blob: d3947edc8dbd3f815f83605843b48b54f07e791d [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
drh909626d2008-05-30 14:58:37 +000013** the WHERE clause of SQL statements. This module is responsible for
drh51669862004-12-18 18:40:26 +000014** 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**
drh7c01f1d2009-03-25 16:51:43 +000019** $Id: where.c,v 1.377 2009/03/25 16:51:43 drh Exp $
drh75897232000-05-29 14:26:00 +000020*/
21#include "sqliteInt.h"
22
23/*
drh51147ba2005-07-23 22:59:55 +000024** Trace output macros
25*/
26#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
mlcreech3a00f902008-03-04 17:45:01 +000027int sqlite3WhereTrace = 0;
drhe8f52c52008-07-12 14:52:20 +000028#endif
drh6df2acd2008-12-28 16:55:25 +000029#if 0
mlcreech3a00f902008-03-04 17:45:01 +000030# define WHERETRACE(X) if(sqlite3WhereTrace) sqlite3DebugPrintf X
drh51147ba2005-07-23 22:59:55 +000031#else
drh4f0c5872007-03-26 22:05:01 +000032# define WHERETRACE(X)
drh51147ba2005-07-23 22:59:55 +000033#endif
34
drh0fcef5e2005-07-19 17:38:22 +000035/* Forward reference
36*/
37typedef struct WhereClause WhereClause;
drh111a6a72008-12-21 03:51:16 +000038typedef struct WhereMaskSet WhereMaskSet;
drh700a2262008-12-17 19:22:15 +000039typedef struct WhereOrInfo WhereOrInfo;
40typedef struct WhereAndInfo WhereAndInfo;
drh111a6a72008-12-21 03:51:16 +000041typedef struct WhereCost WhereCost;
drh0aa74ed2005-07-16 13:33:20 +000042
43/*
drh75897232000-05-29 14:26:00 +000044** The query generator uses an array of instances of this structure to
45** help it analyze the subexpressions of the WHERE clause. Each WHERE
drh6a1e0712008-12-05 15:24:15 +000046** clause subexpression is separated from the others by AND operators.
47** (Note: the same data structure is also reused to hold a group of terms
48** separated by OR operators. But at the top-level, everything is AND
49** separated.)
drh51669862004-12-18 18:40:26 +000050**
drh0fcef5e2005-07-19 17:38:22 +000051** All WhereTerms are collected into a single WhereClause structure.
52** The following identity holds:
drh51669862004-12-18 18:40:26 +000053**
drh0fcef5e2005-07-19 17:38:22 +000054** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +000055**
drh0fcef5e2005-07-19 17:38:22 +000056** When a term is of the form:
57**
58** X <op> <expr>
59**
60** where X is a column name and <op> is one of certain operators,
drh700a2262008-12-17 19:22:15 +000061** then WhereTerm.leftCursor and WhereTerm.u.leftColumn record the
62** cursor number and column number for X. WhereTerm.eOperator records
drh51147ba2005-07-23 22:59:55 +000063** the <op> using a bitmask encoding defined by WO_xxx below. The
64** use of a bitmask encoding for the operator allows us to search
65** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +000066**
drh700a2262008-12-17 19:22:15 +000067** A WhereTerm might also be two or more subterms connected by OR:
68**
69** (t1.X <op> <expr>) OR (t1.Y <op> <expr>) OR ....
70**
71** In this second case, wtFlag as the TERM_ORINFO set and eOperator==WO_OR
72** and the WhereTerm.u.pOrInfo field points to auxiliary information that
73** is collected about the
74**
75** If a term in the WHERE clause does not match either of the two previous
76** categories, then eOperator==0. The WhereTerm.pExpr field is still set
77** to the original subexpression content and wtFlags is set up appropriately
78** but no other fields in the WhereTerm object are meaningful.
79**
80** When eOperator!=0, prereqRight and prereqAll record sets of cursor numbers,
drh111a6a72008-12-21 03:51:16 +000081** but they do so indirectly. A single WhereMaskSet structure translates
drh51669862004-12-18 18:40:26 +000082** cursor number into bits and the translated bit is stored in the prereq
83** fields. The translation is used in order to maximize the number of
84** bits that will fit in a Bitmask. The VDBE cursor numbers might be
85** spread out over the non-negative integers. For example, the cursor
drh111a6a72008-12-21 03:51:16 +000086** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The WhereMaskSet
drh51669862004-12-18 18:40:26 +000087** translates these sparse cursor numbers into consecutive integers
88** beginning with 0 in order to make the best possible use of the available
89** bits in the Bitmask. So, in the example above, the cursor numbers
90** would be mapped into integers 0 through 7.
drh6a1e0712008-12-05 15:24:15 +000091**
92** The number of terms in a join is limited by the number of bits
93** in prereqRight and prereqAll. The default is 64 bits, hence SQLite
94** is only able to process joins with 64 or fewer tables.
drh75897232000-05-29 14:26:00 +000095*/
drh0aa74ed2005-07-16 13:33:20 +000096typedef struct WhereTerm WhereTerm;
97struct WhereTerm {
drh165be382008-12-05 02:36:33 +000098 Expr *pExpr; /* Pointer to the subexpression that is this term */
drhec1724e2008-12-09 01:32:03 +000099 int iParent; /* Disable pWC->a[iParent] when this term disabled */
100 int leftCursor; /* Cursor number of X in "X <op> <expr>" */
drh700a2262008-12-17 19:22:15 +0000101 union {
102 int leftColumn; /* Column number of X in "X <op> <expr>" */
103 WhereOrInfo *pOrInfo; /* Extra information if eOperator==WO_OR */
104 WhereAndInfo *pAndInfo; /* Extra information if eOperator==WO_AND */
105 } u;
drhb52076c2006-01-23 13:22:09 +0000106 u16 eOperator; /* A WO_xx value describing <op> */
drh165be382008-12-05 02:36:33 +0000107 u8 wtFlags; /* TERM_xxx bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +0000108 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +0000109 WhereClause *pWC; /* The clause this term is part of */
drh165be382008-12-05 02:36:33 +0000110 Bitmask prereqRight; /* Bitmask of tables used by pExpr->pRight */
111 Bitmask prereqAll; /* Bitmask of tables referenced by pExpr */
drh75897232000-05-29 14:26:00 +0000112};
113
114/*
drh165be382008-12-05 02:36:33 +0000115** Allowed values of WhereTerm.wtFlags
drh0aa74ed2005-07-16 13:33:20 +0000116*/
drh633e6d52008-07-28 19:34:53 +0000117#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(db, pExpr) */
drh6c30be82005-07-29 15:10:17 +0000118#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
119#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000120#define TERM_COPIED 0x08 /* Has a child */
drh700a2262008-12-17 19:22:15 +0000121#define TERM_ORINFO 0x10 /* Need to free the WhereTerm.u.pOrInfo object */
122#define TERM_ANDINFO 0x20 /* Need to free the WhereTerm.u.pAndInfo obj */
123#define TERM_OR_OK 0x40 /* Used during OR-clause processing */
drh0aa74ed2005-07-16 13:33:20 +0000124
125/*
126** An instance of the following structure holds all information about a
127** WHERE clause. Mostly this is a container for one or more WhereTerms.
128*/
drh0aa74ed2005-07-16 13:33:20 +0000129struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000130 Parse *pParse; /* The parser context */
drh111a6a72008-12-21 03:51:16 +0000131 WhereMaskSet *pMaskSet; /* Mapping of table cursor numbers to bitmasks */
drh29435252008-12-28 18:35:08 +0000132 u8 op; /* Split operator. TK_AND or TK_OR */
drh0aa74ed2005-07-16 13:33:20 +0000133 int nTerm; /* Number of terms */
134 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000135 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
drhec1724e2008-12-09 01:32:03 +0000136 WhereTerm aStatic[4]; /* Initial static space for a[] */
drhe23399f2005-07-22 00:31:39 +0000137};
138
139/*
drh700a2262008-12-17 19:22:15 +0000140** A WhereTerm with eOperator==WO_OR has its u.pOrInfo pointer set to
141** a dynamically allocated instance of the following structure.
142*/
143struct WhereOrInfo {
drh111a6a72008-12-21 03:51:16 +0000144 WhereClause wc; /* Decomposition into subterms */
drh1a58fe02008-12-20 02:06:13 +0000145 Bitmask indexable; /* Bitmask of all indexable tables in the clause */
drh700a2262008-12-17 19:22:15 +0000146};
147
148/*
149** A WhereTerm with eOperator==WO_AND has its u.pAndInfo pointer set to
150** a dynamically allocated instance of the following structure.
151*/
152struct WhereAndInfo {
drh29435252008-12-28 18:35:08 +0000153 WhereClause wc; /* The subexpression broken out */
drh700a2262008-12-17 19:22:15 +0000154};
155
156/*
drh6a3ea0e2003-05-02 14:32:12 +0000157** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000158** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000159**
160** The VDBE cursor numbers are small integers contained in
161** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
162** clause, the cursor numbers might not begin with 0 and they might
163** contain gaps in the numbering sequence. But we want to make maximum
164** use of the bits in our bitmasks. This structure provides a mapping
165** from the sparse cursor numbers into consecutive integers beginning
166** with 0.
167**
drh111a6a72008-12-21 03:51:16 +0000168** If WhereMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
drh51669862004-12-18 18:40:26 +0000169** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
170**
171** For example, if the WHERE clause expression used these VDBE
drh111a6a72008-12-21 03:51:16 +0000172** cursors: 4, 5, 8, 29, 57, 73. Then the WhereMaskSet structure
drh51669862004-12-18 18:40:26 +0000173** would map those cursor numbers into bits 0 through 5.
174**
175** Note that the mapping is not necessarily ordered. In the example
176** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
177** 57->5, 73->4. Or one of 719 other combinations might be used. It
178** does not really matter. What is important is that sparse cursor
179** numbers all get mapped into bit numbers that begin with 0 and contain
180** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000181*/
drh111a6a72008-12-21 03:51:16 +0000182struct WhereMaskSet {
drh1398ad32005-01-19 23:24:50 +0000183 int n; /* Number of assigned cursor values */
danielk197723432972008-11-17 16:42:00 +0000184 int ix[BMS]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000185};
186
drh111a6a72008-12-21 03:51:16 +0000187/*
188** A WhereCost object records a lookup strategy and the estimated
189** cost of pursuing that strategy.
190*/
191struct WhereCost {
192 WherePlan plan; /* The lookup strategy */
193 double rCost; /* Overall cost of pursuing this search strategy */
194 double nRow; /* Estimated number of output rows */
195};
drh0aa74ed2005-07-16 13:33:20 +0000196
drh6a3ea0e2003-05-02 14:32:12 +0000197/*
drh51147ba2005-07-23 22:59:55 +0000198** Bitmasks for the operators that indices are able to exploit. An
199** OR-ed combination of these values can be used when searching for
200** terms in the where clause.
201*/
drh165be382008-12-05 02:36:33 +0000202#define WO_IN 0x001
203#define WO_EQ 0x002
drh51147ba2005-07-23 22:59:55 +0000204#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
205#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
206#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
207#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh165be382008-12-05 02:36:33 +0000208#define WO_MATCH 0x040
209#define WO_ISNULL 0x080
drh700a2262008-12-17 19:22:15 +0000210#define WO_OR 0x100 /* Two or more OR-connected terms */
211#define WO_AND 0x200 /* Two or more AND-connected terms */
drh51147ba2005-07-23 22:59:55 +0000212
drhec1724e2008-12-09 01:32:03 +0000213#define WO_ALL 0xfff /* Mask of all possible WO_* values */
drh1a58fe02008-12-20 02:06:13 +0000214#define WO_SINGLE 0x0ff /* Mask of all non-compound WO_* values */
drhec1724e2008-12-09 01:32:03 +0000215
drh51147ba2005-07-23 22:59:55 +0000216/*
drh700a2262008-12-17 19:22:15 +0000217** Value for wsFlags returned by bestIndex() and stored in
218** WhereLevel.wsFlags. These flags determine which search
219** strategies are appropriate.
drhf2d315d2007-01-25 16:56:06 +0000220**
drh165be382008-12-05 02:36:33 +0000221** The least significant 12 bits is reserved as a mask for WO_ values above.
drh700a2262008-12-17 19:22:15 +0000222** The WhereLevel.wsFlags field is usually set to WO_IN|WO_EQ|WO_ISNULL.
223** But if the table is the right table of a left join, WhereLevel.wsFlags
224** is set to WO_IN|WO_EQ. The WhereLevel.wsFlags field can then be used as
drhf2d315d2007-01-25 16:56:06 +0000225** the "op" parameter to findTerm when we are resolving equality constraints.
226** ISNULL constraints will then not be used on the right table of a left
227** join. Tickets #2177 and #2189.
drh51147ba2005-07-23 22:59:55 +0000228*/
drh165be382008-12-05 02:36:33 +0000229#define WHERE_ROWID_EQ 0x00001000 /* rowid=EXPR or rowid IN (...) */
230#define WHERE_ROWID_RANGE 0x00002000 /* rowid<EXPR and/or rowid>EXPR */
231#define WHERE_COLUMN_EQ 0x00010000 /* x=EXPR or x IN (...) */
232#define WHERE_COLUMN_RANGE 0x00020000 /* x<EXPR and/or x>EXPR */
233#define WHERE_COLUMN_IN 0x00040000 /* x IN (...) */
drh111a6a72008-12-21 03:51:16 +0000234#define WHERE_INDEXED 0x00070000 /* Anything that uses an index */
235#define WHERE_IN_ABLE 0x00071000 /* Able to support an IN operator */
drh165be382008-12-05 02:36:33 +0000236#define WHERE_TOP_LIMIT 0x00100000 /* x<EXPR or x<=EXPR constraint */
237#define WHERE_BTM_LIMIT 0x00200000 /* x>EXPR or x>=EXPR constraint */
238#define WHERE_IDX_ONLY 0x00800000 /* Use index only - omit table */
239#define WHERE_ORDERBY 0x01000000 /* Output will appear in correct order */
240#define WHERE_REVERSE 0x02000000 /* Scan in reverse order */
241#define WHERE_UNIQUE 0x04000000 /* Selects no more than one row */
242#define WHERE_VIRTUALTABLE 0x08000000 /* Use virtual-table processing */
243#define WHERE_MULTI_OR 0x10000000 /* OR using multiple indices */
drh51147ba2005-07-23 22:59:55 +0000244
245/*
drh0aa74ed2005-07-16 13:33:20 +0000246** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000247*/
drh7b4fc6a2007-02-06 13:26:32 +0000248static void whereClauseInit(
249 WhereClause *pWC, /* The WhereClause to be initialized */
250 Parse *pParse, /* The parsing context */
drh111a6a72008-12-21 03:51:16 +0000251 WhereMaskSet *pMaskSet /* Mapping from table cursor numbers to bitmasks */
drh7b4fc6a2007-02-06 13:26:32 +0000252){
drhfe05af82005-07-21 03:14:59 +0000253 pWC->pParse = pParse;
drh7b4fc6a2007-02-06 13:26:32 +0000254 pWC->pMaskSet = pMaskSet;
drh0aa74ed2005-07-16 13:33:20 +0000255 pWC->nTerm = 0;
drhcad651e2007-04-20 12:22:01 +0000256 pWC->nSlot = ArraySize(pWC->aStatic);
drh0aa74ed2005-07-16 13:33:20 +0000257 pWC->a = pWC->aStatic;
258}
259
drh700a2262008-12-17 19:22:15 +0000260/* Forward reference */
261static void whereClauseClear(WhereClause*);
262
263/*
264** Deallocate all memory associated with a WhereOrInfo object.
265*/
266static void whereOrInfoDelete(sqlite3 *db, WhereOrInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000267 whereClauseClear(&p->wc);
268 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000269}
270
271/*
272** Deallocate all memory associated with a WhereAndInfo object.
273*/
274static void whereAndInfoDelete(sqlite3 *db, WhereAndInfo *p){
drh5bd98ae2009-01-07 18:24:03 +0000275 whereClauseClear(&p->wc);
276 sqlite3DbFree(db, p);
drh700a2262008-12-17 19:22:15 +0000277}
278
drh0aa74ed2005-07-16 13:33:20 +0000279/*
280** Deallocate a WhereClause structure. The WhereClause structure
281** itself is not freed. This routine is the inverse of whereClauseInit().
282*/
283static void whereClauseClear(WhereClause *pWC){
284 int i;
285 WhereTerm *a;
drh633e6d52008-07-28 19:34:53 +0000286 sqlite3 *db = pWC->pParse->db;
drh0aa74ed2005-07-16 13:33:20 +0000287 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
drh165be382008-12-05 02:36:33 +0000288 if( a->wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000289 sqlite3ExprDelete(db, a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000290 }
drh700a2262008-12-17 19:22:15 +0000291 if( a->wtFlags & TERM_ORINFO ){
292 whereOrInfoDelete(db, a->u.pOrInfo);
293 }else if( a->wtFlags & TERM_ANDINFO ){
294 whereAndInfoDelete(db, a->u.pAndInfo);
295 }
drh0aa74ed2005-07-16 13:33:20 +0000296 }
297 if( pWC->a!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000298 sqlite3DbFree(db, pWC->a);
drh0aa74ed2005-07-16 13:33:20 +0000299 }
300}
301
302/*
drh6a1e0712008-12-05 15:24:15 +0000303** Add a single new WhereTerm entry to the WhereClause object pWC.
304** The new WhereTerm object is constructed from Expr p and with wtFlags.
305** The index in pWC->a[] of the new WhereTerm is returned on success.
306** 0 is returned if the new WhereTerm could not be added due to a memory
307** allocation error. The memory allocation failure will be recorded in
308** the db->mallocFailed flag so that higher-level functions can detect it.
309**
310** This routine will increase the size of the pWC->a[] array as necessary.
drh9eb20282005-08-24 03:52:18 +0000311**
drh165be382008-12-05 02:36:33 +0000312** If the wtFlags argument includes TERM_DYNAMIC, then responsibility
drh6a1e0712008-12-05 15:24:15 +0000313** for freeing the expression p is assumed by the WhereClause object pWC.
314** This is true even if this routine fails to allocate a new WhereTerm.
drhb63a53d2007-03-31 01:34:44 +0000315**
drh9eb20282005-08-24 03:52:18 +0000316** WARNING: This routine might reallocate the space used to store
drh909626d2008-05-30 14:58:37 +0000317** WhereTerms. All pointers to WhereTerms should be invalidated after
drh9eb20282005-08-24 03:52:18 +0000318** calling this routine. Such pointers may be reinitialized by referencing
319** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000320*/
drhec1724e2008-12-09 01:32:03 +0000321static int whereClauseInsert(WhereClause *pWC, Expr *p, u8 wtFlags){
drh0aa74ed2005-07-16 13:33:20 +0000322 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000323 int idx;
drh0aa74ed2005-07-16 13:33:20 +0000324 if( pWC->nTerm>=pWC->nSlot ){
325 WhereTerm *pOld = pWC->a;
drh633e6d52008-07-28 19:34:53 +0000326 sqlite3 *db = pWC->pParse->db;
327 pWC->a = sqlite3DbMallocRaw(db, sizeof(pWC->a[0])*pWC->nSlot*2 );
drhb63a53d2007-03-31 01:34:44 +0000328 if( pWC->a==0 ){
drh165be382008-12-05 02:36:33 +0000329 if( wtFlags & TERM_DYNAMIC ){
drh633e6d52008-07-28 19:34:53 +0000330 sqlite3ExprDelete(db, p);
drhb63a53d2007-03-31 01:34:44 +0000331 }
drhf998b732007-11-26 13:36:00 +0000332 pWC->a = pOld;
drhb63a53d2007-03-31 01:34:44 +0000333 return 0;
334 }
drh0aa74ed2005-07-16 13:33:20 +0000335 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
336 if( pOld!=pWC->aStatic ){
drh633e6d52008-07-28 19:34:53 +0000337 sqlite3DbFree(db, pOld);
drh0aa74ed2005-07-16 13:33:20 +0000338 }
drh6a1e0712008-12-05 15:24:15 +0000339 pWC->nSlot = sqlite3DbMallocSize(db, pWC->a)/sizeof(pWC->a[0]);
drh0aa74ed2005-07-16 13:33:20 +0000340 }
drh6a1e0712008-12-05 15:24:15 +0000341 pTerm = &pWC->a[idx = pWC->nTerm++];
drh0fcef5e2005-07-19 17:38:22 +0000342 pTerm->pExpr = p;
drh165be382008-12-05 02:36:33 +0000343 pTerm->wtFlags = wtFlags;
drh0fcef5e2005-07-19 17:38:22 +0000344 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000345 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000346 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000347}
drh75897232000-05-29 14:26:00 +0000348
349/*
drh51669862004-12-18 18:40:26 +0000350** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000351** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000352** operator specified in the op parameter. The WhereClause structure
353** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000354**
drh51669862004-12-18 18:40:26 +0000355** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
356** \________/ \_______________/ \________________/
357** slot[0] slot[1] slot[2]
358**
359** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000360** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000361**
drh51147ba2005-07-23 22:59:55 +0000362** In the previous sentence and in the diagram, "slot[]" refers to
drh902b9ee2008-12-05 17:17:07 +0000363** the WhereClause.a[] array. The slot[] array grows as needed to contain
drh51147ba2005-07-23 22:59:55 +0000364** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000365*/
drh6c30be82005-07-29 15:10:17 +0000366static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh29435252008-12-28 18:35:08 +0000367 pWC->op = (u8)op;
drh0aa74ed2005-07-16 13:33:20 +0000368 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000369 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000370 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000371 }else{
drh6c30be82005-07-29 15:10:17 +0000372 whereSplit(pWC, pExpr->pLeft, op);
373 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000374 }
drh75897232000-05-29 14:26:00 +0000375}
376
377/*
drh6a3ea0e2003-05-02 14:32:12 +0000378** Initialize an expression mask set
379*/
380#define initMaskSet(P) memset(P, 0, sizeof(*P))
381
382/*
drh1398ad32005-01-19 23:24:50 +0000383** Return the bitmask for the given cursor number. Return 0 if
384** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000385*/
drh111a6a72008-12-21 03:51:16 +0000386static Bitmask getMask(WhereMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000387 int i;
388 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000389 if( pMaskSet->ix[i]==iCursor ){
390 return ((Bitmask)1)<<i;
391 }
drh6a3ea0e2003-05-02 14:32:12 +0000392 }
drh6a3ea0e2003-05-02 14:32:12 +0000393 return 0;
394}
395
396/*
drh1398ad32005-01-19 23:24:50 +0000397** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000398**
399** There is one cursor per table in the FROM clause. The number of
400** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000401** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000402** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000403*/
drh111a6a72008-12-21 03:51:16 +0000404static void createMask(WhereMaskSet *pMaskSet, int iCursor){
drhcad651e2007-04-20 12:22:01 +0000405 assert( pMaskSet->n < ArraySize(pMaskSet->ix) );
drh0fcef5e2005-07-19 17:38:22 +0000406 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000407}
408
409/*
drh75897232000-05-29 14:26:00 +0000410** This routine walks (recursively) an expression tree and generates
411** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000412** tree.
drh75897232000-05-29 14:26:00 +0000413**
414** In order for this routine to work, the calling function must have
drh7d10d5a2008-08-20 16:35:10 +0000415** previously invoked sqlite3ResolveExprNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000416** the header comment on that routine for additional information.
drh7d10d5a2008-08-20 16:35:10 +0000417** The sqlite3ResolveExprNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000418** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000419** the VDBE cursor number of the table. This routine just has to
420** translate the cursor numbers into bitmask values and OR all
421** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000422*/
drh111a6a72008-12-21 03:51:16 +0000423static Bitmask exprListTableUsage(WhereMaskSet*, ExprList*);
424static Bitmask exprSelectTableUsage(WhereMaskSet*, Select*);
425static Bitmask exprTableUsage(WhereMaskSet *pMaskSet, Expr *p){
drh51669862004-12-18 18:40:26 +0000426 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000427 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000428 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000429 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000430 return mask;
drh75897232000-05-29 14:26:00 +0000431 }
danielk1977b3bce662005-01-29 08:32:43 +0000432 mask = exprTableUsage(pMaskSet, p->pRight);
433 mask |= exprTableUsage(pMaskSet, p->pLeft);
danielk19776ab3a2e2009-02-19 14:39:25 +0000434 if( ExprHasProperty(p, EP_xIsSelect) ){
435 mask |= exprSelectTableUsage(pMaskSet, p->x.pSelect);
436 }else{
437 mask |= exprListTableUsage(pMaskSet, p->x.pList);
438 }
danielk1977b3bce662005-01-29 08:32:43 +0000439 return mask;
440}
drh111a6a72008-12-21 03:51:16 +0000441static Bitmask exprListTableUsage(WhereMaskSet *pMaskSet, ExprList *pList){
danielk1977b3bce662005-01-29 08:32:43 +0000442 int i;
443 Bitmask mask = 0;
444 if( pList ){
445 for(i=0; i<pList->nExpr; i++){
446 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000447 }
448 }
drh75897232000-05-29 14:26:00 +0000449 return mask;
450}
drh111a6a72008-12-21 03:51:16 +0000451static Bitmask exprSelectTableUsage(WhereMaskSet *pMaskSet, Select *pS){
drha430ae82007-09-12 15:41:01 +0000452 Bitmask mask = 0;
453 while( pS ){
454 mask |= exprListTableUsage(pMaskSet, pS->pEList);
drhf5b11382005-09-17 13:07:13 +0000455 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
456 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
457 mask |= exprTableUsage(pMaskSet, pS->pWhere);
458 mask |= exprTableUsage(pMaskSet, pS->pHaving);
drha430ae82007-09-12 15:41:01 +0000459 pS = pS->pPrior;
drhf5b11382005-09-17 13:07:13 +0000460 }
461 return mask;
462}
drh75897232000-05-29 14:26:00 +0000463
464/*
drh487ab3c2001-11-08 00:45:21 +0000465** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000466** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000467** "=", "<", ">", "<=", ">=", and "IN".
drh487ab3c2001-11-08 00:45:21 +0000468*/
469static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000470 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
471 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
472 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
473 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000474 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000475}
476
477/*
drh902b9ee2008-12-05 17:17:07 +0000478** Swap two objects of type TYPE.
drh193bd772004-07-20 18:23:14 +0000479*/
480#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
481
482/*
drh909626d2008-05-30 14:58:37 +0000483** Commute a comparison operator. Expressions of the form "X op Y"
drh0fcef5e2005-07-19 17:38:22 +0000484** are converted into "Y op X".
danielk1977eb5453d2007-07-30 14:40:48 +0000485**
486** If a collation sequence is associated with either the left or right
487** side of the comparison, it remains associated with the same side after
488** the commutation. So "Y collate NOCASE op X" becomes
489** "X collate NOCASE op Y". This is because any collation sequence on
490** the left hand side of a comparison overrides any collation sequence
491** attached to the right. For the same reason the EP_ExpCollate flag
492** is not commuted.
drh193bd772004-07-20 18:23:14 +0000493*/
drh7d10d5a2008-08-20 16:35:10 +0000494static void exprCommute(Parse *pParse, Expr *pExpr){
danielk1977eb5453d2007-07-30 14:40:48 +0000495 u16 expRight = (pExpr->pRight->flags & EP_ExpCollate);
496 u16 expLeft = (pExpr->pLeft->flags & EP_ExpCollate);
drhfe05af82005-07-21 03:14:59 +0000497 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drh7d10d5a2008-08-20 16:35:10 +0000498 pExpr->pRight->pColl = sqlite3ExprCollSeq(pParse, pExpr->pRight);
499 pExpr->pLeft->pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
drh0fcef5e2005-07-19 17:38:22 +0000500 SWAP(CollSeq*,pExpr->pRight->pColl,pExpr->pLeft->pColl);
danielk1977eb5453d2007-07-30 14:40:48 +0000501 pExpr->pRight->flags = (pExpr->pRight->flags & ~EP_ExpCollate) | expLeft;
502 pExpr->pLeft->flags = (pExpr->pLeft->flags & ~EP_ExpCollate) | expRight;
drh0fcef5e2005-07-19 17:38:22 +0000503 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
504 if( pExpr->op>=TK_GT ){
505 assert( TK_LT==TK_GT+2 );
506 assert( TK_GE==TK_LE+2 );
507 assert( TK_GT>TK_EQ );
508 assert( TK_GT<TK_LE );
509 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
510 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000511 }
drh193bd772004-07-20 18:23:14 +0000512}
513
514/*
drhfe05af82005-07-21 03:14:59 +0000515** Translate from TK_xx operator to WO_xx bitmask.
516*/
drhec1724e2008-12-09 01:32:03 +0000517static u16 operatorMask(int op){
518 u16 c;
drhfe05af82005-07-21 03:14:59 +0000519 assert( allowedOp(op) );
520 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000521 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000522 }else if( op==TK_ISNULL ){
523 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000524 }else{
drhec1724e2008-12-09 01:32:03 +0000525 assert( (WO_EQ<<(op-TK_EQ)) < 0x7fff );
526 c = (u16)(WO_EQ<<(op-TK_EQ));
drhfe05af82005-07-21 03:14:59 +0000527 }
drh50b39962006-10-28 00:28:09 +0000528 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000529 assert( op!=TK_IN || c==WO_IN );
530 assert( op!=TK_EQ || c==WO_EQ );
531 assert( op!=TK_LT || c==WO_LT );
532 assert( op!=TK_LE || c==WO_LE );
533 assert( op!=TK_GT || c==WO_GT );
534 assert( op!=TK_GE || c==WO_GE );
535 return c;
drhfe05af82005-07-21 03:14:59 +0000536}
537
538/*
539** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
540** where X is a reference to the iColumn of table iCur and <op> is one of
541** the WO_xx operator codes specified by the op parameter.
542** Return a pointer to the term. Return 0 if not found.
543*/
544static WhereTerm *findTerm(
545 WhereClause *pWC, /* The WHERE clause to be searched */
546 int iCur, /* Cursor number of LHS */
547 int iColumn, /* Column number of LHS */
548 Bitmask notReady, /* RHS must not overlap with this mask */
drhec1724e2008-12-09 01:32:03 +0000549 u32 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000550 Index *pIdx /* Must be compatible with this index, if not NULL */
551){
552 WhereTerm *pTerm;
553 int k;
drh22c24032008-07-09 13:28:53 +0000554 assert( iCur>=0 );
drhec1724e2008-12-09 01:32:03 +0000555 op &= WO_ALL;
drhfe05af82005-07-21 03:14:59 +0000556 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
557 if( pTerm->leftCursor==iCur
558 && (pTerm->prereqRight & notReady)==0
drh700a2262008-12-17 19:22:15 +0000559 && pTerm->u.leftColumn==iColumn
drhb52076c2006-01-23 13:22:09 +0000560 && (pTerm->eOperator & op)!=0
drhfe05af82005-07-21 03:14:59 +0000561 ){
drh22c24032008-07-09 13:28:53 +0000562 if( pIdx && pTerm->eOperator!=WO_ISNULL ){
drhfe05af82005-07-21 03:14:59 +0000563 Expr *pX = pTerm->pExpr;
564 CollSeq *pColl;
565 char idxaff;
danielk1977f0113002006-01-24 12:09:17 +0000566 int j;
drhfe05af82005-07-21 03:14:59 +0000567 Parse *pParse = pWC->pParse;
568
569 idxaff = pIdx->pTable->aCol[iColumn].affinity;
570 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
danielk1977bcbb04e2007-05-29 12:11:29 +0000571
572 /* Figure out the collation sequence required from an index for
573 ** it to be useful for optimising expression pX. Store this
574 ** value in variable pColl.
575 */
576 assert(pX->pLeft);
577 pColl = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pX->pRight);
danielk197793574162008-12-30 15:26:29 +0000578 assert(pColl || pParse->nErr);
danielk1977bcbb04e2007-05-29 12:11:29 +0000579
drh22c24032008-07-09 13:28:53 +0000580 for(j=0; pIdx->aiColumn[j]!=iColumn; j++){
drh34004ce2008-07-11 16:15:17 +0000581 if( NEVER(j>=pIdx->nColumn) ) return 0;
drh22c24032008-07-09 13:28:53 +0000582 }
danielk197793574162008-12-30 15:26:29 +0000583 if( pColl && sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drhfe05af82005-07-21 03:14:59 +0000584 }
585 return pTerm;
586 }
587 }
588 return 0;
589}
590
drh6c30be82005-07-29 15:10:17 +0000591/* Forward reference */
drh7b4fc6a2007-02-06 13:26:32 +0000592static void exprAnalyze(SrcList*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000593
594/*
595** Call exprAnalyze on all terms in a WHERE clause.
596**
597**
598*/
599static void exprAnalyzeAll(
600 SrcList *pTabList, /* the FROM clause */
drh6c30be82005-07-29 15:10:17 +0000601 WhereClause *pWC /* the WHERE clause to be analyzed */
602){
drh6c30be82005-07-29 15:10:17 +0000603 int i;
drh9eb20282005-08-24 03:52:18 +0000604 for(i=pWC->nTerm-1; i>=0; i--){
drh7b4fc6a2007-02-06 13:26:32 +0000605 exprAnalyze(pTabList, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000606 }
607}
608
drhd2687b72005-08-12 22:56:09 +0000609#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
610/*
611** Check to see if the given expression is a LIKE or GLOB operator that
612** can be optimized using inequality constraints. Return TRUE if it is
613** so and false if not.
614**
615** In order for the operator to be optimizible, the RHS must be a string
616** literal that does not begin with a wildcard.
617*/
618static int isLikeOrGlob(
drh7d10d5a2008-08-20 16:35:10 +0000619 Parse *pParse, /* Parsing and code generating context */
drhd2687b72005-08-12 22:56:09 +0000620 Expr *pExpr, /* Test this expression */
621 int *pnPattern, /* Number of non-wildcard prefix characters */
drh9f504ea2008-02-23 21:55:39 +0000622 int *pisComplete, /* True if the only wildcard is % in the last character */
623 int *pnoCase /* True if uppercase is equivalent to lowercase */
drhd2687b72005-08-12 22:56:09 +0000624){
drh5bd98ae2009-01-07 18:24:03 +0000625 const char *z; /* String on RHS of LIKE operator */
626 Expr *pRight, *pLeft; /* Right and left size of LIKE operator */
627 ExprList *pList; /* List of operands to the LIKE operator */
628 int c; /* One character in z[] */
629 int cnt; /* Number of non-wildcard prefix characters */
630 char wc[3]; /* Wildcard characters */
631 CollSeq *pColl; /* Collating sequence for LHS */
632 sqlite3 *db = pParse->db; /* Database connection */
drhd64fe2f2005-08-28 17:00:23 +0000633
drh9f504ea2008-02-23 21:55:39 +0000634 if( !sqlite3IsLikeFunction(db, pExpr, pnoCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000635 return 0;
636 }
drh9f504ea2008-02-23 21:55:39 +0000637#ifdef SQLITE_EBCDIC
638 if( *pnoCase ) return 0;
639#endif
danielk19776ab3a2e2009-02-19 14:39:25 +0000640 pList = pExpr->x.pList;
drh55ef4d92005-08-14 01:20:37 +0000641 pRight = pList->a[0].pExpr;
drh5bd98ae2009-01-07 18:24:03 +0000642 if( pRight->op!=TK_STRING ){
drhd2687b72005-08-12 22:56:09 +0000643 return 0;
644 }
drh55ef4d92005-08-14 01:20:37 +0000645 pLeft = pList->a[1].pExpr;
drhd2687b72005-08-12 22:56:09 +0000646 if( pLeft->op!=TK_COLUMN ){
647 return 0;
648 }
drh7d10d5a2008-08-20 16:35:10 +0000649 pColl = sqlite3ExprCollSeq(pParse, pLeft);
drh01495b92008-01-23 12:52:40 +0000650 assert( pColl!=0 || pLeft->iColumn==-1 );
drhd64fe2f2005-08-28 17:00:23 +0000651 if( pColl==0 ){
drh01495b92008-01-23 12:52:40 +0000652 /* No collation is defined for the ROWID. Use the default. */
drhd64fe2f2005-08-28 17:00:23 +0000653 pColl = db->pDfltColl;
654 }
drh9f504ea2008-02-23 21:55:39 +0000655 if( (pColl->type!=SQLITE_COLL_BINARY || *pnoCase) &&
656 (pColl->type!=SQLITE_COLL_NOCASE || !*pnoCase) ){
drhd64fe2f2005-08-28 17:00:23 +0000657 return 0;
658 }
drh7c01f1d2009-03-25 16:51:43 +0000659 sqlite3DequoteExpr(pRight);
danielk197700fd9572005-12-07 06:27:43 +0000660 z = (char *)pRight->token.z;
drhf998b732007-11-26 13:36:00 +0000661 cnt = 0;
662 if( z ){
663 while( (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2] ){ cnt++; }
664 }
drh5bd98ae2009-01-07 18:24:03 +0000665 if( cnt==0 || 255==(u8)z[cnt-1] ){
drhd2687b72005-08-12 22:56:09 +0000666 return 0;
667 }
drh55ef4d92005-08-14 01:20:37 +0000668 *pisComplete = z[cnt]==wc[0] && z[cnt+1]==0;
drhd2687b72005-08-12 22:56:09 +0000669 *pnPattern = cnt;
670 return 1;
671}
672#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
673
drhedb193b2006-06-27 13:20:21 +0000674
675#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000676/*
drh7f375902006-06-13 17:38:59 +0000677** Check to see if the given expression is of the form
678**
679** column MATCH expr
680**
681** If it is then return TRUE. If not, return FALSE.
682*/
683static int isMatchOfColumn(
684 Expr *pExpr /* Test this expression */
685){
686 ExprList *pList;
687
688 if( pExpr->op!=TK_FUNCTION ){
689 return 0;
690 }
drhedb193b2006-06-27 13:20:21 +0000691 if( pExpr->token.n!=5 ||
692 sqlite3StrNICmp((const char*)pExpr->token.z,"match",5)!=0 ){
drh7f375902006-06-13 17:38:59 +0000693 return 0;
694 }
danielk19776ab3a2e2009-02-19 14:39:25 +0000695 pList = pExpr->x.pList;
drh7f375902006-06-13 17:38:59 +0000696 if( pList->nExpr!=2 ){
697 return 0;
698 }
699 if( pList->a[1].pExpr->op != TK_COLUMN ){
700 return 0;
701 }
702 return 1;
703}
drhedb193b2006-06-27 13:20:21 +0000704#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000705
706/*
drh54a167d2005-11-26 14:08:07 +0000707** If the pBase expression originated in the ON or USING clause of
708** a join, then transfer the appropriate markings over to derived.
709*/
710static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
711 pDerived->flags |= pBase->flags & EP_FromJoin;
712 pDerived->iRightJoinTable = pBase->iRightJoinTable;
713}
714
drh3e355802007-02-23 23:13:33 +0000715#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
716/*
drh1a58fe02008-12-20 02:06:13 +0000717** Analyze a term that consists of two or more OR-connected
718** subterms. So in:
drh3e355802007-02-23 23:13:33 +0000719**
drh1a58fe02008-12-20 02:06:13 +0000720** ... WHERE (a=5) AND (b=7 OR c=9 OR d=13) AND (d=13)
721** ^^^^^^^^^^^^^^^^^^^^
drh3e355802007-02-23 23:13:33 +0000722**
drh1a58fe02008-12-20 02:06:13 +0000723** This routine analyzes terms such as the middle term in the above example.
724** A WhereOrTerm object is computed and attached to the term under
725** analysis, regardless of the outcome of the analysis. Hence:
drh3e355802007-02-23 23:13:33 +0000726**
drh1a58fe02008-12-20 02:06:13 +0000727** WhereTerm.wtFlags |= TERM_ORINFO
728** WhereTerm.u.pOrInfo = a dynamically allocated WhereOrTerm object
drh3e355802007-02-23 23:13:33 +0000729**
drh1a58fe02008-12-20 02:06:13 +0000730** The term being analyzed must have two or more of OR-connected subterms.
danielk1977fdc40192008-12-29 18:33:32 +0000731** A single subterm might be a set of AND-connected sub-subterms.
drh1a58fe02008-12-20 02:06:13 +0000732** Examples of terms under analysis:
drh3e355802007-02-23 23:13:33 +0000733**
drh1a58fe02008-12-20 02:06:13 +0000734** (A) t1.x=t2.y OR t1.x=t2.z OR t1.y=15 OR t1.z=t3.a+5
735** (B) x=expr1 OR expr2=x OR x=expr3
736** (C) t1.x=t2.y OR (t1.x=t2.z AND t1.y=15)
737** (D) x=expr1 OR (y>11 AND y<22 AND z LIKE '*hello*')
738** (E) (p.a=1 AND q.b=2 AND r.c=3) OR (p.x=4 AND q.y=5 AND r.z=6)
drh3e355802007-02-23 23:13:33 +0000739**
drh1a58fe02008-12-20 02:06:13 +0000740** CASE 1:
741**
742** If all subterms are of the form T.C=expr for some single column of C
743** a single table T (as shown in example B above) then create a new virtual
744** term that is an equivalent IN expression. In other words, if the term
745** being analyzed is:
746**
747** x = expr1 OR expr2 = x OR x = expr3
748**
749** then create a new virtual term like this:
750**
751** x IN (expr1,expr2,expr3)
752**
753** CASE 2:
754**
755** If all subterms are indexable by a single table T, then set
756**
757** WhereTerm.eOperator = WO_OR
758** WhereTerm.u.pOrInfo->indexable |= the cursor number for table T
759**
760** A subterm is "indexable" if it is of the form
761** "T.C <op> <expr>" where C is any column of table T and
762** <op> is one of "=", "<", "<=", ">", ">=", "IS NULL", or "IN".
763** A subterm is also indexable if it is an AND of two or more
764** subsubterms at least one of which is indexable. Indexable AND
765** subterms have their eOperator set to WO_AND and they have
766** u.pAndInfo set to a dynamically allocated WhereAndTerm object.
767**
768** From another point of view, "indexable" means that the subterm could
769** potentially be used with an index if an appropriate index exists.
770** This analysis does not consider whether or not the index exists; that
771** is something the bestIndex() routine will determine. This analysis
772** only looks at whether subterms appropriate for indexing exist.
773**
774** All examples A through E above all satisfy case 2. But if a term
775** also statisfies case 1 (such as B) we know that the optimizer will
776** always prefer case 1, so in that case we pretend that case 2 is not
777** satisfied.
778**
779** It might be the case that multiple tables are indexable. For example,
780** (E) above is indexable on tables P, Q, and R.
781**
782** Terms that satisfy case 2 are candidates for lookup by using
783** separate indices to find rowids for each subterm and composing
784** the union of all rowids using a RowSet object. This is similar
785** to "bitmap indices" in other database engines.
786**
787** OTHERWISE:
788**
789** If neither case 1 nor case 2 apply, then leave the eOperator set to
790** zero. This term is not useful for search.
drh3e355802007-02-23 23:13:33 +0000791*/
drh1a58fe02008-12-20 02:06:13 +0000792static void exprAnalyzeOrTerm(
793 SrcList *pSrc, /* the FROM clause */
794 WhereClause *pWC, /* the complete WHERE clause */
795 int idxTerm /* Index of the OR-term to be analyzed */
796){
797 Parse *pParse = pWC->pParse; /* Parser context */
798 sqlite3 *db = pParse->db; /* Database connection */
799 WhereTerm *pTerm = &pWC->a[idxTerm]; /* The term to be analyzed */
800 Expr *pExpr = pTerm->pExpr; /* The expression of the term */
drh111a6a72008-12-21 03:51:16 +0000801 WhereMaskSet *pMaskSet = pWC->pMaskSet; /* Table use masks */
drh1a58fe02008-12-20 02:06:13 +0000802 int i; /* Loop counters */
803 WhereClause *pOrWc; /* Breakup of pTerm into subterms */
804 WhereTerm *pOrTerm; /* A Sub-term within the pOrWc */
805 WhereOrInfo *pOrInfo; /* Additional information associated with pTerm */
806 Bitmask chngToIN; /* Tables that might satisfy case 1 */
807 Bitmask indexable; /* Tables that are indexable, satisfying case 2 */
drh3e355802007-02-23 23:13:33 +0000808
drh1a58fe02008-12-20 02:06:13 +0000809 /*
810 ** Break the OR clause into its separate subterms. The subterms are
811 ** stored in a WhereClause structure containing within the WhereOrInfo
812 ** object that is attached to the original OR clause term.
813 */
814 assert( (pTerm->wtFlags & (TERM_DYNAMIC|TERM_ORINFO|TERM_ANDINFO))==0 );
815 assert( pExpr->op==TK_OR );
drh954701a2008-12-29 23:45:07 +0000816 pTerm->u.pOrInfo = pOrInfo = sqlite3DbMallocZero(db, sizeof(*pOrInfo));
drh1a58fe02008-12-20 02:06:13 +0000817 if( pOrInfo==0 ) return;
818 pTerm->wtFlags |= TERM_ORINFO;
819 pOrWc = &pOrInfo->wc;
820 whereClauseInit(pOrWc, pWC->pParse, pMaskSet);
821 whereSplit(pOrWc, pExpr, TK_OR);
822 exprAnalyzeAll(pSrc, pOrWc);
823 if( db->mallocFailed ) return;
824 assert( pOrWc->nTerm>=2 );
825
826 /*
827 ** Compute the set of tables that might satisfy cases 1 or 2.
828 */
829 indexable = chngToIN = ~(Bitmask)0;
830 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0 && indexable; i--, pOrTerm++){
831 if( (pOrTerm->eOperator & WO_SINGLE)==0 ){
drh29435252008-12-28 18:35:08 +0000832 WhereAndInfo *pAndInfo;
833 assert( pOrTerm->eOperator==0 );
834 assert( (pOrTerm->wtFlags & (TERM_ANDINFO|TERM_ORINFO))==0 );
drh1a58fe02008-12-20 02:06:13 +0000835 chngToIN = 0;
drh29435252008-12-28 18:35:08 +0000836 pAndInfo = sqlite3DbMallocRaw(db, sizeof(*pAndInfo));
837 if( pAndInfo ){
838 WhereClause *pAndWC;
839 WhereTerm *pAndTerm;
840 int j;
841 Bitmask b = 0;
842 pOrTerm->u.pAndInfo = pAndInfo;
843 pOrTerm->wtFlags |= TERM_ANDINFO;
844 pOrTerm->eOperator = WO_AND;
845 pAndWC = &pAndInfo->wc;
846 whereClauseInit(pAndWC, pWC->pParse, pMaskSet);
847 whereSplit(pAndWC, pOrTerm->pExpr, TK_AND);
848 exprAnalyzeAll(pSrc, pAndWC);
drh7c2fbde2009-01-07 20:58:57 +0000849 testcase( db->mallocFailed );
drh96c7a7d2009-01-10 15:34:12 +0000850 if( !db->mallocFailed ){
851 for(j=0, pAndTerm=pAndWC->a; j<pAndWC->nTerm; j++, pAndTerm++){
852 assert( pAndTerm->pExpr );
853 if( allowedOp(pAndTerm->pExpr->op) ){
854 b |= getMask(pMaskSet, pAndTerm->leftCursor);
855 }
drh29435252008-12-28 18:35:08 +0000856 }
857 }
858 indexable &= b;
859 }
drh1a58fe02008-12-20 02:06:13 +0000860 }else if( pOrTerm->wtFlags & TERM_COPIED ){
861 /* Skip this term for now. We revisit it when we process the
862 ** corresponding TERM_VIRTUAL term */
863 }else{
864 Bitmask b;
865 b = getMask(pMaskSet, pOrTerm->leftCursor);
866 if( pOrTerm->wtFlags & TERM_VIRTUAL ){
867 WhereTerm *pOther = &pOrWc->a[pOrTerm->iParent];
868 b |= getMask(pMaskSet, pOther->leftCursor);
869 }
870 indexable &= b;
871 if( pOrTerm->eOperator!=WO_EQ ){
872 chngToIN = 0;
873 }else{
874 chngToIN &= b;
875 }
876 }
drh3e355802007-02-23 23:13:33 +0000877 }
drh1a58fe02008-12-20 02:06:13 +0000878
879 /*
880 ** Record the set of tables that satisfy case 2. The set might be
drh111a6a72008-12-21 03:51:16 +0000881 ** empty.
drh1a58fe02008-12-20 02:06:13 +0000882 */
883 pOrInfo->indexable = indexable;
drh111a6a72008-12-21 03:51:16 +0000884 pTerm->eOperator = indexable==0 ? 0 : WO_OR;
drh1a58fe02008-12-20 02:06:13 +0000885
886 /*
887 ** chngToIN holds a set of tables that *might* satisfy case 1. But
888 ** we have to do some additional checking to see if case 1 really
889 ** is satisfied.
890 */
891 if( chngToIN ){
892 int okToChngToIN = 0; /* True if the conversion to IN is valid */
893 int iColumn = -1; /* Column index on lhs of IN operator */
shane63207ab2009-02-04 01:49:30 +0000894 int iCursor = -1; /* Table cursor common to all terms */
drh1a58fe02008-12-20 02:06:13 +0000895 int j = 0; /* Loop counter */
896
897 /* Search for a table and column that appears on one side or the
898 ** other of the == operator in every subterm. That table and column
899 ** will be recorded in iCursor and iColumn. There might not be any
900 ** such table and column. Set okToChngToIN if an appropriate table
901 ** and column is found but leave okToChngToIN false if not found.
902 */
903 for(j=0; j<2 && !okToChngToIN; j++){
904 pOrTerm = pOrWc->a;
905 for(i=pOrWc->nTerm-1; i>=0; i--, pOrTerm++){
906 assert( pOrTerm->eOperator==WO_EQ );
907 pOrTerm->wtFlags &= ~TERM_OR_OK;
908 if( pOrTerm->leftCursor==iColumn ) continue;
909 if( (chngToIN & getMask(pMaskSet, pOrTerm->leftCursor))==0 ) continue;
910 iColumn = pOrTerm->u.leftColumn;
911 iCursor = pOrTerm->leftCursor;
912 break;
913 }
914 if( i<0 ){
915 assert( j==1 );
916 assert( (chngToIN&(chngToIN-1))==0 );
917 assert( chngToIN==getMask(pMaskSet, iColumn) );
918 break;
919 }
920 okToChngToIN = 1;
921 for(; i>=0 && okToChngToIN; i--, pOrTerm++){
922 assert( pOrTerm->eOperator==WO_EQ );
923 if( pOrTerm->leftCursor!=iCursor ){
924 pOrTerm->wtFlags &= ~TERM_OR_OK;
925 }else if( pOrTerm->u.leftColumn!=iColumn ){
926 okToChngToIN = 0;
927 }else{
928 int affLeft, affRight;
929 /* If the right-hand side is also a column, then the affinities
930 ** of both right and left sides must be such that no type
931 ** conversions are required on the right. (Ticket #2249)
932 */
933 affRight = sqlite3ExprAffinity(pOrTerm->pExpr->pRight);
934 affLeft = sqlite3ExprAffinity(pOrTerm->pExpr->pLeft);
935 if( affRight!=0 && affRight!=affLeft ){
936 okToChngToIN = 0;
937 }else{
938 pOrTerm->wtFlags |= TERM_OR_OK;
939 }
940 }
941 }
942 }
943
944 /* At this point, okToChngToIN is true if original pTerm satisfies
945 ** case 1. In that case, construct a new virtual term that is
946 ** pTerm converted into an IN operator.
947 */
948 if( okToChngToIN ){
949 Expr *pDup; /* A transient duplicate expression */
950 ExprList *pList = 0; /* The RHS of the IN operator */
951 Expr *pLeft = 0; /* The LHS of the IN operator */
952 Expr *pNew; /* The complete IN operator */
953
954 for(i=pOrWc->nTerm-1, pOrTerm=pOrWc->a; i>=0; i--, pOrTerm++){
955 if( (pOrTerm->wtFlags & TERM_OR_OK)==0 ) continue;
956 assert( pOrTerm->eOperator==WO_EQ );
957 assert( pOrTerm->leftCursor==iCursor );
958 assert( pOrTerm->u.leftColumn==iColumn );
danielk19776ab3a2e2009-02-19 14:39:25 +0000959 pDup = sqlite3ExprDup(db, pOrTerm->pExpr->pRight, 0);
drh1a58fe02008-12-20 02:06:13 +0000960 pList = sqlite3ExprListAppend(pWC->pParse, pList, pDup, 0);
961 pLeft = pOrTerm->pExpr->pLeft;
962 }
963 assert( pLeft!=0 );
danielk19776ab3a2e2009-02-19 14:39:25 +0000964 pDup = sqlite3ExprDup(db, pLeft, 0);
drh1a58fe02008-12-20 02:06:13 +0000965 pNew = sqlite3Expr(db, TK_IN, pDup, 0, 0);
966 if( pNew ){
967 int idxNew;
968 transferJoinMarkings(pNew, pExpr);
danielk19776ab3a2e2009-02-19 14:39:25 +0000969 assert( !ExprHasProperty(pNew, EP_xIsSelect) );
970 pNew->x.pList = pList;
drh1a58fe02008-12-20 02:06:13 +0000971 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
972 testcase( idxNew==0 );
973 exprAnalyze(pSrc, pWC, idxNew);
974 pTerm = &pWC->a[idxTerm];
975 pWC->a[idxNew].iParent = idxTerm;
976 pTerm->nChild = 1;
977 }else{
978 sqlite3ExprListDelete(db, pList);
979 }
980 pTerm->eOperator = 0; /* case 1 trumps case 2 */
981 }
drh3e355802007-02-23 23:13:33 +0000982 }
drh3e355802007-02-23 23:13:33 +0000983}
984#endif /* !SQLITE_OMIT_OR_OPTIMIZATION && !SQLITE_OMIT_SUBQUERY */
drh54a167d2005-11-26 14:08:07 +0000985
drh1a58fe02008-12-20 02:06:13 +0000986
drh54a167d2005-11-26 14:08:07 +0000987/*
drh0aa74ed2005-07-16 13:33:20 +0000988** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +0000989** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +0000990** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +0000991** structure.
drh51147ba2005-07-23 22:59:55 +0000992**
993** If the expression is of the form "<expr> <op> X" it gets commuted
drh1a58fe02008-12-20 02:06:13 +0000994** to the standard form of "X <op> <expr>".
995**
996** If the expression is of the form "X <op> Y" where both X and Y are
997** columns, then the original expression is unchanged and a new virtual
998** term of the form "Y <op> X" is added to the WHERE clause and
999** analyzed separately. The original term is marked with TERM_COPIED
1000** and the new term is marked with TERM_DYNAMIC (because it's pExpr
1001** needs to be freed with the WhereClause) and TERM_VIRTUAL (because it
1002** is a commuted copy of a prior term.) The original term has nChild=1
1003** and the copy has idxParent set to the index of the original term.
drh75897232000-05-29 14:26:00 +00001004*/
drh0fcef5e2005-07-19 17:38:22 +00001005static void exprAnalyze(
1006 SrcList *pSrc, /* the FROM clause */
drh9eb20282005-08-24 03:52:18 +00001007 WhereClause *pWC, /* the WHERE clause */
1008 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +00001009){
drh1a58fe02008-12-20 02:06:13 +00001010 WhereTerm *pTerm; /* The term to be analyzed */
drh111a6a72008-12-21 03:51:16 +00001011 WhereMaskSet *pMaskSet; /* Set of table index masks */
drh1a58fe02008-12-20 02:06:13 +00001012 Expr *pExpr; /* The expression to be analyzed */
1013 Bitmask prereqLeft; /* Prerequesites of the pExpr->pLeft */
1014 Bitmask prereqAll; /* Prerequesites of pExpr */
drhdafc0ce2008-04-17 19:14:02 +00001015 Bitmask extraRight = 0;
drhd2687b72005-08-12 22:56:09 +00001016 int nPattern;
1017 int isComplete;
drh9f504ea2008-02-23 21:55:39 +00001018 int noCase;
drh1a58fe02008-12-20 02:06:13 +00001019 int op; /* Top-level operator. pExpr->op */
1020 Parse *pParse = pWC->pParse; /* Parsing context */
1021 sqlite3 *db = pParse->db; /* Database connection */
drh0fcef5e2005-07-19 17:38:22 +00001022
drhf998b732007-11-26 13:36:00 +00001023 if( db->mallocFailed ){
1024 return;
1025 }
1026 pTerm = &pWC->a[idxTerm];
1027 pMaskSet = pWC->pMaskSet;
1028 pExpr = pTerm->pExpr;
drh0fcef5e2005-07-19 17:38:22 +00001029 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +00001030 op = pExpr->op;
1031 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +00001032 assert( pExpr->pRight==0 );
danielk19776ab3a2e2009-02-19 14:39:25 +00001033 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1034 pTerm->prereqRight = exprSelectTableUsage(pMaskSet, pExpr->x.pSelect);
1035 }else{
1036 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->x.pList);
1037 }
drh50b39962006-10-28 00:28:09 +00001038 }else if( op==TK_ISNULL ){
1039 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +00001040 }else{
1041 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
1042 }
drh22d6a532005-09-19 21:05:48 +00001043 prereqAll = exprTableUsage(pMaskSet, pExpr);
1044 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drh42165be2008-03-26 14:56:34 +00001045 Bitmask x = getMask(pMaskSet, pExpr->iRightJoinTable);
1046 prereqAll |= x;
drhdafc0ce2008-04-17 19:14:02 +00001047 extraRight = x-1; /* ON clause terms may not be used with an index
1048 ** on left table of a LEFT JOIN. Ticket #3015 */
drh22d6a532005-09-19 21:05:48 +00001049 }
1050 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +00001051 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +00001052 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +00001053 pTerm->eOperator = 0;
drh50b39962006-10-28 00:28:09 +00001054 if( allowedOp(op) && (pTerm->prereqRight & prereqLeft)==0 ){
drh0fcef5e2005-07-19 17:38:22 +00001055 Expr *pLeft = pExpr->pLeft;
1056 Expr *pRight = pExpr->pRight;
1057 if( pLeft->op==TK_COLUMN ){
1058 pTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001059 pTerm->u.leftColumn = pLeft->iColumn;
drh50b39962006-10-28 00:28:09 +00001060 pTerm->eOperator = operatorMask(op);
drh75897232000-05-29 14:26:00 +00001061 }
drh0fcef5e2005-07-19 17:38:22 +00001062 if( pRight && pRight->op==TK_COLUMN ){
1063 WhereTerm *pNew;
1064 Expr *pDup;
1065 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +00001066 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001067 pDup = sqlite3ExprDup(db, pExpr, 0);
drh17435752007-08-16 04:30:38 +00001068 if( db->mallocFailed ){
drh633e6d52008-07-28 19:34:53 +00001069 sqlite3ExprDelete(db, pDup);
drh28f45912006-10-18 23:26:38 +00001070 return;
1071 }
drh9eb20282005-08-24 03:52:18 +00001072 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
1073 if( idxNew==0 ) return;
1074 pNew = &pWC->a[idxNew];
1075 pNew->iParent = idxTerm;
1076 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +00001077 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001078 pTerm->wtFlags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +00001079 }else{
1080 pDup = pExpr;
1081 pNew = pTerm;
1082 }
drh7d10d5a2008-08-20 16:35:10 +00001083 exprCommute(pParse, pDup);
drh0fcef5e2005-07-19 17:38:22 +00001084 pLeft = pDup->pLeft;
1085 pNew->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001086 pNew->u.leftColumn = pLeft->iColumn;
drh0fcef5e2005-07-19 17:38:22 +00001087 pNew->prereqRight = prereqLeft;
1088 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +00001089 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +00001090 }
1091 }
drhed378002005-07-28 23:12:08 +00001092
drhd2687b72005-08-12 22:56:09 +00001093#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +00001094 /* If a term is the BETWEEN operator, create two new virtual terms
drh1a58fe02008-12-20 02:06:13 +00001095 ** that define the range that the BETWEEN implements. For example:
1096 **
1097 ** a BETWEEN b AND c
1098 **
1099 ** is converted into:
1100 **
1101 ** (a BETWEEN b AND c) AND (a>=b) AND (a<=c)
1102 **
1103 ** The two new terms are added onto the end of the WhereClause object.
1104 ** The new terms are "dynamic" and are children of the original BETWEEN
1105 ** term. That means that if the BETWEEN term is coded, the children are
1106 ** skipped. Or, if the children are satisfied by an index, the original
1107 ** BETWEEN term is skipped.
drhed378002005-07-28 23:12:08 +00001108 */
drh29435252008-12-28 18:35:08 +00001109 else if( pExpr->op==TK_BETWEEN && pWC->op==TK_AND ){
danielk19776ab3a2e2009-02-19 14:39:25 +00001110 ExprList *pList = pExpr->x.pList;
drhed378002005-07-28 23:12:08 +00001111 int i;
1112 static const u8 ops[] = {TK_GE, TK_LE};
1113 assert( pList!=0 );
1114 assert( pList->nExpr==2 );
1115 for(i=0; i<2; i++){
1116 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +00001117 int idxNew;
danielk19776ab3a2e2009-02-19 14:39:25 +00001118 pNewExpr = sqlite3Expr(db, ops[i], sqlite3ExprDup(db, pExpr->pLeft, 0),
1119 sqlite3ExprDup(db, pList->a[i].pExpr, 0), 0);
drh9eb20282005-08-24 03:52:18 +00001120 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001121 testcase( idxNew==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001122 exprAnalyze(pSrc, pWC, idxNew);
drh9eb20282005-08-24 03:52:18 +00001123 pTerm = &pWC->a[idxTerm];
1124 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +00001125 }
drh45b1ee42005-08-02 17:48:22 +00001126 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +00001127 }
drhd2687b72005-08-12 22:56:09 +00001128#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +00001129
danielk19771576cd92006-01-14 08:02:28 +00001130#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh1a58fe02008-12-20 02:06:13 +00001131 /* Analyze a term that is composed of two or more subterms connected by
1132 ** an OR operator.
drh6c30be82005-07-29 15:10:17 +00001133 */
1134 else if( pExpr->op==TK_OR ){
drh29435252008-12-28 18:35:08 +00001135 assert( pWC->op==TK_AND );
drh1a58fe02008-12-20 02:06:13 +00001136 exprAnalyzeOrTerm(pSrc, pWC, idxTerm);
drh6c30be82005-07-29 15:10:17 +00001137 }
drhd2687b72005-08-12 22:56:09 +00001138#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1139
1140#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
1141 /* Add constraints to reduce the search space on a LIKE or GLOB
1142 ** operator.
drh9f504ea2008-02-23 21:55:39 +00001143 **
1144 ** A like pattern of the form "x LIKE 'abc%'" is changed into constraints
1145 **
1146 ** x>='abc' AND x<'abd' AND x LIKE 'abc%'
1147 **
1148 ** The last character of the prefix "abc" is incremented to form the
shane7bc71e52008-05-28 18:01:44 +00001149 ** termination condition "abd".
drhd2687b72005-08-12 22:56:09 +00001150 */
drh29435252008-12-28 18:35:08 +00001151 if( isLikeOrGlob(pParse, pExpr, &nPattern, &isComplete, &noCase)
1152 && pWC->op==TK_AND ){
drhd2687b72005-08-12 22:56:09 +00001153 Expr *pLeft, *pRight;
1154 Expr *pStr1, *pStr2;
1155 Expr *pNewExpr1, *pNewExpr2;
drh9eb20282005-08-24 03:52:18 +00001156 int idxNew1, idxNew2;
1157
danielk19776ab3a2e2009-02-19 14:39:25 +00001158 pLeft = pExpr->x.pList->a[1].pExpr;
1159 pRight = pExpr->x.pList->a[0].pExpr;
drh17435752007-08-16 04:30:38 +00001160 pStr1 = sqlite3PExpr(pParse, TK_STRING, 0, 0, 0);
drhd2687b72005-08-12 22:56:09 +00001161 if( pStr1 ){
drh17435752007-08-16 04:30:38 +00001162 sqlite3TokenCopy(db, &pStr1->token, &pRight->token);
drhd2687b72005-08-12 22:56:09 +00001163 pStr1->token.n = nPattern;
drh9c86df52007-06-11 12:56:15 +00001164 pStr1->flags = EP_Dequoted;
drhd2687b72005-08-12 22:56:09 +00001165 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001166 pStr2 = sqlite3ExprDup(db, pStr1, 0);
drhf998b732007-11-26 13:36:00 +00001167 if( !db->mallocFailed ){
drh9f504ea2008-02-23 21:55:39 +00001168 u8 c, *pC;
danielk19776ab3a2e2009-02-19 14:39:25 +00001169 /* assert( pStr2->token.dyn ); */
drh9f504ea2008-02-23 21:55:39 +00001170 pC = (u8*)&pStr2->token.z[nPattern-1];
1171 c = *pC;
drh02a50b72008-05-26 18:33:40 +00001172 if( noCase ){
1173 if( c=='@' ) isComplete = 0;
1174 c = sqlite3UpperToLower[c];
1175 }
drh9f504ea2008-02-23 21:55:39 +00001176 *pC = c + 1;
drhd2687b72005-08-12 22:56:09 +00001177 }
danielk19776ab3a2e2009-02-19 14:39:25 +00001178 pNewExpr1 = sqlite3PExpr(pParse, TK_GE, sqlite3ExprDup(db,pLeft,0),pStr1,0);
drh9eb20282005-08-24 03:52:18 +00001179 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001180 testcase( idxNew1==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001181 exprAnalyze(pSrc, pWC, idxNew1);
danielk19776ab3a2e2009-02-19 14:39:25 +00001182 pNewExpr2 = sqlite3PExpr(pParse, TK_LT, sqlite3ExprDup(db,pLeft,0),pStr2,0);
drh9eb20282005-08-24 03:52:18 +00001183 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001184 testcase( idxNew2==0 );
drh7b4fc6a2007-02-06 13:26:32 +00001185 exprAnalyze(pSrc, pWC, idxNew2);
drh9eb20282005-08-24 03:52:18 +00001186 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +00001187 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +00001188 pWC->a[idxNew1].iParent = idxTerm;
1189 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +00001190 pTerm->nChild = 2;
1191 }
1192 }
1193#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +00001194
1195#ifndef SQLITE_OMIT_VIRTUALTABLE
1196 /* Add a WO_MATCH auxiliary term to the constraint set if the
1197 ** current expression is of the form: column MATCH expr.
1198 ** This information is used by the xBestIndex methods of
1199 ** virtual tables. The native query optimizer does not attempt
1200 ** to do anything with MATCH functions.
1201 */
1202 if( isMatchOfColumn(pExpr) ){
1203 int idxNew;
1204 Expr *pRight, *pLeft;
1205 WhereTerm *pNewTerm;
1206 Bitmask prereqColumn, prereqExpr;
1207
danielk19776ab3a2e2009-02-19 14:39:25 +00001208 pRight = pExpr->x.pList->a[0].pExpr;
1209 pLeft = pExpr->x.pList->a[1].pExpr;
drh7f375902006-06-13 17:38:59 +00001210 prereqExpr = exprTableUsage(pMaskSet, pRight);
1211 prereqColumn = exprTableUsage(pMaskSet, pLeft);
1212 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +00001213 Expr *pNewExpr;
danielk19776ab3a2e2009-02-19 14:39:25 +00001214 pNewExpr = sqlite3Expr(db, TK_MATCH, 0, sqlite3ExprDup(db, pRight, 0), 0);
drh1a90e092006-06-14 22:07:10 +00001215 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh6a1e0712008-12-05 15:24:15 +00001216 testcase( idxNew==0 );
drh7f375902006-06-13 17:38:59 +00001217 pNewTerm = &pWC->a[idxNew];
1218 pNewTerm->prereqRight = prereqExpr;
1219 pNewTerm->leftCursor = pLeft->iTable;
drh700a2262008-12-17 19:22:15 +00001220 pNewTerm->u.leftColumn = pLeft->iColumn;
drh7f375902006-06-13 17:38:59 +00001221 pNewTerm->eOperator = WO_MATCH;
1222 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +00001223 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +00001224 pTerm->nChild = 1;
drh165be382008-12-05 02:36:33 +00001225 pTerm->wtFlags |= TERM_COPIED;
drh7f375902006-06-13 17:38:59 +00001226 pNewTerm->prereqAll = pTerm->prereqAll;
1227 }
1228 }
1229#endif /* SQLITE_OMIT_VIRTUALTABLE */
drhdafc0ce2008-04-17 19:14:02 +00001230
1231 /* Prevent ON clause terms of a LEFT JOIN from being used to drive
1232 ** an index for tables to the left of the join.
1233 */
1234 pTerm->prereqRight |= extraRight;
drh75897232000-05-29 14:26:00 +00001235}
1236
drh7b4fc6a2007-02-06 13:26:32 +00001237/*
1238** Return TRUE if any of the expressions in pList->a[iFirst...] contain
1239** a reference to any table other than the iBase table.
1240*/
1241static int referencesOtherTables(
1242 ExprList *pList, /* Search expressions in ths list */
drh111a6a72008-12-21 03:51:16 +00001243 WhereMaskSet *pMaskSet, /* Mapping from tables to bitmaps */
drh7b4fc6a2007-02-06 13:26:32 +00001244 int iFirst, /* Be searching with the iFirst-th expression */
1245 int iBase /* Ignore references to this table */
1246){
1247 Bitmask allowed = ~getMask(pMaskSet, iBase);
1248 while( iFirst<pList->nExpr ){
1249 if( (exprTableUsage(pMaskSet, pList->a[iFirst++].pExpr)&allowed)!=0 ){
1250 return 1;
1251 }
1252 }
1253 return 0;
1254}
1255
drh0fcef5e2005-07-19 17:38:22 +00001256
drh75897232000-05-29 14:26:00 +00001257/*
drh51669862004-12-18 18:40:26 +00001258** This routine decides if pIdx can be used to satisfy the ORDER BY
1259** clause. If it can, it returns 1. If pIdx cannot satisfy the
1260** ORDER BY clause, this routine returns 0.
1261**
1262** pOrderBy is an ORDER BY clause from a SELECT statement. pTab is the
1263** left-most table in the FROM clause of that same SELECT statement and
1264** the table has a cursor number of "base". pIdx is an index on pTab.
1265**
1266** nEqCol is the number of columns of pIdx that are used as equality
1267** constraints. Any of these columns may be missing from the ORDER BY
1268** clause and the match can still be a success.
1269**
drh51669862004-12-18 18:40:26 +00001270** All terms of the ORDER BY that match against the index must be either
1271** ASC or DESC. (Terms of the ORDER BY clause past the end of a UNIQUE
1272** index do not need to satisfy this constraint.) The *pbRev value is
1273** set to 1 if the ORDER BY clause is all DESC and it is set to 0 if
1274** the ORDER BY clause is all ASC.
1275*/
1276static int isSortingIndex(
1277 Parse *pParse, /* Parsing context */
drh111a6a72008-12-21 03:51:16 +00001278 WhereMaskSet *pMaskSet, /* Mapping from table cursor numbers to bitmaps */
drh51669862004-12-18 18:40:26 +00001279 Index *pIdx, /* The index we are testing */
drh74161702006-02-24 02:53:49 +00001280 int base, /* Cursor number for the table to be sorted */
drh51669862004-12-18 18:40:26 +00001281 ExprList *pOrderBy, /* The ORDER BY clause */
1282 int nEqCol, /* Number of index columns with == constraints */
1283 int *pbRev /* Set to 1 if ORDER BY is DESC */
1284){
drhb46b5772005-08-29 16:40:52 +00001285 int i, j; /* Loop counters */
drh85eeb692005-12-21 03:16:42 +00001286 int sortOrder = 0; /* XOR of index and ORDER BY sort direction */
drhb46b5772005-08-29 16:40:52 +00001287 int nTerm; /* Number of ORDER BY terms */
1288 struct ExprList_item *pTerm; /* A term of the ORDER BY clause */
drh51669862004-12-18 18:40:26 +00001289 sqlite3 *db = pParse->db;
1290
1291 assert( pOrderBy!=0 );
1292 nTerm = pOrderBy->nExpr;
1293 assert( nTerm>0 );
1294
1295 /* Match terms of the ORDER BY clause against columns of
1296 ** the index.
drhcc192542006-12-20 03:24:19 +00001297 **
1298 ** Note that indices have pIdx->nColumn regular columns plus
1299 ** one additional column containing the rowid. The rowid column
1300 ** of the index is also allowed to match against the ORDER BY
1301 ** clause.
drh51669862004-12-18 18:40:26 +00001302 */
drhcc192542006-12-20 03:24:19 +00001303 for(i=j=0, pTerm=pOrderBy->a; j<nTerm && i<=pIdx->nColumn; i++){
drh51669862004-12-18 18:40:26 +00001304 Expr *pExpr; /* The expression of the ORDER BY pTerm */
1305 CollSeq *pColl; /* The collating sequence of pExpr */
drh85eeb692005-12-21 03:16:42 +00001306 int termSortOrder; /* Sort order for this term */
drhcc192542006-12-20 03:24:19 +00001307 int iColumn; /* The i-th column of the index. -1 for rowid */
1308 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
1309 const char *zColl; /* Name of the collating sequence for i-th index term */
drh51669862004-12-18 18:40:26 +00001310
1311 pExpr = pTerm->pExpr;
1312 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=base ){
1313 /* Can not use an index sort on anything that is not a column in the
1314 ** left-most table of the FROM clause */
drh7b4fc6a2007-02-06 13:26:32 +00001315 break;
drh51669862004-12-18 18:40:26 +00001316 }
1317 pColl = sqlite3ExprCollSeq(pParse, pExpr);
drhcc192542006-12-20 03:24:19 +00001318 if( !pColl ){
1319 pColl = db->pDfltColl;
1320 }
1321 if( i<pIdx->nColumn ){
1322 iColumn = pIdx->aiColumn[i];
1323 if( iColumn==pIdx->pTable->iPKey ){
1324 iColumn = -1;
1325 }
1326 iSortOrder = pIdx->aSortOrder[i];
1327 zColl = pIdx->azColl[i];
1328 }else{
1329 iColumn = -1;
1330 iSortOrder = 0;
1331 zColl = pColl->zName;
1332 }
1333 if( pExpr->iColumn!=iColumn || sqlite3StrICmp(pColl->zName, zColl) ){
drh9012bcb2004-12-19 00:11:35 +00001334 /* Term j of the ORDER BY clause does not match column i of the index */
1335 if( i<nEqCol ){
drh51669862004-12-18 18:40:26 +00001336 /* If an index column that is constrained by == fails to match an
1337 ** ORDER BY term, that is OK. Just ignore that column of the index
1338 */
1339 continue;
drhff354e92008-06-25 02:47:57 +00001340 }else if( i==pIdx->nColumn ){
1341 /* Index column i is the rowid. All other terms match. */
1342 break;
drh51669862004-12-18 18:40:26 +00001343 }else{
1344 /* If an index column fails to match and is not constrained by ==
1345 ** then the index cannot satisfy the ORDER BY constraint.
1346 */
1347 return 0;
1348 }
1349 }
danielk1977b3bf5562006-01-10 17:58:23 +00001350 assert( pIdx->aSortOrder!=0 );
drh85eeb692005-12-21 03:16:42 +00001351 assert( pTerm->sortOrder==0 || pTerm->sortOrder==1 );
drhcc192542006-12-20 03:24:19 +00001352 assert( iSortOrder==0 || iSortOrder==1 );
1353 termSortOrder = iSortOrder ^ pTerm->sortOrder;
drh51669862004-12-18 18:40:26 +00001354 if( i>nEqCol ){
drh85eeb692005-12-21 03:16:42 +00001355 if( termSortOrder!=sortOrder ){
drh51669862004-12-18 18:40:26 +00001356 /* Indices can only be used if all ORDER BY terms past the
1357 ** equality constraints are all either DESC or ASC. */
1358 return 0;
1359 }
1360 }else{
drh85eeb692005-12-21 03:16:42 +00001361 sortOrder = termSortOrder;
drh51669862004-12-18 18:40:26 +00001362 }
1363 j++;
1364 pTerm++;
drh7b4fc6a2007-02-06 13:26:32 +00001365 if( iColumn<0 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001366 /* If the indexed column is the primary key and everything matches
drh7b4fc6a2007-02-06 13:26:32 +00001367 ** so far and none of the ORDER BY terms to the right reference other
1368 ** tables in the join, then we are assured that the index can be used
1369 ** to sort because the primary key is unique and so none of the other
1370 ** columns will make any difference
drhcc192542006-12-20 03:24:19 +00001371 */
1372 j = nTerm;
1373 }
drh51669862004-12-18 18:40:26 +00001374 }
1375
drhcc192542006-12-20 03:24:19 +00001376 *pbRev = sortOrder!=0;
drh8718f522005-08-13 16:13:04 +00001377 if( j>=nTerm ){
drhcc192542006-12-20 03:24:19 +00001378 /* All terms of the ORDER BY clause are covered by this index so
1379 ** this index can be used for sorting. */
1380 return 1;
1381 }
drh7b4fc6a2007-02-06 13:26:32 +00001382 if( pIdx->onError!=OE_None && i==pIdx->nColumn
1383 && !referencesOtherTables(pOrderBy, pMaskSet, j, base) ){
drhcc192542006-12-20 03:24:19 +00001384 /* All terms of this index match some prefix of the ORDER BY clause
drh7b4fc6a2007-02-06 13:26:32 +00001385 ** and the index is UNIQUE and no terms on the tail of the ORDER BY
1386 ** clause reference other tables in a join. If this is all true then
1387 ** the order by clause is superfluous. */
drh51669862004-12-18 18:40:26 +00001388 return 1;
1389 }
1390 return 0;
1391}
1392
1393/*
drhb6c29892004-11-22 19:12:19 +00001394** Check table to see if the ORDER BY clause in pOrderBy can be satisfied
1395** by sorting in order of ROWID. Return true if so and set *pbRev to be
1396** true for reverse ROWID and false for forward ROWID order.
1397*/
1398static int sortableByRowid(
1399 int base, /* Cursor number for table to be sorted */
1400 ExprList *pOrderBy, /* The ORDER BY clause */
drh111a6a72008-12-21 03:51:16 +00001401 WhereMaskSet *pMaskSet, /* Mapping from table cursors to bitmaps */
drhb6c29892004-11-22 19:12:19 +00001402 int *pbRev /* Set to 1 if ORDER BY is DESC */
1403){
1404 Expr *p;
1405
1406 assert( pOrderBy!=0 );
1407 assert( pOrderBy->nExpr>0 );
1408 p = pOrderBy->a[0].pExpr;
drh7b4fc6a2007-02-06 13:26:32 +00001409 if( p->op==TK_COLUMN && p->iTable==base && p->iColumn==-1
1410 && !referencesOtherTables(pOrderBy, pMaskSet, 1, base) ){
drhb6c29892004-11-22 19:12:19 +00001411 *pbRev = pOrderBy->a[0].sortOrder;
1412 return 1;
1413 }
1414 return 0;
1415}
1416
drhfe05af82005-07-21 03:14:59 +00001417/*
drhb6fb62d2005-09-20 08:47:20 +00001418** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +00001419** The results need not be exact. This is only used for estimating
drh909626d2008-05-30 14:58:37 +00001420** the total cost of performing operations with O(logN) or O(NlogN)
drh28c4cf42005-07-27 20:41:43 +00001421** complexity. Because N is just a guess, it is no great tragedy if
1422** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +00001423*/
1424static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +00001425 double logN = 1;
1426 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001427 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001428 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001429 x *= 10;
1430 }
1431 return logN;
1432}
1433
drh6d209d82006-06-27 01:54:26 +00001434/*
1435** Two routines for printing the content of an sqlite3_index_info
1436** structure. Used for testing and debugging only. If neither
1437** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1438** are no-ops.
1439*/
drh77a2a5e2007-04-06 01:04:39 +00001440#if !defined(SQLITE_OMIT_VIRTUALTABLE) && defined(SQLITE_DEBUG)
drh6d209d82006-06-27 01:54:26 +00001441static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1442 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001443 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001444 for(i=0; i<p->nConstraint; i++){
1445 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1446 i,
1447 p->aConstraint[i].iColumn,
1448 p->aConstraint[i].iTermOffset,
1449 p->aConstraint[i].op,
1450 p->aConstraint[i].usable);
1451 }
1452 for(i=0; i<p->nOrderBy; i++){
1453 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1454 i,
1455 p->aOrderBy[i].iColumn,
1456 p->aOrderBy[i].desc);
1457 }
1458}
1459static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1460 int i;
mlcreech3a00f902008-03-04 17:45:01 +00001461 if( !sqlite3WhereTrace ) return;
drh6d209d82006-06-27 01:54:26 +00001462 for(i=0; i<p->nConstraint; i++){
1463 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1464 i,
1465 p->aConstraintUsage[i].argvIndex,
1466 p->aConstraintUsage[i].omit);
1467 }
1468 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1469 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1470 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1471 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1472}
1473#else
1474#define TRACE_IDX_INPUTS(A)
1475#define TRACE_IDX_OUTPUTS(A)
1476#endif
1477
drh9eff6162006-06-12 21:59:13 +00001478#ifndef SQLITE_OMIT_VIRTUALTABLE
1479/*
drh7f375902006-06-13 17:38:59 +00001480** Compute the best index for a virtual table.
1481**
1482** The best index is computed by the xBestIndex method of the virtual
1483** table module. This routine is really just a wrapper that sets up
1484** the sqlite3_index_info structure that is used to communicate with
1485** xBestIndex.
1486**
1487** In a join, this routine might be called multiple times for the
1488** same virtual table. The sqlite3_index_info structure is created
1489** and initialized on the first invocation and reused on all subsequent
1490** invocations. The sqlite3_index_info structure is also used when
1491** code is generated to access the virtual table. The whereInfoDelete()
1492** routine takes care of freeing the sqlite3_index_info structure after
1493** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00001494*/
1495static double bestVirtualIndex(
1496 Parse *pParse, /* The parsing context */
1497 WhereClause *pWC, /* The WHERE clause */
1498 struct SrcList_item *pSrc, /* The FROM clause term to search */
1499 Bitmask notReady, /* Mask of cursors that are not available */
1500 ExprList *pOrderBy, /* The order by clause */
1501 int orderByUsable, /* True if we can potential sort */
1502 sqlite3_index_info **ppIdxInfo /* Index information passed to xBestIndex */
1503){
1504 Table *pTab = pSrc->pTab;
danielk19773e3a84d2008-08-01 17:37:40 +00001505 sqlite3_vtab *pVtab = pTab->pVtab;
drh9eff6162006-06-12 21:59:13 +00001506 sqlite3_index_info *pIdxInfo;
1507 struct sqlite3_index_constraint *pIdxCons;
1508 struct sqlite3_index_orderby *pIdxOrderBy;
1509 struct sqlite3_index_constraint_usage *pUsage;
1510 WhereTerm *pTerm;
1511 int i, j;
1512 int nOrderBy;
danielk197774cdba42006-06-19 12:02:58 +00001513 int rc;
drh9eff6162006-06-12 21:59:13 +00001514
1515 /* If the sqlite3_index_info structure has not been previously
1516 ** allocated and initialized for this virtual table, then allocate
1517 ** and initialize it now
1518 */
1519 pIdxInfo = *ppIdxInfo;
1520 if( pIdxInfo==0 ){
drh9eff6162006-06-12 21:59:13 +00001521 int nTerm;
drh4f0c5872007-03-26 22:05:01 +00001522 WHERETRACE(("Recomputing index info for %s...\n", pTab->zName));
drh9eff6162006-06-12 21:59:13 +00001523
1524 /* Count the number of possible WHERE clause constraints referring
1525 ** to this virtual table */
1526 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1527 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001528 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001529 testcase( pTerm->eOperator==WO_IN );
1530 testcase( pTerm->eOperator==WO_ISNULL );
1531 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh9eff6162006-06-12 21:59:13 +00001532 nTerm++;
1533 }
1534
1535 /* If the ORDER BY clause contains only columns in the current
1536 ** virtual table then allocate space for the aOrderBy part of
1537 ** the sqlite3_index_info structure.
1538 */
1539 nOrderBy = 0;
1540 if( pOrderBy ){
1541 for(i=0; i<pOrderBy->nExpr; i++){
1542 Expr *pExpr = pOrderBy->a[i].pExpr;
1543 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1544 }
1545 if( i==pOrderBy->nExpr ){
1546 nOrderBy = pOrderBy->nExpr;
1547 }
1548 }
1549
1550 /* Allocate the sqlite3_index_info structure
1551 */
danielk197726783a52007-08-29 14:06:22 +00001552 pIdxInfo = sqlite3DbMallocZero(pParse->db, sizeof(*pIdxInfo)
drh9eff6162006-06-12 21:59:13 +00001553 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1554 + sizeof(*pIdxOrderBy)*nOrderBy );
1555 if( pIdxInfo==0 ){
1556 sqlite3ErrorMsg(pParse, "out of memory");
shanefbd60f82009-02-04 03:59:25 +00001557 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
1558 return (double)0;
drh9eff6162006-06-12 21:59:13 +00001559 }
1560 *ppIdxInfo = pIdxInfo;
1561
1562 /* Initialize the structure. The sqlite3_index_info structure contains
1563 ** many fields that are declared "const" to prevent xBestIndex from
1564 ** changing them. We have to do some funky casting in order to
1565 ** initialize those fields.
1566 */
1567 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1568 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1569 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1570 *(int*)&pIdxInfo->nConstraint = nTerm;
1571 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1572 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1573 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1574 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1575 pUsage;
1576
1577 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1578 if( pTerm->leftCursor != pSrc->iCursor ) continue;
drh4d9f9e62008-08-25 12:08:22 +00001579 assert( (pTerm->eOperator&(pTerm->eOperator-1))==0 );
drh981642f2008-04-19 14:40:43 +00001580 testcase( pTerm->eOperator==WO_IN );
1581 testcase( pTerm->eOperator==WO_ISNULL );
1582 if( pTerm->eOperator & (WO_IN|WO_ISNULL) ) continue;
drh700a2262008-12-17 19:22:15 +00001583 pIdxCons[j].iColumn = pTerm->u.leftColumn;
drh9eff6162006-06-12 21:59:13 +00001584 pIdxCons[j].iTermOffset = i;
drhec1724e2008-12-09 01:32:03 +00001585 pIdxCons[j].op = (u8)pTerm->eOperator;
drh7f375902006-06-13 17:38:59 +00001586 /* The direct assignment in the previous line is possible only because
1587 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1588 ** following asserts verify this fact. */
drh9eff6162006-06-12 21:59:13 +00001589 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1590 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1591 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1592 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1593 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
drh7f375902006-06-13 17:38:59 +00001594 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
1595 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
drh9eff6162006-06-12 21:59:13 +00001596 j++;
1597 }
1598 for(i=0; i<nOrderBy; i++){
1599 Expr *pExpr = pOrderBy->a[i].pExpr;
1600 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1601 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1602 }
1603 }
1604
drh7f375902006-06-13 17:38:59 +00001605 /* At this point, the sqlite3_index_info structure that pIdxInfo points
1606 ** to will have been initialized, either during the current invocation or
1607 ** during some prior invocation. Now we just have to customize the
1608 ** details of pIdxInfo for the current invocation and pass it to
1609 ** xBestIndex.
1610 */
1611
danielk1977935ed5e2007-03-30 09:13:13 +00001612 /* The module name must be defined. Also, by this point there must
1613 ** be a pointer to an sqlite3_vtab structure. Otherwise
1614 ** sqlite3ViewGetColumnNames() would have picked up the error.
1615 */
drh9eff6162006-06-12 21:59:13 +00001616 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
danielk19773e3a84d2008-08-01 17:37:40 +00001617 assert( pVtab );
danielk1977935ed5e2007-03-30 09:13:13 +00001618#if 0
drh9eff6162006-06-12 21:59:13 +00001619 if( pTab->pVtab==0 ){
1620 sqlite3ErrorMsg(pParse, "undefined module %s for table %s",
1621 pTab->azModuleArg[0], pTab->zName);
1622 return 0.0;
1623 }
danielk1977935ed5e2007-03-30 09:13:13 +00001624#endif
drh9eff6162006-06-12 21:59:13 +00001625
1626 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00001627 ** output variables to zero.
1628 **
1629 ** aConstraint[].usable is true for constraints where the right-hand
1630 ** side contains only references to tables to the left of the current
1631 ** table. In other words, if the constraint is of the form:
1632 **
1633 ** column = expr
1634 **
1635 ** and we are evaluating a join, then the constraint on column is
1636 ** only valid if all tables referenced in expr occur to the left
1637 ** of the table containing column.
1638 **
1639 ** The aConstraints[] array contains entries for all constraints
1640 ** on the current table. That way we only have to compute it once
1641 ** even though we might try to pick the best index multiple times.
1642 ** For each attempt at picking an index, the order of tables in the
1643 ** join might be different so we have to recompute the usable flag
1644 ** each time.
drh9eff6162006-06-12 21:59:13 +00001645 */
1646 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
1647 pUsage = pIdxInfo->aConstraintUsage;
1648 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
1649 j = pIdxCons->iTermOffset;
1650 pTerm = &pWC->a[j];
drhec1724e2008-12-09 01:32:03 +00001651 pIdxCons->usable = (pTerm->prereqRight & notReady)==0 ?1:0;
drh9eff6162006-06-12 21:59:13 +00001652 }
1653 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00001654 if( pIdxInfo->needToFreeIdxStr ){
1655 sqlite3_free(pIdxInfo->idxStr);
1656 }
1657 pIdxInfo->idxStr = 0;
1658 pIdxInfo->idxNum = 0;
1659 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00001660 pIdxInfo->orderByConsumed = 0;
shanefbd60f82009-02-04 03:59:25 +00001661 /* ((double)2) In case of SQLITE_OMIT_FLOATING_POINT... */
1662 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / ((double)2);
drh9eff6162006-06-12 21:59:13 +00001663 nOrderBy = pIdxInfo->nOrderBy;
1664 if( pIdxInfo->nOrderBy && !orderByUsable ){
drha967e882006-06-13 01:04:52 +00001665 *(int*)&pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00001666 }
danielk197774cdba42006-06-19 12:02:58 +00001667
drh7e8b8482008-01-23 03:03:05 +00001668 (void)sqlite3SafetyOff(pParse->db);
drh4f0c5872007-03-26 22:05:01 +00001669 WHERETRACE(("xBestIndex for %s\n", pTab->zName));
drh6d209d82006-06-27 01:54:26 +00001670 TRACE_IDX_INPUTS(pIdxInfo);
danielk19773e3a84d2008-08-01 17:37:40 +00001671 rc = pVtab->pModule->xBestIndex(pVtab, pIdxInfo);
drh6d209d82006-06-27 01:54:26 +00001672 TRACE_IDX_OUTPUTS(pIdxInfo);
danielk197739359dc2008-03-17 09:36:44 +00001673 (void)sqlite3SafetyOn(pParse->db);
1674
danielk19773e3a84d2008-08-01 17:37:40 +00001675 if( rc!=SQLITE_OK ){
1676 if( rc==SQLITE_NOMEM ){
1677 pParse->db->mallocFailed = 1;
1678 }else if( !pVtab->zErrMsg ){
1679 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1680 }else{
1681 sqlite3ErrorMsg(pParse, "%s", pVtab->zErrMsg);
1682 }
1683 }
1684 sqlite3DbFree(pParse->db, pVtab->zErrMsg);
1685 pVtab->zErrMsg = 0;
1686
danielk197739359dc2008-03-17 09:36:44 +00001687 for(i=0; i<pIdxInfo->nConstraint; i++){
1688 if( !pIdxInfo->aConstraint[i].usable && pUsage[i].argvIndex>0 ){
1689 sqlite3ErrorMsg(pParse,
1690 "table %s: xBestIndex returned an invalid plan", pTab->zName);
shanefbd60f82009-02-04 03:59:25 +00001691 /* (double)0 In case of SQLITE_OMIT_FLOATING_POINT... */
1692 return (double)0;
danielk197739359dc2008-03-17 09:36:44 +00001693 }
1694 }
1695
drha967e882006-06-13 01:04:52 +00001696 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
drh9eff6162006-06-12 21:59:13 +00001697 return pIdxInfo->estimatedCost;
1698}
1699#endif /* SQLITE_OMIT_VIRTUALTABLE */
1700
drh28c4cf42005-07-27 20:41:43 +00001701/*
drh111a6a72008-12-21 03:51:16 +00001702** Find the query plan for accessing a particular table. Write the
1703** best query plan and its cost into the WhereCost object supplied as the
1704** last parameter.
drh51147ba2005-07-23 22:59:55 +00001705**
drh111a6a72008-12-21 03:51:16 +00001706** The lowest cost plan wins. The cost is an estimate of the amount of
1707** CPU and disk I/O need to process the request using the selected plan.
drh51147ba2005-07-23 22:59:55 +00001708** Factors that influence cost include:
1709**
1710** * The estimated number of rows that will be retrieved. (The
1711** fewer the better.)
1712**
1713** * Whether or not sorting must occur.
1714**
1715** * Whether or not there must be separate lookups in the
1716** index and in the main table.
1717**
danielk1977e2d7b242009-02-23 17:33:49 +00001718** If there was an INDEXED BY clause (pSrc->pIndex) attached to the table in
1719** the SQL statement, then this function only considers plans using the
drh296a4832009-03-22 20:36:18 +00001720** named index. If no such plan is found, then the returned cost is
1721** SQLITE_BIG_DBL. If a plan is found that uses the named index,
danielk197785574e32008-10-06 05:32:18 +00001722** then the cost is calculated in the usual way.
1723**
danielk1977e2d7b242009-02-23 17:33:49 +00001724** If a NOT INDEXED clause (pSrc->notIndexed!=0) was attached to the table
1725** in the SELECT statement, then no indexes are considered. However, the
1726** selected plan may still take advantage of the tables built-in rowid
danielk197785574e32008-10-06 05:32:18 +00001727** index.
drhfe05af82005-07-21 03:14:59 +00001728*/
drh111a6a72008-12-21 03:51:16 +00001729static void bestIndex(
drhfe05af82005-07-21 03:14:59 +00001730 Parse *pParse, /* The parsing context */
1731 WhereClause *pWC, /* The WHERE clause */
1732 struct SrcList_item *pSrc, /* The FROM clause term to search */
1733 Bitmask notReady, /* Mask of cursors that are not available */
drh111a6a72008-12-21 03:51:16 +00001734 ExprList *pOrderBy, /* The ORDER BY clause */
1735 WhereCost *pCost /* Lowest cost query plan */
drhfe05af82005-07-21 03:14:59 +00001736){
drh111a6a72008-12-21 03:51:16 +00001737 WhereTerm *pTerm; /* A single term of the WHERE clause */
drh51147ba2005-07-23 22:59:55 +00001738 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
1739 Index *pProbe; /* An index we are evaluating */
1740 int rev; /* True to scan in reverse order */
drh165be382008-12-05 02:36:33 +00001741 int wsFlags; /* Flags associated with pProbe */
drh51147ba2005-07-23 22:59:55 +00001742 int nEq; /* Number of == or IN constraints */
drhc49de5d2007-01-19 01:06:01 +00001743 int eqTermMask; /* Mask of valid equality operators */
drh51147ba2005-07-23 22:59:55 +00001744 double cost; /* Cost of using pProbe */
drh111a6a72008-12-21 03:51:16 +00001745 double nRow; /* Estimated number of rows in result set */
drhdd5f5a62008-12-23 13:35:23 +00001746 int i; /* Loop counter */
1747 Bitmask maskSrc; /* Bitmask for the pSrc table */
drhfe05af82005-07-21 03:14:59 +00001748
drh165be382008-12-05 02:36:33 +00001749 WHERETRACE(("bestIndex: tbl=%s notReady=%llx\n", pSrc->pTab->zName,notReady));
drh4dd238a2006-03-28 23:55:57 +00001750 pProbe = pSrc->pTab->pIndex;
danielk197785574e32008-10-06 05:32:18 +00001751 if( pSrc->notIndexed ){
1752 pProbe = 0;
1753 }
drh4dd238a2006-03-28 23:55:57 +00001754
1755 /* If the table has no indices and there are no terms in the where
1756 ** clause that refer to the ROWID, then we will never be able to do
1757 ** anything other than a full table scan on this table. We might as
1758 ** well put it first in the join order. That way, perhaps it can be
1759 ** referenced by other tables in the join.
1760 */
drh111a6a72008-12-21 03:51:16 +00001761 memset(pCost, 0, sizeof(*pCost));
drh4dd238a2006-03-28 23:55:57 +00001762 if( pProbe==0 &&
1763 findTerm(pWC, iCur, -1, 0, WO_EQ|WO_IN|WO_LT|WO_LE|WO_GT|WO_GE,0)==0 &&
drh7b4fc6a2007-02-06 13:26:32 +00001764 (pOrderBy==0 || !sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev)) ){
drh111a6a72008-12-21 03:51:16 +00001765 return;
drh4dd238a2006-03-28 23:55:57 +00001766 }
drh111a6a72008-12-21 03:51:16 +00001767 pCost->rCost = SQLITE_BIG_DBL;
drh51147ba2005-07-23 22:59:55 +00001768
danielk197785574e32008-10-06 05:32:18 +00001769 /* Check for a rowid=EXPR or rowid IN (...) constraints. If there was
1770 ** an INDEXED BY clause attached to this table, skip this step.
drhfe05af82005-07-21 03:14:59 +00001771 */
danielk197785574e32008-10-06 05:32:18 +00001772 if( !pSrc->pIndex ){
1773 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
1774 if( pTerm ){
1775 Expr *pExpr;
drh111a6a72008-12-21 03:51:16 +00001776 pCost->plan.wsFlags = WHERE_ROWID_EQ;
danielk197785574e32008-10-06 05:32:18 +00001777 if( pTerm->eOperator & WO_EQ ){
1778 /* Rowid== is always the best pick. Look no further. Because only
1779 ** a single row is generated, output is always in sorted order */
drh111a6a72008-12-21 03:51:16 +00001780 pCost->plan.wsFlags = WHERE_ROWID_EQ | WHERE_UNIQUE;
1781 pCost->plan.nEq = 1;
danielk197785574e32008-10-06 05:32:18 +00001782 WHERETRACE(("... best is rowid\n"));
drh111a6a72008-12-21 03:51:16 +00001783 pCost->rCost = 0;
1784 pCost->nRow = 1;
1785 return;
danielk19776ab3a2e2009-02-19 14:39:25 +00001786 }else if( !ExprHasProperty((pExpr = pTerm->pExpr), EP_xIsSelect)
1787 && pExpr->x.pList
1788 ){
danielk197785574e32008-10-06 05:32:18 +00001789 /* Rowid IN (LIST): cost is NlogN where N is the number of list
1790 ** elements. */
danielk19776ab3a2e2009-02-19 14:39:25 +00001791 pCost->rCost = pCost->nRow = pExpr->x.pList->nExpr;
drh111a6a72008-12-21 03:51:16 +00001792 pCost->rCost *= estLog(pCost->rCost);
danielk197785574e32008-10-06 05:32:18 +00001793 }else{
1794 /* Rowid IN (SELECT): cost is NlogN where N is the number of rows
1795 ** in the result of the inner select. We have no way to estimate
1796 ** that value so make a wild guess. */
drh111a6a72008-12-21 03:51:16 +00001797 pCost->nRow = 100;
1798 pCost->rCost = 200;
drh28c4cf42005-07-27 20:41:43 +00001799 }
drh111a6a72008-12-21 03:51:16 +00001800 WHERETRACE(("... rowid IN cost: %.9g\n", pCost->rCost));
drh51147ba2005-07-23 22:59:55 +00001801 }
danielk197785574e32008-10-06 05:32:18 +00001802
1803 /* Estimate the cost of a table scan. If we do not know how many
1804 ** entries are in the table, use 1 million as a guess.
1805 */
1806 cost = pProbe ? pProbe->aiRowEst[0] : 1000000;
1807 WHERETRACE(("... table scan base cost: %.9g\n", cost));
drh165be382008-12-05 02:36:33 +00001808 wsFlags = WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001809
1810 /* Check for constraints on a range of rowids in a table scan.
1811 */
1812 pTerm = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE|WO_GT|WO_GE, 0);
1813 if( pTerm ){
1814 if( findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0) ){
drh165be382008-12-05 02:36:33 +00001815 wsFlags |= WHERE_TOP_LIMIT;
drh700a2262008-12-17 19:22:15 +00001816 cost /= 3; /* Guess that rowid<EXPR eliminates two-thirds of rows */
danielk197785574e32008-10-06 05:32:18 +00001817 }
1818 if( findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0) ){
drh165be382008-12-05 02:36:33 +00001819 wsFlags |= WHERE_BTM_LIMIT;
danielk197785574e32008-10-06 05:32:18 +00001820 cost /= 3; /* Guess that rowid>EXPR eliminates two-thirds of rows */
1821 }
1822 WHERETRACE(("... rowid range reduces cost to %.9g\n", cost));
1823 }else{
drh165be382008-12-05 02:36:33 +00001824 wsFlags = 0;
danielk197785574e32008-10-06 05:32:18 +00001825 }
drh111a6a72008-12-21 03:51:16 +00001826 nRow = cost;
danielk197785574e32008-10-06 05:32:18 +00001827
1828 /* If the table scan does not satisfy the ORDER BY clause, increase
1829 ** the cost by NlogN to cover the expense of sorting. */
1830 if( pOrderBy ){
1831 if( sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev) ){
drh165be382008-12-05 02:36:33 +00001832 wsFlags |= WHERE_ORDERBY|WHERE_ROWID_RANGE;
danielk197785574e32008-10-06 05:32:18 +00001833 if( rev ){
drh165be382008-12-05 02:36:33 +00001834 wsFlags |= WHERE_REVERSE;
danielk197785574e32008-10-06 05:32:18 +00001835 }
1836 }else{
1837 cost += cost*estLog(cost);
1838 WHERETRACE(("... sorting increases cost to %.9g\n", cost));
1839 }
drh699b3d42009-02-23 16:52:07 +00001840 }else if( pParse->db->flags & SQLITE_ReverseOrder ){
1841 /* For application testing, randomly reverse the output order for
1842 ** SELECT statements that omit the ORDER BY clause. This will help
1843 ** to find cases where
1844 */
1845 wsFlags |= WHERE_REVERSE;
danielk197785574e32008-10-06 05:32:18 +00001846 }
drh699b3d42009-02-23 16:52:07 +00001847
1848 /* Remember this case if it is the best so far */
drh111a6a72008-12-21 03:51:16 +00001849 if( cost<pCost->rCost ){
1850 pCost->rCost = cost;
1851 pCost->nRow = nRow;
1852 pCost->plan.wsFlags = wsFlags;
danielk197785574e32008-10-06 05:32:18 +00001853 }
drhfe05af82005-07-21 03:14:59 +00001854 }
1855
drh23d04d52008-12-23 23:56:22 +00001856#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00001857 /* Search for an OR-clause that can be used to look up the table.
1858 */
1859 maskSrc = getMask(pWC->pMaskSet, iCur);
1860 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1861 WhereClause tempWC;
1862 tempWC = *pWC;
drhdd5f5a62008-12-23 13:35:23 +00001863 if( pTerm->eOperator==WO_OR
1864 && ((pTerm->prereqAll & ~maskSrc) & notReady)==0
1865 && (pTerm->u.pOrInfo->indexable & maskSrc)!=0 ){
1866 WhereClause *pOrWC = &pTerm->u.pOrInfo->wc;
1867 WhereTerm *pOrTerm;
1868 int j;
drha7e77062009-01-14 00:55:09 +00001869 int sortable = 0;
drhdd5f5a62008-12-23 13:35:23 +00001870 double rTotal = 0;
drh1c8781f2009-01-06 14:19:36 +00001871 nRow = 0;
drhdd5f5a62008-12-23 13:35:23 +00001872 for(j=0, pOrTerm=pOrWC->a; j<pOrWC->nTerm; j++, pOrTerm++){
1873 WhereCost sTermCost;
drh04bbcd52008-12-30 17:55:00 +00001874 WHERETRACE(("... Multi-index OR testing for term %d of %d....\n", j,i));
drh29435252008-12-28 18:35:08 +00001875 if( pOrTerm->eOperator==WO_AND ){
1876 WhereClause *pAndWC = &pOrTerm->u.pAndInfo->wc;
1877 bestIndex(pParse, pAndWC, pSrc, notReady, 0, &sTermCost);
1878 }else if( pOrTerm->leftCursor==iCur ){
1879 tempWC.a = pOrTerm;
drh04bbcd52008-12-30 17:55:00 +00001880 tempWC.nTerm = 1;
drh29435252008-12-28 18:35:08 +00001881 bestIndex(pParse, &tempWC, pSrc, notReady, 0, &sTermCost);
1882 }else{
1883 continue;
1884 }
drhdd5f5a62008-12-23 13:35:23 +00001885 rTotal += sTermCost.rCost;
1886 nRow += sTermCost.nRow;
drh103bd882009-01-08 21:00:02 +00001887 if( rTotal>=pCost->rCost ) break;
drhdd5f5a62008-12-23 13:35:23 +00001888 }
drha7e77062009-01-14 00:55:09 +00001889 if( pOrderBy!=0 ){
1890 if( sortableByRowid(iCur, pOrderBy, pWC->pMaskSet, &rev) && !rev ){
1891 sortable = 1;
1892 }else{
1893 rTotal += nRow*estLog(nRow);
1894 WHERETRACE(("... sorting increases OR cost to %.9g\n", rTotal));
1895 }
1896 }
drh04bbcd52008-12-30 17:55:00 +00001897 WHERETRACE(("... multi-index OR cost=%.9g nrow=%.9g\n",
1898 rTotal, nRow));
drhdd5f5a62008-12-23 13:35:23 +00001899 if( rTotal<pCost->rCost ){
1900 pCost->rCost = rTotal;
1901 pCost->nRow = nRow;
1902 pCost->plan.wsFlags = WHERE_MULTI_OR;
1903 pCost->plan.u.pTerm = pTerm;
drha7e77062009-01-14 00:55:09 +00001904 if( sortable ){
drhca8c4662008-12-28 20:47:02 +00001905 pCost->plan.wsFlags = WHERE_ORDERBY|WHERE_MULTI_OR;
1906 }
drhdd5f5a62008-12-23 13:35:23 +00001907 }
1908 }
1909 }
drh23d04d52008-12-23 23:56:22 +00001910#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00001911
drhc49de5d2007-01-19 01:06:01 +00001912 /* If the pSrc table is the right table of a LEFT JOIN then we may not
1913 ** use an index to satisfy IS NULL constraints on that table. This is
1914 ** because columns might end up being NULL if the table does not match -
1915 ** a circumstance which the index cannot help us discover. Ticket #2177.
1916 */
1917 if( (pSrc->jointype & JT_LEFT)!=0 ){
1918 eqTermMask = WO_EQ|WO_IN;
1919 }else{
1920 eqTermMask = WO_EQ|WO_IN|WO_ISNULL;
1921 }
1922
drhfe05af82005-07-21 03:14:59 +00001923 /* Look at each index.
1924 */
danielk197785574e32008-10-06 05:32:18 +00001925 if( pSrc->pIndex ){
1926 pProbe = pSrc->pIndex;
1927 }
1928 for(; pProbe; pProbe=(pSrc->pIndex ? 0 : pProbe->pNext)){
drhb37df7b2005-10-13 02:09:49 +00001929 double inMultiplier = 1;
drh51147ba2005-07-23 22:59:55 +00001930
drh4f0c5872007-03-26 22:05:01 +00001931 WHERETRACE(("... index %s:\n", pProbe->zName));
drhfe05af82005-07-21 03:14:59 +00001932
1933 /* Count the number of columns in the index that are satisfied
1934 ** by x=EXPR constraints or x IN (...) constraints.
1935 */
drh165be382008-12-05 02:36:33 +00001936 wsFlags = 0;
drhfe05af82005-07-21 03:14:59 +00001937 for(i=0; i<pProbe->nColumn; i++){
1938 int j = pProbe->aiColumn[i];
drhc49de5d2007-01-19 01:06:01 +00001939 pTerm = findTerm(pWC, iCur, j, notReady, eqTermMask, pProbe);
drhfe05af82005-07-21 03:14:59 +00001940 if( pTerm==0 ) break;
drh165be382008-12-05 02:36:33 +00001941 wsFlags |= WHERE_COLUMN_EQ;
drhb52076c2006-01-23 13:22:09 +00001942 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00001943 Expr *pExpr = pTerm->pExpr;
drh165be382008-12-05 02:36:33 +00001944 wsFlags |= WHERE_COLUMN_IN;
danielk19776ab3a2e2009-02-19 14:39:25 +00001945 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
drhffe0f892006-05-11 13:26:25 +00001946 inMultiplier *= 25;
danielk19776ab3a2e2009-02-19 14:39:25 +00001947 }else if( pExpr->x.pList ){
1948 inMultiplier *= pExpr->x.pList->nExpr + 1;
drhfe05af82005-07-21 03:14:59 +00001949 }
1950 }
1951 }
drh111a6a72008-12-21 03:51:16 +00001952 nRow = pProbe->aiRowEst[i] * inMultiplier;
1953 cost = nRow * estLog(inMultiplier);
drh51147ba2005-07-23 22:59:55 +00001954 nEq = i;
drh165be382008-12-05 02:36:33 +00001955 if( pProbe->onError!=OE_None && (wsFlags & WHERE_COLUMN_IN)==0
drh943af3c2005-07-29 19:43:58 +00001956 && nEq==pProbe->nColumn ){
drh165be382008-12-05 02:36:33 +00001957 wsFlags |= WHERE_UNIQUE;
drh943af3c2005-07-29 19:43:58 +00001958 }
drh8e70e342007-09-13 17:54:40 +00001959 WHERETRACE(("...... nEq=%d inMult=%.9g cost=%.9g\n",nEq,inMultiplier,cost));
drhfe05af82005-07-21 03:14:59 +00001960
drh51147ba2005-07-23 22:59:55 +00001961 /* Look for range constraints
drhfe05af82005-07-21 03:14:59 +00001962 */
drh51147ba2005-07-23 22:59:55 +00001963 if( nEq<pProbe->nColumn ){
1964 int j = pProbe->aiColumn[nEq];
1965 pTerm = findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE|WO_GT|WO_GE, pProbe);
1966 if( pTerm ){
drh165be382008-12-05 02:36:33 +00001967 wsFlags |= WHERE_COLUMN_RANGE;
drh51147ba2005-07-23 22:59:55 +00001968 if( findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001969 wsFlags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001970 cost /= 3;
drh111a6a72008-12-21 03:51:16 +00001971 nRow /= 3;
drh51147ba2005-07-23 22:59:55 +00001972 }
1973 if( findTerm(pWC, iCur, j, notReady, WO_GT|WO_GE, pProbe) ){
drh165be382008-12-05 02:36:33 +00001974 wsFlags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001975 cost /= 3;
drh111a6a72008-12-21 03:51:16 +00001976 nRow /= 3;
drh51147ba2005-07-23 22:59:55 +00001977 }
drh4f0c5872007-03-26 22:05:01 +00001978 WHERETRACE(("...... range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001979 }
1980 }
1981
drh28c4cf42005-07-27 20:41:43 +00001982 /* Add the additional cost of sorting if that is a factor.
drh51147ba2005-07-23 22:59:55 +00001983 */
drh28c4cf42005-07-27 20:41:43 +00001984 if( pOrderBy ){
drh165be382008-12-05 02:36:33 +00001985 if( (wsFlags & WHERE_COLUMN_IN)==0 &&
drh7b4fc6a2007-02-06 13:26:32 +00001986 isSortingIndex(pParse,pWC->pMaskSet,pProbe,iCur,pOrderBy,nEq,&rev) ){
drh165be382008-12-05 02:36:33 +00001987 if( wsFlags==0 ){
1988 wsFlags = WHERE_COLUMN_RANGE;
drh28c4cf42005-07-27 20:41:43 +00001989 }
drh165be382008-12-05 02:36:33 +00001990 wsFlags |= WHERE_ORDERBY;
drh28c4cf42005-07-27 20:41:43 +00001991 if( rev ){
drh165be382008-12-05 02:36:33 +00001992 wsFlags |= WHERE_REVERSE;
drh28c4cf42005-07-27 20:41:43 +00001993 }
1994 }else{
1995 cost += cost*estLog(cost);
drh4f0c5872007-03-26 22:05:01 +00001996 WHERETRACE(("...... orderby increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001997 }
drh699b3d42009-02-23 16:52:07 +00001998 }else if( pParse->db->flags & SQLITE_ReverseOrder ){
1999 /* For application testing, randomly reverse the output order for
2000 ** SELECT statements that omit the ORDER BY clause. This will help
2001 ** to find cases where
2002 */
2003 wsFlags |= WHERE_REVERSE;
drhfe05af82005-07-21 03:14:59 +00002004 }
2005
2006 /* Check to see if we can get away with using just the index without
drh51147ba2005-07-23 22:59:55 +00002007 ** ever reading the table. If that is the case, then halve the
2008 ** cost of this index.
drhfe05af82005-07-21 03:14:59 +00002009 */
drh165be382008-12-05 02:36:33 +00002010 if( wsFlags && pSrc->colUsed < (((Bitmask)1)<<(BMS-1)) ){
drhfe05af82005-07-21 03:14:59 +00002011 Bitmask m = pSrc->colUsed;
2012 int j;
2013 for(j=0; j<pProbe->nColumn; j++){
2014 int x = pProbe->aiColumn[j];
2015 if( x<BMS-1 ){
2016 m &= ~(((Bitmask)1)<<x);
2017 }
2018 }
2019 if( m==0 ){
drh165be382008-12-05 02:36:33 +00002020 wsFlags |= WHERE_IDX_ONLY;
drhb37df7b2005-10-13 02:09:49 +00002021 cost /= 2;
drh4f0c5872007-03-26 22:05:01 +00002022 WHERETRACE(("...... idx-only reduces cost to %.9g\n", cost));
drhfe05af82005-07-21 03:14:59 +00002023 }
2024 }
2025
drh51147ba2005-07-23 22:59:55 +00002026 /* If this index has achieved the lowest cost so far, then use it.
drhfe05af82005-07-21 03:14:59 +00002027 */
drh111a6a72008-12-21 03:51:16 +00002028 if( wsFlags!=0 && cost < pCost->rCost ){
2029 pCost->rCost = cost;
2030 pCost->nRow = nRow;
2031 pCost->plan.wsFlags = wsFlags;
2032 pCost->plan.nEq = nEq;
2033 assert( pCost->plan.wsFlags & WHERE_INDEXED );
2034 pCost->plan.u.pIdx = pProbe;
drhfe05af82005-07-21 03:14:59 +00002035 }
2036 }
2037
drhfe05af82005-07-21 03:14:59 +00002038 /* Report the best result
2039 */
drh111a6a72008-12-21 03:51:16 +00002040 pCost->plan.wsFlags |= eqTermMask;
2041 WHERETRACE(("best index is %s, cost=%.9g, nrow=%.9g, wsFlags=%x, nEq=%d\n",
2042 (pCost->plan.wsFlags & WHERE_INDEXED)!=0 ?
2043 pCost->plan.u.pIdx->zName : "(none)", pCost->nRow,
2044 pCost->rCost, pCost->plan.wsFlags, pCost->plan.nEq));
drhfe05af82005-07-21 03:14:59 +00002045}
2046
drhb6c29892004-11-22 19:12:19 +00002047
2048/*
drh2ffb1182004-07-19 19:14:01 +00002049** Disable a term in the WHERE clause. Except, do not disable the term
2050** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2051** or USING clause of that join.
2052**
2053** Consider the term t2.z='ok' in the following queries:
2054**
2055** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2056** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2057** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2058**
drh23bf66d2004-12-14 03:34:34 +00002059** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00002060** in the ON clause. The term is disabled in (3) because it is not part
2061** of a LEFT OUTER JOIN. In (1), the term is not disabled.
2062**
2063** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00002064** of the join. Disabling is an optimization. When terms are satisfied
2065** by indices, we disable them to prevent redundant tests in the inner
2066** loop. We would get the correct results if nothing were ever disabled,
2067** but joins might run a little slower. The trick is to disable as much
2068** as we can without disabling too much. If we disabled in (1), we'd get
2069** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00002070*/
drh0fcef5e2005-07-19 17:38:22 +00002071static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
2072 if( pTerm
drh165be382008-12-05 02:36:33 +00002073 && ALWAYS((pTerm->wtFlags & TERM_CODED)==0)
drh0fcef5e2005-07-19 17:38:22 +00002074 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
2075 ){
drh165be382008-12-05 02:36:33 +00002076 pTerm->wtFlags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00002077 if( pTerm->iParent>=0 ){
2078 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
2079 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00002080 disableTerm(pLevel, pOther);
2081 }
drh0fcef5e2005-07-19 17:38:22 +00002082 }
drh2ffb1182004-07-19 19:14:01 +00002083 }
2084}
2085
2086/*
danielk1977b790c6c2008-04-18 10:25:24 +00002087** Apply the affinities associated with the first n columns of index
2088** pIdx to the values in the n registers starting at base.
drh94a11212004-09-25 13:12:14 +00002089*/
danielk1977b790c6c2008-04-18 10:25:24 +00002090static void codeApplyAffinity(Parse *pParse, int base, int n, Index *pIdx){
2091 if( n>0 ){
2092 Vdbe *v = pParse->pVdbe;
2093 assert( v!=0 );
2094 sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
2095 sqlite3IndexAffinityStr(v, pIdx);
2096 sqlite3ExprCacheAffinityChange(pParse, base, n);
2097 }
drh94a11212004-09-25 13:12:14 +00002098}
2099
drhe8b97272005-07-19 22:22:12 +00002100
2101/*
drh51147ba2005-07-23 22:59:55 +00002102** Generate code for a single equality term of the WHERE clause. An equality
2103** term can be either X=expr or X IN (...). pTerm is the term to be
2104** coded.
2105**
drh1db639c2008-01-17 02:36:28 +00002106** The current value for the constraint is left in register iReg.
drh51147ba2005-07-23 22:59:55 +00002107**
2108** For a constraint of the form X=expr, the expression is evaluated and its
2109** result is left on the stack. For constraints of the form X IN (...)
2110** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00002111*/
drh678ccce2008-03-31 18:19:54 +00002112static int codeEqualityTerm(
drh94a11212004-09-25 13:12:14 +00002113 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00002114 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh1db639c2008-01-17 02:36:28 +00002115 WhereLevel *pLevel, /* When level of the FROM clause we are working on */
drh678ccce2008-03-31 18:19:54 +00002116 int iTarget /* Attempt to leave results in this register */
drh94a11212004-09-25 13:12:14 +00002117){
drh0fcef5e2005-07-19 17:38:22 +00002118 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00002119 Vdbe *v = pParse->pVdbe;
drh678ccce2008-03-31 18:19:54 +00002120 int iReg; /* Register holding results */
drh1db639c2008-01-17 02:36:28 +00002121
danielk19772d605492008-10-01 08:43:03 +00002122 assert( iTarget>0 );
drh50b39962006-10-28 00:28:09 +00002123 if( pX->op==TK_EQ ){
drh678ccce2008-03-31 18:19:54 +00002124 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh50b39962006-10-28 00:28:09 +00002125 }else if( pX->op==TK_ISNULL ){
drh678ccce2008-03-31 18:19:54 +00002126 iReg = iTarget;
drh1db639c2008-01-17 02:36:28 +00002127 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
danielk1977b3bce662005-01-29 08:32:43 +00002128#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00002129 }else{
danielk19779a96b662007-11-29 17:05:18 +00002130 int eType;
danielk1977b3bce662005-01-29 08:32:43 +00002131 int iTab;
drh72e8fa42007-03-28 14:30:06 +00002132 struct InLoop *pIn;
danielk1977b3bce662005-01-29 08:32:43 +00002133
drh50b39962006-10-28 00:28:09 +00002134 assert( pX->op==TK_IN );
drh678ccce2008-03-31 18:19:54 +00002135 iReg = iTarget;
danielk19770cdc0222008-06-26 18:04:03 +00002136 eType = sqlite3FindInIndex(pParse, pX, 0);
danielk1977b3bce662005-01-29 08:32:43 +00002137 iTab = pX->iTable;
drh66a51672008-01-03 00:01:23 +00002138 sqlite3VdbeAddOp2(v, OP_Rewind, iTab, 0);
drhd4e70eb2008-01-02 00:34:36 +00002139 VdbeComment((v, "%.*s", pX->span.n, pX->span.z));
drh111a6a72008-12-21 03:51:16 +00002140 assert( pLevel->plan.wsFlags & WHERE_IN_ABLE );
2141 if( pLevel->u.in.nIn==0 ){
drhb3190c12008-12-08 21:37:14 +00002142 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
drh72e8fa42007-03-28 14:30:06 +00002143 }
drh111a6a72008-12-21 03:51:16 +00002144 pLevel->u.in.nIn++;
2145 pLevel->u.in.aInLoop =
2146 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
2147 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
2148 pIn = pLevel->u.in.aInLoop;
drh72e8fa42007-03-28 14:30:06 +00002149 if( pIn ){
drh111a6a72008-12-21 03:51:16 +00002150 pIn += pLevel->u.in.nIn - 1;
drh72e8fa42007-03-28 14:30:06 +00002151 pIn->iCur = iTab;
drh1db639c2008-01-17 02:36:28 +00002152 if( eType==IN_INDEX_ROWID ){
drhb3190c12008-12-08 21:37:14 +00002153 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
drh1db639c2008-01-17 02:36:28 +00002154 }else{
drhb3190c12008-12-08 21:37:14 +00002155 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
drh1db639c2008-01-17 02:36:28 +00002156 }
2157 sqlite3VdbeAddOp1(v, OP_IsNull, iReg);
drha6110402005-07-28 20:51:19 +00002158 }else{
drh111a6a72008-12-21 03:51:16 +00002159 pLevel->u.in.nIn = 0;
drhe23399f2005-07-22 00:31:39 +00002160 }
danielk1977b3bce662005-01-29 08:32:43 +00002161#endif
drh94a11212004-09-25 13:12:14 +00002162 }
drh0fcef5e2005-07-19 17:38:22 +00002163 disableTerm(pLevel, pTerm);
drh678ccce2008-03-31 18:19:54 +00002164 return iReg;
drh94a11212004-09-25 13:12:14 +00002165}
2166
drh51147ba2005-07-23 22:59:55 +00002167/*
2168** Generate code that will evaluate all == and IN constraints for an
2169** index. The values for all constraints are left on the stack.
2170**
2171** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
2172** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
2173** The index has as many as three equality constraints, but in this
2174** example, the third "c" value is an inequality. So only two
2175** constraints are coded. This routine will generate code to evaluate
drh6df2acd2008-12-28 16:55:25 +00002176** a==5 and b IN (1,2,3). The current values for a and b will be stored
2177** in consecutive registers and the index of the first register is returned.
drh51147ba2005-07-23 22:59:55 +00002178**
2179** In the example above nEq==2. But this subroutine works for any value
2180** of nEq including 0. If nEq==0, this routine is nearly a no-op.
2181** The only thing it does is allocate the pLevel->iMem memory cell.
2182**
drh700a2262008-12-17 19:22:15 +00002183** This routine always allocates at least one memory cell and returns
2184** the index of that memory cell. The code that
2185** calls this routine will use that memory cell to store the termination
drh51147ba2005-07-23 22:59:55 +00002186** key value of the loop. If one or more IN operators appear, then
2187** this routine allocates an additional nEq memory cells for internal
2188** use.
2189*/
drh1db639c2008-01-17 02:36:28 +00002190static int codeAllEqualityTerms(
drh51147ba2005-07-23 22:59:55 +00002191 Parse *pParse, /* Parsing context */
2192 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
2193 WhereClause *pWC, /* The WHERE clause */
drh1db639c2008-01-17 02:36:28 +00002194 Bitmask notReady, /* Which parts of FROM have not yet been coded */
2195 int nExtraReg /* Number of extra registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002196){
drh111a6a72008-12-21 03:51:16 +00002197 int nEq = pLevel->plan.nEq; /* The number of == or IN constraints to code */
2198 Vdbe *v = pParse->pVdbe; /* The vm under construction */
2199 Index *pIdx; /* The index being used for this loop */
drh51147ba2005-07-23 22:59:55 +00002200 int iCur = pLevel->iTabCur; /* The cursor of the table */
2201 WhereTerm *pTerm; /* A single constraint term */
2202 int j; /* Loop counter */
drh1db639c2008-01-17 02:36:28 +00002203 int regBase; /* Base register */
drh6df2acd2008-12-28 16:55:25 +00002204 int nReg; /* Number of registers to allocate */
drh51147ba2005-07-23 22:59:55 +00002205
drh111a6a72008-12-21 03:51:16 +00002206 /* This module is only called on query plans that use an index. */
2207 assert( pLevel->plan.wsFlags & WHERE_INDEXED );
2208 pIdx = pLevel->plan.u.pIdx;
2209
drh51147ba2005-07-23 22:59:55 +00002210 /* Figure out how many memory cells we will need then allocate them.
drh51147ba2005-07-23 22:59:55 +00002211 */
drh700a2262008-12-17 19:22:15 +00002212 regBase = pParse->nMem + 1;
drh6df2acd2008-12-28 16:55:25 +00002213 nReg = pLevel->plan.nEq + nExtraReg;
2214 pParse->nMem += nReg;
drh51147ba2005-07-23 22:59:55 +00002215
2216 /* Evaluate the equality constraints
2217 */
drhc49de5d2007-01-19 01:06:01 +00002218 assert( pIdx->nColumn>=nEq );
2219 for(j=0; j<nEq; j++){
drh678ccce2008-03-31 18:19:54 +00002220 int r1;
drh51147ba2005-07-23 22:59:55 +00002221 int k = pIdx->aiColumn[j];
drh111a6a72008-12-21 03:51:16 +00002222 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->plan.wsFlags, pIdx);
drh34004ce2008-07-11 16:15:17 +00002223 if( NEVER(pTerm==0) ) break;
drh165be382008-12-05 02:36:33 +00002224 assert( (pTerm->wtFlags & TERM_CODED)==0 );
drh678ccce2008-03-31 18:19:54 +00002225 r1 = codeEqualityTerm(pParse, pTerm, pLevel, regBase+j);
2226 if( r1!=regBase+j ){
drh6df2acd2008-12-28 16:55:25 +00002227 if( nReg==1 ){
2228 sqlite3ReleaseTempReg(pParse, regBase);
2229 regBase = r1;
2230 }else{
2231 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
2232 }
drh678ccce2008-03-31 18:19:54 +00002233 }
drh981642f2008-04-19 14:40:43 +00002234 testcase( pTerm->eOperator & WO_ISNULL );
2235 testcase( pTerm->eOperator & WO_IN );
drh72e8fa42007-03-28 14:30:06 +00002236 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
drhb3190c12008-12-08 21:37:14 +00002237 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
drh51147ba2005-07-23 22:59:55 +00002238 }
2239 }
drh1db639c2008-01-17 02:36:28 +00002240 return regBase;
drh51147ba2005-07-23 22:59:55 +00002241}
2242
drh111a6a72008-12-21 03:51:16 +00002243/*
drh23d04d52008-12-23 23:56:22 +00002244** Return TRUE if the WhereClause pWC contains no terms that
2245** are not virtual and which have not been coded.
2246**
2247** To put it another way, return TRUE if no additional WHERE clauses
2248** tests are required in order to establish that the current row
2249** should go to output and return FALSE if there are some terms of
2250** the WHERE clause that need to be validated before outputing the row.
2251*/
2252static int whereRowReadyForOutput(WhereClause *pWC){
2253 WhereTerm *pTerm;
2254 int j;
2255
2256 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2257 if( (pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED))==0 ) return 0;
2258 }
2259 return 1;
2260}
2261
2262/*
drh111a6a72008-12-21 03:51:16 +00002263** Generate code for the start of the iLevel-th loop in the WHERE clause
2264** implementation described by pWInfo.
2265*/
2266static Bitmask codeOneLoopStart(
2267 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
2268 int iLevel, /* Which level of pWInfo->a[] should be coded */
2269 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2270 Bitmask notReady /* Which tables are currently available */
2271){
2272 int j, k; /* Loop counters */
2273 int iCur; /* The VDBE cursor for the table */
2274 int addrNxt; /* Where to jump to continue with the next IN case */
2275 int omitTable; /* True if we use the index only */
2276 int bRev; /* True if we need to scan in reverse order */
2277 WhereLevel *pLevel; /* The where level to be coded */
2278 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
2279 WhereTerm *pTerm; /* A WHERE clause term */
2280 Parse *pParse; /* Parsing context */
2281 Vdbe *v; /* The prepared stmt under constructions */
2282 struct SrcList_item *pTabItem; /* FROM clause term being coded */
drh23d04d52008-12-23 23:56:22 +00002283 int addrBrk; /* Jump here to break out of the loop */
2284 int addrCont; /* Jump here to continue with next cycle */
2285 int regRowSet; /* Write rowids to this RowSet if non-negative */
2286 int codeRowSetEarly; /* True if index fully constrains the search */
drh111a6a72008-12-21 03:51:16 +00002287
2288
2289 pParse = pWInfo->pParse;
2290 v = pParse->pVdbe;
2291 pWC = pWInfo->pWC;
2292 pLevel = &pWInfo->a[iLevel];
2293 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2294 iCur = pTabItem->iCursor;
2295 bRev = (pLevel->plan.wsFlags & WHERE_REVERSE)!=0;
2296 omitTable = (pLevel->plan.wsFlags & WHERE_IDX_ONLY)!=0;
drh23d04d52008-12-23 23:56:22 +00002297 regRowSet = pWInfo->regRowSet;
2298 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002299
2300 /* Create labels for the "break" and "continue" instructions
2301 ** for the current loop. Jump to addrBrk to break out of a loop.
2302 ** Jump to cont to go immediately to the next iteration of the
2303 ** loop.
2304 **
2305 ** When there is an IN operator, we also have a "addrNxt" label that
2306 ** means to continue with the next IN value combination. When
2307 ** there are no IN operators in the constraints, the "addrNxt" label
2308 ** is the same as "addrBrk".
2309 */
2310 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
2311 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
2312
2313 /* If this is the right table of a LEFT OUTER JOIN, allocate and
2314 ** initialize a memory cell that records if this table matches any
2315 ** row of the left table of the join.
2316 */
2317 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
2318 pLevel->iLeftJoin = ++pParse->nMem;
2319 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
2320 VdbeComment((v, "init LEFT JOIN no-match flag"));
2321 }
2322
2323#ifndef SQLITE_OMIT_VIRTUALTABLE
2324 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2325 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
2326 ** to access the data.
2327 */
2328 int iReg; /* P3 Value for OP_VFilter */
2329 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
2330 int nConstraint = pVtabIdx->nConstraint;
2331 struct sqlite3_index_constraint_usage *aUsage =
2332 pVtabIdx->aConstraintUsage;
2333 const struct sqlite3_index_constraint *aConstraint =
2334 pVtabIdx->aConstraint;
2335
2336 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
2337 pParse->disableColCache++;
2338 for(j=1; j<=nConstraint; j++){
2339 for(k=0; k<nConstraint; k++){
2340 if( aUsage[k].argvIndex==j ){
2341 int iTerm = aConstraint[k].iTermOffset;
2342 assert( pParse->disableColCache );
2343 sqlite3ExprCode(pParse, pWC->a[iTerm].pExpr->pRight, iReg+j+1);
2344 break;
2345 }
2346 }
2347 if( k==nConstraint ) break;
2348 }
2349 assert( pParse->disableColCache );
2350 pParse->disableColCache--;
2351 sqlite3VdbeAddOp2(v, OP_Integer, pVtabIdx->idxNum, iReg);
2352 sqlite3VdbeAddOp2(v, OP_Integer, j-1, iReg+1);
2353 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrBrk, iReg, pVtabIdx->idxStr,
2354 pVtabIdx->needToFreeIdxStr ? P4_MPRINTF : P4_STATIC);
drh111a6a72008-12-21 03:51:16 +00002355 pVtabIdx->needToFreeIdxStr = 0;
2356 for(j=0; j<nConstraint; j++){
2357 if( aUsage[j].omit ){
2358 int iTerm = aConstraint[j].iTermOffset;
2359 disableTerm(pLevel, &pWC->a[iTerm]);
2360 }
2361 }
2362 pLevel->op = OP_VNext;
2363 pLevel->p1 = iCur;
2364 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh23d04d52008-12-23 23:56:22 +00002365 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2366 if( codeRowSetEarly ){
2367 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, iReg);
2368 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, iReg);
2369 }
2370 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
drh111a6a72008-12-21 03:51:16 +00002371 }else
2372#endif /* SQLITE_OMIT_VIRTUALTABLE */
2373
2374 if( pLevel->plan.wsFlags & WHERE_ROWID_EQ ){
2375 /* Case 1: We can directly reference a single row using an
2376 ** equality comparison against the ROWID field. Or
2377 ** we reference multiple rows using a "rowid IN (...)"
2378 ** construct.
2379 */
2380 int r1;
2381 int rtmp = sqlite3GetTempReg(pParse);
2382 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
2383 assert( pTerm!=0 );
2384 assert( pTerm->pExpr!=0 );
2385 assert( pTerm->leftCursor==iCur );
2386 assert( omitTable==0 );
2387 r1 = codeEqualityTerm(pParse, pTerm, pLevel, rtmp);
2388 addrNxt = pLevel->addrNxt;
2389 sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, addrNxt);
2390 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, r1);
drh23d04d52008-12-23 23:56:22 +00002391 codeRowSetEarly = (pWC->nTerm==1 && regRowSet>=0) ?1:0;
2392 if( codeRowSetEarly ){
2393 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2394 }
drh111a6a72008-12-21 03:51:16 +00002395 sqlite3ReleaseTempReg(pParse, rtmp);
2396 VdbeComment((v, "pk"));
2397 pLevel->op = OP_Noop;
2398 }else if( pLevel->plan.wsFlags & WHERE_ROWID_RANGE ){
2399 /* Case 2: We have an inequality comparison against the ROWID field.
2400 */
2401 int testOp = OP_Noop;
2402 int start;
2403 int memEndValue = 0;
2404 WhereTerm *pStart, *pEnd;
2405
2406 assert( omitTable==0 );
2407 pStart = findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0);
2408 pEnd = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0);
2409 if( bRev ){
2410 pTerm = pStart;
2411 pStart = pEnd;
2412 pEnd = pTerm;
2413 }
2414 if( pStart ){
2415 Expr *pX; /* The expression that defines the start bound */
2416 int r1, rTemp; /* Registers for holding the start boundary */
2417
2418 /* The following constant maps TK_xx codes into corresponding
2419 ** seek opcodes. It depends on a particular ordering of TK_xx
2420 */
2421 const u8 aMoveOp[] = {
2422 /* TK_GT */ OP_SeekGt,
2423 /* TK_LE */ OP_SeekLe,
2424 /* TK_LT */ OP_SeekLt,
2425 /* TK_GE */ OP_SeekGe
2426 };
2427 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
2428 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
2429 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
2430
2431 pX = pStart->pExpr;
2432 assert( pX!=0 );
2433 assert( pStart->leftCursor==iCur );
2434 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
2435 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
2436 VdbeComment((v, "pk"));
2437 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
2438 sqlite3ReleaseTempReg(pParse, rTemp);
2439 disableTerm(pLevel, pStart);
2440 }else{
2441 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
2442 }
2443 if( pEnd ){
2444 Expr *pX;
2445 pX = pEnd->pExpr;
2446 assert( pX!=0 );
2447 assert( pEnd->leftCursor==iCur );
2448 memEndValue = ++pParse->nMem;
2449 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
2450 if( pX->op==TK_LT || pX->op==TK_GT ){
2451 testOp = bRev ? OP_Le : OP_Ge;
2452 }else{
2453 testOp = bRev ? OP_Lt : OP_Gt;
2454 }
2455 disableTerm(pLevel, pEnd);
2456 }
2457 start = sqlite3VdbeCurrentAddr(v);
2458 pLevel->op = bRev ? OP_Prev : OP_Next;
2459 pLevel->p1 = iCur;
2460 pLevel->p2 = start;
drhca8c4662008-12-28 20:47:02 +00002461 pLevel->p5 = (pStart==0 && pEnd==0) ?1:0;
drh23d04d52008-12-23 23:56:22 +00002462 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2463 if( codeRowSetEarly || testOp!=OP_Noop ){
drh111a6a72008-12-21 03:51:16 +00002464 int r1 = sqlite3GetTempReg(pParse);
2465 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
drh23d04d52008-12-23 23:56:22 +00002466 if( testOp!=OP_Noop ){
2467 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, r1);
2468 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
2469 }
2470 if( codeRowSetEarly ){
2471 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2472 }
drh111a6a72008-12-21 03:51:16 +00002473 sqlite3ReleaseTempReg(pParse, r1);
2474 }
2475 }else if( pLevel->plan.wsFlags & (WHERE_COLUMN_RANGE|WHERE_COLUMN_EQ) ){
2476 /* Case 3: A scan using an index.
2477 **
2478 ** The WHERE clause may contain zero or more equality
2479 ** terms ("==" or "IN" operators) that refer to the N
2480 ** left-most columns of the index. It may also contain
2481 ** inequality constraints (>, <, >= or <=) on the indexed
2482 ** column that immediately follows the N equalities. Only
2483 ** the right-most column can be an inequality - the rest must
2484 ** use the "==" and "IN" operators. For example, if the
2485 ** index is on (x,y,z), then the following clauses are all
2486 ** optimized:
2487 **
2488 ** x=5
2489 ** x=5 AND y=10
2490 ** x=5 AND y<10
2491 ** x=5 AND y>5 AND y<10
2492 ** x=5 AND y=5 AND z<=10
2493 **
2494 ** The z<10 term of the following cannot be used, only
2495 ** the x=5 term:
2496 **
2497 ** x=5 AND z<10
2498 **
2499 ** N may be zero if there are inequality constraints.
2500 ** If there are no inequality constraints, then N is at
2501 ** least one.
2502 **
2503 ** This case is also used when there are no WHERE clause
2504 ** constraints but an index is selected anyway, in order
2505 ** to force the output order to conform to an ORDER BY.
2506 */
2507 int aStartOp[] = {
2508 0,
2509 0,
2510 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
2511 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
2512 OP_SeekGt, /* 4: (start_constraints && !startEq && !bRev) */
2513 OP_SeekLt, /* 5: (start_constraints && !startEq && bRev) */
2514 OP_SeekGe, /* 6: (start_constraints && startEq && !bRev) */
2515 OP_SeekLe /* 7: (start_constraints && startEq && bRev) */
2516 };
2517 int aEndOp[] = {
2518 OP_Noop, /* 0: (!end_constraints) */
2519 OP_IdxGE, /* 1: (end_constraints && !bRev) */
2520 OP_IdxLT /* 2: (end_constraints && bRev) */
2521 };
2522 int nEq = pLevel->plan.nEq;
2523 int isMinQuery = 0; /* If this is an optimized SELECT min(x).. */
2524 int regBase; /* Base register holding constraint values */
2525 int r1; /* Temp register */
2526 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
2527 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
2528 int startEq; /* True if range start uses ==, >= or <= */
2529 int endEq; /* True if range end uses ==, >= or <= */
2530 int start_constraints; /* Start of range is constrained */
2531 int nConstraint; /* Number of constraint terms */
2532 Index *pIdx; /* The index we will be using */
2533 int iIdxCur; /* The VDBE cursor for the index */
drh6df2acd2008-12-28 16:55:25 +00002534 int nExtraReg = 0; /* Number of extra registers needed */
2535 int op; /* Instruction opcode */
drh111a6a72008-12-21 03:51:16 +00002536
2537 pIdx = pLevel->plan.u.pIdx;
2538 iIdxCur = pLevel->iIdxCur;
2539 k = pIdx->aiColumn[nEq]; /* Column for inequality constraints */
2540
drh111a6a72008-12-21 03:51:16 +00002541 /* If this loop satisfies a sort order (pOrderBy) request that
2542 ** was passed to this function to implement a "SELECT min(x) ..."
2543 ** query, then the caller will only allow the loop to run for
2544 ** a single iteration. This means that the first row returned
2545 ** should not have a NULL value stored in 'x'. If column 'x' is
2546 ** the first one after the nEq equality constraints in the index,
2547 ** this requires some special handling.
2548 */
2549 if( (wctrlFlags&WHERE_ORDERBY_MIN)!=0
2550 && (pLevel->plan.wsFlags&WHERE_ORDERBY)
2551 && (pIdx->nColumn>nEq)
2552 ){
2553 /* assert( pOrderBy->nExpr==1 ); */
2554 /* assert( pOrderBy->a[0].pExpr->iColumn==pIdx->aiColumn[nEq] ); */
2555 isMinQuery = 1;
drh6df2acd2008-12-28 16:55:25 +00002556 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002557 }
2558
2559 /* Find any inequality constraint terms for the start and end
2560 ** of the range.
2561 */
2562 if( pLevel->plan.wsFlags & WHERE_TOP_LIMIT ){
2563 pRangeEnd = findTerm(pWC, iCur, k, notReady, (WO_LT|WO_LE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002564 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002565 }
2566 if( pLevel->plan.wsFlags & WHERE_BTM_LIMIT ){
2567 pRangeStart = findTerm(pWC, iCur, k, notReady, (WO_GT|WO_GE), pIdx);
drh6df2acd2008-12-28 16:55:25 +00002568 nExtraReg = 1;
drh111a6a72008-12-21 03:51:16 +00002569 }
2570
drh6df2acd2008-12-28 16:55:25 +00002571 /* Generate code to evaluate all constraint terms using == or IN
2572 ** and store the values of those terms in an array of registers
2573 ** starting at regBase.
2574 */
2575 regBase = codeAllEqualityTerms(pParse, pLevel, pWC, notReady, nExtraReg);
2576 addrNxt = pLevel->addrNxt;
2577
2578
drh111a6a72008-12-21 03:51:16 +00002579 /* If we are doing a reverse order scan on an ascending index, or
2580 ** a forward order scan on a descending index, interchange the
2581 ** start and end terms (pRangeStart and pRangeEnd).
2582 */
2583 if( bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC) ){
2584 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
2585 }
2586
2587 testcase( pRangeStart && pRangeStart->eOperator & WO_LE );
2588 testcase( pRangeStart && pRangeStart->eOperator & WO_GE );
2589 testcase( pRangeEnd && pRangeEnd->eOperator & WO_LE );
2590 testcase( pRangeEnd && pRangeEnd->eOperator & WO_GE );
2591 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
2592 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
2593 start_constraints = pRangeStart || nEq>0;
2594
2595 /* Seek the index cursor to the start of the range. */
2596 nConstraint = nEq;
2597 if( pRangeStart ){
2598 int dcc = pParse->disableColCache;
2599 if( pRangeEnd ){
2600 pParse->disableColCache++;
2601 }
2602 sqlite3ExprCode(pParse, pRangeStart->pExpr->pRight, regBase+nEq);
2603 pParse->disableColCache = dcc;
2604 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2605 nConstraint++;
2606 }else if( isMinQuery ){
2607 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2608 nConstraint++;
2609 startEq = 0;
2610 start_constraints = 1;
2611 }
2612 codeApplyAffinity(pParse, regBase, nConstraint, pIdx);
2613 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2614 assert( op!=0 );
2615 testcase( op==OP_Rewind );
2616 testcase( op==OP_Last );
2617 testcase( op==OP_SeekGt );
2618 testcase( op==OP_SeekGe );
2619 testcase( op==OP_SeekLe );
2620 testcase( op==OP_SeekLt );
2621 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2622 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2623
2624 /* Load the value for the inequality constraint at the end of the
2625 ** range (if any).
2626 */
2627 nConstraint = nEq;
2628 if( pRangeEnd ){
2629 sqlite3ExprCode(pParse, pRangeEnd->pExpr->pRight, regBase+nEq);
2630 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2631 codeApplyAffinity(pParse, regBase, nEq+1, pIdx);
2632 nConstraint++;
2633 }
2634
2635 /* Top of the loop body */
2636 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2637
2638 /* Check if the index cursor is past the end of the range. */
2639 op = aEndOp[(pRangeEnd || nEq) * (1 + bRev)];
2640 testcase( op==OP_Noop );
2641 testcase( op==OP_IdxGE );
2642 testcase( op==OP_IdxLT );
drh6df2acd2008-12-28 16:55:25 +00002643 if( op!=OP_Noop ){
2644 sqlite3VdbeAddOp4(v, op, iIdxCur, addrNxt, regBase,
2645 SQLITE_INT_TO_PTR(nConstraint), P4_INT32);
2646 sqlite3VdbeChangeP5(v, endEq!=bRev ?1:0);
2647 }
drh111a6a72008-12-21 03:51:16 +00002648
2649 /* If there are inequality constraints, check that the value
2650 ** of the table column that the inequality contrains is not NULL.
2651 ** If it is, jump to the next iteration of the loop.
2652 */
2653 r1 = sqlite3GetTempReg(pParse);
2654 testcase( pLevel->plan.wsFlags & WHERE_BTM_LIMIT );
2655 testcase( pLevel->plan.wsFlags & WHERE_TOP_LIMIT );
2656 if( pLevel->plan.wsFlags & (WHERE_BTM_LIMIT|WHERE_TOP_LIMIT) ){
2657 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, nEq, r1);
2658 sqlite3VdbeAddOp2(v, OP_IsNull, r1, addrCont);
2659 }
2660
2661 /* Seek the table cursor, if required */
drh23d04d52008-12-23 23:56:22 +00002662 disableTerm(pLevel, pRangeStart);
2663 disableTerm(pLevel, pRangeEnd);
2664 codeRowSetEarly = regRowSet>=0 ? whereRowReadyForOutput(pWC) : 0;
2665 if( !omitTable || codeRowSetEarly ){
drh111a6a72008-12-21 03:51:16 +00002666 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, r1);
drh23d04d52008-12-23 23:56:22 +00002667 if( codeRowSetEarly ){
2668 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2669 }else{
2670 sqlite3VdbeAddOp2(v, OP_Seek, iCur, r1); /* Deferred seek */
2671 }
drh111a6a72008-12-21 03:51:16 +00002672 }
2673 sqlite3ReleaseTempReg(pParse, r1);
2674
2675 /* Record the instruction used to terminate the loop. Disable
2676 ** WHERE clause terms made redundant by the index range scan.
2677 */
2678 pLevel->op = bRev ? OP_Prev : OP_Next;
2679 pLevel->p1 = iIdxCur;
drhdd5f5a62008-12-23 13:35:23 +00002680 }else
2681
drh23d04d52008-12-23 23:56:22 +00002682#ifndef SQLITE_OMIT_OR_OPTIMIZATION
drhdd5f5a62008-12-23 13:35:23 +00002683 if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
drh111a6a72008-12-21 03:51:16 +00002684 /* Case 4: Two or more separately indexed terms connected by OR
2685 **
2686 ** Example:
2687 **
2688 ** CREATE TABLE t1(a,b,c,d);
2689 ** CREATE INDEX i1 ON t1(a);
2690 ** CREATE INDEX i2 ON t1(b);
2691 ** CREATE INDEX i3 ON t1(c);
2692 **
2693 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2694 **
2695 ** In the example, there are three indexed terms connected by OR.
2696 ** The top of the loop is constructed by creating a RowSet object
2697 ** and populating it. Then looping over elements of the rowset.
2698 **
2699 ** Null 1
2700 ** # fill RowSet 1 with entries where a=5 using i1
2701 ** # fill Rowset 1 with entries where b=7 using i2
2702 ** # fill Rowset 1 with entries where c=11 and d=13 i3 and t1
2703 ** A: RowSetRead 1, B, 2
2704 ** Seek i, 2
2705 **
2706 ** The bottom of the loop looks like this:
2707 **
2708 ** Goto 0, A
2709 ** B:
2710 */
drh23d04d52008-12-23 23:56:22 +00002711 int regOrRowset; /* Register holding the RowSet object */
drh111a6a72008-12-21 03:51:16 +00002712 int regNextRowid; /* Register holding next rowid */
drh111a6a72008-12-21 03:51:16 +00002713 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2714 WhereTerm *pOrTerm; /* A single subterm within the OR-clause */
drhdd5f5a62008-12-23 13:35:23 +00002715 SrcList oneTab; /* Shortened table list */
drh111a6a72008-12-21 03:51:16 +00002716
2717 pTerm = pLevel->plan.u.pTerm;
2718 assert( pTerm!=0 );
2719 assert( pTerm->eOperator==WO_OR );
2720 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2721 pOrWc = &pTerm->u.pOrInfo->wc;
drh23d04d52008-12-23 23:56:22 +00002722 codeRowSetEarly = (regRowSet>=0 && pWC->nTerm==1) ?1:0;
2723
2724 if( codeRowSetEarly ){
2725 regOrRowset = regRowSet;
2726 }else{
2727 regOrRowset = sqlite3GetTempReg(pParse);
2728 sqlite3VdbeAddOp2(v, OP_Null, 0, regOrRowset);
2729 }
drhdd5f5a62008-12-23 13:35:23 +00002730 oneTab.nSrc = 1;
2731 oneTab.nAlloc = 1;
2732 oneTab.a[0] = *pTabItem;
2733 for(j=0, pOrTerm=pOrWc->a; j<pOrWc->nTerm; j++, pOrTerm++){
2734 WhereInfo *pSubWInfo;
drh29435252008-12-28 18:35:08 +00002735 if( pOrTerm->leftCursor!=iCur && pOrTerm->eOperator!=WO_AND ) continue;
drh23d04d52008-12-23 23:56:22 +00002736 pSubWInfo = sqlite3WhereBegin(pParse, &oneTab, pOrTerm->pExpr, 0,
drh6df2acd2008-12-28 16:55:25 +00002737 WHERE_FILL_ROWSET | WHERE_OMIT_OPEN | WHERE_OMIT_CLOSE,
2738 regOrRowset);
drhdd5f5a62008-12-23 13:35:23 +00002739 if( pSubWInfo ){
drhdd5f5a62008-12-23 13:35:23 +00002740 sqlite3WhereEnd(pSubWInfo);
2741 }
2742 }
drh111a6a72008-12-21 03:51:16 +00002743 sqlite3VdbeResolveLabel(v, addrCont);
drh23d04d52008-12-23 23:56:22 +00002744 if( !codeRowSetEarly ){
2745 regNextRowid = sqlite3GetTempReg(pParse);
2746 addrCont =
2747 sqlite3VdbeAddOp3(v, OP_RowSetRead, regOrRowset,addrBrk,regNextRowid);
2748 sqlite3VdbeAddOp2(v, OP_Seek, iCur, regNextRowid);
2749 sqlite3ReleaseTempReg(pParse, regNextRowid);
2750 /* sqlite3ReleaseTempReg(pParse, regOrRowset); // Preserve the RowSet */
2751 pLevel->op = OP_Goto;
2752 pLevel->p2 = addrCont;
drh171256c2009-01-08 03:11:19 +00002753 }else{
2754 pLevel->op = OP_Noop;
drh23d04d52008-12-23 23:56:22 +00002755 }
2756 disableTerm(pLevel, pTerm);
drhdd5f5a62008-12-23 13:35:23 +00002757 }else
drh23d04d52008-12-23 23:56:22 +00002758#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
drhdd5f5a62008-12-23 13:35:23 +00002759
2760 {
drh111a6a72008-12-21 03:51:16 +00002761 /* Case 5: There is no usable index. We must do a complete
2762 ** scan of the entire table.
2763 */
drh699b3d42009-02-23 16:52:07 +00002764 static const u8 aStep[] = { OP_Next, OP_Prev };
2765 static const u8 aStart[] = { OP_Rewind, OP_Last };
2766 assert( bRev==0 || bRev==1 );
drh111a6a72008-12-21 03:51:16 +00002767 assert( omitTable==0 );
drh699b3d42009-02-23 16:52:07 +00002768 pLevel->op = aStep[bRev];
drh111a6a72008-12-21 03:51:16 +00002769 pLevel->p1 = iCur;
drh699b3d42009-02-23 16:52:07 +00002770 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
drh111a6a72008-12-21 03:51:16 +00002771 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
drh23d04d52008-12-23 23:56:22 +00002772 codeRowSetEarly = 0;
drh111a6a72008-12-21 03:51:16 +00002773 }
2774 notReady &= ~getMask(pWC->pMaskSet, iCur);
2775
2776 /* Insert code to test every subexpression that can be completely
2777 ** computed using the current set of tables.
2778 */
2779 k = 0;
2780 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2781 Expr *pE;
2782 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2783 testcase( pTerm->wtFlags & TERM_CODED );
2784 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2785 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2786 pE = pTerm->pExpr;
2787 assert( pE!=0 );
2788 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
2789 continue;
2790 }
2791 pParse->disableColCache += k;
2792 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2793 pParse->disableColCache -= k;
2794 k = 1;
2795 pTerm->wtFlags |= TERM_CODED;
2796 }
2797
2798 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2799 ** at least one row of the right table has matched the left table.
2800 */
2801 if( pLevel->iLeftJoin ){
2802 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2803 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2804 VdbeComment((v, "record LEFT JOIN hit"));
2805 sqlite3ExprClearColumnCache(pParse, pLevel->iTabCur);
2806 sqlite3ExprClearColumnCache(pParse, pLevel->iIdxCur);
2807 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
2808 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2809 testcase( pTerm->wtFlags & TERM_CODED );
2810 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2811 if( (pTerm->prereqAll & notReady)!=0 ) continue;
2812 assert( pTerm->pExpr );
2813 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2814 pTerm->wtFlags |= TERM_CODED;
2815 }
2816 }
drh23d04d52008-12-23 23:56:22 +00002817
2818 /*
2819 ** If it was requested to store the results in a rowset and that has
2820 ** not already been do, then do so now.
2821 */
2822 if( regRowSet>=0 && !codeRowSetEarly ){
2823 int r1 = sqlite3GetTempReg(pParse);
2824#ifndef SQLITE_OMIT_VIRTUALTABLE
2825 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
2826 sqlite3VdbeAddOp2(v, OP_VRowid, iCur, r1);
2827 }else
2828#endif
2829 {
2830 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, r1);
2831 }
2832 sqlite3VdbeAddOp2(v, OP_RowSetAdd, regRowSet, r1);
2833 sqlite3ReleaseTempReg(pParse, r1);
2834 }
2835
drh111a6a72008-12-21 03:51:16 +00002836 return notReady;
2837}
2838
drh549c8b62005-09-19 13:15:23 +00002839#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00002840/*
2841** The following variable holds a text description of query plan generated
2842** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
2843** overwrites the previous. This information is used for testing and
2844** analysis only.
2845*/
2846char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
2847static int nQPlan = 0; /* Next free slow in _query_plan[] */
2848
2849#endif /* SQLITE_TEST */
2850
2851
drh9eff6162006-06-12 21:59:13 +00002852/*
2853** Free a WhereInfo structure
2854*/
drh10fe8402008-10-11 16:47:35 +00002855static void whereInfoFree(sqlite3 *db, WhereInfo *pWInfo){
drh9eff6162006-06-12 21:59:13 +00002856 if( pWInfo ){
2857 int i;
2858 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00002859 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
2860 if( pInfo ){
danielk197780442942008-12-24 11:25:39 +00002861 assert( pInfo->needToFreeIdxStr==0 || db->mallocFailed );
2862 if( pInfo->needToFreeIdxStr ){
2863 sqlite3_free(pInfo->idxStr);
danielk1977be229652009-03-20 14:18:51 +00002864 }
drh633e6d52008-07-28 19:34:53 +00002865 sqlite3DbFree(db, pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00002866 }
drh9eff6162006-06-12 21:59:13 +00002867 }
drh111a6a72008-12-21 03:51:16 +00002868 whereClauseClear(pWInfo->pWC);
drh633e6d52008-07-28 19:34:53 +00002869 sqlite3DbFree(db, pWInfo);
drh9eff6162006-06-12 21:59:13 +00002870 }
2871}
2872
drh94a11212004-09-25 13:12:14 +00002873
2874/*
drhe3184742002-06-19 14:27:05 +00002875** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00002876** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00002877** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00002878** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00002879** in order to complete the WHERE clause processing.
2880**
2881** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00002882**
2883** The basic idea is to do a nested loop, one loop for each table in
2884** the FROM clause of a select. (INSERT and UPDATE statements are the
2885** same as a SELECT with only a single table in the FROM clause.) For
2886** example, if the SQL is this:
2887**
2888** SELECT * FROM t1, t2, t3 WHERE ...;
2889**
2890** Then the code generated is conceptually like the following:
2891**
2892** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002893** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00002894** foreach row3 in t3 do /
2895** ...
2896** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00002897** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00002898** end /
2899**
drh29dda4a2005-07-21 18:23:20 +00002900** Note that the loops might not be nested in the order in which they
2901** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00002902** use of indices. Note also that when the IN operator appears in
2903** the WHERE clause, it might result in additional nested loops for
2904** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00002905**
drhc27a1ce2002-06-14 20:58:45 +00002906** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00002907** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
2908** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00002909** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00002910**
drhe6f85e72004-12-25 01:03:13 +00002911** The code that sqlite3WhereBegin() generates leaves the cursors named
2912** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00002913** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00002914** data from the various tables of the loop.
2915**
drhc27a1ce2002-06-14 20:58:45 +00002916** If the WHERE clause is empty, the foreach loops must each scan their
2917** entire tables. Thus a three-way join is an O(N^3) operation. But if
2918** the tables have indices and there are terms in the WHERE clause that
2919** refer to those indices, a complete table scan can be avoided and the
2920** code will run much faster. Most of the work of this routine is checking
2921** to see if there are indices that can be used to speed up the loop.
2922**
2923** Terms of the WHERE clause are also used to limit which rows actually
2924** make it to the "..." in the middle of the loop. After each "foreach",
2925** terms of the WHERE clause that use only terms in that loop and outer
2926** loops are evaluated and if false a jump is made around all subsequent
2927** inner loops (or around the "..." if the test occurs within the inner-
2928** most loop)
2929**
2930** OUTER JOINS
2931**
2932** An outer join of tables t1 and t2 is conceptally coded as follows:
2933**
2934** foreach row1 in t1 do
2935** flag = 0
2936** foreach row2 in t2 do
2937** start:
2938** ...
2939** flag = 1
2940** end
drhe3184742002-06-19 14:27:05 +00002941** if flag==0 then
2942** move the row2 cursor to a null row
2943** goto start
2944** fi
drhc27a1ce2002-06-14 20:58:45 +00002945** end
2946**
drhe3184742002-06-19 14:27:05 +00002947** ORDER BY CLAUSE PROCESSING
2948**
2949** *ppOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
2950** if there is one. If there is no ORDER BY clause or if this routine
2951** is called from an UPDATE or DELETE statement, then ppOrderBy is NULL.
2952**
2953** If an index can be used so that the natural output order of the table
2954** scan is correct for the ORDER BY clause, then that index is used and
2955** *ppOrderBy is set to NULL. This is an optimization that prevents an
2956** unnecessary sort of the result set if an index appropriate for the
2957** ORDER BY clause already exists.
2958**
2959** If the where clause loops cannot be arranged to provide the correct
2960** output order, then the *ppOrderBy is unchanged.
drh75897232000-05-29 14:26:00 +00002961*/
danielk19774adee202004-05-08 08:23:19 +00002962WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00002963 Parse *pParse, /* The parser context */
2964 SrcList *pTabList, /* A list of all tables to be scanned */
2965 Expr *pWhere, /* The WHERE clause */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002966 ExprList **ppOrderBy, /* An ORDER BY clause, or NULL */
drh23d04d52008-12-23 23:56:22 +00002967 u8 wctrlFlags, /* One of the WHERE_* flags defined in sqliteInt.h */
2968 int regRowSet /* Register hold RowSet if WHERE_FILL_ROWSET is set */
drh75897232000-05-29 14:26:00 +00002969){
2970 int i; /* Loop counter */
danielk1977be229652009-03-20 14:18:51 +00002971 int nByteWInfo; /* Num. bytes allocated for WhereInfo struct */
drh75897232000-05-29 14:26:00 +00002972 WhereInfo *pWInfo; /* Will become the return value of this function */
2973 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhfe05af82005-07-21 03:14:59 +00002974 Bitmask notReady; /* Cursors that are not yet positioned */
drh111a6a72008-12-21 03:51:16 +00002975 WhereMaskSet *pMaskSet; /* The expression mask set */
drh111a6a72008-12-21 03:51:16 +00002976 WhereClause *pWC; /* Decomposition of the WHERE clause */
drh9012bcb2004-12-19 00:11:35 +00002977 struct SrcList_item *pTabItem; /* A single entry from pTabList */
2978 WhereLevel *pLevel; /* A single level in the pWInfo list */
drh29dda4a2005-07-21 18:23:20 +00002979 int iFrom; /* First unused FROM clause element */
drh111a6a72008-12-21 03:51:16 +00002980 int andFlags; /* AND-ed combination of all pWC->a[].wtFlags */
drh17435752007-08-16 04:30:38 +00002981 sqlite3 *db; /* Database connection */
danielk1977a9d1ccb2008-01-05 17:39:29 +00002982 ExprList *pOrderBy = 0;
drh75897232000-05-29 14:26:00 +00002983
drh29dda4a2005-07-21 18:23:20 +00002984 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00002985 ** bits in a Bitmask
2986 */
drh29dda4a2005-07-21 18:23:20 +00002987 if( pTabList->nSrc>BMS ){
2988 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00002989 return 0;
2990 }
2991
danielk1977a9d1ccb2008-01-05 17:39:29 +00002992 if( ppOrderBy ){
2993 pOrderBy = *ppOrderBy;
2994 }
2995
drh75897232000-05-29 14:26:00 +00002996 /* Allocate and initialize the WhereInfo structure that will become the
danielk1977be229652009-03-20 14:18:51 +00002997 ** return value. A single allocation is used to store the WhereInfo
2998 ** struct, the contents of WhereInfo.a[], the WhereClause structure
2999 ** and the WhereMaskSet structure. Since WhereClause contains an 8-byte
3000 ** field (type Bitmask) it must be aligned on an 8-byte boundary on
3001 ** some architectures. Hence the ROUND8() below.
drh75897232000-05-29 14:26:00 +00003002 */
drh17435752007-08-16 04:30:38 +00003003 db = pParse->db;
danielk1977be229652009-03-20 14:18:51 +00003004 nByteWInfo = ROUND8(sizeof(WhereInfo)+(pTabList->nSrc-1)*sizeof(WhereLevel));
3005 pWInfo = sqlite3DbMallocZero(db,
3006 nByteWInfo +
3007 sizeof(WhereClause) +
3008 sizeof(WhereMaskSet)
3009 );
drh17435752007-08-16 04:30:38 +00003010 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00003011 goto whereBeginError;
drh75897232000-05-29 14:26:00 +00003012 }
danielk197770b6d572006-06-19 04:49:34 +00003013 pWInfo->nLevel = pTabList->nSrc;
drh75897232000-05-29 14:26:00 +00003014 pWInfo->pParse = pParse;
3015 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00003016 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh23d04d52008-12-23 23:56:22 +00003017 pWInfo->regRowSet = (wctrlFlags & WHERE_FILL_ROWSET) ? regRowSet : -1;
danielk1977be229652009-03-20 14:18:51 +00003018 pWInfo->pWC = pWC = (WhereClause *)&((u8 *)pWInfo)[nByteWInfo];
drh6df2acd2008-12-28 16:55:25 +00003019 pWInfo->wctrlFlags = wctrlFlags;
drh111a6a72008-12-21 03:51:16 +00003020 pMaskSet = (WhereMaskSet*)&pWC[1];
drh08192d52002-04-30 19:20:28 +00003021
drh111a6a72008-12-21 03:51:16 +00003022 /* Split the WHERE clause into separate subexpressions where each
3023 ** subexpression is separated by an AND operator.
3024 */
3025 initMaskSet(pMaskSet);
3026 whereClauseInit(pWC, pParse, pMaskSet);
3027 sqlite3ExprCodeConstants(pParse, pWhere);
3028 whereSplit(pWC, pWhere, TK_AND);
3029
drh08192d52002-04-30 19:20:28 +00003030 /* Special case: a WHERE clause that is constant. Evaluate the
3031 ** expression and either jump over all of the code or fall thru.
3032 */
drh0a168372007-06-08 00:20:47 +00003033 if( pWhere && (pTabList->nSrc==0 || sqlite3ExprIsConstantNotJoin(pWhere)) ){
drh35573352008-01-08 23:54:25 +00003034 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, SQLITE_JUMPIFNULL);
drhdf199a22002-06-14 22:38:41 +00003035 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00003036 }
drh75897232000-05-29 14:26:00 +00003037
drh42165be2008-03-26 14:56:34 +00003038 /* Assign a bit from the bitmask to every term in the FROM clause.
3039 **
3040 ** When assigning bitmask values to FROM clause cursors, it must be
3041 ** the case that if X is the bitmask for the N-th FROM clause term then
3042 ** the bitmask for all FROM clause terms to the left of the N-th term
3043 ** is (X-1). An expression from the ON clause of a LEFT JOIN can use
3044 ** its Expr.iRightJoinTable value to find the bitmask of the right table
3045 ** of the join. Subtracting one from the right table bitmask gives a
3046 ** bitmask for all tables to the left of the join. Knowing the bitmask
3047 ** for all tables to the left of a left join is important. Ticket #3015.
3048 */
3049 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003050 createMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003051 }
3052#ifndef NDEBUG
3053 {
3054 Bitmask toTheLeft = 0;
3055 for(i=0; i<pTabList->nSrc; i++){
drh111a6a72008-12-21 03:51:16 +00003056 Bitmask m = getMask(pMaskSet, pTabList->a[i].iCursor);
drh42165be2008-03-26 14:56:34 +00003057 assert( (m-1)==toTheLeft );
3058 toTheLeft |= m;
3059 }
3060 }
3061#endif
3062
drh29dda4a2005-07-21 18:23:20 +00003063 /* Analyze all of the subexpressions. Note that exprAnalyze() might
3064 ** add new virtual terms onto the end of the WHERE clause. We do not
3065 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00003066 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00003067 */
drh111a6a72008-12-21 03:51:16 +00003068 exprAnalyzeAll(pTabList, pWC);
drh17435752007-08-16 04:30:38 +00003069 if( db->mallocFailed ){
danielk197785574e32008-10-06 05:32:18 +00003070 goto whereBeginError;
drh0bbaa1b2005-08-19 19:14:12 +00003071 }
drh75897232000-05-29 14:26:00 +00003072
drh29dda4a2005-07-21 18:23:20 +00003073 /* Chose the best index to use for each table in the FROM clause.
3074 **
drh51147ba2005-07-23 22:59:55 +00003075 ** This loop fills in the following fields:
3076 **
3077 ** pWInfo->a[].pIdx The index to use for this level of the loop.
drh165be382008-12-05 02:36:33 +00003078 ** pWInfo->a[].wsFlags WHERE_xxx flags associated with pIdx
drh51147ba2005-07-23 22:59:55 +00003079 ** pWInfo->a[].nEq The number of == and IN constraints
danielk197785574e32008-10-06 05:32:18 +00003080 ** pWInfo->a[].iFrom Which term of the FROM clause is being coded
drh51147ba2005-07-23 22:59:55 +00003081 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
3082 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
drh111a6a72008-12-21 03:51:16 +00003083 ** pWInfo->a[].pTerm When wsFlags==WO_OR, the OR-clause term
drh51147ba2005-07-23 22:59:55 +00003084 **
3085 ** This loop also figures out the nesting order of tables in the FROM
3086 ** clause.
drh75897232000-05-29 14:26:00 +00003087 */
drhfe05af82005-07-21 03:14:59 +00003088 notReady = ~(Bitmask)0;
drh9012bcb2004-12-19 00:11:35 +00003089 pTabItem = pTabList->a;
3090 pLevel = pWInfo->a;
drh943af3c2005-07-29 19:43:58 +00003091 andFlags = ~0;
drh4f0c5872007-03-26 22:05:01 +00003092 WHERETRACE(("*** Optimizer Start ***\n"));
drh29dda4a2005-07-21 18:23:20 +00003093 for(i=iFrom=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
drh111a6a72008-12-21 03:51:16 +00003094 WhereCost bestPlan; /* Most efficient plan seen so far */
drh29dda4a2005-07-21 18:23:20 +00003095 Index *pIdx; /* Index for FROM table at pTabItem */
drh29dda4a2005-07-21 18:23:20 +00003096 int j; /* For looping over FROM tables */
drh02afc862006-01-20 18:10:57 +00003097 int bestJ = 0; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00003098 Bitmask m; /* Bitmask value for j or bestJ */
drh570b9352006-02-01 02:45:02 +00003099 int once = 0; /* True when first table is seen */
drh29dda4a2005-07-21 18:23:20 +00003100
drh111a6a72008-12-21 03:51:16 +00003101 memset(&bestPlan, 0, sizeof(bestPlan));
3102 bestPlan.rCost = SQLITE_BIG_DBL;
drh29dda4a2005-07-21 18:23:20 +00003103 for(j=iFrom, pTabItem=&pTabList->a[j]; j<pTabList->nSrc; j++, pTabItem++){
drhdf26fd52006-06-06 11:45:54 +00003104 int doNotReorder; /* True if this table should not be reordered */
drh111a6a72008-12-21 03:51:16 +00003105 WhereCost sCost; /* Cost information from bestIndex() */
drhdf26fd52006-06-06 11:45:54 +00003106
drh61dfc312006-12-16 16:25:15 +00003107 doNotReorder = (pTabItem->jointype & (JT_LEFT|JT_CROSS))!=0;
drhdf26fd52006-06-06 11:45:54 +00003108 if( once && doNotReorder ) break;
drh111a6a72008-12-21 03:51:16 +00003109 m = getMask(pMaskSet, pTabItem->iCursor);
drh29dda4a2005-07-21 18:23:20 +00003110 if( (m & notReady)==0 ){
3111 if( j==iFrom ) iFrom++;
3112 continue;
3113 }
drh9eff6162006-06-12 21:59:13 +00003114 assert( pTabItem->pTab );
3115#ifndef SQLITE_OMIT_VIRTUALTABLE
drh4cbdda92006-06-14 19:00:20 +00003116 if( IsVirtual(pTabItem->pTab) ){
drh111a6a72008-12-21 03:51:16 +00003117 sqlite3_index_info *pVtabIdx; /* Current virtual index */
drh6d209d82006-06-27 01:54:26 +00003118 sqlite3_index_info **ppIdxInfo = &pWInfo->a[j].pIdxInfo;
drh111a6a72008-12-21 03:51:16 +00003119 sCost.rCost = bestVirtualIndex(pParse, pWC, pTabItem, notReady,
3120 ppOrderBy ? *ppOrderBy : 0, i==0,
3121 ppIdxInfo);
3122 sCost.plan.wsFlags = WHERE_VIRTUALTABLE;
3123 sCost.plan.u.pVtabIdx = pVtabIdx = *ppIdxInfo;
3124 if( pVtabIdx && pVtabIdx->orderByConsumed ){
3125 sCost.plan.wsFlags = WHERE_VIRTUALTABLE | WHERE_ORDERBY;
drh1a90e092006-06-14 22:07:10 +00003126 }
drh111a6a72008-12-21 03:51:16 +00003127 sCost.plan.nEq = 0;
shanefbd60f82009-02-04 03:59:25 +00003128 /* (double)2 In case of SQLITE_OMIT_FLOATING_POINT... */
3129 if( (SQLITE_BIG_DBL/((double)2))<sCost.rCost ){
danielk19778efe5412007-03-02 08:12:22 +00003130 /* The cost is not allowed to be larger than SQLITE_BIG_DBL (the
3131 ** inital value of lowestCost in this loop. If it is, then
drh111a6a72008-12-21 03:51:16 +00003132 ** the (cost<lowestCost) test below will never be true.
danielk19778efe5412007-03-02 08:12:22 +00003133 */
shanefbd60f82009-02-04 03:59:25 +00003134 /* (double)2 In case of SQLITE_OMIT_FLOATING_POINT... */
3135 sCost.rCost = (SQLITE_BIG_DBL/((double)2));
danielk19778efe5412007-03-02 08:12:22 +00003136 }
drh9eff6162006-06-12 21:59:13 +00003137 }else
3138#endif
3139 {
drh111a6a72008-12-21 03:51:16 +00003140 bestIndex(pParse, pWC, pTabItem, notReady,
3141 (i==0 && ppOrderBy) ? *ppOrderBy : 0, &sCost);
drh9eff6162006-06-12 21:59:13 +00003142 }
danielk1977992347f2008-12-30 09:45:45 +00003143 if( once==0 || sCost.rCost<bestPlan.rCost ){
drh570b9352006-02-01 02:45:02 +00003144 once = 1;
drh111a6a72008-12-21 03:51:16 +00003145 bestPlan = sCost;
drh29dda4a2005-07-21 18:23:20 +00003146 bestJ = j;
3147 }
drhdf26fd52006-06-06 11:45:54 +00003148 if( doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00003149 }
danielk1977992347f2008-12-30 09:45:45 +00003150 assert( once );
3151 assert( notReady & getMask(pMaskSet, pTabList->a[bestJ].iCursor) );
drhcb041342008-06-12 00:07:29 +00003152 WHERETRACE(("*** Optimizer selects table %d for loop %d\n", bestJ,
drh3dec2232005-09-10 15:28:09 +00003153 pLevel-pWInfo->a));
drh111a6a72008-12-21 03:51:16 +00003154 if( (bestPlan.plan.wsFlags & WHERE_ORDERBY)!=0 ){
drhfe05af82005-07-21 03:14:59 +00003155 *ppOrderBy = 0;
drhc4a3c772001-04-04 11:48:57 +00003156 }
drh111a6a72008-12-21 03:51:16 +00003157 andFlags &= bestPlan.plan.wsFlags;
3158 pLevel->plan = bestPlan.plan;
3159 if( bestPlan.plan.wsFlags & WHERE_INDEXED ){
drh9012bcb2004-12-19 00:11:35 +00003160 pLevel->iIdxCur = pParse->nTab++;
drhfe05af82005-07-21 03:14:59 +00003161 }else{
3162 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00003163 }
drh111a6a72008-12-21 03:51:16 +00003164 notReady &= ~getMask(pMaskSet, pTabList->a[bestJ].iCursor);
shaned87897d2009-01-30 05:40:27 +00003165 pLevel->iFrom = (u8)bestJ;
danielk197785574e32008-10-06 05:32:18 +00003166
3167 /* Check that if the table scanned by this loop iteration had an
3168 ** INDEXED BY clause attached to it, that the named index is being
3169 ** used for the scan. If not, then query compilation has failed.
3170 ** Return an error.
3171 */
3172 pIdx = pTabList->a[bestJ].pIndex;
drh171256c2009-01-08 03:11:19 +00003173 if( pIdx ){
3174 if( (bestPlan.plan.wsFlags & WHERE_INDEXED)==0 ){
3175 sqlite3ErrorMsg(pParse, "cannot use index: %s", pIdx->zName);
3176 goto whereBeginError;
3177 }else{
3178 /* If an INDEXED BY clause is used, the bestIndex() function is
3179 ** guaranteed to find the index specified in the INDEXED BY clause
3180 ** if it find an index at all. */
3181 assert( bestPlan.plan.u.pIdx==pIdx );
3182 }
danielk197785574e32008-10-06 05:32:18 +00003183 }
drh75897232000-05-29 14:26:00 +00003184 }
drh4f0c5872007-03-26 22:05:01 +00003185 WHERETRACE(("*** Optimizer Finished ***\n"));
danielk197780442942008-12-24 11:25:39 +00003186 if( db->mallocFailed ){
3187 goto whereBeginError;
3188 }
drh75897232000-05-29 14:26:00 +00003189
drh943af3c2005-07-29 19:43:58 +00003190 /* If the total query only selects a single row, then the ORDER BY
3191 ** clause is irrelevant.
3192 */
3193 if( (andFlags & WHERE_UNIQUE)!=0 && ppOrderBy ){
3194 *ppOrderBy = 0;
3195 }
3196
drh08c88eb2008-04-10 13:33:18 +00003197 /* If the caller is an UPDATE or DELETE statement that is requesting
3198 ** to use a one-pass algorithm, determine if this is appropriate.
3199 ** The one-pass algorithm only works if the WHERE clause constraints
3200 ** the statement to update a single row.
3201 */
drh165be382008-12-05 02:36:33 +00003202 assert( (wctrlFlags & WHERE_ONEPASS_DESIRED)==0 || pWInfo->nLevel==1 );
3203 if( (wctrlFlags & WHERE_ONEPASS_DESIRED)!=0 && (andFlags & WHERE_UNIQUE)!=0 ){
drh08c88eb2008-04-10 13:33:18 +00003204 pWInfo->okOnePass = 1;
drh111a6a72008-12-21 03:51:16 +00003205 pWInfo->a[0].plan.wsFlags &= ~WHERE_IDX_ONLY;
drh08c88eb2008-04-10 13:33:18 +00003206 }
3207
drh9012bcb2004-12-19 00:11:35 +00003208 /* Open all tables in the pTabList and any indices selected for
3209 ** searching those tables.
3210 */
3211 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh29dda4a2005-07-21 18:23:20 +00003212 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00003213 Table *pTab; /* Table to open */
danielk1977da184232006-01-05 11:34:32 +00003214 int iDb; /* Index of database containing table/index */
drh9012bcb2004-12-19 00:11:35 +00003215
drhecc92422005-09-10 16:46:12 +00003216#ifndef SQLITE_OMIT_EXPLAIN
3217 if( pParse->explain==2 ){
3218 char *zMsg;
3219 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
danielk19771e536952007-08-16 10:09:01 +00003220 zMsg = sqlite3MPrintf(db, "TABLE %s", pItem->zName);
drhecc92422005-09-10 16:46:12 +00003221 if( pItem->zAlias ){
drh633e6d52008-07-28 19:34:53 +00003222 zMsg = sqlite3MAppendf(db, zMsg, "%s AS %s", zMsg, pItem->zAlias);
drhecc92422005-09-10 16:46:12 +00003223 }
drh111a6a72008-12-21 03:51:16 +00003224 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3225 zMsg = sqlite3MAppendf(db, zMsg, "%s WITH INDEX %s",
3226 zMsg, pLevel->plan.u.pIdx->zName);
drh46129af2008-12-30 16:18:47 +00003227 }else if( pLevel->plan.wsFlags & WHERE_MULTI_OR ){
3228 zMsg = sqlite3MAppendf(db, zMsg, "%s VIA MULTI-INDEX UNION", zMsg);
drh111a6a72008-12-21 03:51:16 +00003229 }else if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh633e6d52008-07-28 19:34:53 +00003230 zMsg = sqlite3MAppendf(db, zMsg, "%s USING PRIMARY KEY", zMsg);
drhecc92422005-09-10 16:46:12 +00003231 }
drh9eff6162006-06-12 21:59:13 +00003232#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003233 else if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
3234 sqlite3_index_info *pVtabIdx = pLevel->plan.u.pVtabIdx;
drh633e6d52008-07-28 19:34:53 +00003235 zMsg = sqlite3MAppendf(db, zMsg, "%s VIRTUAL TABLE INDEX %d:%s", zMsg,
drh111a6a72008-12-21 03:51:16 +00003236 pVtabIdx->idxNum, pVtabIdx->idxStr);
drh9eff6162006-06-12 21:59:13 +00003237 }
3238#endif
drh111a6a72008-12-21 03:51:16 +00003239 if( pLevel->plan.wsFlags & WHERE_ORDERBY ){
drh633e6d52008-07-28 19:34:53 +00003240 zMsg = sqlite3MAppendf(db, zMsg, "%s ORDER BY", zMsg);
drhe2b39092006-04-21 09:38:36 +00003241 }
drh66a51672008-01-03 00:01:23 +00003242 sqlite3VdbeAddOp4(v, OP_Explain, i, pLevel->iFrom, 0, zMsg, P4_DYNAMIC);
drhecc92422005-09-10 16:46:12 +00003243 }
3244#endif /* SQLITE_OMIT_EXPLAIN */
drh29dda4a2005-07-21 18:23:20 +00003245 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003246 pTab = pTabItem->pTab;
danielk1977da184232006-01-05 11:34:32 +00003247 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drh7d10d5a2008-08-20 16:35:10 +00003248 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh9eff6162006-06-12 21:59:13 +00003249#ifndef SQLITE_OMIT_VIRTUALTABLE
drh111a6a72008-12-21 03:51:16 +00003250 if( (pLevel->plan.wsFlags & WHERE_VIRTUALTABLE)!=0 ){
danielk197793626f42006-06-20 13:07:27 +00003251 int iCur = pTabItem->iCursor;
drh66a51672008-01-03 00:01:23 +00003252 sqlite3VdbeAddOp4(v, OP_VOpen, iCur, 0, 0,
3253 (const char*)pTab->pVtab, P4_VTAB);
drh9eff6162006-06-12 21:59:13 +00003254 }else
3255#endif
drh6df2acd2008-12-28 16:55:25 +00003256 if( (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0
3257 && (wctrlFlags & WHERE_OMIT_OPEN)==0 ){
drh08c88eb2008-04-10 13:33:18 +00003258 int op = pWInfo->okOnePass ? OP_OpenWrite : OP_OpenRead;
3259 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, op);
danielk197723432972008-11-17 16:42:00 +00003260 if( !pWInfo->okOnePass && pTab->nCol<BMS ){
danielk19779792eef2006-01-13 15:58:43 +00003261 Bitmask b = pTabItem->colUsed;
3262 int n = 0;
drh74161702006-02-24 02:53:49 +00003263 for(; b; b=b>>1, n++){}
shanec0688ea2009-03-05 03:48:06 +00003264 sqlite3VdbeChangeP4(v, sqlite3VdbeCurrentAddr(v)-1, SQLITE_INT_TO_PTR(n), P4_INT32);
danielk19779792eef2006-01-13 15:58:43 +00003265 assert( n<=pTab->nCol );
3266 }
danielk1977c00da102006-01-07 13:21:04 +00003267 }else{
3268 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00003269 }
3270 pLevel->iTabCur = pTabItem->iCursor;
drh111a6a72008-12-21 03:51:16 +00003271 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3272 Index *pIx = pLevel->plan.u.pIdx;
danielk1977b3bf5562006-01-10 17:58:23 +00003273 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
drh111a6a72008-12-21 03:51:16 +00003274 int iIdxCur = pLevel->iIdxCur;
danielk1977da184232006-01-05 11:34:32 +00003275 assert( pIx->pSchema==pTab->pSchema );
drh111a6a72008-12-21 03:51:16 +00003276 assert( iIdxCur>=0 );
danielk1977207872a2008-01-03 07:54:23 +00003277 sqlite3VdbeAddOp4(v, OP_OpenRead, iIdxCur, pIx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +00003278 (char*)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +00003279 VdbeComment((v, "%s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00003280 }
danielk1977da184232006-01-05 11:34:32 +00003281 sqlite3CodeVerifySchema(pParse, iDb);
drh9012bcb2004-12-19 00:11:35 +00003282 }
3283 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
3284
drh29dda4a2005-07-21 18:23:20 +00003285 /* Generate the code to do the search. Each iteration of the for
3286 ** loop below generates code for a single nested loop of the VM
3287 ** program.
drh75897232000-05-29 14:26:00 +00003288 */
drhfe05af82005-07-21 03:14:59 +00003289 notReady = ~(Bitmask)0;
drh111a6a72008-12-21 03:51:16 +00003290 for(i=0; i<pTabList->nSrc; i++){
3291 notReady = codeOneLoopStart(pWInfo, i, wctrlFlags, notReady);
drh813f31e2009-01-06 00:08:02 +00003292 pWInfo->iContinue = pWInfo->a[i].addrCont;
drh75897232000-05-29 14:26:00 +00003293 }
drh7ec764a2005-07-21 03:48:20 +00003294
3295#ifdef SQLITE_TEST /* For testing and debugging use only */
3296 /* Record in the query plan information about the current table
3297 ** and the index used to access it (if any). If the table itself
3298 ** is not used, its name is just '{}'. If no index is used
3299 ** the index is listed as "{}". If the primary key is used the
3300 ** index name is '*'.
3301 */
3302 for(i=0; i<pTabList->nSrc; i++){
3303 char *z;
3304 int n;
drh7ec764a2005-07-21 03:48:20 +00003305 pLevel = &pWInfo->a[i];
drh29dda4a2005-07-21 18:23:20 +00003306 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00003307 z = pTabItem->zAlias;
3308 if( z==0 ) z = pTabItem->pTab->zName;
drhea678832008-12-10 19:26:22 +00003309 n = sqlite3Strlen30(z);
drh7ec764a2005-07-21 03:48:20 +00003310 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
drh111a6a72008-12-21 03:51:16 +00003311 if( pLevel->plan.wsFlags & WHERE_IDX_ONLY ){
drh5bb3eb92007-05-04 13:15:55 +00003312 memcpy(&sqlite3_query_plan[nQPlan], "{}", 2);
drh7ec764a2005-07-21 03:48:20 +00003313 nQPlan += 2;
3314 }else{
drh5bb3eb92007-05-04 13:15:55 +00003315 memcpy(&sqlite3_query_plan[nQPlan], z, n);
drh7ec764a2005-07-21 03:48:20 +00003316 nQPlan += n;
3317 }
3318 sqlite3_query_plan[nQPlan++] = ' ';
3319 }
drh111a6a72008-12-21 03:51:16 +00003320 testcase( pLevel->plan.wsFlags & WHERE_ROWID_EQ );
3321 testcase( pLevel->plan.wsFlags & WHERE_ROWID_RANGE );
3322 if( pLevel->plan.wsFlags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh5bb3eb92007-05-04 13:15:55 +00003323 memcpy(&sqlite3_query_plan[nQPlan], "* ", 2);
drh7ec764a2005-07-21 03:48:20 +00003324 nQPlan += 2;
drh111a6a72008-12-21 03:51:16 +00003325 }else if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3326 n = sqlite3Strlen30(pLevel->plan.u.pIdx->zName);
drh7ec764a2005-07-21 03:48:20 +00003327 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
drh111a6a72008-12-21 03:51:16 +00003328 memcpy(&sqlite3_query_plan[nQPlan], pLevel->plan.u.pIdx->zName, n);
drh7ec764a2005-07-21 03:48:20 +00003329 nQPlan += n;
3330 sqlite3_query_plan[nQPlan++] = ' ';
3331 }
drh111a6a72008-12-21 03:51:16 +00003332 }else{
3333 memcpy(&sqlite3_query_plan[nQPlan], "{} ", 3);
3334 nQPlan += 3;
drh7ec764a2005-07-21 03:48:20 +00003335 }
3336 }
3337 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
3338 sqlite3_query_plan[--nQPlan] = 0;
3339 }
3340 sqlite3_query_plan[nQPlan] = 0;
3341 nQPlan = 0;
3342#endif /* SQLITE_TEST // Testing and debugging use only */
3343
drh29dda4a2005-07-21 18:23:20 +00003344 /* Record the continuation address in the WhereInfo structure. Then
3345 ** clean up and return.
3346 */
drh75897232000-05-29 14:26:00 +00003347 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00003348
3349 /* Jump here if malloc fails */
danielk197785574e32008-10-06 05:32:18 +00003350whereBeginError:
drh10fe8402008-10-11 16:47:35 +00003351 whereInfoFree(db, pWInfo);
drhe23399f2005-07-22 00:31:39 +00003352 return 0;
drh75897232000-05-29 14:26:00 +00003353}
3354
3355/*
drhc27a1ce2002-06-14 20:58:45 +00003356** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00003357** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00003358*/
danielk19774adee202004-05-08 08:23:19 +00003359void sqlite3WhereEnd(WhereInfo *pWInfo){
drh633e6d52008-07-28 19:34:53 +00003360 Parse *pParse = pWInfo->pParse;
3361 Vdbe *v = pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00003362 int i;
drh6b563442001-11-07 16:48:26 +00003363 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00003364 SrcList *pTabList = pWInfo->pTabList;
drh633e6d52008-07-28 19:34:53 +00003365 sqlite3 *db = pParse->db;
drh19a775c2000-06-05 18:54:46 +00003366
drh9012bcb2004-12-19 00:11:35 +00003367 /* Generate loop termination code.
3368 */
drh633e6d52008-07-28 19:34:53 +00003369 sqlite3ExprClearColumnCache(pParse, -1);
drhad3cab52002-05-24 02:04:32 +00003370 for(i=pTabList->nSrc-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00003371 pLevel = &pWInfo->a[i];
drhb3190c12008-12-08 21:37:14 +00003372 sqlite3VdbeResolveLabel(v, pLevel->addrCont);
drh6b563442001-11-07 16:48:26 +00003373 if( pLevel->op!=OP_Noop ){
drh66a51672008-01-03 00:01:23 +00003374 sqlite3VdbeAddOp2(v, pLevel->op, pLevel->p1, pLevel->p2);
drhd1d38482008-10-07 23:46:38 +00003375 sqlite3VdbeChangeP5(v, pLevel->p5);
drh19a775c2000-06-05 18:54:46 +00003376 }
drh111a6a72008-12-21 03:51:16 +00003377 if( pLevel->plan.wsFlags & WHERE_IN_ABLE && pLevel->u.in.nIn>0 ){
drh72e8fa42007-03-28 14:30:06 +00003378 struct InLoop *pIn;
drhe23399f2005-07-22 00:31:39 +00003379 int j;
drhb3190c12008-12-08 21:37:14 +00003380 sqlite3VdbeResolveLabel(v, pLevel->addrNxt);
drh111a6a72008-12-21 03:51:16 +00003381 for(j=pLevel->u.in.nIn, pIn=&pLevel->u.in.aInLoop[j-1]; j>0; j--, pIn--){
drhb3190c12008-12-08 21:37:14 +00003382 sqlite3VdbeJumpHere(v, pIn->addrInTop+1);
3383 sqlite3VdbeAddOp2(v, OP_Next, pIn->iCur, pIn->addrInTop);
3384 sqlite3VdbeJumpHere(v, pIn->addrInTop-1);
drhe23399f2005-07-22 00:31:39 +00003385 }
drh111a6a72008-12-21 03:51:16 +00003386 sqlite3DbFree(db, pLevel->u.in.aInLoop);
drhd99f7062002-06-08 23:25:08 +00003387 }
drhb3190c12008-12-08 21:37:14 +00003388 sqlite3VdbeResolveLabel(v, pLevel->addrBrk);
drhad2d8302002-05-24 20:31:36 +00003389 if( pLevel->iLeftJoin ){
3390 int addr;
drh3c84ddf2008-01-09 02:15:38 +00003391 addr = sqlite3VdbeAddOp1(v, OP_IfPos, pLevel->iLeftJoin);
3392 sqlite3VdbeAddOp1(v, OP_NullRow, pTabList->a[i].iCursor);
drh9012bcb2004-12-19 00:11:35 +00003393 if( pLevel->iIdxCur>=0 ){
drh3c84ddf2008-01-09 02:15:38 +00003394 sqlite3VdbeAddOp1(v, OP_NullRow, pLevel->iIdxCur);
drh7f09b3e2002-08-13 13:15:49 +00003395 }
drhb3190c12008-12-08 21:37:14 +00003396 sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrFirst);
drhd654be82005-09-20 17:42:23 +00003397 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00003398 }
drh19a775c2000-06-05 18:54:46 +00003399 }
drh9012bcb2004-12-19 00:11:35 +00003400
3401 /* The "break" point is here, just past the end of the outer loop.
3402 ** Set it.
3403 */
danielk19774adee202004-05-08 08:23:19 +00003404 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00003405
drh29dda4a2005-07-21 18:23:20 +00003406 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00003407 */
drh29dda4a2005-07-21 18:23:20 +00003408 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
3409 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00003410 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00003411 assert( pTab!=0 );
drh7d10d5a2008-08-20 16:35:10 +00003412 if( (pTab->tabFlags & TF_Ephemeral)!=0 || pTab->pSelect ) continue;
drh6df2acd2008-12-28 16:55:25 +00003413 if( (pWInfo->wctrlFlags & WHERE_OMIT_CLOSE)==0 ){
3414 if( !pWInfo->okOnePass && (pLevel->plan.wsFlags & WHERE_IDX_ONLY)==0 ){
3415 sqlite3VdbeAddOp1(v, OP_Close, pTabItem->iCursor);
3416 }
3417 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
3418 sqlite3VdbeAddOp1(v, OP_Close, pLevel->iIdxCur);
3419 }
drh9012bcb2004-12-19 00:11:35 +00003420 }
3421
danielk197721de2e72007-11-29 17:43:27 +00003422 /* If this scan uses an index, make code substitutions to read data
3423 ** from the index in preference to the table. Sometimes, this means
3424 ** the table need never be read from. This is a performance boost,
3425 ** as the vdbe level waits until the table is read before actually
3426 ** seeking the table cursor to the record corresponding to the current
3427 ** position in the index.
drh9012bcb2004-12-19 00:11:35 +00003428 **
3429 ** Calls to the code generator in between sqlite3WhereBegin and
3430 ** sqlite3WhereEnd will have created code that references the table
3431 ** directly. This loop scans all that code looking for opcodes
3432 ** that reference the table and converts them into opcodes that
3433 ** reference the index.
3434 */
drh111a6a72008-12-21 03:51:16 +00003435 if( (pLevel->plan.wsFlags & WHERE_INDEXED)!=0 ){
danielk1977f0113002006-01-24 12:09:17 +00003436 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00003437 VdbeOp *pOp;
drh111a6a72008-12-21 03:51:16 +00003438 Index *pIdx = pLevel->plan.u.pIdx;
3439 int useIndexOnly = pLevel->plan.wsFlags & WHERE_IDX_ONLY;
drh9012bcb2004-12-19 00:11:35 +00003440
3441 assert( pIdx!=0 );
3442 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
3443 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00003444 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00003445 if( pOp->p1!=pLevel->iTabCur ) continue;
3446 if( pOp->opcode==OP_Column ){
drh9012bcb2004-12-19 00:11:35 +00003447 for(j=0; j<pIdx->nColumn; j++){
3448 if( pOp->p2==pIdx->aiColumn[j] ){
3449 pOp->p2 = j;
danielk197721de2e72007-11-29 17:43:27 +00003450 pOp->p1 = pLevel->iIdxCur;
drh9012bcb2004-12-19 00:11:35 +00003451 break;
3452 }
3453 }
danielk197721de2e72007-11-29 17:43:27 +00003454 assert(!useIndexOnly || j<pIdx->nColumn);
drhf0863fe2005-06-12 21:35:51 +00003455 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00003456 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00003457 pOp->opcode = OP_IdxRowid;
danielk197721de2e72007-11-29 17:43:27 +00003458 }else if( pOp->opcode==OP_NullRow && useIndexOnly ){
danielk19776c18b6e2005-01-30 09:17:58 +00003459 pOp->opcode = OP_Noop;
drh9012bcb2004-12-19 00:11:35 +00003460 }
3461 }
drh6b563442001-11-07 16:48:26 +00003462 }
drh19a775c2000-06-05 18:54:46 +00003463 }
drh9012bcb2004-12-19 00:11:35 +00003464
3465 /* Final cleanup
3466 */
drh10fe8402008-10-11 16:47:35 +00003467 whereInfoFree(db, pWInfo);
drh75897232000-05-29 14:26:00 +00003468 return;
3469}