xref: /sqlite-3.40.0/src/select.c (revision b419452c)
1 /*
2 ** 2001 September 15
3 **
4 ** The author disclaims copyright to this source code.  In place of
5 ** a legal notice, here is a blessing:
6 **
7 **    May you do good and not evil.
8 **    May you find forgiveness for yourself and forgive others.
9 **    May you share freely, never taking more than you give.
10 **
11 *************************************************************************
12 ** This file contains C code routines that are called by the parser
13 ** to handle SELECT statements in SQLite.
14 */
15 #include "sqliteInt.h"
16 
17 /*
18 ** An instance of the following object is used to record information about
19 ** how to process the DISTINCT keyword, to simplify passing that information
20 ** into the selectInnerLoop() routine.
21 */
22 typedef struct DistinctCtx DistinctCtx;
23 struct DistinctCtx {
24   u8 isTnct;      /* True if the DISTINCT keyword is present */
25   u8 eTnctType;   /* One of the WHERE_DISTINCT_* operators */
26   int tabTnct;    /* Ephemeral table used for DISTINCT processing */
27   int addrTnct;   /* Address of OP_OpenEphemeral opcode for tabTnct */
28 };
29 
30 /*
31 ** An instance of the following object is used to record information about
32 ** the ORDER BY (or GROUP BY) clause of query is being coded.
33 **
34 ** The aDefer[] array is used by the sorter-references optimization. For
35 ** example, assuming there is no index that can be used for the ORDER BY,
36 ** for the query:
37 **
38 **     SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10;
39 **
40 ** it may be more efficient to add just the "a" values to the sorter, and
41 ** retrieve the associated "bigblob" values directly from table t1 as the
42 ** 10 smallest "a" values are extracted from the sorter.
43 **
44 ** When the sorter-reference optimization is used, there is one entry in the
45 ** aDefer[] array for each database table that may be read as values are
46 ** extracted from the sorter.
47 */
48 typedef struct SortCtx SortCtx;
49 struct SortCtx {
50   ExprList *pOrderBy;   /* The ORDER BY (or GROUP BY clause) */
51   int nOBSat;           /* Number of ORDER BY terms satisfied by indices */
52   int iECursor;         /* Cursor number for the sorter */
53   int regReturn;        /* Register holding block-output return address */
54   int labelBkOut;       /* Start label for the block-output subroutine */
55   int addrSortIndex;    /* Address of the OP_SorterOpen or OP_OpenEphemeral */
56   int labelDone;        /* Jump here when done, ex: LIMIT reached */
57   int labelOBLopt;      /* Jump here when sorter is full */
58   u8 sortFlags;         /* Zero or more SORTFLAG_* bits */
59 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
60   u8 nDefer;            /* Number of valid entries in aDefer[] */
61   struct DeferredCsr {
62     Table *pTab;        /* Table definition */
63     int iCsr;           /* Cursor number for table */
64     int nKey;           /* Number of PK columns for table pTab (>=1) */
65   } aDefer[4];
66 #endif
67   struct RowLoadInfo *pDeferredRowLoad;  /* Deferred row loading info or NULL */
68 };
69 #define SORTFLAG_UseSorter  0x01   /* Use SorterOpen instead of OpenEphemeral */
70 
71 /*
72 ** Delete all the content of a Select structure.  Deallocate the structure
73 ** itself depending on the value of bFree
74 **
75 ** If bFree==1, call sqlite3DbFree() on the p object.
76 ** If bFree==0, Leave the first Select object unfreed
77 */
78 static void clearSelect(sqlite3 *db, Select *p, int bFree){
79   while( p ){
80     Select *pPrior = p->pPrior;
81     sqlite3ExprListDelete(db, p->pEList);
82     sqlite3SrcListDelete(db, p->pSrc);
83     sqlite3ExprDelete(db, p->pWhere);
84     sqlite3ExprListDelete(db, p->pGroupBy);
85     sqlite3ExprDelete(db, p->pHaving);
86     sqlite3ExprListDelete(db, p->pOrderBy);
87     sqlite3ExprDelete(db, p->pLimit);
88     if( OK_IF_ALWAYS_TRUE(p->pWith) ) sqlite3WithDelete(db, p->pWith);
89 #ifndef SQLITE_OMIT_WINDOWFUNC
90     if( OK_IF_ALWAYS_TRUE(p->pWinDefn) ){
91       sqlite3WindowListDelete(db, p->pWinDefn);
92     }
93     while( p->pWin ){
94       assert( p->pWin->ppThis==&p->pWin );
95       sqlite3WindowUnlinkFromSelect(p->pWin);
96     }
97 #endif
98     if( bFree ) sqlite3DbFreeNN(db, p);
99     p = pPrior;
100     bFree = 1;
101   }
102 }
103 
104 /*
105 ** Initialize a SelectDest structure.
106 */
107 void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
108   pDest->eDest = (u8)eDest;
109   pDest->iSDParm = iParm;
110   pDest->iSDParm2 = 0;
111   pDest->zAffSdst = 0;
112   pDest->iSdst = 0;
113   pDest->nSdst = 0;
114 }
115 
116 
117 /*
118 ** Allocate a new Select structure and return a pointer to that
119 ** structure.
120 */
121 Select *sqlite3SelectNew(
122   Parse *pParse,        /* Parsing context */
123   ExprList *pEList,     /* which columns to include in the result */
124   SrcList *pSrc,        /* the FROM clause -- which tables to scan */
125   Expr *pWhere,         /* the WHERE clause */
126   ExprList *pGroupBy,   /* the GROUP BY clause */
127   Expr *pHaving,        /* the HAVING clause */
128   ExprList *pOrderBy,   /* the ORDER BY clause */
129   u32 selFlags,         /* Flag parameters, such as SF_Distinct */
130   Expr *pLimit          /* LIMIT value.  NULL means not used */
131 ){
132   Select *pNew, *pAllocated;
133   Select standin;
134   pAllocated = pNew = sqlite3DbMallocRawNN(pParse->db, sizeof(*pNew) );
135   if( pNew==0 ){
136     assert( pParse->db->mallocFailed );
137     pNew = &standin;
138   }
139   if( pEList==0 ){
140     pEList = sqlite3ExprListAppend(pParse, 0,
141                                    sqlite3Expr(pParse->db,TK_ASTERISK,0));
142   }
143   pNew->pEList = pEList;
144   pNew->op = TK_SELECT;
145   pNew->selFlags = selFlags;
146   pNew->iLimit = 0;
147   pNew->iOffset = 0;
148   pNew->selId = ++pParse->nSelect;
149   pNew->addrOpenEphm[0] = -1;
150   pNew->addrOpenEphm[1] = -1;
151   pNew->nSelectRow = 0;
152   if( pSrc==0 ) pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*pSrc));
153   pNew->pSrc = pSrc;
154   pNew->pWhere = pWhere;
155   pNew->pGroupBy = pGroupBy;
156   pNew->pHaving = pHaving;
157   pNew->pOrderBy = pOrderBy;
158   pNew->pPrior = 0;
159   pNew->pNext = 0;
160   pNew->pLimit = pLimit;
161   pNew->pWith = 0;
162 #ifndef SQLITE_OMIT_WINDOWFUNC
163   pNew->pWin = 0;
164   pNew->pWinDefn = 0;
165 #endif
166   if( pParse->db->mallocFailed ) {
167     clearSelect(pParse->db, pNew, pNew!=&standin);
168     pAllocated = 0;
169   }else{
170     assert( pNew->pSrc!=0 || pParse->nErr>0 );
171   }
172   return pAllocated;
173 }
174 
175 
176 /*
177 ** Delete the given Select structure and all of its substructures.
178 */
179 void sqlite3SelectDelete(sqlite3 *db, Select *p){
180   if( OK_IF_ALWAYS_TRUE(p) ) clearSelect(db, p, 1);
181 }
182 
183 /*
184 ** Return a pointer to the right-most SELECT statement in a compound.
185 */
186 static Select *findRightmost(Select *p){
187   while( p->pNext ) p = p->pNext;
188   return p;
189 }
190 
191 /*
192 ** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
193 ** type of join.  Return an integer constant that expresses that type
194 ** in terms of the following bit values:
195 **
196 **     JT_INNER
197 **     JT_CROSS
198 **     JT_OUTER
199 **     JT_NATURAL
200 **     JT_LEFT
201 **     JT_RIGHT
202 **
203 ** A full outer join is the combination of JT_LEFT and JT_RIGHT.
204 **
205 ** If an illegal or unsupported join type is seen, then still return
206 ** a join type, but put an error in the pParse structure.
207 */
208 int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
209   int jointype = 0;
210   Token *apAll[3];
211   Token *p;
212                              /*   0123456789 123456789 123456789 123 */
213   static const char zKeyText[] = "naturaleftouterightfullinnercross";
214   static const struct {
215     u8 i;        /* Beginning of keyword text in zKeyText[] */
216     u8 nChar;    /* Length of the keyword in characters */
217     u8 code;     /* Join type mask */
218   } aKeyword[] = {
219     /* natural */ { 0,  7, JT_NATURAL                },
220     /* left    */ { 6,  4, JT_LEFT|JT_OUTER          },
221     /* outer   */ { 10, 5, JT_OUTER                  },
222     /* right   */ { 14, 5, JT_RIGHT|JT_OUTER         },
223     /* full    */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
224     /* inner   */ { 23, 5, JT_INNER                  },
225     /* cross   */ { 28, 5, JT_INNER|JT_CROSS         },
226   };
227   int i, j;
228   apAll[0] = pA;
229   apAll[1] = pB;
230   apAll[2] = pC;
231   for(i=0; i<3 && apAll[i]; i++){
232     p = apAll[i];
233     for(j=0; j<ArraySize(aKeyword); j++){
234       if( p->n==aKeyword[j].nChar
235           && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
236         jointype |= aKeyword[j].code;
237         break;
238       }
239     }
240     testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
241     if( j>=ArraySize(aKeyword) ){
242       jointype |= JT_ERROR;
243       break;
244     }
245   }
246   if(
247      (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
248      (jointype & JT_ERROR)!=0
249   ){
250     const char *zSp = " ";
251     assert( pB!=0 );
252     if( pC==0 ){ zSp++; }
253     sqlite3ErrorMsg(pParse, "unknown or unsupported join type: "
254        "%T %T%s%T", pA, pB, zSp, pC);
255     jointype = JT_INNER;
256   }else if( (jointype & JT_OUTER)!=0
257          && (jointype & (JT_LEFT|JT_RIGHT))!=JT_LEFT ){
258     sqlite3ErrorMsg(pParse,
259       "RIGHT and FULL OUTER JOINs are not currently supported");
260     jointype = JT_INNER;
261   }
262   return jointype;
263 }
264 
265 /*
266 ** Return the index of a column in a table.  Return -1 if the column
267 ** is not contained in the table.
268 */
269 int sqlite3ColumnIndex(Table *pTab, const char *zCol){
270   int i;
271   u8 h = sqlite3StrIHash(zCol);
272   Column *pCol;
273   for(pCol=pTab->aCol, i=0; i<pTab->nCol; pCol++, i++){
274     if( pCol->hName==h && sqlite3StrICmp(pCol->zCnName, zCol)==0 ) return i;
275   }
276   return -1;
277 }
278 
279 /*
280 ** Search the first N tables in pSrc, from left to right, looking for a
281 ** table that has a column named zCol.
282 **
283 ** When found, set *piTab and *piCol to the table index and column index
284 ** of the matching column and return TRUE.
285 **
286 ** If not found, return FALSE.
287 */
288 static int tableAndColumnIndex(
289   SrcList *pSrc,       /* Array of tables to search */
290   int N,               /* Number of tables in pSrc->a[] to search */
291   const char *zCol,    /* Name of the column we are looking for */
292   int *piTab,          /* Write index of pSrc->a[] here */
293   int *piCol,          /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
294   int bIgnoreHidden    /* True to ignore hidden columns */
295 ){
296   int i;               /* For looping over tables in pSrc */
297   int iCol;            /* Index of column matching zCol */
298 
299   assert( (piTab==0)==(piCol==0) );  /* Both or neither are NULL */
300   for(i=0; i<N; i++){
301     iCol = sqlite3ColumnIndex(pSrc->a[i].pTab, zCol);
302     if( iCol>=0
303      && (bIgnoreHidden==0 || IsHiddenColumn(&pSrc->a[i].pTab->aCol[iCol])==0)
304     ){
305       if( piTab ){
306         *piTab = i;
307         *piCol = iCol;
308       }
309       return 1;
310     }
311   }
312   return 0;
313 }
314 
315 /*
316 ** This function is used to add terms implied by JOIN syntax to the
317 ** WHERE clause expression of a SELECT statement. The new term, which
318 ** is ANDed with the existing WHERE clause, is of the form:
319 **
320 **    (tab1.col1 = tab2.col2)
321 **
322 ** where tab1 is the iSrc'th table in SrcList pSrc and tab2 is the
323 ** (iSrc+1)'th. Column col1 is column iColLeft of tab1, and col2 is
324 ** column iColRight of tab2.
325 */
326 static void addWhereTerm(
327   Parse *pParse,                  /* Parsing context */
328   SrcList *pSrc,                  /* List of tables in FROM clause */
329   int iLeft,                      /* Index of first table to join in pSrc */
330   int iColLeft,                   /* Index of column in first table */
331   int iRight,                     /* Index of second table in pSrc */
332   int iColRight,                  /* Index of column in second table */
333   int isOuterJoin,                /* True if this is an OUTER join */
334   Expr **ppWhere                  /* IN/OUT: The WHERE clause to add to */
335 ){
336   sqlite3 *db = pParse->db;
337   Expr *pE1;
338   Expr *pE2;
339   Expr *pEq;
340 
341   assert( iLeft<iRight );
342   assert( pSrc->nSrc>iRight );
343   assert( pSrc->a[iLeft].pTab );
344   assert( pSrc->a[iRight].pTab );
345 
346   pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iColLeft);
347   pE2 = sqlite3CreateColumnExpr(db, pSrc, iRight, iColRight);
348 
349   pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
350   if( pEq && isOuterJoin ){
351     ExprSetProperty(pEq, EP_FromJoin);
352     assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
353     ExprSetVVAProperty(pEq, EP_NoReduce);
354     pEq->iRightJoinTable = pE2->iTable;
355   }
356   *ppWhere = sqlite3ExprAnd(pParse, *ppWhere, pEq);
357 }
358 
359 /*
360 ** Set the EP_FromJoin property on all terms of the given expression.
361 ** And set the Expr.iRightJoinTable to iTable for every term in the
362 ** expression.
363 **
364 ** The EP_FromJoin property is used on terms of an expression to tell
365 ** the LEFT OUTER JOIN processing logic that this term is part of the
366 ** join restriction specified in the ON or USING clause and not a part
367 ** of the more general WHERE clause.  These terms are moved over to the
368 ** WHERE clause during join processing but we need to remember that they
369 ** originated in the ON or USING clause.
370 **
371 ** The Expr.iRightJoinTable tells the WHERE clause processing that the
372 ** expression depends on table iRightJoinTable even if that table is not
373 ** explicitly mentioned in the expression.  That information is needed
374 ** for cases like this:
375 **
376 **    SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
377 **
378 ** The where clause needs to defer the handling of the t1.x=5
379 ** term until after the t2 loop of the join.  In that way, a
380 ** NULL t2 row will be inserted whenever t1.x!=5.  If we do not
381 ** defer the handling of t1.x=5, it will be processed immediately
382 ** after the t1 loop and rows with t1.x!=5 will never appear in
383 ** the output, which is incorrect.
384 */
385 void sqlite3SetJoinExpr(Expr *p, int iTable){
386   while( p ){
387     ExprSetProperty(p, EP_FromJoin);
388     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
389     ExprSetVVAProperty(p, EP_NoReduce);
390     p->iRightJoinTable = iTable;
391     if( p->op==TK_FUNCTION && p->x.pList ){
392       int i;
393       for(i=0; i<p->x.pList->nExpr; i++){
394         sqlite3SetJoinExpr(p->x.pList->a[i].pExpr, iTable);
395       }
396     }
397     sqlite3SetJoinExpr(p->pLeft, iTable);
398     p = p->pRight;
399   }
400 }
401 
402 /* Undo the work of sqlite3SetJoinExpr(). In the expression p, convert every
403 ** term that is marked with EP_FromJoin and iRightJoinTable==iTable into
404 ** an ordinary term that omits the EP_FromJoin mark.
405 **
406 ** This happens when a LEFT JOIN is simplified into an ordinary JOIN.
407 */
408 static void unsetJoinExpr(Expr *p, int iTable){
409   while( p ){
410     if( ExprHasProperty(p, EP_FromJoin)
411      && (iTable<0 || p->iRightJoinTable==iTable) ){
412       ExprClearProperty(p, EP_FromJoin);
413     }
414     if( p->op==TK_COLUMN && p->iTable==iTable ){
415       ExprClearProperty(p, EP_CanBeNull);
416     }
417     if( p->op==TK_FUNCTION && p->x.pList ){
418       int i;
419       for(i=0; i<p->x.pList->nExpr; i++){
420         unsetJoinExpr(p->x.pList->a[i].pExpr, iTable);
421       }
422     }
423     unsetJoinExpr(p->pLeft, iTable);
424     p = p->pRight;
425   }
426 }
427 
428 /*
429 ** This routine processes the join information for a SELECT statement.
430 ** ON and USING clauses are converted into extra terms of the WHERE clause.
431 ** NATURAL joins also create extra WHERE clause terms.
432 **
433 ** The terms of a FROM clause are contained in the Select.pSrc structure.
434 ** The left most table is the first entry in Select.pSrc.  The right-most
435 ** table is the last entry.  The join operator is held in the entry to
436 ** the left.  Thus entry 0 contains the join operator for the join between
437 ** entries 0 and 1.  Any ON or USING clauses associated with the join are
438 ** also attached to the left entry.
439 **
440 ** This routine returns the number of errors encountered.
441 */
442 static int sqliteProcessJoin(Parse *pParse, Select *p){
443   SrcList *pSrc;                  /* All tables in the FROM clause */
444   int i, j;                       /* Loop counters */
445   SrcItem *pLeft;                 /* Left table being joined */
446   SrcItem *pRight;                /* Right table being joined */
447 
448   pSrc = p->pSrc;
449   pLeft = &pSrc->a[0];
450   pRight = &pLeft[1];
451   for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
452     Table *pRightTab = pRight->pTab;
453     int isOuter;
454 
455     if( NEVER(pLeft->pTab==0 || pRightTab==0) ) continue;
456     isOuter = (pRight->fg.jointype & JT_OUTER)!=0;
457 
458     /* When the NATURAL keyword is present, add WHERE clause terms for
459     ** every column that the two tables have in common.
460     */
461     if( pRight->fg.jointype & JT_NATURAL ){
462       if( pRight->pOn || pRight->pUsing ){
463         sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
464            "an ON or USING clause", 0);
465         return 1;
466       }
467       for(j=0; j<pRightTab->nCol; j++){
468         char *zName;   /* Name of column in the right table */
469         int iLeft;     /* Matching left table */
470         int iLeftCol;  /* Matching column in the left table */
471 
472         if( IsHiddenColumn(&pRightTab->aCol[j]) ) continue;
473         zName = pRightTab->aCol[j].zCnName;
474         if( tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol, 1) ){
475           addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, j,
476                 isOuter, &p->pWhere);
477         }
478       }
479     }
480 
481     /* Disallow both ON and USING clauses in the same join
482     */
483     if( pRight->pOn && pRight->pUsing ){
484       sqlite3ErrorMsg(pParse, "cannot have both ON and USING "
485         "clauses in the same join");
486       return 1;
487     }
488 
489     /* Add the ON clause to the end of the WHERE clause, connected by
490     ** an AND operator.
491     */
492     if( pRight->pOn ){
493       if( isOuter ) sqlite3SetJoinExpr(pRight->pOn, pRight->iCursor);
494       p->pWhere = sqlite3ExprAnd(pParse, p->pWhere, pRight->pOn);
495       pRight->pOn = 0;
496     }
497 
498     /* Create extra terms on the WHERE clause for each column named
499     ** in the USING clause.  Example: If the two tables to be joined are
500     ** A and B and the USING clause names X, Y, and Z, then add this
501     ** to the WHERE clause:    A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
502     ** Report an error if any column mentioned in the USING clause is
503     ** not contained in both tables to be joined.
504     */
505     if( pRight->pUsing ){
506       IdList *pList = pRight->pUsing;
507       for(j=0; j<pList->nId; j++){
508         char *zName;     /* Name of the term in the USING clause */
509         int iLeft;       /* Table on the left with matching column name */
510         int iLeftCol;    /* Column number of matching column on the left */
511         int iRightCol;   /* Column number of matching column on the right */
512 
513         zName = pList->a[j].zName;
514         iRightCol = sqlite3ColumnIndex(pRightTab, zName);
515         if( iRightCol<0
516          || !tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol, 0)
517         ){
518           sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
519             "not present in both tables", zName);
520           return 1;
521         }
522         addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, iRightCol,
523                      isOuter, &p->pWhere);
524       }
525     }
526   }
527   return 0;
528 }
529 
530 /*
531 ** An instance of this object holds information (beyond pParse and pSelect)
532 ** needed to load the next result row that is to be added to the sorter.
533 */
534 typedef struct RowLoadInfo RowLoadInfo;
535 struct RowLoadInfo {
536   int regResult;               /* Store results in array of registers here */
537   u8 ecelFlags;                /* Flag argument to ExprCodeExprList() */
538 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
539   ExprList *pExtra;            /* Extra columns needed by sorter refs */
540   int regExtraResult;          /* Where to load the extra columns */
541 #endif
542 };
543 
544 /*
545 ** This routine does the work of loading query data into an array of
546 ** registers so that it can be added to the sorter.
547 */
548 static void innerLoopLoadRow(
549   Parse *pParse,             /* Statement under construction */
550   Select *pSelect,           /* The query being coded */
551   RowLoadInfo *pInfo         /* Info needed to complete the row load */
552 ){
553   sqlite3ExprCodeExprList(pParse, pSelect->pEList, pInfo->regResult,
554                           0, pInfo->ecelFlags);
555 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
556   if( pInfo->pExtra ){
557     sqlite3ExprCodeExprList(pParse, pInfo->pExtra, pInfo->regExtraResult, 0, 0);
558     sqlite3ExprListDelete(pParse->db, pInfo->pExtra);
559   }
560 #endif
561 }
562 
563 /*
564 ** Code the OP_MakeRecord instruction that generates the entry to be
565 ** added into the sorter.
566 **
567 ** Return the register in which the result is stored.
568 */
569 static int makeSorterRecord(
570   Parse *pParse,
571   SortCtx *pSort,
572   Select *pSelect,
573   int regBase,
574   int nBase
575 ){
576   int nOBSat = pSort->nOBSat;
577   Vdbe *v = pParse->pVdbe;
578   int regOut = ++pParse->nMem;
579   if( pSort->pDeferredRowLoad ){
580     innerLoopLoadRow(pParse, pSelect, pSort->pDeferredRowLoad);
581   }
582   sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regOut);
583   return regOut;
584 }
585 
586 /*
587 ** Generate code that will push the record in registers regData
588 ** through regData+nData-1 onto the sorter.
589 */
590 static void pushOntoSorter(
591   Parse *pParse,         /* Parser context */
592   SortCtx *pSort,        /* Information about the ORDER BY clause */
593   Select *pSelect,       /* The whole SELECT statement */
594   int regData,           /* First register holding data to be sorted */
595   int regOrigData,       /* First register holding data before packing */
596   int nData,             /* Number of elements in the regData data array */
597   int nPrefixReg         /* No. of reg prior to regData available for use */
598 ){
599   Vdbe *v = pParse->pVdbe;                         /* Stmt under construction */
600   int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
601   int nExpr = pSort->pOrderBy->nExpr;              /* No. of ORDER BY terms */
602   int nBase = nExpr + bSeq + nData;                /* Fields in sorter record */
603   int regBase;                                     /* Regs for sorter record */
604   int regRecord = 0;                               /* Assembled sorter record */
605   int nOBSat = pSort->nOBSat;                      /* ORDER BY terms to skip */
606   int op;                            /* Opcode to add sorter record to sorter */
607   int iLimit;                        /* LIMIT counter */
608   int iSkip = 0;                     /* End of the sorter insert loop */
609 
610   assert( bSeq==0 || bSeq==1 );
611 
612   /* Three cases:
613   **   (1) The data to be sorted has already been packed into a Record
614   **       by a prior OP_MakeRecord.  In this case nData==1 and regData
615   **       will be completely unrelated to regOrigData.
616   **   (2) All output columns are included in the sort record.  In that
617   **       case regData==regOrigData.
618   **   (3) Some output columns are omitted from the sort record due to
619   **       the SQLITE_ENABLE_SORTER_REFERENCE optimization, or due to the
620   **       SQLITE_ECEL_OMITREF optimization, or due to the
621   **       SortCtx.pDeferredRowLoad optimiation.  In any of these cases
622   **       regOrigData is 0 to prevent this routine from trying to copy
623   **       values that might not yet exist.
624   */
625   assert( nData==1 || regData==regOrigData || regOrigData==0 );
626 
627   if( nPrefixReg ){
628     assert( nPrefixReg==nExpr+bSeq );
629     regBase = regData - nPrefixReg;
630   }else{
631     regBase = pParse->nMem + 1;
632     pParse->nMem += nBase;
633   }
634   assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
635   iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
636   pSort->labelDone = sqlite3VdbeMakeLabel(pParse);
637   sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
638                           SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
639   if( bSeq ){
640     sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
641   }
642   if( nPrefixReg==0 && nData>0 ){
643     sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
644   }
645   if( nOBSat>0 ){
646     int regPrevKey;   /* The first nOBSat columns of the previous row */
647     int addrFirst;    /* Address of the OP_IfNot opcode */
648     int addrJmp;      /* Address of the OP_Jump opcode */
649     VdbeOp *pOp;      /* Opcode that opens the sorter */
650     int nKey;         /* Number of sorting key columns, including OP_Sequence */
651     KeyInfo *pKI;     /* Original KeyInfo on the sorter table */
652 
653     regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
654     regPrevKey = pParse->nMem+1;
655     pParse->nMem += pSort->nOBSat;
656     nKey = nExpr - pSort->nOBSat + bSeq;
657     if( bSeq ){
658       addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
659     }else{
660       addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
661     }
662     VdbeCoverage(v);
663     sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
664     pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
665     if( pParse->db->mallocFailed ) return;
666     pOp->p2 = nKey + nData;
667     pKI = pOp->p4.pKeyInfo;
668     memset(pKI->aSortFlags, 0, pKI->nKeyField); /* Makes OP_Jump testable */
669     sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
670     testcase( pKI->nAllField > pKI->nKeyField+2 );
671     pOp->p4.pKeyInfo = sqlite3KeyInfoFromExprList(pParse,pSort->pOrderBy,nOBSat,
672                                            pKI->nAllField-pKI->nKeyField-1);
673     pOp = 0; /* Ensure pOp not used after sqltie3VdbeAddOp3() */
674     addrJmp = sqlite3VdbeCurrentAddr(v);
675     sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
676     pSort->labelBkOut = sqlite3VdbeMakeLabel(pParse);
677     pSort->regReturn = ++pParse->nMem;
678     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
679     sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
680     if( iLimit ){
681       sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
682       VdbeCoverage(v);
683     }
684     sqlite3VdbeJumpHere(v, addrFirst);
685     sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
686     sqlite3VdbeJumpHere(v, addrJmp);
687   }
688   if( iLimit ){
689     /* At this point the values for the new sorter entry are stored
690     ** in an array of registers. They need to be composed into a record
691     ** and inserted into the sorter if either (a) there are currently
692     ** less than LIMIT+OFFSET items or (b) the new record is smaller than
693     ** the largest record currently in the sorter. If (b) is true and there
694     ** are already LIMIT+OFFSET items in the sorter, delete the largest
695     ** entry before inserting the new one. This way there are never more
696     ** than LIMIT+OFFSET items in the sorter.
697     **
698     ** If the new record does not need to be inserted into the sorter,
699     ** jump to the next iteration of the loop. If the pSort->labelOBLopt
700     ** value is not zero, then it is a label of where to jump.  Otherwise,
701     ** just bypass the row insert logic.  See the header comment on the
702     ** sqlite3WhereOrderByLimitOptLabel() function for additional info.
703     */
704     int iCsr = pSort->iECursor;
705     sqlite3VdbeAddOp2(v, OP_IfNotZero, iLimit, sqlite3VdbeCurrentAddr(v)+4);
706     VdbeCoverage(v);
707     sqlite3VdbeAddOp2(v, OP_Last, iCsr, 0);
708     iSkip = sqlite3VdbeAddOp4Int(v, OP_IdxLE,
709                                  iCsr, 0, regBase+nOBSat, nExpr-nOBSat);
710     VdbeCoverage(v);
711     sqlite3VdbeAddOp1(v, OP_Delete, iCsr);
712   }
713   if( regRecord==0 ){
714     regRecord = makeSorterRecord(pParse, pSort, pSelect, regBase, nBase);
715   }
716   if( pSort->sortFlags & SORTFLAG_UseSorter ){
717     op = OP_SorterInsert;
718   }else{
719     op = OP_IdxInsert;
720   }
721   sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
722                        regBase+nOBSat, nBase-nOBSat);
723   if( iSkip ){
724     sqlite3VdbeChangeP2(v, iSkip,
725          pSort->labelOBLopt ? pSort->labelOBLopt : sqlite3VdbeCurrentAddr(v));
726   }
727 }
728 
729 /*
730 ** Add code to implement the OFFSET
731 */
732 static void codeOffset(
733   Vdbe *v,          /* Generate code into this VM */
734   int iOffset,      /* Register holding the offset counter */
735   int iContinue     /* Jump here to skip the current record */
736 ){
737   if( iOffset>0 ){
738     sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
739     VdbeComment((v, "OFFSET"));
740   }
741 }
742 
743 /*
744 ** Add code that will check to make sure the array of registers starting at
745 ** iMem form a distinct entry. This is used by both "SELECT DISTINCT ..." and
746 ** distinct aggregates ("SELECT count(DISTINCT <expr>) ..."). Three strategies
747 ** are available. Which is used depends on the value of parameter eTnctType,
748 ** as follows:
749 **
750 **   WHERE_DISTINCT_UNORDERED/WHERE_DISTINCT_NOOP:
751 **     Build an ephemeral table that contains all entries seen before and
752 **     skip entries which have been seen before.
753 **
754 **     Parameter iTab is the cursor number of an ephemeral table that must
755 **     be opened before the VM code generated by this routine is executed.
756 **     The ephemeral cursor table is queried for a record identical to the
757 **     record formed by the current array of registers. If one is found,
758 **     jump to VM address addrRepeat. Otherwise, insert a new record into
759 **     the ephemeral cursor and proceed.
760 **
761 **     The returned value in this case is a copy of parameter iTab.
762 **
763 **   WHERE_DISTINCT_ORDERED:
764 **     In this case rows are being delivered sorted order. The ephermal
765 **     table is not required. Instead, the current set of values
766 **     is compared against previous row. If they match, the new row
767 **     is not distinct and control jumps to VM address addrRepeat. Otherwise,
768 **     the VM program proceeds with processing the new row.
769 **
770 **     The returned value in this case is the register number of the first
771 **     in an array of registers used to store the previous result row so that
772 **     it can be compared to the next. The caller must ensure that this
773 **     register is initialized to NULL.  (The fixDistinctOpenEph() routine
774 **     will take care of this initialization.)
775 **
776 **   WHERE_DISTINCT_UNIQUE:
777 **     In this case it has already been determined that the rows are distinct.
778 **     No special action is required. The return value is zero.
779 **
780 ** Parameter pEList is the list of expressions used to generated the
781 ** contents of each row. It is used by this routine to determine (a)
782 ** how many elements there are in the array of registers and (b) the
783 ** collation sequences that should be used for the comparisons if
784 ** eTnctType is WHERE_DISTINCT_ORDERED.
785 */
786 static int codeDistinct(
787   Parse *pParse,     /* Parsing and code generating context */
788   int eTnctType,     /* WHERE_DISTINCT_* value */
789   int iTab,          /* A sorting index used to test for distinctness */
790   int addrRepeat,    /* Jump to here if not distinct */
791   ExprList *pEList,  /* Expression for each element */
792   int regElem        /* First element */
793 ){
794   int iRet = 0;
795   int nResultCol = pEList->nExpr;
796   Vdbe *v = pParse->pVdbe;
797 
798   switch( eTnctType ){
799     case WHERE_DISTINCT_ORDERED: {
800       int i;
801       int iJump;              /* Jump destination */
802       int regPrev;            /* Previous row content */
803 
804       /* Allocate space for the previous row */
805       iRet = regPrev = pParse->nMem+1;
806       pParse->nMem += nResultCol;
807 
808       iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
809       for(i=0; i<nResultCol; i++){
810         CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
811         if( i<nResultCol-1 ){
812           sqlite3VdbeAddOp3(v, OP_Ne, regElem+i, iJump, regPrev+i);
813           VdbeCoverage(v);
814         }else{
815           sqlite3VdbeAddOp3(v, OP_Eq, regElem+i, addrRepeat, regPrev+i);
816           VdbeCoverage(v);
817          }
818         sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
819         sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
820       }
821       assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
822       sqlite3VdbeAddOp3(v, OP_Copy, regElem, regPrev, nResultCol-1);
823       break;
824     }
825 
826     case WHERE_DISTINCT_UNIQUE: {
827       /* nothing to do */
828       break;
829     }
830 
831     default: {
832       int r1 = sqlite3GetTempReg(pParse);
833       sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, regElem, nResultCol);
834       VdbeCoverage(v);
835       sqlite3VdbeAddOp3(v, OP_MakeRecord, regElem, nResultCol, r1);
836       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, regElem, nResultCol);
837       sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
838       sqlite3ReleaseTempReg(pParse, r1);
839       iRet = iTab;
840       break;
841     }
842   }
843 
844   return iRet;
845 }
846 
847 /*
848 ** This routine runs after codeDistinct().  It makes necessary
849 ** adjustments to the OP_OpenEphemeral opcode that the codeDistinct()
850 ** routine made use of.  This processing must be done separately since
851 ** sometimes codeDistinct is called before the OP_OpenEphemeral is actually
852 ** laid down.
853 **
854 ** WHERE_DISTINCT_NOOP:
855 ** WHERE_DISTINCT_UNORDERED:
856 **
857 **     No adjustments necessary.  This function is a no-op.
858 **
859 ** WHERE_DISTINCT_UNIQUE:
860 **
861 **     The ephemeral table is not needed.  So change the
862 **     OP_OpenEphemeral opcode into an OP_Noop.
863 **
864 ** WHERE_DISTINCT_ORDERED:
865 **
866 **     The ephemeral table is not needed.  But we do need register
867 **     iVal to be initialized to NULL.  So change the OP_OpenEphemeral
868 **     into an OP_Null on the iVal register.
869 */
870 static void fixDistinctOpenEph(
871   Parse *pParse,     /* Parsing and code generating context */
872   int eTnctType,     /* WHERE_DISTINCT_* value */
873   int iVal,          /* Value returned by codeDistinct() */
874   int iOpenEphAddr   /* Address of OP_OpenEphemeral instruction for iTab */
875 ){
876   if( pParse->nErr==0
877    && (eTnctType==WHERE_DISTINCT_UNIQUE || eTnctType==WHERE_DISTINCT_ORDERED)
878   ){
879     Vdbe *v = pParse->pVdbe;
880     sqlite3VdbeChangeToNoop(v, iOpenEphAddr);
881     if( sqlite3VdbeGetOp(v, iOpenEphAddr+1)->opcode==OP_Explain ){
882       sqlite3VdbeChangeToNoop(v, iOpenEphAddr+1);
883     }
884     if( eTnctType==WHERE_DISTINCT_ORDERED ){
885       /* Change the OP_OpenEphemeral to an OP_Null that sets the MEM_Cleared
886       ** bit on the first register of the previous value.  This will cause the
887       ** OP_Ne added in codeDistinct() to always fail on the first iteration of
888       ** the loop even if the first row is all NULLs.  */
889       VdbeOp *pOp = sqlite3VdbeGetOp(v, iOpenEphAddr);
890       pOp->opcode = OP_Null;
891       pOp->p1 = 1;
892       pOp->p2 = iVal;
893     }
894   }
895 }
896 
897 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
898 /*
899 ** This function is called as part of inner-loop generation for a SELECT
900 ** statement with an ORDER BY that is not optimized by an index. It
901 ** determines the expressions, if any, that the sorter-reference
902 ** optimization should be used for. The sorter-reference optimization
903 ** is used for SELECT queries like:
904 **
905 **   SELECT a, bigblob FROM t1 ORDER BY a LIMIT 10
906 **
907 ** If the optimization is used for expression "bigblob", then instead of
908 ** storing values read from that column in the sorter records, the PK of
909 ** the row from table t1 is stored instead. Then, as records are extracted from
910 ** the sorter to return to the user, the required value of bigblob is
911 ** retrieved directly from table t1. If the values are very large, this
912 ** can be more efficient than storing them directly in the sorter records.
913 **
914 ** The ExprList_item.bSorterRef flag is set for each expression in pEList
915 ** for which the sorter-reference optimization should be enabled.
916 ** Additionally, the pSort->aDefer[] array is populated with entries
917 ** for all cursors required to evaluate all selected expressions. Finally.
918 ** output variable (*ppExtra) is set to an expression list containing
919 ** expressions for all extra PK values that should be stored in the
920 ** sorter records.
921 */
922 static void selectExprDefer(
923   Parse *pParse,                  /* Leave any error here */
924   SortCtx *pSort,                 /* Sorter context */
925   ExprList *pEList,               /* Expressions destined for sorter */
926   ExprList **ppExtra              /* Expressions to append to sorter record */
927 ){
928   int i;
929   int nDefer = 0;
930   ExprList *pExtra = 0;
931   for(i=0; i<pEList->nExpr; i++){
932     struct ExprList_item *pItem = &pEList->a[i];
933     if( pItem->u.x.iOrderByCol==0 ){
934       Expr *pExpr = pItem->pExpr;
935       Table *pTab = pExpr->y.pTab;
936       if( pExpr->op==TK_COLUMN && pExpr->iColumn>=0 && pTab && !IsVirtual(pTab)
937        && (pTab->aCol[pExpr->iColumn].colFlags & COLFLAG_SORTERREF)
938       ){
939         int j;
940         for(j=0; j<nDefer; j++){
941           if( pSort->aDefer[j].iCsr==pExpr->iTable ) break;
942         }
943         if( j==nDefer ){
944           if( nDefer==ArraySize(pSort->aDefer) ){
945             continue;
946           }else{
947             int nKey = 1;
948             int k;
949             Index *pPk = 0;
950             if( !HasRowid(pTab) ){
951               pPk = sqlite3PrimaryKeyIndex(pTab);
952               nKey = pPk->nKeyCol;
953             }
954             for(k=0; k<nKey; k++){
955               Expr *pNew = sqlite3PExpr(pParse, TK_COLUMN, 0, 0);
956               if( pNew ){
957                 pNew->iTable = pExpr->iTable;
958                 pNew->y.pTab = pExpr->y.pTab;
959                 pNew->iColumn = pPk ? pPk->aiColumn[k] : -1;
960                 pExtra = sqlite3ExprListAppend(pParse, pExtra, pNew);
961               }
962             }
963             pSort->aDefer[nDefer].pTab = pExpr->y.pTab;
964             pSort->aDefer[nDefer].iCsr = pExpr->iTable;
965             pSort->aDefer[nDefer].nKey = nKey;
966             nDefer++;
967           }
968         }
969         pItem->bSorterRef = 1;
970       }
971     }
972   }
973   pSort->nDefer = (u8)nDefer;
974   *ppExtra = pExtra;
975 }
976 #endif
977 
978 /*
979 ** This routine generates the code for the inside of the inner loop
980 ** of a SELECT.
981 **
982 ** If srcTab is negative, then the p->pEList expressions
983 ** are evaluated in order to get the data for this row.  If srcTab is
984 ** zero or more, then data is pulled from srcTab and p->pEList is used only
985 ** to get the number of columns and the collation sequence for each column.
986 */
987 static void selectInnerLoop(
988   Parse *pParse,          /* The parser context */
989   Select *p,              /* The complete select statement being coded */
990   int srcTab,             /* Pull data from this table if non-negative */
991   SortCtx *pSort,         /* If not NULL, info on how to process ORDER BY */
992   DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
993   SelectDest *pDest,      /* How to dispose of the results */
994   int iContinue,          /* Jump here to continue with next row */
995   int iBreak              /* Jump here to break out of the inner loop */
996 ){
997   Vdbe *v = pParse->pVdbe;
998   int i;
999   int hasDistinct;            /* True if the DISTINCT keyword is present */
1000   int eDest = pDest->eDest;   /* How to dispose of results */
1001   int iParm = pDest->iSDParm; /* First argument to disposal method */
1002   int nResultCol;             /* Number of result columns */
1003   int nPrefixReg = 0;         /* Number of extra registers before regResult */
1004   RowLoadInfo sRowLoadInfo;   /* Info for deferred row loading */
1005 
1006   /* Usually, regResult is the first cell in an array of memory cells
1007   ** containing the current result row. In this case regOrig is set to the
1008   ** same value. However, if the results are being sent to the sorter, the
1009   ** values for any expressions that are also part of the sort-key are omitted
1010   ** from this array. In this case regOrig is set to zero.  */
1011   int regResult;              /* Start of memory holding current results */
1012   int regOrig;                /* Start of memory holding full result (or 0) */
1013 
1014   assert( v );
1015   assert( p->pEList!=0 );
1016   hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
1017   if( pSort && pSort->pOrderBy==0 ) pSort = 0;
1018   if( pSort==0 && !hasDistinct ){
1019     assert( iContinue!=0 );
1020     codeOffset(v, p->iOffset, iContinue);
1021   }
1022 
1023   /* Pull the requested columns.
1024   */
1025   nResultCol = p->pEList->nExpr;
1026 
1027   if( pDest->iSdst==0 ){
1028     if( pSort ){
1029       nPrefixReg = pSort->pOrderBy->nExpr;
1030       if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
1031       pParse->nMem += nPrefixReg;
1032     }
1033     pDest->iSdst = pParse->nMem+1;
1034     pParse->nMem += nResultCol;
1035   }else if( pDest->iSdst+nResultCol > pParse->nMem ){
1036     /* This is an error condition that can result, for example, when a SELECT
1037     ** on the right-hand side of an INSERT contains more result columns than
1038     ** there are columns in the table on the left.  The error will be caught
1039     ** and reported later.  But we need to make sure enough memory is allocated
1040     ** to avoid other spurious errors in the meantime. */
1041     pParse->nMem += nResultCol;
1042   }
1043   pDest->nSdst = nResultCol;
1044   regOrig = regResult = pDest->iSdst;
1045   if( srcTab>=0 ){
1046     for(i=0; i<nResultCol; i++){
1047       sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
1048       VdbeComment((v, "%s", p->pEList->a[i].zEName));
1049     }
1050   }else if( eDest!=SRT_Exists ){
1051 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1052     ExprList *pExtra = 0;
1053 #endif
1054     /* If the destination is an EXISTS(...) expression, the actual
1055     ** values returned by the SELECT are not required.
1056     */
1057     u8 ecelFlags;    /* "ecel" is an abbreviation of "ExprCodeExprList" */
1058     ExprList *pEList;
1059     if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
1060       ecelFlags = SQLITE_ECEL_DUP;
1061     }else{
1062       ecelFlags = 0;
1063     }
1064     if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
1065       /* For each expression in p->pEList that is a copy of an expression in
1066       ** the ORDER BY clause (pSort->pOrderBy), set the associated
1067       ** iOrderByCol value to one more than the index of the ORDER BY
1068       ** expression within the sort-key that pushOntoSorter() will generate.
1069       ** This allows the p->pEList field to be omitted from the sorted record,
1070       ** saving space and CPU cycles.  */
1071       ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
1072 
1073       for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
1074         int j;
1075         if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
1076           p->pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
1077         }
1078       }
1079 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1080       selectExprDefer(pParse, pSort, p->pEList, &pExtra);
1081       if( pExtra && pParse->db->mallocFailed==0 ){
1082         /* If there are any extra PK columns to add to the sorter records,
1083         ** allocate extra memory cells and adjust the OpenEphemeral
1084         ** instruction to account for the larger records. This is only
1085         ** required if there are one or more WITHOUT ROWID tables with
1086         ** composite primary keys in the SortCtx.aDefer[] array.  */
1087         VdbeOp *pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
1088         pOp->p2 += (pExtra->nExpr - pSort->nDefer);
1089         pOp->p4.pKeyInfo->nAllField += (pExtra->nExpr - pSort->nDefer);
1090         pParse->nMem += pExtra->nExpr;
1091       }
1092 #endif
1093 
1094       /* Adjust nResultCol to account for columns that are omitted
1095       ** from the sorter by the optimizations in this branch */
1096       pEList = p->pEList;
1097       for(i=0; i<pEList->nExpr; i++){
1098         if( pEList->a[i].u.x.iOrderByCol>0
1099 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1100          || pEList->a[i].bSorterRef
1101 #endif
1102         ){
1103           nResultCol--;
1104           regOrig = 0;
1105         }
1106       }
1107 
1108       testcase( regOrig );
1109       testcase( eDest==SRT_Set );
1110       testcase( eDest==SRT_Mem );
1111       testcase( eDest==SRT_Coroutine );
1112       testcase( eDest==SRT_Output );
1113       assert( eDest==SRT_Set || eDest==SRT_Mem
1114            || eDest==SRT_Coroutine || eDest==SRT_Output
1115            || eDest==SRT_Upfrom );
1116     }
1117     sRowLoadInfo.regResult = regResult;
1118     sRowLoadInfo.ecelFlags = ecelFlags;
1119 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1120     sRowLoadInfo.pExtra = pExtra;
1121     sRowLoadInfo.regExtraResult = regResult + nResultCol;
1122     if( pExtra ) nResultCol += pExtra->nExpr;
1123 #endif
1124     if( p->iLimit
1125      && (ecelFlags & SQLITE_ECEL_OMITREF)!=0
1126      && nPrefixReg>0
1127     ){
1128       assert( pSort!=0 );
1129       assert( hasDistinct==0 );
1130       pSort->pDeferredRowLoad = &sRowLoadInfo;
1131       regOrig = 0;
1132     }else{
1133       innerLoopLoadRow(pParse, p, &sRowLoadInfo);
1134     }
1135   }
1136 
1137   /* If the DISTINCT keyword was present on the SELECT statement
1138   ** and this row has been seen before, then do not make this row
1139   ** part of the result.
1140   */
1141   if( hasDistinct ){
1142     int eType = pDistinct->eTnctType;
1143     int iTab = pDistinct->tabTnct;
1144     assert( nResultCol==p->pEList->nExpr );
1145     iTab = codeDistinct(pParse, eType, iTab, iContinue, p->pEList, regResult);
1146     fixDistinctOpenEph(pParse, eType, iTab, pDistinct->addrTnct);
1147     if( pSort==0 ){
1148       codeOffset(v, p->iOffset, iContinue);
1149     }
1150   }
1151 
1152   switch( eDest ){
1153     /* In this mode, write each query result to the key of the temporary
1154     ** table iParm.
1155     */
1156 #ifndef SQLITE_OMIT_COMPOUND_SELECT
1157     case SRT_Union: {
1158       int r1;
1159       r1 = sqlite3GetTempReg(pParse);
1160       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
1161       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
1162       sqlite3ReleaseTempReg(pParse, r1);
1163       break;
1164     }
1165 
1166     /* Construct a record from the query result, but instead of
1167     ** saving that record, use it as a key to delete elements from
1168     ** the temporary table iParm.
1169     */
1170     case SRT_Except: {
1171       sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
1172       break;
1173     }
1174 #endif /* SQLITE_OMIT_COMPOUND_SELECT */
1175 
1176     /* Store the result as data using a unique key.
1177     */
1178     case SRT_Fifo:
1179     case SRT_DistFifo:
1180     case SRT_Table:
1181     case SRT_EphemTab: {
1182       int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
1183       testcase( eDest==SRT_Table );
1184       testcase( eDest==SRT_EphemTab );
1185       testcase( eDest==SRT_Fifo );
1186       testcase( eDest==SRT_DistFifo );
1187       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
1188 #ifndef SQLITE_OMIT_CTE
1189       if( eDest==SRT_DistFifo ){
1190         /* If the destination is DistFifo, then cursor (iParm+1) is open
1191         ** on an ephemeral index. If the current row is already present
1192         ** in the index, do not write it to the output. If not, add the
1193         ** current row to the index and proceed with writing it to the
1194         ** output table as well.  */
1195         int addr = sqlite3VdbeCurrentAddr(v) + 4;
1196         sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
1197         VdbeCoverage(v);
1198         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
1199         assert( pSort==0 );
1200       }
1201 #endif
1202       if( pSort ){
1203         assert( regResult==regOrig );
1204         pushOntoSorter(pParse, pSort, p, r1+nPrefixReg, regOrig, 1, nPrefixReg);
1205       }else{
1206         int r2 = sqlite3GetTempReg(pParse);
1207         sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
1208         sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
1209         sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1210         sqlite3ReleaseTempReg(pParse, r2);
1211       }
1212       sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
1213       break;
1214     }
1215 
1216     case SRT_Upfrom: {
1217       if( pSort ){
1218         pushOntoSorter(
1219             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
1220       }else{
1221         int i2 = pDest->iSDParm2;
1222         int r1 = sqlite3GetTempReg(pParse);
1223 
1224         /* If the UPDATE FROM join is an aggregate that matches no rows, it
1225         ** might still be trying to return one row, because that is what
1226         ** aggregates do.  Don't record that empty row in the output table. */
1227         sqlite3VdbeAddOp2(v, OP_IsNull, regResult, iBreak); VdbeCoverage(v);
1228 
1229         sqlite3VdbeAddOp3(v, OP_MakeRecord,
1230                           regResult+(i2<0), nResultCol-(i2<0), r1);
1231         if( i2<0 ){
1232           sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regResult);
1233         }else{
1234           sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, i2);
1235         }
1236       }
1237       break;
1238     }
1239 
1240 #ifndef SQLITE_OMIT_SUBQUERY
1241     /* If we are creating a set for an "expr IN (SELECT ...)" construct,
1242     ** then there should be a single item on the stack.  Write this
1243     ** item into the set table with bogus data.
1244     */
1245     case SRT_Set: {
1246       if( pSort ){
1247         /* At first glance you would think we could optimize out the
1248         ** ORDER BY in this case since the order of entries in the set
1249         ** does not matter.  But there might be a LIMIT clause, in which
1250         ** case the order does matter */
1251         pushOntoSorter(
1252             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
1253       }else{
1254         int r1 = sqlite3GetTempReg(pParse);
1255         assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
1256         sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
1257             r1, pDest->zAffSdst, nResultCol);
1258         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
1259         sqlite3ReleaseTempReg(pParse, r1);
1260       }
1261       break;
1262     }
1263 
1264 
1265     /* If any row exist in the result set, record that fact and abort.
1266     */
1267     case SRT_Exists: {
1268       sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
1269       /* The LIMIT clause will terminate the loop for us */
1270       break;
1271     }
1272 
1273     /* If this is a scalar select that is part of an expression, then
1274     ** store the results in the appropriate memory cell or array of
1275     ** memory cells and break out of the scan loop.
1276     */
1277     case SRT_Mem: {
1278       if( pSort ){
1279         assert( nResultCol<=pDest->nSdst );
1280         pushOntoSorter(
1281             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
1282       }else{
1283         assert( nResultCol==pDest->nSdst );
1284         assert( regResult==iParm );
1285         /* The LIMIT clause will jump out of the loop for us */
1286       }
1287       break;
1288     }
1289 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
1290 
1291     case SRT_Coroutine:       /* Send data to a co-routine */
1292     case SRT_Output: {        /* Return the results */
1293       testcase( eDest==SRT_Coroutine );
1294       testcase( eDest==SRT_Output );
1295       if( pSort ){
1296         pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
1297                        nPrefixReg);
1298       }else if( eDest==SRT_Coroutine ){
1299         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
1300       }else{
1301         sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
1302       }
1303       break;
1304     }
1305 
1306 #ifndef SQLITE_OMIT_CTE
1307     /* Write the results into a priority queue that is order according to
1308     ** pDest->pOrderBy (in pSO).  pDest->iSDParm (in iParm) is the cursor for an
1309     ** index with pSO->nExpr+2 columns.  Build a key using pSO for the first
1310     ** pSO->nExpr columns, then make sure all keys are unique by adding a
1311     ** final OP_Sequence column.  The last column is the record as a blob.
1312     */
1313     case SRT_DistQueue:
1314     case SRT_Queue: {
1315       int nKey;
1316       int r1, r2, r3;
1317       int addrTest = 0;
1318       ExprList *pSO;
1319       pSO = pDest->pOrderBy;
1320       assert( pSO );
1321       nKey = pSO->nExpr;
1322       r1 = sqlite3GetTempReg(pParse);
1323       r2 = sqlite3GetTempRange(pParse, nKey+2);
1324       r3 = r2+nKey+1;
1325       if( eDest==SRT_DistQueue ){
1326         /* If the destination is DistQueue, then cursor (iParm+1) is open
1327         ** on a second ephemeral index that holds all values every previously
1328         ** added to the queue. */
1329         addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
1330                                         regResult, nResultCol);
1331         VdbeCoverage(v);
1332       }
1333       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
1334       if( eDest==SRT_DistQueue ){
1335         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
1336         sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
1337       }
1338       for(i=0; i<nKey; i++){
1339         sqlite3VdbeAddOp2(v, OP_SCopy,
1340                           regResult + pSO->a[i].u.x.iOrderByCol - 1,
1341                           r2+i);
1342       }
1343       sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
1344       sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
1345       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
1346       if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
1347       sqlite3ReleaseTempReg(pParse, r1);
1348       sqlite3ReleaseTempRange(pParse, r2, nKey+2);
1349       break;
1350     }
1351 #endif /* SQLITE_OMIT_CTE */
1352 
1353 
1354 
1355 #if !defined(SQLITE_OMIT_TRIGGER)
1356     /* Discard the results.  This is used for SELECT statements inside
1357     ** the body of a TRIGGER.  The purpose of such selects is to call
1358     ** user-defined functions that have side effects.  We do not care
1359     ** about the actual results of the select.
1360     */
1361     default: {
1362       assert( eDest==SRT_Discard );
1363       break;
1364     }
1365 #endif
1366   }
1367 
1368   /* Jump to the end of the loop if the LIMIT is reached.  Except, if
1369   ** there is a sorter, in which case the sorter has already limited
1370   ** the output for us.
1371   */
1372   if( pSort==0 && p->iLimit ){
1373     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
1374   }
1375 }
1376 
1377 /*
1378 ** Allocate a KeyInfo object sufficient for an index of N key columns and
1379 ** X extra columns.
1380 */
1381 KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
1382   int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
1383   KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
1384   if( p ){
1385     p->aSortFlags = (u8*)&p->aColl[N+X];
1386     p->nKeyField = (u16)N;
1387     p->nAllField = (u16)(N+X);
1388     p->enc = ENC(db);
1389     p->db = db;
1390     p->nRef = 1;
1391     memset(&p[1], 0, nExtra);
1392   }else{
1393     sqlite3OomFault(db);
1394   }
1395   return p;
1396 }
1397 
1398 /*
1399 ** Deallocate a KeyInfo object
1400 */
1401 void sqlite3KeyInfoUnref(KeyInfo *p){
1402   if( p ){
1403     assert( p->nRef>0 );
1404     p->nRef--;
1405     if( p->nRef==0 ) sqlite3DbFreeNN(p->db, p);
1406   }
1407 }
1408 
1409 /*
1410 ** Make a new pointer to a KeyInfo object
1411 */
1412 KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
1413   if( p ){
1414     assert( p->nRef>0 );
1415     p->nRef++;
1416   }
1417   return p;
1418 }
1419 
1420 #ifdef SQLITE_DEBUG
1421 /*
1422 ** Return TRUE if a KeyInfo object can be change.  The KeyInfo object
1423 ** can only be changed if this is just a single reference to the object.
1424 **
1425 ** This routine is used only inside of assert() statements.
1426 */
1427 int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
1428 #endif /* SQLITE_DEBUG */
1429 
1430 /*
1431 ** Given an expression list, generate a KeyInfo structure that records
1432 ** the collating sequence for each expression in that expression list.
1433 **
1434 ** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
1435 ** KeyInfo structure is appropriate for initializing a virtual index to
1436 ** implement that clause.  If the ExprList is the result set of a SELECT
1437 ** then the KeyInfo structure is appropriate for initializing a virtual
1438 ** index to implement a DISTINCT test.
1439 **
1440 ** Space to hold the KeyInfo structure is obtained from malloc.  The calling
1441 ** function is responsible for seeing that this structure is eventually
1442 ** freed.
1443 */
1444 KeyInfo *sqlite3KeyInfoFromExprList(
1445   Parse *pParse,       /* Parsing context */
1446   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
1447   int iStart,          /* Begin with this column of pList */
1448   int nExtra           /* Add this many extra columns to the end */
1449 ){
1450   int nExpr;
1451   KeyInfo *pInfo;
1452   struct ExprList_item *pItem;
1453   sqlite3 *db = pParse->db;
1454   int i;
1455 
1456   nExpr = pList->nExpr;
1457   pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
1458   if( pInfo ){
1459     assert( sqlite3KeyInfoIsWriteable(pInfo) );
1460     for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
1461       pInfo->aColl[i-iStart] = sqlite3ExprNNCollSeq(pParse, pItem->pExpr);
1462       pInfo->aSortFlags[i-iStart] = pItem->sortFlags;
1463     }
1464   }
1465   return pInfo;
1466 }
1467 
1468 /*
1469 ** Name of the connection operator, used for error messages.
1470 */
1471 const char *sqlite3SelectOpName(int id){
1472   char *z;
1473   switch( id ){
1474     case TK_ALL:       z = "UNION ALL";   break;
1475     case TK_INTERSECT: z = "INTERSECT";   break;
1476     case TK_EXCEPT:    z = "EXCEPT";      break;
1477     default:           z = "UNION";       break;
1478   }
1479   return z;
1480 }
1481 
1482 #ifndef SQLITE_OMIT_EXPLAIN
1483 /*
1484 ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1485 ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1486 ** where the caption is of the form:
1487 **
1488 **   "USE TEMP B-TREE FOR xxx"
1489 **
1490 ** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
1491 ** is determined by the zUsage argument.
1492 */
1493 static void explainTempTable(Parse *pParse, const char *zUsage){
1494   ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s", zUsage));
1495 }
1496 
1497 /*
1498 ** Assign expression b to lvalue a. A second, no-op, version of this macro
1499 ** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1500 ** in sqlite3Select() to assign values to structure member variables that
1501 ** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1502 ** code with #ifndef directives.
1503 */
1504 # define explainSetInteger(a, b) a = b
1505 
1506 #else
1507 /* No-op versions of the explainXXX() functions and macros. */
1508 # define explainTempTable(y,z)
1509 # define explainSetInteger(y,z)
1510 #endif
1511 
1512 
1513 /*
1514 ** If the inner loop was generated using a non-null pOrderBy argument,
1515 ** then the results were placed in a sorter.  After the loop is terminated
1516 ** we need to run the sorter and output the results.  The following
1517 ** routine generates the code needed to do that.
1518 */
1519 static void generateSortTail(
1520   Parse *pParse,    /* Parsing context */
1521   Select *p,        /* The SELECT statement */
1522   SortCtx *pSort,   /* Information on the ORDER BY clause */
1523   int nColumn,      /* Number of columns of data */
1524   SelectDest *pDest /* Write the sorted results here */
1525 ){
1526   Vdbe *v = pParse->pVdbe;                     /* The prepared statement */
1527   int addrBreak = pSort->labelDone;            /* Jump here to exit loop */
1528   int addrContinue = sqlite3VdbeMakeLabel(pParse);/* Jump here for next cycle */
1529   int addr;                       /* Top of output loop. Jump for Next. */
1530   int addrOnce = 0;
1531   int iTab;
1532   ExprList *pOrderBy = pSort->pOrderBy;
1533   int eDest = pDest->eDest;
1534   int iParm = pDest->iSDParm;
1535   int regRow;
1536   int regRowid;
1537   int iCol;
1538   int nKey;                       /* Number of key columns in sorter record */
1539   int iSortTab;                   /* Sorter cursor to read from */
1540   int i;
1541   int bSeq;                       /* True if sorter record includes seq. no. */
1542   int nRefKey = 0;
1543   struct ExprList_item *aOutEx = p->pEList->a;
1544 
1545   assert( addrBreak<0 );
1546   if( pSort->labelBkOut ){
1547     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
1548     sqlite3VdbeGoto(v, addrBreak);
1549     sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
1550   }
1551 
1552 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1553   /* Open any cursors needed for sorter-reference expressions */
1554   for(i=0; i<pSort->nDefer; i++){
1555     Table *pTab = pSort->aDefer[i].pTab;
1556     int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1557     sqlite3OpenTable(pParse, pSort->aDefer[i].iCsr, iDb, pTab, OP_OpenRead);
1558     nRefKey = MAX(nRefKey, pSort->aDefer[i].nKey);
1559   }
1560 #endif
1561 
1562   iTab = pSort->iECursor;
1563   if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
1564     regRowid = 0;
1565     regRow = pDest->iSdst;
1566   }else{
1567     regRowid = sqlite3GetTempReg(pParse);
1568     if( eDest==SRT_EphemTab || eDest==SRT_Table ){
1569       regRow = sqlite3GetTempReg(pParse);
1570       nColumn = 0;
1571     }else{
1572       regRow = sqlite3GetTempRange(pParse, nColumn);
1573     }
1574   }
1575   nKey = pOrderBy->nExpr - pSort->nOBSat;
1576   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1577     int regSortOut = ++pParse->nMem;
1578     iSortTab = pParse->nTab++;
1579     if( pSort->labelBkOut ){
1580       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
1581     }
1582     sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut,
1583         nKey+1+nColumn+nRefKey);
1584     if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
1585     addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
1586     VdbeCoverage(v);
1587     codeOffset(v, p->iOffset, addrContinue);
1588     sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
1589     bSeq = 0;
1590   }else{
1591     addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
1592     codeOffset(v, p->iOffset, addrContinue);
1593     iSortTab = iTab;
1594     bSeq = 1;
1595   }
1596   for(i=0, iCol=nKey+bSeq-1; i<nColumn; i++){
1597 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1598     if( aOutEx[i].bSorterRef ) continue;
1599 #endif
1600     if( aOutEx[i].u.x.iOrderByCol==0 ) iCol++;
1601   }
1602 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1603   if( pSort->nDefer ){
1604     int iKey = iCol+1;
1605     int regKey = sqlite3GetTempRange(pParse, nRefKey);
1606 
1607     for(i=0; i<pSort->nDefer; i++){
1608       int iCsr = pSort->aDefer[i].iCsr;
1609       Table *pTab = pSort->aDefer[i].pTab;
1610       int nKey = pSort->aDefer[i].nKey;
1611 
1612       sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1613       if( HasRowid(pTab) ){
1614         sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey);
1615         sqlite3VdbeAddOp3(v, OP_SeekRowid, iCsr,
1616             sqlite3VdbeCurrentAddr(v)+1, regKey);
1617       }else{
1618         int k;
1619         int iJmp;
1620         assert( sqlite3PrimaryKeyIndex(pTab)->nKeyCol==nKey );
1621         for(k=0; k<nKey; k++){
1622           sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iKey++, regKey+k);
1623         }
1624         iJmp = sqlite3VdbeCurrentAddr(v);
1625         sqlite3VdbeAddOp4Int(v, OP_SeekGE, iCsr, iJmp+2, regKey, nKey);
1626         sqlite3VdbeAddOp4Int(v, OP_IdxLE, iCsr, iJmp+3, regKey, nKey);
1627         sqlite3VdbeAddOp1(v, OP_NullRow, iCsr);
1628       }
1629     }
1630     sqlite3ReleaseTempRange(pParse, regKey, nRefKey);
1631   }
1632 #endif
1633   for(i=nColumn-1; i>=0; i--){
1634 #ifdef SQLITE_ENABLE_SORTER_REFERENCES
1635     if( aOutEx[i].bSorterRef ){
1636       sqlite3ExprCode(pParse, aOutEx[i].pExpr, regRow+i);
1637     }else
1638 #endif
1639     {
1640       int iRead;
1641       if( aOutEx[i].u.x.iOrderByCol ){
1642         iRead = aOutEx[i].u.x.iOrderByCol-1;
1643       }else{
1644         iRead = iCol--;
1645       }
1646       sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
1647       VdbeComment((v, "%s", aOutEx[i].zEName));
1648     }
1649   }
1650   switch( eDest ){
1651     case SRT_Table:
1652     case SRT_EphemTab: {
1653       sqlite3VdbeAddOp3(v, OP_Column, iSortTab, nKey+bSeq, regRow);
1654       sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1655       sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1656       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1657       break;
1658     }
1659 #ifndef SQLITE_OMIT_SUBQUERY
1660     case SRT_Set: {
1661       assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1662       sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
1663                         pDest->zAffSdst, nColumn);
1664       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
1665       break;
1666     }
1667     case SRT_Mem: {
1668       /* The LIMIT clause will terminate the loop for us */
1669       break;
1670     }
1671 #endif
1672     case SRT_Upfrom: {
1673       int i2 = pDest->iSDParm2;
1674       int r1 = sqlite3GetTempReg(pParse);
1675       sqlite3VdbeAddOp3(v, OP_MakeRecord,regRow+(i2<0),nColumn-(i2<0),r1);
1676       if( i2<0 ){
1677         sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, regRow);
1678       }else{
1679         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regRow, i2);
1680       }
1681       break;
1682     }
1683     default: {
1684       assert( eDest==SRT_Output || eDest==SRT_Coroutine );
1685       testcase( eDest==SRT_Output );
1686       testcase( eDest==SRT_Coroutine );
1687       if( eDest==SRT_Output ){
1688         sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
1689       }else{
1690         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
1691       }
1692       break;
1693     }
1694   }
1695   if( regRowid ){
1696     if( eDest==SRT_Set ){
1697       sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1698     }else{
1699       sqlite3ReleaseTempReg(pParse, regRow);
1700     }
1701     sqlite3ReleaseTempReg(pParse, regRowid);
1702   }
1703   /* The bottom of the loop
1704   */
1705   sqlite3VdbeResolveLabel(v, addrContinue);
1706   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1707     sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
1708   }else{
1709     sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
1710   }
1711   if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
1712   sqlite3VdbeResolveLabel(v, addrBreak);
1713 }
1714 
1715 /*
1716 ** Return a pointer to a string containing the 'declaration type' of the
1717 ** expression pExpr. The string may be treated as static by the caller.
1718 **
1719 ** Also try to estimate the size of the returned value and return that
1720 ** result in *pEstWidth.
1721 **
1722 ** The declaration type is the exact datatype definition extracted from the
1723 ** original CREATE TABLE statement if the expression is a column. The
1724 ** declaration type for a ROWID field is INTEGER. Exactly when an expression
1725 ** is considered a column can be complex in the presence of subqueries. The
1726 ** result-set expression in all of the following SELECT statements is
1727 ** considered a column by this function.
1728 **
1729 **   SELECT col FROM tbl;
1730 **   SELECT (SELECT col FROM tbl;
1731 **   SELECT (SELECT col FROM tbl);
1732 **   SELECT abc FROM (SELECT col AS abc FROM tbl);
1733 **
1734 ** The declaration type for any expression other than a column is NULL.
1735 **
1736 ** This routine has either 3 or 6 parameters depending on whether or not
1737 ** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
1738 */
1739 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1740 # define columnType(A,B,C,D,E) columnTypeImpl(A,B,C,D,E)
1741 #else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
1742 # define columnType(A,B,C,D,E) columnTypeImpl(A,B)
1743 #endif
1744 static const char *columnTypeImpl(
1745   NameContext *pNC,
1746 #ifndef SQLITE_ENABLE_COLUMN_METADATA
1747   Expr *pExpr
1748 #else
1749   Expr *pExpr,
1750   const char **pzOrigDb,
1751   const char **pzOrigTab,
1752   const char **pzOrigCol
1753 #endif
1754 ){
1755   char const *zType = 0;
1756   int j;
1757 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1758   char const *zOrigDb = 0;
1759   char const *zOrigTab = 0;
1760   char const *zOrigCol = 0;
1761 #endif
1762 
1763   assert( pExpr!=0 );
1764   assert( pNC->pSrcList!=0 );
1765   switch( pExpr->op ){
1766     case TK_COLUMN: {
1767       /* The expression is a column. Locate the table the column is being
1768       ** extracted from in NameContext.pSrcList. This table may be real
1769       ** database table or a subquery.
1770       */
1771       Table *pTab = 0;            /* Table structure column is extracted from */
1772       Select *pS = 0;             /* Select the column is extracted from */
1773       int iCol = pExpr->iColumn;  /* Index of column in pTab */
1774       while( pNC && !pTab ){
1775         SrcList *pTabList = pNC->pSrcList;
1776         for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1777         if( j<pTabList->nSrc ){
1778           pTab = pTabList->a[j].pTab;
1779           pS = pTabList->a[j].pSelect;
1780         }else{
1781           pNC = pNC->pNext;
1782         }
1783       }
1784 
1785       if( pTab==0 ){
1786         /* At one time, code such as "SELECT new.x" within a trigger would
1787         ** cause this condition to run.  Since then, we have restructured how
1788         ** trigger code is generated and so this condition is no longer
1789         ** possible. However, it can still be true for statements like
1790         ** the following:
1791         **
1792         **   CREATE TABLE t1(col INTEGER);
1793         **   SELECT (SELECT t1.col) FROM FROM t1;
1794         **
1795         ** when columnType() is called on the expression "t1.col" in the
1796         ** sub-select. In this case, set the column type to NULL, even
1797         ** though it should really be "INTEGER".
1798         **
1799         ** This is not a problem, as the column type of "t1.col" is never
1800         ** used. When columnType() is called on the expression
1801         ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1802         ** branch below.  */
1803         break;
1804       }
1805 
1806       assert( pTab && pExpr->y.pTab==pTab );
1807       if( pS ){
1808         /* The "table" is actually a sub-select or a view in the FROM clause
1809         ** of the SELECT statement. Return the declaration type and origin
1810         ** data for the result-set column of the sub-select.
1811         */
1812         if( iCol<pS->pEList->nExpr
1813 #ifdef SQLITE_ALLOW_ROWID_IN_VIEW
1814          && iCol>=0
1815 #else
1816          && ALWAYS(iCol>=0)
1817 #endif
1818         ){
1819           /* If iCol is less than zero, then the expression requests the
1820           ** rowid of the sub-select or view. This expression is legal (see
1821           ** test case misc2.2.2) - it always evaluates to NULL.
1822           */
1823           NameContext sNC;
1824           Expr *p = pS->pEList->a[iCol].pExpr;
1825           sNC.pSrcList = pS->pSrc;
1826           sNC.pNext = pNC;
1827           sNC.pParse = pNC->pParse;
1828           zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol);
1829         }
1830       }else{
1831         /* A real table or a CTE table */
1832         assert( !pS );
1833 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1834         if( iCol<0 ) iCol = pTab->iPKey;
1835         assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
1836         if( iCol<0 ){
1837           zType = "INTEGER";
1838           zOrigCol = "rowid";
1839         }else{
1840           zOrigCol = pTab->aCol[iCol].zCnName;
1841           zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
1842         }
1843         zOrigTab = pTab->zName;
1844         if( pNC->pParse && pTab->pSchema ){
1845           int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
1846           zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
1847         }
1848 #else
1849         assert( iCol==XN_ROWID || (iCol>=0 && iCol<pTab->nCol) );
1850         if( iCol<0 ){
1851           zType = "INTEGER";
1852         }else{
1853           zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
1854         }
1855 #endif
1856       }
1857       break;
1858     }
1859 #ifndef SQLITE_OMIT_SUBQUERY
1860     case TK_SELECT: {
1861       /* The expression is a sub-select. Return the declaration type and
1862       ** origin info for the single column in the result set of the SELECT
1863       ** statement.
1864       */
1865       NameContext sNC;
1866       Select *pS = pExpr->x.pSelect;
1867       Expr *p = pS->pEList->a[0].pExpr;
1868       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
1869       sNC.pSrcList = pS->pSrc;
1870       sNC.pNext = pNC;
1871       sNC.pParse = pNC->pParse;
1872       zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
1873       break;
1874     }
1875 #endif
1876   }
1877 
1878 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1879   if( pzOrigDb ){
1880     assert( pzOrigTab && pzOrigCol );
1881     *pzOrigDb = zOrigDb;
1882     *pzOrigTab = zOrigTab;
1883     *pzOrigCol = zOrigCol;
1884   }
1885 #endif
1886   return zType;
1887 }
1888 
1889 /*
1890 ** Generate code that will tell the VDBE the declaration types of columns
1891 ** in the result set.
1892 */
1893 static void generateColumnTypes(
1894   Parse *pParse,      /* Parser context */
1895   SrcList *pTabList,  /* List of tables */
1896   ExprList *pEList    /* Expressions defining the result set */
1897 ){
1898 #ifndef SQLITE_OMIT_DECLTYPE
1899   Vdbe *v = pParse->pVdbe;
1900   int i;
1901   NameContext sNC;
1902   sNC.pSrcList = pTabList;
1903   sNC.pParse = pParse;
1904   sNC.pNext = 0;
1905   for(i=0; i<pEList->nExpr; i++){
1906     Expr *p = pEList->a[i].pExpr;
1907     const char *zType;
1908 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1909     const char *zOrigDb = 0;
1910     const char *zOrigTab = 0;
1911     const char *zOrigCol = 0;
1912     zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol);
1913 
1914     /* The vdbe must make its own copy of the column-type and other
1915     ** column specific strings, in case the schema is reset before this
1916     ** virtual machine is deleted.
1917     */
1918     sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
1919     sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
1920     sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
1921 #else
1922     zType = columnType(&sNC, p, 0, 0, 0);
1923 #endif
1924     sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
1925   }
1926 #endif /* !defined(SQLITE_OMIT_DECLTYPE) */
1927 }
1928 
1929 
1930 /*
1931 ** Compute the column names for a SELECT statement.
1932 **
1933 ** The only guarantee that SQLite makes about column names is that if the
1934 ** column has an AS clause assigning it a name, that will be the name used.
1935 ** That is the only documented guarantee.  However, countless applications
1936 ** developed over the years have made baseless assumptions about column names
1937 ** and will break if those assumptions changes.  Hence, use extreme caution
1938 ** when modifying this routine to avoid breaking legacy.
1939 **
1940 ** See Also: sqlite3ColumnsFromExprList()
1941 **
1942 ** The PRAGMA short_column_names and PRAGMA full_column_names settings are
1943 ** deprecated.  The default setting is short=ON, full=OFF.  99.9% of all
1944 ** applications should operate this way.  Nevertheless, we need to support the
1945 ** other modes for legacy:
1946 **
1947 **    short=OFF, full=OFF:      Column name is the text of the expression has it
1948 **                              originally appears in the SELECT statement.  In
1949 **                              other words, the zSpan of the result expression.
1950 **
1951 **    short=ON, full=OFF:       (This is the default setting).  If the result
1952 **                              refers directly to a table column, then the
1953 **                              result column name is just the table column
1954 **                              name: COLUMN.  Otherwise use zSpan.
1955 **
1956 **    full=ON, short=ANY:       If the result refers directly to a table column,
1957 **                              then the result column name with the table name
1958 **                              prefix, ex: TABLE.COLUMN.  Otherwise use zSpan.
1959 */
1960 void sqlite3GenerateColumnNames(
1961   Parse *pParse,      /* Parser context */
1962   Select *pSelect     /* Generate column names for this SELECT statement */
1963 ){
1964   Vdbe *v = pParse->pVdbe;
1965   int i;
1966   Table *pTab;
1967   SrcList *pTabList;
1968   ExprList *pEList;
1969   sqlite3 *db = pParse->db;
1970   int fullName;    /* TABLE.COLUMN if no AS clause and is a direct table ref */
1971   int srcName;     /* COLUMN or TABLE.COLUMN if no AS clause and is direct */
1972 
1973 #ifndef SQLITE_OMIT_EXPLAIN
1974   /* If this is an EXPLAIN, skip this step */
1975   if( pParse->explain ){
1976     return;
1977   }
1978 #endif
1979 
1980   if( pParse->colNamesSet ) return;
1981   /* Column names are determined by the left-most term of a compound select */
1982   while( pSelect->pPrior ) pSelect = pSelect->pPrior;
1983   SELECTTRACE(1,pParse,pSelect,("generating column names\n"));
1984   pTabList = pSelect->pSrc;
1985   pEList = pSelect->pEList;
1986   assert( v!=0 );
1987   assert( pTabList!=0 );
1988   pParse->colNamesSet = 1;
1989   fullName = (db->flags & SQLITE_FullColNames)!=0;
1990   srcName = (db->flags & SQLITE_ShortColNames)!=0 || fullName;
1991   sqlite3VdbeSetNumCols(v, pEList->nExpr);
1992   for(i=0; i<pEList->nExpr; i++){
1993     Expr *p = pEList->a[i].pExpr;
1994 
1995     assert( p!=0 );
1996     assert( p->op!=TK_AGG_COLUMN );  /* Agg processing has not run yet */
1997     assert( p->op!=TK_COLUMN || p->y.pTab!=0 ); /* Covering idx not yet coded */
1998     if( pEList->a[i].zEName && pEList->a[i].eEName==ENAME_NAME ){
1999       /* An AS clause always takes first priority */
2000       char *zName = pEList->a[i].zEName;
2001       sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
2002     }else if( srcName && p->op==TK_COLUMN ){
2003       char *zCol;
2004       int iCol = p->iColumn;
2005       pTab = p->y.pTab;
2006       assert( pTab!=0 );
2007       if( iCol<0 ) iCol = pTab->iPKey;
2008       assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
2009       if( iCol<0 ){
2010         zCol = "rowid";
2011       }else{
2012         zCol = pTab->aCol[iCol].zCnName;
2013       }
2014       if( fullName ){
2015         char *zName = 0;
2016         zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
2017         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
2018       }else{
2019         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
2020       }
2021     }else{
2022       const char *z = pEList->a[i].zEName;
2023       z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
2024       sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
2025     }
2026   }
2027   generateColumnTypes(pParse, pTabList, pEList);
2028 }
2029 
2030 /*
2031 ** Given an expression list (which is really the list of expressions
2032 ** that form the result set of a SELECT statement) compute appropriate
2033 ** column names for a table that would hold the expression list.
2034 **
2035 ** All column names will be unique.
2036 **
2037 ** Only the column names are computed.  Column.zType, Column.zColl,
2038 ** and other fields of Column are zeroed.
2039 **
2040 ** Return SQLITE_OK on success.  If a memory allocation error occurs,
2041 ** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
2042 **
2043 ** The only guarantee that SQLite makes about column names is that if the
2044 ** column has an AS clause assigning it a name, that will be the name used.
2045 ** That is the only documented guarantee.  However, countless applications
2046 ** developed over the years have made baseless assumptions about column names
2047 ** and will break if those assumptions changes.  Hence, use extreme caution
2048 ** when modifying this routine to avoid breaking legacy.
2049 **
2050 ** See Also: sqlite3GenerateColumnNames()
2051 */
2052 int sqlite3ColumnsFromExprList(
2053   Parse *pParse,          /* Parsing context */
2054   ExprList *pEList,       /* Expr list from which to derive column names */
2055   i16 *pnCol,             /* Write the number of columns here */
2056   Column **paCol          /* Write the new column list here */
2057 ){
2058   sqlite3 *db = pParse->db;   /* Database connection */
2059   int i, j;                   /* Loop counters */
2060   u32 cnt;                    /* Index added to make the name unique */
2061   Column *aCol, *pCol;        /* For looping over result columns */
2062   int nCol;                   /* Number of columns in the result set */
2063   char *zName;                /* Column name */
2064   int nName;                  /* Size of name in zName[] */
2065   Hash ht;                    /* Hash table of column names */
2066   Table *pTab;
2067 
2068   sqlite3HashInit(&ht);
2069   if( pEList ){
2070     nCol = pEList->nExpr;
2071     aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
2072     testcase( aCol==0 );
2073     if( NEVER(nCol>32767) ) nCol = 32767;
2074   }else{
2075     nCol = 0;
2076     aCol = 0;
2077   }
2078   assert( nCol==(i16)nCol );
2079   *pnCol = nCol;
2080   *paCol = aCol;
2081 
2082   for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
2083     /* Get an appropriate name for the column
2084     */
2085     if( (zName = pEList->a[i].zEName)!=0 && pEList->a[i].eEName==ENAME_NAME ){
2086       /* If the column contains an "AS <name>" phrase, use <name> as the name */
2087     }else{
2088       Expr *pColExpr = sqlite3ExprSkipCollateAndLikely(pEList->a[i].pExpr);
2089       while( ALWAYS(pColExpr!=0) && pColExpr->op==TK_DOT ){
2090         pColExpr = pColExpr->pRight;
2091         assert( pColExpr!=0 );
2092       }
2093       if( pColExpr->op==TK_COLUMN && (pTab = pColExpr->y.pTab)!=0 ){
2094         /* For columns use the column name name */
2095         int iCol = pColExpr->iColumn;
2096         if( iCol<0 ) iCol = pTab->iPKey;
2097         zName = iCol>=0 ? pTab->aCol[iCol].zCnName : "rowid";
2098       }else if( pColExpr->op==TK_ID ){
2099         assert( !ExprHasProperty(pColExpr, EP_IntValue) );
2100         zName = pColExpr->u.zToken;
2101       }else{
2102         /* Use the original text of the column expression as its name */
2103         zName = pEList->a[i].zEName;
2104       }
2105     }
2106     if( zName && !sqlite3IsTrueOrFalse(zName) ){
2107       zName = sqlite3DbStrDup(db, zName);
2108     }else{
2109       zName = sqlite3MPrintf(db,"column%d",i+1);
2110     }
2111 
2112     /* Make sure the column name is unique.  If the name is not unique,
2113     ** append an integer to the name so that it becomes unique.
2114     */
2115     cnt = 0;
2116     while( zName && sqlite3HashFind(&ht, zName)!=0 ){
2117       nName = sqlite3Strlen30(zName);
2118       if( nName>0 ){
2119         for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
2120         if( zName[j]==':' ) nName = j;
2121       }
2122       zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
2123       if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
2124     }
2125     pCol->zCnName = zName;
2126     pCol->hName = sqlite3StrIHash(zName);
2127     sqlite3ColumnPropertiesFromName(0, pCol);
2128     if( zName && sqlite3HashInsert(&ht, zName, pCol)==pCol ){
2129       sqlite3OomFault(db);
2130     }
2131   }
2132   sqlite3HashClear(&ht);
2133   if( db->mallocFailed ){
2134     for(j=0; j<i; j++){
2135       sqlite3DbFree(db, aCol[j].zCnName);
2136     }
2137     sqlite3DbFree(db, aCol);
2138     *paCol = 0;
2139     *pnCol = 0;
2140     return SQLITE_NOMEM_BKPT;
2141   }
2142   return SQLITE_OK;
2143 }
2144 
2145 /*
2146 ** Add type and collation information to a column list based on
2147 ** a SELECT statement.
2148 **
2149 ** The column list presumably came from selectColumnNamesFromExprList().
2150 ** The column list has only names, not types or collations.  This
2151 ** routine goes through and adds the types and collations.
2152 **
2153 ** This routine requires that all identifiers in the SELECT
2154 ** statement be resolved.
2155 */
2156 void sqlite3SelectAddColumnTypeAndCollation(
2157   Parse *pParse,        /* Parsing contexts */
2158   Table *pTab,          /* Add column type information to this table */
2159   Select *pSelect,      /* SELECT used to determine types and collations */
2160   char aff              /* Default affinity for columns */
2161 ){
2162   sqlite3 *db = pParse->db;
2163   NameContext sNC;
2164   Column *pCol;
2165   CollSeq *pColl;
2166   int i;
2167   Expr *p;
2168   struct ExprList_item *a;
2169 
2170   assert( pSelect!=0 );
2171   assert( (pSelect->selFlags & SF_Resolved)!=0 );
2172   assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
2173   if( db->mallocFailed ) return;
2174   memset(&sNC, 0, sizeof(sNC));
2175   sNC.pSrcList = pSelect->pSrc;
2176   a = pSelect->pEList->a;
2177   for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
2178     const char *zType;
2179     int n, m;
2180     pTab->tabFlags |= (pCol->colFlags & COLFLAG_NOINSERT);
2181     p = a[i].pExpr;
2182     zType = columnType(&sNC, p, 0, 0, 0);
2183     /* pCol->szEst = ... // Column size est for SELECT tables never used */
2184     pCol->affinity = sqlite3ExprAffinity(p);
2185     if( zType ){
2186       m = sqlite3Strlen30(zType);
2187       n = sqlite3Strlen30(pCol->zCnName);
2188       pCol->zCnName = sqlite3DbReallocOrFree(db, pCol->zCnName, n+m+2);
2189       if( pCol->zCnName ){
2190         memcpy(&pCol->zCnName[n+1], zType, m+1);
2191         pCol->colFlags |= COLFLAG_HASTYPE;
2192       }
2193     }
2194     if( pCol->affinity<=SQLITE_AFF_NONE ) pCol->affinity = aff;
2195     pColl = sqlite3ExprCollSeq(pParse, p);
2196     if( pColl && (pCol->colFlags & COLFLAG_HASCOLL)==0 ){
2197       assert( pTab->pIndex==0 );
2198       sqlite3ColumnSetColl(db, pCol, pColl->zName);
2199     }
2200   }
2201   pTab->szTabRow = 1; /* Any non-zero value works */
2202 }
2203 
2204 /*
2205 ** Given a SELECT statement, generate a Table structure that describes
2206 ** the result set of that SELECT.
2207 */
2208 Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect, char aff){
2209   Table *pTab;
2210   sqlite3 *db = pParse->db;
2211   u64 savedFlags;
2212 
2213   savedFlags = db->flags;
2214   db->flags &= ~(u64)SQLITE_FullColNames;
2215   db->flags |= SQLITE_ShortColNames;
2216   sqlite3SelectPrep(pParse, pSelect, 0);
2217   db->flags = savedFlags;
2218   if( pParse->nErr ) return 0;
2219   while( pSelect->pPrior ) pSelect = pSelect->pPrior;
2220   pTab = sqlite3DbMallocZero(db, sizeof(Table) );
2221   if( pTab==0 ){
2222     return 0;
2223   }
2224   pTab->nTabRef = 1;
2225   pTab->zName = 0;
2226   pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
2227   sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
2228   sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect, aff);
2229   pTab->iPKey = -1;
2230   if( db->mallocFailed ){
2231     sqlite3DeleteTable(db, pTab);
2232     return 0;
2233   }
2234   return pTab;
2235 }
2236 
2237 /*
2238 ** Get a VDBE for the given parser context.  Create a new one if necessary.
2239 ** If an error occurs, return NULL and leave a message in pParse.
2240 */
2241 Vdbe *sqlite3GetVdbe(Parse *pParse){
2242   if( pParse->pVdbe ){
2243     return pParse->pVdbe;
2244   }
2245   if( pParse->pToplevel==0
2246    && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
2247   ){
2248     pParse->okConstFactor = 1;
2249   }
2250   return sqlite3VdbeCreate(pParse);
2251 }
2252 
2253 
2254 /*
2255 ** Compute the iLimit and iOffset fields of the SELECT based on the
2256 ** pLimit expressions.  pLimit->pLeft and pLimit->pRight hold the expressions
2257 ** that appear in the original SQL statement after the LIMIT and OFFSET
2258 ** keywords.  Or NULL if those keywords are omitted. iLimit and iOffset
2259 ** are the integer memory register numbers for counters used to compute
2260 ** the limit and offset.  If there is no limit and/or offset, then
2261 ** iLimit and iOffset are negative.
2262 **
2263 ** This routine changes the values of iLimit and iOffset only if
2264 ** a limit or offset is defined by pLimit->pLeft and pLimit->pRight.  iLimit
2265 ** and iOffset should have been preset to appropriate default values (zero)
2266 ** prior to calling this routine.
2267 **
2268 ** The iOffset register (if it exists) is initialized to the value
2269 ** of the OFFSET.  The iLimit register is initialized to LIMIT.  Register
2270 ** iOffset+1 is initialized to LIMIT+OFFSET.
2271 **
2272 ** Only if pLimit->pLeft!=0 do the limit registers get
2273 ** redefined.  The UNION ALL operator uses this property to force
2274 ** the reuse of the same limit and offset registers across multiple
2275 ** SELECT statements.
2276 */
2277 static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
2278   Vdbe *v = 0;
2279   int iLimit = 0;
2280   int iOffset;
2281   int n;
2282   Expr *pLimit = p->pLimit;
2283 
2284   if( p->iLimit ) return;
2285 
2286   /*
2287   ** "LIMIT -1" always shows all rows.  There is some
2288   ** controversy about what the correct behavior should be.
2289   ** The current implementation interprets "LIMIT 0" to mean
2290   ** no rows.
2291   */
2292   if( pLimit ){
2293     assert( pLimit->op==TK_LIMIT );
2294     assert( pLimit->pLeft!=0 );
2295     p->iLimit = iLimit = ++pParse->nMem;
2296     v = sqlite3GetVdbe(pParse);
2297     assert( v!=0 );
2298     if( sqlite3ExprIsInteger(pLimit->pLeft, &n) ){
2299       sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
2300       VdbeComment((v, "LIMIT counter"));
2301       if( n==0 ){
2302         sqlite3VdbeGoto(v, iBreak);
2303       }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
2304         p->nSelectRow = sqlite3LogEst((u64)n);
2305         p->selFlags |= SF_FixedLimit;
2306       }
2307     }else{
2308       sqlite3ExprCode(pParse, pLimit->pLeft, iLimit);
2309       sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
2310       VdbeComment((v, "LIMIT counter"));
2311       sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
2312     }
2313     if( pLimit->pRight ){
2314       p->iOffset = iOffset = ++pParse->nMem;
2315       pParse->nMem++;   /* Allocate an extra register for limit+offset */
2316       sqlite3ExprCode(pParse, pLimit->pRight, iOffset);
2317       sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
2318       VdbeComment((v, "OFFSET counter"));
2319       sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
2320       VdbeComment((v, "LIMIT+OFFSET"));
2321     }
2322   }
2323 }
2324 
2325 #ifndef SQLITE_OMIT_COMPOUND_SELECT
2326 /*
2327 ** Return the appropriate collating sequence for the iCol-th column of
2328 ** the result set for the compound-select statement "p".  Return NULL if
2329 ** the column has no default collating sequence.
2330 **
2331 ** The collating sequence for the compound select is taken from the
2332 ** left-most term of the select that has a collating sequence.
2333 */
2334 static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
2335   CollSeq *pRet;
2336   if( p->pPrior ){
2337     pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
2338   }else{
2339     pRet = 0;
2340   }
2341   assert( iCol>=0 );
2342   /* iCol must be less than p->pEList->nExpr.  Otherwise an error would
2343   ** have been thrown during name resolution and we would not have gotten
2344   ** this far */
2345   if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
2346     pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
2347   }
2348   return pRet;
2349 }
2350 
2351 /*
2352 ** The select statement passed as the second parameter is a compound SELECT
2353 ** with an ORDER BY clause. This function allocates and returns a KeyInfo
2354 ** structure suitable for implementing the ORDER BY.
2355 **
2356 ** Space to hold the KeyInfo structure is obtained from malloc. The calling
2357 ** function is responsible for ensuring that this structure is eventually
2358 ** freed.
2359 */
2360 static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
2361   ExprList *pOrderBy = p->pOrderBy;
2362   int nOrderBy = p->pOrderBy->nExpr;
2363   sqlite3 *db = pParse->db;
2364   KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
2365   if( pRet ){
2366     int i;
2367     for(i=0; i<nOrderBy; i++){
2368       struct ExprList_item *pItem = &pOrderBy->a[i];
2369       Expr *pTerm = pItem->pExpr;
2370       CollSeq *pColl;
2371 
2372       if( pTerm->flags & EP_Collate ){
2373         pColl = sqlite3ExprCollSeq(pParse, pTerm);
2374       }else{
2375         pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
2376         if( pColl==0 ) pColl = db->pDfltColl;
2377         pOrderBy->a[i].pExpr =
2378           sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
2379       }
2380       assert( sqlite3KeyInfoIsWriteable(pRet) );
2381       pRet->aColl[i] = pColl;
2382       pRet->aSortFlags[i] = pOrderBy->a[i].sortFlags;
2383     }
2384   }
2385 
2386   return pRet;
2387 }
2388 
2389 #ifndef SQLITE_OMIT_CTE
2390 /*
2391 ** This routine generates VDBE code to compute the content of a WITH RECURSIVE
2392 ** query of the form:
2393 **
2394 **   <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
2395 **                         \___________/             \_______________/
2396 **                           p->pPrior                      p
2397 **
2398 **
2399 ** There is exactly one reference to the recursive-table in the FROM clause
2400 ** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
2401 **
2402 ** The setup-query runs once to generate an initial set of rows that go
2403 ** into a Queue table.  Rows are extracted from the Queue table one by
2404 ** one.  Each row extracted from Queue is output to pDest.  Then the single
2405 ** extracted row (now in the iCurrent table) becomes the content of the
2406 ** recursive-table for a recursive-query run.  The output of the recursive-query
2407 ** is added back into the Queue table.  Then another row is extracted from Queue
2408 ** and the iteration continues until the Queue table is empty.
2409 **
2410 ** If the compound query operator is UNION then no duplicate rows are ever
2411 ** inserted into the Queue table.  The iDistinct table keeps a copy of all rows
2412 ** that have ever been inserted into Queue and causes duplicates to be
2413 ** discarded.  If the operator is UNION ALL, then duplicates are allowed.
2414 **
2415 ** If the query has an ORDER BY, then entries in the Queue table are kept in
2416 ** ORDER BY order and the first entry is extracted for each cycle.  Without
2417 ** an ORDER BY, the Queue table is just a FIFO.
2418 **
2419 ** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2420 ** have been output to pDest.  A LIMIT of zero means to output no rows and a
2421 ** negative LIMIT means to output all rows.  If there is also an OFFSET clause
2422 ** with a positive value, then the first OFFSET outputs are discarded rather
2423 ** than being sent to pDest.  The LIMIT count does not begin until after OFFSET
2424 ** rows have been skipped.
2425 */
2426 static void generateWithRecursiveQuery(
2427   Parse *pParse,        /* Parsing context */
2428   Select *p,            /* The recursive SELECT to be coded */
2429   SelectDest *pDest     /* What to do with query results */
2430 ){
2431   SrcList *pSrc = p->pSrc;      /* The FROM clause of the recursive query */
2432   int nCol = p->pEList->nExpr;  /* Number of columns in the recursive table */
2433   Vdbe *v = pParse->pVdbe;      /* The prepared statement under construction */
2434   Select *pSetup = p->pPrior;   /* The setup query */
2435   Select *pFirstRec;            /* Left-most recursive term */
2436   int addrTop;                  /* Top of the loop */
2437   int addrCont, addrBreak;      /* CONTINUE and BREAK addresses */
2438   int iCurrent = 0;             /* The Current table */
2439   int regCurrent;               /* Register holding Current table */
2440   int iQueue;                   /* The Queue table */
2441   int iDistinct = 0;            /* To ensure unique results if UNION */
2442   int eDest = SRT_Fifo;         /* How to write to Queue */
2443   SelectDest destQueue;         /* SelectDest targetting the Queue table */
2444   int i;                        /* Loop counter */
2445   int rc;                       /* Result code */
2446   ExprList *pOrderBy;           /* The ORDER BY clause */
2447   Expr *pLimit;                 /* Saved LIMIT and OFFSET */
2448   int regLimit, regOffset;      /* Registers used by LIMIT and OFFSET */
2449 
2450 #ifndef SQLITE_OMIT_WINDOWFUNC
2451   if( p->pWin ){
2452     sqlite3ErrorMsg(pParse, "cannot use window functions in recursive queries");
2453     return;
2454   }
2455 #endif
2456 
2457   /* Obtain authorization to do a recursive query */
2458   if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
2459 
2460   /* Process the LIMIT and OFFSET clauses, if they exist */
2461   addrBreak = sqlite3VdbeMakeLabel(pParse);
2462   p->nSelectRow = 320;  /* 4 billion rows */
2463   computeLimitRegisters(pParse, p, addrBreak);
2464   pLimit = p->pLimit;
2465   regLimit = p->iLimit;
2466   regOffset = p->iOffset;
2467   p->pLimit = 0;
2468   p->iLimit = p->iOffset = 0;
2469   pOrderBy = p->pOrderBy;
2470 
2471   /* Locate the cursor number of the Current table */
2472   for(i=0; ALWAYS(i<pSrc->nSrc); i++){
2473     if( pSrc->a[i].fg.isRecursive ){
2474       iCurrent = pSrc->a[i].iCursor;
2475       break;
2476     }
2477   }
2478 
2479   /* Allocate cursors numbers for Queue and Distinct.  The cursor number for
2480   ** the Distinct table must be exactly one greater than Queue in order
2481   ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
2482   iQueue = pParse->nTab++;
2483   if( p->op==TK_UNION ){
2484     eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
2485     iDistinct = pParse->nTab++;
2486   }else{
2487     eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
2488   }
2489   sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2490 
2491   /* Allocate cursors for Current, Queue, and Distinct. */
2492   regCurrent = ++pParse->nMem;
2493   sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
2494   if( pOrderBy ){
2495     KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
2496     sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2497                       (char*)pKeyInfo, P4_KEYINFO);
2498     destQueue.pOrderBy = pOrderBy;
2499   }else{
2500     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2501   }
2502   VdbeComment((v, "Queue table"));
2503   if( iDistinct ){
2504     p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2505     p->selFlags |= SF_UsesEphemeral;
2506   }
2507 
2508   /* Detach the ORDER BY clause from the compound SELECT */
2509   p->pOrderBy = 0;
2510 
2511   /* Figure out how many elements of the compound SELECT are part of the
2512   ** recursive query.  Make sure no recursive elements use aggregate
2513   ** functions.  Mark the recursive elements as UNION ALL even if they
2514   ** are really UNION because the distinctness will be enforced by the
2515   ** iDistinct table.  pFirstRec is left pointing to the left-most
2516   ** recursive term of the CTE.
2517   */
2518   pFirstRec = p;
2519   for(pFirstRec=p; ALWAYS(pFirstRec!=0); pFirstRec=pFirstRec->pPrior){
2520     if( pFirstRec->selFlags & SF_Aggregate ){
2521       sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2522       goto end_of_recursive_query;
2523     }
2524     pFirstRec->op = TK_ALL;
2525     if( (pFirstRec->pPrior->selFlags & SF_Recursive)==0 ) break;
2526   }
2527 
2528   /* Store the results of the setup-query in Queue. */
2529   pSetup = pFirstRec->pPrior;
2530   pSetup->pNext = 0;
2531   ExplainQueryPlan((pParse, 1, "SETUP"));
2532   rc = sqlite3Select(pParse, pSetup, &destQueue);
2533   pSetup->pNext = p;
2534   if( rc ) goto end_of_recursive_query;
2535 
2536   /* Find the next row in the Queue and output that row */
2537   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
2538 
2539   /* Transfer the next row in Queue over to Current */
2540   sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
2541   if( pOrderBy ){
2542     sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2543   }else{
2544     sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2545   }
2546   sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2547 
2548   /* Output the single row in Current */
2549   addrCont = sqlite3VdbeMakeLabel(pParse);
2550   codeOffset(v, regOffset, addrCont);
2551   selectInnerLoop(pParse, p, iCurrent,
2552       0, 0, pDest, addrCont, addrBreak);
2553   if( regLimit ){
2554     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
2555     VdbeCoverage(v);
2556   }
2557   sqlite3VdbeResolveLabel(v, addrCont);
2558 
2559   /* Execute the recursive SELECT taking the single row in Current as
2560   ** the value for the recursive-table. Store the results in the Queue.
2561   */
2562   pFirstRec->pPrior = 0;
2563   ExplainQueryPlan((pParse, 1, "RECURSIVE STEP"));
2564   sqlite3Select(pParse, p, &destQueue);
2565   assert( pFirstRec->pPrior==0 );
2566   pFirstRec->pPrior = pSetup;
2567 
2568   /* Keep running the loop until the Queue is empty */
2569   sqlite3VdbeGoto(v, addrTop);
2570   sqlite3VdbeResolveLabel(v, addrBreak);
2571 
2572 end_of_recursive_query:
2573   sqlite3ExprListDelete(pParse->db, p->pOrderBy);
2574   p->pOrderBy = pOrderBy;
2575   p->pLimit = pLimit;
2576   return;
2577 }
2578 #endif /* SQLITE_OMIT_CTE */
2579 
2580 /* Forward references */
2581 static int multiSelectOrderBy(
2582   Parse *pParse,        /* Parsing context */
2583   Select *p,            /* The right-most of SELECTs to be coded */
2584   SelectDest *pDest     /* What to do with query results */
2585 );
2586 
2587 /*
2588 ** Handle the special case of a compound-select that originates from a
2589 ** VALUES clause.  By handling this as a special case, we avoid deep
2590 ** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2591 ** on a VALUES clause.
2592 **
2593 ** Because the Select object originates from a VALUES clause:
2594 **   (1) There is no LIMIT or OFFSET or else there is a LIMIT of exactly 1
2595 **   (2) All terms are UNION ALL
2596 **   (3) There is no ORDER BY clause
2597 **
2598 ** The "LIMIT of exactly 1" case of condition (1) comes about when a VALUES
2599 ** clause occurs within scalar expression (ex: "SELECT (VALUES(1),(2),(3))").
2600 ** The sqlite3CodeSubselect will have added the LIMIT 1 clause in tht case.
2601 ** Since the limit is exactly 1, we only need to evalutes the left-most VALUES.
2602 */
2603 static int multiSelectValues(
2604   Parse *pParse,        /* Parsing context */
2605   Select *p,            /* The right-most of SELECTs to be coded */
2606   SelectDest *pDest     /* What to do with query results */
2607 ){
2608   int nRow = 1;
2609   int rc = 0;
2610   int bShowAll = p->pLimit==0;
2611   assert( p->selFlags & SF_MultiValue );
2612   do{
2613     assert( p->selFlags & SF_Values );
2614     assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
2615     assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
2616 #ifndef SQLITE_OMIT_WINDOWFUNC
2617     if( p->pWin ) return -1;
2618 #endif
2619     if( p->pPrior==0 ) break;
2620     assert( p->pPrior->pNext==p );
2621     p = p->pPrior;
2622     nRow += bShowAll;
2623   }while(1);
2624   ExplainQueryPlan((pParse, 0, "SCAN %d CONSTANT ROW%s", nRow,
2625                     nRow==1 ? "" : "S"));
2626   while( p ){
2627     selectInnerLoop(pParse, p, -1, 0, 0, pDest, 1, 1);
2628     if( !bShowAll ) break;
2629     p->nSelectRow = nRow;
2630     p = p->pNext;
2631   }
2632   return rc;
2633 }
2634 
2635 /*
2636 ** Return true if the SELECT statement which is known to be the recursive
2637 ** part of a recursive CTE still has its anchor terms attached.  If the
2638 ** anchor terms have already been removed, then return false.
2639 */
2640 static int hasAnchor(Select *p){
2641   while( p && (p->selFlags & SF_Recursive)!=0 ){ p = p->pPrior; }
2642   return p!=0;
2643 }
2644 
2645 /*
2646 ** This routine is called to process a compound query form from
2647 ** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2648 ** INTERSECT
2649 **
2650 ** "p" points to the right-most of the two queries.  the query on the
2651 ** left is p->pPrior.  The left query could also be a compound query
2652 ** in which case this routine will be called recursively.
2653 **
2654 ** The results of the total query are to be written into a destination
2655 ** of type eDest with parameter iParm.
2656 **
2657 ** Example 1:  Consider a three-way compound SQL statement.
2658 **
2659 **     SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2660 **
2661 ** This statement is parsed up as follows:
2662 **
2663 **     SELECT c FROM t3
2664 **      |
2665 **      `----->  SELECT b FROM t2
2666 **                |
2667 **                `------>  SELECT a FROM t1
2668 **
2669 ** The arrows in the diagram above represent the Select.pPrior pointer.
2670 ** So if this routine is called with p equal to the t3 query, then
2671 ** pPrior will be the t2 query.  p->op will be TK_UNION in this case.
2672 **
2673 ** Notice that because of the way SQLite parses compound SELECTs, the
2674 ** individual selects always group from left to right.
2675 */
2676 static int multiSelect(
2677   Parse *pParse,        /* Parsing context */
2678   Select *p,            /* The right-most of SELECTs to be coded */
2679   SelectDest *pDest     /* What to do with query results */
2680 ){
2681   int rc = SQLITE_OK;   /* Success code from a subroutine */
2682   Select *pPrior;       /* Another SELECT immediately to our left */
2683   Vdbe *v;              /* Generate code to this VDBE */
2684   SelectDest dest;      /* Alternative data destination */
2685   Select *pDelete = 0;  /* Chain of simple selects to delete */
2686   sqlite3 *db;          /* Database connection */
2687 
2688   /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs.  Only
2689   ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
2690   */
2691   assert( p && p->pPrior );  /* Calling function guarantees this much */
2692   assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
2693   assert( p->selFlags & SF_Compound );
2694   db = pParse->db;
2695   pPrior = p->pPrior;
2696   dest = *pDest;
2697   assert( pPrior->pOrderBy==0 );
2698   assert( pPrior->pLimit==0 );
2699 
2700   v = sqlite3GetVdbe(pParse);
2701   assert( v!=0 );  /* The VDBE already created by calling function */
2702 
2703   /* Create the destination temporary table if necessary
2704   */
2705   if( dest.eDest==SRT_EphemTab ){
2706     assert( p->pEList );
2707     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
2708     dest.eDest = SRT_Table;
2709   }
2710 
2711   /* Special handling for a compound-select that originates as a VALUES clause.
2712   */
2713   if( p->selFlags & SF_MultiValue ){
2714     rc = multiSelectValues(pParse, p, &dest);
2715     if( rc>=0 ) goto multi_select_end;
2716     rc = SQLITE_OK;
2717   }
2718 
2719   /* Make sure all SELECTs in the statement have the same number of elements
2720   ** in their result sets.
2721   */
2722   assert( p->pEList && pPrior->pEList );
2723   assert( p->pEList->nExpr==pPrior->pEList->nExpr );
2724 
2725 #ifndef SQLITE_OMIT_CTE
2726   if( (p->selFlags & SF_Recursive)!=0 && hasAnchor(p) ){
2727     generateWithRecursiveQuery(pParse, p, &dest);
2728   }else
2729 #endif
2730 
2731   /* Compound SELECTs that have an ORDER BY clause are handled separately.
2732   */
2733   if( p->pOrderBy ){
2734     return multiSelectOrderBy(pParse, p, pDest);
2735   }else{
2736 
2737 #ifndef SQLITE_OMIT_EXPLAIN
2738     if( pPrior->pPrior==0 ){
2739       ExplainQueryPlan((pParse, 1, "COMPOUND QUERY"));
2740       ExplainQueryPlan((pParse, 1, "LEFT-MOST SUBQUERY"));
2741     }
2742 #endif
2743 
2744     /* Generate code for the left and right SELECT statements.
2745     */
2746     switch( p->op ){
2747       case TK_ALL: {
2748         int addr = 0;
2749         int nLimit = 0;  /* Initialize to suppress harmless compiler warning */
2750         assert( !pPrior->pLimit );
2751         pPrior->iLimit = p->iLimit;
2752         pPrior->iOffset = p->iOffset;
2753         pPrior->pLimit = p->pLimit;
2754         SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL left...\n"));
2755         rc = sqlite3Select(pParse, pPrior, &dest);
2756         pPrior->pLimit = 0;
2757         if( rc ){
2758           goto multi_select_end;
2759         }
2760         p->pPrior = 0;
2761         p->iLimit = pPrior->iLimit;
2762         p->iOffset = pPrior->iOffset;
2763         if( p->iLimit ){
2764           addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2765           VdbeComment((v, "Jump ahead if LIMIT reached"));
2766           if( p->iOffset ){
2767             sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2768                               p->iLimit, p->iOffset+1, p->iOffset);
2769           }
2770         }
2771         ExplainQueryPlan((pParse, 1, "UNION ALL"));
2772         SELECTTRACE(1, pParse, p, ("multiSelect UNION ALL right...\n"));
2773         rc = sqlite3Select(pParse, p, &dest);
2774         testcase( rc!=SQLITE_OK );
2775         pDelete = p->pPrior;
2776         p->pPrior = pPrior;
2777         p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2778         if( p->pLimit
2779          && sqlite3ExprIsInteger(p->pLimit->pLeft, &nLimit)
2780          && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2781         ){
2782           p->nSelectRow = sqlite3LogEst((u64)nLimit);
2783         }
2784         if( addr ){
2785           sqlite3VdbeJumpHere(v, addr);
2786         }
2787         break;
2788       }
2789       case TK_EXCEPT:
2790       case TK_UNION: {
2791         int unionTab;    /* Cursor number of the temp table holding result */
2792         u8 op = 0;       /* One of the SRT_ operations to apply to self */
2793         int priorOp;     /* The SRT_ operation to apply to prior selects */
2794         Expr *pLimit;    /* Saved values of p->nLimit  */
2795         int addr;
2796         SelectDest uniondest;
2797 
2798         testcase( p->op==TK_EXCEPT );
2799         testcase( p->op==TK_UNION );
2800         priorOp = SRT_Union;
2801         if( dest.eDest==priorOp ){
2802           /* We can reuse a temporary table generated by a SELECT to our
2803           ** right.
2804           */
2805           assert( p->pLimit==0 );      /* Not allowed on leftward elements */
2806           unionTab = dest.iSDParm;
2807         }else{
2808           /* We will need to create our own temporary table to hold the
2809           ** intermediate results.
2810           */
2811           unionTab = pParse->nTab++;
2812           assert( p->pOrderBy==0 );
2813           addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2814           assert( p->addrOpenEphm[0] == -1 );
2815           p->addrOpenEphm[0] = addr;
2816           findRightmost(p)->selFlags |= SF_UsesEphemeral;
2817           assert( p->pEList );
2818         }
2819 
2820 
2821         /* Code the SELECT statements to our left
2822         */
2823         assert( !pPrior->pOrderBy );
2824         sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
2825         SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION left...\n"));
2826         rc = sqlite3Select(pParse, pPrior, &uniondest);
2827         if( rc ){
2828           goto multi_select_end;
2829         }
2830 
2831         /* Code the current SELECT statement
2832         */
2833         if( p->op==TK_EXCEPT ){
2834           op = SRT_Except;
2835         }else{
2836           assert( p->op==TK_UNION );
2837           op = SRT_Union;
2838         }
2839         p->pPrior = 0;
2840         pLimit = p->pLimit;
2841         p->pLimit = 0;
2842         uniondest.eDest = op;
2843         ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
2844                           sqlite3SelectOpName(p->op)));
2845         SELECTTRACE(1, pParse, p, ("multiSelect EXCEPT/UNION right...\n"));
2846         rc = sqlite3Select(pParse, p, &uniondest);
2847         testcase( rc!=SQLITE_OK );
2848         assert( p->pOrderBy==0 );
2849         pDelete = p->pPrior;
2850         p->pPrior = pPrior;
2851         p->pOrderBy = 0;
2852         if( p->op==TK_UNION ){
2853           p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2854         }
2855         sqlite3ExprDelete(db, p->pLimit);
2856         p->pLimit = pLimit;
2857         p->iLimit = 0;
2858         p->iOffset = 0;
2859 
2860         /* Convert the data in the temporary table into whatever form
2861         ** it is that we currently need.
2862         */
2863         assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
2864         assert( p->pEList || db->mallocFailed );
2865         if( dest.eDest!=priorOp && db->mallocFailed==0 ){
2866           int iCont, iBreak, iStart;
2867           iBreak = sqlite3VdbeMakeLabel(pParse);
2868           iCont = sqlite3VdbeMakeLabel(pParse);
2869           computeLimitRegisters(pParse, p, iBreak);
2870           sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
2871           iStart = sqlite3VdbeCurrentAddr(v);
2872           selectInnerLoop(pParse, p, unionTab,
2873                           0, 0, &dest, iCont, iBreak);
2874           sqlite3VdbeResolveLabel(v, iCont);
2875           sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
2876           sqlite3VdbeResolveLabel(v, iBreak);
2877           sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
2878         }
2879         break;
2880       }
2881       default: assert( p->op==TK_INTERSECT ); {
2882         int tab1, tab2;
2883         int iCont, iBreak, iStart;
2884         Expr *pLimit;
2885         int addr;
2886         SelectDest intersectdest;
2887         int r1;
2888 
2889         /* INTERSECT is different from the others since it requires
2890         ** two temporary tables.  Hence it has its own case.  Begin
2891         ** by allocating the tables we will need.
2892         */
2893         tab1 = pParse->nTab++;
2894         tab2 = pParse->nTab++;
2895         assert( p->pOrderBy==0 );
2896 
2897         addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
2898         assert( p->addrOpenEphm[0] == -1 );
2899         p->addrOpenEphm[0] = addr;
2900         findRightmost(p)->selFlags |= SF_UsesEphemeral;
2901         assert( p->pEList );
2902 
2903         /* Code the SELECTs to our left into temporary table "tab1".
2904         */
2905         sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
2906         SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT left...\n"));
2907         rc = sqlite3Select(pParse, pPrior, &intersectdest);
2908         if( rc ){
2909           goto multi_select_end;
2910         }
2911 
2912         /* Code the current SELECT into temporary table "tab2"
2913         */
2914         addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
2915         assert( p->addrOpenEphm[1] == -1 );
2916         p->addrOpenEphm[1] = addr;
2917         p->pPrior = 0;
2918         pLimit = p->pLimit;
2919         p->pLimit = 0;
2920         intersectdest.iSDParm = tab2;
2921         ExplainQueryPlan((pParse, 1, "%s USING TEMP B-TREE",
2922                           sqlite3SelectOpName(p->op)));
2923         SELECTTRACE(1, pParse, p, ("multiSelect INTERSECT right...\n"));
2924         rc = sqlite3Select(pParse, p, &intersectdest);
2925         testcase( rc!=SQLITE_OK );
2926         pDelete = p->pPrior;
2927         p->pPrior = pPrior;
2928         if( p->nSelectRow>pPrior->nSelectRow ){
2929           p->nSelectRow = pPrior->nSelectRow;
2930         }
2931         sqlite3ExprDelete(db, p->pLimit);
2932         p->pLimit = pLimit;
2933 
2934         /* Generate code to take the intersection of the two temporary
2935         ** tables.
2936         */
2937         if( rc ) break;
2938         assert( p->pEList );
2939         iBreak = sqlite3VdbeMakeLabel(pParse);
2940         iCont = sqlite3VdbeMakeLabel(pParse);
2941         computeLimitRegisters(pParse, p, iBreak);
2942         sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
2943         r1 = sqlite3GetTempReg(pParse);
2944         iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
2945         sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0);
2946         VdbeCoverage(v);
2947         sqlite3ReleaseTempReg(pParse, r1);
2948         selectInnerLoop(pParse, p, tab1,
2949                         0, 0, &dest, iCont, iBreak);
2950         sqlite3VdbeResolveLabel(v, iCont);
2951         sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
2952         sqlite3VdbeResolveLabel(v, iBreak);
2953         sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
2954         sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
2955         break;
2956       }
2957     }
2958 
2959   #ifndef SQLITE_OMIT_EXPLAIN
2960     if( p->pNext==0 ){
2961       ExplainQueryPlanPop(pParse);
2962     }
2963   #endif
2964   }
2965   if( pParse->nErr ) goto multi_select_end;
2966 
2967   /* Compute collating sequences used by
2968   ** temporary tables needed to implement the compound select.
2969   ** Attach the KeyInfo structure to all temporary tables.
2970   **
2971   ** This section is run by the right-most SELECT statement only.
2972   ** SELECT statements to the left always skip this part.  The right-most
2973   ** SELECT might also skip this part if it has no ORDER BY clause and
2974   ** no temp tables are required.
2975   */
2976   if( p->selFlags & SF_UsesEphemeral ){
2977     int i;                        /* Loop counter */
2978     KeyInfo *pKeyInfo;            /* Collating sequence for the result set */
2979     Select *pLoop;                /* For looping through SELECT statements */
2980     CollSeq **apColl;             /* For looping through pKeyInfo->aColl[] */
2981     int nCol;                     /* Number of columns in result set */
2982 
2983     assert( p->pNext==0 );
2984     nCol = p->pEList->nExpr;
2985     pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
2986     if( !pKeyInfo ){
2987       rc = SQLITE_NOMEM_BKPT;
2988       goto multi_select_end;
2989     }
2990     for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
2991       *apColl = multiSelectCollSeq(pParse, p, i);
2992       if( 0==*apColl ){
2993         *apColl = db->pDfltColl;
2994       }
2995     }
2996 
2997     for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
2998       for(i=0; i<2; i++){
2999         int addr = pLoop->addrOpenEphm[i];
3000         if( addr<0 ){
3001           /* If [0] is unused then [1] is also unused.  So we can
3002           ** always safely abort as soon as the first unused slot is found */
3003           assert( pLoop->addrOpenEphm[1]<0 );
3004           break;
3005         }
3006         sqlite3VdbeChangeP2(v, addr, nCol);
3007         sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
3008                             P4_KEYINFO);
3009         pLoop->addrOpenEphm[i] = -1;
3010       }
3011     }
3012     sqlite3KeyInfoUnref(pKeyInfo);
3013   }
3014 
3015 multi_select_end:
3016   pDest->iSdst = dest.iSdst;
3017   pDest->nSdst = dest.nSdst;
3018   sqlite3SelectDelete(db, pDelete);
3019   return rc;
3020 }
3021 #endif /* SQLITE_OMIT_COMPOUND_SELECT */
3022 
3023 /*
3024 ** Error message for when two or more terms of a compound select have different
3025 ** size result sets.
3026 */
3027 void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
3028   if( p->selFlags & SF_Values ){
3029     sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
3030   }else{
3031     sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
3032       " do not have the same number of result columns",
3033       sqlite3SelectOpName(p->op));
3034   }
3035 }
3036 
3037 /*
3038 ** Code an output subroutine for a coroutine implementation of a
3039 ** SELECT statment.
3040 **
3041 ** The data to be output is contained in pIn->iSdst.  There are
3042 ** pIn->nSdst columns to be output.  pDest is where the output should
3043 ** be sent.
3044 **
3045 ** regReturn is the number of the register holding the subroutine
3046 ** return address.
3047 **
3048 ** If regPrev>0 then it is the first register in a vector that
3049 ** records the previous output.  mem[regPrev] is a flag that is false
3050 ** if there has been no previous output.  If regPrev>0 then code is
3051 ** generated to suppress duplicates.  pKeyInfo is used for comparing
3052 ** keys.
3053 **
3054 ** If the LIMIT found in p->iLimit is reached, jump immediately to
3055 ** iBreak.
3056 */
3057 static int generateOutputSubroutine(
3058   Parse *pParse,          /* Parsing context */
3059   Select *p,              /* The SELECT statement */
3060   SelectDest *pIn,        /* Coroutine supplying data */
3061   SelectDest *pDest,      /* Where to send the data */
3062   int regReturn,          /* The return address register */
3063   int regPrev,            /* Previous result register.  No uniqueness if 0 */
3064   KeyInfo *pKeyInfo,      /* For comparing with previous entry */
3065   int iBreak              /* Jump here if we hit the LIMIT */
3066 ){
3067   Vdbe *v = pParse->pVdbe;
3068   int iContinue;
3069   int addr;
3070 
3071   addr = sqlite3VdbeCurrentAddr(v);
3072   iContinue = sqlite3VdbeMakeLabel(pParse);
3073 
3074   /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
3075   */
3076   if( regPrev ){
3077     int addr1, addr2;
3078     addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
3079     addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
3080                               (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
3081     sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
3082     sqlite3VdbeJumpHere(v, addr1);
3083     sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
3084     sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
3085   }
3086   if( pParse->db->mallocFailed ) return 0;
3087 
3088   /* Suppress the first OFFSET entries if there is an OFFSET clause
3089   */
3090   codeOffset(v, p->iOffset, iContinue);
3091 
3092   assert( pDest->eDest!=SRT_Exists );
3093   assert( pDest->eDest!=SRT_Table );
3094   switch( pDest->eDest ){
3095     /* Store the result as data using a unique key.
3096     */
3097     case SRT_EphemTab: {
3098       int r1 = sqlite3GetTempReg(pParse);
3099       int r2 = sqlite3GetTempReg(pParse);
3100       sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
3101       sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
3102       sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
3103       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
3104       sqlite3ReleaseTempReg(pParse, r2);
3105       sqlite3ReleaseTempReg(pParse, r1);
3106       break;
3107     }
3108 
3109 #ifndef SQLITE_OMIT_SUBQUERY
3110     /* If we are creating a set for an "expr IN (SELECT ...)".
3111     */
3112     case SRT_Set: {
3113       int r1;
3114       testcase( pIn->nSdst>1 );
3115       r1 = sqlite3GetTempReg(pParse);
3116       sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
3117           r1, pDest->zAffSdst, pIn->nSdst);
3118       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
3119                            pIn->iSdst, pIn->nSdst);
3120       sqlite3ReleaseTempReg(pParse, r1);
3121       break;
3122     }
3123 
3124     /* If this is a scalar select that is part of an expression, then
3125     ** store the results in the appropriate memory cell and break out
3126     ** of the scan loop.  Note that the select might return multiple columns
3127     ** if it is the RHS of a row-value IN operator.
3128     */
3129     case SRT_Mem: {
3130       testcase( pIn->nSdst>1 );
3131       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, pIn->nSdst);
3132       /* The LIMIT clause will jump out of the loop for us */
3133       break;
3134     }
3135 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
3136 
3137     /* The results are stored in a sequence of registers
3138     ** starting at pDest->iSdst.  Then the co-routine yields.
3139     */
3140     case SRT_Coroutine: {
3141       if( pDest->iSdst==0 ){
3142         pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
3143         pDest->nSdst = pIn->nSdst;
3144       }
3145       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
3146       sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
3147       break;
3148     }
3149 
3150     /* If none of the above, then the result destination must be
3151     ** SRT_Output.  This routine is never called with any other
3152     ** destination other than the ones handled above or SRT_Output.
3153     **
3154     ** For SRT_Output, results are stored in a sequence of registers.
3155     ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
3156     ** return the next row of result.
3157     */
3158     default: {
3159       assert( pDest->eDest==SRT_Output );
3160       sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
3161       break;
3162     }
3163   }
3164 
3165   /* Jump to the end of the loop if the LIMIT is reached.
3166   */
3167   if( p->iLimit ){
3168     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
3169   }
3170 
3171   /* Generate the subroutine return
3172   */
3173   sqlite3VdbeResolveLabel(v, iContinue);
3174   sqlite3VdbeAddOp1(v, OP_Return, regReturn);
3175 
3176   return addr;
3177 }
3178 
3179 /*
3180 ** Alternative compound select code generator for cases when there
3181 ** is an ORDER BY clause.
3182 **
3183 ** We assume a query of the following form:
3184 **
3185 **      <selectA>  <operator>  <selectB>  ORDER BY <orderbylist>
3186 **
3187 ** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT.  The idea
3188 ** is to code both <selectA> and <selectB> with the ORDER BY clause as
3189 ** co-routines.  Then run the co-routines in parallel and merge the results
3190 ** into the output.  In addition to the two coroutines (called selectA and
3191 ** selectB) there are 7 subroutines:
3192 **
3193 **    outA:    Move the output of the selectA coroutine into the output
3194 **             of the compound query.
3195 **
3196 **    outB:    Move the output of the selectB coroutine into the output
3197 **             of the compound query.  (Only generated for UNION and
3198 **             UNION ALL.  EXCEPT and INSERTSECT never output a row that
3199 **             appears only in B.)
3200 **
3201 **    AltB:    Called when there is data from both coroutines and A<B.
3202 **
3203 **    AeqB:    Called when there is data from both coroutines and A==B.
3204 **
3205 **    AgtB:    Called when there is data from both coroutines and A>B.
3206 **
3207 **    EofA:    Called when data is exhausted from selectA.
3208 **
3209 **    EofB:    Called when data is exhausted from selectB.
3210 **
3211 ** The implementation of the latter five subroutines depend on which
3212 ** <operator> is used:
3213 **
3214 **
3215 **             UNION ALL         UNION            EXCEPT          INTERSECT
3216 **          -------------  -----------------  --------------  -----------------
3217 **   AltB:   outA, nextA      outA, nextA       outA, nextA         nextA
3218 **
3219 **   AeqB:   outA, nextA         nextA             nextA         outA, nextA
3220 **
3221 **   AgtB:   outB, nextB      outB, nextB          nextB            nextB
3222 **
3223 **   EofA:   outB, nextB      outB, nextB          halt             halt
3224 **
3225 **   EofB:   outA, nextA      outA, nextA       outA, nextA         halt
3226 **
3227 ** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
3228 ** causes an immediate jump to EofA and an EOF on B following nextB causes
3229 ** an immediate jump to EofB.  Within EofA and EofB, and EOF on entry or
3230 ** following nextX causes a jump to the end of the select processing.
3231 **
3232 ** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
3233 ** within the output subroutine.  The regPrev register set holds the previously
3234 ** output value.  A comparison is made against this value and the output
3235 ** is skipped if the next results would be the same as the previous.
3236 **
3237 ** The implementation plan is to implement the two coroutines and seven
3238 ** subroutines first, then put the control logic at the bottom.  Like this:
3239 **
3240 **          goto Init
3241 **     coA: coroutine for left query (A)
3242 **     coB: coroutine for right query (B)
3243 **    outA: output one row of A
3244 **    outB: output one row of B (UNION and UNION ALL only)
3245 **    EofA: ...
3246 **    EofB: ...
3247 **    AltB: ...
3248 **    AeqB: ...
3249 **    AgtB: ...
3250 **    Init: initialize coroutine registers
3251 **          yield coA
3252 **          if eof(A) goto EofA
3253 **          yield coB
3254 **          if eof(B) goto EofB
3255 **    Cmpr: Compare A, B
3256 **          Jump AltB, AeqB, AgtB
3257 **     End: ...
3258 **
3259 ** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
3260 ** actually called using Gosub and they do not Return.  EofA and EofB loop
3261 ** until all data is exhausted then jump to the "end" labe.  AltB, AeqB,
3262 ** and AgtB jump to either L2 or to one of EofA or EofB.
3263 */
3264 #ifndef SQLITE_OMIT_COMPOUND_SELECT
3265 static int multiSelectOrderBy(
3266   Parse *pParse,        /* Parsing context */
3267   Select *p,            /* The right-most of SELECTs to be coded */
3268   SelectDest *pDest     /* What to do with query results */
3269 ){
3270   int i, j;             /* Loop counters */
3271   Select *pPrior;       /* Another SELECT immediately to our left */
3272   Vdbe *v;              /* Generate code to this VDBE */
3273   SelectDest destA;     /* Destination for coroutine A */
3274   SelectDest destB;     /* Destination for coroutine B */
3275   int regAddrA;         /* Address register for select-A coroutine */
3276   int regAddrB;         /* Address register for select-B coroutine */
3277   int addrSelectA;      /* Address of the select-A coroutine */
3278   int addrSelectB;      /* Address of the select-B coroutine */
3279   int regOutA;          /* Address register for the output-A subroutine */
3280   int regOutB;          /* Address register for the output-B subroutine */
3281   int addrOutA;         /* Address of the output-A subroutine */
3282   int addrOutB = 0;     /* Address of the output-B subroutine */
3283   int addrEofA;         /* Address of the select-A-exhausted subroutine */
3284   int addrEofA_noB;     /* Alternate addrEofA if B is uninitialized */
3285   int addrEofB;         /* Address of the select-B-exhausted subroutine */
3286   int addrAltB;         /* Address of the A<B subroutine */
3287   int addrAeqB;         /* Address of the A==B subroutine */
3288   int addrAgtB;         /* Address of the A>B subroutine */
3289   int regLimitA;        /* Limit register for select-A */
3290   int regLimitB;        /* Limit register for select-A */
3291   int regPrev;          /* A range of registers to hold previous output */
3292   int savedLimit;       /* Saved value of p->iLimit */
3293   int savedOffset;      /* Saved value of p->iOffset */
3294   int labelCmpr;        /* Label for the start of the merge algorithm */
3295   int labelEnd;         /* Label for the end of the overall SELECT stmt */
3296   int addr1;            /* Jump instructions that get retargetted */
3297   int op;               /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
3298   KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
3299   KeyInfo *pKeyMerge;   /* Comparison information for merging rows */
3300   sqlite3 *db;          /* Database connection */
3301   ExprList *pOrderBy;   /* The ORDER BY clause */
3302   int nOrderBy;         /* Number of terms in the ORDER BY clause */
3303   u32 *aPermute;        /* Mapping from ORDER BY terms to result set columns */
3304 
3305   assert( p->pOrderBy!=0 );
3306   assert( pKeyDup==0 ); /* "Managed" code needs this.  Ticket #3382. */
3307   db = pParse->db;
3308   v = pParse->pVdbe;
3309   assert( v!=0 );       /* Already thrown the error if VDBE alloc failed */
3310   labelEnd = sqlite3VdbeMakeLabel(pParse);
3311   labelCmpr = sqlite3VdbeMakeLabel(pParse);
3312 
3313 
3314   /* Patch up the ORDER BY clause
3315   */
3316   op = p->op;
3317   pPrior = p->pPrior;
3318   assert( pPrior->pOrderBy==0 );
3319   pOrderBy = p->pOrderBy;
3320   assert( pOrderBy );
3321   nOrderBy = pOrderBy->nExpr;
3322 
3323   /* For operators other than UNION ALL we have to make sure that
3324   ** the ORDER BY clause covers every term of the result set.  Add
3325   ** terms to the ORDER BY clause as necessary.
3326   */
3327   if( op!=TK_ALL ){
3328     for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
3329       struct ExprList_item *pItem;
3330       for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
3331         assert( pItem->u.x.iOrderByCol>0 );
3332         if( pItem->u.x.iOrderByCol==i ) break;
3333       }
3334       if( j==nOrderBy ){
3335         Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
3336         if( pNew==0 ) return SQLITE_NOMEM_BKPT;
3337         pNew->flags |= EP_IntValue;
3338         pNew->u.iValue = i;
3339         p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
3340         if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
3341       }
3342     }
3343   }
3344 
3345   /* Compute the comparison permutation and keyinfo that is used with
3346   ** the permutation used to determine if the next
3347   ** row of results comes from selectA or selectB.  Also add explicit
3348   ** collations to the ORDER BY clause terms so that when the subqueries
3349   ** to the right and the left are evaluated, they use the correct
3350   ** collation.
3351   */
3352   aPermute = sqlite3DbMallocRawNN(db, sizeof(u32)*(nOrderBy + 1));
3353   if( aPermute ){
3354     struct ExprList_item *pItem;
3355     aPermute[0] = nOrderBy;
3356     for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
3357       assert( pItem->u.x.iOrderByCol>0 );
3358       assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
3359       aPermute[i] = pItem->u.x.iOrderByCol - 1;
3360     }
3361     pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
3362   }else{
3363     pKeyMerge = 0;
3364   }
3365 
3366   /* Reattach the ORDER BY clause to the query.
3367   */
3368   p->pOrderBy = pOrderBy;
3369   pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
3370 
3371   /* Allocate a range of temporary registers and the KeyInfo needed
3372   ** for the logic that removes duplicate result rows when the
3373   ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
3374   */
3375   if( op==TK_ALL ){
3376     regPrev = 0;
3377   }else{
3378     int nExpr = p->pEList->nExpr;
3379     assert( nOrderBy>=nExpr || db->mallocFailed );
3380     regPrev = pParse->nMem+1;
3381     pParse->nMem += nExpr+1;
3382     sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
3383     pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
3384     if( pKeyDup ){
3385       assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
3386       for(i=0; i<nExpr; i++){
3387         pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
3388         pKeyDup->aSortFlags[i] = 0;
3389       }
3390     }
3391   }
3392 
3393   /* Separate the left and the right query from one another
3394   */
3395   p->pPrior = 0;
3396   pPrior->pNext = 0;
3397   sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
3398   if( pPrior->pPrior==0 ){
3399     sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
3400   }
3401 
3402   /* Compute the limit registers */
3403   computeLimitRegisters(pParse, p, labelEnd);
3404   if( p->iLimit && op==TK_ALL ){
3405     regLimitA = ++pParse->nMem;
3406     regLimitB = ++pParse->nMem;
3407     sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
3408                                   regLimitA);
3409     sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
3410   }else{
3411     regLimitA = regLimitB = 0;
3412   }
3413   sqlite3ExprDelete(db, p->pLimit);
3414   p->pLimit = 0;
3415 
3416   regAddrA = ++pParse->nMem;
3417   regAddrB = ++pParse->nMem;
3418   regOutA = ++pParse->nMem;
3419   regOutB = ++pParse->nMem;
3420   sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3421   sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
3422 
3423   ExplainQueryPlan((pParse, 1, "MERGE (%s)", sqlite3SelectOpName(p->op)));
3424 
3425   /* Generate a coroutine to evaluate the SELECT statement to the
3426   ** left of the compound operator - the "A" select.
3427   */
3428   addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
3429   addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
3430   VdbeComment((v, "left SELECT"));
3431   pPrior->iLimit = regLimitA;
3432   ExplainQueryPlan((pParse, 1, "LEFT"));
3433   sqlite3Select(pParse, pPrior, &destA);
3434   sqlite3VdbeEndCoroutine(v, regAddrA);
3435   sqlite3VdbeJumpHere(v, addr1);
3436 
3437   /* Generate a coroutine to evaluate the SELECT statement on
3438   ** the right - the "B" select
3439   */
3440   addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
3441   addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
3442   VdbeComment((v, "right SELECT"));
3443   savedLimit = p->iLimit;
3444   savedOffset = p->iOffset;
3445   p->iLimit = regLimitB;
3446   p->iOffset = 0;
3447   ExplainQueryPlan((pParse, 1, "RIGHT"));
3448   sqlite3Select(pParse, p, &destB);
3449   p->iLimit = savedLimit;
3450   p->iOffset = savedOffset;
3451   sqlite3VdbeEndCoroutine(v, regAddrB);
3452 
3453   /* Generate a subroutine that outputs the current row of the A
3454   ** select as the next output row of the compound select.
3455   */
3456   VdbeNoopComment((v, "Output routine for A"));
3457   addrOutA = generateOutputSubroutine(pParse,
3458                  p, &destA, pDest, regOutA,
3459                  regPrev, pKeyDup, labelEnd);
3460 
3461   /* Generate a subroutine that outputs the current row of the B
3462   ** select as the next output row of the compound select.
3463   */
3464   if( op==TK_ALL || op==TK_UNION ){
3465     VdbeNoopComment((v, "Output routine for B"));
3466     addrOutB = generateOutputSubroutine(pParse,
3467                  p, &destB, pDest, regOutB,
3468                  regPrev, pKeyDup, labelEnd);
3469   }
3470   sqlite3KeyInfoUnref(pKeyDup);
3471 
3472   /* Generate a subroutine to run when the results from select A
3473   ** are exhausted and only data in select B remains.
3474   */
3475   if( op==TK_EXCEPT || op==TK_INTERSECT ){
3476     addrEofA_noB = addrEofA = labelEnd;
3477   }else{
3478     VdbeNoopComment((v, "eof-A subroutine"));
3479     addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3480     addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
3481                                      VdbeCoverage(v);
3482     sqlite3VdbeGoto(v, addrEofA);
3483     p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
3484   }
3485 
3486   /* Generate a subroutine to run when the results from select B
3487   ** are exhausted and only data in select A remains.
3488   */
3489   if( op==TK_INTERSECT ){
3490     addrEofB = addrEofA;
3491     if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
3492   }else{
3493     VdbeNoopComment((v, "eof-B subroutine"));
3494     addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3495     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
3496     sqlite3VdbeGoto(v, addrEofB);
3497   }
3498 
3499   /* Generate code to handle the case of A<B
3500   */
3501   VdbeNoopComment((v, "A-lt-B subroutine"));
3502   addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3503   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
3504   sqlite3VdbeGoto(v, labelCmpr);
3505 
3506   /* Generate code to handle the case of A==B
3507   */
3508   if( op==TK_ALL ){
3509     addrAeqB = addrAltB;
3510   }else if( op==TK_INTERSECT ){
3511     addrAeqB = addrAltB;
3512     addrAltB++;
3513   }else{
3514     VdbeNoopComment((v, "A-eq-B subroutine"));
3515     addrAeqB =
3516     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
3517     sqlite3VdbeGoto(v, labelCmpr);
3518   }
3519 
3520   /* Generate code to handle the case of A>B
3521   */
3522   VdbeNoopComment((v, "A-gt-B subroutine"));
3523   addrAgtB = sqlite3VdbeCurrentAddr(v);
3524   if( op==TK_ALL || op==TK_UNION ){
3525     sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3526   }
3527   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
3528   sqlite3VdbeGoto(v, labelCmpr);
3529 
3530   /* This code runs once to initialize everything.
3531   */
3532   sqlite3VdbeJumpHere(v, addr1);
3533   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3534   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
3535 
3536   /* Implement the main merge loop
3537   */
3538   sqlite3VdbeResolveLabel(v, labelCmpr);
3539   sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
3540   sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
3541                          (char*)pKeyMerge, P4_KEYINFO);
3542   sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
3543   sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
3544 
3545   /* Jump to the this point in order to terminate the query.
3546   */
3547   sqlite3VdbeResolveLabel(v, labelEnd);
3548 
3549   /* Reassembly the compound query so that it will be freed correctly
3550   ** by the calling function */
3551   if( p->pPrior ){
3552     sqlite3SelectDelete(db, p->pPrior);
3553   }
3554   p->pPrior = pPrior;
3555   pPrior->pNext = p;
3556 
3557   sqlite3ExprListDelete(db, pPrior->pOrderBy);
3558   pPrior->pOrderBy = 0;
3559 
3560   /*** TBD:  Insert subroutine calls to close cursors on incomplete
3561   **** subqueries ****/
3562   ExplainQueryPlanPop(pParse);
3563   return pParse->nErr!=0;
3564 }
3565 #endif
3566 
3567 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3568 
3569 /* An instance of the SubstContext object describes an substitution edit
3570 ** to be performed on a parse tree.
3571 **
3572 ** All references to columns in table iTable are to be replaced by corresponding
3573 ** expressions in pEList.
3574 */
3575 typedef struct SubstContext {
3576   Parse *pParse;            /* The parsing context */
3577   int iTable;               /* Replace references to this table */
3578   int iNewTable;            /* New table number */
3579   int isLeftJoin;           /* Add TK_IF_NULL_ROW opcodes on each replacement */
3580   ExprList *pEList;         /* Replacement expressions */
3581 } SubstContext;
3582 
3583 /* Forward Declarations */
3584 static void substExprList(SubstContext*, ExprList*);
3585 static void substSelect(SubstContext*, Select*, int);
3586 
3587 /*
3588 ** Scan through the expression pExpr.  Replace every reference to
3589 ** a column in table number iTable with a copy of the iColumn-th
3590 ** entry in pEList.  (But leave references to the ROWID column
3591 ** unchanged.)
3592 **
3593 ** This routine is part of the flattening procedure.  A subquery
3594 ** whose result set is defined by pEList appears as entry in the
3595 ** FROM clause of a SELECT such that the VDBE cursor assigned to that
3596 ** FORM clause entry is iTable.  This routine makes the necessary
3597 ** changes to pExpr so that it refers directly to the source table
3598 ** of the subquery rather the result set of the subquery.
3599 */
3600 static Expr *substExpr(
3601   SubstContext *pSubst,  /* Description of the substitution */
3602   Expr *pExpr            /* Expr in which substitution occurs */
3603 ){
3604   if( pExpr==0 ) return 0;
3605   if( ExprHasProperty(pExpr, EP_FromJoin)
3606    && pExpr->iRightJoinTable==pSubst->iTable
3607   ){
3608     pExpr->iRightJoinTable = pSubst->iNewTable;
3609   }
3610   if( pExpr->op==TK_COLUMN
3611    && pExpr->iTable==pSubst->iTable
3612    && !ExprHasProperty(pExpr, EP_FixedCol)
3613   ){
3614 #ifdef SQLITE_ALLOW_ROWID_IN_VIEW
3615     if( pExpr->iColumn<0 ){
3616       pExpr->op = TK_NULL;
3617     }else
3618 #endif
3619     {
3620       Expr *pNew;
3621       Expr *pCopy = pSubst->pEList->a[pExpr->iColumn].pExpr;
3622       Expr ifNullRow;
3623       assert( pSubst->pEList!=0 && pExpr->iColumn<pSubst->pEList->nExpr );
3624       assert( pExpr->pRight==0 );
3625       if( sqlite3ExprIsVector(pCopy) ){
3626         sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
3627       }else{
3628         sqlite3 *db = pSubst->pParse->db;
3629         if( pSubst->isLeftJoin && pCopy->op!=TK_COLUMN ){
3630           memset(&ifNullRow, 0, sizeof(ifNullRow));
3631           ifNullRow.op = TK_IF_NULL_ROW;
3632           ifNullRow.pLeft = pCopy;
3633           ifNullRow.iTable = pSubst->iNewTable;
3634           ifNullRow.flags = EP_IfNullRow;
3635           pCopy = &ifNullRow;
3636         }
3637         testcase( ExprHasProperty(pCopy, EP_Subquery) );
3638         pNew = sqlite3ExprDup(db, pCopy, 0);
3639         if( db->mallocFailed ){
3640           sqlite3ExprDelete(db, pNew);
3641           return pExpr;
3642         }
3643         if( pSubst->isLeftJoin ){
3644           ExprSetProperty(pNew, EP_CanBeNull);
3645         }
3646         if( ExprHasProperty(pExpr,EP_FromJoin) ){
3647           sqlite3SetJoinExpr(pNew, pExpr->iRightJoinTable);
3648         }
3649         sqlite3ExprDelete(db, pExpr);
3650         pExpr = pNew;
3651 
3652         /* Ensure that the expression now has an implicit collation sequence,
3653         ** just as it did when it was a column of a view or sub-query. */
3654         if( pExpr->op!=TK_COLUMN && pExpr->op!=TK_COLLATE ){
3655           CollSeq *pColl = sqlite3ExprCollSeq(pSubst->pParse, pExpr);
3656           pExpr = sqlite3ExprAddCollateString(pSubst->pParse, pExpr,
3657               (pColl ? pColl->zName : "BINARY")
3658           );
3659         }
3660         ExprClearProperty(pExpr, EP_Collate);
3661       }
3662     }
3663   }else{
3664     if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3665       pExpr->iTable = pSubst->iNewTable;
3666     }
3667     pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3668     pExpr->pRight = substExpr(pSubst, pExpr->pRight);
3669     if( ExprHasProperty(pExpr, EP_xIsSelect) ){
3670       substSelect(pSubst, pExpr->x.pSelect, 1);
3671     }else{
3672       substExprList(pSubst, pExpr->x.pList);
3673     }
3674 #ifndef SQLITE_OMIT_WINDOWFUNC
3675     if( ExprHasProperty(pExpr, EP_WinFunc) ){
3676       Window *pWin = pExpr->y.pWin;
3677       pWin->pFilter = substExpr(pSubst, pWin->pFilter);
3678       substExprList(pSubst, pWin->pPartition);
3679       substExprList(pSubst, pWin->pOrderBy);
3680     }
3681 #endif
3682   }
3683   return pExpr;
3684 }
3685 static void substExprList(
3686   SubstContext *pSubst, /* Description of the substitution */
3687   ExprList *pList       /* List to scan and in which to make substitutes */
3688 ){
3689   int i;
3690   if( pList==0 ) return;
3691   for(i=0; i<pList->nExpr; i++){
3692     pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
3693   }
3694 }
3695 static void substSelect(
3696   SubstContext *pSubst, /* Description of the substitution */
3697   Select *p,            /* SELECT statement in which to make substitutions */
3698   int doPrior           /* Do substitutes on p->pPrior too */
3699 ){
3700   SrcList *pSrc;
3701   SrcItem *pItem;
3702   int i;
3703   if( !p ) return;
3704   do{
3705     substExprList(pSubst, p->pEList);
3706     substExprList(pSubst, p->pGroupBy);
3707     substExprList(pSubst, p->pOrderBy);
3708     p->pHaving = substExpr(pSubst, p->pHaving);
3709     p->pWhere = substExpr(pSubst, p->pWhere);
3710     pSrc = p->pSrc;
3711     assert( pSrc!=0 );
3712     for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
3713       substSelect(pSubst, pItem->pSelect, 1);
3714       if( pItem->fg.isTabFunc ){
3715         substExprList(pSubst, pItem->u1.pFuncArg);
3716       }
3717     }
3718   }while( doPrior && (p = p->pPrior)!=0 );
3719 }
3720 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3721 
3722 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3723 /*
3724 ** pSelect is a SELECT statement and pSrcItem is one item in the FROM
3725 ** clause of that SELECT.
3726 **
3727 ** This routine scans the entire SELECT statement and recomputes the
3728 ** pSrcItem->colUsed mask.
3729 */
3730 static int recomputeColumnsUsedExpr(Walker *pWalker, Expr *pExpr){
3731   SrcItem *pItem;
3732   if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
3733   pItem = pWalker->u.pSrcItem;
3734   if( pItem->iCursor!=pExpr->iTable ) return WRC_Continue;
3735   if( pExpr->iColumn<0 ) return WRC_Continue;
3736   pItem->colUsed |= sqlite3ExprColUsed(pExpr);
3737   return WRC_Continue;
3738 }
3739 static void recomputeColumnsUsed(
3740   Select *pSelect,                 /* The complete SELECT statement */
3741   SrcItem *pSrcItem                /* Which FROM clause item to recompute */
3742 ){
3743   Walker w;
3744   if( NEVER(pSrcItem->pTab==0) ) return;
3745   memset(&w, 0, sizeof(w));
3746   w.xExprCallback = recomputeColumnsUsedExpr;
3747   w.xSelectCallback = sqlite3SelectWalkNoop;
3748   w.u.pSrcItem = pSrcItem;
3749   pSrcItem->colUsed = 0;
3750   sqlite3WalkSelect(&w, pSelect);
3751 }
3752 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3753 
3754 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3755 /*
3756 ** Assign new cursor numbers to each of the items in pSrc. For each
3757 ** new cursor number assigned, set an entry in the aCsrMap[] array
3758 ** to map the old cursor number to the new:
3759 **
3760 **     aCsrMap[iOld+1] = iNew;
3761 **
3762 ** The array is guaranteed by the caller to be large enough for all
3763 ** existing cursor numbers in pSrc.  aCsrMap[0] is the array size.
3764 **
3765 ** If pSrc contains any sub-selects, call this routine recursively
3766 ** on the FROM clause of each such sub-select, with iExcept set to -1.
3767 */
3768 static void srclistRenumberCursors(
3769   Parse *pParse,                  /* Parse context */
3770   int *aCsrMap,                   /* Array to store cursor mappings in */
3771   SrcList *pSrc,                  /* FROM clause to renumber */
3772   int iExcept                     /* FROM clause item to skip */
3773 ){
3774   int i;
3775   SrcItem *pItem;
3776   for(i=0, pItem=pSrc->a; i<pSrc->nSrc; i++, pItem++){
3777     if( i!=iExcept ){
3778       Select *p;
3779       assert( pItem->iCursor < aCsrMap[0] );
3780       if( !pItem->fg.isRecursive || aCsrMap[pItem->iCursor+1]==0 ){
3781         aCsrMap[pItem->iCursor+1] = pParse->nTab++;
3782       }
3783       pItem->iCursor = aCsrMap[pItem->iCursor+1];
3784       for(p=pItem->pSelect; p; p=p->pPrior){
3785         srclistRenumberCursors(pParse, aCsrMap, p->pSrc, -1);
3786       }
3787     }
3788   }
3789 }
3790 
3791 /*
3792 ** *piCursor is a cursor number.  Change it if it needs to be mapped.
3793 */
3794 static void renumberCursorDoMapping(Walker *pWalker, int *piCursor){
3795   int *aCsrMap = pWalker->u.aiCol;
3796   int iCsr = *piCursor;
3797   if( iCsr < aCsrMap[0] && aCsrMap[iCsr+1]>0 ){
3798     *piCursor = aCsrMap[iCsr+1];
3799   }
3800 }
3801 
3802 /*
3803 ** Expression walker callback used by renumberCursors() to update
3804 ** Expr objects to match newly assigned cursor numbers.
3805 */
3806 static int renumberCursorsCb(Walker *pWalker, Expr *pExpr){
3807   int op = pExpr->op;
3808   if( op==TK_COLUMN || op==TK_IF_NULL_ROW ){
3809     renumberCursorDoMapping(pWalker, &pExpr->iTable);
3810   }
3811   if( ExprHasProperty(pExpr, EP_FromJoin) ){
3812     renumberCursorDoMapping(pWalker, &pExpr->iRightJoinTable);
3813   }
3814   return WRC_Continue;
3815 }
3816 
3817 /*
3818 ** Assign a new cursor number to each cursor in the FROM clause (Select.pSrc)
3819 ** of the SELECT statement passed as the second argument, and to each
3820 ** cursor in the FROM clause of any FROM clause sub-selects, recursively.
3821 ** Except, do not assign a new cursor number to the iExcept'th element in
3822 ** the FROM clause of (*p). Update all expressions and other references
3823 ** to refer to the new cursor numbers.
3824 **
3825 ** Argument aCsrMap is an array that may be used for temporary working
3826 ** space. Two guarantees are made by the caller:
3827 **
3828 **   * the array is larger than the largest cursor number used within the
3829 **     select statement passed as an argument, and
3830 **
3831 **   * the array entries for all cursor numbers that do *not* appear in
3832 **     FROM clauses of the select statement as described above are
3833 **     initialized to zero.
3834 */
3835 static void renumberCursors(
3836   Parse *pParse,                  /* Parse context */
3837   Select *p,                      /* Select to renumber cursors within */
3838   int iExcept,                    /* FROM clause item to skip */
3839   int *aCsrMap                    /* Working space */
3840 ){
3841   Walker w;
3842   srclistRenumberCursors(pParse, aCsrMap, p->pSrc, iExcept);
3843   memset(&w, 0, sizeof(w));
3844   w.u.aiCol = aCsrMap;
3845   w.xExprCallback = renumberCursorsCb;
3846   w.xSelectCallback = sqlite3SelectWalkNoop;
3847   sqlite3WalkSelect(&w, p);
3848 }
3849 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3850 
3851 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3852 /*
3853 ** This routine attempts to flatten subqueries as a performance optimization.
3854 ** This routine returns 1 if it makes changes and 0 if no flattening occurs.
3855 **
3856 ** To understand the concept of flattening, consider the following
3857 ** query:
3858 **
3859 **     SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
3860 **
3861 ** The default way of implementing this query is to execute the
3862 ** subquery first and store the results in a temporary table, then
3863 ** run the outer query on that temporary table.  This requires two
3864 ** passes over the data.  Furthermore, because the temporary table
3865 ** has no indices, the WHERE clause on the outer query cannot be
3866 ** optimized.
3867 **
3868 ** This routine attempts to rewrite queries such as the above into
3869 ** a single flat select, like this:
3870 **
3871 **     SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
3872 **
3873 ** The code generated for this simplification gives the same result
3874 ** but only has to scan the data once.  And because indices might
3875 ** exist on the table t1, a complete scan of the data might be
3876 ** avoided.
3877 **
3878 ** Flattening is subject to the following constraints:
3879 **
3880 **  (**)  We no longer attempt to flatten aggregate subqueries. Was:
3881 **        The subquery and the outer query cannot both be aggregates.
3882 **
3883 **  (**)  We no longer attempt to flatten aggregate subqueries. Was:
3884 **        (2) If the subquery is an aggregate then
3885 **        (2a) the outer query must not be a join and
3886 **        (2b) the outer query must not use subqueries
3887 **             other than the one FROM-clause subquery that is a candidate
3888 **             for flattening.  (This is due to ticket [2f7170d73bf9abf80]
3889 **             from 2015-02-09.)
3890 **
3891 **   (3)  If the subquery is the right operand of a LEFT JOIN then
3892 **        (3a) the subquery may not be a join and
3893 **        (3b) the FROM clause of the subquery may not contain a virtual
3894 **             table and
3895 **        (3c) the outer query may not be an aggregate.
3896 **        (3d) the outer query may not be DISTINCT.
3897 **
3898 **   (4)  The subquery can not be DISTINCT.
3899 **
3900 **  (**)  At one point restrictions (4) and (5) defined a subset of DISTINCT
3901 **        sub-queries that were excluded from this optimization. Restriction
3902 **        (4) has since been expanded to exclude all DISTINCT subqueries.
3903 **
3904 **  (**)  We no longer attempt to flatten aggregate subqueries.  Was:
3905 **        If the subquery is aggregate, the outer query may not be DISTINCT.
3906 **
3907 **   (7)  The subquery must have a FROM clause.  TODO:  For subqueries without
3908 **        A FROM clause, consider adding a FROM clause with the special
3909 **        table sqlite_once that consists of a single row containing a
3910 **        single NULL.
3911 **
3912 **   (8)  If the subquery uses LIMIT then the outer query may not be a join.
3913 **
3914 **   (9)  If the subquery uses LIMIT then the outer query may not be aggregate.
3915 **
3916 **  (**)  Restriction (10) was removed from the code on 2005-02-05 but we
3917 **        accidently carried the comment forward until 2014-09-15.  Original
3918 **        constraint: "If the subquery is aggregate then the outer query
3919 **        may not use LIMIT."
3920 **
3921 **  (11)  The subquery and the outer query may not both have ORDER BY clauses.
3922 **
3923 **  (**)  Not implemented.  Subsumed into restriction (3).  Was previously
3924 **        a separate restriction deriving from ticket #350.
3925 **
3926 **  (13)  The subquery and outer query may not both use LIMIT.
3927 **
3928 **  (14)  The subquery may not use OFFSET.
3929 **
3930 **  (15)  If the outer query is part of a compound select, then the
3931 **        subquery may not use LIMIT.
3932 **        (See ticket #2339 and ticket [02a8e81d44]).
3933 **
3934 **  (16)  If the outer query is aggregate, then the subquery may not
3935 **        use ORDER BY.  (Ticket #2942)  This used to not matter
3936 **        until we introduced the group_concat() function.
3937 **
3938 **  (17)  If the subquery is a compound select, then
3939 **        (17a) all compound operators must be a UNION ALL, and
3940 **        (17b) no terms within the subquery compound may be aggregate
3941 **              or DISTINCT, and
3942 **        (17c) every term within the subquery compound must have a FROM clause
3943 **        (17d) the outer query may not be
3944 **              (17d1) aggregate, or
3945 **              (17d2) DISTINCT
3946 **        (17e) the subquery may not contain window functions, and
3947 **        (17f) the subquery must not be the RHS of a LEFT JOIN.
3948 **
3949 **        The parent and sub-query may contain WHERE clauses. Subject to
3950 **        rules (11), (13) and (14), they may also contain ORDER BY,
3951 **        LIMIT and OFFSET clauses.  The subquery cannot use any compound
3952 **        operator other than UNION ALL because all the other compound
3953 **        operators have an implied DISTINCT which is disallowed by
3954 **        restriction (4).
3955 **
3956 **        Also, each component of the sub-query must return the same number
3957 **        of result columns. This is actually a requirement for any compound
3958 **        SELECT statement, but all the code here does is make sure that no
3959 **        such (illegal) sub-query is flattened. The caller will detect the
3960 **        syntax error and return a detailed message.
3961 **
3962 **  (18)  If the sub-query is a compound select, then all terms of the
3963 **        ORDER BY clause of the parent must be copies of a term returned
3964 **        by the parent query.
3965 **
3966 **  (19)  If the subquery uses LIMIT then the outer query may not
3967 **        have a WHERE clause.
3968 **
3969 **  (20)  If the sub-query is a compound select, then it must not use
3970 **        an ORDER BY clause.  Ticket #3773.  We could relax this constraint
3971 **        somewhat by saying that the terms of the ORDER BY clause must
3972 **        appear as unmodified result columns in the outer query.  But we
3973 **        have other optimizations in mind to deal with that case.
3974 **
3975 **  (21)  If the subquery uses LIMIT then the outer query may not be
3976 **        DISTINCT.  (See ticket [752e1646fc]).
3977 **
3978 **  (22)  The subquery may not be a recursive CTE.
3979 **
3980 **  (23)  If the outer query is a recursive CTE, then the sub-query may not be
3981 **        a compound query.  This restriction is because transforming the
3982 **        parent to a compound query confuses the code that handles
3983 **        recursive queries in multiSelect().
3984 **
3985 **  (**)  We no longer attempt to flatten aggregate subqueries.  Was:
3986 **        The subquery may not be an aggregate that uses the built-in min() or
3987 **        or max() functions.  (Without this restriction, a query like:
3988 **        "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
3989 **        return the value X for which Y was maximal.)
3990 **
3991 **  (25)  If either the subquery or the parent query contains a window
3992 **        function in the select list or ORDER BY clause, flattening
3993 **        is not attempted.
3994 **
3995 **
3996 ** In this routine, the "p" parameter is a pointer to the outer query.
3997 ** The subquery is p->pSrc->a[iFrom].  isAgg is true if the outer query
3998 ** uses aggregates.
3999 **
4000 ** If flattening is not attempted, this routine is a no-op and returns 0.
4001 ** If flattening is attempted this routine returns 1.
4002 **
4003 ** All of the expression analysis must occur on both the outer query and
4004 ** the subquery before this routine runs.
4005 */
4006 static int flattenSubquery(
4007   Parse *pParse,       /* Parsing context */
4008   Select *p,           /* The parent or outer SELECT statement */
4009   int iFrom,           /* Index in p->pSrc->a[] of the inner subquery */
4010   int isAgg            /* True if outer SELECT uses aggregate functions */
4011 ){
4012   const char *zSavedAuthContext = pParse->zAuthContext;
4013   Select *pParent;    /* Current UNION ALL term of the other query */
4014   Select *pSub;       /* The inner query or "subquery" */
4015   Select *pSub1;      /* Pointer to the rightmost select in sub-query */
4016   SrcList *pSrc;      /* The FROM clause of the outer query */
4017   SrcList *pSubSrc;   /* The FROM clause of the subquery */
4018   int iParent;        /* VDBE cursor number of the pSub result set temp table */
4019   int iNewParent = -1;/* Replacement table for iParent */
4020   int isLeftJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
4021   int i;              /* Loop counter */
4022   Expr *pWhere;                    /* The WHERE clause */
4023   SrcItem *pSubitem;               /* The subquery */
4024   sqlite3 *db = pParse->db;
4025   Walker w;                        /* Walker to persist agginfo data */
4026   int *aCsrMap = 0;
4027 
4028   /* Check to see if flattening is permitted.  Return 0 if not.
4029   */
4030   assert( p!=0 );
4031   assert( p->pPrior==0 );
4032   if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
4033   pSrc = p->pSrc;
4034   assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
4035   pSubitem = &pSrc->a[iFrom];
4036   iParent = pSubitem->iCursor;
4037   pSub = pSubitem->pSelect;
4038   assert( pSub!=0 );
4039 
4040 #ifndef SQLITE_OMIT_WINDOWFUNC
4041   if( p->pWin || pSub->pWin ) return 0;                  /* Restriction (25) */
4042 #endif
4043 
4044   pSubSrc = pSub->pSrc;
4045   assert( pSubSrc );
4046   /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
4047   ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
4048   ** because they could be computed at compile-time.  But when LIMIT and OFFSET
4049   ** became arbitrary expressions, we were forced to add restrictions (13)
4050   ** and (14). */
4051   if( pSub->pLimit && p->pLimit ) return 0;              /* Restriction (13) */
4052   if( pSub->pLimit && pSub->pLimit->pRight ) return 0;   /* Restriction (14) */
4053   if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
4054     return 0;                                            /* Restriction (15) */
4055   }
4056   if( pSubSrc->nSrc==0 ) return 0;                       /* Restriction (7)  */
4057   if( pSub->selFlags & SF_Distinct ) return 0;           /* Restriction (4)  */
4058   if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
4059      return 0;         /* Restrictions (8)(9) */
4060   }
4061   if( p->pOrderBy && pSub->pOrderBy ){
4062      return 0;                                           /* Restriction (11) */
4063   }
4064   if( isAgg && pSub->pOrderBy ) return 0;                /* Restriction (16) */
4065   if( pSub->pLimit && p->pWhere ) return 0;              /* Restriction (19) */
4066   if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
4067      return 0;         /* Restriction (21) */
4068   }
4069   if( pSub->selFlags & (SF_Recursive) ){
4070     return 0; /* Restrictions (22) */
4071   }
4072 
4073   /*
4074   ** If the subquery is the right operand of a LEFT JOIN, then the
4075   ** subquery may not be a join itself (3a). Example of why this is not
4076   ** allowed:
4077   **
4078   **         t1 LEFT OUTER JOIN (t2 JOIN t3)
4079   **
4080   ** If we flatten the above, we would get
4081   **
4082   **         (t1 LEFT OUTER JOIN t2) JOIN t3
4083   **
4084   ** which is not at all the same thing.
4085   **
4086   ** If the subquery is the right operand of a LEFT JOIN, then the outer
4087   ** query cannot be an aggregate. (3c)  This is an artifact of the way
4088   ** aggregates are processed - there is no mechanism to determine if
4089   ** the LEFT JOIN table should be all-NULL.
4090   **
4091   ** See also tickets #306, #350, and #3300.
4092   */
4093   if( (pSubitem->fg.jointype & JT_OUTER)!=0 ){
4094     isLeftJoin = 1;
4095     if( pSubSrc->nSrc>1                   /* (3a) */
4096      || isAgg                             /* (3b) */
4097      || IsVirtual(pSubSrc->a[0].pTab)     /* (3c) */
4098      || (p->selFlags & SF_Distinct)!=0    /* (3d) */
4099     ){
4100       return 0;
4101     }
4102   }
4103 #ifdef SQLITE_EXTRA_IFNULLROW
4104   else if( iFrom>0 && !isAgg ){
4105     /* Setting isLeftJoin to -1 causes OP_IfNullRow opcodes to be generated for
4106     ** every reference to any result column from subquery in a join, even
4107     ** though they are not necessary.  This will stress-test the OP_IfNullRow
4108     ** opcode. */
4109     isLeftJoin = -1;
4110   }
4111 #endif
4112 
4113   /* Restriction (17): If the sub-query is a compound SELECT, then it must
4114   ** use only the UNION ALL operator. And none of the simple select queries
4115   ** that make up the compound SELECT are allowed to be aggregate or distinct
4116   ** queries.
4117   */
4118   if( pSub->pPrior ){
4119     if( pSub->pOrderBy ){
4120       return 0;  /* Restriction (20) */
4121     }
4122     if( isAgg || (p->selFlags & SF_Distinct)!=0 || isLeftJoin>0 ){
4123       return 0; /* (17d1), (17d2), or (17f) */
4124     }
4125     for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
4126       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
4127       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
4128       assert( pSub->pSrc!=0 );
4129       assert( (pSub->selFlags & SF_Recursive)==0 );
4130       assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
4131       if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0    /* (17b) */
4132        || (pSub1->pPrior && pSub1->op!=TK_ALL)                 /* (17a) */
4133        || pSub1->pSrc->nSrc<1                                  /* (17c) */
4134 #ifndef SQLITE_OMIT_WINDOWFUNC
4135        || pSub1->pWin                                          /* (17e) */
4136 #endif
4137       ){
4138         return 0;
4139       }
4140       testcase( pSub1->pSrc->nSrc>1 );
4141     }
4142 
4143     /* Restriction (18). */
4144     if( p->pOrderBy ){
4145       int ii;
4146       for(ii=0; ii<p->pOrderBy->nExpr; ii++){
4147         if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
4148       }
4149     }
4150 
4151     /* Restriction (23) */
4152     if( (p->selFlags & SF_Recursive) ) return 0;
4153 
4154     if( pSrc->nSrc>1 ){
4155       if( pParse->nSelect>500 ) return 0;
4156       aCsrMap = sqlite3DbMallocZero(db, (pParse->nTab+1)*sizeof(int));
4157       if( aCsrMap ) aCsrMap[0] = pParse->nTab;
4158     }
4159   }
4160 
4161   /***** If we reach this point, flattening is permitted. *****/
4162   SELECTTRACE(1,pParse,p,("flatten %u.%p from term %d\n",
4163                    pSub->selId, pSub, iFrom));
4164 
4165   /* Authorize the subquery */
4166   pParse->zAuthContext = pSubitem->zName;
4167   TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
4168   testcase( i==SQLITE_DENY );
4169   pParse->zAuthContext = zSavedAuthContext;
4170 
4171   /* Delete the transient structures associated with thesubquery */
4172   pSub1 = pSubitem->pSelect;
4173   sqlite3DbFree(db, pSubitem->zDatabase);
4174   sqlite3DbFree(db, pSubitem->zName);
4175   sqlite3DbFree(db, pSubitem->zAlias);
4176   pSubitem->zDatabase = 0;
4177   pSubitem->zName = 0;
4178   pSubitem->zAlias = 0;
4179   pSubitem->pSelect = 0;
4180   assert( pSubitem->pOn==0 );
4181 
4182   /* If the sub-query is a compound SELECT statement, then (by restrictions
4183   ** 17 and 18 above) it must be a UNION ALL and the parent query must
4184   ** be of the form:
4185   **
4186   **     SELECT <expr-list> FROM (<sub-query>) <where-clause>
4187   **
4188   ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
4189   ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
4190   ** OFFSET clauses and joins them to the left-hand-side of the original
4191   ** using UNION ALL operators. In this case N is the number of simple
4192   ** select statements in the compound sub-query.
4193   **
4194   ** Example:
4195   **
4196   **     SELECT a+1 FROM (
4197   **        SELECT x FROM tab
4198   **        UNION ALL
4199   **        SELECT y FROM tab
4200   **        UNION ALL
4201   **        SELECT abs(z*2) FROM tab2
4202   **     ) WHERE a!=5 ORDER BY 1
4203   **
4204   ** Transformed into:
4205   **
4206   **     SELECT x+1 FROM tab WHERE x+1!=5
4207   **     UNION ALL
4208   **     SELECT y+1 FROM tab WHERE y+1!=5
4209   **     UNION ALL
4210   **     SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
4211   **     ORDER BY 1
4212   **
4213   ** We call this the "compound-subquery flattening".
4214   */
4215   for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
4216     Select *pNew;
4217     ExprList *pOrderBy = p->pOrderBy;
4218     Expr *pLimit = p->pLimit;
4219     Select *pPrior = p->pPrior;
4220     Table *pItemTab = pSubitem->pTab;
4221     pSubitem->pTab = 0;
4222     p->pOrderBy = 0;
4223     p->pPrior = 0;
4224     p->pLimit = 0;
4225     pNew = sqlite3SelectDup(db, p, 0);
4226     p->pLimit = pLimit;
4227     p->pOrderBy = pOrderBy;
4228     p->op = TK_ALL;
4229     pSubitem->pTab = pItemTab;
4230     if( pNew==0 ){
4231       p->pPrior = pPrior;
4232     }else{
4233       pNew->selId = ++pParse->nSelect;
4234       if( aCsrMap && ALWAYS(db->mallocFailed==0) ){
4235         renumberCursors(pParse, pNew, iFrom, aCsrMap);
4236       }
4237       pNew->pPrior = pPrior;
4238       if( pPrior ) pPrior->pNext = pNew;
4239       pNew->pNext = p;
4240       p->pPrior = pNew;
4241       SELECTTRACE(2,pParse,p,("compound-subquery flattener"
4242                               " creates %u as peer\n",pNew->selId));
4243     }
4244     assert( pSubitem->pSelect==0 );
4245   }
4246   sqlite3DbFree(db, aCsrMap);
4247   if( db->mallocFailed ){
4248     pSubitem->pSelect = pSub1;
4249     return 1;
4250   }
4251 
4252   /* Defer deleting the Table object associated with the
4253   ** subquery until code generation is
4254   ** complete, since there may still exist Expr.pTab entries that
4255   ** refer to the subquery even after flattening.  Ticket #3346.
4256   **
4257   ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
4258   */
4259   if( ALWAYS(pSubitem->pTab!=0) ){
4260     Table *pTabToDel = pSubitem->pTab;
4261     if( pTabToDel->nTabRef==1 ){
4262       Parse *pToplevel = sqlite3ParseToplevel(pParse);
4263       sqlite3ParserAddCleanup(pToplevel,
4264          (void(*)(sqlite3*,void*))sqlite3DeleteTable,
4265          pTabToDel);
4266       testcase( pToplevel->earlyCleanup );
4267     }else{
4268       pTabToDel->nTabRef--;
4269     }
4270     pSubitem->pTab = 0;
4271   }
4272 
4273   /* The following loop runs once for each term in a compound-subquery
4274   ** flattening (as described above).  If we are doing a different kind
4275   ** of flattening - a flattening other than a compound-subquery flattening -
4276   ** then this loop only runs once.
4277   **
4278   ** This loop moves all of the FROM elements of the subquery into the
4279   ** the FROM clause of the outer query.  Before doing this, remember
4280   ** the cursor number for the original outer query FROM element in
4281   ** iParent.  The iParent cursor will never be used.  Subsequent code
4282   ** will scan expressions looking for iParent references and replace
4283   ** those references with expressions that resolve to the subquery FROM
4284   ** elements we are now copying in.
4285   */
4286   pSub = pSub1;
4287   for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
4288     int nSubSrc;
4289     u8 jointype = 0;
4290     assert( pSub!=0 );
4291     pSubSrc = pSub->pSrc;     /* FROM clause of subquery */
4292     nSubSrc = pSubSrc->nSrc;  /* Number of terms in subquery FROM clause */
4293     pSrc = pParent->pSrc;     /* FROM clause of the outer query */
4294 
4295     if( pParent==p ){
4296       jointype = pSubitem->fg.jointype;     /* First time through the loop */
4297     }
4298 
4299     /* The subquery uses a single slot of the FROM clause of the outer
4300     ** query.  If the subquery has more than one element in its FROM clause,
4301     ** then expand the outer query to make space for it to hold all elements
4302     ** of the subquery.
4303     **
4304     ** Example:
4305     **
4306     **    SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
4307     **
4308     ** The outer query has 3 slots in its FROM clause.  One slot of the
4309     ** outer query (the middle slot) is used by the subquery.  The next
4310     ** block of code will expand the outer query FROM clause to 4 slots.
4311     ** The middle slot is expanded to two slots in order to make space
4312     ** for the two elements in the FROM clause of the subquery.
4313     */
4314     if( nSubSrc>1 ){
4315       pSrc = sqlite3SrcListEnlarge(pParse, pSrc, nSubSrc-1,iFrom+1);
4316       if( pSrc==0 ) break;
4317       pParent->pSrc = pSrc;
4318     }
4319 
4320     /* Transfer the FROM clause terms from the subquery into the
4321     ** outer query.
4322     */
4323     for(i=0; i<nSubSrc; i++){
4324       sqlite3IdListDelete(db, pSrc->a[i+iFrom].pUsing);
4325       assert( pSrc->a[i+iFrom].fg.isTabFunc==0 );
4326       pSrc->a[i+iFrom] = pSubSrc->a[i];
4327       iNewParent = pSubSrc->a[i].iCursor;
4328       memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
4329     }
4330     pSrc->a[iFrom].fg.jointype = jointype;
4331 
4332     /* Now begin substituting subquery result set expressions for
4333     ** references to the iParent in the outer query.
4334     **
4335     ** Example:
4336     **
4337     **   SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
4338     **   \                     \_____________ subquery __________/          /
4339     **    \_____________________ outer query ______________________________/
4340     **
4341     ** We look at every expression in the outer query and every place we see
4342     ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
4343     */
4344     if( pSub->pOrderBy && (pParent->selFlags & SF_NoopOrderBy)==0 ){
4345       /* At this point, any non-zero iOrderByCol values indicate that the
4346       ** ORDER BY column expression is identical to the iOrderByCol'th
4347       ** expression returned by SELECT statement pSub. Since these values
4348       ** do not necessarily correspond to columns in SELECT statement pParent,
4349       ** zero them before transfering the ORDER BY clause.
4350       **
4351       ** Not doing this may cause an error if a subsequent call to this
4352       ** function attempts to flatten a compound sub-query into pParent
4353       ** (the only way this can happen is if the compound sub-query is
4354       ** currently part of pSub->pSrc). See ticket [d11a6e908f].  */
4355       ExprList *pOrderBy = pSub->pOrderBy;
4356       for(i=0; i<pOrderBy->nExpr; i++){
4357         pOrderBy->a[i].u.x.iOrderByCol = 0;
4358       }
4359       assert( pParent->pOrderBy==0 );
4360       pParent->pOrderBy = pOrderBy;
4361       pSub->pOrderBy = 0;
4362     }
4363     pWhere = pSub->pWhere;
4364     pSub->pWhere = 0;
4365     if( isLeftJoin>0 ){
4366       sqlite3SetJoinExpr(pWhere, iNewParent);
4367     }
4368     if( pWhere ){
4369       if( pParent->pWhere ){
4370         pParent->pWhere = sqlite3PExpr(pParse, TK_AND, pWhere, pParent->pWhere);
4371       }else{
4372         pParent->pWhere = pWhere;
4373       }
4374     }
4375     if( db->mallocFailed==0 ){
4376       SubstContext x;
4377       x.pParse = pParse;
4378       x.iTable = iParent;
4379       x.iNewTable = iNewParent;
4380       x.isLeftJoin = isLeftJoin;
4381       x.pEList = pSub->pEList;
4382       substSelect(&x, pParent, 0);
4383     }
4384 
4385     /* The flattened query is a compound if either the inner or the
4386     ** outer query is a compound. */
4387     pParent->selFlags |= pSub->selFlags & SF_Compound;
4388     assert( (pSub->selFlags & SF_Distinct)==0 ); /* restriction (17b) */
4389 
4390     /*
4391     ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
4392     **
4393     ** One is tempted to try to add a and b to combine the limits.  But this
4394     ** does not work if either limit is negative.
4395     */
4396     if( pSub->pLimit ){
4397       pParent->pLimit = pSub->pLimit;
4398       pSub->pLimit = 0;
4399     }
4400 
4401     /* Recompute the SrcList_item.colUsed masks for the flattened
4402     ** tables. */
4403     for(i=0; i<nSubSrc; i++){
4404       recomputeColumnsUsed(pParent, &pSrc->a[i+iFrom]);
4405     }
4406   }
4407 
4408   /* Finially, delete what is left of the subquery and return
4409   ** success.
4410   */
4411   sqlite3AggInfoPersistWalkerInit(&w, pParse);
4412   sqlite3WalkSelect(&w,pSub1);
4413   sqlite3SelectDelete(db, pSub1);
4414 
4415 #if SELECTTRACE_ENABLED
4416   if( sqlite3SelectTrace & 0x100 ){
4417     SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
4418     sqlite3TreeViewSelect(0, p, 0);
4419   }
4420 #endif
4421 
4422   return 1;
4423 }
4424 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4425 
4426 /*
4427 ** A structure to keep track of all of the column values that are fixed to
4428 ** a known value due to WHERE clause constraints of the form COLUMN=VALUE.
4429 */
4430 typedef struct WhereConst WhereConst;
4431 struct WhereConst {
4432   Parse *pParse;   /* Parsing context */
4433   u8 *pOomFault;   /* Pointer to pParse->db->mallocFailed */
4434   int nConst;      /* Number for COLUMN=CONSTANT terms */
4435   int nChng;       /* Number of times a constant is propagated */
4436   int bHasAffBlob; /* At least one column in apExpr[] as affinity BLOB */
4437   Expr **apExpr;   /* [i*2] is COLUMN and [i*2+1] is VALUE */
4438 };
4439 
4440 /*
4441 ** Add a new entry to the pConst object.  Except, do not add duplicate
4442 ** pColumn entires.  Also, do not add if doing so would not be appropriate.
4443 **
4444 ** The caller guarantees the pColumn is a column and pValue is a constant.
4445 ** This routine has to do some additional checks before completing the
4446 ** insert.
4447 */
4448 static void constInsert(
4449   WhereConst *pConst,  /* The WhereConst into which we are inserting */
4450   Expr *pColumn,       /* The COLUMN part of the constraint */
4451   Expr *pValue,        /* The VALUE part of the constraint */
4452   Expr *pExpr          /* Overall expression: COLUMN=VALUE or VALUE=COLUMN */
4453 ){
4454   int i;
4455   assert( pColumn->op==TK_COLUMN );
4456   assert( sqlite3ExprIsConstant(pValue) );
4457 
4458   if( ExprHasProperty(pColumn, EP_FixedCol) ) return;
4459   if( sqlite3ExprAffinity(pValue)!=0 ) return;
4460   if( !sqlite3IsBinary(sqlite3ExprCompareCollSeq(pConst->pParse,pExpr)) ){
4461     return;
4462   }
4463 
4464   /* 2018-10-25 ticket [cf5ed20f]
4465   ** Make sure the same pColumn is not inserted more than once */
4466   for(i=0; i<pConst->nConst; i++){
4467     const Expr *pE2 = pConst->apExpr[i*2];
4468     assert( pE2->op==TK_COLUMN );
4469     if( pE2->iTable==pColumn->iTable
4470      && pE2->iColumn==pColumn->iColumn
4471     ){
4472       return;  /* Already present.  Return without doing anything. */
4473     }
4474   }
4475   if( sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4476     pConst->bHasAffBlob = 1;
4477   }
4478 
4479   pConst->nConst++;
4480   pConst->apExpr = sqlite3DbReallocOrFree(pConst->pParse->db, pConst->apExpr,
4481                          pConst->nConst*2*sizeof(Expr*));
4482   if( pConst->apExpr==0 ){
4483     pConst->nConst = 0;
4484   }else{
4485     pConst->apExpr[pConst->nConst*2-2] = pColumn;
4486     pConst->apExpr[pConst->nConst*2-1] = pValue;
4487   }
4488 }
4489 
4490 /*
4491 ** Find all terms of COLUMN=VALUE or VALUE=COLUMN in pExpr where VALUE
4492 ** is a constant expression and where the term must be true because it
4493 ** is part of the AND-connected terms of the expression.  For each term
4494 ** found, add it to the pConst structure.
4495 */
4496 static void findConstInWhere(WhereConst *pConst, Expr *pExpr){
4497   Expr *pRight, *pLeft;
4498   if( NEVER(pExpr==0) ) return;
4499   if( ExprHasProperty(pExpr, EP_FromJoin) ) return;
4500   if( pExpr->op==TK_AND ){
4501     findConstInWhere(pConst, pExpr->pRight);
4502     findConstInWhere(pConst, pExpr->pLeft);
4503     return;
4504   }
4505   if( pExpr->op!=TK_EQ ) return;
4506   pRight = pExpr->pRight;
4507   pLeft = pExpr->pLeft;
4508   assert( pRight!=0 );
4509   assert( pLeft!=0 );
4510   if( pRight->op==TK_COLUMN && sqlite3ExprIsConstant(pLeft) ){
4511     constInsert(pConst,pRight,pLeft,pExpr);
4512   }
4513   if( pLeft->op==TK_COLUMN && sqlite3ExprIsConstant(pRight) ){
4514     constInsert(pConst,pLeft,pRight,pExpr);
4515   }
4516 }
4517 
4518 /*
4519 ** This is a helper function for Walker callback propagateConstantExprRewrite().
4520 **
4521 ** Argument pExpr is a candidate expression to be replaced by a value. If
4522 ** pExpr is equivalent to one of the columns named in pWalker->u.pConst,
4523 ** then overwrite it with the corresponding value. Except, do not do so
4524 ** if argument bIgnoreAffBlob is non-zero and the affinity of pExpr
4525 ** is SQLITE_AFF_BLOB.
4526 */
4527 static int propagateConstantExprRewriteOne(
4528   WhereConst *pConst,
4529   Expr *pExpr,
4530   int bIgnoreAffBlob
4531 ){
4532   int i;
4533   if( pConst->pOomFault[0] ) return WRC_Prune;
4534   if( pExpr->op!=TK_COLUMN ) return WRC_Continue;
4535   if( ExprHasProperty(pExpr, EP_FixedCol|EP_FromJoin) ){
4536     testcase( ExprHasProperty(pExpr, EP_FixedCol) );
4537     testcase( ExprHasProperty(pExpr, EP_FromJoin) );
4538     return WRC_Continue;
4539   }
4540   for(i=0; i<pConst->nConst; i++){
4541     Expr *pColumn = pConst->apExpr[i*2];
4542     if( pColumn==pExpr ) continue;
4543     if( pColumn->iTable!=pExpr->iTable ) continue;
4544     if( pColumn->iColumn!=pExpr->iColumn ) continue;
4545     if( bIgnoreAffBlob && sqlite3ExprAffinity(pColumn)==SQLITE_AFF_BLOB ){
4546       break;
4547     }
4548     /* A match is found.  Add the EP_FixedCol property */
4549     pConst->nChng++;
4550     ExprClearProperty(pExpr, EP_Leaf);
4551     ExprSetProperty(pExpr, EP_FixedCol);
4552     assert( pExpr->pLeft==0 );
4553     pExpr->pLeft = sqlite3ExprDup(pConst->pParse->db, pConst->apExpr[i*2+1], 0);
4554     if( pConst->pParse->db->mallocFailed ) return WRC_Prune;
4555     break;
4556   }
4557   return WRC_Prune;
4558 }
4559 
4560 /*
4561 ** This is a Walker expression callback. pExpr is a node from the WHERE
4562 ** clause of a SELECT statement. This function examines pExpr to see if
4563 ** any substitutions based on the contents of pWalker->u.pConst should
4564 ** be made to pExpr or its immediate children.
4565 **
4566 ** A substitution is made if:
4567 **
4568 **   + pExpr is a column with an affinity other than BLOB that matches
4569 **     one of the columns in pWalker->u.pConst, or
4570 **
4571 **   + pExpr is a binary comparison operator (=, <=, >=, <, >) that
4572 **     uses an affinity other than TEXT and one of its immediate
4573 **     children is a column that matches one of the columns in
4574 **     pWalker->u.pConst.
4575 */
4576 static int propagateConstantExprRewrite(Walker *pWalker, Expr *pExpr){
4577   WhereConst *pConst = pWalker->u.pConst;
4578   assert( TK_GT==TK_EQ+1 );
4579   assert( TK_LE==TK_EQ+2 );
4580   assert( TK_LT==TK_EQ+3 );
4581   assert( TK_GE==TK_EQ+4 );
4582   if( pConst->bHasAffBlob ){
4583     if( (pExpr->op>=TK_EQ && pExpr->op<=TK_GE)
4584      || pExpr->op==TK_IS
4585     ){
4586       propagateConstantExprRewriteOne(pConst, pExpr->pLeft, 0);
4587       if( pConst->pOomFault[0] ) return WRC_Prune;
4588       if( sqlite3ExprAffinity(pExpr->pLeft)!=SQLITE_AFF_TEXT ){
4589         propagateConstantExprRewriteOne(pConst, pExpr->pRight, 0);
4590       }
4591     }
4592   }
4593   return propagateConstantExprRewriteOne(pConst, pExpr, pConst->bHasAffBlob);
4594 }
4595 
4596 /*
4597 ** The WHERE-clause constant propagation optimization.
4598 **
4599 ** If the WHERE clause contains terms of the form COLUMN=CONSTANT or
4600 ** CONSTANT=COLUMN that are top-level AND-connected terms that are not
4601 ** part of a ON clause from a LEFT JOIN, then throughout the query
4602 ** replace all other occurrences of COLUMN with CONSTANT.
4603 **
4604 ** For example, the query:
4605 **
4606 **      SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=t1.a AND t3.c=t2.b
4607 **
4608 ** Is transformed into
4609 **
4610 **      SELECT * FROM t1, t2, t3 WHERE t1.a=39 AND t2.b=39 AND t3.c=39
4611 **
4612 ** Return true if any transformations where made and false if not.
4613 **
4614 ** Implementation note:  Constant propagation is tricky due to affinity
4615 ** and collating sequence interactions.  Consider this example:
4616 **
4617 **    CREATE TABLE t1(a INT,b TEXT);
4618 **    INSERT INTO t1 VALUES(123,'0123');
4619 **    SELECT * FROM t1 WHERE a=123 AND b=a;
4620 **    SELECT * FROM t1 WHERE a=123 AND b=123;
4621 **
4622 ** The two SELECT statements above should return different answers.  b=a
4623 ** is alway true because the comparison uses numeric affinity, but b=123
4624 ** is false because it uses text affinity and '0123' is not the same as '123'.
4625 ** To work around this, the expression tree is not actually changed from
4626 ** "b=a" to "b=123" but rather the "a" in "b=a" is tagged with EP_FixedCol
4627 ** and the "123" value is hung off of the pLeft pointer.  Code generator
4628 ** routines know to generate the constant "123" instead of looking up the
4629 ** column value.  Also, to avoid collation problems, this optimization is
4630 ** only attempted if the "a=123" term uses the default BINARY collation.
4631 **
4632 ** 2021-05-25 forum post 6a06202608: Another troublesome case is...
4633 **
4634 **    CREATE TABLE t1(x);
4635 **    INSERT INTO t1 VALUES(10.0);
4636 **    SELECT 1 FROM t1 WHERE x=10 AND x LIKE 10;
4637 **
4638 ** The query should return no rows, because the t1.x value is '10.0' not '10'
4639 ** and '10.0' is not LIKE '10'.  But if we are not careful, the first WHERE
4640 ** term "x=10" will cause the second WHERE term to become "10 LIKE 10",
4641 ** resulting in a false positive.  To avoid this, constant propagation for
4642 ** columns with BLOB affinity is only allowed if the constant is used with
4643 ** operators ==, <=, <, >=, >, or IS in a way that will cause the correct
4644 ** type conversions to occur.  See logic associated with the bHasAffBlob flag
4645 ** for details.
4646 */
4647 static int propagateConstants(
4648   Parse *pParse,   /* The parsing context */
4649   Select *p        /* The query in which to propagate constants */
4650 ){
4651   WhereConst x;
4652   Walker w;
4653   int nChng = 0;
4654   x.pParse = pParse;
4655   x.pOomFault = &pParse->db->mallocFailed;
4656   do{
4657     x.nConst = 0;
4658     x.nChng = 0;
4659     x.apExpr = 0;
4660     x.bHasAffBlob = 0;
4661     findConstInWhere(&x, p->pWhere);
4662     if( x.nConst ){
4663       memset(&w, 0, sizeof(w));
4664       w.pParse = pParse;
4665       w.xExprCallback = propagateConstantExprRewrite;
4666       w.xSelectCallback = sqlite3SelectWalkNoop;
4667       w.xSelectCallback2 = 0;
4668       w.walkerDepth = 0;
4669       w.u.pConst = &x;
4670       sqlite3WalkExpr(&w, p->pWhere);
4671       sqlite3DbFree(x.pParse->db, x.apExpr);
4672       nChng += x.nChng;
4673     }
4674   }while( x.nChng );
4675   return nChng;
4676 }
4677 
4678 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4679 # if !defined(SQLITE_OMIT_WINDOWFUNC)
4680 /*
4681 ** This function is called to determine whether or not it is safe to
4682 ** push WHERE clause expression pExpr down to FROM clause sub-query
4683 ** pSubq, which contains at least one window function. Return 1
4684 ** if it is safe and the expression should be pushed down, or 0
4685 ** otherwise.
4686 **
4687 ** It is only safe to push the expression down if it consists only
4688 ** of constants and copies of expressions that appear in the PARTITION
4689 ** BY clause of all window function used by the sub-query. It is safe
4690 ** to filter out entire partitions, but not rows within partitions, as
4691 ** this may change the results of the window functions.
4692 **
4693 ** At the time this function is called it is guaranteed that
4694 **
4695 **   * the sub-query uses only one distinct window frame, and
4696 **   * that the window frame has a PARTITION BY clase.
4697 */
4698 static int pushDownWindowCheck(Parse *pParse, Select *pSubq, Expr *pExpr){
4699   assert( pSubq->pWin->pPartition );
4700   assert( (pSubq->selFlags & SF_MultiPart)==0 );
4701   assert( pSubq->pPrior==0 );
4702   return sqlite3ExprIsConstantOrGroupBy(pParse, pExpr, pSubq->pWin->pPartition);
4703 }
4704 # endif /* SQLITE_OMIT_WINDOWFUNC */
4705 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4706 
4707 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
4708 /*
4709 ** Make copies of relevant WHERE clause terms of the outer query into
4710 ** the WHERE clause of subquery.  Example:
4711 **
4712 **    SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
4713 **
4714 ** Transformed into:
4715 **
4716 **    SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
4717 **     WHERE x=5 AND y=10;
4718 **
4719 ** The hope is that the terms added to the inner query will make it more
4720 ** efficient.
4721 **
4722 ** Do not attempt this optimization if:
4723 **
4724 **   (1) (** This restriction was removed on 2017-09-29.  We used to
4725 **           disallow this optimization for aggregate subqueries, but now
4726 **           it is allowed by putting the extra terms on the HAVING clause.
4727 **           The added HAVING clause is pointless if the subquery lacks
4728 **           a GROUP BY clause.  But such a HAVING clause is also harmless
4729 **           so there does not appear to be any reason to add extra logic
4730 **           to suppress it. **)
4731 **
4732 **   (2) The inner query is the recursive part of a common table expression.
4733 **
4734 **   (3) The inner query has a LIMIT clause (since the changes to the WHERE
4735 **       clause would change the meaning of the LIMIT).
4736 **
4737 **   (4) The inner query is the right operand of a LEFT JOIN and the
4738 **       expression to be pushed down does not come from the ON clause
4739 **       on that LEFT JOIN.
4740 **
4741 **   (5) The WHERE clause expression originates in the ON or USING clause
4742 **       of a LEFT JOIN where iCursor is not the right-hand table of that
4743 **       left join.  An example:
4744 **
4745 **           SELECT *
4746 **           FROM (SELECT 1 AS a1 UNION ALL SELECT 2) AS aa
4747 **           JOIN (SELECT 1 AS b2 UNION ALL SELECT 2) AS bb ON (a1=b2)
4748 **           LEFT JOIN (SELECT 8 AS c3 UNION ALL SELECT 9) AS cc ON (b2=2);
4749 **
4750 **       The correct answer is three rows:  (1,1,NULL),(2,2,8),(2,2,9).
4751 **       But if the (b2=2) term were to be pushed down into the bb subquery,
4752 **       then the (1,1,NULL) row would be suppressed.
4753 **
4754 **   (6) Window functions make things tricky as changes to the WHERE clause
4755 **       of the inner query could change the window over which window
4756 **       functions are calculated. Therefore, do not attempt the optimization
4757 **       if:
4758 **
4759 **     (6a) The inner query uses multiple incompatible window partitions.
4760 **
4761 **     (6b) The inner query is a compound and uses window-functions.
4762 **
4763 **     (6c) The WHERE clause does not consist entirely of constants and
4764 **          copies of expressions found in the PARTITION BY clause of
4765 **          all window-functions used by the sub-query. It is safe to
4766 **          filter out entire partitions, as this does not change the
4767 **          window over which any window-function is calculated.
4768 **
4769 **   (7) The inner query is a Common Table Expression (CTE) that should
4770 **       be materialized.  (This restriction is implemented in the calling
4771 **       routine.)
4772 **
4773 ** Return 0 if no changes are made and non-zero if one or more WHERE clause
4774 ** terms are duplicated into the subquery.
4775 */
4776 static int pushDownWhereTerms(
4777   Parse *pParse,        /* Parse context (for malloc() and error reporting) */
4778   Select *pSubq,        /* The subquery whose WHERE clause is to be augmented */
4779   Expr *pWhere,         /* The WHERE clause of the outer query */
4780   int iCursor,          /* Cursor number of the subquery */
4781   int isLeftJoin        /* True if pSubq is the right term of a LEFT JOIN */
4782 ){
4783   Expr *pNew;
4784   int nChng = 0;
4785   if( pWhere==0 ) return 0;
4786   if( pSubq->selFlags & (SF_Recursive|SF_MultiPart) ) return 0;
4787 
4788 #ifndef SQLITE_OMIT_WINDOWFUNC
4789   if( pSubq->pPrior ){
4790     Select *pSel;
4791     for(pSel=pSubq; pSel; pSel=pSel->pPrior){
4792       if( pSel->pWin ) return 0;    /* restriction (6b) */
4793     }
4794   }else{
4795     if( pSubq->pWin && pSubq->pWin->pPartition==0 ) return 0;
4796   }
4797 #endif
4798 
4799 #ifdef SQLITE_DEBUG
4800   /* Only the first term of a compound can have a WITH clause.  But make
4801   ** sure no other terms are marked SF_Recursive in case something changes
4802   ** in the future.
4803   */
4804   {
4805     Select *pX;
4806     for(pX=pSubq; pX; pX=pX->pPrior){
4807       assert( (pX->selFlags & (SF_Recursive))==0 );
4808     }
4809   }
4810 #endif
4811 
4812   if( pSubq->pLimit!=0 ){
4813     return 0; /* restriction (3) */
4814   }
4815   while( pWhere->op==TK_AND ){
4816     nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight,
4817                                 iCursor, isLeftJoin);
4818     pWhere = pWhere->pLeft;
4819   }
4820   if( isLeftJoin
4821    && (ExprHasProperty(pWhere,EP_FromJoin)==0
4822          || pWhere->iRightJoinTable!=iCursor)
4823   ){
4824     return 0; /* restriction (4) */
4825   }
4826   if( ExprHasProperty(pWhere,EP_FromJoin) && pWhere->iRightJoinTable!=iCursor ){
4827     return 0; /* restriction (5) */
4828   }
4829   if( sqlite3ExprIsTableConstant(pWhere, iCursor) ){
4830     nChng++;
4831     pSubq->selFlags |= SF_PushDown;
4832     while( pSubq ){
4833       SubstContext x;
4834       pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
4835       unsetJoinExpr(pNew, -1);
4836       x.pParse = pParse;
4837       x.iTable = iCursor;
4838       x.iNewTable = iCursor;
4839       x.isLeftJoin = 0;
4840       x.pEList = pSubq->pEList;
4841       pNew = substExpr(&x, pNew);
4842 #ifndef SQLITE_OMIT_WINDOWFUNC
4843       if( pSubq->pWin && 0==pushDownWindowCheck(pParse, pSubq, pNew) ){
4844         /* Restriction 6c has prevented push-down in this case */
4845         sqlite3ExprDelete(pParse->db, pNew);
4846         nChng--;
4847         break;
4848       }
4849 #endif
4850       if( pSubq->selFlags & SF_Aggregate ){
4851         pSubq->pHaving = sqlite3ExprAnd(pParse, pSubq->pHaving, pNew);
4852       }else{
4853         pSubq->pWhere = sqlite3ExprAnd(pParse, pSubq->pWhere, pNew);
4854       }
4855       pSubq = pSubq->pPrior;
4856     }
4857   }
4858   return nChng;
4859 }
4860 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
4861 
4862 /*
4863 ** The pFunc is the only aggregate function in the query.  Check to see
4864 ** if the query is a candidate for the min/max optimization.
4865 **
4866 ** If the query is a candidate for the min/max optimization, then set
4867 ** *ppMinMax to be an ORDER BY clause to be used for the optimization
4868 ** and return either WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX depending on
4869 ** whether pFunc is a min() or max() function.
4870 **
4871 ** If the query is not a candidate for the min/max optimization, return
4872 ** WHERE_ORDERBY_NORMAL (which must be zero).
4873 **
4874 ** This routine must be called after aggregate functions have been
4875 ** located but before their arguments have been subjected to aggregate
4876 ** analysis.
4877 */
4878 static u8 minMaxQuery(sqlite3 *db, Expr *pFunc, ExprList **ppMinMax){
4879   int eRet = WHERE_ORDERBY_NORMAL;      /* Return value */
4880   ExprList *pEList = pFunc->x.pList;    /* Arguments to agg function */
4881   const char *zFunc;                    /* Name of aggregate function pFunc */
4882   ExprList *pOrderBy;
4883   u8 sortFlags = 0;
4884 
4885   assert( *ppMinMax==0 );
4886   assert( pFunc->op==TK_AGG_FUNCTION );
4887   assert( !IsWindowFunc(pFunc) );
4888   if( pEList==0
4889    || pEList->nExpr!=1
4890    || ExprHasProperty(pFunc, EP_WinFunc)
4891    || OptimizationDisabled(db, SQLITE_MinMaxOpt)
4892   ){
4893     return eRet;
4894   }
4895   zFunc = pFunc->u.zToken;
4896   if( sqlite3StrICmp(zFunc, "min")==0 ){
4897     eRet = WHERE_ORDERBY_MIN;
4898     if( sqlite3ExprCanBeNull(pEList->a[0].pExpr) ){
4899       sortFlags = KEYINFO_ORDER_BIGNULL;
4900     }
4901   }else if( sqlite3StrICmp(zFunc, "max")==0 ){
4902     eRet = WHERE_ORDERBY_MAX;
4903     sortFlags = KEYINFO_ORDER_DESC;
4904   }else{
4905     return eRet;
4906   }
4907   *ppMinMax = pOrderBy = sqlite3ExprListDup(db, pEList, 0);
4908   assert( pOrderBy!=0 || db->mallocFailed );
4909   if( pOrderBy ) pOrderBy->a[0].sortFlags = sortFlags;
4910   return eRet;
4911 }
4912 
4913 /*
4914 ** The select statement passed as the first argument is an aggregate query.
4915 ** The second argument is the associated aggregate-info object. This
4916 ** function tests if the SELECT is of the form:
4917 **
4918 **   SELECT count(*) FROM <tbl>
4919 **
4920 ** where table is a database table, not a sub-select or view. If the query
4921 ** does match this pattern, then a pointer to the Table object representing
4922 ** <tbl> is returned. Otherwise, 0 is returned.
4923 */
4924 static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
4925   Table *pTab;
4926   Expr *pExpr;
4927 
4928   assert( !p->pGroupBy );
4929 
4930   if( p->pWhere || p->pEList->nExpr!=1
4931    || p->pSrc->nSrc!=1 || p->pSrc->a[0].pSelect
4932   ){
4933     return 0;
4934   }
4935   pTab = p->pSrc->a[0].pTab;
4936   pExpr = p->pEList->a[0].pExpr;
4937   assert( pTab && !IsView(pTab) && pExpr );
4938 
4939   if( IsVirtual(pTab) ) return 0;
4940   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
4941   if( NEVER(pAggInfo->nFunc==0) ) return 0;
4942   if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
4943   if( ExprHasProperty(pExpr, EP_Distinct|EP_WinFunc) ) return 0;
4944 
4945   return pTab;
4946 }
4947 
4948 /*
4949 ** If the source-list item passed as an argument was augmented with an
4950 ** INDEXED BY clause, then try to locate the specified index. If there
4951 ** was such a clause and the named index cannot be found, return
4952 ** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
4953 ** pFrom->pIndex and return SQLITE_OK.
4954 */
4955 int sqlite3IndexedByLookup(Parse *pParse, SrcItem *pFrom){
4956   Table *pTab = pFrom->pTab;
4957   char *zIndexedBy = pFrom->u1.zIndexedBy;
4958   Index *pIdx;
4959   assert( pTab!=0 );
4960   assert( pFrom->fg.isIndexedBy!=0 );
4961 
4962   for(pIdx=pTab->pIndex;
4963       pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
4964       pIdx=pIdx->pNext
4965   );
4966   if( !pIdx ){
4967     sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
4968     pParse->checkSchema = 1;
4969     return SQLITE_ERROR;
4970   }
4971   pFrom->u2.pIBIndex = pIdx;
4972   return SQLITE_OK;
4973 }
4974 
4975 /*
4976 ** Detect compound SELECT statements that use an ORDER BY clause with
4977 ** an alternative collating sequence.
4978 **
4979 **    SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
4980 **
4981 ** These are rewritten as a subquery:
4982 **
4983 **    SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
4984 **     ORDER BY ... COLLATE ...
4985 **
4986 ** This transformation is necessary because the multiSelectOrderBy() routine
4987 ** above that generates the code for a compound SELECT with an ORDER BY clause
4988 ** uses a merge algorithm that requires the same collating sequence on the
4989 ** result columns as on the ORDER BY clause.  See ticket
4990 ** http://www.sqlite.org/src/info/6709574d2a
4991 **
4992 ** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
4993 ** The UNION ALL operator works fine with multiSelectOrderBy() even when
4994 ** there are COLLATE terms in the ORDER BY.
4995 */
4996 static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
4997   int i;
4998   Select *pNew;
4999   Select *pX;
5000   sqlite3 *db;
5001   struct ExprList_item *a;
5002   SrcList *pNewSrc;
5003   Parse *pParse;
5004   Token dummy;
5005 
5006   if( p->pPrior==0 ) return WRC_Continue;
5007   if( p->pOrderBy==0 ) return WRC_Continue;
5008   for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
5009   if( pX==0 ) return WRC_Continue;
5010   a = p->pOrderBy->a;
5011 #ifndef SQLITE_OMIT_WINDOWFUNC
5012   /* If iOrderByCol is already non-zero, then it has already been matched
5013   ** to a result column of the SELECT statement. This occurs when the
5014   ** SELECT is rewritten for window-functions processing and then passed
5015   ** to sqlite3SelectPrep() and similar a second time. The rewriting done
5016   ** by this function is not required in this case. */
5017   if( a[0].u.x.iOrderByCol ) return WRC_Continue;
5018 #endif
5019   for(i=p->pOrderBy->nExpr-1; i>=0; i--){
5020     if( a[i].pExpr->flags & EP_Collate ) break;
5021   }
5022   if( i<0 ) return WRC_Continue;
5023 
5024   /* If we reach this point, that means the transformation is required. */
5025 
5026   pParse = pWalker->pParse;
5027   db = pParse->db;
5028   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
5029   if( pNew==0 ) return WRC_Abort;
5030   memset(&dummy, 0, sizeof(dummy));
5031   pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0,0);
5032   if( pNewSrc==0 ) return WRC_Abort;
5033   *pNew = *p;
5034   p->pSrc = pNewSrc;
5035   p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
5036   p->op = TK_SELECT;
5037   p->pWhere = 0;
5038   pNew->pGroupBy = 0;
5039   pNew->pHaving = 0;
5040   pNew->pOrderBy = 0;
5041   p->pPrior = 0;
5042   p->pNext = 0;
5043   p->pWith = 0;
5044 #ifndef SQLITE_OMIT_WINDOWFUNC
5045   p->pWinDefn = 0;
5046 #endif
5047   p->selFlags &= ~SF_Compound;
5048   assert( (p->selFlags & SF_Converted)==0 );
5049   p->selFlags |= SF_Converted;
5050   assert( pNew->pPrior!=0 );
5051   pNew->pPrior->pNext = pNew;
5052   pNew->pLimit = 0;
5053   return WRC_Continue;
5054 }
5055 
5056 /*
5057 ** Check to see if the FROM clause term pFrom has table-valued function
5058 ** arguments.  If it does, leave an error message in pParse and return
5059 ** non-zero, since pFrom is not allowed to be a table-valued function.
5060 */
5061 static int cannotBeFunction(Parse *pParse, SrcItem *pFrom){
5062   if( pFrom->fg.isTabFunc ){
5063     sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
5064     return 1;
5065   }
5066   return 0;
5067 }
5068 
5069 #ifndef SQLITE_OMIT_CTE
5070 /*
5071 ** Argument pWith (which may be NULL) points to a linked list of nested
5072 ** WITH contexts, from inner to outermost. If the table identified by
5073 ** FROM clause element pItem is really a common-table-expression (CTE)
5074 ** then return a pointer to the CTE definition for that table. Otherwise
5075 ** return NULL.
5076 **
5077 ** If a non-NULL value is returned, set *ppContext to point to the With
5078 ** object that the returned CTE belongs to.
5079 */
5080 static struct Cte *searchWith(
5081   With *pWith,                    /* Current innermost WITH clause */
5082   SrcItem *pItem,                 /* FROM clause element to resolve */
5083   With **ppContext                /* OUT: WITH clause return value belongs to */
5084 ){
5085   const char *zName = pItem->zName;
5086   With *p;
5087   assert( pItem->zDatabase==0 );
5088   assert( zName!=0 );
5089   for(p=pWith; p; p=p->pOuter){
5090     int i;
5091     for(i=0; i<p->nCte; i++){
5092       if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
5093         *ppContext = p;
5094         return &p->a[i];
5095       }
5096     }
5097     if( p->bView ) break;
5098   }
5099   return 0;
5100 }
5101 
5102 /* The code generator maintains a stack of active WITH clauses
5103 ** with the inner-most WITH clause being at the top of the stack.
5104 **
5105 ** This routine pushes the WITH clause passed as the second argument
5106 ** onto the top of the stack. If argument bFree is true, then this
5107 ** WITH clause will never be popped from the stack but should instead
5108 ** be freed along with the Parse object. In other cases, when
5109 ** bFree==0, the With object will be freed along with the SELECT
5110 ** statement with which it is associated.
5111 **
5112 ** This routine returns a copy of pWith.  Or, if bFree is true and
5113 ** the pWith object is destroyed immediately due to an OOM condition,
5114 ** then this routine return NULL.
5115 **
5116 ** If bFree is true, do not continue to use the pWith pointer after
5117 ** calling this routine,  Instead, use only the return value.
5118 */
5119 With *sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
5120   if( pWith ){
5121     if( bFree ){
5122       pWith = (With*)sqlite3ParserAddCleanup(pParse,
5123                       (void(*)(sqlite3*,void*))sqlite3WithDelete,
5124                       pWith);
5125       if( pWith==0 ) return 0;
5126     }
5127     if( pParse->nErr==0 ){
5128       assert( pParse->pWith!=pWith );
5129       pWith->pOuter = pParse->pWith;
5130       pParse->pWith = pWith;
5131     }
5132   }
5133   return pWith;
5134 }
5135 
5136 /*
5137 ** This function checks if argument pFrom refers to a CTE declared by
5138 ** a WITH clause on the stack currently maintained by the parser (on the
5139 ** pParse->pWith linked list).  And if currently processing a CTE
5140 ** CTE expression, through routine checks to see if the reference is
5141 ** a recursive reference to the CTE.
5142 **
5143 ** If pFrom matches a CTE according to either of these two above, pFrom->pTab
5144 ** and other fields are populated accordingly.
5145 **
5146 ** Return 0 if no match is found.
5147 ** Return 1 if a match is found.
5148 ** Return 2 if an error condition is detected.
5149 */
5150 static int resolveFromTermToCte(
5151   Parse *pParse,                  /* The parsing context */
5152   Walker *pWalker,                /* Current tree walker */
5153   SrcItem *pFrom                  /* The FROM clause term to check */
5154 ){
5155   Cte *pCte;               /* Matched CTE (or NULL if no match) */
5156   With *pWith;             /* The matching WITH */
5157 
5158   assert( pFrom->pTab==0 );
5159   if( pParse->pWith==0 ){
5160     /* There are no WITH clauses in the stack.  No match is possible */
5161     return 0;
5162   }
5163   if( pParse->nErr ){
5164     /* Prior errors might have left pParse->pWith in a goofy state, so
5165     ** go no further. */
5166     return 0;
5167   }
5168   if( pFrom->zDatabase!=0 ){
5169     /* The FROM term contains a schema qualifier (ex: main.t1) and so
5170     ** it cannot possibly be a CTE reference. */
5171     return 0;
5172   }
5173   if( pFrom->fg.notCte ){
5174     /* The FROM term is specifically excluded from matching a CTE.
5175     **   (1)  It is part of a trigger that used to have zDatabase but had
5176     **        zDatabase removed by sqlite3FixTriggerStep().
5177     **   (2)  This is the first term in the FROM clause of an UPDATE.
5178     */
5179     return 0;
5180   }
5181   pCte = searchWith(pParse->pWith, pFrom, &pWith);
5182   if( pCte ){
5183     sqlite3 *db = pParse->db;
5184     Table *pTab;
5185     ExprList *pEList;
5186     Select *pSel;
5187     Select *pLeft;                /* Left-most SELECT statement */
5188     Select *pRecTerm;             /* Left-most recursive term */
5189     int bMayRecursive;            /* True if compound joined by UNION [ALL] */
5190     With *pSavedWith;             /* Initial value of pParse->pWith */
5191     int iRecTab = -1;             /* Cursor for recursive table */
5192     CteUse *pCteUse;
5193 
5194     /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
5195     ** recursive reference to CTE pCte. Leave an error in pParse and return
5196     ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
5197     ** In this case, proceed.  */
5198     if( pCte->zCteErr ){
5199       sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
5200       return 2;
5201     }
5202     if( cannotBeFunction(pParse, pFrom) ) return 2;
5203 
5204     assert( pFrom->pTab==0 );
5205     pTab = sqlite3DbMallocZero(db, sizeof(Table));
5206     if( pTab==0 ) return 2;
5207     pCteUse = pCte->pUse;
5208     if( pCteUse==0 ){
5209       pCte->pUse = pCteUse = sqlite3DbMallocZero(db, sizeof(pCteUse[0]));
5210       if( pCteUse==0
5211        || sqlite3ParserAddCleanup(pParse,sqlite3DbFree,pCteUse)==0
5212       ){
5213         sqlite3DbFree(db, pTab);
5214         return 2;
5215       }
5216       pCteUse->eM10d = pCte->eM10d;
5217     }
5218     pFrom->pTab = pTab;
5219     pTab->nTabRef = 1;
5220     pTab->zName = sqlite3DbStrDup(db, pCte->zName);
5221     pTab->iPKey = -1;
5222     pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
5223     pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5224     pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
5225     if( db->mallocFailed ) return 2;
5226     pFrom->pSelect->selFlags |= SF_CopyCte;
5227     assert( pFrom->pSelect );
5228     pFrom->fg.isCte = 1;
5229     pFrom->u2.pCteUse = pCteUse;
5230     pCteUse->nUse++;
5231     if( pCteUse->nUse>=2 && pCteUse->eM10d==M10d_Any ){
5232       pCteUse->eM10d = M10d_Yes;
5233     }
5234 
5235     /* Check if this is a recursive CTE. */
5236     pRecTerm = pSel = pFrom->pSelect;
5237     bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
5238     while( bMayRecursive && pRecTerm->op==pSel->op ){
5239       int i;
5240       SrcList *pSrc = pRecTerm->pSrc;
5241       assert( pRecTerm->pPrior!=0 );
5242       for(i=0; i<pSrc->nSrc; i++){
5243         SrcItem *pItem = &pSrc->a[i];
5244         if( pItem->zDatabase==0
5245          && pItem->zName!=0
5246          && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
5247         ){
5248           pItem->pTab = pTab;
5249           pTab->nTabRef++;
5250           pItem->fg.isRecursive = 1;
5251           if( pRecTerm->selFlags & SF_Recursive ){
5252             sqlite3ErrorMsg(pParse,
5253                "multiple references to recursive table: %s", pCte->zName
5254             );
5255             return 2;
5256           }
5257           pRecTerm->selFlags |= SF_Recursive;
5258           if( iRecTab<0 ) iRecTab = pParse->nTab++;
5259           pItem->iCursor = iRecTab;
5260         }
5261       }
5262       if( (pRecTerm->selFlags & SF_Recursive)==0 ) break;
5263       pRecTerm = pRecTerm->pPrior;
5264     }
5265 
5266     pCte->zCteErr = "circular reference: %s";
5267     pSavedWith = pParse->pWith;
5268     pParse->pWith = pWith;
5269     if( pSel->selFlags & SF_Recursive ){
5270       int rc;
5271       assert( pRecTerm!=0 );
5272       assert( (pRecTerm->selFlags & SF_Recursive)==0 );
5273       assert( pRecTerm->pNext!=0 );
5274       assert( (pRecTerm->pNext->selFlags & SF_Recursive)!=0 );
5275       assert( pRecTerm->pWith==0 );
5276       pRecTerm->pWith = pSel->pWith;
5277       rc = sqlite3WalkSelect(pWalker, pRecTerm);
5278       pRecTerm->pWith = 0;
5279       if( rc ){
5280         pParse->pWith = pSavedWith;
5281         return 2;
5282       }
5283     }else{
5284       if( sqlite3WalkSelect(pWalker, pSel) ){
5285         pParse->pWith = pSavedWith;
5286         return 2;
5287       }
5288     }
5289     pParse->pWith = pWith;
5290 
5291     for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
5292     pEList = pLeft->pEList;
5293     if( pCte->pCols ){
5294       if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
5295         sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
5296             pCte->zName, pEList->nExpr, pCte->pCols->nExpr
5297         );
5298         pParse->pWith = pSavedWith;
5299         return 2;
5300       }
5301       pEList = pCte->pCols;
5302     }
5303 
5304     sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
5305     if( bMayRecursive ){
5306       if( pSel->selFlags & SF_Recursive ){
5307         pCte->zCteErr = "multiple recursive references: %s";
5308       }else{
5309         pCte->zCteErr = "recursive reference in a subquery: %s";
5310       }
5311       sqlite3WalkSelect(pWalker, pSel);
5312     }
5313     pCte->zCteErr = 0;
5314     pParse->pWith = pSavedWith;
5315     return 1;  /* Success */
5316   }
5317   return 0;  /* No match */
5318 }
5319 #endif
5320 
5321 #ifndef SQLITE_OMIT_CTE
5322 /*
5323 ** If the SELECT passed as the second argument has an associated WITH
5324 ** clause, pop it from the stack stored as part of the Parse object.
5325 **
5326 ** This function is used as the xSelectCallback2() callback by
5327 ** sqlite3SelectExpand() when walking a SELECT tree to resolve table
5328 ** names and other FROM clause elements.
5329 */
5330 void sqlite3SelectPopWith(Walker *pWalker, Select *p){
5331   Parse *pParse = pWalker->pParse;
5332   if( OK_IF_ALWAYS_TRUE(pParse->pWith) && p->pPrior==0 ){
5333     With *pWith = findRightmost(p)->pWith;
5334     if( pWith!=0 ){
5335       assert( pParse->pWith==pWith || pParse->nErr );
5336       pParse->pWith = pWith->pOuter;
5337     }
5338   }
5339 }
5340 #endif
5341 
5342 /*
5343 ** The SrcList_item structure passed as the second argument represents a
5344 ** sub-query in the FROM clause of a SELECT statement. This function
5345 ** allocates and populates the SrcList_item.pTab object. If successful,
5346 ** SQLITE_OK is returned. Otherwise, if an OOM error is encountered,
5347 ** SQLITE_NOMEM.
5348 */
5349 int sqlite3ExpandSubquery(Parse *pParse, SrcItem *pFrom){
5350   Select *pSel = pFrom->pSelect;
5351   Table *pTab;
5352 
5353   assert( pSel );
5354   pFrom->pTab = pTab = sqlite3DbMallocZero(pParse->db, sizeof(Table));
5355   if( pTab==0 ) return SQLITE_NOMEM;
5356   pTab->nTabRef = 1;
5357   if( pFrom->zAlias ){
5358     pTab->zName = sqlite3DbStrDup(pParse->db, pFrom->zAlias);
5359   }else{
5360     pTab->zName = sqlite3MPrintf(pParse->db, "subquery_%u", pSel->selId);
5361   }
5362   while( pSel->pPrior ){ pSel = pSel->pPrior; }
5363   sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
5364   pTab->iPKey = -1;
5365   pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
5366 #ifndef SQLITE_ALLOW_ROWID_IN_VIEW
5367   /* The usual case - do not allow ROWID on a subquery */
5368   pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
5369 #else
5370   pTab->tabFlags |= TF_Ephemeral;  /* Legacy compatibility mode */
5371 #endif
5372 
5373 
5374   return pParse->nErr ? SQLITE_ERROR : SQLITE_OK;
5375 }
5376 
5377 /*
5378 ** This routine is a Walker callback for "expanding" a SELECT statement.
5379 ** "Expanding" means to do the following:
5380 **
5381 **    (1)  Make sure VDBE cursor numbers have been assigned to every
5382 **         element of the FROM clause.
5383 **
5384 **    (2)  Fill in the pTabList->a[].pTab fields in the SrcList that
5385 **         defines FROM clause.  When views appear in the FROM clause,
5386 **         fill pTabList->a[].pSelect with a copy of the SELECT statement
5387 **         that implements the view.  A copy is made of the view's SELECT
5388 **         statement so that we can freely modify or delete that statement
5389 **         without worrying about messing up the persistent representation
5390 **         of the view.
5391 **
5392 **    (3)  Add terms to the WHERE clause to accommodate the NATURAL keyword
5393 **         on joins and the ON and USING clause of joins.
5394 **
5395 **    (4)  Scan the list of columns in the result set (pEList) looking
5396 **         for instances of the "*" operator or the TABLE.* operator.
5397 **         If found, expand each "*" to be every column in every table
5398 **         and TABLE.* to be every column in TABLE.
5399 **
5400 */
5401 static int selectExpander(Walker *pWalker, Select *p){
5402   Parse *pParse = pWalker->pParse;
5403   int i, j, k, rc;
5404   SrcList *pTabList;
5405   ExprList *pEList;
5406   SrcItem *pFrom;
5407   sqlite3 *db = pParse->db;
5408   Expr *pE, *pRight, *pExpr;
5409   u16 selFlags = p->selFlags;
5410   u32 elistFlags = 0;
5411 
5412   p->selFlags |= SF_Expanded;
5413   if( db->mallocFailed  ){
5414     return WRC_Abort;
5415   }
5416   assert( p->pSrc!=0 );
5417   if( (selFlags & SF_Expanded)!=0 ){
5418     return WRC_Prune;
5419   }
5420   if( pWalker->eCode ){
5421     /* Renumber selId because it has been copied from a view */
5422     p->selId = ++pParse->nSelect;
5423   }
5424   pTabList = p->pSrc;
5425   pEList = p->pEList;
5426   if( pParse->pWith && (p->selFlags & SF_View) ){
5427     if( p->pWith==0 ){
5428       p->pWith = (With*)sqlite3DbMallocZero(db, sizeof(With));
5429       if( p->pWith==0 ){
5430         return WRC_Abort;
5431       }
5432     }
5433     p->pWith->bView = 1;
5434   }
5435   sqlite3WithPush(pParse, p->pWith, 0);
5436 
5437   /* Make sure cursor numbers have been assigned to all entries in
5438   ** the FROM clause of the SELECT statement.
5439   */
5440   sqlite3SrcListAssignCursors(pParse, pTabList);
5441 
5442   /* Look up every table named in the FROM clause of the select.  If
5443   ** an entry of the FROM clause is a subquery instead of a table or view,
5444   ** then create a transient table structure to describe the subquery.
5445   */
5446   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5447     Table *pTab;
5448     assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
5449     if( pFrom->pTab ) continue;
5450     assert( pFrom->fg.isRecursive==0 );
5451     if( pFrom->zName==0 ){
5452 #ifndef SQLITE_OMIT_SUBQUERY
5453       Select *pSel = pFrom->pSelect;
5454       /* A sub-query in the FROM clause of a SELECT */
5455       assert( pSel!=0 );
5456       assert( pFrom->pTab==0 );
5457       if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
5458       if( sqlite3ExpandSubquery(pParse, pFrom) ) return WRC_Abort;
5459 #endif
5460 #ifndef SQLITE_OMIT_CTE
5461     }else if( (rc = resolveFromTermToCte(pParse, pWalker, pFrom))!=0 ){
5462       if( rc>1 ) return WRC_Abort;
5463       pTab = pFrom->pTab;
5464       assert( pTab!=0 );
5465 #endif
5466     }else{
5467       /* An ordinary table or view name in the FROM clause */
5468       assert( pFrom->pTab==0 );
5469       pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
5470       if( pTab==0 ) return WRC_Abort;
5471       if( pTab->nTabRef>=0xffff ){
5472         sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
5473            pTab->zName);
5474         pFrom->pTab = 0;
5475         return WRC_Abort;
5476       }
5477       pTab->nTabRef++;
5478       if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
5479         return WRC_Abort;
5480       }
5481 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_VIRTUALTABLE)
5482       if( !IsOrdinaryTable(pTab) ){
5483         i16 nCol;
5484         u8 eCodeOrig = pWalker->eCode;
5485         if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
5486         assert( pFrom->pSelect==0 );
5487         if( IsView(pTab) ){
5488           if( (db->flags & SQLITE_EnableView)==0
5489            && pTab->pSchema!=db->aDb[1].pSchema
5490           ){
5491             sqlite3ErrorMsg(pParse, "access to view \"%s\" prohibited",
5492               pTab->zName);
5493           }
5494           pFrom->pSelect = sqlite3SelectDup(db, pTab->u.view.pSelect, 0);
5495         }else
5496 #ifndef SQLITE_OMIT_VIRTUALTABLE
5497         if( ALWAYS(IsVirtual(pTab))
5498          && pFrom->fg.fromDDL
5499          && ALWAYS(pTab->u.vtab.p!=0)
5500          && pTab->u.vtab.p->eVtabRisk > ((db->flags & SQLITE_TrustedSchema)!=0)
5501         ){
5502           sqlite3ErrorMsg(pParse, "unsafe use of virtual table \"%s\"",
5503                                   pTab->zName);
5504         }
5505         assert( SQLITE_VTABRISK_Normal==1 && SQLITE_VTABRISK_High==2 );
5506 #endif
5507         nCol = pTab->nCol;
5508         pTab->nCol = -1;
5509         pWalker->eCode = 1;  /* Turn on Select.selId renumbering */
5510         sqlite3WalkSelect(pWalker, pFrom->pSelect);
5511         pWalker->eCode = eCodeOrig;
5512         pTab->nCol = nCol;
5513       }
5514 #endif
5515     }
5516 
5517     /* Locate the index named by the INDEXED BY clause, if any. */
5518     if( pFrom->fg.isIndexedBy && sqlite3IndexedByLookup(pParse, pFrom) ){
5519       return WRC_Abort;
5520     }
5521   }
5522 
5523   /* Process NATURAL keywords, and ON and USING clauses of joins.
5524   */
5525   if( pParse->nErr || db->mallocFailed || sqliteProcessJoin(pParse, p) ){
5526     return WRC_Abort;
5527   }
5528 
5529   /* For every "*" that occurs in the column list, insert the names of
5530   ** all columns in all tables.  And for every TABLE.* insert the names
5531   ** of all columns in TABLE.  The parser inserted a special expression
5532   ** with the TK_ASTERISK operator for each "*" that it found in the column
5533   ** list.  The following code just has to locate the TK_ASTERISK
5534   ** expressions and expand each one to the list of all columns in
5535   ** all tables.
5536   **
5537   ** The first loop just checks to see if there are any "*" operators
5538   ** that need expanding.
5539   */
5540   for(k=0; k<pEList->nExpr; k++){
5541     pE = pEList->a[k].pExpr;
5542     if( pE->op==TK_ASTERISK ) break;
5543     assert( pE->op!=TK_DOT || pE->pRight!=0 );
5544     assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
5545     if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
5546     elistFlags |= pE->flags;
5547   }
5548   if( k<pEList->nExpr ){
5549     /*
5550     ** If we get here it means the result set contains one or more "*"
5551     ** operators that need to be expanded.  Loop through each expression
5552     ** in the result set and expand them one by one.
5553     */
5554     struct ExprList_item *a = pEList->a;
5555     ExprList *pNew = 0;
5556     int flags = pParse->db->flags;
5557     int longNames = (flags & SQLITE_FullColNames)!=0
5558                       && (flags & SQLITE_ShortColNames)==0;
5559 
5560     for(k=0; k<pEList->nExpr; k++){
5561       pE = a[k].pExpr;
5562       elistFlags |= pE->flags;
5563       pRight = pE->pRight;
5564       assert( pE->op!=TK_DOT || pRight!=0 );
5565       if( pE->op!=TK_ASTERISK
5566        && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
5567       ){
5568         /* This particular expression does not need to be expanded.
5569         */
5570         pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
5571         if( pNew ){
5572           pNew->a[pNew->nExpr-1].zEName = a[k].zEName;
5573           pNew->a[pNew->nExpr-1].eEName = a[k].eEName;
5574           a[k].zEName = 0;
5575         }
5576         a[k].pExpr = 0;
5577       }else{
5578         /* This expression is a "*" or a "TABLE.*" and needs to be
5579         ** expanded. */
5580         int tableSeen = 0;      /* Set to 1 when TABLE matches */
5581         char *zTName = 0;       /* text of name of TABLE */
5582         if( pE->op==TK_DOT ){
5583           assert( pE->pLeft!=0 );
5584           assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
5585           zTName = pE->pLeft->u.zToken;
5586         }
5587         for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5588           Table *pTab = pFrom->pTab;
5589           Select *pSub = pFrom->pSelect;
5590           char *zTabName = pFrom->zAlias;
5591           const char *zSchemaName = 0;
5592           int iDb;
5593           if( zTabName==0 ){
5594             zTabName = pTab->zName;
5595           }
5596           if( db->mallocFailed ) break;
5597           if( pSub==0 || (pSub->selFlags & SF_NestedFrom)==0 ){
5598             pSub = 0;
5599             if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
5600               continue;
5601             }
5602             iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
5603             zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
5604           }
5605           for(j=0; j<pTab->nCol; j++){
5606             char *zName = pTab->aCol[j].zCnName;
5607             char *zColname;  /* The computed column name */
5608             char *zToFree;   /* Malloced string that needs to be freed */
5609             Token sColname;  /* Computed column name as a token */
5610 
5611             assert( zName );
5612             if( zTName && pSub
5613              && sqlite3MatchEName(&pSub->pEList->a[j], 0, zTName, 0)==0
5614             ){
5615               continue;
5616             }
5617 
5618             /* If a column is marked as 'hidden', omit it from the expanded
5619             ** result-set list unless the SELECT has the SF_IncludeHidden
5620             ** bit set.
5621             */
5622             if( (p->selFlags & SF_IncludeHidden)==0
5623              && IsHiddenColumn(&pTab->aCol[j])
5624             ){
5625               continue;
5626             }
5627             tableSeen = 1;
5628 
5629             if( i>0 && zTName==0 ){
5630               if( (pFrom->fg.jointype & JT_NATURAL)!=0
5631                 && tableAndColumnIndex(pTabList, i, zName, 0, 0, 1)
5632               ){
5633                 /* In a NATURAL join, omit the join columns from the
5634                 ** table to the right of the join */
5635                 continue;
5636               }
5637               if( sqlite3IdListIndex(pFrom->pUsing, zName)>=0 ){
5638                 /* In a join with a USING clause, omit columns in the
5639                 ** using clause from the table on the right. */
5640                 continue;
5641               }
5642             }
5643             pRight = sqlite3Expr(db, TK_ID, zName);
5644             zColname = zName;
5645             zToFree = 0;
5646             if( longNames || pTabList->nSrc>1 ){
5647               Expr *pLeft;
5648               pLeft = sqlite3Expr(db, TK_ID, zTabName);
5649               pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
5650               if( zSchemaName ){
5651                 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
5652                 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
5653               }
5654               if( longNames ){
5655                 zColname = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
5656                 zToFree = zColname;
5657               }
5658             }else{
5659               pExpr = pRight;
5660             }
5661             pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
5662             sqlite3TokenInit(&sColname, zColname);
5663             sqlite3ExprListSetName(pParse, pNew, &sColname, 0);
5664             if( pNew && (p->selFlags & SF_NestedFrom)!=0 && !IN_RENAME_OBJECT ){
5665               struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
5666               sqlite3DbFree(db, pX->zEName);
5667               if( pSub ){
5668                 pX->zEName = sqlite3DbStrDup(db, pSub->pEList->a[j].zEName);
5669                 testcase( pX->zEName==0 );
5670               }else{
5671                 pX->zEName = sqlite3MPrintf(db, "%s.%s.%s",
5672                                            zSchemaName, zTabName, zColname);
5673                 testcase( pX->zEName==0 );
5674               }
5675               pX->eEName = ENAME_TAB;
5676             }
5677             sqlite3DbFree(db, zToFree);
5678           }
5679         }
5680         if( !tableSeen ){
5681           if( zTName ){
5682             sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
5683           }else{
5684             sqlite3ErrorMsg(pParse, "no tables specified");
5685           }
5686         }
5687       }
5688     }
5689     sqlite3ExprListDelete(db, pEList);
5690     p->pEList = pNew;
5691   }
5692   if( p->pEList ){
5693     if( p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
5694       sqlite3ErrorMsg(pParse, "too many columns in result set");
5695       return WRC_Abort;
5696     }
5697     if( (elistFlags & (EP_HasFunc|EP_Subquery))!=0 ){
5698       p->selFlags |= SF_ComplexResult;
5699     }
5700   }
5701   return WRC_Continue;
5702 }
5703 
5704 #if SQLITE_DEBUG
5705 /*
5706 ** Always assert.  This xSelectCallback2 implementation proves that the
5707 ** xSelectCallback2 is never invoked.
5708 */
5709 void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
5710   UNUSED_PARAMETER2(NotUsed, NotUsed2);
5711   assert( 0 );
5712 }
5713 #endif
5714 /*
5715 ** This routine "expands" a SELECT statement and all of its subqueries.
5716 ** For additional information on what it means to "expand" a SELECT
5717 ** statement, see the comment on the selectExpand worker callback above.
5718 **
5719 ** Expanding a SELECT statement is the first step in processing a
5720 ** SELECT statement.  The SELECT statement must be expanded before
5721 ** name resolution is performed.
5722 **
5723 ** If anything goes wrong, an error message is written into pParse.
5724 ** The calling function can detect the problem by looking at pParse->nErr
5725 ** and/or pParse->db->mallocFailed.
5726 */
5727 static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
5728   Walker w;
5729   w.xExprCallback = sqlite3ExprWalkNoop;
5730   w.pParse = pParse;
5731   if( OK_IF_ALWAYS_TRUE(pParse->hasCompound) ){
5732     w.xSelectCallback = convertCompoundSelectToSubquery;
5733     w.xSelectCallback2 = 0;
5734     sqlite3WalkSelect(&w, pSelect);
5735   }
5736   w.xSelectCallback = selectExpander;
5737   w.xSelectCallback2 = sqlite3SelectPopWith;
5738   w.eCode = 0;
5739   sqlite3WalkSelect(&w, pSelect);
5740 }
5741 
5742 
5743 #ifndef SQLITE_OMIT_SUBQUERY
5744 /*
5745 ** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
5746 ** interface.
5747 **
5748 ** For each FROM-clause subquery, add Column.zType and Column.zColl
5749 ** information to the Table structure that represents the result set
5750 ** of that subquery.
5751 **
5752 ** The Table structure that represents the result set was constructed
5753 ** by selectExpander() but the type and collation information was omitted
5754 ** at that point because identifiers had not yet been resolved.  This
5755 ** routine is called after identifier resolution.
5756 */
5757 static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
5758   Parse *pParse;
5759   int i;
5760   SrcList *pTabList;
5761   SrcItem *pFrom;
5762 
5763   assert( p->selFlags & SF_Resolved );
5764   if( p->selFlags & SF_HasTypeInfo ) return;
5765   p->selFlags |= SF_HasTypeInfo;
5766   pParse = pWalker->pParse;
5767   pTabList = p->pSrc;
5768   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
5769     Table *pTab = pFrom->pTab;
5770     assert( pTab!=0 );
5771     if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
5772       /* A sub-query in the FROM clause of a SELECT */
5773       Select *pSel = pFrom->pSelect;
5774       if( pSel ){
5775         while( pSel->pPrior ) pSel = pSel->pPrior;
5776         sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel,
5777                                                SQLITE_AFF_NONE);
5778       }
5779     }
5780   }
5781 }
5782 #endif
5783 
5784 
5785 /*
5786 ** This routine adds datatype and collating sequence information to
5787 ** the Table structures of all FROM-clause subqueries in a
5788 ** SELECT statement.
5789 **
5790 ** Use this routine after name resolution.
5791 */
5792 static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
5793 #ifndef SQLITE_OMIT_SUBQUERY
5794   Walker w;
5795   w.xSelectCallback = sqlite3SelectWalkNoop;
5796   w.xSelectCallback2 = selectAddSubqueryTypeInfo;
5797   w.xExprCallback = sqlite3ExprWalkNoop;
5798   w.pParse = pParse;
5799   sqlite3WalkSelect(&w, pSelect);
5800 #endif
5801 }
5802 
5803 
5804 /*
5805 ** This routine sets up a SELECT statement for processing.  The
5806 ** following is accomplished:
5807 **
5808 **     *  VDBE Cursor numbers are assigned to all FROM-clause terms.
5809 **     *  Ephemeral Table objects are created for all FROM-clause subqueries.
5810 **     *  ON and USING clauses are shifted into WHERE statements
5811 **     *  Wildcards "*" and "TABLE.*" in result sets are expanded.
5812 **     *  Identifiers in expression are matched to tables.
5813 **
5814 ** This routine acts recursively on all subqueries within the SELECT.
5815 */
5816 void sqlite3SelectPrep(
5817   Parse *pParse,         /* The parser context */
5818   Select *p,             /* The SELECT statement being coded. */
5819   NameContext *pOuterNC  /* Name context for container */
5820 ){
5821   assert( p!=0 || pParse->db->mallocFailed );
5822   if( pParse->db->mallocFailed ) return;
5823   if( p->selFlags & SF_HasTypeInfo ) return;
5824   sqlite3SelectExpand(pParse, p);
5825   if( pParse->nErr || pParse->db->mallocFailed ) return;
5826   sqlite3ResolveSelectNames(pParse, p, pOuterNC);
5827   if( pParse->nErr || pParse->db->mallocFailed ) return;
5828   sqlite3SelectAddTypeInfo(pParse, p);
5829 }
5830 
5831 /*
5832 ** Reset the aggregate accumulator.
5833 **
5834 ** The aggregate accumulator is a set of memory cells that hold
5835 ** intermediate results while calculating an aggregate.  This
5836 ** routine generates code that stores NULLs in all of those memory
5837 ** cells.
5838 */
5839 static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
5840   Vdbe *v = pParse->pVdbe;
5841   int i;
5842   struct AggInfo_func *pFunc;
5843   int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
5844   if( nReg==0 ) return;
5845   if( pParse->nErr || pParse->db->mallocFailed ) return;
5846 #ifdef SQLITE_DEBUG
5847   /* Verify that all AggInfo registers are within the range specified by
5848   ** AggInfo.mnReg..AggInfo.mxReg */
5849   assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
5850   for(i=0; i<pAggInfo->nColumn; i++){
5851     assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
5852          && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
5853   }
5854   for(i=0; i<pAggInfo->nFunc; i++){
5855     assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
5856          && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
5857   }
5858 #endif
5859   sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
5860   for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
5861     if( pFunc->iDistinct>=0 ){
5862       Expr *pE = pFunc->pFExpr;
5863       assert( !ExprHasProperty(pE, EP_xIsSelect) );
5864       if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
5865         sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
5866            "argument");
5867         pFunc->iDistinct = -1;
5868       }else{
5869         KeyInfo *pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pE->x.pList,0,0);
5870         pFunc->iDistAddr = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
5871             pFunc->iDistinct, 0, 0, (char*)pKeyInfo, P4_KEYINFO);
5872         ExplainQueryPlan((pParse, 0, "USE TEMP B-TREE FOR %s(DISTINCT)",
5873                           pFunc->pFunc->zName));
5874       }
5875     }
5876   }
5877 }
5878 
5879 /*
5880 ** Invoke the OP_AggFinalize opcode for every aggregate function
5881 ** in the AggInfo structure.
5882 */
5883 static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
5884   Vdbe *v = pParse->pVdbe;
5885   int i;
5886   struct AggInfo_func *pF;
5887   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
5888     ExprList *pList = pF->pFExpr->x.pList;
5889     assert( !ExprHasProperty(pF->pFExpr, EP_xIsSelect) );
5890     sqlite3VdbeAddOp2(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0);
5891     sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
5892   }
5893 }
5894 
5895 
5896 /*
5897 ** Update the accumulator memory cells for an aggregate based on
5898 ** the current cursor position.
5899 **
5900 ** If regAcc is non-zero and there are no min() or max() aggregates
5901 ** in pAggInfo, then only populate the pAggInfo->nAccumulator accumulator
5902 ** registers if register regAcc contains 0. The caller will take care
5903 ** of setting and clearing regAcc.
5904 */
5905 static void updateAccumulator(
5906   Parse *pParse,
5907   int regAcc,
5908   AggInfo *pAggInfo,
5909   int eDistinctType
5910 ){
5911   Vdbe *v = pParse->pVdbe;
5912   int i;
5913   int regHit = 0;
5914   int addrHitTest = 0;
5915   struct AggInfo_func *pF;
5916   struct AggInfo_col *pC;
5917 
5918   pAggInfo->directMode = 1;
5919   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
5920     int nArg;
5921     int addrNext = 0;
5922     int regAgg;
5923     ExprList *pList = pF->pFExpr->x.pList;
5924     assert( !ExprHasProperty(pF->pFExpr, EP_xIsSelect) );
5925     assert( !IsWindowFunc(pF->pFExpr) );
5926     if( ExprHasProperty(pF->pFExpr, EP_WinFunc) ){
5927       Expr *pFilter = pF->pFExpr->y.pWin->pFilter;
5928       if( pAggInfo->nAccumulator
5929        && (pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL)
5930        && regAcc
5931       ){
5932         /* If regAcc==0, there there exists some min() or max() function
5933         ** without a FILTER clause that will ensure the magnet registers
5934         ** are populated. */
5935         if( regHit==0 ) regHit = ++pParse->nMem;
5936         /* If this is the first row of the group (regAcc contains 0), clear the
5937         ** "magnet" register regHit so that the accumulator registers
5938         ** are populated if the FILTER clause jumps over the the
5939         ** invocation of min() or max() altogether. Or, if this is not
5940         ** the first row (regAcc contains 1), set the magnet register so that
5941         ** the accumulators are not populated unless the min()/max() is invoked
5942         ** and indicates that they should be.  */
5943         sqlite3VdbeAddOp2(v, OP_Copy, regAcc, regHit);
5944       }
5945       addrNext = sqlite3VdbeMakeLabel(pParse);
5946       sqlite3ExprIfFalse(pParse, pFilter, addrNext, SQLITE_JUMPIFNULL);
5947     }
5948     if( pList ){
5949       nArg = pList->nExpr;
5950       regAgg = sqlite3GetTempRange(pParse, nArg);
5951       sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
5952     }else{
5953       nArg = 0;
5954       regAgg = 0;
5955     }
5956     if( pF->iDistinct>=0 && pList ){
5957       if( addrNext==0 ){
5958         addrNext = sqlite3VdbeMakeLabel(pParse);
5959       }
5960       pF->iDistinct = codeDistinct(pParse, eDistinctType,
5961           pF->iDistinct, addrNext, pList, regAgg);
5962     }
5963     if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
5964       CollSeq *pColl = 0;
5965       struct ExprList_item *pItem;
5966       int j;
5967       assert( pList!=0 );  /* pList!=0 if pF->pFunc has NEEDCOLL */
5968       for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
5969         pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
5970       }
5971       if( !pColl ){
5972         pColl = pParse->db->pDfltColl;
5973       }
5974       if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
5975       sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
5976     }
5977     sqlite3VdbeAddOp3(v, OP_AggStep, 0, regAgg, pF->iMem);
5978     sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
5979     sqlite3VdbeChangeP5(v, (u8)nArg);
5980     sqlite3ReleaseTempRange(pParse, regAgg, nArg);
5981     if( addrNext ){
5982       sqlite3VdbeResolveLabel(v, addrNext);
5983     }
5984   }
5985   if( regHit==0 && pAggInfo->nAccumulator ){
5986     regHit = regAcc;
5987   }
5988   if( regHit ){
5989     addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
5990   }
5991   for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
5992     sqlite3ExprCode(pParse, pC->pCExpr, pC->iMem);
5993   }
5994 
5995   pAggInfo->directMode = 0;
5996   if( addrHitTest ){
5997     sqlite3VdbeJumpHereOrPopInst(v, addrHitTest);
5998   }
5999 }
6000 
6001 /*
6002 ** Add a single OP_Explain instruction to the VDBE to explain a simple
6003 ** count(*) query ("SELECT count(*) FROM pTab").
6004 */
6005 #ifndef SQLITE_OMIT_EXPLAIN
6006 static void explainSimpleCount(
6007   Parse *pParse,                  /* Parse context */
6008   Table *pTab,                    /* Table being queried */
6009   Index *pIdx                     /* Index used to optimize scan, or NULL */
6010 ){
6011   if( pParse->explain==2 ){
6012     int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
6013     sqlite3VdbeExplain(pParse, 0, "SCAN %s%s%s",
6014         pTab->zName,
6015         bCover ? " USING COVERING INDEX " : "",
6016         bCover ? pIdx->zName : ""
6017     );
6018   }
6019 }
6020 #else
6021 # define explainSimpleCount(a,b,c)
6022 #endif
6023 
6024 /*
6025 ** sqlite3WalkExpr() callback used by havingToWhere().
6026 **
6027 ** If the node passed to the callback is a TK_AND node, return
6028 ** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
6029 **
6030 ** Otherwise, return WRC_Prune. In this case, also check if the
6031 ** sub-expression matches the criteria for being moved to the WHERE
6032 ** clause. If so, add it to the WHERE clause and replace the sub-expression
6033 ** within the HAVING expression with a constant "1".
6034 */
6035 static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
6036   if( pExpr->op!=TK_AND ){
6037     Select *pS = pWalker->u.pSelect;
6038     /* This routine is called before the HAVING clause of the current
6039     ** SELECT is analyzed for aggregates. So if pExpr->pAggInfo is set
6040     ** here, it indicates that the expression is a correlated reference to a
6041     ** column from an outer aggregate query, or an aggregate function that
6042     ** belongs to an outer query. Do not move the expression to the WHERE
6043     ** clause in this obscure case, as doing so may corrupt the outer Select
6044     ** statements AggInfo structure.  */
6045     if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, pS->pGroupBy)
6046      && ExprAlwaysFalse(pExpr)==0
6047      && pExpr->pAggInfo==0
6048     ){
6049       sqlite3 *db = pWalker->pParse->db;
6050       Expr *pNew = sqlite3Expr(db, TK_INTEGER, "1");
6051       if( pNew ){
6052         Expr *pWhere = pS->pWhere;
6053         SWAP(Expr, *pNew, *pExpr);
6054         pNew = sqlite3ExprAnd(pWalker->pParse, pWhere, pNew);
6055         pS->pWhere = pNew;
6056         pWalker->eCode = 1;
6057       }
6058     }
6059     return WRC_Prune;
6060   }
6061   return WRC_Continue;
6062 }
6063 
6064 /*
6065 ** Transfer eligible terms from the HAVING clause of a query, which is
6066 ** processed after grouping, to the WHERE clause, which is processed before
6067 ** grouping. For example, the query:
6068 **
6069 **   SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
6070 **
6071 ** can be rewritten as:
6072 **
6073 **   SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
6074 **
6075 ** A term of the HAVING expression is eligible for transfer if it consists
6076 ** entirely of constants and expressions that are also GROUP BY terms that
6077 ** use the "BINARY" collation sequence.
6078 */
6079 static void havingToWhere(Parse *pParse, Select *p){
6080   Walker sWalker;
6081   memset(&sWalker, 0, sizeof(sWalker));
6082   sWalker.pParse = pParse;
6083   sWalker.xExprCallback = havingToWhereExprCb;
6084   sWalker.u.pSelect = p;
6085   sqlite3WalkExpr(&sWalker, p->pHaving);
6086 #if SELECTTRACE_ENABLED
6087   if( sWalker.eCode && (sqlite3SelectTrace & 0x100)!=0 ){
6088     SELECTTRACE(0x100,pParse,p,("Move HAVING terms into WHERE:\n"));
6089     sqlite3TreeViewSelect(0, p, 0);
6090   }
6091 #endif
6092 }
6093 
6094 /*
6095 ** Check to see if the pThis entry of pTabList is a self-join of a prior view.
6096 ** If it is, then return the SrcList_item for the prior view.  If it is not,
6097 ** then return 0.
6098 */
6099 static SrcItem *isSelfJoinView(
6100   SrcList *pTabList,           /* Search for self-joins in this FROM clause */
6101   SrcItem *pThis               /* Search for prior reference to this subquery */
6102 ){
6103   SrcItem *pItem;
6104   assert( pThis->pSelect!=0 );
6105   if( pThis->pSelect->selFlags & SF_PushDown ) return 0;
6106   for(pItem = pTabList->a; pItem<pThis; pItem++){
6107     Select *pS1;
6108     if( pItem->pSelect==0 ) continue;
6109     if( pItem->fg.viaCoroutine ) continue;
6110     if( pItem->zName==0 ) continue;
6111     assert( pItem->pTab!=0 );
6112     assert( pThis->pTab!=0 );
6113     if( pItem->pTab->pSchema!=pThis->pTab->pSchema ) continue;
6114     if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
6115     pS1 = pItem->pSelect;
6116     if( pItem->pTab->pSchema==0 && pThis->pSelect->selId!=pS1->selId ){
6117       /* The query flattener left two different CTE tables with identical
6118       ** names in the same FROM clause. */
6119       continue;
6120     }
6121     if( pItem->pSelect->selFlags & SF_PushDown ){
6122       /* The view was modified by some other optimization such as
6123       ** pushDownWhereTerms() */
6124       continue;
6125     }
6126     return pItem;
6127   }
6128   return 0;
6129 }
6130 
6131 /*
6132 ** Deallocate a single AggInfo object
6133 */
6134 static void agginfoFree(sqlite3 *db, AggInfo *p){
6135   sqlite3DbFree(db, p->aCol);
6136   sqlite3DbFree(db, p->aFunc);
6137   sqlite3DbFreeNN(db, p);
6138 }
6139 
6140 #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6141 /*
6142 ** Attempt to transform a query of the form
6143 **
6144 **    SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
6145 **
6146 ** Into this:
6147 **
6148 **    SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
6149 **
6150 ** The transformation only works if all of the following are true:
6151 **
6152 **   *  The subquery is a UNION ALL of two or more terms
6153 **   *  The subquery does not have a LIMIT clause
6154 **   *  There is no WHERE or GROUP BY or HAVING clauses on the subqueries
6155 **   *  The outer query is a simple count(*) with no WHERE clause or other
6156 **      extraneous syntax.
6157 **
6158 ** Return TRUE if the optimization is undertaken.
6159 */
6160 static int countOfViewOptimization(Parse *pParse, Select *p){
6161   Select *pSub, *pPrior;
6162   Expr *pExpr;
6163   Expr *pCount;
6164   sqlite3 *db;
6165   if( (p->selFlags & SF_Aggregate)==0 ) return 0;   /* This is an aggregate */
6166   if( p->pEList->nExpr!=1 ) return 0;               /* Single result column */
6167   if( p->pWhere ) return 0;
6168   if( p->pGroupBy ) return 0;
6169   pExpr = p->pEList->a[0].pExpr;
6170   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;        /* Result is an aggregate */
6171   if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0;  /* Is count() */
6172   if( pExpr->x.pList!=0 ) return 0;                 /* Must be count(*) */
6173   if( p->pSrc->nSrc!=1 ) return 0;                  /* One table in FROM  */
6174   pSub = p->pSrc->a[0].pSelect;
6175   if( pSub==0 ) return 0;                           /* The FROM is a subquery */
6176   if( pSub->pPrior==0 ) return 0;                   /* Must be a compound ry */
6177   do{
6178     if( pSub->op!=TK_ALL && pSub->pPrior ) return 0;  /* Must be UNION ALL */
6179     if( pSub->pWhere ) return 0;                      /* No WHERE clause */
6180     if( pSub->pLimit ) return 0;                      /* No LIMIT clause */
6181     if( pSub->selFlags & SF_Aggregate ) return 0;     /* Not an aggregate */
6182     pSub = pSub->pPrior;                              /* Repeat over compound */
6183   }while( pSub );
6184 
6185   /* If we reach this point then it is OK to perform the transformation */
6186 
6187   db = pParse->db;
6188   pCount = pExpr;
6189   pExpr = 0;
6190   pSub = p->pSrc->a[0].pSelect;
6191   p->pSrc->a[0].pSelect = 0;
6192   sqlite3SrcListDelete(db, p->pSrc);
6193   p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
6194   while( pSub ){
6195     Expr *pTerm;
6196     pPrior = pSub->pPrior;
6197     pSub->pPrior = 0;
6198     pSub->pNext = 0;
6199     pSub->selFlags |= SF_Aggregate;
6200     pSub->selFlags &= ~SF_Compound;
6201     pSub->nSelectRow = 0;
6202     sqlite3ExprListDelete(db, pSub->pEList);
6203     pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
6204     pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
6205     pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
6206     sqlite3PExprAddSelect(pParse, pTerm, pSub);
6207     if( pExpr==0 ){
6208       pExpr = pTerm;
6209     }else{
6210       pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
6211     }
6212     pSub = pPrior;
6213   }
6214   p->pEList->a[0].pExpr = pExpr;
6215   p->selFlags &= ~SF_Aggregate;
6216 
6217 #if SELECTTRACE_ENABLED
6218   if( sqlite3SelectTrace & 0x400 ){
6219     SELECTTRACE(0x400,pParse,p,("After count-of-view optimization:\n"));
6220     sqlite3TreeViewSelect(0, p, 0);
6221   }
6222 #endif
6223   return 1;
6224 }
6225 #endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
6226 
6227 /*
6228 ** Generate code for the SELECT statement given in the p argument.
6229 **
6230 ** The results are returned according to the SelectDest structure.
6231 ** See comments in sqliteInt.h for further information.
6232 **
6233 ** This routine returns the number of errors.  If any errors are
6234 ** encountered, then an appropriate error message is left in
6235 ** pParse->zErrMsg.
6236 **
6237 ** This routine does NOT free the Select structure passed in.  The
6238 ** calling function needs to do that.
6239 */
6240 int sqlite3Select(
6241   Parse *pParse,         /* The parser context */
6242   Select *p,             /* The SELECT statement being coded. */
6243   SelectDest *pDest      /* What to do with the query results */
6244 ){
6245   int i, j;              /* Loop counters */
6246   WhereInfo *pWInfo;     /* Return from sqlite3WhereBegin() */
6247   Vdbe *v;               /* The virtual machine under construction */
6248   int isAgg;             /* True for select lists like "count(*)" */
6249   ExprList *pEList = 0;  /* List of columns to extract. */
6250   SrcList *pTabList;     /* List of tables to select from */
6251   Expr *pWhere;          /* The WHERE clause.  May be NULL */
6252   ExprList *pGroupBy;    /* The GROUP BY clause.  May be NULL */
6253   Expr *pHaving;         /* The HAVING clause.  May be NULL */
6254   AggInfo *pAggInfo = 0; /* Aggregate information */
6255   int rc = 1;            /* Value to return from this function */
6256   DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
6257   SortCtx sSort;         /* Info on how to code the ORDER BY clause */
6258   int iEnd;              /* Address of the end of the query */
6259   sqlite3 *db;           /* The database connection */
6260   ExprList *pMinMaxOrderBy = 0;  /* Added ORDER BY for min/max queries */
6261   u8 minMaxFlag;                 /* Flag for min/max queries */
6262 
6263   db = pParse->db;
6264   v = sqlite3GetVdbe(pParse);
6265   if( p==0 || db->mallocFailed || pParse->nErr ){
6266     return 1;
6267   }
6268   if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
6269 #if SELECTTRACE_ENABLED
6270   SELECTTRACE(1,pParse,p, ("begin processing:\n", pParse->addrExplain));
6271   if( sqlite3SelectTrace & 0x100 ){
6272     sqlite3TreeViewSelect(0, p, 0);
6273   }
6274 #endif
6275 
6276   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
6277   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
6278   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
6279   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
6280   if( IgnorableDistinct(pDest) ){
6281     assert(pDest->eDest==SRT_Exists     || pDest->eDest==SRT_Union ||
6282            pDest->eDest==SRT_Except     || pDest->eDest==SRT_Discard ||
6283            pDest->eDest==SRT_DistQueue  || pDest->eDest==SRT_DistFifo );
6284     /* All of these destinations are also able to ignore the ORDER BY clause */
6285     if( p->pOrderBy ){
6286 #if SELECTTRACE_ENABLED
6287       SELECTTRACE(1,pParse,p, ("dropping superfluous ORDER BY:\n"));
6288       if( sqlite3SelectTrace & 0x100 ){
6289         sqlite3TreeViewExprList(0, p->pOrderBy, 0, "ORDERBY");
6290       }
6291 #endif
6292       sqlite3ParserAddCleanup(pParse,
6293         (void(*)(sqlite3*,void*))sqlite3ExprListDelete,
6294         p->pOrderBy);
6295       testcase( pParse->earlyCleanup );
6296       p->pOrderBy = 0;
6297     }
6298     p->selFlags &= ~SF_Distinct;
6299     p->selFlags |= SF_NoopOrderBy;
6300   }
6301   sqlite3SelectPrep(pParse, p, 0);
6302   if( pParse->nErr || db->mallocFailed ){
6303     goto select_end;
6304   }
6305   assert( p->pEList!=0 );
6306 #if SELECTTRACE_ENABLED
6307   if( sqlite3SelectTrace & 0x104 ){
6308     SELECTTRACE(0x104,pParse,p, ("after name resolution:\n"));
6309     sqlite3TreeViewSelect(0, p, 0);
6310   }
6311 #endif
6312 
6313   /* If the SF_UFSrcCheck flag is set, then this function is being called
6314   ** as part of populating the temp table for an UPDATE...FROM statement.
6315   ** In this case, it is an error if the target object (pSrc->a[0]) name
6316   ** or alias is duplicated within FROM clause (pSrc->a[1..n]).
6317   **
6318   ** Postgres disallows this case too. The reason is that some other
6319   ** systems handle this case differently, and not all the same way,
6320   ** which is just confusing. To avoid this, we follow PG's lead and
6321   ** disallow it altogether.  */
6322   if( p->selFlags & SF_UFSrcCheck ){
6323     SrcItem *p0 = &p->pSrc->a[0];
6324     for(i=1; i<p->pSrc->nSrc; i++){
6325       SrcItem *p1 = &p->pSrc->a[i];
6326       if( p0->pTab==p1->pTab && 0==sqlite3_stricmp(p0->zAlias, p1->zAlias) ){
6327         sqlite3ErrorMsg(pParse,
6328             "target object/alias may not appear in FROM clause: %s",
6329             p0->zAlias ? p0->zAlias : p0->pTab->zName
6330         );
6331         goto select_end;
6332       }
6333     }
6334 
6335     /* Clear the SF_UFSrcCheck flag. The check has already been performed,
6336     ** and leaving this flag set can cause errors if a compound sub-query
6337     ** in p->pSrc is flattened into this query and this function called
6338     ** again as part of compound SELECT processing.  */
6339     p->selFlags &= ~SF_UFSrcCheck;
6340   }
6341 
6342   if( pDest->eDest==SRT_Output ){
6343     sqlite3GenerateColumnNames(pParse, p);
6344   }
6345 
6346 #ifndef SQLITE_OMIT_WINDOWFUNC
6347   if( sqlite3WindowRewrite(pParse, p) ){
6348     assert( db->mallocFailed || pParse->nErr>0 );
6349     goto select_end;
6350   }
6351 #if SELECTTRACE_ENABLED
6352   if( p->pWin && (sqlite3SelectTrace & 0x108)!=0 ){
6353     SELECTTRACE(0x104,pParse,p, ("after window rewrite:\n"));
6354     sqlite3TreeViewSelect(0, p, 0);
6355   }
6356 #endif
6357 #endif /* SQLITE_OMIT_WINDOWFUNC */
6358   pTabList = p->pSrc;
6359   isAgg = (p->selFlags & SF_Aggregate)!=0;
6360   memset(&sSort, 0, sizeof(sSort));
6361   sSort.pOrderBy = p->pOrderBy;
6362 
6363   /* Try to do various optimizations (flattening subqueries, and strength
6364   ** reduction of join operators) in the FROM clause up into the main query
6365   */
6366 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6367   for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
6368     SrcItem *pItem = &pTabList->a[i];
6369     Select *pSub = pItem->pSelect;
6370     Table *pTab = pItem->pTab;
6371 
6372     /* The expander should have already created transient Table objects
6373     ** even for FROM clause elements such as subqueries that do not correspond
6374     ** to a real table */
6375     assert( pTab!=0 );
6376 
6377     /* Convert LEFT JOIN into JOIN if there are terms of the right table
6378     ** of the LEFT JOIN used in the WHERE clause.
6379     */
6380     if( (pItem->fg.jointype & JT_LEFT)!=0
6381      && sqlite3ExprImpliesNonNullRow(p->pWhere, pItem->iCursor)
6382      && OptimizationEnabled(db, SQLITE_SimplifyJoin)
6383     ){
6384       SELECTTRACE(0x100,pParse,p,
6385                 ("LEFT-JOIN simplifies to JOIN on term %d\n",i));
6386       pItem->fg.jointype &= ~(JT_LEFT|JT_OUTER);
6387       unsetJoinExpr(p->pWhere, pItem->iCursor);
6388     }
6389 
6390     /* No futher action if this term of the FROM clause is no a subquery */
6391     if( pSub==0 ) continue;
6392 
6393     /* Catch mismatch in the declared columns of a view and the number of
6394     ** columns in the SELECT on the RHS */
6395     if( pTab->nCol!=pSub->pEList->nExpr ){
6396       sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
6397                       pTab->nCol, pTab->zName, pSub->pEList->nExpr);
6398       goto select_end;
6399     }
6400 
6401     /* Do not try to flatten an aggregate subquery.
6402     **
6403     ** Flattening an aggregate subquery is only possible if the outer query
6404     ** is not a join.  But if the outer query is not a join, then the subquery
6405     ** will be implemented as a co-routine and there is no advantage to
6406     ** flattening in that case.
6407     */
6408     if( (pSub->selFlags & SF_Aggregate)!=0 ) continue;
6409     assert( pSub->pGroupBy==0 );
6410 
6411     /* If a FROM-clause subquery has an ORDER BY clause that is not
6412     ** really doing anything, then delete it now so that it does not
6413     ** interfere with query flattening.  See the discussion at
6414     ** https://sqlite.org/forum/forumpost/2d76f2bcf65d256a
6415     **
6416     ** Beware of these cases where the ORDER BY clause may not be safely
6417     ** omitted:
6418     **
6419     **    (1)   There is also a LIMIT clause
6420     **    (2)   The subquery was added to help with window-function
6421     **          processing
6422     **    (3)   The subquery is in the FROM clause of an UPDATE
6423     **    (4)   The outer query uses an aggregate function other than
6424     **          the built-in count(), min(), or max().
6425     **    (5)   The ORDER BY isn't going to accomplish anything because
6426     **          one of:
6427     **            (a)  The outer query has a different ORDER BY clause
6428     **            (b)  The subquery is part of a join
6429     **          See forum post 062d576715d277c8
6430     */
6431     if( pSub->pOrderBy!=0
6432      && (p->pOrderBy!=0 || pTabList->nSrc>1)      /* Condition (5) */
6433      && pSub->pLimit==0                           /* Condition (1) */
6434      && (pSub->selFlags & SF_OrderByReqd)==0      /* Condition (2) */
6435      && (p->selFlags & SF_OrderByReqd)==0         /* Condition (3) and (4) */
6436      && OptimizationEnabled(db, SQLITE_OmitOrderBy)
6437     ){
6438       SELECTTRACE(0x100,pParse,p,
6439                 ("omit superfluous ORDER BY on %r FROM-clause subquery\n",i+1));
6440       sqlite3ExprListDelete(db, pSub->pOrderBy);
6441       pSub->pOrderBy = 0;
6442     }
6443 
6444     /* If the outer query contains a "complex" result set (that is,
6445     ** if the result set of the outer query uses functions or subqueries)
6446     ** and if the subquery contains an ORDER BY clause and if
6447     ** it will be implemented as a co-routine, then do not flatten.  This
6448     ** restriction allows SQL constructs like this:
6449     **
6450     **  SELECT expensive_function(x)
6451     **    FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
6452     **
6453     ** The expensive_function() is only computed on the 10 rows that
6454     ** are output, rather than every row of the table.
6455     **
6456     ** The requirement that the outer query have a complex result set
6457     ** means that flattening does occur on simpler SQL constraints without
6458     ** the expensive_function() like:
6459     **
6460     **  SELECT x FROM (SELECT x FROM tab ORDER BY y LIMIT 10);
6461     */
6462     if( pSub->pOrderBy!=0
6463      && i==0
6464      && (p->selFlags & SF_ComplexResult)!=0
6465      && (pTabList->nSrc==1
6466          || (pTabList->a[1].fg.jointype&(JT_LEFT|JT_CROSS))!=0)
6467     ){
6468       continue;
6469     }
6470 
6471     if( flattenSubquery(pParse, p, i, isAgg) ){
6472       if( pParse->nErr ) goto select_end;
6473       /* This subquery can be absorbed into its parent. */
6474       i = -1;
6475     }
6476     pTabList = p->pSrc;
6477     if( db->mallocFailed ) goto select_end;
6478     if( !IgnorableOrderby(pDest) ){
6479       sSort.pOrderBy = p->pOrderBy;
6480     }
6481   }
6482 #endif
6483 
6484 #ifndef SQLITE_OMIT_COMPOUND_SELECT
6485   /* Handle compound SELECT statements using the separate multiSelect()
6486   ** procedure.
6487   */
6488   if( p->pPrior ){
6489     rc = multiSelect(pParse, p, pDest);
6490 #if SELECTTRACE_ENABLED
6491     SELECTTRACE(0x1,pParse,p,("end compound-select processing\n"));
6492     if( (sqlite3SelectTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
6493       sqlite3TreeViewSelect(0, p, 0);
6494     }
6495 #endif
6496     if( p->pNext==0 ) ExplainQueryPlanPop(pParse);
6497     return rc;
6498   }
6499 #endif
6500 
6501   /* Do the WHERE-clause constant propagation optimization if this is
6502   ** a join.  No need to speed time on this operation for non-join queries
6503   ** as the equivalent optimization will be handled by query planner in
6504   ** sqlite3WhereBegin().
6505   */
6506   if( p->pWhere!=0
6507    && p->pWhere->op==TK_AND
6508    && OptimizationEnabled(db, SQLITE_PropagateConst)
6509    && propagateConstants(pParse, p)
6510   ){
6511 #if SELECTTRACE_ENABLED
6512     if( sqlite3SelectTrace & 0x100 ){
6513       SELECTTRACE(0x100,pParse,p,("After constant propagation:\n"));
6514       sqlite3TreeViewSelect(0, p, 0);
6515     }
6516 #endif
6517   }else{
6518     SELECTTRACE(0x100,pParse,p,("Constant propagation not helpful\n"));
6519   }
6520 
6521 #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
6522   if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
6523    && countOfViewOptimization(pParse, p)
6524   ){
6525     if( db->mallocFailed ) goto select_end;
6526     pEList = p->pEList;
6527     pTabList = p->pSrc;
6528   }
6529 #endif
6530 
6531   /* For each term in the FROM clause, do two things:
6532   ** (1) Authorized unreferenced tables
6533   ** (2) Generate code for all sub-queries
6534   */
6535   for(i=0; i<pTabList->nSrc; i++){
6536     SrcItem *pItem = &pTabList->a[i];
6537     SrcItem *pPrior;
6538     SelectDest dest;
6539     Select *pSub;
6540 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6541     const char *zSavedAuthContext;
6542 #endif
6543 
6544     /* Issue SQLITE_READ authorizations with a fake column name for any
6545     ** tables that are referenced but from which no values are extracted.
6546     ** Examples of where these kinds of null SQLITE_READ authorizations
6547     ** would occur:
6548     **
6549     **     SELECT count(*) FROM t1;   -- SQLITE_READ t1.""
6550     **     SELECT t1.* FROM t1, t2;   -- SQLITE_READ t2.""
6551     **
6552     ** The fake column name is an empty string.  It is possible for a table to
6553     ** have a column named by the empty string, in which case there is no way to
6554     ** distinguish between an unreferenced table and an actual reference to the
6555     ** "" column. The original design was for the fake column name to be a NULL,
6556     ** which would be unambiguous.  But legacy authorization callbacks might
6557     ** assume the column name is non-NULL and segfault.  The use of an empty
6558     ** string for the fake column name seems safer.
6559     */
6560     if( pItem->colUsed==0 && pItem->zName!=0 ){
6561       sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
6562     }
6563 
6564 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
6565     /* Generate code for all sub-queries in the FROM clause
6566     */
6567     pSub = pItem->pSelect;
6568     if( pSub==0 ) continue;
6569 
6570     /* The code for a subquery should only be generated once. */
6571     assert( pItem->addrFillSub==0 );
6572 
6573     /* Increment Parse.nHeight by the height of the largest expression
6574     ** tree referred to by this, the parent select. The child select
6575     ** may contain expression trees of at most
6576     ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
6577     ** more conservative than necessary, but much easier than enforcing
6578     ** an exact limit.
6579     */
6580     pParse->nHeight += sqlite3SelectExprHeight(p);
6581 
6582     /* Make copies of constant WHERE-clause terms in the outer query down
6583     ** inside the subquery.  This can help the subquery to run more efficiently.
6584     */
6585     if( OptimizationEnabled(db, SQLITE_PushDown)
6586      && (pItem->fg.isCte==0 || pItem->u2.pCteUse->eM10d!=M10d_Yes)
6587      && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem->iCursor,
6588                            (pItem->fg.jointype & JT_OUTER)!=0)
6589     ){
6590 #if SELECTTRACE_ENABLED
6591       if( sqlite3SelectTrace & 0x100 ){
6592         SELECTTRACE(0x100,pParse,p,
6593             ("After WHERE-clause push-down into subquery %d:\n", pSub->selId));
6594         sqlite3TreeViewSelect(0, p, 0);
6595       }
6596 #endif
6597       assert( pItem->pSelect && (pItem->pSelect->selFlags & SF_PushDown)!=0 );
6598     }else{
6599       SELECTTRACE(0x100,pParse,p,("Push-down not possible\n"));
6600     }
6601 
6602     zSavedAuthContext = pParse->zAuthContext;
6603     pParse->zAuthContext = pItem->zName;
6604 
6605     /* Generate code to implement the subquery
6606     **
6607     ** The subquery is implemented as a co-routine if:
6608     **    (1)  the subquery is guaranteed to be the outer loop (so that
6609     **         it does not need to be computed more than once), and
6610     **    (2)  the subquery is not a CTE that should be materialized
6611     **
6612     ** TODO: Are there other reasons beside (1) and (2) to use a co-routine
6613     ** implementation?
6614     */
6615     if( i==0
6616      && (pTabList->nSrc==1
6617             || (pTabList->a[1].fg.jointype&(JT_LEFT|JT_CROSS))!=0)  /* (1) */
6618      && (pItem->fg.isCte==0 || pItem->u2.pCteUse->eM10d!=M10d_Yes)  /* (2) */
6619     ){
6620       /* Implement a co-routine that will return a single row of the result
6621       ** set on each invocation.
6622       */
6623       int addrTop = sqlite3VdbeCurrentAddr(v)+1;
6624 
6625       pItem->regReturn = ++pParse->nMem;
6626       sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
6627       VdbeComment((v, "%!S", pItem));
6628       pItem->addrFillSub = addrTop;
6629       sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
6630       ExplainQueryPlan((pParse, 1, "CO-ROUTINE %!S", pItem));
6631       sqlite3Select(pParse, pSub, &dest);
6632       pItem->pTab->nRowLogEst = pSub->nSelectRow;
6633       pItem->fg.viaCoroutine = 1;
6634       pItem->regResult = dest.iSdst;
6635       sqlite3VdbeEndCoroutine(v, pItem->regReturn);
6636       sqlite3VdbeJumpHere(v, addrTop-1);
6637       sqlite3ClearTempRegCache(pParse);
6638     }else if( pItem->fg.isCte && pItem->u2.pCteUse->addrM9e>0 ){
6639       /* This is a CTE for which materialization code has already been
6640       ** generated.  Invoke the subroutine to compute the materialization,
6641       ** the make the pItem->iCursor be a copy of the ephemerial table that
6642       ** holds the result of the materialization. */
6643       CteUse *pCteUse = pItem->u2.pCteUse;
6644       sqlite3VdbeAddOp2(v, OP_Gosub, pCteUse->regRtn, pCteUse->addrM9e);
6645       if( pItem->iCursor!=pCteUse->iCur ){
6646         sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pCteUse->iCur);
6647       }
6648       pSub->nSelectRow = pCteUse->nRowEst;
6649     }else if( (pPrior = isSelfJoinView(pTabList, pItem))!=0 ){
6650       /* This view has already been materialized by a prior entry in
6651       ** this same FROM clause.  Reuse it. */
6652       if( pPrior->addrFillSub ){
6653         sqlite3VdbeAddOp2(v, OP_Gosub, pPrior->regReturn, pPrior->addrFillSub);
6654       }
6655       sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
6656       pSub->nSelectRow = pPrior->pSelect->nSelectRow;
6657     }else{
6658       /* Materialize the view.  If the view is not correlated, generate a
6659       ** subroutine to do the materialization so that subsequent uses of
6660       ** the same view can reuse the materialization. */
6661       int topAddr;
6662       int onceAddr = 0;
6663       int retAddr;
6664 
6665       pItem->regReturn = ++pParse->nMem;
6666       topAddr = sqlite3VdbeAddOp2(v, OP_Integer, 0, pItem->regReturn);
6667       pItem->addrFillSub = topAddr+1;
6668       if( pItem->fg.isCorrelated==0 ){
6669         /* If the subquery is not correlated and if we are not inside of
6670         ** a trigger, then we only need to compute the value of the subquery
6671         ** once. */
6672         onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
6673         VdbeComment((v, "materialize %!S", pItem));
6674       }else{
6675         VdbeNoopComment((v, "materialize %!S", pItem));
6676       }
6677       sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
6678       ExplainQueryPlan((pParse, 1, "MATERIALIZE %!S", pItem));
6679       sqlite3Select(pParse, pSub, &dest);
6680       pItem->pTab->nRowLogEst = pSub->nSelectRow;
6681       if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
6682       retAddr = sqlite3VdbeAddOp1(v, OP_Return, pItem->regReturn);
6683       VdbeComment((v, "end %!S", pItem));
6684       sqlite3VdbeChangeP1(v, topAddr, retAddr);
6685       sqlite3ClearTempRegCache(pParse);
6686       if( pItem->fg.isCte && pItem->fg.isCorrelated==0 ){
6687         CteUse *pCteUse = pItem->u2.pCteUse;
6688         pCteUse->addrM9e = pItem->addrFillSub;
6689         pCteUse->regRtn = pItem->regReturn;
6690         pCteUse->iCur = pItem->iCursor;
6691         pCteUse->nRowEst = pSub->nSelectRow;
6692       }
6693     }
6694     if( db->mallocFailed ) goto select_end;
6695     pParse->nHeight -= sqlite3SelectExprHeight(p);
6696     pParse->zAuthContext = zSavedAuthContext;
6697 #endif
6698   }
6699 
6700   /* Various elements of the SELECT copied into local variables for
6701   ** convenience */
6702   pEList = p->pEList;
6703   pWhere = p->pWhere;
6704   pGroupBy = p->pGroupBy;
6705   pHaving = p->pHaving;
6706   sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
6707 
6708 #if SELECTTRACE_ENABLED
6709   if( sqlite3SelectTrace & 0x400 ){
6710     SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
6711     sqlite3TreeViewSelect(0, p, 0);
6712   }
6713 #endif
6714 
6715   /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
6716   ** if the select-list is the same as the ORDER BY list, then this query
6717   ** can be rewritten as a GROUP BY. In other words, this:
6718   **
6719   **     SELECT DISTINCT xyz FROM ... ORDER BY xyz
6720   **
6721   ** is transformed to:
6722   **
6723   **     SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
6724   **
6725   ** The second form is preferred as a single index (or temp-table) may be
6726   ** used for both the ORDER BY and DISTINCT processing. As originally
6727   ** written the query must use a temp-table for at least one of the ORDER
6728   ** BY and DISTINCT, and an index or separate temp-table for the other.
6729   */
6730   if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
6731    && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
6732 #ifndef SQLITE_OMIT_WINDOWFUNC
6733    && p->pWin==0
6734 #endif
6735   ){
6736     p->selFlags &= ~SF_Distinct;
6737     pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
6738     p->selFlags |= SF_Aggregate;
6739     /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
6740     ** the sDistinct.isTnct is still set.  Hence, isTnct represents the
6741     ** original setting of the SF_Distinct flag, not the current setting */
6742     assert( sDistinct.isTnct );
6743 
6744 #if SELECTTRACE_ENABLED
6745     if( sqlite3SelectTrace & 0x400 ){
6746       SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
6747       sqlite3TreeViewSelect(0, p, 0);
6748     }
6749 #endif
6750   }
6751 
6752   /* If there is an ORDER BY clause, then create an ephemeral index to
6753   ** do the sorting.  But this sorting ephemeral index might end up
6754   ** being unused if the data can be extracted in pre-sorted order.
6755   ** If that is the case, then the OP_OpenEphemeral instruction will be
6756   ** changed to an OP_Noop once we figure out that the sorting index is
6757   ** not needed.  The sSort.addrSortIndex variable is used to facilitate
6758   ** that change.
6759   */
6760   if( sSort.pOrderBy ){
6761     KeyInfo *pKeyInfo;
6762     pKeyInfo = sqlite3KeyInfoFromExprList(
6763         pParse, sSort.pOrderBy, 0, pEList->nExpr);
6764     sSort.iECursor = pParse->nTab++;
6765     sSort.addrSortIndex =
6766       sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6767           sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
6768           (char*)pKeyInfo, P4_KEYINFO
6769       );
6770   }else{
6771     sSort.addrSortIndex = -1;
6772   }
6773 
6774   /* If the output is destined for a temporary table, open that table.
6775   */
6776   if( pDest->eDest==SRT_EphemTab ){
6777     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
6778   }
6779 
6780   /* Set the limiter.
6781   */
6782   iEnd = sqlite3VdbeMakeLabel(pParse);
6783   if( (p->selFlags & SF_FixedLimit)==0 ){
6784     p->nSelectRow = 320;  /* 4 billion rows */
6785   }
6786   computeLimitRegisters(pParse, p, iEnd);
6787   if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
6788     sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
6789     sSort.sortFlags |= SORTFLAG_UseSorter;
6790   }
6791 
6792   /* Open an ephemeral index to use for the distinct set.
6793   */
6794   if( p->selFlags & SF_Distinct ){
6795     sDistinct.tabTnct = pParse->nTab++;
6796     sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
6797                        sDistinct.tabTnct, 0, 0,
6798                        (char*)sqlite3KeyInfoFromExprList(pParse, p->pEList,0,0),
6799                        P4_KEYINFO);
6800     sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
6801     sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
6802   }else{
6803     sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
6804   }
6805 
6806   if( !isAgg && pGroupBy==0 ){
6807     /* No aggregate functions and no GROUP BY clause */
6808     u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0)
6809                    | (p->selFlags & SF_FixedLimit);
6810 #ifndef SQLITE_OMIT_WINDOWFUNC
6811     Window *pWin = p->pWin;      /* Main window object (or NULL) */
6812     if( pWin ){
6813       sqlite3WindowCodeInit(pParse, p);
6814     }
6815 #endif
6816     assert( WHERE_USE_LIMIT==SF_FixedLimit );
6817 
6818 
6819     /* Begin the database scan. */
6820     SELECTTRACE(1,pParse,p,("WhereBegin\n"));
6821     pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
6822                                p->pEList, wctrlFlags, p->nSelectRow);
6823     if( pWInfo==0 ) goto select_end;
6824     if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
6825       p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
6826     }
6827     if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
6828       sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
6829     }
6830     if( sSort.pOrderBy ){
6831       sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
6832       sSort.labelOBLopt = sqlite3WhereOrderByLimitOptLabel(pWInfo);
6833       if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
6834         sSort.pOrderBy = 0;
6835       }
6836     }
6837     SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
6838 
6839     /* If sorting index that was created by a prior OP_OpenEphemeral
6840     ** instruction ended up not being needed, then change the OP_OpenEphemeral
6841     ** into an OP_Noop.
6842     */
6843     if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
6844       sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
6845     }
6846 
6847     assert( p->pEList==pEList );
6848 #ifndef SQLITE_OMIT_WINDOWFUNC
6849     if( pWin ){
6850       int addrGosub = sqlite3VdbeMakeLabel(pParse);
6851       int iCont = sqlite3VdbeMakeLabel(pParse);
6852       int iBreak = sqlite3VdbeMakeLabel(pParse);
6853       int regGosub = ++pParse->nMem;
6854 
6855       sqlite3WindowCodeStep(pParse, p, pWInfo, regGosub, addrGosub);
6856 
6857       sqlite3VdbeAddOp2(v, OP_Goto, 0, iBreak);
6858       sqlite3VdbeResolveLabel(v, addrGosub);
6859       VdbeNoopComment((v, "inner-loop subroutine"));
6860       sSort.labelOBLopt = 0;
6861       selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest, iCont, iBreak);
6862       sqlite3VdbeResolveLabel(v, iCont);
6863       sqlite3VdbeAddOp1(v, OP_Return, regGosub);
6864       VdbeComment((v, "end inner-loop subroutine"));
6865       sqlite3VdbeResolveLabel(v, iBreak);
6866     }else
6867 #endif /* SQLITE_OMIT_WINDOWFUNC */
6868     {
6869       /* Use the standard inner loop. */
6870       selectInnerLoop(pParse, p, -1, &sSort, &sDistinct, pDest,
6871           sqlite3WhereContinueLabel(pWInfo),
6872           sqlite3WhereBreakLabel(pWInfo));
6873 
6874       /* End the database scan loop.
6875       */
6876       SELECTTRACE(1,pParse,p,("WhereEnd\n"));
6877       sqlite3WhereEnd(pWInfo);
6878     }
6879   }else{
6880     /* This case when there exist aggregate functions or a GROUP BY clause
6881     ** or both */
6882     NameContext sNC;    /* Name context for processing aggregate information */
6883     int iAMem;          /* First Mem address for storing current GROUP BY */
6884     int iBMem;          /* First Mem address for previous GROUP BY */
6885     int iUseFlag;       /* Mem address holding flag indicating that at least
6886                         ** one row of the input to the aggregator has been
6887                         ** processed */
6888     int iAbortFlag;     /* Mem address which causes query abort if positive */
6889     int groupBySort;    /* Rows come from source in GROUP BY order */
6890     int addrEnd;        /* End of processing for this SELECT */
6891     int sortPTab = 0;   /* Pseudotable used to decode sorting results */
6892     int sortOut = 0;    /* Output register from the sorter */
6893     int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
6894 
6895     /* Remove any and all aliases between the result set and the
6896     ** GROUP BY clause.
6897     */
6898     if( pGroupBy ){
6899       int k;                        /* Loop counter */
6900       struct ExprList_item *pItem;  /* For looping over expression in a list */
6901 
6902       for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
6903         pItem->u.x.iAlias = 0;
6904       }
6905       for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
6906         pItem->u.x.iAlias = 0;
6907       }
6908       assert( 66==sqlite3LogEst(100) );
6909       if( p->nSelectRow>66 ) p->nSelectRow = 66;
6910 
6911       /* If there is both a GROUP BY and an ORDER BY clause and they are
6912       ** identical, then it may be possible to disable the ORDER BY clause
6913       ** on the grounds that the GROUP BY will cause elements to come out
6914       ** in the correct order. It also may not - the GROUP BY might use a
6915       ** database index that causes rows to be grouped together as required
6916       ** but not actually sorted. Either way, record the fact that the
6917       ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
6918       ** variable.  */
6919       if( sSort.pOrderBy && pGroupBy->nExpr==sSort.pOrderBy->nExpr ){
6920         int ii;
6921         /* The GROUP BY processing doesn't care whether rows are delivered in
6922         ** ASC or DESC order - only that each group is returned contiguously.
6923         ** So set the ASC/DESC flags in the GROUP BY to match those in the
6924         ** ORDER BY to maximize the chances of rows being delivered in an
6925         ** order that makes the ORDER BY redundant.  */
6926         for(ii=0; ii<pGroupBy->nExpr; ii++){
6927           u8 sortFlags = sSort.pOrderBy->a[ii].sortFlags & KEYINFO_ORDER_DESC;
6928           pGroupBy->a[ii].sortFlags = sortFlags;
6929         }
6930         if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
6931           orderByGrp = 1;
6932         }
6933       }
6934     }else{
6935       assert( 0==sqlite3LogEst(1) );
6936       p->nSelectRow = 0;
6937     }
6938 
6939     /* Create a label to jump to when we want to abort the query */
6940     addrEnd = sqlite3VdbeMakeLabel(pParse);
6941 
6942     /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
6943     ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
6944     ** SELECT statement.
6945     */
6946     pAggInfo = sqlite3DbMallocZero(db, sizeof(*pAggInfo) );
6947     if( pAggInfo ){
6948       sqlite3ParserAddCleanup(pParse,
6949           (void(*)(sqlite3*,void*))agginfoFree, pAggInfo);
6950       testcase( pParse->earlyCleanup );
6951     }
6952     if( db->mallocFailed ){
6953       goto select_end;
6954     }
6955     pAggInfo->selId = p->selId;
6956     memset(&sNC, 0, sizeof(sNC));
6957     sNC.pParse = pParse;
6958     sNC.pSrcList = pTabList;
6959     sNC.uNC.pAggInfo = pAggInfo;
6960     VVA_ONLY( sNC.ncFlags = NC_UAggInfo; )
6961     pAggInfo->mnReg = pParse->nMem+1;
6962     pAggInfo->nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
6963     pAggInfo->pGroupBy = pGroupBy;
6964     sqlite3ExprAnalyzeAggList(&sNC, pEList);
6965     sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
6966     if( pHaving ){
6967       if( pGroupBy ){
6968         assert( pWhere==p->pWhere );
6969         assert( pHaving==p->pHaving );
6970         assert( pGroupBy==p->pGroupBy );
6971         havingToWhere(pParse, p);
6972         pWhere = p->pWhere;
6973       }
6974       sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
6975     }
6976     pAggInfo->nAccumulator = pAggInfo->nColumn;
6977     if( p->pGroupBy==0 && p->pHaving==0 && pAggInfo->nFunc==1 ){
6978       minMaxFlag = minMaxQuery(db, pAggInfo->aFunc[0].pFExpr, &pMinMaxOrderBy);
6979     }else{
6980       minMaxFlag = WHERE_ORDERBY_NORMAL;
6981     }
6982     for(i=0; i<pAggInfo->nFunc; i++){
6983       Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
6984       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
6985       sNC.ncFlags |= NC_InAggFunc;
6986       sqlite3ExprAnalyzeAggList(&sNC, pExpr->x.pList);
6987 #ifndef SQLITE_OMIT_WINDOWFUNC
6988       assert( !IsWindowFunc(pExpr) );
6989       if( ExprHasProperty(pExpr, EP_WinFunc) ){
6990         sqlite3ExprAnalyzeAggregates(&sNC, pExpr->y.pWin->pFilter);
6991       }
6992 #endif
6993       sNC.ncFlags &= ~NC_InAggFunc;
6994     }
6995     pAggInfo->mxReg = pParse->nMem;
6996     if( db->mallocFailed ) goto select_end;
6997 #if SELECTTRACE_ENABLED
6998     if( sqlite3SelectTrace & 0x400 ){
6999       int ii;
7000       SELECTTRACE(0x400,pParse,p,("After aggregate analysis %p:\n", pAggInfo));
7001       sqlite3TreeViewSelect(0, p, 0);
7002       if( minMaxFlag ){
7003         sqlite3DebugPrintf("MIN/MAX Optimization (0x%02x) adds:\n", minMaxFlag);
7004         sqlite3TreeViewExprList(0, pMinMaxOrderBy, 0, "ORDERBY");
7005       }
7006       for(ii=0; ii<pAggInfo->nColumn; ii++){
7007         sqlite3DebugPrintf("agg-column[%d] iMem=%d\n",
7008             ii, pAggInfo->aCol[ii].iMem);
7009         sqlite3TreeViewExpr(0, pAggInfo->aCol[ii].pCExpr, 0);
7010       }
7011       for(ii=0; ii<pAggInfo->nFunc; ii++){
7012         sqlite3DebugPrintf("agg-func[%d]: iMem=%d\n",
7013             ii, pAggInfo->aFunc[ii].iMem);
7014         sqlite3TreeViewExpr(0, pAggInfo->aFunc[ii].pFExpr, 0);
7015       }
7016     }
7017 #endif
7018 
7019 
7020     /* Processing for aggregates with GROUP BY is very different and
7021     ** much more complex than aggregates without a GROUP BY.
7022     */
7023     if( pGroupBy ){
7024       KeyInfo *pKeyInfo;  /* Keying information for the group by clause */
7025       int addr1;          /* A-vs-B comparision jump */
7026       int addrOutputRow;  /* Start of subroutine that outputs a result row */
7027       int regOutputRow;   /* Return address register for output subroutine */
7028       int addrSetAbort;   /* Set the abort flag and return */
7029       int addrTopOfLoop;  /* Top of the input loop */
7030       int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
7031       int addrReset;      /* Subroutine for resetting the accumulator */
7032       int regReset;       /* Return address register for reset subroutine */
7033       ExprList *pDistinct = 0;
7034       u16 distFlag = 0;
7035       int eDist = WHERE_DISTINCT_NOOP;
7036 
7037       if( pAggInfo->nFunc==1
7038        && pAggInfo->aFunc[0].iDistinct>=0
7039        && pAggInfo->aFunc[0].pFExpr->x.pList
7040       ){
7041         Expr *pExpr = pAggInfo->aFunc[0].pFExpr->x.pList->a[0].pExpr;
7042         pExpr = sqlite3ExprDup(db, pExpr, 0);
7043         pDistinct = sqlite3ExprListDup(db, pGroupBy, 0);
7044         pDistinct = sqlite3ExprListAppend(pParse, pDistinct, pExpr);
7045         distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
7046       }
7047 
7048       /* If there is a GROUP BY clause we might need a sorting index to
7049       ** implement it.  Allocate that sorting index now.  If it turns out
7050       ** that we do not need it after all, the OP_SorterOpen instruction
7051       ** will be converted into a Noop.
7052       */
7053       pAggInfo->sortingIdx = pParse->nTab++;
7054       pKeyInfo = sqlite3KeyInfoFromExprList(pParse, pGroupBy,
7055                                             0, pAggInfo->nColumn);
7056       addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
7057           pAggInfo->sortingIdx, pAggInfo->nSortingColumn,
7058           0, (char*)pKeyInfo, P4_KEYINFO);
7059 
7060       /* Initialize memory locations used by GROUP BY aggregate processing
7061       */
7062       iUseFlag = ++pParse->nMem;
7063       iAbortFlag = ++pParse->nMem;
7064       regOutputRow = ++pParse->nMem;
7065       addrOutputRow = sqlite3VdbeMakeLabel(pParse);
7066       regReset = ++pParse->nMem;
7067       addrReset = sqlite3VdbeMakeLabel(pParse);
7068       iAMem = pParse->nMem + 1;
7069       pParse->nMem += pGroupBy->nExpr;
7070       iBMem = pParse->nMem + 1;
7071       pParse->nMem += pGroupBy->nExpr;
7072       sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
7073       VdbeComment((v, "clear abort flag"));
7074       sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
7075 
7076       /* Begin a loop that will extract all source rows in GROUP BY order.
7077       ** This might involve two separate loops with an OP_Sort in between, or
7078       ** it might be a single loop that uses an index to extract information
7079       ** in the right order to begin with.
7080       */
7081       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
7082       SELECTTRACE(1,pParse,p,("WhereBegin\n"));
7083       pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, pDistinct,
7084           WHERE_GROUPBY | (orderByGrp ? WHERE_SORTBYGROUP : 0) | distFlag, 0
7085       );
7086       if( pWInfo==0 ){
7087         sqlite3ExprListDelete(db, pDistinct);
7088         goto select_end;
7089       }
7090       eDist = sqlite3WhereIsDistinct(pWInfo);
7091       SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
7092       if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
7093         /* The optimizer is able to deliver rows in group by order so
7094         ** we do not have to sort.  The OP_OpenEphemeral table will be
7095         ** cancelled later because we still need to use the pKeyInfo
7096         */
7097         groupBySort = 0;
7098       }else{
7099         /* Rows are coming out in undetermined order.  We have to push
7100         ** each row into a sorting index, terminate the first loop,
7101         ** then loop over the sorting index in order to get the output
7102         ** in sorted order
7103         */
7104         int regBase;
7105         int regRecord;
7106         int nCol;
7107         int nGroupBy;
7108 
7109         explainTempTable(pParse,
7110             (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
7111                     "DISTINCT" : "GROUP BY");
7112 
7113         groupBySort = 1;
7114         nGroupBy = pGroupBy->nExpr;
7115         nCol = nGroupBy;
7116         j = nGroupBy;
7117         for(i=0; i<pAggInfo->nColumn; i++){
7118           if( pAggInfo->aCol[i].iSorterColumn>=j ){
7119             nCol++;
7120             j++;
7121           }
7122         }
7123         regBase = sqlite3GetTempRange(pParse, nCol);
7124         sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
7125         j = nGroupBy;
7126         for(i=0; i<pAggInfo->nColumn; i++){
7127           struct AggInfo_col *pCol = &pAggInfo->aCol[i];
7128           if( pCol->iSorterColumn>=j ){
7129             int r1 = j + regBase;
7130             sqlite3ExprCodeGetColumnOfTable(v,
7131                                pCol->pTab, pCol->iTable, pCol->iColumn, r1);
7132             j++;
7133           }
7134         }
7135         regRecord = sqlite3GetTempReg(pParse);
7136         sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
7137         sqlite3VdbeAddOp2(v, OP_SorterInsert, pAggInfo->sortingIdx, regRecord);
7138         sqlite3ReleaseTempReg(pParse, regRecord);
7139         sqlite3ReleaseTempRange(pParse, regBase, nCol);
7140         SELECTTRACE(1,pParse,p,("WhereEnd\n"));
7141         sqlite3WhereEnd(pWInfo);
7142         pAggInfo->sortingIdxPTab = sortPTab = pParse->nTab++;
7143         sortOut = sqlite3GetTempReg(pParse);
7144         sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
7145         sqlite3VdbeAddOp2(v, OP_SorterSort, pAggInfo->sortingIdx, addrEnd);
7146         VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
7147         pAggInfo->useSortingIdx = 1;
7148       }
7149 
7150       /* If the index or temporary table used by the GROUP BY sort
7151       ** will naturally deliver rows in the order required by the ORDER BY
7152       ** clause, cancel the ephemeral table open coded earlier.
7153       **
7154       ** This is an optimization - the correct answer should result regardless.
7155       ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
7156       ** disable this optimization for testing purposes.  */
7157       if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
7158        && (groupBySort || sqlite3WhereIsSorted(pWInfo))
7159       ){
7160         sSort.pOrderBy = 0;
7161         sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
7162       }
7163 
7164       /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
7165       ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
7166       ** Then compare the current GROUP BY terms against the GROUP BY terms
7167       ** from the previous row currently stored in a0, a1, a2...
7168       */
7169       addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
7170       if( groupBySort ){
7171         sqlite3VdbeAddOp3(v, OP_SorterData, pAggInfo->sortingIdx,
7172                           sortOut, sortPTab);
7173       }
7174       for(j=0; j<pGroupBy->nExpr; j++){
7175         if( groupBySort ){
7176           sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
7177         }else{
7178           pAggInfo->directMode = 1;
7179           sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
7180         }
7181       }
7182       sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
7183                           (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
7184       addr1 = sqlite3VdbeCurrentAddr(v);
7185       sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
7186 
7187       /* Generate code that runs whenever the GROUP BY changes.
7188       ** Changes in the GROUP BY are detected by the previous code
7189       ** block.  If there were no changes, this block is skipped.
7190       **
7191       ** This code copies current group by terms in b0,b1,b2,...
7192       ** over to a0,a1,a2.  It then calls the output subroutine
7193       ** and resets the aggregate accumulator registers in preparation
7194       ** for the next GROUP BY batch.
7195       */
7196       sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
7197       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
7198       VdbeComment((v, "output one row"));
7199       sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
7200       VdbeComment((v, "check abort flag"));
7201       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
7202       VdbeComment((v, "reset accumulator"));
7203 
7204       /* Update the aggregate accumulators based on the content of
7205       ** the current row
7206       */
7207       sqlite3VdbeJumpHere(v, addr1);
7208       updateAccumulator(pParse, iUseFlag, pAggInfo, eDist);
7209       sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
7210       VdbeComment((v, "indicate data in accumulator"));
7211 
7212       /* End of the loop
7213       */
7214       if( groupBySort ){
7215         sqlite3VdbeAddOp2(v, OP_SorterNext, pAggInfo->sortingIdx,addrTopOfLoop);
7216         VdbeCoverage(v);
7217       }else{
7218         SELECTTRACE(1,pParse,p,("WhereEnd\n"));
7219         sqlite3WhereEnd(pWInfo);
7220         sqlite3VdbeChangeToNoop(v, addrSortingIdx);
7221       }
7222       sqlite3ExprListDelete(db, pDistinct);
7223 
7224       /* Output the final row of result
7225       */
7226       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
7227       VdbeComment((v, "output final row"));
7228 
7229       /* Jump over the subroutines
7230       */
7231       sqlite3VdbeGoto(v, addrEnd);
7232 
7233       /* Generate a subroutine that outputs a single row of the result
7234       ** set.  This subroutine first looks at the iUseFlag.  If iUseFlag
7235       ** is less than or equal to zero, the subroutine is a no-op.  If
7236       ** the processing calls for the query to abort, this subroutine
7237       ** increments the iAbortFlag memory location before returning in
7238       ** order to signal the caller to abort.
7239       */
7240       addrSetAbort = sqlite3VdbeCurrentAddr(v);
7241       sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
7242       VdbeComment((v, "set abort flag"));
7243       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7244       sqlite3VdbeResolveLabel(v, addrOutputRow);
7245       addrOutputRow = sqlite3VdbeCurrentAddr(v);
7246       sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
7247       VdbeCoverage(v);
7248       VdbeComment((v, "Groupby result generator entry point"));
7249       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7250       finalizeAggFunctions(pParse, pAggInfo);
7251       sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
7252       selectInnerLoop(pParse, p, -1, &sSort,
7253                       &sDistinct, pDest,
7254                       addrOutputRow+1, addrSetAbort);
7255       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
7256       VdbeComment((v, "end groupby result generator"));
7257 
7258       /* Generate a subroutine that will reset the group-by accumulator
7259       */
7260       sqlite3VdbeResolveLabel(v, addrReset);
7261       resetAccumulator(pParse, pAggInfo);
7262       sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
7263       VdbeComment((v, "indicate accumulator empty"));
7264       sqlite3VdbeAddOp1(v, OP_Return, regReset);
7265 
7266       if( eDist!=WHERE_DISTINCT_NOOP ){
7267         struct AggInfo_func *pF = &pAggInfo->aFunc[0];
7268         fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7269       }
7270     } /* endif pGroupBy.  Begin aggregate queries without GROUP BY: */
7271     else {
7272       Table *pTab;
7273       if( (pTab = isSimpleCount(p, pAggInfo))!=0 ){
7274         /* If isSimpleCount() returns a pointer to a Table structure, then
7275         ** the SQL statement is of the form:
7276         **
7277         **   SELECT count(*) FROM <tbl>
7278         **
7279         ** where the Table structure returned represents table <tbl>.
7280         **
7281         ** This statement is so common that it is optimized specially. The
7282         ** OP_Count instruction is executed either on the intkey table that
7283         ** contains the data for table <tbl> or on one of its indexes. It
7284         ** is better to execute the op on an index, as indexes are almost
7285         ** always spread across less pages than their corresponding tables.
7286         */
7287         const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
7288         const int iCsr = pParse->nTab++;     /* Cursor to scan b-tree */
7289         Index *pIdx;                         /* Iterator variable */
7290         KeyInfo *pKeyInfo = 0;               /* Keyinfo for scanned index */
7291         Index *pBest = 0;                    /* Best index found so far */
7292         Pgno iRoot = pTab->tnum;             /* Root page of scanned b-tree */
7293 
7294         sqlite3CodeVerifySchema(pParse, iDb);
7295         sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
7296 
7297         /* Search for the index that has the lowest scan cost.
7298         **
7299         ** (2011-04-15) Do not do a full scan of an unordered index.
7300         **
7301         ** (2013-10-03) Do not count the entries in a partial index.
7302         **
7303         ** In practice the KeyInfo structure will not be used. It is only
7304         ** passed to keep OP_OpenRead happy.
7305         */
7306         if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
7307         if( !p->pSrc->a[0].fg.notIndexed ){
7308           for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
7309             if( pIdx->bUnordered==0
7310              && pIdx->szIdxRow<pTab->szTabRow
7311              && pIdx->pPartIdxWhere==0
7312              && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
7313             ){
7314               pBest = pIdx;
7315             }
7316           }
7317         }
7318         if( pBest ){
7319           iRoot = pBest->tnum;
7320           pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
7321         }
7322 
7323         /* Open a read-only cursor, execute the OP_Count, close the cursor. */
7324         sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, (int)iRoot, iDb, 1);
7325         if( pKeyInfo ){
7326           sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
7327         }
7328         sqlite3VdbeAddOp2(v, OP_Count, iCsr, pAggInfo->aFunc[0].iMem);
7329         sqlite3VdbeAddOp1(v, OP_Close, iCsr);
7330         explainSimpleCount(pParse, pTab, pBest);
7331       }else{
7332         int regAcc = 0;           /* "populate accumulators" flag */
7333         ExprList *pDistinct = 0;
7334         u16 distFlag = 0;
7335         int eDist;
7336 
7337         /* If there are accumulator registers but no min() or max() functions
7338         ** without FILTER clauses, allocate register regAcc. Register regAcc
7339         ** will contain 0 the first time the inner loop runs, and 1 thereafter.
7340         ** The code generated by updateAccumulator() uses this to ensure
7341         ** that the accumulator registers are (a) updated only once if
7342         ** there are no min() or max functions or (b) always updated for the
7343         ** first row visited by the aggregate, so that they are updated at
7344         ** least once even if the FILTER clause means the min() or max()
7345         ** function visits zero rows.  */
7346         if( pAggInfo->nAccumulator ){
7347           for(i=0; i<pAggInfo->nFunc; i++){
7348             if( ExprHasProperty(pAggInfo->aFunc[i].pFExpr, EP_WinFunc) ){
7349               continue;
7350             }
7351             if( pAggInfo->aFunc[i].pFunc->funcFlags&SQLITE_FUNC_NEEDCOLL ){
7352               break;
7353             }
7354           }
7355           if( i==pAggInfo->nFunc ){
7356             regAcc = ++pParse->nMem;
7357             sqlite3VdbeAddOp2(v, OP_Integer, 0, regAcc);
7358           }
7359         }else if( pAggInfo->nFunc==1 && pAggInfo->aFunc[0].iDistinct>=0 ){
7360           pDistinct = pAggInfo->aFunc[0].pFExpr->x.pList;
7361           distFlag = pDistinct ? (WHERE_WANT_DISTINCT|WHERE_AGG_DISTINCT) : 0;
7362         }
7363 
7364         /* This case runs if the aggregate has no GROUP BY clause.  The
7365         ** processing is much simpler since there is only a single row
7366         ** of output.
7367         */
7368         assert( p->pGroupBy==0 );
7369         resetAccumulator(pParse, pAggInfo);
7370 
7371         /* If this query is a candidate for the min/max optimization, then
7372         ** minMaxFlag will have been previously set to either
7373         ** WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX and pMinMaxOrderBy will
7374         ** be an appropriate ORDER BY expression for the optimization.
7375         */
7376         assert( minMaxFlag==WHERE_ORDERBY_NORMAL || pMinMaxOrderBy!=0 );
7377         assert( pMinMaxOrderBy==0 || pMinMaxOrderBy->nExpr==1 );
7378 
7379         SELECTTRACE(1,pParse,p,("WhereBegin\n"));
7380         pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMaxOrderBy,
7381                                    pDistinct, minMaxFlag|distFlag, 0);
7382         if( pWInfo==0 ){
7383           goto select_end;
7384         }
7385         SELECTTRACE(1,pParse,p,("WhereBegin returns\n"));
7386         eDist = sqlite3WhereIsDistinct(pWInfo);
7387         updateAccumulator(pParse, regAcc, pAggInfo, eDist);
7388         if( eDist!=WHERE_DISTINCT_NOOP ){
7389           struct AggInfo_func *pF = &pAggInfo->aFunc[0];
7390           fixDistinctOpenEph(pParse, eDist, pF->iDistinct, pF->iDistAddr);
7391         }
7392 
7393         if( regAcc ) sqlite3VdbeAddOp2(v, OP_Integer, 1, regAcc);
7394         if( minMaxFlag ){
7395           sqlite3WhereMinMaxOptEarlyOut(v, pWInfo);
7396         }
7397         SELECTTRACE(1,pParse,p,("WhereEnd\n"));
7398         sqlite3WhereEnd(pWInfo);
7399         finalizeAggFunctions(pParse, pAggInfo);
7400       }
7401 
7402       sSort.pOrderBy = 0;
7403       sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
7404       selectInnerLoop(pParse, p, -1, 0, 0,
7405                       pDest, addrEnd, addrEnd);
7406     }
7407     sqlite3VdbeResolveLabel(v, addrEnd);
7408 
7409   } /* endif aggregate query */
7410 
7411   if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
7412     explainTempTable(pParse, "DISTINCT");
7413   }
7414 
7415   /* If there is an ORDER BY clause, then we need to sort the results
7416   ** and send them to the callback one by one.
7417   */
7418   if( sSort.pOrderBy ){
7419     explainTempTable(pParse,
7420                      sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
7421     assert( p->pEList==pEList );
7422     generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
7423   }
7424 
7425   /* Jump here to skip this query
7426   */
7427   sqlite3VdbeResolveLabel(v, iEnd);
7428 
7429   /* The SELECT has been coded. If there is an error in the Parse structure,
7430   ** set the return code to 1. Otherwise 0. */
7431   rc = (pParse->nErr>0);
7432 
7433   /* Control jumps to here if an error is encountered above, or upon
7434   ** successful coding of the SELECT.
7435   */
7436 select_end:
7437   assert( db->mallocFailed==0 || db->mallocFailed==1 );
7438   pParse->nErr += db->mallocFailed;
7439   sqlite3ExprListDelete(db, pMinMaxOrderBy);
7440 #ifdef SQLITE_DEBUG
7441   if( pAggInfo && !db->mallocFailed ){
7442     for(i=0; i<pAggInfo->nColumn; i++){
7443       Expr *pExpr = pAggInfo->aCol[i].pCExpr;
7444       assert( pExpr!=0 );
7445       assert( pExpr->pAggInfo==pAggInfo );
7446       assert( pExpr->iAgg==i );
7447     }
7448     for(i=0; i<pAggInfo->nFunc; i++){
7449       Expr *pExpr = pAggInfo->aFunc[i].pFExpr;
7450       assert( pExpr!=0 );
7451       assert( pExpr->pAggInfo==pAggInfo );
7452       assert( pExpr->iAgg==i );
7453     }
7454   }
7455 #endif
7456 
7457 #if SELECTTRACE_ENABLED
7458   SELECTTRACE(0x1,pParse,p,("end processing\n"));
7459   if( (sqlite3SelectTrace & 0x2000)!=0 && ExplainQueryPlanParent(pParse)==0 ){
7460     sqlite3TreeViewSelect(0, p, 0);
7461   }
7462 #endif
7463   ExplainQueryPlanPop(pParse);
7464   return rc;
7465 }
7466