xref: /sqlite-3.40.0/src/select.c (revision 91ea8cf4)
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 ** Trace output macros
19 */
20 #if SELECTTRACE_ENABLED
21 /***/ int sqlite3SelectTrace = 0;
22 # define SELECTTRACE(K,P,S,X)  \
23   if(sqlite3SelectTrace&(K))   \
24     sqlite3DebugPrintf("%*s%s.%p: ",(P)->nSelectIndent*2-2,"",\
25         (S)->zSelName,(S)),\
26     sqlite3DebugPrintf X
27 #else
28 # define SELECTTRACE(K,P,S,X)
29 #endif
30 
31 
32 /*
33 ** An instance of the following object is used to record information about
34 ** how to process the DISTINCT keyword, to simplify passing that information
35 ** into the selectInnerLoop() routine.
36 */
37 typedef struct DistinctCtx DistinctCtx;
38 struct DistinctCtx {
39   u8 isTnct;      /* True if the DISTINCT keyword is present */
40   u8 eTnctType;   /* One of the WHERE_DISTINCT_* operators */
41   int tabTnct;    /* Ephemeral table used for DISTINCT processing */
42   int addrTnct;   /* Address of OP_OpenEphemeral opcode for tabTnct */
43 };
44 
45 /*
46 ** An instance of the following object is used to record information about
47 ** the ORDER BY (or GROUP BY) clause of query is being coded.
48 */
49 typedef struct SortCtx SortCtx;
50 struct SortCtx {
51   ExprList *pOrderBy;   /* The ORDER BY (or GROUP BY clause) */
52   int nOBSat;           /* Number of ORDER BY terms satisfied by indices */
53   int iECursor;         /* Cursor number for the sorter */
54   int regReturn;        /* Register holding block-output return address */
55   int labelBkOut;       /* Start label for the block-output subroutine */
56   int addrSortIndex;    /* Address of the OP_SorterOpen or OP_OpenEphemeral */
57   int labelDone;        /* Jump here when done, ex: LIMIT reached */
58   u8 sortFlags;         /* Zero or more SORTFLAG_* bits */
59   u8 bOrderedInnerLoop; /* ORDER BY correctly sorts the inner loop */
60 };
61 #define SORTFLAG_UseSorter  0x01   /* Use SorterOpen instead of OpenEphemeral */
62 
63 /*
64 ** Delete all the content of a Select structure.  Deallocate the structure
65 ** itself only if bFree is true.
66 */
67 static void clearSelect(sqlite3 *db, Select *p, int bFree){
68   while( p ){
69     Select *pPrior = p->pPrior;
70     sqlite3ExprListDelete(db, p->pEList);
71     sqlite3SrcListDelete(db, p->pSrc);
72     sqlite3ExprDelete(db, p->pWhere);
73     sqlite3ExprListDelete(db, p->pGroupBy);
74     sqlite3ExprDelete(db, p->pHaving);
75     sqlite3ExprListDelete(db, p->pOrderBy);
76     sqlite3ExprDelete(db, p->pLimit);
77     sqlite3ExprDelete(db, p->pOffset);
78     if( p->pWith ) sqlite3WithDelete(db, p->pWith);
79     if( bFree ) sqlite3DbFreeNN(db, p);
80     p = pPrior;
81     bFree = 1;
82   }
83 }
84 
85 /*
86 ** Initialize a SelectDest structure.
87 */
88 void sqlite3SelectDestInit(SelectDest *pDest, int eDest, int iParm){
89   pDest->eDest = (u8)eDest;
90   pDest->iSDParm = iParm;
91   pDest->zAffSdst = 0;
92   pDest->iSdst = 0;
93   pDest->nSdst = 0;
94 }
95 
96 
97 /*
98 ** Allocate a new Select structure and return a pointer to that
99 ** structure.
100 */
101 Select *sqlite3SelectNew(
102   Parse *pParse,        /* Parsing context */
103   ExprList *pEList,     /* which columns to include in the result */
104   SrcList *pSrc,        /* the FROM clause -- which tables to scan */
105   Expr *pWhere,         /* the WHERE clause */
106   ExprList *pGroupBy,   /* the GROUP BY clause */
107   Expr *pHaving,        /* the HAVING clause */
108   ExprList *pOrderBy,   /* the ORDER BY clause */
109   u32 selFlags,         /* Flag parameters, such as SF_Distinct */
110   Expr *pLimit,         /* LIMIT value.  NULL means not used */
111   Expr *pOffset         /* OFFSET value.  NULL means no offset */
112 ){
113   Select *pNew;
114   Select standin;
115   pNew = sqlite3DbMallocRawNN(pParse->db, sizeof(*pNew) );
116   if( pNew==0 ){
117     assert( pParse->db->mallocFailed );
118     pNew = &standin;
119   }
120   if( pEList==0 ){
121     pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(pParse->db,TK_ASTERISK,0));
122   }
123   pNew->pEList = pEList;
124   pNew->op = TK_SELECT;
125   pNew->selFlags = selFlags;
126   pNew->iLimit = 0;
127   pNew->iOffset = 0;
128 #if SELECTTRACE_ENABLED
129   pNew->zSelName[0] = 0;
130 #endif
131   pNew->addrOpenEphm[0] = -1;
132   pNew->addrOpenEphm[1] = -1;
133   pNew->nSelectRow = 0;
134   if( pSrc==0 ) pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*pSrc));
135   pNew->pSrc = pSrc;
136   pNew->pWhere = pWhere;
137   pNew->pGroupBy = pGroupBy;
138   pNew->pHaving = pHaving;
139   pNew->pOrderBy = pOrderBy;
140   pNew->pPrior = 0;
141   pNew->pNext = 0;
142   pNew->pLimit = pLimit;
143   pNew->pOffset = pOffset;
144   pNew->pWith = 0;
145   assert( pOffset==0 || pLimit!=0 || pParse->nErr>0 || pParse->db->mallocFailed!=0 );
146   if( pParse->db->mallocFailed ) {
147     clearSelect(pParse->db, pNew, pNew!=&standin);
148     pNew = 0;
149   }else{
150     assert( pNew->pSrc!=0 || pParse->nErr>0 );
151   }
152   assert( pNew!=&standin );
153   return pNew;
154 }
155 
156 #if SELECTTRACE_ENABLED
157 /*
158 ** Set the name of a Select object
159 */
160 void sqlite3SelectSetName(Select *p, const char *zName){
161   if( p && zName ){
162     sqlite3_snprintf(sizeof(p->zSelName), p->zSelName, "%s", zName);
163   }
164 }
165 #endif
166 
167 
168 /*
169 ** Delete the given Select structure and all of its substructures.
170 */
171 void sqlite3SelectDelete(sqlite3 *db, Select *p){
172   if( p ) clearSelect(db, p, 1);
173 }
174 
175 /*
176 ** Return a pointer to the right-most SELECT statement in a compound.
177 */
178 static Select *findRightmost(Select *p){
179   while( p->pNext ) p = p->pNext;
180   return p;
181 }
182 
183 /*
184 ** Given 1 to 3 identifiers preceding the JOIN keyword, determine the
185 ** type of join.  Return an integer constant that expresses that type
186 ** in terms of the following bit values:
187 **
188 **     JT_INNER
189 **     JT_CROSS
190 **     JT_OUTER
191 **     JT_NATURAL
192 **     JT_LEFT
193 **     JT_RIGHT
194 **
195 ** A full outer join is the combination of JT_LEFT and JT_RIGHT.
196 **
197 ** If an illegal or unsupported join type is seen, then still return
198 ** a join type, but put an error in the pParse structure.
199 */
200 int sqlite3JoinType(Parse *pParse, Token *pA, Token *pB, Token *pC){
201   int jointype = 0;
202   Token *apAll[3];
203   Token *p;
204                              /*   0123456789 123456789 123456789 123 */
205   static const char zKeyText[] = "naturaleftouterightfullinnercross";
206   static const struct {
207     u8 i;        /* Beginning of keyword text in zKeyText[] */
208     u8 nChar;    /* Length of the keyword in characters */
209     u8 code;     /* Join type mask */
210   } aKeyword[] = {
211     /* natural */ { 0,  7, JT_NATURAL                },
212     /* left    */ { 6,  4, JT_LEFT|JT_OUTER          },
213     /* outer   */ { 10, 5, JT_OUTER                  },
214     /* right   */ { 14, 5, JT_RIGHT|JT_OUTER         },
215     /* full    */ { 19, 4, JT_LEFT|JT_RIGHT|JT_OUTER },
216     /* inner   */ { 23, 5, JT_INNER                  },
217     /* cross   */ { 28, 5, JT_INNER|JT_CROSS         },
218   };
219   int i, j;
220   apAll[0] = pA;
221   apAll[1] = pB;
222   apAll[2] = pC;
223   for(i=0; i<3 && apAll[i]; i++){
224     p = apAll[i];
225     for(j=0; j<ArraySize(aKeyword); j++){
226       if( p->n==aKeyword[j].nChar
227           && sqlite3StrNICmp((char*)p->z, &zKeyText[aKeyword[j].i], p->n)==0 ){
228         jointype |= aKeyword[j].code;
229         break;
230       }
231     }
232     testcase( j==0 || j==1 || j==2 || j==3 || j==4 || j==5 || j==6 );
233     if( j>=ArraySize(aKeyword) ){
234       jointype |= JT_ERROR;
235       break;
236     }
237   }
238   if(
239      (jointype & (JT_INNER|JT_OUTER))==(JT_INNER|JT_OUTER) ||
240      (jointype & JT_ERROR)!=0
241   ){
242     const char *zSp = " ";
243     assert( pB!=0 );
244     if( pC==0 ){ zSp++; }
245     sqlite3ErrorMsg(pParse, "unknown or unsupported join type: "
246        "%T %T%s%T", pA, pB, zSp, pC);
247     jointype = JT_INNER;
248   }else if( (jointype & JT_OUTER)!=0
249          && (jointype & (JT_LEFT|JT_RIGHT))!=JT_LEFT ){
250     sqlite3ErrorMsg(pParse,
251       "RIGHT and FULL OUTER JOINs are not currently supported");
252     jointype = JT_INNER;
253   }
254   return jointype;
255 }
256 
257 /*
258 ** Return the index of a column in a table.  Return -1 if the column
259 ** is not contained in the table.
260 */
261 static int columnIndex(Table *pTab, const char *zCol){
262   int i;
263   for(i=0; i<pTab->nCol; i++){
264     if( sqlite3StrICmp(pTab->aCol[i].zName, zCol)==0 ) return i;
265   }
266   return -1;
267 }
268 
269 /*
270 ** Search the first N tables in pSrc, from left to right, looking for a
271 ** table that has a column named zCol.
272 **
273 ** When found, set *piTab and *piCol to the table index and column index
274 ** of the matching column and return TRUE.
275 **
276 ** If not found, return FALSE.
277 */
278 static int tableAndColumnIndex(
279   SrcList *pSrc,       /* Array of tables to search */
280   int N,               /* Number of tables in pSrc->a[] to search */
281   const char *zCol,    /* Name of the column we are looking for */
282   int *piTab,          /* Write index of pSrc->a[] here */
283   int *piCol           /* Write index of pSrc->a[*piTab].pTab->aCol[] here */
284 ){
285   int i;               /* For looping over tables in pSrc */
286   int iCol;            /* Index of column matching zCol */
287 
288   assert( (piTab==0)==(piCol==0) );  /* Both or neither are NULL */
289   for(i=0; i<N; i++){
290     iCol = columnIndex(pSrc->a[i].pTab, zCol);
291     if( iCol>=0 ){
292       if( piTab ){
293         *piTab = i;
294         *piCol = iCol;
295       }
296       return 1;
297     }
298   }
299   return 0;
300 }
301 
302 /*
303 ** This function is used to add terms implied by JOIN syntax to the
304 ** WHERE clause expression of a SELECT statement. The new term, which
305 ** is ANDed with the existing WHERE clause, is of the form:
306 **
307 **    (tab1.col1 = tab2.col2)
308 **
309 ** where tab1 is the iSrc'th table in SrcList pSrc and tab2 is the
310 ** (iSrc+1)'th. Column col1 is column iColLeft of tab1, and col2 is
311 ** column iColRight of tab2.
312 */
313 static void addWhereTerm(
314   Parse *pParse,                  /* Parsing context */
315   SrcList *pSrc,                  /* List of tables in FROM clause */
316   int iLeft,                      /* Index of first table to join in pSrc */
317   int iColLeft,                   /* Index of column in first table */
318   int iRight,                     /* Index of second table in pSrc */
319   int iColRight,                  /* Index of column in second table */
320   int isOuterJoin,                /* True if this is an OUTER join */
321   Expr **ppWhere                  /* IN/OUT: The WHERE clause to add to */
322 ){
323   sqlite3 *db = pParse->db;
324   Expr *pE1;
325   Expr *pE2;
326   Expr *pEq;
327 
328   assert( iLeft<iRight );
329   assert( pSrc->nSrc>iRight );
330   assert( pSrc->a[iLeft].pTab );
331   assert( pSrc->a[iRight].pTab );
332 
333   pE1 = sqlite3CreateColumnExpr(db, pSrc, iLeft, iColLeft);
334   pE2 = sqlite3CreateColumnExpr(db, pSrc, iRight, iColRight);
335 
336   pEq = sqlite3PExpr(pParse, TK_EQ, pE1, pE2);
337   if( pEq && isOuterJoin ){
338     ExprSetProperty(pEq, EP_FromJoin);
339     assert( !ExprHasProperty(pEq, EP_TokenOnly|EP_Reduced) );
340     ExprSetVVAProperty(pEq, EP_NoReduce);
341     pEq->iRightJoinTable = (i16)pE2->iTable;
342   }
343   *ppWhere = sqlite3ExprAnd(db, *ppWhere, pEq);
344 }
345 
346 /*
347 ** Set the EP_FromJoin property on all terms of the given expression.
348 ** And set the Expr.iRightJoinTable to iTable for every term in the
349 ** expression.
350 **
351 ** The EP_FromJoin property is used on terms of an expression to tell
352 ** the LEFT OUTER JOIN processing logic that this term is part of the
353 ** join restriction specified in the ON or USING clause and not a part
354 ** of the more general WHERE clause.  These terms are moved over to the
355 ** WHERE clause during join processing but we need to remember that they
356 ** originated in the ON or USING clause.
357 **
358 ** The Expr.iRightJoinTable tells the WHERE clause processing that the
359 ** expression depends on table iRightJoinTable even if that table is not
360 ** explicitly mentioned in the expression.  That information is needed
361 ** for cases like this:
362 **
363 **    SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.b AND t1.x=5
364 **
365 ** The where clause needs to defer the handling of the t1.x=5
366 ** term until after the t2 loop of the join.  In that way, a
367 ** NULL t2 row will be inserted whenever t1.x!=5.  If we do not
368 ** defer the handling of t1.x=5, it will be processed immediately
369 ** after the t1 loop and rows with t1.x!=5 will never appear in
370 ** the output, which is incorrect.
371 */
372 static void setJoinExpr(Expr *p, int iTable){
373   while( p ){
374     ExprSetProperty(p, EP_FromJoin);
375     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
376     ExprSetVVAProperty(p, EP_NoReduce);
377     p->iRightJoinTable = (i16)iTable;
378     if( p->op==TK_FUNCTION && p->x.pList ){
379       int i;
380       for(i=0; i<p->x.pList->nExpr; i++){
381         setJoinExpr(p->x.pList->a[i].pExpr, iTable);
382       }
383     }
384     setJoinExpr(p->pLeft, iTable);
385     p = p->pRight;
386   }
387 }
388 
389 /*
390 ** This routine processes the join information for a SELECT statement.
391 ** ON and USING clauses are converted into extra terms of the WHERE clause.
392 ** NATURAL joins also create extra WHERE clause terms.
393 **
394 ** The terms of a FROM clause are contained in the Select.pSrc structure.
395 ** The left most table is the first entry in Select.pSrc.  The right-most
396 ** table is the last entry.  The join operator is held in the entry to
397 ** the left.  Thus entry 0 contains the join operator for the join between
398 ** entries 0 and 1.  Any ON or USING clauses associated with the join are
399 ** also attached to the left entry.
400 **
401 ** This routine returns the number of errors encountered.
402 */
403 static int sqliteProcessJoin(Parse *pParse, Select *p){
404   SrcList *pSrc;                  /* All tables in the FROM clause */
405   int i, j;                       /* Loop counters */
406   struct SrcList_item *pLeft;     /* Left table being joined */
407   struct SrcList_item *pRight;    /* Right table being joined */
408 
409   pSrc = p->pSrc;
410   pLeft = &pSrc->a[0];
411   pRight = &pLeft[1];
412   for(i=0; i<pSrc->nSrc-1; i++, pRight++, pLeft++){
413     Table *pLeftTab = pLeft->pTab;
414     Table *pRightTab = pRight->pTab;
415     int isOuter;
416 
417     if( NEVER(pLeftTab==0 || pRightTab==0) ) continue;
418     isOuter = (pRight->fg.jointype & JT_OUTER)!=0;
419 
420     /* When the NATURAL keyword is present, add WHERE clause terms for
421     ** every column that the two tables have in common.
422     */
423     if( pRight->fg.jointype & JT_NATURAL ){
424       if( pRight->pOn || pRight->pUsing ){
425         sqlite3ErrorMsg(pParse, "a NATURAL join may not have "
426            "an ON or USING clause", 0);
427         return 1;
428       }
429       for(j=0; j<pRightTab->nCol; j++){
430         char *zName;   /* Name of column in the right table */
431         int iLeft;     /* Matching left table */
432         int iLeftCol;  /* Matching column in the left table */
433 
434         zName = pRightTab->aCol[j].zName;
435         if( tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol) ){
436           addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, j,
437                        isOuter, &p->pWhere);
438         }
439       }
440     }
441 
442     /* Disallow both ON and USING clauses in the same join
443     */
444     if( pRight->pOn && pRight->pUsing ){
445       sqlite3ErrorMsg(pParse, "cannot have both ON and USING "
446         "clauses in the same join");
447       return 1;
448     }
449 
450     /* Add the ON clause to the end of the WHERE clause, connected by
451     ** an AND operator.
452     */
453     if( pRight->pOn ){
454       if( isOuter ) setJoinExpr(pRight->pOn, pRight->iCursor);
455       p->pWhere = sqlite3ExprAnd(pParse->db, p->pWhere, pRight->pOn);
456       pRight->pOn = 0;
457     }
458 
459     /* Create extra terms on the WHERE clause for each column named
460     ** in the USING clause.  Example: If the two tables to be joined are
461     ** A and B and the USING clause names X, Y, and Z, then add this
462     ** to the WHERE clause:    A.X=B.X AND A.Y=B.Y AND A.Z=B.Z
463     ** Report an error if any column mentioned in the USING clause is
464     ** not contained in both tables to be joined.
465     */
466     if( pRight->pUsing ){
467       IdList *pList = pRight->pUsing;
468       for(j=0; j<pList->nId; j++){
469         char *zName;     /* Name of the term in the USING clause */
470         int iLeft;       /* Table on the left with matching column name */
471         int iLeftCol;    /* Column number of matching column on the left */
472         int iRightCol;   /* Column number of matching column on the right */
473 
474         zName = pList->a[j].zName;
475         iRightCol = columnIndex(pRightTab, zName);
476         if( iRightCol<0
477          || !tableAndColumnIndex(pSrc, i+1, zName, &iLeft, &iLeftCol)
478         ){
479           sqlite3ErrorMsg(pParse, "cannot join using column %s - column "
480             "not present in both tables", zName);
481           return 1;
482         }
483         addWhereTerm(pParse, pSrc, iLeft, iLeftCol, i+1, iRightCol,
484                      isOuter, &p->pWhere);
485       }
486     }
487   }
488   return 0;
489 }
490 
491 /* Forward reference */
492 static KeyInfo *keyInfoFromExprList(
493   Parse *pParse,       /* Parsing context */
494   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
495   int iStart,          /* Begin with this column of pList */
496   int nExtra           /* Add this many extra columns to the end */
497 );
498 
499 /*
500 ** Generate code that will push the record in registers regData
501 ** through regData+nData-1 onto the sorter.
502 */
503 static void pushOntoSorter(
504   Parse *pParse,         /* Parser context */
505   SortCtx *pSort,        /* Information about the ORDER BY clause */
506   Select *pSelect,       /* The whole SELECT statement */
507   int regData,           /* First register holding data to be sorted */
508   int regOrigData,       /* First register holding data before packing */
509   int nData,             /* Number of elements in the data array */
510   int nPrefixReg         /* No. of reg prior to regData available for use */
511 ){
512   Vdbe *v = pParse->pVdbe;                         /* Stmt under construction */
513   int bSeq = ((pSort->sortFlags & SORTFLAG_UseSorter)==0);
514   int nExpr = pSort->pOrderBy->nExpr;              /* No. of ORDER BY terms */
515   int nBase = nExpr + bSeq + nData;                /* Fields in sorter record */
516   int regBase;                                     /* Regs for sorter record */
517   int regRecord = ++pParse->nMem;                  /* Assembled sorter record */
518   int nOBSat = pSort->nOBSat;                      /* ORDER BY terms to skip */
519   int op;                            /* Opcode to add sorter record to sorter */
520   int iLimit;                        /* LIMIT counter */
521 
522   assert( bSeq==0 || bSeq==1 );
523   assert( nData==1 || regData==regOrigData || regOrigData==0 );
524   if( nPrefixReg ){
525     assert( nPrefixReg==nExpr+bSeq );
526     regBase = regData - nExpr - bSeq;
527   }else{
528     regBase = pParse->nMem + 1;
529     pParse->nMem += nBase;
530   }
531   assert( pSelect->iOffset==0 || pSelect->iLimit!=0 );
532   iLimit = pSelect->iOffset ? pSelect->iOffset+1 : pSelect->iLimit;
533   pSort->labelDone = sqlite3VdbeMakeLabel(v);
534   sqlite3ExprCodeExprList(pParse, pSort->pOrderBy, regBase, regOrigData,
535                           SQLITE_ECEL_DUP | (regOrigData? SQLITE_ECEL_REF : 0));
536   if( bSeq ){
537     sqlite3VdbeAddOp2(v, OP_Sequence, pSort->iECursor, regBase+nExpr);
538   }
539   if( nPrefixReg==0 && nData>0 ){
540     sqlite3ExprCodeMove(pParse, regData, regBase+nExpr+bSeq, nData);
541   }
542   sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase+nOBSat, nBase-nOBSat, regRecord);
543   if( nOBSat>0 ){
544     int regPrevKey;   /* The first nOBSat columns of the previous row */
545     int addrFirst;    /* Address of the OP_IfNot opcode */
546     int addrJmp;      /* Address of the OP_Jump opcode */
547     VdbeOp *pOp;      /* Opcode that opens the sorter */
548     int nKey;         /* Number of sorting key columns, including OP_Sequence */
549     KeyInfo *pKI;     /* Original KeyInfo on the sorter table */
550 
551     regPrevKey = pParse->nMem+1;
552     pParse->nMem += pSort->nOBSat;
553     nKey = nExpr - pSort->nOBSat + bSeq;
554     if( bSeq ){
555       addrFirst = sqlite3VdbeAddOp1(v, OP_IfNot, regBase+nExpr);
556     }else{
557       addrFirst = sqlite3VdbeAddOp1(v, OP_SequenceTest, pSort->iECursor);
558     }
559     VdbeCoverage(v);
560     sqlite3VdbeAddOp3(v, OP_Compare, regPrevKey, regBase, pSort->nOBSat);
561     pOp = sqlite3VdbeGetOp(v, pSort->addrSortIndex);
562     if( pParse->db->mallocFailed ) return;
563     pOp->p2 = nKey + nData;
564     pKI = pOp->p4.pKeyInfo;
565     memset(pKI->aSortOrder, 0, pKI->nField); /* Makes OP_Jump below testable */
566     sqlite3VdbeChangeP4(v, -1, (char*)pKI, P4_KEYINFO);
567     testcase( pKI->nXField>2 );
568     pOp->p4.pKeyInfo = keyInfoFromExprList(pParse, pSort->pOrderBy, nOBSat,
569                                            pKI->nXField-1);
570     addrJmp = sqlite3VdbeCurrentAddr(v);
571     sqlite3VdbeAddOp3(v, OP_Jump, addrJmp+1, 0, addrJmp+1); VdbeCoverage(v);
572     pSort->labelBkOut = sqlite3VdbeMakeLabel(v);
573     pSort->regReturn = ++pParse->nMem;
574     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
575     sqlite3VdbeAddOp1(v, OP_ResetSorter, pSort->iECursor);
576     if( iLimit ){
577       sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, pSort->labelDone);
578       VdbeCoverage(v);
579     }
580     sqlite3VdbeJumpHere(v, addrFirst);
581     sqlite3ExprCodeMove(pParse, regBase, regPrevKey, pSort->nOBSat);
582     sqlite3VdbeJumpHere(v, addrJmp);
583   }
584   if( pSort->sortFlags & SORTFLAG_UseSorter ){
585     op = OP_SorterInsert;
586   }else{
587     op = OP_IdxInsert;
588   }
589   sqlite3VdbeAddOp4Int(v, op, pSort->iECursor, regRecord,
590                        regBase+nOBSat, nBase-nOBSat);
591   if( iLimit ){
592     int addr;
593     int r1 = 0;
594     /* Fill the sorter until it contains LIMIT+OFFSET entries.  (The iLimit
595     ** register is initialized with value of LIMIT+OFFSET.)  After the sorter
596     ** fills up, delete the least entry in the sorter after each insert.
597     ** Thus we never hold more than the LIMIT+OFFSET rows in memory at once */
598     addr = sqlite3VdbeAddOp1(v, OP_IfNotZero, iLimit); VdbeCoverage(v);
599     sqlite3VdbeAddOp1(v, OP_Last, pSort->iECursor);
600     if( pSort->bOrderedInnerLoop ){
601       r1 = ++pParse->nMem;
602       sqlite3VdbeAddOp3(v, OP_Column, pSort->iECursor, nExpr, r1);
603       VdbeComment((v, "seq"));
604     }
605     sqlite3VdbeAddOp1(v, OP_Delete, pSort->iECursor);
606     if( pSort->bOrderedInnerLoop ){
607       /* If the inner loop is driven by an index such that values from
608       ** the same iteration of the inner loop are in sorted order, then
609       ** immediately jump to the next iteration of an inner loop if the
610       ** entry from the current iteration does not fit into the top
611       ** LIMIT+OFFSET entries of the sorter. */
612       int iBrk = sqlite3VdbeCurrentAddr(v) + 2;
613       sqlite3VdbeAddOp3(v, OP_Eq, regBase+nExpr, iBrk, r1);
614       sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
615       VdbeCoverage(v);
616     }
617     sqlite3VdbeJumpHere(v, addr);
618   }
619 }
620 
621 /*
622 ** Add code to implement the OFFSET
623 */
624 static void codeOffset(
625   Vdbe *v,          /* Generate code into this VM */
626   int iOffset,      /* Register holding the offset counter */
627   int iContinue     /* Jump here to skip the current record */
628 ){
629   if( iOffset>0 ){
630     sqlite3VdbeAddOp3(v, OP_IfPos, iOffset, iContinue, 1); VdbeCoverage(v);
631     VdbeComment((v, "OFFSET"));
632   }
633 }
634 
635 /*
636 ** Add code that will check to make sure the N registers starting at iMem
637 ** form a distinct entry.  iTab is a sorting index that holds previously
638 ** seen combinations of the N values.  A new entry is made in iTab
639 ** if the current N values are new.
640 **
641 ** A jump to addrRepeat is made and the N+1 values are popped from the
642 ** stack if the top N elements are not distinct.
643 */
644 static void codeDistinct(
645   Parse *pParse,     /* Parsing and code generating context */
646   int iTab,          /* A sorting index used to test for distinctness */
647   int addrRepeat,    /* Jump to here if not distinct */
648   int N,             /* Number of elements */
649   int iMem           /* First element */
650 ){
651   Vdbe *v;
652   int r1;
653 
654   v = pParse->pVdbe;
655   r1 = sqlite3GetTempReg(pParse);
656   sqlite3VdbeAddOp4Int(v, OP_Found, iTab, addrRepeat, iMem, N); VdbeCoverage(v);
657   sqlite3VdbeAddOp3(v, OP_MakeRecord, iMem, N, r1);
658   sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r1, iMem, N);
659   sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
660   sqlite3ReleaseTempReg(pParse, r1);
661 }
662 
663 /*
664 ** This routine generates the code for the inside of the inner loop
665 ** of a SELECT.
666 **
667 ** If srcTab is negative, then the pEList expressions
668 ** are evaluated in order to get the data for this row.  If srcTab is
669 ** zero or more, then data is pulled from srcTab and pEList is used only
670 ** to get the number of columns and the collation sequence for each column.
671 */
672 static void selectInnerLoop(
673   Parse *pParse,          /* The parser context */
674   Select *p,              /* The complete select statement being coded */
675   ExprList *pEList,       /* List of values being extracted */
676   int srcTab,             /* Pull data from this table */
677   SortCtx *pSort,         /* If not NULL, info on how to process ORDER BY */
678   DistinctCtx *pDistinct, /* If not NULL, info on how to process DISTINCT */
679   SelectDest *pDest,      /* How to dispose of the results */
680   int iContinue,          /* Jump here to continue with next row */
681   int iBreak              /* Jump here to break out of the inner loop */
682 ){
683   Vdbe *v = pParse->pVdbe;
684   int i;
685   int hasDistinct;            /* True if the DISTINCT keyword is present */
686   int eDest = pDest->eDest;   /* How to dispose of results */
687   int iParm = pDest->iSDParm; /* First argument to disposal method */
688   int nResultCol;             /* Number of result columns */
689   int nPrefixReg = 0;         /* Number of extra registers before regResult */
690 
691   /* Usually, regResult is the first cell in an array of memory cells
692   ** containing the current result row. In this case regOrig is set to the
693   ** same value. However, if the results are being sent to the sorter, the
694   ** values for any expressions that are also part of the sort-key are omitted
695   ** from this array. In this case regOrig is set to zero.  */
696   int regResult;              /* Start of memory holding current results */
697   int regOrig;                /* Start of memory holding full result (or 0) */
698 
699   assert( v );
700   assert( pEList!=0 );
701   hasDistinct = pDistinct ? pDistinct->eTnctType : WHERE_DISTINCT_NOOP;
702   if( pSort && pSort->pOrderBy==0 ) pSort = 0;
703   if( pSort==0 && !hasDistinct ){
704     assert( iContinue!=0 );
705     codeOffset(v, p->iOffset, iContinue);
706   }
707 
708   /* Pull the requested columns.
709   */
710   nResultCol = pEList->nExpr;
711 
712   if( pDest->iSdst==0 ){
713     if( pSort ){
714       nPrefixReg = pSort->pOrderBy->nExpr;
715       if( !(pSort->sortFlags & SORTFLAG_UseSorter) ) nPrefixReg++;
716       pParse->nMem += nPrefixReg;
717     }
718     pDest->iSdst = pParse->nMem+1;
719     pParse->nMem += nResultCol;
720   }else if( pDest->iSdst+nResultCol > pParse->nMem ){
721     /* This is an error condition that can result, for example, when a SELECT
722     ** on the right-hand side of an INSERT contains more result columns than
723     ** there are columns in the table on the left.  The error will be caught
724     ** and reported later.  But we need to make sure enough memory is allocated
725     ** to avoid other spurious errors in the meantime. */
726     pParse->nMem += nResultCol;
727   }
728   pDest->nSdst = nResultCol;
729   regOrig = regResult = pDest->iSdst;
730   if( srcTab>=0 ){
731     for(i=0; i<nResultCol; i++){
732       sqlite3VdbeAddOp3(v, OP_Column, srcTab, i, regResult+i);
733       VdbeComment((v, "%s", pEList->a[i].zName));
734     }
735   }else if( eDest!=SRT_Exists ){
736     /* If the destination is an EXISTS(...) expression, the actual
737     ** values returned by the SELECT are not required.
738     */
739     u8 ecelFlags;
740     if( eDest==SRT_Mem || eDest==SRT_Output || eDest==SRT_Coroutine ){
741       ecelFlags = SQLITE_ECEL_DUP;
742     }else{
743       ecelFlags = 0;
744     }
745     if( pSort && hasDistinct==0 && eDest!=SRT_EphemTab && eDest!=SRT_Table ){
746       /* For each expression in pEList that is a copy of an expression in
747       ** the ORDER BY clause (pSort->pOrderBy), set the associated
748       ** iOrderByCol value to one more than the index of the ORDER BY
749       ** expression within the sort-key that pushOntoSorter() will generate.
750       ** This allows the pEList field to be omitted from the sorted record,
751       ** saving space and CPU cycles.  */
752       ecelFlags |= (SQLITE_ECEL_OMITREF|SQLITE_ECEL_REF);
753       for(i=pSort->nOBSat; i<pSort->pOrderBy->nExpr; i++){
754         int j;
755         if( (j = pSort->pOrderBy->a[i].u.x.iOrderByCol)>0 ){
756           pEList->a[j-1].u.x.iOrderByCol = i+1-pSort->nOBSat;
757         }
758       }
759       regOrig = 0;
760       assert( eDest==SRT_Set || eDest==SRT_Mem
761            || eDest==SRT_Coroutine || eDest==SRT_Output );
762     }
763     nResultCol = sqlite3ExprCodeExprList(pParse,pEList,regResult,0,ecelFlags);
764   }
765 
766   /* If the DISTINCT keyword was present on the SELECT statement
767   ** and this row has been seen before, then do not make this row
768   ** part of the result.
769   */
770   if( hasDistinct ){
771     switch( pDistinct->eTnctType ){
772       case WHERE_DISTINCT_ORDERED: {
773         VdbeOp *pOp;            /* No longer required OpenEphemeral instr. */
774         int iJump;              /* Jump destination */
775         int regPrev;            /* Previous row content */
776 
777         /* Allocate space for the previous row */
778         regPrev = pParse->nMem+1;
779         pParse->nMem += nResultCol;
780 
781         /* Change the OP_OpenEphemeral coded earlier to an OP_Null
782         ** sets the MEM_Cleared bit on the first register of the
783         ** previous value.  This will cause the OP_Ne below to always
784         ** fail on the first iteration of the loop even if the first
785         ** row is all NULLs.
786         */
787         sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
788         pOp = sqlite3VdbeGetOp(v, pDistinct->addrTnct);
789         pOp->opcode = OP_Null;
790         pOp->p1 = 1;
791         pOp->p2 = regPrev;
792 
793         iJump = sqlite3VdbeCurrentAddr(v) + nResultCol;
794         for(i=0; i<nResultCol; i++){
795           CollSeq *pColl = sqlite3ExprCollSeq(pParse, pEList->a[i].pExpr);
796           if( i<nResultCol-1 ){
797             sqlite3VdbeAddOp3(v, OP_Ne, regResult+i, iJump, regPrev+i);
798             VdbeCoverage(v);
799           }else{
800             sqlite3VdbeAddOp3(v, OP_Eq, regResult+i, iContinue, regPrev+i);
801             VdbeCoverage(v);
802            }
803           sqlite3VdbeChangeP4(v, -1, (const char *)pColl, P4_COLLSEQ);
804           sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
805         }
806         assert( sqlite3VdbeCurrentAddr(v)==iJump || pParse->db->mallocFailed );
807         sqlite3VdbeAddOp3(v, OP_Copy, regResult, regPrev, nResultCol-1);
808         break;
809       }
810 
811       case WHERE_DISTINCT_UNIQUE: {
812         sqlite3VdbeChangeToNoop(v, pDistinct->addrTnct);
813         break;
814       }
815 
816       default: {
817         assert( pDistinct->eTnctType==WHERE_DISTINCT_UNORDERED );
818         codeDistinct(pParse, pDistinct->tabTnct, iContinue, nResultCol,
819                      regResult);
820         break;
821       }
822     }
823     if( pSort==0 ){
824       codeOffset(v, p->iOffset, iContinue);
825     }
826   }
827 
828   switch( eDest ){
829     /* In this mode, write each query result to the key of the temporary
830     ** table iParm.
831     */
832 #ifndef SQLITE_OMIT_COMPOUND_SELECT
833     case SRT_Union: {
834       int r1;
835       r1 = sqlite3GetTempReg(pParse);
836       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1);
837       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
838       sqlite3ReleaseTempReg(pParse, r1);
839       break;
840     }
841 
842     /* Construct a record from the query result, but instead of
843     ** saving that record, use it as a key to delete elements from
844     ** the temporary table iParm.
845     */
846     case SRT_Except: {
847       sqlite3VdbeAddOp3(v, OP_IdxDelete, iParm, regResult, nResultCol);
848       break;
849     }
850 #endif /* SQLITE_OMIT_COMPOUND_SELECT */
851 
852     /* Store the result as data using a unique key.
853     */
854     case SRT_Fifo:
855     case SRT_DistFifo:
856     case SRT_Table:
857     case SRT_EphemTab: {
858       int r1 = sqlite3GetTempRange(pParse, nPrefixReg+1);
859       testcase( eDest==SRT_Table );
860       testcase( eDest==SRT_EphemTab );
861       testcase( eDest==SRT_Fifo );
862       testcase( eDest==SRT_DistFifo );
863       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r1+nPrefixReg);
864 #ifndef SQLITE_OMIT_CTE
865       if( eDest==SRT_DistFifo ){
866         /* If the destination is DistFifo, then cursor (iParm+1) is open
867         ** on an ephemeral index. If the current row is already present
868         ** in the index, do not write it to the output. If not, add the
869         ** current row to the index and proceed with writing it to the
870         ** output table as well.  */
871         int addr = sqlite3VdbeCurrentAddr(v) + 4;
872         sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, addr, r1, 0);
873         VdbeCoverage(v);
874         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm+1, r1,regResult,nResultCol);
875         assert( pSort==0 );
876       }
877 #endif
878       if( pSort ){
879         pushOntoSorter(pParse, pSort, p, r1+nPrefixReg,regResult,1,nPrefixReg);
880       }else{
881         int r2 = sqlite3GetTempReg(pParse);
882         sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, r2);
883         sqlite3VdbeAddOp3(v, OP_Insert, iParm, r1, r2);
884         sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
885         sqlite3ReleaseTempReg(pParse, r2);
886       }
887       sqlite3ReleaseTempRange(pParse, r1, nPrefixReg+1);
888       break;
889     }
890 
891 #ifndef SQLITE_OMIT_SUBQUERY
892     /* If we are creating a set for an "expr IN (SELECT ...)" construct,
893     ** then there should be a single item on the stack.  Write this
894     ** item into the set table with bogus data.
895     */
896     case SRT_Set: {
897       if( pSort ){
898         /* At first glance you would think we could optimize out the
899         ** ORDER BY in this case since the order of entries in the set
900         ** does not matter.  But there might be a LIMIT clause, in which
901         ** case the order does matter */
902         pushOntoSorter(
903             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
904       }else{
905         int r1 = sqlite3GetTempReg(pParse);
906         assert( sqlite3Strlen30(pDest->zAffSdst)==nResultCol );
907         sqlite3VdbeAddOp4(v, OP_MakeRecord, regResult, nResultCol,
908             r1, pDest->zAffSdst, nResultCol);
909         sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
910         sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, regResult, nResultCol);
911         sqlite3ReleaseTempReg(pParse, r1);
912       }
913       break;
914     }
915 
916     /* If any row exist in the result set, record that fact and abort.
917     */
918     case SRT_Exists: {
919       sqlite3VdbeAddOp2(v, OP_Integer, 1, iParm);
920       /* The LIMIT clause will terminate the loop for us */
921       break;
922     }
923 
924     /* If this is a scalar select that is part of an expression, then
925     ** store the results in the appropriate memory cell or array of
926     ** memory cells and break out of the scan loop.
927     */
928     case SRT_Mem: {
929       if( pSort ){
930         assert( nResultCol<=pDest->nSdst );
931         pushOntoSorter(
932             pParse, pSort, p, regResult, regOrig, nResultCol, nPrefixReg);
933       }else{
934         assert( nResultCol==pDest->nSdst );
935         assert( regResult==iParm );
936         /* The LIMIT clause will jump out of the loop for us */
937       }
938       break;
939     }
940 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
941 
942     case SRT_Coroutine:       /* Send data to a co-routine */
943     case SRT_Output: {        /* Return the results */
944       testcase( eDest==SRT_Coroutine );
945       testcase( eDest==SRT_Output );
946       if( pSort ){
947         pushOntoSorter(pParse, pSort, p, regResult, regOrig, nResultCol,
948                        nPrefixReg);
949       }else if( eDest==SRT_Coroutine ){
950         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
951       }else{
952         sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, nResultCol);
953         sqlite3ExprCacheAffinityChange(pParse, regResult, nResultCol);
954       }
955       break;
956     }
957 
958 #ifndef SQLITE_OMIT_CTE
959     /* Write the results into a priority queue that is order according to
960     ** pDest->pOrderBy (in pSO).  pDest->iSDParm (in iParm) is the cursor for an
961     ** index with pSO->nExpr+2 columns.  Build a key using pSO for the first
962     ** pSO->nExpr columns, then make sure all keys are unique by adding a
963     ** final OP_Sequence column.  The last column is the record as a blob.
964     */
965     case SRT_DistQueue:
966     case SRT_Queue: {
967       int nKey;
968       int r1, r2, r3;
969       int addrTest = 0;
970       ExprList *pSO;
971       pSO = pDest->pOrderBy;
972       assert( pSO );
973       nKey = pSO->nExpr;
974       r1 = sqlite3GetTempReg(pParse);
975       r2 = sqlite3GetTempRange(pParse, nKey+2);
976       r3 = r2+nKey+1;
977       if( eDest==SRT_DistQueue ){
978         /* If the destination is DistQueue, then cursor (iParm+1) is open
979         ** on a second ephemeral index that holds all values every previously
980         ** added to the queue. */
981         addrTest = sqlite3VdbeAddOp4Int(v, OP_Found, iParm+1, 0,
982                                         regResult, nResultCol);
983         VdbeCoverage(v);
984       }
985       sqlite3VdbeAddOp3(v, OP_MakeRecord, regResult, nResultCol, r3);
986       if( eDest==SRT_DistQueue ){
987         sqlite3VdbeAddOp2(v, OP_IdxInsert, iParm+1, r3);
988         sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
989       }
990       for(i=0; i<nKey; i++){
991         sqlite3VdbeAddOp2(v, OP_SCopy,
992                           regResult + pSO->a[i].u.x.iOrderByCol - 1,
993                           r2+i);
994       }
995       sqlite3VdbeAddOp2(v, OP_Sequence, iParm, r2+nKey);
996       sqlite3VdbeAddOp3(v, OP_MakeRecord, r2, nKey+2, r1);
997       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, r1, r2, nKey+2);
998       if( addrTest ) sqlite3VdbeJumpHere(v, addrTest);
999       sqlite3ReleaseTempReg(pParse, r1);
1000       sqlite3ReleaseTempRange(pParse, r2, nKey+2);
1001       break;
1002     }
1003 #endif /* SQLITE_OMIT_CTE */
1004 
1005 
1006 
1007 #if !defined(SQLITE_OMIT_TRIGGER)
1008     /* Discard the results.  This is used for SELECT statements inside
1009     ** the body of a TRIGGER.  The purpose of such selects is to call
1010     ** user-defined functions that have side effects.  We do not care
1011     ** about the actual results of the select.
1012     */
1013     default: {
1014       assert( eDest==SRT_Discard );
1015       break;
1016     }
1017 #endif
1018   }
1019 
1020   /* Jump to the end of the loop if the LIMIT is reached.  Except, if
1021   ** there is a sorter, in which case the sorter has already limited
1022   ** the output for us.
1023   */
1024   if( pSort==0 && p->iLimit ){
1025     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
1026   }
1027 }
1028 
1029 /*
1030 ** Allocate a KeyInfo object sufficient for an index of N key columns and
1031 ** X extra columns.
1032 */
1033 KeyInfo *sqlite3KeyInfoAlloc(sqlite3 *db, int N, int X){
1034   int nExtra = (N+X)*(sizeof(CollSeq*)+1) - sizeof(CollSeq*);
1035   KeyInfo *p = sqlite3DbMallocRawNN(db, sizeof(KeyInfo) + nExtra);
1036   if( p ){
1037     p->aSortOrder = (u8*)&p->aColl[N+X];
1038     p->nField = (u16)N;
1039     p->nXField = (u16)X;
1040     p->enc = ENC(db);
1041     p->db = db;
1042     p->nRef = 1;
1043     memset(&p[1], 0, nExtra);
1044   }else{
1045     sqlite3OomFault(db);
1046   }
1047   return p;
1048 }
1049 
1050 /*
1051 ** Deallocate a KeyInfo object
1052 */
1053 void sqlite3KeyInfoUnref(KeyInfo *p){
1054   if( p ){
1055     assert( p->nRef>0 );
1056     p->nRef--;
1057     if( p->nRef==0 ) sqlite3DbFreeNN(p->db, p);
1058   }
1059 }
1060 
1061 /*
1062 ** Make a new pointer to a KeyInfo object
1063 */
1064 KeyInfo *sqlite3KeyInfoRef(KeyInfo *p){
1065   if( p ){
1066     assert( p->nRef>0 );
1067     p->nRef++;
1068   }
1069   return p;
1070 }
1071 
1072 #ifdef SQLITE_DEBUG
1073 /*
1074 ** Return TRUE if a KeyInfo object can be change.  The KeyInfo object
1075 ** can only be changed if this is just a single reference to the object.
1076 **
1077 ** This routine is used only inside of assert() statements.
1078 */
1079 int sqlite3KeyInfoIsWriteable(KeyInfo *p){ return p->nRef==1; }
1080 #endif /* SQLITE_DEBUG */
1081 
1082 /*
1083 ** Given an expression list, generate a KeyInfo structure that records
1084 ** the collating sequence for each expression in that expression list.
1085 **
1086 ** If the ExprList is an ORDER BY or GROUP BY clause then the resulting
1087 ** KeyInfo structure is appropriate for initializing a virtual index to
1088 ** implement that clause.  If the ExprList is the result set of a SELECT
1089 ** then the KeyInfo structure is appropriate for initializing a virtual
1090 ** index to implement a DISTINCT test.
1091 **
1092 ** Space to hold the KeyInfo structure is obtained from malloc.  The calling
1093 ** function is responsible for seeing that this structure is eventually
1094 ** freed.
1095 */
1096 static KeyInfo *keyInfoFromExprList(
1097   Parse *pParse,       /* Parsing context */
1098   ExprList *pList,     /* Form the KeyInfo object from this ExprList */
1099   int iStart,          /* Begin with this column of pList */
1100   int nExtra           /* Add this many extra columns to the end */
1101 ){
1102   int nExpr;
1103   KeyInfo *pInfo;
1104   struct ExprList_item *pItem;
1105   sqlite3 *db = pParse->db;
1106   int i;
1107 
1108   nExpr = pList->nExpr;
1109   pInfo = sqlite3KeyInfoAlloc(db, nExpr-iStart, nExtra+1);
1110   if( pInfo ){
1111     assert( sqlite3KeyInfoIsWriteable(pInfo) );
1112     for(i=iStart, pItem=pList->a+iStart; i<nExpr; i++, pItem++){
1113       CollSeq *pColl;
1114       pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
1115       if( !pColl ) pColl = db->pDfltColl;
1116       pInfo->aColl[i-iStart] = pColl;
1117       pInfo->aSortOrder[i-iStart] = pItem->sortOrder;
1118     }
1119   }
1120   return pInfo;
1121 }
1122 
1123 /*
1124 ** Name of the connection operator, used for error messages.
1125 */
1126 static const char *selectOpName(int id){
1127   char *z;
1128   switch( id ){
1129     case TK_ALL:       z = "UNION ALL";   break;
1130     case TK_INTERSECT: z = "INTERSECT";   break;
1131     case TK_EXCEPT:    z = "EXCEPT";      break;
1132     default:           z = "UNION";       break;
1133   }
1134   return z;
1135 }
1136 
1137 #ifndef SQLITE_OMIT_EXPLAIN
1138 /*
1139 ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1140 ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1141 ** where the caption is of the form:
1142 **
1143 **   "USE TEMP B-TREE FOR xxx"
1144 **
1145 ** where xxx is one of "DISTINCT", "ORDER BY" or "GROUP BY". Exactly which
1146 ** is determined by the zUsage argument.
1147 */
1148 static void explainTempTable(Parse *pParse, const char *zUsage){
1149   if( pParse->explain==2 ){
1150     Vdbe *v = pParse->pVdbe;
1151     char *zMsg = sqlite3MPrintf(pParse->db, "USE TEMP B-TREE FOR %s", zUsage);
1152     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
1153   }
1154 }
1155 
1156 /*
1157 ** Assign expression b to lvalue a. A second, no-op, version of this macro
1158 ** is provided when SQLITE_OMIT_EXPLAIN is defined. This allows the code
1159 ** in sqlite3Select() to assign values to structure member variables that
1160 ** only exist if SQLITE_OMIT_EXPLAIN is not defined without polluting the
1161 ** code with #ifndef directives.
1162 */
1163 # define explainSetInteger(a, b) a = b
1164 
1165 #else
1166 /* No-op versions of the explainXXX() functions and macros. */
1167 # define explainTempTable(y,z)
1168 # define explainSetInteger(y,z)
1169 #endif
1170 
1171 #if !defined(SQLITE_OMIT_EXPLAIN) && !defined(SQLITE_OMIT_COMPOUND_SELECT)
1172 /*
1173 ** Unless an "EXPLAIN QUERY PLAN" command is being processed, this function
1174 ** is a no-op. Otherwise, it adds a single row of output to the EQP result,
1175 ** where the caption is of one of the two forms:
1176 **
1177 **   "COMPOSITE SUBQUERIES iSub1 and iSub2 (op)"
1178 **   "COMPOSITE SUBQUERIES iSub1 and iSub2 USING TEMP B-TREE (op)"
1179 **
1180 ** where iSub1 and iSub2 are the integers passed as the corresponding
1181 ** function parameters, and op is the text representation of the parameter
1182 ** of the same name. The parameter "op" must be one of TK_UNION, TK_EXCEPT,
1183 ** TK_INTERSECT or TK_ALL. The first form is used if argument bUseTmp is
1184 ** false, or the second form if it is true.
1185 */
1186 static void explainComposite(
1187   Parse *pParse,                  /* Parse context */
1188   int op,                         /* One of TK_UNION, TK_EXCEPT etc. */
1189   int iSub1,                      /* Subquery id 1 */
1190   int iSub2,                      /* Subquery id 2 */
1191   int bUseTmp                     /* True if a temp table was used */
1192 ){
1193   assert( op==TK_UNION || op==TK_EXCEPT || op==TK_INTERSECT || op==TK_ALL );
1194   if( pParse->explain==2 ){
1195     Vdbe *v = pParse->pVdbe;
1196     char *zMsg = sqlite3MPrintf(
1197         pParse->db, "COMPOUND SUBQUERIES %d AND %d %s(%s)", iSub1, iSub2,
1198         bUseTmp?"USING TEMP B-TREE ":"", selectOpName(op)
1199     );
1200     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
1201   }
1202 }
1203 #else
1204 /* No-op versions of the explainXXX() functions and macros. */
1205 # define explainComposite(v,w,x,y,z)
1206 #endif
1207 
1208 /*
1209 ** If the inner loop was generated using a non-null pOrderBy argument,
1210 ** then the results were placed in a sorter.  After the loop is terminated
1211 ** we need to run the sorter and output the results.  The following
1212 ** routine generates the code needed to do that.
1213 */
1214 static void generateSortTail(
1215   Parse *pParse,    /* Parsing context */
1216   Select *p,        /* The SELECT statement */
1217   SortCtx *pSort,   /* Information on the ORDER BY clause */
1218   int nColumn,      /* Number of columns of data */
1219   SelectDest *pDest /* Write the sorted results here */
1220 ){
1221   Vdbe *v = pParse->pVdbe;                     /* The prepared statement */
1222   int addrBreak = pSort->labelDone;            /* Jump here to exit loop */
1223   int addrContinue = sqlite3VdbeMakeLabel(v);  /* Jump here for next cycle */
1224   int addr;
1225   int addrOnce = 0;
1226   int iTab;
1227   ExprList *pOrderBy = pSort->pOrderBy;
1228   int eDest = pDest->eDest;
1229   int iParm = pDest->iSDParm;
1230   int regRow;
1231   int regRowid;
1232   int iCol;
1233   int nKey;
1234   int iSortTab;                   /* Sorter cursor to read from */
1235   int nSortData;                  /* Trailing values to read from sorter */
1236   int i;
1237   int bSeq;                       /* True if sorter record includes seq. no. */
1238   struct ExprList_item *aOutEx = p->pEList->a;
1239 
1240   assert( addrBreak<0 );
1241   if( pSort->labelBkOut ){
1242     sqlite3VdbeAddOp2(v, OP_Gosub, pSort->regReturn, pSort->labelBkOut);
1243     sqlite3VdbeGoto(v, addrBreak);
1244     sqlite3VdbeResolveLabel(v, pSort->labelBkOut);
1245   }
1246   iTab = pSort->iECursor;
1247   if( eDest==SRT_Output || eDest==SRT_Coroutine || eDest==SRT_Mem ){
1248     regRowid = 0;
1249     regRow = pDest->iSdst;
1250     nSortData = nColumn;
1251   }else{
1252     regRowid = sqlite3GetTempReg(pParse);
1253     regRow = sqlite3GetTempRange(pParse, nColumn);
1254     nSortData = nColumn;
1255   }
1256   nKey = pOrderBy->nExpr - pSort->nOBSat;
1257   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1258     int regSortOut = ++pParse->nMem;
1259     iSortTab = pParse->nTab++;
1260     if( pSort->labelBkOut ){
1261       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
1262     }
1263     sqlite3VdbeAddOp3(v, OP_OpenPseudo, iSortTab, regSortOut, nKey+1+nSortData);
1264     if( addrOnce ) sqlite3VdbeJumpHere(v, addrOnce);
1265     addr = 1 + sqlite3VdbeAddOp2(v, OP_SorterSort, iTab, addrBreak);
1266     VdbeCoverage(v);
1267     codeOffset(v, p->iOffset, addrContinue);
1268     sqlite3VdbeAddOp3(v, OP_SorterData, iTab, regSortOut, iSortTab);
1269     bSeq = 0;
1270   }else{
1271     addr = 1 + sqlite3VdbeAddOp2(v, OP_Sort, iTab, addrBreak); VdbeCoverage(v);
1272     codeOffset(v, p->iOffset, addrContinue);
1273     iSortTab = iTab;
1274     bSeq = 1;
1275   }
1276   for(i=0, iCol=nKey+bSeq; i<nSortData; i++){
1277     int iRead;
1278     if( aOutEx[i].u.x.iOrderByCol ){
1279       iRead = aOutEx[i].u.x.iOrderByCol-1;
1280     }else{
1281       iRead = iCol++;
1282     }
1283     sqlite3VdbeAddOp3(v, OP_Column, iSortTab, iRead, regRow+i);
1284     VdbeComment((v, "%s", aOutEx[i].zName ? aOutEx[i].zName : aOutEx[i].zSpan));
1285   }
1286   switch( eDest ){
1287     case SRT_Table:
1288     case SRT_EphemTab: {
1289       sqlite3VdbeAddOp2(v, OP_NewRowid, iParm, regRowid);
1290       sqlite3VdbeAddOp3(v, OP_Insert, iParm, regRow, regRowid);
1291       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1292       break;
1293     }
1294 #ifndef SQLITE_OMIT_SUBQUERY
1295     case SRT_Set: {
1296       assert( nColumn==sqlite3Strlen30(pDest->zAffSdst) );
1297       sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, nColumn, regRowid,
1298                         pDest->zAffSdst, nColumn);
1299       sqlite3ExprCacheAffinityChange(pParse, regRow, nColumn);
1300       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iParm, regRowid, regRow, nColumn);
1301       break;
1302     }
1303     case SRT_Mem: {
1304       /* The LIMIT clause will terminate the loop for us */
1305       break;
1306     }
1307 #endif
1308     default: {
1309       assert( eDest==SRT_Output || eDest==SRT_Coroutine );
1310       testcase( eDest==SRT_Output );
1311       testcase( eDest==SRT_Coroutine );
1312       if( eDest==SRT_Output ){
1313         sqlite3VdbeAddOp2(v, OP_ResultRow, pDest->iSdst, nColumn);
1314         sqlite3ExprCacheAffinityChange(pParse, pDest->iSdst, nColumn);
1315       }else{
1316         sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
1317       }
1318       break;
1319     }
1320   }
1321   if( regRowid ){
1322     if( eDest==SRT_Set ){
1323       sqlite3ReleaseTempRange(pParse, regRow, nColumn);
1324     }else{
1325       sqlite3ReleaseTempReg(pParse, regRow);
1326     }
1327     sqlite3ReleaseTempReg(pParse, regRowid);
1328   }
1329   /* The bottom of the loop
1330   */
1331   sqlite3VdbeResolveLabel(v, addrContinue);
1332   if( pSort->sortFlags & SORTFLAG_UseSorter ){
1333     sqlite3VdbeAddOp2(v, OP_SorterNext, iTab, addr); VdbeCoverage(v);
1334   }else{
1335     sqlite3VdbeAddOp2(v, OP_Next, iTab, addr); VdbeCoverage(v);
1336   }
1337   if( pSort->regReturn ) sqlite3VdbeAddOp1(v, OP_Return, pSort->regReturn);
1338   sqlite3VdbeResolveLabel(v, addrBreak);
1339 }
1340 
1341 /*
1342 ** Return a pointer to a string containing the 'declaration type' of the
1343 ** expression pExpr. The string may be treated as static by the caller.
1344 **
1345 ** Also try to estimate the size of the returned value and return that
1346 ** result in *pEstWidth.
1347 **
1348 ** The declaration type is the exact datatype definition extracted from the
1349 ** original CREATE TABLE statement if the expression is a column. The
1350 ** declaration type for a ROWID field is INTEGER. Exactly when an expression
1351 ** is considered a column can be complex in the presence of subqueries. The
1352 ** result-set expression in all of the following SELECT statements is
1353 ** considered a column by this function.
1354 **
1355 **   SELECT col FROM tbl;
1356 **   SELECT (SELECT col FROM tbl;
1357 **   SELECT (SELECT col FROM tbl);
1358 **   SELECT abc FROM (SELECT col AS abc FROM tbl);
1359 **
1360 ** The declaration type for any expression other than a column is NULL.
1361 **
1362 ** This routine has either 3 or 6 parameters depending on whether or not
1363 ** the SQLITE_ENABLE_COLUMN_METADATA compile-time option is used.
1364 */
1365 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1366 # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,C,D,E,F)
1367 #else /* if !defined(SQLITE_ENABLE_COLUMN_METADATA) */
1368 # define columnType(A,B,C,D,E,F) columnTypeImpl(A,B,F)
1369 #endif
1370 static const char *columnTypeImpl(
1371   NameContext *pNC,
1372   Expr *pExpr,
1373 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1374   const char **pzOrigDb,
1375   const char **pzOrigTab,
1376   const char **pzOrigCol,
1377 #endif
1378   u8 *pEstWidth
1379 ){
1380   char const *zType = 0;
1381   int j;
1382   u8 estWidth = 1;
1383 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1384   char const *zOrigDb = 0;
1385   char const *zOrigTab = 0;
1386   char const *zOrigCol = 0;
1387 #endif
1388 
1389   assert( pExpr!=0 );
1390   assert( pNC->pSrcList!=0 );
1391   switch( pExpr->op ){
1392     case TK_AGG_COLUMN:
1393     case TK_COLUMN: {
1394       /* The expression is a column. Locate the table the column is being
1395       ** extracted from in NameContext.pSrcList. This table may be real
1396       ** database table or a subquery.
1397       */
1398       Table *pTab = 0;            /* Table structure column is extracted from */
1399       Select *pS = 0;             /* Select the column is extracted from */
1400       int iCol = pExpr->iColumn;  /* Index of column in pTab */
1401       testcase( pExpr->op==TK_AGG_COLUMN );
1402       testcase( pExpr->op==TK_COLUMN );
1403       while( pNC && !pTab ){
1404         SrcList *pTabList = pNC->pSrcList;
1405         for(j=0;j<pTabList->nSrc && pTabList->a[j].iCursor!=pExpr->iTable;j++);
1406         if( j<pTabList->nSrc ){
1407           pTab = pTabList->a[j].pTab;
1408           pS = pTabList->a[j].pSelect;
1409         }else{
1410           pNC = pNC->pNext;
1411         }
1412       }
1413 
1414       if( pTab==0 ){
1415         /* At one time, code such as "SELECT new.x" within a trigger would
1416         ** cause this condition to run.  Since then, we have restructured how
1417         ** trigger code is generated and so this condition is no longer
1418         ** possible. However, it can still be true for statements like
1419         ** the following:
1420         **
1421         **   CREATE TABLE t1(col INTEGER);
1422         **   SELECT (SELECT t1.col) FROM FROM t1;
1423         **
1424         ** when columnType() is called on the expression "t1.col" in the
1425         ** sub-select. In this case, set the column type to NULL, even
1426         ** though it should really be "INTEGER".
1427         **
1428         ** This is not a problem, as the column type of "t1.col" is never
1429         ** used. When columnType() is called on the expression
1430         ** "(SELECT t1.col)", the correct type is returned (see the TK_SELECT
1431         ** branch below.  */
1432         break;
1433       }
1434 
1435       assert( pTab && pExpr->pTab==pTab );
1436       if( pS ){
1437         /* The "table" is actually a sub-select or a view in the FROM clause
1438         ** of the SELECT statement. Return the declaration type and origin
1439         ** data for the result-set column of the sub-select.
1440         */
1441         if( iCol>=0 && ALWAYS(iCol<pS->pEList->nExpr) ){
1442           /* If iCol is less than zero, then the expression requests the
1443           ** rowid of the sub-select or view. This expression is legal (see
1444           ** test case misc2.2.2) - it always evaluates to NULL.
1445           **
1446           ** The ALWAYS() is because iCol>=pS->pEList->nExpr will have been
1447           ** caught already by name resolution.
1448           */
1449           NameContext sNC;
1450           Expr *p = pS->pEList->a[iCol].pExpr;
1451           sNC.pSrcList = pS->pSrc;
1452           sNC.pNext = pNC;
1453           sNC.pParse = pNC->pParse;
1454           zType = columnType(&sNC, p,&zOrigDb,&zOrigTab,&zOrigCol, &estWidth);
1455         }
1456       }else if( pTab->pSchema ){
1457         /* A real table */
1458         assert( !pS );
1459         if( iCol<0 ) iCol = pTab->iPKey;
1460         assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
1461 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1462         if( iCol<0 ){
1463           zType = "INTEGER";
1464           zOrigCol = "rowid";
1465         }else{
1466           zOrigCol = pTab->aCol[iCol].zName;
1467           zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
1468           estWidth = pTab->aCol[iCol].szEst;
1469         }
1470         zOrigTab = pTab->zName;
1471         if( pNC->pParse ){
1472           int iDb = sqlite3SchemaToIndex(pNC->pParse->db, pTab->pSchema);
1473           zOrigDb = pNC->pParse->db->aDb[iDb].zDbSName;
1474         }
1475 #else
1476         if( iCol<0 ){
1477           zType = "INTEGER";
1478         }else{
1479           zType = sqlite3ColumnType(&pTab->aCol[iCol],0);
1480           estWidth = pTab->aCol[iCol].szEst;
1481         }
1482 #endif
1483       }
1484       break;
1485     }
1486 #ifndef SQLITE_OMIT_SUBQUERY
1487     case TK_SELECT: {
1488       /* The expression is a sub-select. Return the declaration type and
1489       ** origin info for the single column in the result set of the SELECT
1490       ** statement.
1491       */
1492       NameContext sNC;
1493       Select *pS = pExpr->x.pSelect;
1494       Expr *p = pS->pEList->a[0].pExpr;
1495       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
1496       sNC.pSrcList = pS->pSrc;
1497       sNC.pNext = pNC;
1498       sNC.pParse = pNC->pParse;
1499       zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, &estWidth);
1500       break;
1501     }
1502 #endif
1503   }
1504 
1505 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1506   if( pzOrigDb ){
1507     assert( pzOrigTab && pzOrigCol );
1508     *pzOrigDb = zOrigDb;
1509     *pzOrigTab = zOrigTab;
1510     *pzOrigCol = zOrigCol;
1511   }
1512 #endif
1513   if( pEstWidth ) *pEstWidth = estWidth;
1514   return zType;
1515 }
1516 
1517 /*
1518 ** Generate code that will tell the VDBE the declaration types of columns
1519 ** in the result set.
1520 */
1521 static void generateColumnTypes(
1522   Parse *pParse,      /* Parser context */
1523   SrcList *pTabList,  /* List of tables */
1524   ExprList *pEList    /* Expressions defining the result set */
1525 ){
1526 #ifndef SQLITE_OMIT_DECLTYPE
1527   Vdbe *v = pParse->pVdbe;
1528   int i;
1529   NameContext sNC;
1530   sNC.pSrcList = pTabList;
1531   sNC.pParse = pParse;
1532   sNC.pNext = 0;
1533   for(i=0; i<pEList->nExpr; i++){
1534     Expr *p = pEList->a[i].pExpr;
1535     const char *zType;
1536 #ifdef SQLITE_ENABLE_COLUMN_METADATA
1537     const char *zOrigDb = 0;
1538     const char *zOrigTab = 0;
1539     const char *zOrigCol = 0;
1540     zType = columnType(&sNC, p, &zOrigDb, &zOrigTab, &zOrigCol, 0);
1541 
1542     /* The vdbe must make its own copy of the column-type and other
1543     ** column specific strings, in case the schema is reset before this
1544     ** virtual machine is deleted.
1545     */
1546     sqlite3VdbeSetColName(v, i, COLNAME_DATABASE, zOrigDb, SQLITE_TRANSIENT);
1547     sqlite3VdbeSetColName(v, i, COLNAME_TABLE, zOrigTab, SQLITE_TRANSIENT);
1548     sqlite3VdbeSetColName(v, i, COLNAME_COLUMN, zOrigCol, SQLITE_TRANSIENT);
1549 #else
1550     zType = columnType(&sNC, p, 0, 0, 0, 0);
1551 #endif
1552     sqlite3VdbeSetColName(v, i, COLNAME_DECLTYPE, zType, SQLITE_TRANSIENT);
1553   }
1554 #endif /* !defined(SQLITE_OMIT_DECLTYPE) */
1555 }
1556 
1557 /*
1558 ** Return the Table objecct in the SrcList that has cursor iCursor.
1559 ** Or return NULL if no such Table object exists in the SrcList.
1560 */
1561 static Table *tableWithCursor(SrcList *pList, int iCursor){
1562   int j;
1563   for(j=0; j<pList->nSrc; j++){
1564     if( pList->a[j].iCursor==iCursor ) return pList->a[j].pTab;
1565   }
1566   return 0;
1567 }
1568 
1569 
1570 /*
1571 ** Generate code that will tell the VDBE the names of columns
1572 ** in the result set.  This information is used to provide the
1573 ** azCol[] values in the callback.
1574 */
1575 static void generateColumnNames(
1576   Parse *pParse,      /* Parser context */
1577   SrcList *pTabList,  /* List of tables */
1578   ExprList *pEList    /* Expressions defining the result set */
1579 ){
1580   Vdbe *v = pParse->pVdbe;
1581   int i;
1582   Table *pTab;
1583   sqlite3 *db = pParse->db;
1584   int fullNames, shortNames;
1585 
1586 #ifndef SQLITE_OMIT_EXPLAIN
1587   /* If this is an EXPLAIN, skip this step */
1588   if( pParse->explain ){
1589     return;
1590   }
1591 #endif
1592 
1593   if( pParse->colNamesSet || db->mallocFailed ) return;
1594   assert( v!=0 );
1595   assert( pTabList!=0 );
1596   pParse->colNamesSet = 1;
1597   fullNames = (db->flags & SQLITE_FullColNames)!=0;
1598   shortNames = (db->flags & SQLITE_ShortColNames)!=0;
1599   sqlite3VdbeSetNumCols(v, pEList->nExpr);
1600   for(i=0; i<pEList->nExpr; i++){
1601     Expr *p;
1602     p = pEList->a[i].pExpr;
1603     if( NEVER(p==0) ) continue;
1604     if( pEList->a[i].zName ){
1605       char *zName = pEList->a[i].zName;
1606       sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_TRANSIENT);
1607     }else if( (p->op==TK_COLUMN || p->op==TK_AGG_COLUMN)
1608            && (pTab = tableWithCursor(pTabList, p->iTable))!=0
1609     ){
1610       char *zCol;
1611       int iCol = p->iColumn;
1612       if( iCol<0 ) iCol = pTab->iPKey;
1613       assert( iCol==-1 || (iCol>=0 && iCol<pTab->nCol) );
1614       if( iCol<0 ){
1615         zCol = "rowid";
1616       }else{
1617         zCol = pTab->aCol[iCol].zName;
1618       }
1619       if( !shortNames && !fullNames ){
1620         sqlite3VdbeSetColName(v, i, COLNAME_NAME,
1621             sqlite3DbStrDup(db, pEList->a[i].zSpan), SQLITE_DYNAMIC);
1622       }else if( fullNames ){
1623         char *zName = 0;
1624         zName = sqlite3MPrintf(db, "%s.%s", pTab->zName, zCol);
1625         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zName, SQLITE_DYNAMIC);
1626       }else{
1627         sqlite3VdbeSetColName(v, i, COLNAME_NAME, zCol, SQLITE_TRANSIENT);
1628       }
1629     }else{
1630       const char *z = pEList->a[i].zSpan;
1631       z = z==0 ? sqlite3MPrintf(db, "column%d", i+1) : sqlite3DbStrDup(db, z);
1632       sqlite3VdbeSetColName(v, i, COLNAME_NAME, z, SQLITE_DYNAMIC);
1633     }
1634   }
1635   generateColumnTypes(pParse, pTabList, pEList);
1636 }
1637 
1638 /*
1639 ** Given an expression list (which is really the list of expressions
1640 ** that form the result set of a SELECT statement) compute appropriate
1641 ** column names for a table that would hold the expression list.
1642 **
1643 ** All column names will be unique.
1644 **
1645 ** Only the column names are computed.  Column.zType, Column.zColl,
1646 ** and other fields of Column are zeroed.
1647 **
1648 ** Return SQLITE_OK on success.  If a memory allocation error occurs,
1649 ** store NULL in *paCol and 0 in *pnCol and return SQLITE_NOMEM.
1650 */
1651 int sqlite3ColumnsFromExprList(
1652   Parse *pParse,          /* Parsing context */
1653   ExprList *pEList,       /* Expr list from which to derive column names */
1654   i16 *pnCol,             /* Write the number of columns here */
1655   Column **paCol          /* Write the new column list here */
1656 ){
1657   sqlite3 *db = pParse->db;   /* Database connection */
1658   int i, j;                   /* Loop counters */
1659   u32 cnt;                    /* Index added to make the name unique */
1660   Column *aCol, *pCol;        /* For looping over result columns */
1661   int nCol;                   /* Number of columns in the result set */
1662   Expr *p;                    /* Expression for a single result column */
1663   char *zName;                /* Column name */
1664   int nName;                  /* Size of name in zName[] */
1665   Hash ht;                    /* Hash table of column names */
1666 
1667   sqlite3HashInit(&ht);
1668   if( pEList ){
1669     nCol = pEList->nExpr;
1670     aCol = sqlite3DbMallocZero(db, sizeof(aCol[0])*nCol);
1671     testcase( aCol==0 );
1672   }else{
1673     nCol = 0;
1674     aCol = 0;
1675   }
1676   assert( nCol==(i16)nCol );
1677   *pnCol = nCol;
1678   *paCol = aCol;
1679 
1680   for(i=0, pCol=aCol; i<nCol && !db->mallocFailed; i++, pCol++){
1681     /* Get an appropriate name for the column
1682     */
1683     p = sqlite3ExprSkipCollate(pEList->a[i].pExpr);
1684     if( (zName = pEList->a[i].zName)!=0 ){
1685       /* If the column contains an "AS <name>" phrase, use <name> as the name */
1686     }else{
1687       Expr *pColExpr = p;  /* The expression that is the result column name */
1688       Table *pTab;         /* Table associated with this expression */
1689       while( pColExpr->op==TK_DOT ){
1690         pColExpr = pColExpr->pRight;
1691         assert( pColExpr!=0 );
1692       }
1693       if( pColExpr->op==TK_COLUMN && pColExpr->pTab!=0 ){
1694         /* For columns use the column name name */
1695         int iCol = pColExpr->iColumn;
1696         pTab = pColExpr->pTab;
1697         if( iCol<0 ) iCol = pTab->iPKey;
1698         zName = iCol>=0 ? pTab->aCol[iCol].zName : "rowid";
1699       }else if( pColExpr->op==TK_ID ){
1700         assert( !ExprHasProperty(pColExpr, EP_IntValue) );
1701         zName = pColExpr->u.zToken;
1702       }else{
1703         /* Use the original text of the column expression as its name */
1704         zName = pEList->a[i].zSpan;
1705       }
1706     }
1707     if( zName ){
1708       zName = sqlite3DbStrDup(db, zName);
1709     }else{
1710       zName = sqlite3MPrintf(db,"column%d",i+1);
1711     }
1712 
1713     /* Make sure the column name is unique.  If the name is not unique,
1714     ** append an integer to the name so that it becomes unique.
1715     */
1716     cnt = 0;
1717     while( zName && sqlite3HashFind(&ht, zName)!=0 ){
1718       nName = sqlite3Strlen30(zName);
1719       if( nName>0 ){
1720         for(j=nName-1; j>0 && sqlite3Isdigit(zName[j]); j--){}
1721         if( zName[j]==':' ) nName = j;
1722       }
1723       zName = sqlite3MPrintf(db, "%.*z:%u", nName, zName, ++cnt);
1724       if( cnt>3 ) sqlite3_randomness(sizeof(cnt), &cnt);
1725     }
1726     pCol->zName = zName;
1727     sqlite3ColumnPropertiesFromName(0, pCol);
1728     if( zName && sqlite3HashInsert(&ht, zName, pCol)==pCol ){
1729       sqlite3OomFault(db);
1730     }
1731   }
1732   sqlite3HashClear(&ht);
1733   if( db->mallocFailed ){
1734     for(j=0; j<i; j++){
1735       sqlite3DbFree(db, aCol[j].zName);
1736     }
1737     sqlite3DbFree(db, aCol);
1738     *paCol = 0;
1739     *pnCol = 0;
1740     return SQLITE_NOMEM_BKPT;
1741   }
1742   return SQLITE_OK;
1743 }
1744 
1745 /*
1746 ** Add type and collation information to a column list based on
1747 ** a SELECT statement.
1748 **
1749 ** The column list presumably came from selectColumnNamesFromExprList().
1750 ** The column list has only names, not types or collations.  This
1751 ** routine goes through and adds the types and collations.
1752 **
1753 ** This routine requires that all identifiers in the SELECT
1754 ** statement be resolved.
1755 */
1756 void sqlite3SelectAddColumnTypeAndCollation(
1757   Parse *pParse,        /* Parsing contexts */
1758   Table *pTab,          /* Add column type information to this table */
1759   Select *pSelect       /* SELECT used to determine types and collations */
1760 ){
1761   sqlite3 *db = pParse->db;
1762   NameContext sNC;
1763   Column *pCol;
1764   CollSeq *pColl;
1765   int i;
1766   Expr *p;
1767   struct ExprList_item *a;
1768   u64 szAll = 0;
1769 
1770   assert( pSelect!=0 );
1771   assert( (pSelect->selFlags & SF_Resolved)!=0 );
1772   assert( pTab->nCol==pSelect->pEList->nExpr || db->mallocFailed );
1773   if( db->mallocFailed ) return;
1774   memset(&sNC, 0, sizeof(sNC));
1775   sNC.pSrcList = pSelect->pSrc;
1776   a = pSelect->pEList->a;
1777   for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
1778     const char *zType;
1779     int n, m;
1780     p = a[i].pExpr;
1781     zType = columnType(&sNC, p, 0, 0, 0, &pCol->szEst);
1782     szAll += pCol->szEst;
1783     pCol->affinity = sqlite3ExprAffinity(p);
1784     if( zType && (m = sqlite3Strlen30(zType))>0 ){
1785       n = sqlite3Strlen30(pCol->zName);
1786       pCol->zName = sqlite3DbReallocOrFree(db, pCol->zName, n+m+2);
1787       if( pCol->zName ){
1788         memcpy(&pCol->zName[n+1], zType, m+1);
1789         pCol->colFlags |= COLFLAG_HASTYPE;
1790       }
1791     }
1792     if( pCol->affinity==0 ) pCol->affinity = SQLITE_AFF_BLOB;
1793     pColl = sqlite3ExprCollSeq(pParse, p);
1794     if( pColl && pCol->zColl==0 ){
1795       pCol->zColl = sqlite3DbStrDup(db, pColl->zName);
1796     }
1797   }
1798   pTab->szTabRow = sqlite3LogEst(szAll*4);
1799 }
1800 
1801 /*
1802 ** Given a SELECT statement, generate a Table structure that describes
1803 ** the result set of that SELECT.
1804 */
1805 Table *sqlite3ResultSetOfSelect(Parse *pParse, Select *pSelect){
1806   Table *pTab;
1807   sqlite3 *db = pParse->db;
1808   int savedFlags;
1809 
1810   savedFlags = db->flags;
1811   db->flags &= ~SQLITE_FullColNames;
1812   db->flags |= SQLITE_ShortColNames;
1813   sqlite3SelectPrep(pParse, pSelect, 0);
1814   if( pParse->nErr ) return 0;
1815   while( pSelect->pPrior ) pSelect = pSelect->pPrior;
1816   db->flags = savedFlags;
1817   pTab = sqlite3DbMallocZero(db, sizeof(Table) );
1818   if( pTab==0 ){
1819     return 0;
1820   }
1821   /* The sqlite3ResultSetOfSelect() is only used n contexts where lookaside
1822   ** is disabled */
1823   assert( db->lookaside.bDisable );
1824   pTab->nTabRef = 1;
1825   pTab->zName = 0;
1826   pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
1827   sqlite3ColumnsFromExprList(pParse, pSelect->pEList, &pTab->nCol, &pTab->aCol);
1828   sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSelect);
1829   pTab->iPKey = -1;
1830   if( db->mallocFailed ){
1831     sqlite3DeleteTable(db, pTab);
1832     return 0;
1833   }
1834   return pTab;
1835 }
1836 
1837 /*
1838 ** Get a VDBE for the given parser context.  Create a new one if necessary.
1839 ** If an error occurs, return NULL and leave a message in pParse.
1840 */
1841 static SQLITE_NOINLINE Vdbe *allocVdbe(Parse *pParse){
1842   Vdbe *v = pParse->pVdbe = sqlite3VdbeCreate(pParse);
1843   if( v ) sqlite3VdbeAddOp2(v, OP_Init, 0, 1);
1844   if( pParse->pToplevel==0
1845    && OptimizationEnabled(pParse->db,SQLITE_FactorOutConst)
1846   ){
1847     pParse->okConstFactor = 1;
1848   }
1849   return v;
1850 }
1851 Vdbe *sqlite3GetVdbe(Parse *pParse){
1852   Vdbe *v = pParse->pVdbe;
1853   return v ? v : allocVdbe(pParse);
1854 }
1855 
1856 
1857 /*
1858 ** Compute the iLimit and iOffset fields of the SELECT based on the
1859 ** pLimit and pOffset expressions.  pLimit and pOffset hold the expressions
1860 ** that appear in the original SQL statement after the LIMIT and OFFSET
1861 ** keywords.  Or NULL if those keywords are omitted. iLimit and iOffset
1862 ** are the integer memory register numbers for counters used to compute
1863 ** the limit and offset.  If there is no limit and/or offset, then
1864 ** iLimit and iOffset are negative.
1865 **
1866 ** This routine changes the values of iLimit and iOffset only if
1867 ** a limit or offset is defined by pLimit and pOffset.  iLimit and
1868 ** iOffset should have been preset to appropriate default values (zero)
1869 ** prior to calling this routine.
1870 **
1871 ** The iOffset register (if it exists) is initialized to the value
1872 ** of the OFFSET.  The iLimit register is initialized to LIMIT.  Register
1873 ** iOffset+1 is initialized to LIMIT+OFFSET.
1874 **
1875 ** Only if pLimit!=0 or pOffset!=0 do the limit registers get
1876 ** redefined.  The UNION ALL operator uses this property to force
1877 ** the reuse of the same limit and offset registers across multiple
1878 ** SELECT statements.
1879 */
1880 static void computeLimitRegisters(Parse *pParse, Select *p, int iBreak){
1881   Vdbe *v = 0;
1882   int iLimit = 0;
1883   int iOffset;
1884   int n;
1885   if( p->iLimit ) return;
1886 
1887   /*
1888   ** "LIMIT -1" always shows all rows.  There is some
1889   ** controversy about what the correct behavior should be.
1890   ** The current implementation interprets "LIMIT 0" to mean
1891   ** no rows.
1892   */
1893   sqlite3ExprCacheClear(pParse);
1894   assert( p->pOffset==0 || p->pLimit!=0 );
1895   if( p->pLimit ){
1896     p->iLimit = iLimit = ++pParse->nMem;
1897     v = sqlite3GetVdbe(pParse);
1898     assert( v!=0 );
1899     if( sqlite3ExprIsInteger(p->pLimit, &n) ){
1900       sqlite3VdbeAddOp2(v, OP_Integer, n, iLimit);
1901       VdbeComment((v, "LIMIT counter"));
1902       if( n==0 ){
1903         sqlite3VdbeGoto(v, iBreak);
1904       }else if( n>=0 && p->nSelectRow>sqlite3LogEst((u64)n) ){
1905         p->nSelectRow = sqlite3LogEst((u64)n);
1906         p->selFlags |= SF_FixedLimit;
1907       }
1908     }else{
1909       sqlite3ExprCode(pParse, p->pLimit, iLimit);
1910       sqlite3VdbeAddOp1(v, OP_MustBeInt, iLimit); VdbeCoverage(v);
1911       VdbeComment((v, "LIMIT counter"));
1912       sqlite3VdbeAddOp2(v, OP_IfNot, iLimit, iBreak); VdbeCoverage(v);
1913     }
1914     if( p->pOffset ){
1915       p->iOffset = iOffset = ++pParse->nMem;
1916       pParse->nMem++;   /* Allocate an extra register for limit+offset */
1917       sqlite3ExprCode(pParse, p->pOffset, iOffset);
1918       sqlite3VdbeAddOp1(v, OP_MustBeInt, iOffset); VdbeCoverage(v);
1919       VdbeComment((v, "OFFSET counter"));
1920       sqlite3VdbeAddOp3(v, OP_OffsetLimit, iLimit, iOffset+1, iOffset);
1921       VdbeComment((v, "LIMIT+OFFSET"));
1922     }
1923   }
1924 }
1925 
1926 #ifndef SQLITE_OMIT_COMPOUND_SELECT
1927 /*
1928 ** Return the appropriate collating sequence for the iCol-th column of
1929 ** the result set for the compound-select statement "p".  Return NULL if
1930 ** the column has no default collating sequence.
1931 **
1932 ** The collating sequence for the compound select is taken from the
1933 ** left-most term of the select that has a collating sequence.
1934 */
1935 static CollSeq *multiSelectCollSeq(Parse *pParse, Select *p, int iCol){
1936   CollSeq *pRet;
1937   if( p->pPrior ){
1938     pRet = multiSelectCollSeq(pParse, p->pPrior, iCol);
1939   }else{
1940     pRet = 0;
1941   }
1942   assert( iCol>=0 );
1943   /* iCol must be less than p->pEList->nExpr.  Otherwise an error would
1944   ** have been thrown during name resolution and we would not have gotten
1945   ** this far */
1946   if( pRet==0 && ALWAYS(iCol<p->pEList->nExpr) ){
1947     pRet = sqlite3ExprCollSeq(pParse, p->pEList->a[iCol].pExpr);
1948   }
1949   return pRet;
1950 }
1951 
1952 /*
1953 ** The select statement passed as the second parameter is a compound SELECT
1954 ** with an ORDER BY clause. This function allocates and returns a KeyInfo
1955 ** structure suitable for implementing the ORDER BY.
1956 **
1957 ** Space to hold the KeyInfo structure is obtained from malloc. The calling
1958 ** function is responsible for ensuring that this structure is eventually
1959 ** freed.
1960 */
1961 static KeyInfo *multiSelectOrderByKeyInfo(Parse *pParse, Select *p, int nExtra){
1962   ExprList *pOrderBy = p->pOrderBy;
1963   int nOrderBy = p->pOrderBy->nExpr;
1964   sqlite3 *db = pParse->db;
1965   KeyInfo *pRet = sqlite3KeyInfoAlloc(db, nOrderBy+nExtra, 1);
1966   if( pRet ){
1967     int i;
1968     for(i=0; i<nOrderBy; i++){
1969       struct ExprList_item *pItem = &pOrderBy->a[i];
1970       Expr *pTerm = pItem->pExpr;
1971       CollSeq *pColl;
1972 
1973       if( pTerm->flags & EP_Collate ){
1974         pColl = sqlite3ExprCollSeq(pParse, pTerm);
1975       }else{
1976         pColl = multiSelectCollSeq(pParse, p, pItem->u.x.iOrderByCol-1);
1977         if( pColl==0 ) pColl = db->pDfltColl;
1978         pOrderBy->a[i].pExpr =
1979           sqlite3ExprAddCollateString(pParse, pTerm, pColl->zName);
1980       }
1981       assert( sqlite3KeyInfoIsWriteable(pRet) );
1982       pRet->aColl[i] = pColl;
1983       pRet->aSortOrder[i] = pOrderBy->a[i].sortOrder;
1984     }
1985   }
1986 
1987   return pRet;
1988 }
1989 
1990 #ifndef SQLITE_OMIT_CTE
1991 /*
1992 ** This routine generates VDBE code to compute the content of a WITH RECURSIVE
1993 ** query of the form:
1994 **
1995 **   <recursive-table> AS (<setup-query> UNION [ALL] <recursive-query>)
1996 **                         \___________/             \_______________/
1997 **                           p->pPrior                      p
1998 **
1999 **
2000 ** There is exactly one reference to the recursive-table in the FROM clause
2001 ** of recursive-query, marked with the SrcList->a[].fg.isRecursive flag.
2002 **
2003 ** The setup-query runs once to generate an initial set of rows that go
2004 ** into a Queue table.  Rows are extracted from the Queue table one by
2005 ** one.  Each row extracted from Queue is output to pDest.  Then the single
2006 ** extracted row (now in the iCurrent table) becomes the content of the
2007 ** recursive-table for a recursive-query run.  The output of the recursive-query
2008 ** is added back into the Queue table.  Then another row is extracted from Queue
2009 ** and the iteration continues until the Queue table is empty.
2010 **
2011 ** If the compound query operator is UNION then no duplicate rows are ever
2012 ** inserted into the Queue table.  The iDistinct table keeps a copy of all rows
2013 ** that have ever been inserted into Queue and causes duplicates to be
2014 ** discarded.  If the operator is UNION ALL, then duplicates are allowed.
2015 **
2016 ** If the query has an ORDER BY, then entries in the Queue table are kept in
2017 ** ORDER BY order and the first entry is extracted for each cycle.  Without
2018 ** an ORDER BY, the Queue table is just a FIFO.
2019 **
2020 ** If a LIMIT clause is provided, then the iteration stops after LIMIT rows
2021 ** have been output to pDest.  A LIMIT of zero means to output no rows and a
2022 ** negative LIMIT means to output all rows.  If there is also an OFFSET clause
2023 ** with a positive value, then the first OFFSET outputs are discarded rather
2024 ** than being sent to pDest.  The LIMIT count does not begin until after OFFSET
2025 ** rows have been skipped.
2026 */
2027 static void generateWithRecursiveQuery(
2028   Parse *pParse,        /* Parsing context */
2029   Select *p,            /* The recursive SELECT to be coded */
2030   SelectDest *pDest     /* What to do with query results */
2031 ){
2032   SrcList *pSrc = p->pSrc;      /* The FROM clause of the recursive query */
2033   int nCol = p->pEList->nExpr;  /* Number of columns in the recursive table */
2034   Vdbe *v = pParse->pVdbe;      /* The prepared statement under construction */
2035   Select *pSetup = p->pPrior;   /* The setup query */
2036   int addrTop;                  /* Top of the loop */
2037   int addrCont, addrBreak;      /* CONTINUE and BREAK addresses */
2038   int iCurrent = 0;             /* The Current table */
2039   int regCurrent;               /* Register holding Current table */
2040   int iQueue;                   /* The Queue table */
2041   int iDistinct = 0;            /* To ensure unique results if UNION */
2042   int eDest = SRT_Fifo;         /* How to write to Queue */
2043   SelectDest destQueue;         /* SelectDest targetting the Queue table */
2044   int i;                        /* Loop counter */
2045   int rc;                       /* Result code */
2046   ExprList *pOrderBy;           /* The ORDER BY clause */
2047   Expr *pLimit, *pOffset;       /* Saved LIMIT and OFFSET */
2048   int regLimit, regOffset;      /* Registers used by LIMIT and OFFSET */
2049 
2050   /* Obtain authorization to do a recursive query */
2051   if( sqlite3AuthCheck(pParse, SQLITE_RECURSIVE, 0, 0, 0) ) return;
2052 
2053   /* Process the LIMIT and OFFSET clauses, if they exist */
2054   addrBreak = sqlite3VdbeMakeLabel(v);
2055   p->nSelectRow = 320;  /* 4 billion rows */
2056   computeLimitRegisters(pParse, p, addrBreak);
2057   pLimit = p->pLimit;
2058   pOffset = p->pOffset;
2059   regLimit = p->iLimit;
2060   regOffset = p->iOffset;
2061   p->pLimit = p->pOffset = 0;
2062   p->iLimit = p->iOffset = 0;
2063   pOrderBy = p->pOrderBy;
2064 
2065   /* Locate the cursor number of the Current table */
2066   for(i=0; ALWAYS(i<pSrc->nSrc); i++){
2067     if( pSrc->a[i].fg.isRecursive ){
2068       iCurrent = pSrc->a[i].iCursor;
2069       break;
2070     }
2071   }
2072 
2073   /* Allocate cursors numbers for Queue and Distinct.  The cursor number for
2074   ** the Distinct table must be exactly one greater than Queue in order
2075   ** for the SRT_DistFifo and SRT_DistQueue destinations to work. */
2076   iQueue = pParse->nTab++;
2077   if( p->op==TK_UNION ){
2078     eDest = pOrderBy ? SRT_DistQueue : SRT_DistFifo;
2079     iDistinct = pParse->nTab++;
2080   }else{
2081     eDest = pOrderBy ? SRT_Queue : SRT_Fifo;
2082   }
2083   sqlite3SelectDestInit(&destQueue, eDest, iQueue);
2084 
2085   /* Allocate cursors for Current, Queue, and Distinct. */
2086   regCurrent = ++pParse->nMem;
2087   sqlite3VdbeAddOp3(v, OP_OpenPseudo, iCurrent, regCurrent, nCol);
2088   if( pOrderBy ){
2089     KeyInfo *pKeyInfo = multiSelectOrderByKeyInfo(pParse, p, 1);
2090     sqlite3VdbeAddOp4(v, OP_OpenEphemeral, iQueue, pOrderBy->nExpr+2, 0,
2091                       (char*)pKeyInfo, P4_KEYINFO);
2092     destQueue.pOrderBy = pOrderBy;
2093   }else{
2094     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iQueue, nCol);
2095   }
2096   VdbeComment((v, "Queue table"));
2097   if( iDistinct ){
2098     p->addrOpenEphm[0] = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, iDistinct, 0);
2099     p->selFlags |= SF_UsesEphemeral;
2100   }
2101 
2102   /* Detach the ORDER BY clause from the compound SELECT */
2103   p->pOrderBy = 0;
2104 
2105   /* Store the results of the setup-query in Queue. */
2106   pSetup->pNext = 0;
2107   rc = sqlite3Select(pParse, pSetup, &destQueue);
2108   pSetup->pNext = p;
2109   if( rc ) goto end_of_recursive_query;
2110 
2111   /* Find the next row in the Queue and output that row */
2112   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iQueue, addrBreak); VdbeCoverage(v);
2113 
2114   /* Transfer the next row in Queue over to Current */
2115   sqlite3VdbeAddOp1(v, OP_NullRow, iCurrent); /* To reset column cache */
2116   if( pOrderBy ){
2117     sqlite3VdbeAddOp3(v, OP_Column, iQueue, pOrderBy->nExpr+1, regCurrent);
2118   }else{
2119     sqlite3VdbeAddOp2(v, OP_RowData, iQueue, regCurrent);
2120   }
2121   sqlite3VdbeAddOp1(v, OP_Delete, iQueue);
2122 
2123   /* Output the single row in Current */
2124   addrCont = sqlite3VdbeMakeLabel(v);
2125   codeOffset(v, regOffset, addrCont);
2126   selectInnerLoop(pParse, p, p->pEList, iCurrent,
2127       0, 0, pDest, addrCont, addrBreak);
2128   if( regLimit ){
2129     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, regLimit, addrBreak);
2130     VdbeCoverage(v);
2131   }
2132   sqlite3VdbeResolveLabel(v, addrCont);
2133 
2134   /* Execute the recursive SELECT taking the single row in Current as
2135   ** the value for the recursive-table. Store the results in the Queue.
2136   */
2137   if( p->selFlags & SF_Aggregate ){
2138     sqlite3ErrorMsg(pParse, "recursive aggregate queries not supported");
2139   }else{
2140     p->pPrior = 0;
2141     sqlite3Select(pParse, p, &destQueue);
2142     assert( p->pPrior==0 );
2143     p->pPrior = pSetup;
2144   }
2145 
2146   /* Keep running the loop until the Queue is empty */
2147   sqlite3VdbeGoto(v, addrTop);
2148   sqlite3VdbeResolveLabel(v, addrBreak);
2149 
2150 end_of_recursive_query:
2151   sqlite3ExprListDelete(pParse->db, p->pOrderBy);
2152   p->pOrderBy = pOrderBy;
2153   p->pLimit = pLimit;
2154   p->pOffset = pOffset;
2155   return;
2156 }
2157 #endif /* SQLITE_OMIT_CTE */
2158 
2159 /* Forward references */
2160 static int multiSelectOrderBy(
2161   Parse *pParse,        /* Parsing context */
2162   Select *p,            /* The right-most of SELECTs to be coded */
2163   SelectDest *pDest     /* What to do with query results */
2164 );
2165 
2166 /*
2167 ** Handle the special case of a compound-select that originates from a
2168 ** VALUES clause.  By handling this as a special case, we avoid deep
2169 ** recursion, and thus do not need to enforce the SQLITE_LIMIT_COMPOUND_SELECT
2170 ** on a VALUES clause.
2171 **
2172 ** Because the Select object originates from a VALUES clause:
2173 **   (1) It has no LIMIT or OFFSET
2174 **   (2) All terms are UNION ALL
2175 **   (3) There is no ORDER BY clause
2176 */
2177 static int multiSelectValues(
2178   Parse *pParse,        /* Parsing context */
2179   Select *p,            /* The right-most of SELECTs to be coded */
2180   SelectDest *pDest     /* What to do with query results */
2181 ){
2182   Select *pPrior;
2183   int nRow = 1;
2184   int rc = 0;
2185   assert( p->selFlags & SF_MultiValue );
2186   do{
2187     assert( p->selFlags & SF_Values );
2188     assert( p->op==TK_ALL || (p->op==TK_SELECT && p->pPrior==0) );
2189     assert( p->pLimit==0 );
2190     assert( p->pOffset==0 );
2191     assert( p->pNext==0 || p->pEList->nExpr==p->pNext->pEList->nExpr );
2192     if( p->pPrior==0 ) break;
2193     assert( p->pPrior->pNext==p );
2194     p = p->pPrior;
2195     nRow++;
2196   }while(1);
2197   while( p ){
2198     pPrior = p->pPrior;
2199     p->pPrior = 0;
2200     rc = sqlite3Select(pParse, p, pDest);
2201     p->pPrior = pPrior;
2202     if( rc ) break;
2203     p->nSelectRow = nRow;
2204     p = p->pNext;
2205   }
2206   return rc;
2207 }
2208 
2209 /*
2210 ** This routine is called to process a compound query form from
2211 ** two or more separate queries using UNION, UNION ALL, EXCEPT, or
2212 ** INTERSECT
2213 **
2214 ** "p" points to the right-most of the two queries.  the query on the
2215 ** left is p->pPrior.  The left query could also be a compound query
2216 ** in which case this routine will be called recursively.
2217 **
2218 ** The results of the total query are to be written into a destination
2219 ** of type eDest with parameter iParm.
2220 **
2221 ** Example 1:  Consider a three-way compound SQL statement.
2222 **
2223 **     SELECT a FROM t1 UNION SELECT b FROM t2 UNION SELECT c FROM t3
2224 **
2225 ** This statement is parsed up as follows:
2226 **
2227 **     SELECT c FROM t3
2228 **      |
2229 **      `----->  SELECT b FROM t2
2230 **                |
2231 **                `------>  SELECT a FROM t1
2232 **
2233 ** The arrows in the diagram above represent the Select.pPrior pointer.
2234 ** So if this routine is called with p equal to the t3 query, then
2235 ** pPrior will be the t2 query.  p->op will be TK_UNION in this case.
2236 **
2237 ** Notice that because of the way SQLite parses compound SELECTs, the
2238 ** individual selects always group from left to right.
2239 */
2240 static int multiSelect(
2241   Parse *pParse,        /* Parsing context */
2242   Select *p,            /* The right-most of SELECTs to be coded */
2243   SelectDest *pDest     /* What to do with query results */
2244 ){
2245   int rc = SQLITE_OK;   /* Success code from a subroutine */
2246   Select *pPrior;       /* Another SELECT immediately to our left */
2247   Vdbe *v;              /* Generate code to this VDBE */
2248   SelectDest dest;      /* Alternative data destination */
2249   Select *pDelete = 0;  /* Chain of simple selects to delete */
2250   sqlite3 *db;          /* Database connection */
2251 #ifndef SQLITE_OMIT_EXPLAIN
2252   int iSub1 = 0;        /* EQP id of left-hand query */
2253   int iSub2 = 0;        /* EQP id of right-hand query */
2254 #endif
2255 
2256   /* Make sure there is no ORDER BY or LIMIT clause on prior SELECTs.  Only
2257   ** the last (right-most) SELECT in the series may have an ORDER BY or LIMIT.
2258   */
2259   assert( p && p->pPrior );  /* Calling function guarantees this much */
2260   assert( (p->selFlags & SF_Recursive)==0 || p->op==TK_ALL || p->op==TK_UNION );
2261   db = pParse->db;
2262   pPrior = p->pPrior;
2263   dest = *pDest;
2264   if( pPrior->pOrderBy ){
2265     sqlite3ErrorMsg(pParse,"ORDER BY clause should come after %s not before",
2266       selectOpName(p->op));
2267     rc = 1;
2268     goto multi_select_end;
2269   }
2270   if( pPrior->pLimit ){
2271     sqlite3ErrorMsg(pParse,"LIMIT clause should come after %s not before",
2272       selectOpName(p->op));
2273     rc = 1;
2274     goto multi_select_end;
2275   }
2276 
2277   v = sqlite3GetVdbe(pParse);
2278   assert( v!=0 );  /* The VDBE already created by calling function */
2279 
2280   /* Create the destination temporary table if necessary
2281   */
2282   if( dest.eDest==SRT_EphemTab ){
2283     assert( p->pEList );
2284     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, dest.iSDParm, p->pEList->nExpr);
2285     dest.eDest = SRT_Table;
2286   }
2287 
2288   /* Special handling for a compound-select that originates as a VALUES clause.
2289   */
2290   if( p->selFlags & SF_MultiValue ){
2291     rc = multiSelectValues(pParse, p, &dest);
2292     goto multi_select_end;
2293   }
2294 
2295   /* Make sure all SELECTs in the statement have the same number of elements
2296   ** in their result sets.
2297   */
2298   assert( p->pEList && pPrior->pEList );
2299   assert( p->pEList->nExpr==pPrior->pEList->nExpr );
2300 
2301 #ifndef SQLITE_OMIT_CTE
2302   if( p->selFlags & SF_Recursive ){
2303     generateWithRecursiveQuery(pParse, p, &dest);
2304   }else
2305 #endif
2306 
2307   /* Compound SELECTs that have an ORDER BY clause are handled separately.
2308   */
2309   if( p->pOrderBy ){
2310     return multiSelectOrderBy(pParse, p, pDest);
2311   }else
2312 
2313   /* Generate code for the left and right SELECT statements.
2314   */
2315   switch( p->op ){
2316     case TK_ALL: {
2317       int addr = 0;
2318       int nLimit;
2319       assert( !pPrior->pLimit );
2320       pPrior->iLimit = p->iLimit;
2321       pPrior->iOffset = p->iOffset;
2322       pPrior->pLimit = p->pLimit;
2323       pPrior->pOffset = p->pOffset;
2324       explainSetInteger(iSub1, pParse->iNextSelectId);
2325       rc = sqlite3Select(pParse, pPrior, &dest);
2326       p->pLimit = 0;
2327       p->pOffset = 0;
2328       if( rc ){
2329         goto multi_select_end;
2330       }
2331       p->pPrior = 0;
2332       p->iLimit = pPrior->iLimit;
2333       p->iOffset = pPrior->iOffset;
2334       if( p->iLimit ){
2335         addr = sqlite3VdbeAddOp1(v, OP_IfNot, p->iLimit); VdbeCoverage(v);
2336         VdbeComment((v, "Jump ahead if LIMIT reached"));
2337         if( p->iOffset ){
2338           sqlite3VdbeAddOp3(v, OP_OffsetLimit,
2339                             p->iLimit, p->iOffset+1, p->iOffset);
2340         }
2341       }
2342       explainSetInteger(iSub2, pParse->iNextSelectId);
2343       rc = sqlite3Select(pParse, p, &dest);
2344       testcase( rc!=SQLITE_OK );
2345       pDelete = p->pPrior;
2346       p->pPrior = pPrior;
2347       p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2348       if( pPrior->pLimit
2349        && sqlite3ExprIsInteger(pPrior->pLimit, &nLimit)
2350        && nLimit>0 && p->nSelectRow > sqlite3LogEst((u64)nLimit)
2351       ){
2352         p->nSelectRow = sqlite3LogEst((u64)nLimit);
2353       }
2354       if( addr ){
2355         sqlite3VdbeJumpHere(v, addr);
2356       }
2357       break;
2358     }
2359     case TK_EXCEPT:
2360     case TK_UNION: {
2361       int unionTab;    /* Cursor number of the temporary table holding result */
2362       u8 op = 0;       /* One of the SRT_ operations to apply to self */
2363       int priorOp;     /* The SRT_ operation to apply to prior selects */
2364       Expr *pLimit, *pOffset; /* Saved values of p->nLimit and p->nOffset */
2365       int addr;
2366       SelectDest uniondest;
2367 
2368       testcase( p->op==TK_EXCEPT );
2369       testcase( p->op==TK_UNION );
2370       priorOp = SRT_Union;
2371       if( dest.eDest==priorOp ){
2372         /* We can reuse a temporary table generated by a SELECT to our
2373         ** right.
2374         */
2375         assert( p->pLimit==0 );      /* Not allowed on leftward elements */
2376         assert( p->pOffset==0 );     /* Not allowed on leftward elements */
2377         unionTab = dest.iSDParm;
2378       }else{
2379         /* We will need to create our own temporary table to hold the
2380         ** intermediate results.
2381         */
2382         unionTab = pParse->nTab++;
2383         assert( p->pOrderBy==0 );
2384         addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, unionTab, 0);
2385         assert( p->addrOpenEphm[0] == -1 );
2386         p->addrOpenEphm[0] = addr;
2387         findRightmost(p)->selFlags |= SF_UsesEphemeral;
2388         assert( p->pEList );
2389       }
2390 
2391       /* Code the SELECT statements to our left
2392       */
2393       assert( !pPrior->pOrderBy );
2394       sqlite3SelectDestInit(&uniondest, priorOp, unionTab);
2395       explainSetInteger(iSub1, pParse->iNextSelectId);
2396       rc = sqlite3Select(pParse, pPrior, &uniondest);
2397       if( rc ){
2398         goto multi_select_end;
2399       }
2400 
2401       /* Code the current SELECT statement
2402       */
2403       if( p->op==TK_EXCEPT ){
2404         op = SRT_Except;
2405       }else{
2406         assert( p->op==TK_UNION );
2407         op = SRT_Union;
2408       }
2409       p->pPrior = 0;
2410       pLimit = p->pLimit;
2411       p->pLimit = 0;
2412       pOffset = p->pOffset;
2413       p->pOffset = 0;
2414       uniondest.eDest = op;
2415       explainSetInteger(iSub2, pParse->iNextSelectId);
2416       rc = sqlite3Select(pParse, p, &uniondest);
2417       testcase( rc!=SQLITE_OK );
2418       /* Query flattening in sqlite3Select() might refill p->pOrderBy.
2419       ** Be sure to delete p->pOrderBy, therefore, to avoid a memory leak. */
2420       sqlite3ExprListDelete(db, p->pOrderBy);
2421       pDelete = p->pPrior;
2422       p->pPrior = pPrior;
2423       p->pOrderBy = 0;
2424       if( p->op==TK_UNION ){
2425         p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
2426       }
2427       sqlite3ExprDelete(db, p->pLimit);
2428       p->pLimit = pLimit;
2429       p->pOffset = pOffset;
2430       p->iLimit = 0;
2431       p->iOffset = 0;
2432 
2433       /* Convert the data in the temporary table into whatever form
2434       ** it is that we currently need.
2435       */
2436       assert( unionTab==dest.iSDParm || dest.eDest!=priorOp );
2437       if( dest.eDest!=priorOp ){
2438         int iCont, iBreak, iStart;
2439         assert( p->pEList );
2440         if( dest.eDest==SRT_Output ){
2441           Select *pFirst = p;
2442           while( pFirst->pPrior ) pFirst = pFirst->pPrior;
2443           generateColumnNames(pParse, pFirst->pSrc, pFirst->pEList);
2444         }
2445         iBreak = sqlite3VdbeMakeLabel(v);
2446         iCont = sqlite3VdbeMakeLabel(v);
2447         computeLimitRegisters(pParse, p, iBreak);
2448         sqlite3VdbeAddOp2(v, OP_Rewind, unionTab, iBreak); VdbeCoverage(v);
2449         iStart = sqlite3VdbeCurrentAddr(v);
2450         selectInnerLoop(pParse, p, p->pEList, unionTab,
2451                         0, 0, &dest, iCont, iBreak);
2452         sqlite3VdbeResolveLabel(v, iCont);
2453         sqlite3VdbeAddOp2(v, OP_Next, unionTab, iStart); VdbeCoverage(v);
2454         sqlite3VdbeResolveLabel(v, iBreak);
2455         sqlite3VdbeAddOp2(v, OP_Close, unionTab, 0);
2456       }
2457       break;
2458     }
2459     default: assert( p->op==TK_INTERSECT ); {
2460       int tab1, tab2;
2461       int iCont, iBreak, iStart;
2462       Expr *pLimit, *pOffset;
2463       int addr;
2464       SelectDest intersectdest;
2465       int r1;
2466 
2467       /* INTERSECT is different from the others since it requires
2468       ** two temporary tables.  Hence it has its own case.  Begin
2469       ** by allocating the tables we will need.
2470       */
2471       tab1 = pParse->nTab++;
2472       tab2 = pParse->nTab++;
2473       assert( p->pOrderBy==0 );
2474 
2475       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab1, 0);
2476       assert( p->addrOpenEphm[0] == -1 );
2477       p->addrOpenEphm[0] = addr;
2478       findRightmost(p)->selFlags |= SF_UsesEphemeral;
2479       assert( p->pEList );
2480 
2481       /* Code the SELECTs to our left into temporary table "tab1".
2482       */
2483       sqlite3SelectDestInit(&intersectdest, SRT_Union, tab1);
2484       explainSetInteger(iSub1, pParse->iNextSelectId);
2485       rc = sqlite3Select(pParse, pPrior, &intersectdest);
2486       if( rc ){
2487         goto multi_select_end;
2488       }
2489 
2490       /* Code the current SELECT into temporary table "tab2"
2491       */
2492       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, tab2, 0);
2493       assert( p->addrOpenEphm[1] == -1 );
2494       p->addrOpenEphm[1] = addr;
2495       p->pPrior = 0;
2496       pLimit = p->pLimit;
2497       p->pLimit = 0;
2498       pOffset = p->pOffset;
2499       p->pOffset = 0;
2500       intersectdest.iSDParm = tab2;
2501       explainSetInteger(iSub2, pParse->iNextSelectId);
2502       rc = sqlite3Select(pParse, p, &intersectdest);
2503       testcase( rc!=SQLITE_OK );
2504       pDelete = p->pPrior;
2505       p->pPrior = pPrior;
2506       if( p->nSelectRow>pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
2507       sqlite3ExprDelete(db, p->pLimit);
2508       p->pLimit = pLimit;
2509       p->pOffset = pOffset;
2510 
2511       /* Generate code to take the intersection of the two temporary
2512       ** tables.
2513       */
2514       assert( p->pEList );
2515       if( dest.eDest==SRT_Output ){
2516         Select *pFirst = p;
2517         while( pFirst->pPrior ) pFirst = pFirst->pPrior;
2518         generateColumnNames(pParse, pFirst->pSrc, pFirst->pEList);
2519       }
2520       iBreak = sqlite3VdbeMakeLabel(v);
2521       iCont = sqlite3VdbeMakeLabel(v);
2522       computeLimitRegisters(pParse, p, iBreak);
2523       sqlite3VdbeAddOp2(v, OP_Rewind, tab1, iBreak); VdbeCoverage(v);
2524       r1 = sqlite3GetTempReg(pParse);
2525       iStart = sqlite3VdbeAddOp2(v, OP_RowData, tab1, r1);
2526       sqlite3VdbeAddOp4Int(v, OP_NotFound, tab2, iCont, r1, 0); VdbeCoverage(v);
2527       sqlite3ReleaseTempReg(pParse, r1);
2528       selectInnerLoop(pParse, p, p->pEList, tab1,
2529                       0, 0, &dest, iCont, iBreak);
2530       sqlite3VdbeResolveLabel(v, iCont);
2531       sqlite3VdbeAddOp2(v, OP_Next, tab1, iStart); VdbeCoverage(v);
2532       sqlite3VdbeResolveLabel(v, iBreak);
2533       sqlite3VdbeAddOp2(v, OP_Close, tab2, 0);
2534       sqlite3VdbeAddOp2(v, OP_Close, tab1, 0);
2535       break;
2536     }
2537   }
2538 
2539   explainComposite(pParse, p->op, iSub1, iSub2, p->op!=TK_ALL);
2540 
2541   /* Compute collating sequences used by
2542   ** temporary tables needed to implement the compound select.
2543   ** Attach the KeyInfo structure to all temporary tables.
2544   **
2545   ** This section is run by the right-most SELECT statement only.
2546   ** SELECT statements to the left always skip this part.  The right-most
2547   ** SELECT might also skip this part if it has no ORDER BY clause and
2548   ** no temp tables are required.
2549   */
2550   if( p->selFlags & SF_UsesEphemeral ){
2551     int i;                        /* Loop counter */
2552     KeyInfo *pKeyInfo;            /* Collating sequence for the result set */
2553     Select *pLoop;                /* For looping through SELECT statements */
2554     CollSeq **apColl;             /* For looping through pKeyInfo->aColl[] */
2555     int nCol;                     /* Number of columns in result set */
2556 
2557     assert( p->pNext==0 );
2558     nCol = p->pEList->nExpr;
2559     pKeyInfo = sqlite3KeyInfoAlloc(db, nCol, 1);
2560     if( !pKeyInfo ){
2561       rc = SQLITE_NOMEM_BKPT;
2562       goto multi_select_end;
2563     }
2564     for(i=0, apColl=pKeyInfo->aColl; i<nCol; i++, apColl++){
2565       *apColl = multiSelectCollSeq(pParse, p, i);
2566       if( 0==*apColl ){
2567         *apColl = db->pDfltColl;
2568       }
2569     }
2570 
2571     for(pLoop=p; pLoop; pLoop=pLoop->pPrior){
2572       for(i=0; i<2; i++){
2573         int addr = pLoop->addrOpenEphm[i];
2574         if( addr<0 ){
2575           /* If [0] is unused then [1] is also unused.  So we can
2576           ** always safely abort as soon as the first unused slot is found */
2577           assert( pLoop->addrOpenEphm[1]<0 );
2578           break;
2579         }
2580         sqlite3VdbeChangeP2(v, addr, nCol);
2581         sqlite3VdbeChangeP4(v, addr, (char*)sqlite3KeyInfoRef(pKeyInfo),
2582                             P4_KEYINFO);
2583         pLoop->addrOpenEphm[i] = -1;
2584       }
2585     }
2586     sqlite3KeyInfoUnref(pKeyInfo);
2587   }
2588 
2589 multi_select_end:
2590   pDest->iSdst = dest.iSdst;
2591   pDest->nSdst = dest.nSdst;
2592   sqlite3SelectDelete(db, pDelete);
2593   return rc;
2594 }
2595 #endif /* SQLITE_OMIT_COMPOUND_SELECT */
2596 
2597 /*
2598 ** Error message for when two or more terms of a compound select have different
2599 ** size result sets.
2600 */
2601 void sqlite3SelectWrongNumTermsError(Parse *pParse, Select *p){
2602   if( p->selFlags & SF_Values ){
2603     sqlite3ErrorMsg(pParse, "all VALUES must have the same number of terms");
2604   }else{
2605     sqlite3ErrorMsg(pParse, "SELECTs to the left and right of %s"
2606       " do not have the same number of result columns", selectOpName(p->op));
2607   }
2608 }
2609 
2610 /*
2611 ** Code an output subroutine for a coroutine implementation of a
2612 ** SELECT statment.
2613 **
2614 ** The data to be output is contained in pIn->iSdst.  There are
2615 ** pIn->nSdst columns to be output.  pDest is where the output should
2616 ** be sent.
2617 **
2618 ** regReturn is the number of the register holding the subroutine
2619 ** return address.
2620 **
2621 ** If regPrev>0 then it is the first register in a vector that
2622 ** records the previous output.  mem[regPrev] is a flag that is false
2623 ** if there has been no previous output.  If regPrev>0 then code is
2624 ** generated to suppress duplicates.  pKeyInfo is used for comparing
2625 ** keys.
2626 **
2627 ** If the LIMIT found in p->iLimit is reached, jump immediately to
2628 ** iBreak.
2629 */
2630 static int generateOutputSubroutine(
2631   Parse *pParse,          /* Parsing context */
2632   Select *p,              /* The SELECT statement */
2633   SelectDest *pIn,        /* Coroutine supplying data */
2634   SelectDest *pDest,      /* Where to send the data */
2635   int regReturn,          /* The return address register */
2636   int regPrev,            /* Previous result register.  No uniqueness if 0 */
2637   KeyInfo *pKeyInfo,      /* For comparing with previous entry */
2638   int iBreak              /* Jump here if we hit the LIMIT */
2639 ){
2640   Vdbe *v = pParse->pVdbe;
2641   int iContinue;
2642   int addr;
2643 
2644   addr = sqlite3VdbeCurrentAddr(v);
2645   iContinue = sqlite3VdbeMakeLabel(v);
2646 
2647   /* Suppress duplicates for UNION, EXCEPT, and INTERSECT
2648   */
2649   if( regPrev ){
2650     int addr1, addr2;
2651     addr1 = sqlite3VdbeAddOp1(v, OP_IfNot, regPrev); VdbeCoverage(v);
2652     addr2 = sqlite3VdbeAddOp4(v, OP_Compare, pIn->iSdst, regPrev+1, pIn->nSdst,
2653                               (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
2654     sqlite3VdbeAddOp3(v, OP_Jump, addr2+2, iContinue, addr2+2); VdbeCoverage(v);
2655     sqlite3VdbeJumpHere(v, addr1);
2656     sqlite3VdbeAddOp3(v, OP_Copy, pIn->iSdst, regPrev+1, pIn->nSdst-1);
2657     sqlite3VdbeAddOp2(v, OP_Integer, 1, regPrev);
2658   }
2659   if( pParse->db->mallocFailed ) return 0;
2660 
2661   /* Suppress the first OFFSET entries if there is an OFFSET clause
2662   */
2663   codeOffset(v, p->iOffset, iContinue);
2664 
2665   assert( pDest->eDest!=SRT_Exists );
2666   assert( pDest->eDest!=SRT_Table );
2667   switch( pDest->eDest ){
2668     /* Store the result as data using a unique key.
2669     */
2670     case SRT_EphemTab: {
2671       int r1 = sqlite3GetTempReg(pParse);
2672       int r2 = sqlite3GetTempReg(pParse);
2673       sqlite3VdbeAddOp3(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst, r1);
2674       sqlite3VdbeAddOp2(v, OP_NewRowid, pDest->iSDParm, r2);
2675       sqlite3VdbeAddOp3(v, OP_Insert, pDest->iSDParm, r1, r2);
2676       sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
2677       sqlite3ReleaseTempReg(pParse, r2);
2678       sqlite3ReleaseTempReg(pParse, r1);
2679       break;
2680     }
2681 
2682 #ifndef SQLITE_OMIT_SUBQUERY
2683     /* If we are creating a set for an "expr IN (SELECT ...)".
2684     */
2685     case SRT_Set: {
2686       int r1;
2687       testcase( pIn->nSdst>1 );
2688       r1 = sqlite3GetTempReg(pParse);
2689       sqlite3VdbeAddOp4(v, OP_MakeRecord, pIn->iSdst, pIn->nSdst,
2690           r1, pDest->zAffSdst, pIn->nSdst);
2691       sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
2692       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pDest->iSDParm, r1,
2693                            pIn->iSdst, pIn->nSdst);
2694       sqlite3ReleaseTempReg(pParse, r1);
2695       break;
2696     }
2697 
2698     /* If this is a scalar select that is part of an expression, then
2699     ** store the results in the appropriate memory cell and break out
2700     ** of the scan loop.
2701     */
2702     case SRT_Mem: {
2703       assert( pIn->nSdst==1 || pParse->nErr>0 );  testcase( pIn->nSdst!=1 );
2704       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSDParm, 1);
2705       /* The LIMIT clause will jump out of the loop for us */
2706       break;
2707     }
2708 #endif /* #ifndef SQLITE_OMIT_SUBQUERY */
2709 
2710     /* The results are stored in a sequence of registers
2711     ** starting at pDest->iSdst.  Then the co-routine yields.
2712     */
2713     case SRT_Coroutine: {
2714       if( pDest->iSdst==0 ){
2715         pDest->iSdst = sqlite3GetTempRange(pParse, pIn->nSdst);
2716         pDest->nSdst = pIn->nSdst;
2717       }
2718       sqlite3ExprCodeMove(pParse, pIn->iSdst, pDest->iSdst, pIn->nSdst);
2719       sqlite3VdbeAddOp1(v, OP_Yield, pDest->iSDParm);
2720       break;
2721     }
2722 
2723     /* If none of the above, then the result destination must be
2724     ** SRT_Output.  This routine is never called with any other
2725     ** destination other than the ones handled above or SRT_Output.
2726     **
2727     ** For SRT_Output, results are stored in a sequence of registers.
2728     ** Then the OP_ResultRow opcode is used to cause sqlite3_step() to
2729     ** return the next row of result.
2730     */
2731     default: {
2732       assert( pDest->eDest==SRT_Output );
2733       sqlite3VdbeAddOp2(v, OP_ResultRow, pIn->iSdst, pIn->nSdst);
2734       sqlite3ExprCacheAffinityChange(pParse, pIn->iSdst, pIn->nSdst);
2735       break;
2736     }
2737   }
2738 
2739   /* Jump to the end of the loop if the LIMIT is reached.
2740   */
2741   if( p->iLimit ){
2742     sqlite3VdbeAddOp2(v, OP_DecrJumpZero, p->iLimit, iBreak); VdbeCoverage(v);
2743   }
2744 
2745   /* Generate the subroutine return
2746   */
2747   sqlite3VdbeResolveLabel(v, iContinue);
2748   sqlite3VdbeAddOp1(v, OP_Return, regReturn);
2749 
2750   return addr;
2751 }
2752 
2753 /*
2754 ** Alternative compound select code generator for cases when there
2755 ** is an ORDER BY clause.
2756 **
2757 ** We assume a query of the following form:
2758 **
2759 **      <selectA>  <operator>  <selectB>  ORDER BY <orderbylist>
2760 **
2761 ** <operator> is one of UNION ALL, UNION, EXCEPT, or INTERSECT.  The idea
2762 ** is to code both <selectA> and <selectB> with the ORDER BY clause as
2763 ** co-routines.  Then run the co-routines in parallel and merge the results
2764 ** into the output.  In addition to the two coroutines (called selectA and
2765 ** selectB) there are 7 subroutines:
2766 **
2767 **    outA:    Move the output of the selectA coroutine into the output
2768 **             of the compound query.
2769 **
2770 **    outB:    Move the output of the selectB coroutine into the output
2771 **             of the compound query.  (Only generated for UNION and
2772 **             UNION ALL.  EXCEPT and INSERTSECT never output a row that
2773 **             appears only in B.)
2774 **
2775 **    AltB:    Called when there is data from both coroutines and A<B.
2776 **
2777 **    AeqB:    Called when there is data from both coroutines and A==B.
2778 **
2779 **    AgtB:    Called when there is data from both coroutines and A>B.
2780 **
2781 **    EofA:    Called when data is exhausted from selectA.
2782 **
2783 **    EofB:    Called when data is exhausted from selectB.
2784 **
2785 ** The implementation of the latter five subroutines depend on which
2786 ** <operator> is used:
2787 **
2788 **
2789 **             UNION ALL         UNION            EXCEPT          INTERSECT
2790 **          -------------  -----------------  --------------  -----------------
2791 **   AltB:   outA, nextA      outA, nextA       outA, nextA         nextA
2792 **
2793 **   AeqB:   outA, nextA         nextA             nextA         outA, nextA
2794 **
2795 **   AgtB:   outB, nextB      outB, nextB          nextB            nextB
2796 **
2797 **   EofA:   outB, nextB      outB, nextB          halt             halt
2798 **
2799 **   EofB:   outA, nextA      outA, nextA       outA, nextA         halt
2800 **
2801 ** In the AltB, AeqB, and AgtB subroutines, an EOF on A following nextA
2802 ** causes an immediate jump to EofA and an EOF on B following nextB causes
2803 ** an immediate jump to EofB.  Within EofA and EofB, and EOF on entry or
2804 ** following nextX causes a jump to the end of the select processing.
2805 **
2806 ** Duplicate removal in the UNION, EXCEPT, and INTERSECT cases is handled
2807 ** within the output subroutine.  The regPrev register set holds the previously
2808 ** output value.  A comparison is made against this value and the output
2809 ** is skipped if the next results would be the same as the previous.
2810 **
2811 ** The implementation plan is to implement the two coroutines and seven
2812 ** subroutines first, then put the control logic at the bottom.  Like this:
2813 **
2814 **          goto Init
2815 **     coA: coroutine for left query (A)
2816 **     coB: coroutine for right query (B)
2817 **    outA: output one row of A
2818 **    outB: output one row of B (UNION and UNION ALL only)
2819 **    EofA: ...
2820 **    EofB: ...
2821 **    AltB: ...
2822 **    AeqB: ...
2823 **    AgtB: ...
2824 **    Init: initialize coroutine registers
2825 **          yield coA
2826 **          if eof(A) goto EofA
2827 **          yield coB
2828 **          if eof(B) goto EofB
2829 **    Cmpr: Compare A, B
2830 **          Jump AltB, AeqB, AgtB
2831 **     End: ...
2832 **
2833 ** We call AltB, AeqB, AgtB, EofA, and EofB "subroutines" but they are not
2834 ** actually called using Gosub and they do not Return.  EofA and EofB loop
2835 ** until all data is exhausted then jump to the "end" labe.  AltB, AeqB,
2836 ** and AgtB jump to either L2 or to one of EofA or EofB.
2837 */
2838 #ifndef SQLITE_OMIT_COMPOUND_SELECT
2839 static int multiSelectOrderBy(
2840   Parse *pParse,        /* Parsing context */
2841   Select *p,            /* The right-most of SELECTs to be coded */
2842   SelectDest *pDest     /* What to do with query results */
2843 ){
2844   int i, j;             /* Loop counters */
2845   Select *pPrior;       /* Another SELECT immediately to our left */
2846   Vdbe *v;              /* Generate code to this VDBE */
2847   SelectDest destA;     /* Destination for coroutine A */
2848   SelectDest destB;     /* Destination for coroutine B */
2849   int regAddrA;         /* Address register for select-A coroutine */
2850   int regAddrB;         /* Address register for select-B coroutine */
2851   int addrSelectA;      /* Address of the select-A coroutine */
2852   int addrSelectB;      /* Address of the select-B coroutine */
2853   int regOutA;          /* Address register for the output-A subroutine */
2854   int regOutB;          /* Address register for the output-B subroutine */
2855   int addrOutA;         /* Address of the output-A subroutine */
2856   int addrOutB = 0;     /* Address of the output-B subroutine */
2857   int addrEofA;         /* Address of the select-A-exhausted subroutine */
2858   int addrEofA_noB;     /* Alternate addrEofA if B is uninitialized */
2859   int addrEofB;         /* Address of the select-B-exhausted subroutine */
2860   int addrAltB;         /* Address of the A<B subroutine */
2861   int addrAeqB;         /* Address of the A==B subroutine */
2862   int addrAgtB;         /* Address of the A>B subroutine */
2863   int regLimitA;        /* Limit register for select-A */
2864   int regLimitB;        /* Limit register for select-A */
2865   int regPrev;          /* A range of registers to hold previous output */
2866   int savedLimit;       /* Saved value of p->iLimit */
2867   int savedOffset;      /* Saved value of p->iOffset */
2868   int labelCmpr;        /* Label for the start of the merge algorithm */
2869   int labelEnd;         /* Label for the end of the overall SELECT stmt */
2870   int addr1;            /* Jump instructions that get retargetted */
2871   int op;               /* One of TK_ALL, TK_UNION, TK_EXCEPT, TK_INTERSECT */
2872   KeyInfo *pKeyDup = 0; /* Comparison information for duplicate removal */
2873   KeyInfo *pKeyMerge;   /* Comparison information for merging rows */
2874   sqlite3 *db;          /* Database connection */
2875   ExprList *pOrderBy;   /* The ORDER BY clause */
2876   int nOrderBy;         /* Number of terms in the ORDER BY clause */
2877   int *aPermute;        /* Mapping from ORDER BY terms to result set columns */
2878 #ifndef SQLITE_OMIT_EXPLAIN
2879   int iSub1;            /* EQP id of left-hand query */
2880   int iSub2;            /* EQP id of right-hand query */
2881 #endif
2882 
2883   assert( p->pOrderBy!=0 );
2884   assert( pKeyDup==0 ); /* "Managed" code needs this.  Ticket #3382. */
2885   db = pParse->db;
2886   v = pParse->pVdbe;
2887   assert( v!=0 );       /* Already thrown the error if VDBE alloc failed */
2888   labelEnd = sqlite3VdbeMakeLabel(v);
2889   labelCmpr = sqlite3VdbeMakeLabel(v);
2890 
2891 
2892   /* Patch up the ORDER BY clause
2893   */
2894   op = p->op;
2895   pPrior = p->pPrior;
2896   assert( pPrior->pOrderBy==0 );
2897   pOrderBy = p->pOrderBy;
2898   assert( pOrderBy );
2899   nOrderBy = pOrderBy->nExpr;
2900 
2901   /* For operators other than UNION ALL we have to make sure that
2902   ** the ORDER BY clause covers every term of the result set.  Add
2903   ** terms to the ORDER BY clause as necessary.
2904   */
2905   if( op!=TK_ALL ){
2906     for(i=1; db->mallocFailed==0 && i<=p->pEList->nExpr; i++){
2907       struct ExprList_item *pItem;
2908       for(j=0, pItem=pOrderBy->a; j<nOrderBy; j++, pItem++){
2909         assert( pItem->u.x.iOrderByCol>0 );
2910         if( pItem->u.x.iOrderByCol==i ) break;
2911       }
2912       if( j==nOrderBy ){
2913         Expr *pNew = sqlite3Expr(db, TK_INTEGER, 0);
2914         if( pNew==0 ) return SQLITE_NOMEM_BKPT;
2915         pNew->flags |= EP_IntValue;
2916         pNew->u.iValue = i;
2917         p->pOrderBy = pOrderBy = sqlite3ExprListAppend(pParse, pOrderBy, pNew);
2918         if( pOrderBy ) pOrderBy->a[nOrderBy++].u.x.iOrderByCol = (u16)i;
2919       }
2920     }
2921   }
2922 
2923   /* Compute the comparison permutation and keyinfo that is used with
2924   ** the permutation used to determine if the next
2925   ** row of results comes from selectA or selectB.  Also add explicit
2926   ** collations to the ORDER BY clause terms so that when the subqueries
2927   ** to the right and the left are evaluated, they use the correct
2928   ** collation.
2929   */
2930   aPermute = sqlite3DbMallocRawNN(db, sizeof(int)*(nOrderBy + 1));
2931   if( aPermute ){
2932     struct ExprList_item *pItem;
2933     aPermute[0] = nOrderBy;
2934     for(i=1, pItem=pOrderBy->a; i<=nOrderBy; i++, pItem++){
2935       assert( pItem->u.x.iOrderByCol>0 );
2936       assert( pItem->u.x.iOrderByCol<=p->pEList->nExpr );
2937       aPermute[i] = pItem->u.x.iOrderByCol - 1;
2938     }
2939     pKeyMerge = multiSelectOrderByKeyInfo(pParse, p, 1);
2940   }else{
2941     pKeyMerge = 0;
2942   }
2943 
2944   /* Reattach the ORDER BY clause to the query.
2945   */
2946   p->pOrderBy = pOrderBy;
2947   pPrior->pOrderBy = sqlite3ExprListDup(pParse->db, pOrderBy, 0);
2948 
2949   /* Allocate a range of temporary registers and the KeyInfo needed
2950   ** for the logic that removes duplicate result rows when the
2951   ** operator is UNION, EXCEPT, or INTERSECT (but not UNION ALL).
2952   */
2953   if( op==TK_ALL ){
2954     regPrev = 0;
2955   }else{
2956     int nExpr = p->pEList->nExpr;
2957     assert( nOrderBy>=nExpr || db->mallocFailed );
2958     regPrev = pParse->nMem+1;
2959     pParse->nMem += nExpr+1;
2960     sqlite3VdbeAddOp2(v, OP_Integer, 0, regPrev);
2961     pKeyDup = sqlite3KeyInfoAlloc(db, nExpr, 1);
2962     if( pKeyDup ){
2963       assert( sqlite3KeyInfoIsWriteable(pKeyDup) );
2964       for(i=0; i<nExpr; i++){
2965         pKeyDup->aColl[i] = multiSelectCollSeq(pParse, p, i);
2966         pKeyDup->aSortOrder[i] = 0;
2967       }
2968     }
2969   }
2970 
2971   /* Separate the left and the right query from one another
2972   */
2973   p->pPrior = 0;
2974   pPrior->pNext = 0;
2975   sqlite3ResolveOrderGroupBy(pParse, p, p->pOrderBy, "ORDER");
2976   if( pPrior->pPrior==0 ){
2977     sqlite3ResolveOrderGroupBy(pParse, pPrior, pPrior->pOrderBy, "ORDER");
2978   }
2979 
2980   /* Compute the limit registers */
2981   computeLimitRegisters(pParse, p, labelEnd);
2982   if( p->iLimit && op==TK_ALL ){
2983     regLimitA = ++pParse->nMem;
2984     regLimitB = ++pParse->nMem;
2985     sqlite3VdbeAddOp2(v, OP_Copy, p->iOffset ? p->iOffset+1 : p->iLimit,
2986                                   regLimitA);
2987     sqlite3VdbeAddOp2(v, OP_Copy, regLimitA, regLimitB);
2988   }else{
2989     regLimitA = regLimitB = 0;
2990   }
2991   sqlite3ExprDelete(db, p->pLimit);
2992   p->pLimit = 0;
2993   sqlite3ExprDelete(db, p->pOffset);
2994   p->pOffset = 0;
2995 
2996   regAddrA = ++pParse->nMem;
2997   regAddrB = ++pParse->nMem;
2998   regOutA = ++pParse->nMem;
2999   regOutB = ++pParse->nMem;
3000   sqlite3SelectDestInit(&destA, SRT_Coroutine, regAddrA);
3001   sqlite3SelectDestInit(&destB, SRT_Coroutine, regAddrB);
3002 
3003   /* Generate a coroutine to evaluate the SELECT statement to the
3004   ** left of the compound operator - the "A" select.
3005   */
3006   addrSelectA = sqlite3VdbeCurrentAddr(v) + 1;
3007   addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrA, 0, addrSelectA);
3008   VdbeComment((v, "left SELECT"));
3009   pPrior->iLimit = regLimitA;
3010   explainSetInteger(iSub1, pParse->iNextSelectId);
3011   sqlite3Select(pParse, pPrior, &destA);
3012   sqlite3VdbeEndCoroutine(v, regAddrA);
3013   sqlite3VdbeJumpHere(v, addr1);
3014 
3015   /* Generate a coroutine to evaluate the SELECT statement on
3016   ** the right - the "B" select
3017   */
3018   addrSelectB = sqlite3VdbeCurrentAddr(v) + 1;
3019   addr1 = sqlite3VdbeAddOp3(v, OP_InitCoroutine, regAddrB, 0, addrSelectB);
3020   VdbeComment((v, "right SELECT"));
3021   savedLimit = p->iLimit;
3022   savedOffset = p->iOffset;
3023   p->iLimit = regLimitB;
3024   p->iOffset = 0;
3025   explainSetInteger(iSub2, pParse->iNextSelectId);
3026   sqlite3Select(pParse, p, &destB);
3027   p->iLimit = savedLimit;
3028   p->iOffset = savedOffset;
3029   sqlite3VdbeEndCoroutine(v, regAddrB);
3030 
3031   /* Generate a subroutine that outputs the current row of the A
3032   ** select as the next output row of the compound select.
3033   */
3034   VdbeNoopComment((v, "Output routine for A"));
3035   addrOutA = generateOutputSubroutine(pParse,
3036                  p, &destA, pDest, regOutA,
3037                  regPrev, pKeyDup, labelEnd);
3038 
3039   /* Generate a subroutine that outputs the current row of the B
3040   ** select as the next output row of the compound select.
3041   */
3042   if( op==TK_ALL || op==TK_UNION ){
3043     VdbeNoopComment((v, "Output routine for B"));
3044     addrOutB = generateOutputSubroutine(pParse,
3045                  p, &destB, pDest, regOutB,
3046                  regPrev, pKeyDup, labelEnd);
3047   }
3048   sqlite3KeyInfoUnref(pKeyDup);
3049 
3050   /* Generate a subroutine to run when the results from select A
3051   ** are exhausted and only data in select B remains.
3052   */
3053   if( op==TK_EXCEPT || op==TK_INTERSECT ){
3054     addrEofA_noB = addrEofA = labelEnd;
3055   }else{
3056     VdbeNoopComment((v, "eof-A subroutine"));
3057     addrEofA = sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3058     addrEofA_noB = sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, labelEnd);
3059                                      VdbeCoverage(v);
3060     sqlite3VdbeGoto(v, addrEofA);
3061     p->nSelectRow = sqlite3LogEstAdd(p->nSelectRow, pPrior->nSelectRow);
3062   }
3063 
3064   /* Generate a subroutine to run when the results from select B
3065   ** are exhausted and only data in select A remains.
3066   */
3067   if( op==TK_INTERSECT ){
3068     addrEofB = addrEofA;
3069     if( p->nSelectRow > pPrior->nSelectRow ) p->nSelectRow = pPrior->nSelectRow;
3070   }else{
3071     VdbeNoopComment((v, "eof-B subroutine"));
3072     addrEofB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3073     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, labelEnd); VdbeCoverage(v);
3074     sqlite3VdbeGoto(v, addrEofB);
3075   }
3076 
3077   /* Generate code to handle the case of A<B
3078   */
3079   VdbeNoopComment((v, "A-lt-B subroutine"));
3080   addrAltB = sqlite3VdbeAddOp2(v, OP_Gosub, regOutA, addrOutA);
3081   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
3082   sqlite3VdbeGoto(v, labelCmpr);
3083 
3084   /* Generate code to handle the case of A==B
3085   */
3086   if( op==TK_ALL ){
3087     addrAeqB = addrAltB;
3088   }else if( op==TK_INTERSECT ){
3089     addrAeqB = addrAltB;
3090     addrAltB++;
3091   }else{
3092     VdbeNoopComment((v, "A-eq-B subroutine"));
3093     addrAeqB =
3094     sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA); VdbeCoverage(v);
3095     sqlite3VdbeGoto(v, labelCmpr);
3096   }
3097 
3098   /* Generate code to handle the case of A>B
3099   */
3100   VdbeNoopComment((v, "A-gt-B subroutine"));
3101   addrAgtB = sqlite3VdbeCurrentAddr(v);
3102   if( op==TK_ALL || op==TK_UNION ){
3103     sqlite3VdbeAddOp2(v, OP_Gosub, regOutB, addrOutB);
3104   }
3105   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
3106   sqlite3VdbeGoto(v, labelCmpr);
3107 
3108   /* This code runs once to initialize everything.
3109   */
3110   sqlite3VdbeJumpHere(v, addr1);
3111   sqlite3VdbeAddOp2(v, OP_Yield, regAddrA, addrEofA_noB); VdbeCoverage(v);
3112   sqlite3VdbeAddOp2(v, OP_Yield, regAddrB, addrEofB); VdbeCoverage(v);
3113 
3114   /* Implement the main merge loop
3115   */
3116   sqlite3VdbeResolveLabel(v, labelCmpr);
3117   sqlite3VdbeAddOp4(v, OP_Permutation, 0, 0, 0, (char*)aPermute, P4_INTARRAY);
3118   sqlite3VdbeAddOp4(v, OP_Compare, destA.iSdst, destB.iSdst, nOrderBy,
3119                          (char*)pKeyMerge, P4_KEYINFO);
3120   sqlite3VdbeChangeP5(v, OPFLAG_PERMUTE);
3121   sqlite3VdbeAddOp3(v, OP_Jump, addrAltB, addrAeqB, addrAgtB); VdbeCoverage(v);
3122 
3123   /* Jump to the this point in order to terminate the query.
3124   */
3125   sqlite3VdbeResolveLabel(v, labelEnd);
3126 
3127   /* Set the number of output columns
3128   */
3129   if( pDest->eDest==SRT_Output ){
3130     Select *pFirst = pPrior;
3131     while( pFirst->pPrior ) pFirst = pFirst->pPrior;
3132     generateColumnNames(pParse, pFirst->pSrc, pFirst->pEList);
3133   }
3134 
3135   /* Reassembly the compound query so that it will be freed correctly
3136   ** by the calling function */
3137   if( p->pPrior ){
3138     sqlite3SelectDelete(db, p->pPrior);
3139   }
3140   p->pPrior = pPrior;
3141   pPrior->pNext = p;
3142 
3143   /*** TBD:  Insert subroutine calls to close cursors on incomplete
3144   **** subqueries ****/
3145   explainComposite(pParse, p->op, iSub1, iSub2, 0);
3146   return pParse->nErr!=0;
3147 }
3148 #endif
3149 
3150 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3151 
3152 /* An instance of the SubstContext object describes an substitution edit
3153 ** to be performed on a parse tree.
3154 **
3155 ** All references to columns in table iTable are to be replaced by corresponding
3156 ** expressions in pEList.
3157 */
3158 typedef struct SubstContext {
3159   Parse *pParse;            /* The parsing context */
3160   int iTable;               /* Replace references to this table */
3161   int iNewTable;            /* New table number */
3162   int isLeftJoin;           /* Add TK_IF_NULL_ROW opcodes on each replacement */
3163   ExprList *pEList;         /* Replacement expressions */
3164 } SubstContext;
3165 
3166 /* Forward Declarations */
3167 static void substExprList(SubstContext*, ExprList*);
3168 static void substSelect(SubstContext*, Select*, int);
3169 
3170 /*
3171 ** Scan through the expression pExpr.  Replace every reference to
3172 ** a column in table number iTable with a copy of the iColumn-th
3173 ** entry in pEList.  (But leave references to the ROWID column
3174 ** unchanged.)
3175 **
3176 ** This routine is part of the flattening procedure.  A subquery
3177 ** whose result set is defined by pEList appears as entry in the
3178 ** FROM clause of a SELECT such that the VDBE cursor assigned to that
3179 ** FORM clause entry is iTable.  This routine makes the necessary
3180 ** changes to pExpr so that it refers directly to the source table
3181 ** of the subquery rather the result set of the subquery.
3182 */
3183 static Expr *substExpr(
3184   SubstContext *pSubst,  /* Description of the substitution */
3185   Expr *pExpr            /* Expr in which substitution occurs */
3186 ){
3187   if( pExpr==0 ) return 0;
3188   if( ExprHasProperty(pExpr, EP_FromJoin) && pExpr->iRightJoinTable==pSubst->iTable ){
3189     pExpr->iRightJoinTable = pSubst->iNewTable;
3190   }
3191   if( pExpr->op==TK_COLUMN && pExpr->iTable==pSubst->iTable ){
3192     if( pExpr->iColumn<0 ){
3193       pExpr->op = TK_NULL;
3194     }else{
3195       Expr *pNew;
3196       Expr *pCopy = pSubst->pEList->a[pExpr->iColumn].pExpr;
3197       Expr ifNullRow;
3198       assert( pSubst->pEList!=0 && pExpr->iColumn<pSubst->pEList->nExpr );
3199       assert( pExpr->pLeft==0 && pExpr->pRight==0 );
3200       if( sqlite3ExprIsVector(pCopy) ){
3201         sqlite3VectorErrorMsg(pSubst->pParse, pCopy);
3202       }else{
3203         sqlite3 *db = pSubst->pParse->db;
3204         if( pSubst->isLeftJoin && pCopy->op!=TK_COLUMN ){
3205           memset(&ifNullRow, 0, sizeof(ifNullRow));
3206           ifNullRow.op = TK_IF_NULL_ROW;
3207           ifNullRow.pLeft = pCopy;
3208           ifNullRow.iTable = pSubst->iNewTable;
3209           pCopy = &ifNullRow;
3210         }
3211         pNew = sqlite3ExprDup(db, pCopy, 0);
3212         if( pNew && pSubst->isLeftJoin ){
3213           ExprSetProperty(pNew, EP_CanBeNull);
3214         }
3215         if( pNew && ExprHasProperty(pExpr,EP_FromJoin) ){
3216           pNew->iRightJoinTable = pExpr->iRightJoinTable;
3217           ExprSetProperty(pNew, EP_FromJoin);
3218         }
3219         sqlite3ExprDelete(db, pExpr);
3220         pExpr = pNew;
3221       }
3222     }
3223   }else{
3224     if( pExpr->op==TK_IF_NULL_ROW && pExpr->iTable==pSubst->iTable ){
3225       pExpr->iTable = pSubst->iNewTable;
3226     }
3227     pExpr->pLeft = substExpr(pSubst, pExpr->pLeft);
3228     pExpr->pRight = substExpr(pSubst, pExpr->pRight);
3229     if( ExprHasProperty(pExpr, EP_xIsSelect) ){
3230       substSelect(pSubst, pExpr->x.pSelect, 1);
3231     }else{
3232       substExprList(pSubst, pExpr->x.pList);
3233     }
3234   }
3235   return pExpr;
3236 }
3237 static void substExprList(
3238   SubstContext *pSubst, /* Description of the substitution */
3239   ExprList *pList       /* List to scan and in which to make substitutes */
3240 ){
3241   int i;
3242   if( pList==0 ) return;
3243   for(i=0; i<pList->nExpr; i++){
3244     pList->a[i].pExpr = substExpr(pSubst, pList->a[i].pExpr);
3245   }
3246 }
3247 static void substSelect(
3248   SubstContext *pSubst, /* Description of the substitution */
3249   Select *p,            /* SELECT statement in which to make substitutions */
3250   int doPrior           /* Do substitutes on p->pPrior too */
3251 ){
3252   SrcList *pSrc;
3253   struct SrcList_item *pItem;
3254   int i;
3255   if( !p ) return;
3256   do{
3257     substExprList(pSubst, p->pEList);
3258     substExprList(pSubst, p->pGroupBy);
3259     substExprList(pSubst, p->pOrderBy);
3260     p->pHaving = substExpr(pSubst, p->pHaving);
3261     p->pWhere = substExpr(pSubst, p->pWhere);
3262     pSrc = p->pSrc;
3263     assert( pSrc!=0 );
3264     for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
3265       substSelect(pSubst, pItem->pSelect, 1);
3266       if( pItem->fg.isTabFunc ){
3267         substExprList(pSubst, pItem->u1.pFuncArg);
3268       }
3269     }
3270   }while( doPrior && (p = p->pPrior)!=0 );
3271 }
3272 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3273 
3274 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3275 /*
3276 ** This routine attempts to flatten subqueries as a performance optimization.
3277 ** This routine returns 1 if it makes changes and 0 if no flattening occurs.
3278 **
3279 ** To understand the concept of flattening, consider the following
3280 ** query:
3281 **
3282 **     SELECT a FROM (SELECT x+y AS a FROM t1 WHERE z<100) WHERE a>5
3283 **
3284 ** The default way of implementing this query is to execute the
3285 ** subquery first and store the results in a temporary table, then
3286 ** run the outer query on that temporary table.  This requires two
3287 ** passes over the data.  Furthermore, because the temporary table
3288 ** has no indices, the WHERE clause on the outer query cannot be
3289 ** optimized.
3290 **
3291 ** This routine attempts to rewrite queries such as the above into
3292 ** a single flat select, like this:
3293 **
3294 **     SELECT x+y AS a FROM t1 WHERE z<100 AND a>5
3295 **
3296 ** The code generated for this simplification gives the same result
3297 ** but only has to scan the data once.  And because indices might
3298 ** exist on the table t1, a complete scan of the data might be
3299 ** avoided.
3300 **
3301 ** Flattening is only attempted if all of the following are true:
3302 **
3303 **   (1)  The subquery and the outer query do not both use aggregates.
3304 **
3305 **   (2)  The subquery is not an aggregate or (2a) the outer query is not a join
3306 **        and (2b) the outer query does not use subqueries other than the one
3307 **        FROM-clause subquery that is a candidate for flattening.  (2b is
3308 **        due to ticket [2f7170d73bf9abf80] from 2015-02-09.)
3309 **
3310 **   (3)  The subquery is not the right operand of a LEFT JOIN
3311 **        or the subquery is not itself a join and the outer query is not
3312 **        an aggregate.
3313 **
3314 **   (4)  The subquery is not DISTINCT.
3315 **
3316 **  (**)  At one point restrictions (4) and (5) defined a subset of DISTINCT
3317 **        sub-queries that were excluded from this optimization. Restriction
3318 **        (4) has since been expanded to exclude all DISTINCT subqueries.
3319 **
3320 **   (6)  The subquery does not use aggregates or the outer query is not
3321 **        DISTINCT.
3322 **
3323 **   (7)  The subquery has a FROM clause.  TODO:  For subqueries without
3324 **        A FROM clause, consider adding a FROM clause with the special
3325 **        table sqlite_once that consists of a single row containing a
3326 **        single NULL.
3327 **
3328 **   (8)  The subquery does not use LIMIT or the outer query is not a join.
3329 **
3330 **   (9)  The subquery does not use LIMIT or the outer query does not use
3331 **        aggregates.
3332 **
3333 **  (**)  Restriction (10) was removed from the code on 2005-02-05 but we
3334 **        accidently carried the comment forward until 2014-09-15.  Original
3335 **        text: "The subquery does not use aggregates or the outer query
3336 **        does not use LIMIT."
3337 **
3338 **  (11)  The subquery and the outer query do not both have ORDER BY clauses.
3339 **
3340 **  (**)  Not implemented.  Subsumed into restriction (3).  Was previously
3341 **        a separate restriction deriving from ticket #350.
3342 **
3343 **  (13)  The subquery and outer query do not both use LIMIT.
3344 **
3345 **  (14)  The subquery does not use OFFSET.
3346 **
3347 **  (15)  The outer query is not part of a compound select or the
3348 **        subquery does not have a LIMIT clause.
3349 **        (See ticket #2339 and ticket [02a8e81d44]).
3350 **
3351 **  (16)  The outer query is not an aggregate or the subquery does
3352 **        not contain ORDER BY.  (Ticket #2942)  This used to not matter
3353 **        until we introduced the group_concat() function.
3354 **
3355 **  (17)  The sub-query is not a compound select, or it is a UNION ALL
3356 **        compound clause made up entirely of non-aggregate queries, and
3357 **        the parent query:
3358 **
3359 **          * is not itself part of a compound select,
3360 **          * is not an aggregate or DISTINCT query, and
3361 **          * is not a join
3362 **
3363 **        The parent and sub-query may contain WHERE clauses. Subject to
3364 **        rules (11), (13) and (14), they may also contain ORDER BY,
3365 **        LIMIT and OFFSET clauses.  The subquery cannot use any compound
3366 **        operator other than UNION ALL because all the other compound
3367 **        operators have an implied DISTINCT which is disallowed by
3368 **        restriction (4).
3369 **
3370 **        Also, each component of the sub-query must return the same number
3371 **        of result columns. This is actually a requirement for any compound
3372 **        SELECT statement, but all the code here does is make sure that no
3373 **        such (illegal) sub-query is flattened. The caller will detect the
3374 **        syntax error and return a detailed message.
3375 **
3376 **  (18)  If the sub-query is a compound select, then all terms of the
3377 **        ORDER by clause of the parent must be simple references to
3378 **        columns of the sub-query.
3379 **
3380 **  (19)  The subquery does not use LIMIT or the outer query does not
3381 **        have a WHERE clause.
3382 **
3383 **  (20)  If the sub-query is a compound select, then it must not use
3384 **        an ORDER BY clause.  Ticket #3773.  We could relax this constraint
3385 **        somewhat by saying that the terms of the ORDER BY clause must
3386 **        appear as unmodified result columns in the outer query.  But we
3387 **        have other optimizations in mind to deal with that case.
3388 **
3389 **  (21)  The subquery does not use LIMIT or the outer query is not
3390 **        DISTINCT.  (See ticket [752e1646fc]).
3391 **
3392 **  (22)  The subquery is not a recursive CTE.
3393 **
3394 **  (23)  The parent is not a recursive CTE, or the sub-query is not a
3395 **        compound query. This restriction is because transforming the
3396 **        parent to a compound query confuses the code that handles
3397 **        recursive queries in multiSelect().
3398 **
3399 **  (24)  The subquery is not an aggregate that uses the built-in min() or
3400 **        or max() functions.  (Without this restriction, a query like:
3401 **        "SELECT x FROM (SELECT max(y), x FROM t1)" would not necessarily
3402 **        return the value X for which Y was maximal.)
3403 **
3404 **
3405 ** In this routine, the "p" parameter is a pointer to the outer query.
3406 ** The subquery is p->pSrc->a[iFrom].  isAgg is true if the outer query
3407 ** uses aggregates and subqueryIsAgg is true if the subquery uses aggregates.
3408 **
3409 ** If flattening is not attempted, this routine is a no-op and returns 0.
3410 ** If flattening is attempted this routine returns 1.
3411 **
3412 ** All of the expression analysis must occur on both the outer query and
3413 ** the subquery before this routine runs.
3414 */
3415 static int flattenSubquery(
3416   Parse *pParse,       /* Parsing context */
3417   Select *p,           /* The parent or outer SELECT statement */
3418   int iFrom,           /* Index in p->pSrc->a[] of the inner subquery */
3419   int isAgg,           /* True if outer SELECT uses aggregate functions */
3420   int subqueryIsAgg    /* True if the subquery uses aggregate functions */
3421 ){
3422   const char *zSavedAuthContext = pParse->zAuthContext;
3423   Select *pParent;    /* Current UNION ALL term of the other query */
3424   Select *pSub;       /* The inner query or "subquery" */
3425   Select *pSub1;      /* Pointer to the rightmost select in sub-query */
3426   SrcList *pSrc;      /* The FROM clause of the outer query */
3427   SrcList *pSubSrc;   /* The FROM clause of the subquery */
3428   ExprList *pList;    /* The result set of the outer query */
3429   int iParent;        /* VDBE cursor number of the pSub result set temp table */
3430   int iNewParent = -1;/* Replacement table for iParent */
3431   int isLeftJoin = 0; /* True if pSub is the right side of a LEFT JOIN */
3432   int i;              /* Loop counter */
3433   Expr *pWhere;                    /* The WHERE clause */
3434   struct SrcList_item *pSubitem;   /* The subquery */
3435   sqlite3 *db = pParse->db;
3436 
3437   /* Check to see if flattening is permitted.  Return 0 if not.
3438   */
3439   assert( p!=0 );
3440   assert( p->pPrior==0 );  /* Unable to flatten compound queries */
3441   if( OptimizationDisabled(db, SQLITE_QueryFlattener) ) return 0;
3442   pSrc = p->pSrc;
3443   assert( pSrc && iFrom>=0 && iFrom<pSrc->nSrc );
3444   pSubitem = &pSrc->a[iFrom];
3445   iParent = pSubitem->iCursor;
3446   pSub = pSubitem->pSelect;
3447   assert( pSub!=0 );
3448   if( subqueryIsAgg ){
3449     if( isAgg ) return 0;                                /* Restriction (1)   */
3450     if( pSrc->nSrc>1 ) return 0;                         /* Restriction (2a)  */
3451     if( (p->pWhere && ExprHasProperty(p->pWhere,EP_Subquery))
3452      || (sqlite3ExprListFlags(p->pEList) & EP_Subquery)!=0
3453      || (sqlite3ExprListFlags(p->pOrderBy) & EP_Subquery)!=0
3454     ){
3455       return 0;                                          /* Restriction (2b)  */
3456     }
3457   }
3458 
3459   pSubSrc = pSub->pSrc;
3460   assert( pSubSrc );
3461   /* Prior to version 3.1.2, when LIMIT and OFFSET had to be simple constants,
3462   ** not arbitrary expressions, we allowed some combining of LIMIT and OFFSET
3463   ** because they could be computed at compile-time.  But when LIMIT and OFFSET
3464   ** became arbitrary expressions, we were forced to add restrictions (13)
3465   ** and (14). */
3466   if( pSub->pLimit && p->pLimit ) return 0;              /* Restriction (13) */
3467   if( pSub->pOffset ) return 0;                          /* Restriction (14) */
3468   if( (p->selFlags & SF_Compound)!=0 && pSub->pLimit ){
3469     return 0;                                            /* Restriction (15) */
3470   }
3471   if( pSubSrc->nSrc==0 ) return 0;                       /* Restriction (7)  */
3472   if( pSub->selFlags & SF_Distinct ) return 0;           /* Restriction (5)  */
3473   if( pSub->pLimit && (pSrc->nSrc>1 || isAgg) ){
3474      return 0;         /* Restrictions (8)(9) */
3475   }
3476   if( (p->selFlags & SF_Distinct)!=0 && subqueryIsAgg ){
3477      return 0;         /* Restriction (6)  */
3478   }
3479   if( p->pOrderBy && pSub->pOrderBy ){
3480      return 0;                                           /* Restriction (11) */
3481   }
3482   if( isAgg && pSub->pOrderBy ) return 0;                /* Restriction (16) */
3483   if( pSub->pLimit && p->pWhere ) return 0;              /* Restriction (19) */
3484   if( pSub->pLimit && (p->selFlags & SF_Distinct)!=0 ){
3485      return 0;         /* Restriction (21) */
3486   }
3487   testcase( pSub->selFlags & SF_Recursive );
3488   testcase( pSub->selFlags & SF_MinMaxAgg );
3489   if( pSub->selFlags & (SF_Recursive|SF_MinMaxAgg) ){
3490     return 0; /* Restrictions (22) and (24) */
3491   }
3492   if( (p->selFlags & SF_Recursive) && pSub->pPrior ){
3493     return 0; /* Restriction (23) */
3494   }
3495 
3496   /*
3497   ** If the subquery is the right operand of a LEFT JOIN, then the
3498   ** subquery may not be a join itself.  Example of why this is not allowed:
3499   **
3500   **         t1 LEFT OUTER JOIN (t2 JOIN t3)
3501   **
3502   ** If we flatten the above, we would get
3503   **
3504   **         (t1 LEFT OUTER JOIN t2) JOIN t3
3505   **
3506   ** which is not at all the same thing.
3507   **
3508   ** If the subquery is the right operand of a LEFT JOIN, then the outer
3509   ** query cannot be an aggregate.  This is an artifact of the way aggregates
3510   ** are processed - there is no mechanism to determine if the LEFT JOIN
3511   ** table should be all-NULL.
3512   **
3513   ** See also tickets #306, #350, and #3300.
3514   */
3515   if( (pSubitem->fg.jointype & JT_OUTER)!=0 ){
3516     isLeftJoin = 1;
3517     if( pSubSrc->nSrc>1 || isAgg ){
3518       return 0; /* Restriction (3) */
3519     }
3520   }
3521 #ifdef SQLITE_EXTRA_IFNULLROW
3522   else if( iFrom>0 && !isAgg ){
3523     /* Setting isLeftJoin to -1 causes OP_IfNullRow opcodes to be generated for
3524     ** every reference to any result column from subquery in a join, even though
3525     ** they are not necessary.  This will stress-test the OP_IfNullRow opcode. */
3526     isLeftJoin = -1;
3527   }
3528 #endif
3529 
3530   /* Restriction 17: If the sub-query is a compound SELECT, then it must
3531   ** use only the UNION ALL operator. And none of the simple select queries
3532   ** that make up the compound SELECT are allowed to be aggregate or distinct
3533   ** queries.
3534   */
3535   if( pSub->pPrior ){
3536     if( pSub->pOrderBy ){
3537       return 0;  /* Restriction 20 */
3538     }
3539     if( isAgg || (p->selFlags & SF_Distinct)!=0 || pSrc->nSrc!=1 ){
3540       return 0;
3541     }
3542     for(pSub1=pSub; pSub1; pSub1=pSub1->pPrior){
3543       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
3544       testcase( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
3545       assert( pSub->pSrc!=0 );
3546       assert( pSub->pEList->nExpr==pSub1->pEList->nExpr );
3547       if( (pSub1->selFlags & (SF_Distinct|SF_Aggregate))!=0
3548        || (pSub1->pPrior && pSub1->op!=TK_ALL)
3549        || pSub1->pSrc->nSrc<1
3550       ){
3551         return 0;
3552       }
3553       testcase( pSub1->pSrc->nSrc>1 );
3554     }
3555 
3556     /* Restriction 18. */
3557     if( p->pOrderBy ){
3558       int ii;
3559       for(ii=0; ii<p->pOrderBy->nExpr; ii++){
3560         if( p->pOrderBy->a[ii].u.x.iOrderByCol==0 ) return 0;
3561       }
3562     }
3563   }
3564 
3565   /***** If we reach this point, flattening is permitted. *****/
3566   SELECTTRACE(1,pParse,p,("flatten %s.%p from term %d\n",
3567                    pSub->zSelName, pSub, iFrom));
3568 
3569   /* Authorize the subquery */
3570   pParse->zAuthContext = pSubitem->zName;
3571   TESTONLY(i =) sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0);
3572   testcase( i==SQLITE_DENY );
3573   pParse->zAuthContext = zSavedAuthContext;
3574 
3575   /* If the sub-query is a compound SELECT statement, then (by restrictions
3576   ** 17 and 18 above) it must be a UNION ALL and the parent query must
3577   ** be of the form:
3578   **
3579   **     SELECT <expr-list> FROM (<sub-query>) <where-clause>
3580   **
3581   ** followed by any ORDER BY, LIMIT and/or OFFSET clauses. This block
3582   ** creates N-1 copies of the parent query without any ORDER BY, LIMIT or
3583   ** OFFSET clauses and joins them to the left-hand-side of the original
3584   ** using UNION ALL operators. In this case N is the number of simple
3585   ** select statements in the compound sub-query.
3586   **
3587   ** Example:
3588   **
3589   **     SELECT a+1 FROM (
3590   **        SELECT x FROM tab
3591   **        UNION ALL
3592   **        SELECT y FROM tab
3593   **        UNION ALL
3594   **        SELECT abs(z*2) FROM tab2
3595   **     ) WHERE a!=5 ORDER BY 1
3596   **
3597   ** Transformed into:
3598   **
3599   **     SELECT x+1 FROM tab WHERE x+1!=5
3600   **     UNION ALL
3601   **     SELECT y+1 FROM tab WHERE y+1!=5
3602   **     UNION ALL
3603   **     SELECT abs(z*2)+1 FROM tab2 WHERE abs(z*2)+1!=5
3604   **     ORDER BY 1
3605   **
3606   ** We call this the "compound-subquery flattening".
3607   */
3608   for(pSub=pSub->pPrior; pSub; pSub=pSub->pPrior){
3609     Select *pNew;
3610     ExprList *pOrderBy = p->pOrderBy;
3611     Expr *pLimit = p->pLimit;
3612     Expr *pOffset = p->pOffset;
3613     Select *pPrior = p->pPrior;
3614     p->pOrderBy = 0;
3615     p->pSrc = 0;
3616     p->pPrior = 0;
3617     p->pLimit = 0;
3618     p->pOffset = 0;
3619     pNew = sqlite3SelectDup(db, p, 0);
3620     sqlite3SelectSetName(pNew, pSub->zSelName);
3621     p->pOffset = pOffset;
3622     p->pLimit = pLimit;
3623     p->pOrderBy = pOrderBy;
3624     p->pSrc = pSrc;
3625     p->op = TK_ALL;
3626     if( pNew==0 ){
3627       p->pPrior = pPrior;
3628     }else{
3629       pNew->pPrior = pPrior;
3630       if( pPrior ) pPrior->pNext = pNew;
3631       pNew->pNext = p;
3632       p->pPrior = pNew;
3633       SELECTTRACE(2,pParse,p,
3634          ("compound-subquery flattener creates %s.%p as peer\n",
3635          pNew->zSelName, pNew));
3636     }
3637     if( db->mallocFailed ) return 1;
3638   }
3639 
3640   /* Begin flattening the iFrom-th entry of the FROM clause
3641   ** in the outer query.
3642   */
3643   pSub = pSub1 = pSubitem->pSelect;
3644 
3645   /* Delete the transient table structure associated with the
3646   ** subquery
3647   */
3648   sqlite3DbFree(db, pSubitem->zDatabase);
3649   sqlite3DbFree(db, pSubitem->zName);
3650   sqlite3DbFree(db, pSubitem->zAlias);
3651   pSubitem->zDatabase = 0;
3652   pSubitem->zName = 0;
3653   pSubitem->zAlias = 0;
3654   pSubitem->pSelect = 0;
3655 
3656   /* Defer deleting the Table object associated with the
3657   ** subquery until code generation is
3658   ** complete, since there may still exist Expr.pTab entries that
3659   ** refer to the subquery even after flattening.  Ticket #3346.
3660   **
3661   ** pSubitem->pTab is always non-NULL by test restrictions and tests above.
3662   */
3663   if( ALWAYS(pSubitem->pTab!=0) ){
3664     Table *pTabToDel = pSubitem->pTab;
3665     if( pTabToDel->nTabRef==1 ){
3666       Parse *pToplevel = sqlite3ParseToplevel(pParse);
3667       pTabToDel->pNextZombie = pToplevel->pZombieTab;
3668       pToplevel->pZombieTab = pTabToDel;
3669     }else{
3670       pTabToDel->nTabRef--;
3671     }
3672     pSubitem->pTab = 0;
3673   }
3674 
3675   /* The following loop runs once for each term in a compound-subquery
3676   ** flattening (as described above).  If we are doing a different kind
3677   ** of flattening - a flattening other than a compound-subquery flattening -
3678   ** then this loop only runs once.
3679   **
3680   ** This loop moves all of the FROM elements of the subquery into the
3681   ** the FROM clause of the outer query.  Before doing this, remember
3682   ** the cursor number for the original outer query FROM element in
3683   ** iParent.  The iParent cursor will never be used.  Subsequent code
3684   ** will scan expressions looking for iParent references and replace
3685   ** those references with expressions that resolve to the subquery FROM
3686   ** elements we are now copying in.
3687   */
3688   for(pParent=p; pParent; pParent=pParent->pPrior, pSub=pSub->pPrior){
3689     int nSubSrc;
3690     u8 jointype = 0;
3691     pSubSrc = pSub->pSrc;     /* FROM clause of subquery */
3692     nSubSrc = pSubSrc->nSrc;  /* Number of terms in subquery FROM clause */
3693     pSrc = pParent->pSrc;     /* FROM clause of the outer query */
3694 
3695     if( pSrc ){
3696       assert( pParent==p );  /* First time through the loop */
3697       jointype = pSubitem->fg.jointype;
3698     }else{
3699       assert( pParent!=p );  /* 2nd and subsequent times through the loop */
3700       pSrc = pParent->pSrc = sqlite3SrcListAppend(db, 0, 0, 0);
3701       if( pSrc==0 ){
3702         assert( db->mallocFailed );
3703         break;
3704       }
3705     }
3706 
3707     /* The subquery uses a single slot of the FROM clause of the outer
3708     ** query.  If the subquery has more than one element in its FROM clause,
3709     ** then expand the outer query to make space for it to hold all elements
3710     ** of the subquery.
3711     **
3712     ** Example:
3713     **
3714     **    SELECT * FROM tabA, (SELECT * FROM sub1, sub2), tabB;
3715     **
3716     ** The outer query has 3 slots in its FROM clause.  One slot of the
3717     ** outer query (the middle slot) is used by the subquery.  The next
3718     ** block of code will expand the outer query FROM clause to 4 slots.
3719     ** The middle slot is expanded to two slots in order to make space
3720     ** for the two elements in the FROM clause of the subquery.
3721     */
3722     if( nSubSrc>1 ){
3723       pParent->pSrc = pSrc = sqlite3SrcListEnlarge(db, pSrc, nSubSrc-1,iFrom+1);
3724       if( db->mallocFailed ){
3725         break;
3726       }
3727     }
3728 
3729     /* Transfer the FROM clause terms from the subquery into the
3730     ** outer query.
3731     */
3732     for(i=0; i<nSubSrc; i++){
3733       sqlite3IdListDelete(db, pSrc->a[i+iFrom].pUsing);
3734       assert( pSrc->a[i+iFrom].fg.isTabFunc==0 );
3735       pSrc->a[i+iFrom] = pSubSrc->a[i];
3736       iNewParent = pSubSrc->a[i].iCursor;
3737       memset(&pSubSrc->a[i], 0, sizeof(pSubSrc->a[i]));
3738     }
3739     pSrc->a[iFrom].fg.jointype = jointype;
3740 
3741     /* Now begin substituting subquery result set expressions for
3742     ** references to the iParent in the outer query.
3743     **
3744     ** Example:
3745     **
3746     **   SELECT a+5, b*10 FROM (SELECT x*3 AS a, y+10 AS b FROM t1) WHERE a>b;
3747     **   \                     \_____________ subquery __________/          /
3748     **    \_____________________ outer query ______________________________/
3749     **
3750     ** We look at every expression in the outer query and every place we see
3751     ** "a" we substitute "x*3" and every place we see "b" we substitute "y+10".
3752     */
3753     pList = pParent->pEList;
3754     for(i=0; i<pList->nExpr; i++){
3755       if( pList->a[i].zName==0 ){
3756         char *zName = sqlite3DbStrDup(db, pList->a[i].zSpan);
3757         sqlite3Dequote(zName);
3758         pList->a[i].zName = zName;
3759       }
3760     }
3761     if( pSub->pOrderBy ){
3762       /* At this point, any non-zero iOrderByCol values indicate that the
3763       ** ORDER BY column expression is identical to the iOrderByCol'th
3764       ** expression returned by SELECT statement pSub. Since these values
3765       ** do not necessarily correspond to columns in SELECT statement pParent,
3766       ** zero them before transfering the ORDER BY clause.
3767       **
3768       ** Not doing this may cause an error if a subsequent call to this
3769       ** function attempts to flatten a compound sub-query into pParent
3770       ** (the only way this can happen is if the compound sub-query is
3771       ** currently part of pSub->pSrc). See ticket [d11a6e908f].  */
3772       ExprList *pOrderBy = pSub->pOrderBy;
3773       for(i=0; i<pOrderBy->nExpr; i++){
3774         pOrderBy->a[i].u.x.iOrderByCol = 0;
3775       }
3776       assert( pParent->pOrderBy==0 );
3777       assert( pSub->pPrior==0 );
3778       pParent->pOrderBy = pOrderBy;
3779       pSub->pOrderBy = 0;
3780     }
3781     pWhere = sqlite3ExprDup(db, pSub->pWhere, 0);
3782     if( isLeftJoin>0 ){
3783       setJoinExpr(pWhere, iNewParent);
3784     }
3785     if( subqueryIsAgg ){
3786       assert( pParent->pHaving==0 );
3787       pParent->pHaving = pParent->pWhere;
3788       pParent->pWhere = pWhere;
3789       pParent->pHaving = sqlite3ExprAnd(db,
3790           sqlite3ExprDup(db, pSub->pHaving, 0), pParent->pHaving
3791       );
3792       assert( pParent->pGroupBy==0 );
3793       pParent->pGroupBy = sqlite3ExprListDup(db, pSub->pGroupBy, 0);
3794     }else{
3795       pParent->pWhere = sqlite3ExprAnd(db, pWhere, pParent->pWhere);
3796     }
3797     if( db->mallocFailed==0 ){
3798       SubstContext x;
3799       x.pParse = pParse;
3800       x.iTable = iParent;
3801       x.iNewTable = iNewParent;
3802       x.isLeftJoin = isLeftJoin;
3803       x.pEList = pSub->pEList;
3804       substSelect(&x, pParent, 0);
3805     }
3806 
3807     /* The flattened query is distinct if either the inner or the
3808     ** outer query is distinct.
3809     */
3810     pParent->selFlags |= pSub->selFlags & SF_Distinct;
3811 
3812     /*
3813     ** SELECT ... FROM (SELECT ... LIMIT a OFFSET b) LIMIT x OFFSET y;
3814     **
3815     ** One is tempted to try to add a and b to combine the limits.  But this
3816     ** does not work if either limit is negative.
3817     */
3818     if( pSub->pLimit ){
3819       pParent->pLimit = pSub->pLimit;
3820       pSub->pLimit = 0;
3821     }
3822   }
3823 
3824   /* Finially, delete what is left of the subquery and return
3825   ** success.
3826   */
3827   sqlite3SelectDelete(db, pSub1);
3828 
3829 #if SELECTTRACE_ENABLED
3830   if( sqlite3SelectTrace & 0x100 ){
3831     SELECTTRACE(0x100,pParse,p,("After flattening:\n"));
3832     sqlite3TreeViewSelect(0, p, 0);
3833   }
3834 #endif
3835 
3836   return 1;
3837 }
3838 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3839 
3840 
3841 
3842 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
3843 /*
3844 ** Make copies of relevant WHERE clause terms of the outer query into
3845 ** the WHERE clause of subquery.  Example:
3846 **
3847 **    SELECT * FROM (SELECT a AS x, c-d AS y FROM t1) WHERE x=5 AND y=10;
3848 **
3849 ** Transformed into:
3850 **
3851 **    SELECT * FROM (SELECT a AS x, c-d AS y FROM t1 WHERE a=5 AND c-d=10)
3852 **     WHERE x=5 AND y=10;
3853 **
3854 ** The hope is that the terms added to the inner query will make it more
3855 ** efficient.
3856 **
3857 ** Do not attempt this optimization if:
3858 **
3859 **   (1) The inner query is an aggregate.  (In that case, we'd really want
3860 **       to copy the outer WHERE-clause terms onto the HAVING clause of the
3861 **       inner query.  But they probably won't help there so do not bother.)
3862 **
3863 **   (2) The inner query is the recursive part of a common table expression.
3864 **
3865 **   (3) The inner query has a LIMIT clause (since the changes to the WHERE
3866 **       close would change the meaning of the LIMIT).
3867 **
3868 **   (4) The inner query is the right operand of a LEFT JOIN.  (The caller
3869 **       enforces this restriction since this routine does not have enough
3870 **       information to know.)
3871 **
3872 **   (5) The WHERE clause expression originates in the ON or USING clause
3873 **       of a LEFT JOIN.
3874 **
3875 ** Return 0 if no changes are made and non-zero if one or more WHERE clause
3876 ** terms are duplicated into the subquery.
3877 */
3878 static int pushDownWhereTerms(
3879   Parse *pParse,        /* Parse context (for malloc() and error reporting) */
3880   Select *pSubq,        /* The subquery whose WHERE clause is to be augmented */
3881   Expr *pWhere,         /* The WHERE clause of the outer query */
3882   int iCursor           /* Cursor number of the subquery */
3883 ){
3884   Expr *pNew;
3885   int nChng = 0;
3886   Select *pX;           /* For looping over compound SELECTs in pSubq */
3887   if( pWhere==0 ) return 0;
3888   for(pX=pSubq; pX; pX=pX->pPrior){
3889     if( (pX->selFlags & (SF_Aggregate|SF_Recursive))!=0 ){
3890       testcase( pX->selFlags & SF_Aggregate );
3891       testcase( pX->selFlags & SF_Recursive );
3892       testcase( pX!=pSubq );
3893       return 0; /* restrictions (1) and (2) */
3894     }
3895   }
3896   if( pSubq->pLimit!=0 ){
3897     return 0; /* restriction (3) */
3898   }
3899   while( pWhere->op==TK_AND ){
3900     nChng += pushDownWhereTerms(pParse, pSubq, pWhere->pRight, iCursor);
3901     pWhere = pWhere->pLeft;
3902   }
3903   if( ExprHasProperty(pWhere,EP_FromJoin) ) return 0; /* restriction 5 */
3904   if( sqlite3ExprIsTableConstant(pWhere, iCursor) ){
3905     nChng++;
3906     while( pSubq ){
3907       SubstContext x;
3908       pNew = sqlite3ExprDup(pParse->db, pWhere, 0);
3909       x.pParse = pParse;
3910       x.iTable = iCursor;
3911       x.iNewTable = iCursor;
3912       x.isLeftJoin = 0;
3913       x.pEList = pSubq->pEList;
3914       pNew = substExpr(&x, pNew);
3915       pSubq->pWhere = sqlite3ExprAnd(pParse->db, pSubq->pWhere, pNew);
3916       pSubq = pSubq->pPrior;
3917     }
3918   }
3919   return nChng;
3920 }
3921 #endif /* !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW) */
3922 
3923 /*
3924 ** Based on the contents of the AggInfo structure indicated by the first
3925 ** argument, this function checks if the following are true:
3926 **
3927 **    * the query contains just a single aggregate function,
3928 **    * the aggregate function is either min() or max(), and
3929 **    * the argument to the aggregate function is a column value.
3930 **
3931 ** If all of the above are true, then WHERE_ORDERBY_MIN or WHERE_ORDERBY_MAX
3932 ** is returned as appropriate. Also, *ppMinMax is set to point to the
3933 ** list of arguments passed to the aggregate before returning.
3934 **
3935 ** Or, if the conditions above are not met, *ppMinMax is set to 0 and
3936 ** WHERE_ORDERBY_NORMAL is returned.
3937 */
3938 static u8 minMaxQuery(AggInfo *pAggInfo, ExprList **ppMinMax){
3939   int eRet = WHERE_ORDERBY_NORMAL;          /* Return value */
3940 
3941   *ppMinMax = 0;
3942   if( pAggInfo->nFunc==1 ){
3943     Expr *pExpr = pAggInfo->aFunc[0].pExpr; /* Aggregate function */
3944     ExprList *pEList = pExpr->x.pList;      /* Arguments to agg function */
3945 
3946     assert( pExpr->op==TK_AGG_FUNCTION );
3947     if( pEList && pEList->nExpr==1 && pEList->a[0].pExpr->op==TK_AGG_COLUMN ){
3948       const char *zFunc = pExpr->u.zToken;
3949       if( sqlite3StrICmp(zFunc, "min")==0 ){
3950         eRet = WHERE_ORDERBY_MIN;
3951         *ppMinMax = pEList;
3952       }else if( sqlite3StrICmp(zFunc, "max")==0 ){
3953         eRet = WHERE_ORDERBY_MAX;
3954         *ppMinMax = pEList;
3955       }
3956     }
3957   }
3958 
3959   assert( *ppMinMax==0 || (*ppMinMax)->nExpr==1 );
3960   return eRet;
3961 }
3962 
3963 /*
3964 ** The select statement passed as the first argument is an aggregate query.
3965 ** The second argument is the associated aggregate-info object. This
3966 ** function tests if the SELECT is of the form:
3967 **
3968 **   SELECT count(*) FROM <tbl>
3969 **
3970 ** where table is a database table, not a sub-select or view. If the query
3971 ** does match this pattern, then a pointer to the Table object representing
3972 ** <tbl> is returned. Otherwise, 0 is returned.
3973 */
3974 static Table *isSimpleCount(Select *p, AggInfo *pAggInfo){
3975   Table *pTab;
3976   Expr *pExpr;
3977 
3978   assert( !p->pGroupBy );
3979 
3980   if( p->pWhere || p->pEList->nExpr!=1
3981    || p->pSrc->nSrc!=1 || p->pSrc->a[0].pSelect
3982   ){
3983     return 0;
3984   }
3985   pTab = p->pSrc->a[0].pTab;
3986   pExpr = p->pEList->a[0].pExpr;
3987   assert( pTab && !pTab->pSelect && pExpr );
3988 
3989   if( IsVirtual(pTab) ) return 0;
3990   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;
3991   if( NEVER(pAggInfo->nFunc==0) ) return 0;
3992   if( (pAggInfo->aFunc[0].pFunc->funcFlags&SQLITE_FUNC_COUNT)==0 ) return 0;
3993   if( pExpr->flags&EP_Distinct ) return 0;
3994 
3995   return pTab;
3996 }
3997 
3998 /*
3999 ** If the source-list item passed as an argument was augmented with an
4000 ** INDEXED BY clause, then try to locate the specified index. If there
4001 ** was such a clause and the named index cannot be found, return
4002 ** SQLITE_ERROR and leave an error in pParse. Otherwise, populate
4003 ** pFrom->pIndex and return SQLITE_OK.
4004 */
4005 int sqlite3IndexedByLookup(Parse *pParse, struct SrcList_item *pFrom){
4006   if( pFrom->pTab && pFrom->fg.isIndexedBy ){
4007     Table *pTab = pFrom->pTab;
4008     char *zIndexedBy = pFrom->u1.zIndexedBy;
4009     Index *pIdx;
4010     for(pIdx=pTab->pIndex;
4011         pIdx && sqlite3StrICmp(pIdx->zName, zIndexedBy);
4012         pIdx=pIdx->pNext
4013     );
4014     if( !pIdx ){
4015       sqlite3ErrorMsg(pParse, "no such index: %s", zIndexedBy, 0);
4016       pParse->checkSchema = 1;
4017       return SQLITE_ERROR;
4018     }
4019     pFrom->pIBIndex = pIdx;
4020   }
4021   return SQLITE_OK;
4022 }
4023 /*
4024 ** Detect compound SELECT statements that use an ORDER BY clause with
4025 ** an alternative collating sequence.
4026 **
4027 **    SELECT ... FROM t1 EXCEPT SELECT ... FROM t2 ORDER BY .. COLLATE ...
4028 **
4029 ** These are rewritten as a subquery:
4030 **
4031 **    SELECT * FROM (SELECT ... FROM t1 EXCEPT SELECT ... FROM t2)
4032 **     ORDER BY ... COLLATE ...
4033 **
4034 ** This transformation is necessary because the multiSelectOrderBy() routine
4035 ** above that generates the code for a compound SELECT with an ORDER BY clause
4036 ** uses a merge algorithm that requires the same collating sequence on the
4037 ** result columns as on the ORDER BY clause.  See ticket
4038 ** http://www.sqlite.org/src/info/6709574d2a
4039 **
4040 ** This transformation is only needed for EXCEPT, INTERSECT, and UNION.
4041 ** The UNION ALL operator works fine with multiSelectOrderBy() even when
4042 ** there are COLLATE terms in the ORDER BY.
4043 */
4044 static int convertCompoundSelectToSubquery(Walker *pWalker, Select *p){
4045   int i;
4046   Select *pNew;
4047   Select *pX;
4048   sqlite3 *db;
4049   struct ExprList_item *a;
4050   SrcList *pNewSrc;
4051   Parse *pParse;
4052   Token dummy;
4053 
4054   if( p->pPrior==0 ) return WRC_Continue;
4055   if( p->pOrderBy==0 ) return WRC_Continue;
4056   for(pX=p; pX && (pX->op==TK_ALL || pX->op==TK_SELECT); pX=pX->pPrior){}
4057   if( pX==0 ) return WRC_Continue;
4058   a = p->pOrderBy->a;
4059   for(i=p->pOrderBy->nExpr-1; i>=0; i--){
4060     if( a[i].pExpr->flags & EP_Collate ) break;
4061   }
4062   if( i<0 ) return WRC_Continue;
4063 
4064   /* If we reach this point, that means the transformation is required. */
4065 
4066   pParse = pWalker->pParse;
4067   db = pParse->db;
4068   pNew = sqlite3DbMallocZero(db, sizeof(*pNew) );
4069   if( pNew==0 ) return WRC_Abort;
4070   memset(&dummy, 0, sizeof(dummy));
4071   pNewSrc = sqlite3SrcListAppendFromTerm(pParse,0,0,0,&dummy,pNew,0,0);
4072   if( pNewSrc==0 ) return WRC_Abort;
4073   *pNew = *p;
4074   p->pSrc = pNewSrc;
4075   p->pEList = sqlite3ExprListAppend(pParse, 0, sqlite3Expr(db, TK_ASTERISK, 0));
4076   p->op = TK_SELECT;
4077   p->pWhere = 0;
4078   pNew->pGroupBy = 0;
4079   pNew->pHaving = 0;
4080   pNew->pOrderBy = 0;
4081   p->pPrior = 0;
4082   p->pNext = 0;
4083   p->pWith = 0;
4084   p->selFlags &= ~SF_Compound;
4085   assert( (p->selFlags & SF_Converted)==0 );
4086   p->selFlags |= SF_Converted;
4087   assert( pNew->pPrior!=0 );
4088   pNew->pPrior->pNext = pNew;
4089   pNew->pLimit = 0;
4090   pNew->pOffset = 0;
4091   return WRC_Continue;
4092 }
4093 
4094 /*
4095 ** Check to see if the FROM clause term pFrom has table-valued function
4096 ** arguments.  If it does, leave an error message in pParse and return
4097 ** non-zero, since pFrom is not allowed to be a table-valued function.
4098 */
4099 static int cannotBeFunction(Parse *pParse, struct SrcList_item *pFrom){
4100   if( pFrom->fg.isTabFunc ){
4101     sqlite3ErrorMsg(pParse, "'%s' is not a function", pFrom->zName);
4102     return 1;
4103   }
4104   return 0;
4105 }
4106 
4107 #ifndef SQLITE_OMIT_CTE
4108 /*
4109 ** Argument pWith (which may be NULL) points to a linked list of nested
4110 ** WITH contexts, from inner to outermost. If the table identified by
4111 ** FROM clause element pItem is really a common-table-expression (CTE)
4112 ** then return a pointer to the CTE definition for that table. Otherwise
4113 ** return NULL.
4114 **
4115 ** If a non-NULL value is returned, set *ppContext to point to the With
4116 ** object that the returned CTE belongs to.
4117 */
4118 static struct Cte *searchWith(
4119   With *pWith,                    /* Current innermost WITH clause */
4120   struct SrcList_item *pItem,     /* FROM clause element to resolve */
4121   With **ppContext                /* OUT: WITH clause return value belongs to */
4122 ){
4123   const char *zName;
4124   if( pItem->zDatabase==0 && (zName = pItem->zName)!=0 ){
4125     With *p;
4126     for(p=pWith; p; p=p->pOuter){
4127       int i;
4128       for(i=0; i<p->nCte; i++){
4129         if( sqlite3StrICmp(zName, p->a[i].zName)==0 ){
4130           *ppContext = p;
4131           return &p->a[i];
4132         }
4133       }
4134     }
4135   }
4136   return 0;
4137 }
4138 
4139 /* The code generator maintains a stack of active WITH clauses
4140 ** with the inner-most WITH clause being at the top of the stack.
4141 **
4142 ** This routine pushes the WITH clause passed as the second argument
4143 ** onto the top of the stack. If argument bFree is true, then this
4144 ** WITH clause will never be popped from the stack. In this case it
4145 ** should be freed along with the Parse object. In other cases, when
4146 ** bFree==0, the With object will be freed along with the SELECT
4147 ** statement with which it is associated.
4148 */
4149 void sqlite3WithPush(Parse *pParse, With *pWith, u8 bFree){
4150   assert( bFree==0 || (pParse->pWith==0 && pParse->pWithToFree==0) );
4151   if( pWith ){
4152     assert( pParse->pWith!=pWith );
4153     pWith->pOuter = pParse->pWith;
4154     pParse->pWith = pWith;
4155     if( bFree ) pParse->pWithToFree = pWith;
4156   }
4157 }
4158 
4159 /*
4160 ** This function checks if argument pFrom refers to a CTE declared by
4161 ** a WITH clause on the stack currently maintained by the parser. And,
4162 ** if currently processing a CTE expression, if it is a recursive
4163 ** reference to the current CTE.
4164 **
4165 ** If pFrom falls into either of the two categories above, pFrom->pTab
4166 ** and other fields are populated accordingly. The caller should check
4167 ** (pFrom->pTab!=0) to determine whether or not a successful match
4168 ** was found.
4169 **
4170 ** Whether or not a match is found, SQLITE_OK is returned if no error
4171 ** occurs. If an error does occur, an error message is stored in the
4172 ** parser and some error code other than SQLITE_OK returned.
4173 */
4174 static int withExpand(
4175   Walker *pWalker,
4176   struct SrcList_item *pFrom
4177 ){
4178   Parse *pParse = pWalker->pParse;
4179   sqlite3 *db = pParse->db;
4180   struct Cte *pCte;               /* Matched CTE (or NULL if no match) */
4181   With *pWith;                    /* WITH clause that pCte belongs to */
4182 
4183   assert( pFrom->pTab==0 );
4184 
4185   pCte = searchWith(pParse->pWith, pFrom, &pWith);
4186   if( pCte ){
4187     Table *pTab;
4188     ExprList *pEList;
4189     Select *pSel;
4190     Select *pLeft;                /* Left-most SELECT statement */
4191     int bMayRecursive;            /* True if compound joined by UNION [ALL] */
4192     With *pSavedWith;             /* Initial value of pParse->pWith */
4193 
4194     /* If pCte->zCteErr is non-NULL at this point, then this is an illegal
4195     ** recursive reference to CTE pCte. Leave an error in pParse and return
4196     ** early. If pCte->zCteErr is NULL, then this is not a recursive reference.
4197     ** In this case, proceed.  */
4198     if( pCte->zCteErr ){
4199       sqlite3ErrorMsg(pParse, pCte->zCteErr, pCte->zName);
4200       return SQLITE_ERROR;
4201     }
4202     if( cannotBeFunction(pParse, pFrom) ) return SQLITE_ERROR;
4203 
4204     assert( pFrom->pTab==0 );
4205     pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
4206     if( pTab==0 ) return WRC_Abort;
4207     pTab->nTabRef = 1;
4208     pTab->zName = sqlite3DbStrDup(db, pCte->zName);
4209     pTab->iPKey = -1;
4210     pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
4211     pTab->tabFlags |= TF_Ephemeral | TF_NoVisibleRowid;
4212     pFrom->pSelect = sqlite3SelectDup(db, pCte->pSelect, 0);
4213     if( db->mallocFailed ) return SQLITE_NOMEM_BKPT;
4214     assert( pFrom->pSelect );
4215 
4216     /* Check if this is a recursive CTE. */
4217     pSel = pFrom->pSelect;
4218     bMayRecursive = ( pSel->op==TK_ALL || pSel->op==TK_UNION );
4219     if( bMayRecursive ){
4220       int i;
4221       SrcList *pSrc = pFrom->pSelect->pSrc;
4222       for(i=0; i<pSrc->nSrc; i++){
4223         struct SrcList_item *pItem = &pSrc->a[i];
4224         if( pItem->zDatabase==0
4225          && pItem->zName!=0
4226          && 0==sqlite3StrICmp(pItem->zName, pCte->zName)
4227           ){
4228           pItem->pTab = pTab;
4229           pItem->fg.isRecursive = 1;
4230           pTab->nTabRef++;
4231           pSel->selFlags |= SF_Recursive;
4232         }
4233       }
4234     }
4235 
4236     /* Only one recursive reference is permitted. */
4237     if( pTab->nTabRef>2 ){
4238       sqlite3ErrorMsg(
4239           pParse, "multiple references to recursive table: %s", pCte->zName
4240       );
4241       return SQLITE_ERROR;
4242     }
4243     assert( pTab->nTabRef==1 || ((pSel->selFlags&SF_Recursive) && pTab->nTabRef==2 ));
4244 
4245     pCte->zCteErr = "circular reference: %s";
4246     pSavedWith = pParse->pWith;
4247     pParse->pWith = pWith;
4248     if( bMayRecursive ){
4249       Select *pPrior = pSel->pPrior;
4250       assert( pPrior->pWith==0 );
4251       pPrior->pWith = pSel->pWith;
4252       sqlite3WalkSelect(pWalker, pPrior);
4253       pPrior->pWith = 0;
4254     }else{
4255       sqlite3WalkSelect(pWalker, pSel);
4256     }
4257     pParse->pWith = pWith;
4258 
4259     for(pLeft=pSel; pLeft->pPrior; pLeft=pLeft->pPrior);
4260     pEList = pLeft->pEList;
4261     if( pCte->pCols ){
4262       if( pEList && pEList->nExpr!=pCte->pCols->nExpr ){
4263         sqlite3ErrorMsg(pParse, "table %s has %d values for %d columns",
4264             pCte->zName, pEList->nExpr, pCte->pCols->nExpr
4265         );
4266         pParse->pWith = pSavedWith;
4267         return SQLITE_ERROR;
4268       }
4269       pEList = pCte->pCols;
4270     }
4271 
4272     sqlite3ColumnsFromExprList(pParse, pEList, &pTab->nCol, &pTab->aCol);
4273     if( bMayRecursive ){
4274       if( pSel->selFlags & SF_Recursive ){
4275         pCte->zCteErr = "multiple recursive references: %s";
4276       }else{
4277         pCte->zCteErr = "recursive reference in a subquery: %s";
4278       }
4279       sqlite3WalkSelect(pWalker, pSel);
4280     }
4281     pCte->zCteErr = 0;
4282     pParse->pWith = pSavedWith;
4283   }
4284 
4285   return SQLITE_OK;
4286 }
4287 #endif
4288 
4289 #ifndef SQLITE_OMIT_CTE
4290 /*
4291 ** If the SELECT passed as the second argument has an associated WITH
4292 ** clause, pop it from the stack stored as part of the Parse object.
4293 **
4294 ** This function is used as the xSelectCallback2() callback by
4295 ** sqlite3SelectExpand() when walking a SELECT tree to resolve table
4296 ** names and other FROM clause elements.
4297 */
4298 static void selectPopWith(Walker *pWalker, Select *p){
4299   Parse *pParse = pWalker->pParse;
4300   if( pParse->pWith && p->pPrior==0 ){
4301     With *pWith = findRightmost(p)->pWith;
4302     if( pWith!=0 ){
4303       assert( pParse->pWith==pWith );
4304       pParse->pWith = pWith->pOuter;
4305     }
4306   }
4307 }
4308 #else
4309 #define selectPopWith 0
4310 #endif
4311 
4312 /*
4313 ** This routine is a Walker callback for "expanding" a SELECT statement.
4314 ** "Expanding" means to do the following:
4315 **
4316 **    (1)  Make sure VDBE cursor numbers have been assigned to every
4317 **         element of the FROM clause.
4318 **
4319 **    (2)  Fill in the pTabList->a[].pTab fields in the SrcList that
4320 **         defines FROM clause.  When views appear in the FROM clause,
4321 **         fill pTabList->a[].pSelect with a copy of the SELECT statement
4322 **         that implements the view.  A copy is made of the view's SELECT
4323 **         statement so that we can freely modify or delete that statement
4324 **         without worrying about messing up the persistent representation
4325 **         of the view.
4326 **
4327 **    (3)  Add terms to the WHERE clause to accommodate the NATURAL keyword
4328 **         on joins and the ON and USING clause of joins.
4329 **
4330 **    (4)  Scan the list of columns in the result set (pEList) looking
4331 **         for instances of the "*" operator or the TABLE.* operator.
4332 **         If found, expand each "*" to be every column in every table
4333 **         and TABLE.* to be every column in TABLE.
4334 **
4335 */
4336 static int selectExpander(Walker *pWalker, Select *p){
4337   Parse *pParse = pWalker->pParse;
4338   int i, j, k;
4339   SrcList *pTabList;
4340   ExprList *pEList;
4341   struct SrcList_item *pFrom;
4342   sqlite3 *db = pParse->db;
4343   Expr *pE, *pRight, *pExpr;
4344   u16 selFlags = p->selFlags;
4345 
4346   p->selFlags |= SF_Expanded;
4347   if( db->mallocFailed  ){
4348     return WRC_Abort;
4349   }
4350   if( NEVER(p->pSrc==0) || (selFlags & SF_Expanded)!=0 ){
4351     return WRC_Prune;
4352   }
4353   pTabList = p->pSrc;
4354   pEList = p->pEList;
4355   if( p->pWith ){
4356     sqlite3WithPush(pParse, p->pWith, 0);
4357   }
4358 
4359   /* Make sure cursor numbers have been assigned to all entries in
4360   ** the FROM clause of the SELECT statement.
4361   */
4362   sqlite3SrcListAssignCursors(pParse, pTabList);
4363 
4364   /* Look up every table named in the FROM clause of the select.  If
4365   ** an entry of the FROM clause is a subquery instead of a table or view,
4366   ** then create a transient table structure to describe the subquery.
4367   */
4368   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
4369     Table *pTab;
4370     assert( pFrom->fg.isRecursive==0 || pFrom->pTab!=0 );
4371     if( pFrom->fg.isRecursive ) continue;
4372     assert( pFrom->pTab==0 );
4373 #ifndef SQLITE_OMIT_CTE
4374     if( withExpand(pWalker, pFrom) ) return WRC_Abort;
4375     if( pFrom->pTab ) {} else
4376 #endif
4377     if( pFrom->zName==0 ){
4378 #ifndef SQLITE_OMIT_SUBQUERY
4379       Select *pSel = pFrom->pSelect;
4380       /* A sub-query in the FROM clause of a SELECT */
4381       assert( pSel!=0 );
4382       assert( pFrom->pTab==0 );
4383       if( sqlite3WalkSelect(pWalker, pSel) ) return WRC_Abort;
4384       pFrom->pTab = pTab = sqlite3DbMallocZero(db, sizeof(Table));
4385       if( pTab==0 ) return WRC_Abort;
4386       pTab->nTabRef = 1;
4387       pTab->zName = sqlite3MPrintf(db, "sqlite_sq_%p", (void*)pTab);
4388       while( pSel->pPrior ){ pSel = pSel->pPrior; }
4389       sqlite3ColumnsFromExprList(pParse, pSel->pEList,&pTab->nCol,&pTab->aCol);
4390       pTab->iPKey = -1;
4391       pTab->nRowLogEst = 200; assert( 200==sqlite3LogEst(1048576) );
4392       pTab->tabFlags |= TF_Ephemeral;
4393 #endif
4394     }else{
4395       /* An ordinary table or view name in the FROM clause */
4396       assert( pFrom->pTab==0 );
4397       pFrom->pTab = pTab = sqlite3LocateTableItem(pParse, 0, pFrom);
4398       if( pTab==0 ) return WRC_Abort;
4399       if( pTab->nTabRef>=0xffff ){
4400         sqlite3ErrorMsg(pParse, "too many references to \"%s\": max 65535",
4401            pTab->zName);
4402         pFrom->pTab = 0;
4403         return WRC_Abort;
4404       }
4405       pTab->nTabRef++;
4406       if( !IsVirtual(pTab) && cannotBeFunction(pParse, pFrom) ){
4407         return WRC_Abort;
4408       }
4409 #if !defined(SQLITE_OMIT_VIEW) || !defined (SQLITE_OMIT_VIRTUALTABLE)
4410       if( IsVirtual(pTab) || pTab->pSelect ){
4411         i16 nCol;
4412         if( sqlite3ViewGetColumnNames(pParse, pTab) ) return WRC_Abort;
4413         assert( pFrom->pSelect==0 );
4414         pFrom->pSelect = sqlite3SelectDup(db, pTab->pSelect, 0);
4415         sqlite3SelectSetName(pFrom->pSelect, pTab->zName);
4416         nCol = pTab->nCol;
4417         pTab->nCol = -1;
4418         sqlite3WalkSelect(pWalker, pFrom->pSelect);
4419         pTab->nCol = nCol;
4420       }
4421 #endif
4422     }
4423 
4424     /* Locate the index named by the INDEXED BY clause, if any. */
4425     if( sqlite3IndexedByLookup(pParse, pFrom) ){
4426       return WRC_Abort;
4427     }
4428   }
4429 
4430   /* Process NATURAL keywords, and ON and USING clauses of joins.
4431   */
4432   if( db->mallocFailed || sqliteProcessJoin(pParse, p) ){
4433     return WRC_Abort;
4434   }
4435 
4436   /* For every "*" that occurs in the column list, insert the names of
4437   ** all columns in all tables.  And for every TABLE.* insert the names
4438   ** of all columns in TABLE.  The parser inserted a special expression
4439   ** with the TK_ASTERISK operator for each "*" that it found in the column
4440   ** list.  The following code just has to locate the TK_ASTERISK
4441   ** expressions and expand each one to the list of all columns in
4442   ** all tables.
4443   **
4444   ** The first loop just checks to see if there are any "*" operators
4445   ** that need expanding.
4446   */
4447   for(k=0; k<pEList->nExpr; k++){
4448     pE = pEList->a[k].pExpr;
4449     if( pE->op==TK_ASTERISK ) break;
4450     assert( pE->op!=TK_DOT || pE->pRight!=0 );
4451     assert( pE->op!=TK_DOT || (pE->pLeft!=0 && pE->pLeft->op==TK_ID) );
4452     if( pE->op==TK_DOT && pE->pRight->op==TK_ASTERISK ) break;
4453   }
4454   if( k<pEList->nExpr ){
4455     /*
4456     ** If we get here it means the result set contains one or more "*"
4457     ** operators that need to be expanded.  Loop through each expression
4458     ** in the result set and expand them one by one.
4459     */
4460     struct ExprList_item *a = pEList->a;
4461     ExprList *pNew = 0;
4462     int flags = pParse->db->flags;
4463     int longNames = (flags & SQLITE_FullColNames)!=0
4464                       && (flags & SQLITE_ShortColNames)==0;
4465 
4466     for(k=0; k<pEList->nExpr; k++){
4467       pE = a[k].pExpr;
4468       pRight = pE->pRight;
4469       assert( pE->op!=TK_DOT || pRight!=0 );
4470       if( pE->op!=TK_ASTERISK
4471        && (pE->op!=TK_DOT || pRight->op!=TK_ASTERISK)
4472       ){
4473         /* This particular expression does not need to be expanded.
4474         */
4475         pNew = sqlite3ExprListAppend(pParse, pNew, a[k].pExpr);
4476         if( pNew ){
4477           pNew->a[pNew->nExpr-1].zName = a[k].zName;
4478           pNew->a[pNew->nExpr-1].zSpan = a[k].zSpan;
4479           a[k].zName = 0;
4480           a[k].zSpan = 0;
4481         }
4482         a[k].pExpr = 0;
4483       }else{
4484         /* This expression is a "*" or a "TABLE.*" and needs to be
4485         ** expanded. */
4486         int tableSeen = 0;      /* Set to 1 when TABLE matches */
4487         char *zTName = 0;       /* text of name of TABLE */
4488         if( pE->op==TK_DOT ){
4489           assert( pE->pLeft!=0 );
4490           assert( !ExprHasProperty(pE->pLeft, EP_IntValue) );
4491           zTName = pE->pLeft->u.zToken;
4492         }
4493         for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
4494           Table *pTab = pFrom->pTab;
4495           Select *pSub = pFrom->pSelect;
4496           char *zTabName = pFrom->zAlias;
4497           const char *zSchemaName = 0;
4498           int iDb;
4499           if( zTabName==0 ){
4500             zTabName = pTab->zName;
4501           }
4502           if( db->mallocFailed ) break;
4503           if( pSub==0 || (pSub->selFlags & SF_NestedFrom)==0 ){
4504             pSub = 0;
4505             if( zTName && sqlite3StrICmp(zTName, zTabName)!=0 ){
4506               continue;
4507             }
4508             iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
4509             zSchemaName = iDb>=0 ? db->aDb[iDb].zDbSName : "*";
4510           }
4511           for(j=0; j<pTab->nCol; j++){
4512             char *zName = pTab->aCol[j].zName;
4513             char *zColname;  /* The computed column name */
4514             char *zToFree;   /* Malloced string that needs to be freed */
4515             Token sColname;  /* Computed column name as a token */
4516 
4517             assert( zName );
4518             if( zTName && pSub
4519              && sqlite3MatchSpanName(pSub->pEList->a[j].zSpan, 0, zTName, 0)==0
4520             ){
4521               continue;
4522             }
4523 
4524             /* If a column is marked as 'hidden', omit it from the expanded
4525             ** result-set list unless the SELECT has the SF_IncludeHidden
4526             ** bit set.
4527             */
4528             if( (p->selFlags & SF_IncludeHidden)==0
4529              && IsHiddenColumn(&pTab->aCol[j])
4530             ){
4531               continue;
4532             }
4533             tableSeen = 1;
4534 
4535             if( i>0 && zTName==0 ){
4536               if( (pFrom->fg.jointype & JT_NATURAL)!=0
4537                 && tableAndColumnIndex(pTabList, i, zName, 0, 0)
4538               ){
4539                 /* In a NATURAL join, omit the join columns from the
4540                 ** table to the right of the join */
4541                 continue;
4542               }
4543               if( sqlite3IdListIndex(pFrom->pUsing, zName)>=0 ){
4544                 /* In a join with a USING clause, omit columns in the
4545                 ** using clause from the table on the right. */
4546                 continue;
4547               }
4548             }
4549             pRight = sqlite3Expr(db, TK_ID, zName);
4550             zColname = zName;
4551             zToFree = 0;
4552             if( longNames || pTabList->nSrc>1 ){
4553               Expr *pLeft;
4554               pLeft = sqlite3Expr(db, TK_ID, zTabName);
4555               pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pRight);
4556               if( zSchemaName ){
4557                 pLeft = sqlite3Expr(db, TK_ID, zSchemaName);
4558                 pExpr = sqlite3PExpr(pParse, TK_DOT, pLeft, pExpr);
4559               }
4560               if( longNames ){
4561                 zColname = sqlite3MPrintf(db, "%s.%s", zTabName, zName);
4562                 zToFree = zColname;
4563               }
4564             }else{
4565               pExpr = pRight;
4566             }
4567             pNew = sqlite3ExprListAppend(pParse, pNew, pExpr);
4568             sqlite3TokenInit(&sColname, zColname);
4569             sqlite3ExprListSetName(pParse, pNew, &sColname, 0);
4570             if( pNew && (p->selFlags & SF_NestedFrom)!=0 ){
4571               struct ExprList_item *pX = &pNew->a[pNew->nExpr-1];
4572               if( pSub ){
4573                 pX->zSpan = sqlite3DbStrDup(db, pSub->pEList->a[j].zSpan);
4574                 testcase( pX->zSpan==0 );
4575               }else{
4576                 pX->zSpan = sqlite3MPrintf(db, "%s.%s.%s",
4577                                            zSchemaName, zTabName, zColname);
4578                 testcase( pX->zSpan==0 );
4579               }
4580               pX->bSpanIsTab = 1;
4581             }
4582             sqlite3DbFree(db, zToFree);
4583           }
4584         }
4585         if( !tableSeen ){
4586           if( zTName ){
4587             sqlite3ErrorMsg(pParse, "no such table: %s", zTName);
4588           }else{
4589             sqlite3ErrorMsg(pParse, "no tables specified");
4590           }
4591         }
4592       }
4593     }
4594     sqlite3ExprListDelete(db, pEList);
4595     p->pEList = pNew;
4596   }
4597 #if SQLITE_MAX_COLUMN
4598   if( p->pEList && p->pEList->nExpr>db->aLimit[SQLITE_LIMIT_COLUMN] ){
4599     sqlite3ErrorMsg(pParse, "too many columns in result set");
4600     return WRC_Abort;
4601   }
4602 #endif
4603   return WRC_Continue;
4604 }
4605 
4606 /*
4607 ** No-op routine for the parse-tree walker.
4608 **
4609 ** When this routine is the Walker.xExprCallback then expression trees
4610 ** are walked without any actions being taken at each node.  Presumably,
4611 ** when this routine is used for Walker.xExprCallback then
4612 ** Walker.xSelectCallback is set to do something useful for every
4613 ** subquery in the parser tree.
4614 */
4615 int sqlite3ExprWalkNoop(Walker *NotUsed, Expr *NotUsed2){
4616   UNUSED_PARAMETER2(NotUsed, NotUsed2);
4617   return WRC_Continue;
4618 }
4619 
4620 /*
4621 ** No-op routine for the parse-tree walker for SELECT statements.
4622 ** subquery in the parser tree.
4623 */
4624 int sqlite3SelectWalkNoop(Walker *NotUsed, Select *NotUsed2){
4625   UNUSED_PARAMETER2(NotUsed, NotUsed2);
4626   return WRC_Continue;
4627 }
4628 
4629 #if SQLITE_DEBUG
4630 /*
4631 ** Always assert.  This xSelectCallback2 implementation proves that the
4632 ** xSelectCallback2 is never invoked.
4633 */
4634 void sqlite3SelectWalkAssert2(Walker *NotUsed, Select *NotUsed2){
4635   UNUSED_PARAMETER2(NotUsed, NotUsed2);
4636   assert( 0 );
4637 }
4638 #endif
4639 /*
4640 ** This routine "expands" a SELECT statement and all of its subqueries.
4641 ** For additional information on what it means to "expand" a SELECT
4642 ** statement, see the comment on the selectExpand worker callback above.
4643 **
4644 ** Expanding a SELECT statement is the first step in processing a
4645 ** SELECT statement.  The SELECT statement must be expanded before
4646 ** name resolution is performed.
4647 **
4648 ** If anything goes wrong, an error message is written into pParse.
4649 ** The calling function can detect the problem by looking at pParse->nErr
4650 ** and/or pParse->db->mallocFailed.
4651 */
4652 static void sqlite3SelectExpand(Parse *pParse, Select *pSelect){
4653   Walker w;
4654   w.xExprCallback = sqlite3ExprWalkNoop;
4655   w.pParse = pParse;
4656   if( pParse->hasCompound ){
4657     w.xSelectCallback = convertCompoundSelectToSubquery;
4658     w.xSelectCallback2 = 0;
4659     sqlite3WalkSelect(&w, pSelect);
4660   }
4661   w.xSelectCallback = selectExpander;
4662   w.xSelectCallback2 = selectPopWith;
4663   sqlite3WalkSelect(&w, pSelect);
4664 }
4665 
4666 
4667 #ifndef SQLITE_OMIT_SUBQUERY
4668 /*
4669 ** This is a Walker.xSelectCallback callback for the sqlite3SelectTypeInfo()
4670 ** interface.
4671 **
4672 ** For each FROM-clause subquery, add Column.zType and Column.zColl
4673 ** information to the Table structure that represents the result set
4674 ** of that subquery.
4675 **
4676 ** The Table structure that represents the result set was constructed
4677 ** by selectExpander() but the type and collation information was omitted
4678 ** at that point because identifiers had not yet been resolved.  This
4679 ** routine is called after identifier resolution.
4680 */
4681 static void selectAddSubqueryTypeInfo(Walker *pWalker, Select *p){
4682   Parse *pParse;
4683   int i;
4684   SrcList *pTabList;
4685   struct SrcList_item *pFrom;
4686 
4687   assert( p->selFlags & SF_Resolved );
4688   assert( (p->selFlags & SF_HasTypeInfo)==0 );
4689   p->selFlags |= SF_HasTypeInfo;
4690   pParse = pWalker->pParse;
4691   pTabList = p->pSrc;
4692   for(i=0, pFrom=pTabList->a; i<pTabList->nSrc; i++, pFrom++){
4693     Table *pTab = pFrom->pTab;
4694     assert( pTab!=0 );
4695     if( (pTab->tabFlags & TF_Ephemeral)!=0 ){
4696       /* A sub-query in the FROM clause of a SELECT */
4697       Select *pSel = pFrom->pSelect;
4698       if( pSel ){
4699         while( pSel->pPrior ) pSel = pSel->pPrior;
4700         sqlite3SelectAddColumnTypeAndCollation(pParse, pTab, pSel);
4701       }
4702     }
4703   }
4704 }
4705 #endif
4706 
4707 
4708 /*
4709 ** This routine adds datatype and collating sequence information to
4710 ** the Table structures of all FROM-clause subqueries in a
4711 ** SELECT statement.
4712 **
4713 ** Use this routine after name resolution.
4714 */
4715 static void sqlite3SelectAddTypeInfo(Parse *pParse, Select *pSelect){
4716 #ifndef SQLITE_OMIT_SUBQUERY
4717   Walker w;
4718   w.xSelectCallback = sqlite3SelectWalkNoop;
4719   w.xSelectCallback2 = selectAddSubqueryTypeInfo;
4720   w.xExprCallback = sqlite3ExprWalkNoop;
4721   w.pParse = pParse;
4722   sqlite3WalkSelect(&w, pSelect);
4723 #endif
4724 }
4725 
4726 
4727 /*
4728 ** This routine sets up a SELECT statement for processing.  The
4729 ** following is accomplished:
4730 **
4731 **     *  VDBE Cursor numbers are assigned to all FROM-clause terms.
4732 **     *  Ephemeral Table objects are created for all FROM-clause subqueries.
4733 **     *  ON and USING clauses are shifted into WHERE statements
4734 **     *  Wildcards "*" and "TABLE.*" in result sets are expanded.
4735 **     *  Identifiers in expression are matched to tables.
4736 **
4737 ** This routine acts recursively on all subqueries within the SELECT.
4738 */
4739 void sqlite3SelectPrep(
4740   Parse *pParse,         /* The parser context */
4741   Select *p,             /* The SELECT statement being coded. */
4742   NameContext *pOuterNC  /* Name context for container */
4743 ){
4744   sqlite3 *db;
4745   if( NEVER(p==0) ) return;
4746   db = pParse->db;
4747   if( db->mallocFailed ) return;
4748   if( p->selFlags & SF_HasTypeInfo ) return;
4749   sqlite3SelectExpand(pParse, p);
4750   if( pParse->nErr || db->mallocFailed ) return;
4751   sqlite3ResolveSelectNames(pParse, p, pOuterNC);
4752   if( pParse->nErr || db->mallocFailed ) return;
4753   sqlite3SelectAddTypeInfo(pParse, p);
4754 }
4755 
4756 /*
4757 ** Reset the aggregate accumulator.
4758 **
4759 ** The aggregate accumulator is a set of memory cells that hold
4760 ** intermediate results while calculating an aggregate.  This
4761 ** routine generates code that stores NULLs in all of those memory
4762 ** cells.
4763 */
4764 static void resetAccumulator(Parse *pParse, AggInfo *pAggInfo){
4765   Vdbe *v = pParse->pVdbe;
4766   int i;
4767   struct AggInfo_func *pFunc;
4768   int nReg = pAggInfo->nFunc + pAggInfo->nColumn;
4769   if( nReg==0 ) return;
4770 #ifdef SQLITE_DEBUG
4771   /* Verify that all AggInfo registers are within the range specified by
4772   ** AggInfo.mnReg..AggInfo.mxReg */
4773   assert( nReg==pAggInfo->mxReg-pAggInfo->mnReg+1 );
4774   for(i=0; i<pAggInfo->nColumn; i++){
4775     assert( pAggInfo->aCol[i].iMem>=pAggInfo->mnReg
4776          && pAggInfo->aCol[i].iMem<=pAggInfo->mxReg );
4777   }
4778   for(i=0; i<pAggInfo->nFunc; i++){
4779     assert( pAggInfo->aFunc[i].iMem>=pAggInfo->mnReg
4780          && pAggInfo->aFunc[i].iMem<=pAggInfo->mxReg );
4781   }
4782 #endif
4783   sqlite3VdbeAddOp3(v, OP_Null, 0, pAggInfo->mnReg, pAggInfo->mxReg);
4784   for(pFunc=pAggInfo->aFunc, i=0; i<pAggInfo->nFunc; i++, pFunc++){
4785     if( pFunc->iDistinct>=0 ){
4786       Expr *pE = pFunc->pExpr;
4787       assert( !ExprHasProperty(pE, EP_xIsSelect) );
4788       if( pE->x.pList==0 || pE->x.pList->nExpr!=1 ){
4789         sqlite3ErrorMsg(pParse, "DISTINCT aggregates must have exactly one "
4790            "argument");
4791         pFunc->iDistinct = -1;
4792       }else{
4793         KeyInfo *pKeyInfo = keyInfoFromExprList(pParse, pE->x.pList, 0, 0);
4794         sqlite3VdbeAddOp4(v, OP_OpenEphemeral, pFunc->iDistinct, 0, 0,
4795                           (char*)pKeyInfo, P4_KEYINFO);
4796       }
4797     }
4798   }
4799 }
4800 
4801 /*
4802 ** Invoke the OP_AggFinalize opcode for every aggregate function
4803 ** in the AggInfo structure.
4804 */
4805 static void finalizeAggFunctions(Parse *pParse, AggInfo *pAggInfo){
4806   Vdbe *v = pParse->pVdbe;
4807   int i;
4808   struct AggInfo_func *pF;
4809   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
4810     ExprList *pList = pF->pExpr->x.pList;
4811     assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
4812     sqlite3VdbeAddOp2(v, OP_AggFinal, pF->iMem, pList ? pList->nExpr : 0);
4813     sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
4814   }
4815 }
4816 
4817 /*
4818 ** Update the accumulator memory cells for an aggregate based on
4819 ** the current cursor position.
4820 */
4821 static void updateAccumulator(Parse *pParse, AggInfo *pAggInfo){
4822   Vdbe *v = pParse->pVdbe;
4823   int i;
4824   int regHit = 0;
4825   int addrHitTest = 0;
4826   struct AggInfo_func *pF;
4827   struct AggInfo_col *pC;
4828 
4829   pAggInfo->directMode = 1;
4830   for(i=0, pF=pAggInfo->aFunc; i<pAggInfo->nFunc; i++, pF++){
4831     int nArg;
4832     int addrNext = 0;
4833     int regAgg;
4834     ExprList *pList = pF->pExpr->x.pList;
4835     assert( !ExprHasProperty(pF->pExpr, EP_xIsSelect) );
4836     if( pList ){
4837       nArg = pList->nExpr;
4838       regAgg = sqlite3GetTempRange(pParse, nArg);
4839       sqlite3ExprCodeExprList(pParse, pList, regAgg, 0, SQLITE_ECEL_DUP);
4840     }else{
4841       nArg = 0;
4842       regAgg = 0;
4843     }
4844     if( pF->iDistinct>=0 ){
4845       addrNext = sqlite3VdbeMakeLabel(v);
4846       testcase( nArg==0 );  /* Error condition */
4847       testcase( nArg>1 );   /* Also an error */
4848       codeDistinct(pParse, pF->iDistinct, addrNext, 1, regAgg);
4849     }
4850     if( pF->pFunc->funcFlags & SQLITE_FUNC_NEEDCOLL ){
4851       CollSeq *pColl = 0;
4852       struct ExprList_item *pItem;
4853       int j;
4854       assert( pList!=0 );  /* pList!=0 if pF->pFunc has NEEDCOLL */
4855       for(j=0, pItem=pList->a; !pColl && j<nArg; j++, pItem++){
4856         pColl = sqlite3ExprCollSeq(pParse, pItem->pExpr);
4857       }
4858       if( !pColl ){
4859         pColl = pParse->db->pDfltColl;
4860       }
4861       if( regHit==0 && pAggInfo->nAccumulator ) regHit = ++pParse->nMem;
4862       sqlite3VdbeAddOp4(v, OP_CollSeq, regHit, 0, 0, (char *)pColl, P4_COLLSEQ);
4863     }
4864     sqlite3VdbeAddOp3(v, OP_AggStep0, 0, regAgg, pF->iMem);
4865     sqlite3VdbeAppendP4(v, pF->pFunc, P4_FUNCDEF);
4866     sqlite3VdbeChangeP5(v, (u8)nArg);
4867     sqlite3ExprCacheAffinityChange(pParse, regAgg, nArg);
4868     sqlite3ReleaseTempRange(pParse, regAgg, nArg);
4869     if( addrNext ){
4870       sqlite3VdbeResolveLabel(v, addrNext);
4871       sqlite3ExprCacheClear(pParse);
4872     }
4873   }
4874 
4875   /* Before populating the accumulator registers, clear the column cache.
4876   ** Otherwise, if any of the required column values are already present
4877   ** in registers, sqlite3ExprCode() may use OP_SCopy to copy the value
4878   ** to pC->iMem. But by the time the value is used, the original register
4879   ** may have been used, invalidating the underlying buffer holding the
4880   ** text or blob value. See ticket [883034dcb5].
4881   **
4882   ** Another solution would be to change the OP_SCopy used to copy cached
4883   ** values to an OP_Copy.
4884   */
4885   if( regHit ){
4886     addrHitTest = sqlite3VdbeAddOp1(v, OP_If, regHit); VdbeCoverage(v);
4887   }
4888   sqlite3ExprCacheClear(pParse);
4889   for(i=0, pC=pAggInfo->aCol; i<pAggInfo->nAccumulator; i++, pC++){
4890     sqlite3ExprCode(pParse, pC->pExpr, pC->iMem);
4891   }
4892   pAggInfo->directMode = 0;
4893   sqlite3ExprCacheClear(pParse);
4894   if( addrHitTest ){
4895     sqlite3VdbeJumpHere(v, addrHitTest);
4896   }
4897 }
4898 
4899 /*
4900 ** Add a single OP_Explain instruction to the VDBE to explain a simple
4901 ** count(*) query ("SELECT count(*) FROM pTab").
4902 */
4903 #ifndef SQLITE_OMIT_EXPLAIN
4904 static void explainSimpleCount(
4905   Parse *pParse,                  /* Parse context */
4906   Table *pTab,                    /* Table being queried */
4907   Index *pIdx                     /* Index used to optimize scan, or NULL */
4908 ){
4909   if( pParse->explain==2 ){
4910     int bCover = (pIdx!=0 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pIdx)));
4911     char *zEqp = sqlite3MPrintf(pParse->db, "SCAN TABLE %s%s%s",
4912         pTab->zName,
4913         bCover ? " USING COVERING INDEX " : "",
4914         bCover ? pIdx->zName : ""
4915     );
4916     sqlite3VdbeAddOp4(
4917         pParse->pVdbe, OP_Explain, pParse->iSelectId, 0, 0, zEqp, P4_DYNAMIC
4918     );
4919   }
4920 }
4921 #else
4922 # define explainSimpleCount(a,b,c)
4923 #endif
4924 
4925 /*
4926 ** Context object for havingToWhereExprCb().
4927 */
4928 struct HavingToWhereCtx {
4929   Expr **ppWhere;
4930   ExprList *pGroupBy;
4931 };
4932 
4933 /*
4934 ** sqlite3WalkExpr() callback used by havingToWhere().
4935 **
4936 ** If the node passed to the callback is a TK_AND node, return
4937 ** WRC_Continue to tell sqlite3WalkExpr() to iterate through child nodes.
4938 **
4939 ** Otherwise, return WRC_Prune. In this case, also check if the
4940 ** sub-expression matches the criteria for being moved to the WHERE
4941 ** clause. If so, add it to the WHERE clause and replace the sub-expression
4942 ** within the HAVING expression with a constant "1".
4943 */
4944 static int havingToWhereExprCb(Walker *pWalker, Expr *pExpr){
4945   if( pExpr->op!=TK_AND ){
4946     struct HavingToWhereCtx *p = pWalker->u.pHavingCtx;
4947     if( sqlite3ExprIsConstantOrGroupBy(pWalker->pParse, pExpr, p->pGroupBy) ){
4948       sqlite3 *db = pWalker->pParse->db;
4949       Expr *pNew = sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[1], 0);
4950       if( pNew ){
4951         Expr *pWhere = *(p->ppWhere);
4952         SWAP(Expr, *pNew, *pExpr);
4953         pNew = sqlite3ExprAnd(db, pWhere, pNew);
4954         *(p->ppWhere) = pNew;
4955       }
4956     }
4957     return WRC_Prune;
4958   }
4959   return WRC_Continue;
4960 }
4961 
4962 /*
4963 ** Transfer eligible terms from the HAVING clause of a query, which is
4964 ** processed after grouping, to the WHERE clause, which is processed before
4965 ** grouping. For example, the query:
4966 **
4967 **   SELECT * FROM <tables> WHERE a=? GROUP BY b HAVING b=? AND c=?
4968 **
4969 ** can be rewritten as:
4970 **
4971 **   SELECT * FROM <tables> WHERE a=? AND b=? GROUP BY b HAVING c=?
4972 **
4973 ** A term of the HAVING expression is eligible for transfer if it consists
4974 ** entirely of constants and expressions that are also GROUP BY terms that
4975 ** use the "BINARY" collation sequence.
4976 */
4977 static void havingToWhere(
4978   Parse *pParse,
4979   ExprList *pGroupBy,
4980   Expr *pHaving,
4981   Expr **ppWhere
4982 ){
4983   struct HavingToWhereCtx sCtx;
4984   Walker sWalker;
4985 
4986   sCtx.ppWhere = ppWhere;
4987   sCtx.pGroupBy = pGroupBy;
4988 
4989   memset(&sWalker, 0, sizeof(sWalker));
4990   sWalker.pParse = pParse;
4991   sWalker.xExprCallback = havingToWhereExprCb;
4992   sWalker.u.pHavingCtx = &sCtx;
4993   sqlite3WalkExpr(&sWalker, pHaving);
4994 }
4995 
4996 /*
4997 ** Check to see if the pThis entry of pTabList is a self-join of a prior view.
4998 ** If it is, then return the SrcList_item for the prior view.  If it is not,
4999 ** then return 0.
5000 */
5001 static struct SrcList_item *isSelfJoinView(
5002   SrcList *pTabList,           /* Search for self-joins in this FROM clause */
5003   struct SrcList_item *pThis   /* Search for prior reference to this subquery */
5004 ){
5005   struct SrcList_item *pItem;
5006   for(pItem = pTabList->a; pItem<pThis; pItem++){
5007     if( pItem->pSelect==0 ) continue;
5008     if( pItem->fg.viaCoroutine ) continue;
5009     if( pItem->zName==0 ) continue;
5010     if( sqlite3_stricmp(pItem->zDatabase, pThis->zDatabase)!=0 ) continue;
5011     if( sqlite3_stricmp(pItem->zName, pThis->zName)!=0 ) continue;
5012     if( sqlite3ExprCompare(0,
5013           pThis->pSelect->pWhere, pItem->pSelect->pWhere, -1)
5014     ){
5015       /* The view was modified by some other optimization such as
5016       ** pushDownWhereTerms() */
5017       continue;
5018     }
5019     return pItem;
5020   }
5021   return 0;
5022 }
5023 
5024 #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
5025 /*
5026 ** Attempt to transform a query of the form
5027 **
5028 **    SELECT count(*) FROM (SELECT x FROM t1 UNION ALL SELECT y FROM t2)
5029 **
5030 ** Into this:
5031 **
5032 **    SELECT (SELECT count(*) FROM t1)+(SELECT count(*) FROM t2)
5033 **
5034 ** The transformation only works if all of the following are true:
5035 **
5036 **   *  The subquery is a UNION ALL of two or more terms
5037 **   *  There is no WHERE or GROUP BY or HAVING clauses on the subqueries
5038 **   *  The outer query is a simple count(*)
5039 **
5040 ** Return TRUE if the optimization is undertaken.
5041 */
5042 static int countOfViewOptimization(Parse *pParse, Select *p){
5043   Select *pSub, *pPrior;
5044   Expr *pExpr;
5045   Expr *pCount;
5046   sqlite3 *db;
5047   if( (p->selFlags & SF_Aggregate)==0 ) return 0;   /* This is an aggregate query */
5048   if( p->pEList->nExpr!=1 ) return 0;               /* Single result column */
5049   pExpr = p->pEList->a[0].pExpr;
5050   if( pExpr->op!=TK_AGG_FUNCTION ) return 0;        /* Result is an aggregate */
5051   if( sqlite3_stricmp(pExpr->u.zToken,"count") ) return 0;  /* Must be count() */
5052   if( pExpr->x.pList!=0 ) return 0;                 /* Must be count(*) */
5053   if( p->pSrc->nSrc!=1 ) return 0;                  /* One table in the FROM clause */
5054   pSub = p->pSrc->a[0].pSelect;
5055   if( pSub==0 ) return 0;                           /* The FROM is a subquery */
5056   if( pSub->pPrior==0 ) return 0;                   /* Must be a compound subquery */
5057   do{
5058     if( pSub->op!=TK_ALL && pSub->pPrior ) return 0;  /* Must be UNION ALL */
5059     if( pSub->pWhere ) return 0;                      /* No WHERE clause */
5060     if( pSub->selFlags & SF_Aggregate ) return 0;     /* Not an aggregate */
5061     pSub = pSub->pPrior;                              /* Repeat over compound terms */
5062   }while( pSub );
5063 
5064   /* If we reach this point, that means it is OK to perform the transformation */
5065 
5066   db = pParse->db;
5067   pCount = pExpr;
5068   pExpr = 0;
5069   pSub = p->pSrc->a[0].pSelect;
5070   p->pSrc->a[0].pSelect = 0;
5071   sqlite3SrcListDelete(db, p->pSrc);
5072   p->pSrc = sqlite3DbMallocZero(pParse->db, sizeof(*p->pSrc));
5073   while( pSub ){
5074     Expr *pTerm;
5075     pPrior = pSub->pPrior;
5076     pSub->pPrior = 0;
5077     pSub->pNext = 0;
5078     pSub->selFlags |= SF_Aggregate;
5079     pSub->selFlags &= ~SF_Compound;
5080     pSub->nSelectRow = 0;
5081     sqlite3ExprListDelete(db, pSub->pEList);
5082     pTerm = pPrior ? sqlite3ExprDup(db, pCount, 0) : pCount;
5083     pSub->pEList = sqlite3ExprListAppend(pParse, 0, pTerm);
5084     pTerm = sqlite3PExpr(pParse, TK_SELECT, 0, 0);
5085     sqlite3PExprAddSelect(pParse, pTerm, pSub);
5086     if( pExpr==0 ){
5087       pExpr = pTerm;
5088     }else{
5089       pExpr = sqlite3PExpr(pParse, TK_PLUS, pTerm, pExpr);
5090     }
5091     pSub = pPrior;
5092   }
5093   p->pEList->a[0].pExpr = pExpr;
5094   p->selFlags &= ~SF_Aggregate;
5095 
5096 #if SELECTTRACE_ENABLED
5097   if( sqlite3SelectTrace & 0x400 ){
5098     SELECTTRACE(0x400,pParse,p,("After count-of-view optimization:\n"));
5099     sqlite3TreeViewSelect(0, p, 0);
5100   }
5101 #endif
5102   return 1;
5103 }
5104 #endif /* SQLITE_COUNTOFVIEW_OPTIMIZATION */
5105 
5106 /*
5107 ** Generate code for the SELECT statement given in the p argument.
5108 **
5109 ** The results are returned according to the SelectDest structure.
5110 ** See comments in sqliteInt.h for further information.
5111 **
5112 ** This routine returns the number of errors.  If any errors are
5113 ** encountered, then an appropriate error message is left in
5114 ** pParse->zErrMsg.
5115 **
5116 ** This routine does NOT free the Select structure passed in.  The
5117 ** calling function needs to do that.
5118 */
5119 int sqlite3Select(
5120   Parse *pParse,         /* The parser context */
5121   Select *p,             /* The SELECT statement being coded. */
5122   SelectDest *pDest      /* What to do with the query results */
5123 ){
5124   int i, j;              /* Loop counters */
5125   WhereInfo *pWInfo;     /* Return from sqlite3WhereBegin() */
5126   Vdbe *v;               /* The virtual machine under construction */
5127   int isAgg;             /* True for select lists like "count(*)" */
5128   ExprList *pEList = 0;  /* List of columns to extract. */
5129   SrcList *pTabList;     /* List of tables to select from */
5130   Expr *pWhere;          /* The WHERE clause.  May be NULL */
5131   ExprList *pGroupBy;    /* The GROUP BY clause.  May be NULL */
5132   Expr *pHaving;         /* The HAVING clause.  May be NULL */
5133   int rc = 1;            /* Value to return from this function */
5134   DistinctCtx sDistinct; /* Info on how to code the DISTINCT keyword */
5135   SortCtx sSort;         /* Info on how to code the ORDER BY clause */
5136   AggInfo sAggInfo;      /* Information used by aggregate queries */
5137   int iEnd;              /* Address of the end of the query */
5138   sqlite3 *db;           /* The database connection */
5139 
5140 #ifndef SQLITE_OMIT_EXPLAIN
5141   int iRestoreSelectId = pParse->iSelectId;
5142   pParse->iSelectId = pParse->iNextSelectId++;
5143 #endif
5144 
5145   db = pParse->db;
5146   if( p==0 || db->mallocFailed || pParse->nErr ){
5147     return 1;
5148   }
5149   if( sqlite3AuthCheck(pParse, SQLITE_SELECT, 0, 0, 0) ) return 1;
5150   memset(&sAggInfo, 0, sizeof(sAggInfo));
5151 #if SELECTTRACE_ENABLED
5152   pParse->nSelectIndent++;
5153   SELECTTRACE(1,pParse,p, ("begin processing:\n"));
5154   if( sqlite3SelectTrace & 0x100 ){
5155     sqlite3TreeViewSelect(0, p, 0);
5156   }
5157 #endif
5158 
5159   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistFifo );
5160   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Fifo );
5161   assert( p->pOrderBy==0 || pDest->eDest!=SRT_DistQueue );
5162   assert( p->pOrderBy==0 || pDest->eDest!=SRT_Queue );
5163   if( IgnorableOrderby(pDest) ){
5164     assert(pDest->eDest==SRT_Exists || pDest->eDest==SRT_Union ||
5165            pDest->eDest==SRT_Except || pDest->eDest==SRT_Discard ||
5166            pDest->eDest==SRT_Queue  || pDest->eDest==SRT_DistFifo ||
5167            pDest->eDest==SRT_DistQueue || pDest->eDest==SRT_Fifo);
5168     /* If ORDER BY makes no difference in the output then neither does
5169     ** DISTINCT so it can be removed too. */
5170     sqlite3ExprListDelete(db, p->pOrderBy);
5171     p->pOrderBy = 0;
5172     p->selFlags &= ~SF_Distinct;
5173   }
5174   sqlite3SelectPrep(pParse, p, 0);
5175   memset(&sSort, 0, sizeof(sSort));
5176   sSort.pOrderBy = p->pOrderBy;
5177   pTabList = p->pSrc;
5178   if( pParse->nErr || db->mallocFailed ){
5179     goto select_end;
5180   }
5181   assert( p->pEList!=0 );
5182   isAgg = (p->selFlags & SF_Aggregate)!=0;
5183 #if SELECTTRACE_ENABLED
5184   if( sqlite3SelectTrace & 0x100 ){
5185     SELECTTRACE(0x100,pParse,p, ("after name resolution:\n"));
5186     sqlite3TreeViewSelect(0, p, 0);
5187   }
5188 #endif
5189 
5190   /* Try to flatten subqueries in the FROM clause up into the main query
5191   */
5192 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
5193   for(i=0; !p->pPrior && i<pTabList->nSrc; i++){
5194     struct SrcList_item *pItem = &pTabList->a[i];
5195     Select *pSub = pItem->pSelect;
5196     int isAggSub;
5197     Table *pTab = pItem->pTab;
5198     if( pSub==0 ) continue;
5199 
5200     /* Catch mismatch in the declared columns of a view and the number of
5201     ** columns in the SELECT on the RHS */
5202     if( pTab->nCol!=pSub->pEList->nExpr ){
5203       sqlite3ErrorMsg(pParse, "expected %d columns for '%s' but got %d",
5204                       pTab->nCol, pTab->zName, pSub->pEList->nExpr);
5205       goto select_end;
5206     }
5207 
5208     isAggSub = (pSub->selFlags & SF_Aggregate)!=0;
5209     if( flattenSubquery(pParse, p, i, isAgg, isAggSub) ){
5210       /* This subquery can be absorbed into its parent. */
5211       if( isAggSub ){
5212         isAgg = 1;
5213         p->selFlags |= SF_Aggregate;
5214       }
5215       i = -1;
5216     }
5217     pTabList = p->pSrc;
5218     if( db->mallocFailed ) goto select_end;
5219     if( !IgnorableOrderby(pDest) ){
5220       sSort.pOrderBy = p->pOrderBy;
5221     }
5222   }
5223 #endif
5224 
5225   /* Get a pointer the VDBE under construction, allocating a new VDBE if one
5226   ** does not already exist */
5227   v = sqlite3GetVdbe(pParse);
5228   if( v==0 ) goto select_end;
5229 
5230 #ifndef SQLITE_OMIT_COMPOUND_SELECT
5231   /* Handle compound SELECT statements using the separate multiSelect()
5232   ** procedure.
5233   */
5234   if( p->pPrior ){
5235     rc = multiSelect(pParse, p, pDest);
5236     explainSetInteger(pParse->iSelectId, iRestoreSelectId);
5237 #if SELECTTRACE_ENABLED
5238     SELECTTRACE(1,pParse,p,("end compound-select processing\n"));
5239     pParse->nSelectIndent--;
5240 #endif
5241     return rc;
5242   }
5243 #endif
5244 
5245   /* For each term in the FROM clause, do two things:
5246   ** (1) Authorized unreferenced tables
5247   ** (2) Generate code for all sub-queries
5248   */
5249   for(i=0; i<pTabList->nSrc; i++){
5250     struct SrcList_item *pItem = &pTabList->a[i];
5251     SelectDest dest;
5252     Select *pSub;
5253 
5254     /* Issue SQLITE_READ authorizations with a fake column name for any tables that
5255     ** are referenced but from which no values are extracted. Examples of where these
5256     ** kinds of null SQLITE_READ authorizations would occur:
5257     **
5258     **     SELECT count(*) FROM t1;   -- SQLITE_READ t1.""
5259     **     SELECT t1.* FROM t1, t2;   -- SQLITE_READ t2.""
5260     **
5261     ** The fake column name is an empty string.  It is possible for a table to
5262     ** have a column named by the empty string, in which case there is no way to
5263     ** distinguish between an unreferenced table and an actual reference to the
5264     ** "" column.  The original design was for the fake column name to be a NULL,
5265     ** which would be unambiguous.  But legacy authorization callbacks might
5266     ** assume the column name is non-NULL and segfault.  The use of an empty string
5267     ** for the fake column name seems safer.
5268     */
5269     if( pItem->colUsed==0 ){
5270       sqlite3AuthCheck(pParse, SQLITE_READ, pItem->zName, "", pItem->zDatabase);
5271     }
5272 
5273 #if !defined(SQLITE_OMIT_SUBQUERY) || !defined(SQLITE_OMIT_VIEW)
5274     /* Generate code for all sub-queries in the FROM clause
5275     */
5276     pSub = pItem->pSelect;
5277     if( pSub==0 ) continue;
5278 
5279     /* Sometimes the code for a subquery will be generated more than
5280     ** once, if the subquery is part of the WHERE clause in a LEFT JOIN,
5281     ** for example.  In that case, do not regenerate the code to manifest
5282     ** a view or the co-routine to implement a view.  The first instance
5283     ** is sufficient, though the subroutine to manifest the view does need
5284     ** to be invoked again. */
5285     if( pItem->addrFillSub ){
5286       if( pItem->fg.viaCoroutine==0 ){
5287         /* The subroutine that manifests the view might be a one-time routine,
5288         ** or it might need to be rerun on each iteration because it
5289         ** encodes a correlated subquery. */
5290         testcase( sqlite3VdbeGetOp(v, pItem->addrFillSub)->opcode==OP_Once );
5291         sqlite3VdbeAddOp2(v, OP_Gosub, pItem->regReturn, pItem->addrFillSub);
5292       }
5293       continue;
5294     }
5295 
5296     /* Increment Parse.nHeight by the height of the largest expression
5297     ** tree referred to by this, the parent select. The child select
5298     ** may contain expression trees of at most
5299     ** (SQLITE_MAX_EXPR_DEPTH-Parse.nHeight) height. This is a bit
5300     ** more conservative than necessary, but much easier than enforcing
5301     ** an exact limit.
5302     */
5303     pParse->nHeight += sqlite3SelectExprHeight(p);
5304 
5305     /* Make copies of constant WHERE-clause terms in the outer query down
5306     ** inside the subquery.  This can help the subquery to run more efficiently.
5307     */
5308     if( (pItem->fg.jointype & JT_OUTER)==0
5309      && pushDownWhereTerms(pParse, pSub, p->pWhere, pItem->iCursor)
5310     ){
5311 #if SELECTTRACE_ENABLED
5312       if( sqlite3SelectTrace & 0x100 ){
5313         SELECTTRACE(0x100,pParse,p,("After WHERE-clause push-down:\n"));
5314         sqlite3TreeViewSelect(0, p, 0);
5315       }
5316 #endif
5317     }
5318 
5319     /* Generate code to implement the subquery
5320     **
5321     ** The subquery is implemented as a co-routine if all of these are true:
5322     **   (1)  The subquery is guaranteed to be the outer loop (so that it
5323     **        does not need to be computed more than once)
5324     **   (2)  The ALL keyword after SELECT is omitted.  (Applications are
5325     **        allowed to say "SELECT ALL" instead of just "SELECT" to disable
5326     **        the use of co-routines.)
5327     **   (3)  Co-routines are not disabled using sqlite3_test_control()
5328     **        with SQLITE_TESTCTRL_OPTIMIZATIONS.
5329     **
5330     ** TODO: Are there other reasons beside (1) to use a co-routine
5331     ** implementation?
5332     */
5333     if( i==0
5334      && (pTabList->nSrc==1
5335             || (pTabList->a[1].fg.jointype&(JT_LEFT|JT_CROSS))!=0)  /* (1) */
5336      && (p->selFlags & SF_All)==0                                   /* (2) */
5337      && OptimizationEnabled(db, SQLITE_SubqCoroutine)               /* (3) */
5338     ){
5339       /* Implement a co-routine that will return a single row of the result
5340       ** set on each invocation.
5341       */
5342       int addrTop = sqlite3VdbeCurrentAddr(v)+1;
5343       pItem->regReturn = ++pParse->nMem;
5344       sqlite3VdbeAddOp3(v, OP_InitCoroutine, pItem->regReturn, 0, addrTop);
5345       VdbeComment((v, "%s", pItem->pTab->zName));
5346       pItem->addrFillSub = addrTop;
5347       sqlite3SelectDestInit(&dest, SRT_Coroutine, pItem->regReturn);
5348       explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
5349       sqlite3Select(pParse, pSub, &dest);
5350       pItem->pTab->nRowLogEst = pSub->nSelectRow;
5351       pItem->fg.viaCoroutine = 1;
5352       pItem->regResult = dest.iSdst;
5353       sqlite3VdbeEndCoroutine(v, pItem->regReturn);
5354       sqlite3VdbeJumpHere(v, addrTop-1);
5355       sqlite3ClearTempRegCache(pParse);
5356     }else{
5357       /* Generate a subroutine that will fill an ephemeral table with
5358       ** the content of this subquery.  pItem->addrFillSub will point
5359       ** to the address of the generated subroutine.  pItem->regReturn
5360       ** is a register allocated to hold the subroutine return address
5361       */
5362       int topAddr;
5363       int onceAddr = 0;
5364       int retAddr;
5365       struct SrcList_item *pPrior;
5366 
5367       assert( pItem->addrFillSub==0 );
5368       pItem->regReturn = ++pParse->nMem;
5369       topAddr = sqlite3VdbeAddOp2(v, OP_Integer, 0, pItem->regReturn);
5370       pItem->addrFillSub = topAddr+1;
5371       if( pItem->fg.isCorrelated==0 ){
5372         /* If the subquery is not correlated and if we are not inside of
5373         ** a trigger, then we only need to compute the value of the subquery
5374         ** once. */
5375         onceAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
5376         VdbeComment((v, "materialize \"%s\"", pItem->pTab->zName));
5377       }else{
5378         VdbeNoopComment((v, "materialize \"%s\"", pItem->pTab->zName));
5379       }
5380       pPrior = isSelfJoinView(pTabList, pItem);
5381       if( pPrior ){
5382         sqlite3VdbeAddOp2(v, OP_OpenDup, pItem->iCursor, pPrior->iCursor);
5383         explainSetInteger(pItem->iSelectId, pPrior->iSelectId);
5384         assert( pPrior->pSelect!=0 );
5385         pSub->nSelectRow = pPrior->pSelect->nSelectRow;
5386       }else{
5387         sqlite3SelectDestInit(&dest, SRT_EphemTab, pItem->iCursor);
5388         explainSetInteger(pItem->iSelectId, (u8)pParse->iNextSelectId);
5389         sqlite3Select(pParse, pSub, &dest);
5390       }
5391       pItem->pTab->nRowLogEst = pSub->nSelectRow;
5392       if( onceAddr ) sqlite3VdbeJumpHere(v, onceAddr);
5393       retAddr = sqlite3VdbeAddOp1(v, OP_Return, pItem->regReturn);
5394       VdbeComment((v, "end %s", pItem->pTab->zName));
5395       sqlite3VdbeChangeP1(v, topAddr, retAddr);
5396       sqlite3ClearTempRegCache(pParse);
5397     }
5398     if( db->mallocFailed ) goto select_end;
5399     pParse->nHeight -= sqlite3SelectExprHeight(p);
5400 #endif
5401   }
5402 
5403   /* Various elements of the SELECT copied into local variables for
5404   ** convenience */
5405   pEList = p->pEList;
5406   pWhere = p->pWhere;
5407   pGroupBy = p->pGroupBy;
5408   pHaving = p->pHaving;
5409   sDistinct.isTnct = (p->selFlags & SF_Distinct)!=0;
5410 
5411 #if SELECTTRACE_ENABLED
5412   if( sqlite3SelectTrace & 0x400 ){
5413     SELECTTRACE(0x400,pParse,p,("After all FROM-clause analysis:\n"));
5414     sqlite3TreeViewSelect(0, p, 0);
5415   }
5416 #endif
5417 
5418 #ifdef SQLITE_COUNTOFVIEW_OPTIMIZATION
5419   if( OptimizationEnabled(db, SQLITE_QueryFlattener|SQLITE_CountOfView)
5420    && countOfViewOptimization(pParse, p)
5421   ){
5422     if( db->mallocFailed ) goto select_end;
5423     pEList = p->pEList;
5424     pTabList = p->pSrc;
5425   }
5426 #endif
5427 
5428   /* If the query is DISTINCT with an ORDER BY but is not an aggregate, and
5429   ** if the select-list is the same as the ORDER BY list, then this query
5430   ** can be rewritten as a GROUP BY. In other words, this:
5431   **
5432   **     SELECT DISTINCT xyz FROM ... ORDER BY xyz
5433   **
5434   ** is transformed to:
5435   **
5436   **     SELECT xyz FROM ... GROUP BY xyz ORDER BY xyz
5437   **
5438   ** The second form is preferred as a single index (or temp-table) may be
5439   ** used for both the ORDER BY and DISTINCT processing. As originally
5440   ** written the query must use a temp-table for at least one of the ORDER
5441   ** BY and DISTINCT, and an index or separate temp-table for the other.
5442   */
5443   if( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct
5444    && sqlite3ExprListCompare(sSort.pOrderBy, pEList, -1)==0
5445   ){
5446     p->selFlags &= ~SF_Distinct;
5447     pGroupBy = p->pGroupBy = sqlite3ExprListDup(db, pEList, 0);
5448     /* Notice that even thought SF_Distinct has been cleared from p->selFlags,
5449     ** the sDistinct.isTnct is still set.  Hence, isTnct represents the
5450     ** original setting of the SF_Distinct flag, not the current setting */
5451     assert( sDistinct.isTnct );
5452 
5453 #if SELECTTRACE_ENABLED
5454     if( sqlite3SelectTrace & 0x400 ){
5455       SELECTTRACE(0x400,pParse,p,("Transform DISTINCT into GROUP BY:\n"));
5456       sqlite3TreeViewSelect(0, p, 0);
5457     }
5458 #endif
5459   }
5460 
5461   /* If there is an ORDER BY clause, then create an ephemeral index to
5462   ** do the sorting.  But this sorting ephemeral index might end up
5463   ** being unused if the data can be extracted in pre-sorted order.
5464   ** If that is the case, then the OP_OpenEphemeral instruction will be
5465   ** changed to an OP_Noop once we figure out that the sorting index is
5466   ** not needed.  The sSort.addrSortIndex variable is used to facilitate
5467   ** that change.
5468   */
5469   if( sSort.pOrderBy ){
5470     KeyInfo *pKeyInfo;
5471     pKeyInfo = keyInfoFromExprList(pParse, sSort.pOrderBy, 0, pEList->nExpr);
5472     sSort.iECursor = pParse->nTab++;
5473     sSort.addrSortIndex =
5474       sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
5475           sSort.iECursor, sSort.pOrderBy->nExpr+1+pEList->nExpr, 0,
5476           (char*)pKeyInfo, P4_KEYINFO
5477       );
5478   }else{
5479     sSort.addrSortIndex = -1;
5480   }
5481 
5482   /* If the output is destined for a temporary table, open that table.
5483   */
5484   if( pDest->eDest==SRT_EphemTab ){
5485     sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pDest->iSDParm, pEList->nExpr);
5486   }
5487 
5488   /* Set the limiter.
5489   */
5490   iEnd = sqlite3VdbeMakeLabel(v);
5491   if( (p->selFlags & SF_FixedLimit)==0 ){
5492     p->nSelectRow = 320;  /* 4 billion rows */
5493   }
5494   computeLimitRegisters(pParse, p, iEnd);
5495   if( p->iLimit==0 && sSort.addrSortIndex>=0 ){
5496     sqlite3VdbeChangeOpcode(v, sSort.addrSortIndex, OP_SorterOpen);
5497     sSort.sortFlags |= SORTFLAG_UseSorter;
5498   }
5499 
5500   /* Open an ephemeral index to use for the distinct set.
5501   */
5502   if( p->selFlags & SF_Distinct ){
5503     sDistinct.tabTnct = pParse->nTab++;
5504     sDistinct.addrTnct = sqlite3VdbeAddOp4(v, OP_OpenEphemeral,
5505                              sDistinct.tabTnct, 0, 0,
5506                              (char*)keyInfoFromExprList(pParse, p->pEList,0,0),
5507                              P4_KEYINFO);
5508     sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
5509     sDistinct.eTnctType = WHERE_DISTINCT_UNORDERED;
5510   }else{
5511     sDistinct.eTnctType = WHERE_DISTINCT_NOOP;
5512   }
5513 
5514   if( !isAgg && pGroupBy==0 ){
5515     /* No aggregate functions and no GROUP BY clause */
5516     u16 wctrlFlags = (sDistinct.isTnct ? WHERE_WANT_DISTINCT : 0);
5517     assert( WHERE_USE_LIMIT==SF_FixedLimit );
5518     wctrlFlags |= p->selFlags & SF_FixedLimit;
5519 
5520     /* Begin the database scan. */
5521     pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, sSort.pOrderBy,
5522                                p->pEList, wctrlFlags, p->nSelectRow);
5523     if( pWInfo==0 ) goto select_end;
5524     if( sqlite3WhereOutputRowCount(pWInfo) < p->nSelectRow ){
5525       p->nSelectRow = sqlite3WhereOutputRowCount(pWInfo);
5526     }
5527     if( sDistinct.isTnct && sqlite3WhereIsDistinct(pWInfo) ){
5528       sDistinct.eTnctType = sqlite3WhereIsDistinct(pWInfo);
5529     }
5530     if( sSort.pOrderBy ){
5531       sSort.nOBSat = sqlite3WhereIsOrdered(pWInfo);
5532       sSort.bOrderedInnerLoop = sqlite3WhereOrderedInnerLoop(pWInfo);
5533       if( sSort.nOBSat==sSort.pOrderBy->nExpr ){
5534         sSort.pOrderBy = 0;
5535       }
5536     }
5537 
5538     /* If sorting index that was created by a prior OP_OpenEphemeral
5539     ** instruction ended up not being needed, then change the OP_OpenEphemeral
5540     ** into an OP_Noop.
5541     */
5542     if( sSort.addrSortIndex>=0 && sSort.pOrderBy==0 ){
5543       sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
5544     }
5545 
5546     /* Use the standard inner loop. */
5547     selectInnerLoop(pParse, p, pEList, -1, &sSort, &sDistinct, pDest,
5548                     sqlite3WhereContinueLabel(pWInfo),
5549                     sqlite3WhereBreakLabel(pWInfo));
5550 
5551     /* End the database scan loop.
5552     */
5553     sqlite3WhereEnd(pWInfo);
5554   }else{
5555     /* This case when there exist aggregate functions or a GROUP BY clause
5556     ** or both */
5557     NameContext sNC;    /* Name context for processing aggregate information */
5558     int iAMem;          /* First Mem address for storing current GROUP BY */
5559     int iBMem;          /* First Mem address for previous GROUP BY */
5560     int iUseFlag;       /* Mem address holding flag indicating that at least
5561                         ** one row of the input to the aggregator has been
5562                         ** processed */
5563     int iAbortFlag;     /* Mem address which causes query abort if positive */
5564     int groupBySort;    /* Rows come from source in GROUP BY order */
5565     int addrEnd;        /* End of processing for this SELECT */
5566     int sortPTab = 0;   /* Pseudotable used to decode sorting results */
5567     int sortOut = 0;    /* Output register from the sorter */
5568     int orderByGrp = 0; /* True if the GROUP BY and ORDER BY are the same */
5569 
5570     /* Remove any and all aliases between the result set and the
5571     ** GROUP BY clause.
5572     */
5573     if( pGroupBy ){
5574       int k;                        /* Loop counter */
5575       struct ExprList_item *pItem;  /* For looping over expression in a list */
5576 
5577       for(k=p->pEList->nExpr, pItem=p->pEList->a; k>0; k--, pItem++){
5578         pItem->u.x.iAlias = 0;
5579       }
5580       for(k=pGroupBy->nExpr, pItem=pGroupBy->a; k>0; k--, pItem++){
5581         pItem->u.x.iAlias = 0;
5582       }
5583       assert( 66==sqlite3LogEst(100) );
5584       if( p->nSelectRow>66 ) p->nSelectRow = 66;
5585     }else{
5586       assert( 0==sqlite3LogEst(1) );
5587       p->nSelectRow = 0;
5588     }
5589 
5590     /* If there is both a GROUP BY and an ORDER BY clause and they are
5591     ** identical, then it may be possible to disable the ORDER BY clause
5592     ** on the grounds that the GROUP BY will cause elements to come out
5593     ** in the correct order. It also may not - the GROUP BY might use a
5594     ** database index that causes rows to be grouped together as required
5595     ** but not actually sorted. Either way, record the fact that the
5596     ** ORDER BY and GROUP BY clauses are the same by setting the orderByGrp
5597     ** variable.  */
5598     if( sqlite3ExprListCompare(pGroupBy, sSort.pOrderBy, -1)==0 ){
5599       orderByGrp = 1;
5600     }
5601 
5602     /* Create a label to jump to when we want to abort the query */
5603     addrEnd = sqlite3VdbeMakeLabel(v);
5604 
5605     /* Convert TK_COLUMN nodes into TK_AGG_COLUMN and make entries in
5606     ** sAggInfo for all TK_AGG_FUNCTION nodes in expressions of the
5607     ** SELECT statement.
5608     */
5609     memset(&sNC, 0, sizeof(sNC));
5610     sNC.pParse = pParse;
5611     sNC.pSrcList = pTabList;
5612     sNC.pAggInfo = &sAggInfo;
5613     sAggInfo.mnReg = pParse->nMem+1;
5614     sAggInfo.nSortingColumn = pGroupBy ? pGroupBy->nExpr : 0;
5615     sAggInfo.pGroupBy = pGroupBy;
5616     sqlite3ExprAnalyzeAggList(&sNC, pEList);
5617     sqlite3ExprAnalyzeAggList(&sNC, sSort.pOrderBy);
5618     if( pHaving ){
5619       if( pGroupBy ){
5620         assert( pWhere==p->pWhere );
5621         havingToWhere(pParse, pGroupBy, pHaving, &p->pWhere);
5622         pWhere = p->pWhere;
5623       }
5624       sqlite3ExprAnalyzeAggregates(&sNC, pHaving);
5625     }
5626     sAggInfo.nAccumulator = sAggInfo.nColumn;
5627     for(i=0; i<sAggInfo.nFunc; i++){
5628       assert( !ExprHasProperty(sAggInfo.aFunc[i].pExpr, EP_xIsSelect) );
5629       sNC.ncFlags |= NC_InAggFunc;
5630       sqlite3ExprAnalyzeAggList(&sNC, sAggInfo.aFunc[i].pExpr->x.pList);
5631       sNC.ncFlags &= ~NC_InAggFunc;
5632     }
5633     sAggInfo.mxReg = pParse->nMem;
5634     if( db->mallocFailed ) goto select_end;
5635 
5636     /* Processing for aggregates with GROUP BY is very different and
5637     ** much more complex than aggregates without a GROUP BY.
5638     */
5639     if( pGroupBy ){
5640       KeyInfo *pKeyInfo;  /* Keying information for the group by clause */
5641       int addr1;          /* A-vs-B comparision jump */
5642       int addrOutputRow;  /* Start of subroutine that outputs a result row */
5643       int regOutputRow;   /* Return address register for output subroutine */
5644       int addrSetAbort;   /* Set the abort flag and return */
5645       int addrTopOfLoop;  /* Top of the input loop */
5646       int addrSortingIdx; /* The OP_OpenEphemeral for the sorting index */
5647       int addrReset;      /* Subroutine for resetting the accumulator */
5648       int regReset;       /* Return address register for reset subroutine */
5649 
5650       /* If there is a GROUP BY clause we might need a sorting index to
5651       ** implement it.  Allocate that sorting index now.  If it turns out
5652       ** that we do not need it after all, the OP_SorterOpen instruction
5653       ** will be converted into a Noop.
5654       */
5655       sAggInfo.sortingIdx = pParse->nTab++;
5656       pKeyInfo = keyInfoFromExprList(pParse, pGroupBy, 0, sAggInfo.nColumn);
5657       addrSortingIdx = sqlite3VdbeAddOp4(v, OP_SorterOpen,
5658           sAggInfo.sortingIdx, sAggInfo.nSortingColumn,
5659           0, (char*)pKeyInfo, P4_KEYINFO);
5660 
5661       /* Initialize memory locations used by GROUP BY aggregate processing
5662       */
5663       iUseFlag = ++pParse->nMem;
5664       iAbortFlag = ++pParse->nMem;
5665       regOutputRow = ++pParse->nMem;
5666       addrOutputRow = sqlite3VdbeMakeLabel(v);
5667       regReset = ++pParse->nMem;
5668       addrReset = sqlite3VdbeMakeLabel(v);
5669       iAMem = pParse->nMem + 1;
5670       pParse->nMem += pGroupBy->nExpr;
5671       iBMem = pParse->nMem + 1;
5672       pParse->nMem += pGroupBy->nExpr;
5673       sqlite3VdbeAddOp2(v, OP_Integer, 0, iAbortFlag);
5674       VdbeComment((v, "clear abort flag"));
5675       sqlite3VdbeAddOp2(v, OP_Integer, 0, iUseFlag);
5676       VdbeComment((v, "indicate accumulator empty"));
5677       sqlite3VdbeAddOp3(v, OP_Null, 0, iAMem, iAMem+pGroupBy->nExpr-1);
5678 
5679       /* Begin a loop that will extract all source rows in GROUP BY order.
5680       ** This might involve two separate loops with an OP_Sort in between, or
5681       ** it might be a single loop that uses an index to extract information
5682       ** in the right order to begin with.
5683       */
5684       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
5685       pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pGroupBy, 0,
5686           WHERE_GROUPBY | (orderByGrp ? WHERE_SORTBYGROUP : 0), 0
5687       );
5688       if( pWInfo==0 ) goto select_end;
5689       if( sqlite3WhereIsOrdered(pWInfo)==pGroupBy->nExpr ){
5690         /* The optimizer is able to deliver rows in group by order so
5691         ** we do not have to sort.  The OP_OpenEphemeral table will be
5692         ** cancelled later because we still need to use the pKeyInfo
5693         */
5694         groupBySort = 0;
5695       }else{
5696         /* Rows are coming out in undetermined order.  We have to push
5697         ** each row into a sorting index, terminate the first loop,
5698         ** then loop over the sorting index in order to get the output
5699         ** in sorted order
5700         */
5701         int regBase;
5702         int regRecord;
5703         int nCol;
5704         int nGroupBy;
5705 
5706         explainTempTable(pParse,
5707             (sDistinct.isTnct && (p->selFlags&SF_Distinct)==0) ?
5708                     "DISTINCT" : "GROUP BY");
5709 
5710         groupBySort = 1;
5711         nGroupBy = pGroupBy->nExpr;
5712         nCol = nGroupBy;
5713         j = nGroupBy;
5714         for(i=0; i<sAggInfo.nColumn; i++){
5715           if( sAggInfo.aCol[i].iSorterColumn>=j ){
5716             nCol++;
5717             j++;
5718           }
5719         }
5720         regBase = sqlite3GetTempRange(pParse, nCol);
5721         sqlite3ExprCacheClear(pParse);
5722         sqlite3ExprCodeExprList(pParse, pGroupBy, regBase, 0, 0);
5723         j = nGroupBy;
5724         for(i=0; i<sAggInfo.nColumn; i++){
5725           struct AggInfo_col *pCol = &sAggInfo.aCol[i];
5726           if( pCol->iSorterColumn>=j ){
5727             int r1 = j + regBase;
5728             sqlite3ExprCodeGetColumnToReg(pParse,
5729                                pCol->pTab, pCol->iColumn, pCol->iTable, r1);
5730             j++;
5731           }
5732         }
5733         regRecord = sqlite3GetTempReg(pParse);
5734         sqlite3VdbeAddOp3(v, OP_MakeRecord, regBase, nCol, regRecord);
5735         sqlite3VdbeAddOp2(v, OP_SorterInsert, sAggInfo.sortingIdx, regRecord);
5736         sqlite3ReleaseTempReg(pParse, regRecord);
5737         sqlite3ReleaseTempRange(pParse, regBase, nCol);
5738         sqlite3WhereEnd(pWInfo);
5739         sAggInfo.sortingIdxPTab = sortPTab = pParse->nTab++;
5740         sortOut = sqlite3GetTempReg(pParse);
5741         sqlite3VdbeAddOp3(v, OP_OpenPseudo, sortPTab, sortOut, nCol);
5742         sqlite3VdbeAddOp2(v, OP_SorterSort, sAggInfo.sortingIdx, addrEnd);
5743         VdbeComment((v, "GROUP BY sort")); VdbeCoverage(v);
5744         sAggInfo.useSortingIdx = 1;
5745         sqlite3ExprCacheClear(pParse);
5746 
5747       }
5748 
5749       /* If the index or temporary table used by the GROUP BY sort
5750       ** will naturally deliver rows in the order required by the ORDER BY
5751       ** clause, cancel the ephemeral table open coded earlier.
5752       **
5753       ** This is an optimization - the correct answer should result regardless.
5754       ** Use the SQLITE_GroupByOrder flag with SQLITE_TESTCTRL_OPTIMIZER to
5755       ** disable this optimization for testing purposes.  */
5756       if( orderByGrp && OptimizationEnabled(db, SQLITE_GroupByOrder)
5757        && (groupBySort || sqlite3WhereIsSorted(pWInfo))
5758       ){
5759         sSort.pOrderBy = 0;
5760         sqlite3VdbeChangeToNoop(v, sSort.addrSortIndex);
5761       }
5762 
5763       /* Evaluate the current GROUP BY terms and store in b0, b1, b2...
5764       ** (b0 is memory location iBMem+0, b1 is iBMem+1, and so forth)
5765       ** Then compare the current GROUP BY terms against the GROUP BY terms
5766       ** from the previous row currently stored in a0, a1, a2...
5767       */
5768       addrTopOfLoop = sqlite3VdbeCurrentAddr(v);
5769       sqlite3ExprCacheClear(pParse);
5770       if( groupBySort ){
5771         sqlite3VdbeAddOp3(v, OP_SorterData, sAggInfo.sortingIdx,
5772                           sortOut, sortPTab);
5773       }
5774       for(j=0; j<pGroupBy->nExpr; j++){
5775         if( groupBySort ){
5776           sqlite3VdbeAddOp3(v, OP_Column, sortPTab, j, iBMem+j);
5777         }else{
5778           sAggInfo.directMode = 1;
5779           sqlite3ExprCode(pParse, pGroupBy->a[j].pExpr, iBMem+j);
5780         }
5781       }
5782       sqlite3VdbeAddOp4(v, OP_Compare, iAMem, iBMem, pGroupBy->nExpr,
5783                           (char*)sqlite3KeyInfoRef(pKeyInfo), P4_KEYINFO);
5784       addr1 = sqlite3VdbeCurrentAddr(v);
5785       sqlite3VdbeAddOp3(v, OP_Jump, addr1+1, 0, addr1+1); VdbeCoverage(v);
5786 
5787       /* Generate code that runs whenever the GROUP BY changes.
5788       ** Changes in the GROUP BY are detected by the previous code
5789       ** block.  If there were no changes, this block is skipped.
5790       **
5791       ** This code copies current group by terms in b0,b1,b2,...
5792       ** over to a0,a1,a2.  It then calls the output subroutine
5793       ** and resets the aggregate accumulator registers in preparation
5794       ** for the next GROUP BY batch.
5795       */
5796       sqlite3ExprCodeMove(pParse, iBMem, iAMem, pGroupBy->nExpr);
5797       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
5798       VdbeComment((v, "output one row"));
5799       sqlite3VdbeAddOp2(v, OP_IfPos, iAbortFlag, addrEnd); VdbeCoverage(v);
5800       VdbeComment((v, "check abort flag"));
5801       sqlite3VdbeAddOp2(v, OP_Gosub, regReset, addrReset);
5802       VdbeComment((v, "reset accumulator"));
5803 
5804       /* Update the aggregate accumulators based on the content of
5805       ** the current row
5806       */
5807       sqlite3VdbeJumpHere(v, addr1);
5808       updateAccumulator(pParse, &sAggInfo);
5809       sqlite3VdbeAddOp2(v, OP_Integer, 1, iUseFlag);
5810       VdbeComment((v, "indicate data in accumulator"));
5811 
5812       /* End of the loop
5813       */
5814       if( groupBySort ){
5815         sqlite3VdbeAddOp2(v, OP_SorterNext, sAggInfo.sortingIdx, addrTopOfLoop);
5816         VdbeCoverage(v);
5817       }else{
5818         sqlite3WhereEnd(pWInfo);
5819         sqlite3VdbeChangeToNoop(v, addrSortingIdx);
5820       }
5821 
5822       /* Output the final row of result
5823       */
5824       sqlite3VdbeAddOp2(v, OP_Gosub, regOutputRow, addrOutputRow);
5825       VdbeComment((v, "output final row"));
5826 
5827       /* Jump over the subroutines
5828       */
5829       sqlite3VdbeGoto(v, addrEnd);
5830 
5831       /* Generate a subroutine that outputs a single row of the result
5832       ** set.  This subroutine first looks at the iUseFlag.  If iUseFlag
5833       ** is less than or equal to zero, the subroutine is a no-op.  If
5834       ** the processing calls for the query to abort, this subroutine
5835       ** increments the iAbortFlag memory location before returning in
5836       ** order to signal the caller to abort.
5837       */
5838       addrSetAbort = sqlite3VdbeCurrentAddr(v);
5839       sqlite3VdbeAddOp2(v, OP_Integer, 1, iAbortFlag);
5840       VdbeComment((v, "set abort flag"));
5841       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5842       sqlite3VdbeResolveLabel(v, addrOutputRow);
5843       addrOutputRow = sqlite3VdbeCurrentAddr(v);
5844       sqlite3VdbeAddOp2(v, OP_IfPos, iUseFlag, addrOutputRow+2);
5845       VdbeCoverage(v);
5846       VdbeComment((v, "Groupby result generator entry point"));
5847       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5848       finalizeAggFunctions(pParse, &sAggInfo);
5849       sqlite3ExprIfFalse(pParse, pHaving, addrOutputRow+1, SQLITE_JUMPIFNULL);
5850       selectInnerLoop(pParse, p, p->pEList, -1, &sSort,
5851                       &sDistinct, pDest,
5852                       addrOutputRow+1, addrSetAbort);
5853       sqlite3VdbeAddOp1(v, OP_Return, regOutputRow);
5854       VdbeComment((v, "end groupby result generator"));
5855 
5856       /* Generate a subroutine that will reset the group-by accumulator
5857       */
5858       sqlite3VdbeResolveLabel(v, addrReset);
5859       resetAccumulator(pParse, &sAggInfo);
5860       sqlite3VdbeAddOp1(v, OP_Return, regReset);
5861 
5862     } /* endif pGroupBy.  Begin aggregate queries without GROUP BY: */
5863     else {
5864       ExprList *pDel = 0;
5865 #ifndef SQLITE_OMIT_BTREECOUNT
5866       Table *pTab;
5867       if( (pTab = isSimpleCount(p, &sAggInfo))!=0 ){
5868         /* If isSimpleCount() returns a pointer to a Table structure, then
5869         ** the SQL statement is of the form:
5870         **
5871         **   SELECT count(*) FROM <tbl>
5872         **
5873         ** where the Table structure returned represents table <tbl>.
5874         **
5875         ** This statement is so common that it is optimized specially. The
5876         ** OP_Count instruction is executed either on the intkey table that
5877         ** contains the data for table <tbl> or on one of its indexes. It
5878         ** is better to execute the op on an index, as indexes are almost
5879         ** always spread across less pages than their corresponding tables.
5880         */
5881         const int iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
5882         const int iCsr = pParse->nTab++;     /* Cursor to scan b-tree */
5883         Index *pIdx;                         /* Iterator variable */
5884         KeyInfo *pKeyInfo = 0;               /* Keyinfo for scanned index */
5885         Index *pBest = 0;                    /* Best index found so far */
5886         int iRoot = pTab->tnum;              /* Root page of scanned b-tree */
5887 
5888         sqlite3CodeVerifySchema(pParse, iDb);
5889         sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
5890 
5891         /* Search for the index that has the lowest scan cost.
5892         **
5893         ** (2011-04-15) Do not do a full scan of an unordered index.
5894         **
5895         ** (2013-10-03) Do not count the entries in a partial index.
5896         **
5897         ** In practice the KeyInfo structure will not be used. It is only
5898         ** passed to keep OP_OpenRead happy.
5899         */
5900         if( !HasRowid(pTab) ) pBest = sqlite3PrimaryKeyIndex(pTab);
5901         for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
5902           if( pIdx->bUnordered==0
5903            && pIdx->szIdxRow<pTab->szTabRow
5904            && pIdx->pPartIdxWhere==0
5905            && (!pBest || pIdx->szIdxRow<pBest->szIdxRow)
5906           ){
5907             pBest = pIdx;
5908           }
5909         }
5910         if( pBest ){
5911           iRoot = pBest->tnum;
5912           pKeyInfo = sqlite3KeyInfoOfIndex(pParse, pBest);
5913         }
5914 
5915         /* Open a read-only cursor, execute the OP_Count, close the cursor. */
5916         sqlite3VdbeAddOp4Int(v, OP_OpenRead, iCsr, iRoot, iDb, 1);
5917         if( pKeyInfo ){
5918           sqlite3VdbeChangeP4(v, -1, (char *)pKeyInfo, P4_KEYINFO);
5919         }
5920         sqlite3VdbeAddOp2(v, OP_Count, iCsr, sAggInfo.aFunc[0].iMem);
5921         sqlite3VdbeAddOp1(v, OP_Close, iCsr);
5922         explainSimpleCount(pParse, pTab, pBest);
5923       }else
5924 #endif /* SQLITE_OMIT_BTREECOUNT */
5925       {
5926         /* Check if the query is of one of the following forms:
5927         **
5928         **   SELECT min(x) FROM ...
5929         **   SELECT max(x) FROM ...
5930         **
5931         ** If it is, then ask the code in where.c to attempt to sort results
5932         ** as if there was an "ORDER ON x" or "ORDER ON x DESC" clause.
5933         ** If where.c is able to produce results sorted in this order, then
5934         ** add vdbe code to break out of the processing loop after the
5935         ** first iteration (since the first iteration of the loop is
5936         ** guaranteed to operate on the row with the minimum or maximum
5937         ** value of x, the only row required).
5938         **
5939         ** A special flag must be passed to sqlite3WhereBegin() to slightly
5940         ** modify behavior as follows:
5941         **
5942         **   + If the query is a "SELECT min(x)", then the loop coded by
5943         **     where.c should not iterate over any values with a NULL value
5944         **     for x.
5945         **
5946         **   + The optimizer code in where.c (the thing that decides which
5947         **     index or indices to use) should place a different priority on
5948         **     satisfying the 'ORDER BY' clause than it does in other cases.
5949         **     Refer to code and comments in where.c for details.
5950         */
5951         ExprList *pMinMax = 0;
5952         u8 flag = WHERE_ORDERBY_NORMAL;
5953 
5954         assert( p->pGroupBy==0 );
5955         assert( flag==0 );
5956         if( p->pHaving==0 ){
5957           flag = minMaxQuery(&sAggInfo, &pMinMax);
5958         }
5959         assert( flag==0 || (pMinMax!=0 && pMinMax->nExpr==1) );
5960 
5961         if( flag ){
5962           pMinMax = sqlite3ExprListDup(db, pMinMax, 0);
5963           pDel = pMinMax;
5964           assert( db->mallocFailed || pMinMax!=0 );
5965           if( !db->mallocFailed ){
5966             pMinMax->a[0].sortOrder = flag!=WHERE_ORDERBY_MIN ?1:0;
5967             pMinMax->a[0].pExpr->op = TK_COLUMN;
5968           }
5969         }
5970 
5971         /* This case runs if the aggregate has no GROUP BY clause.  The
5972         ** processing is much simpler since there is only a single row
5973         ** of output.
5974         */
5975         resetAccumulator(pParse, &sAggInfo);
5976         pWInfo = sqlite3WhereBegin(pParse, pTabList, pWhere, pMinMax, 0,flag,0);
5977         if( pWInfo==0 ){
5978           sqlite3ExprListDelete(db, pDel);
5979           goto select_end;
5980         }
5981         updateAccumulator(pParse, &sAggInfo);
5982         assert( pMinMax==0 || pMinMax->nExpr==1 );
5983         if( sqlite3WhereIsOrdered(pWInfo)>0 ){
5984           sqlite3VdbeGoto(v, sqlite3WhereBreakLabel(pWInfo));
5985           VdbeComment((v, "%s() by index",
5986                 (flag==WHERE_ORDERBY_MIN?"min":"max")));
5987         }
5988         sqlite3WhereEnd(pWInfo);
5989         finalizeAggFunctions(pParse, &sAggInfo);
5990       }
5991 
5992       sSort.pOrderBy = 0;
5993       sqlite3ExprIfFalse(pParse, pHaving, addrEnd, SQLITE_JUMPIFNULL);
5994       selectInnerLoop(pParse, p, p->pEList, -1, 0, 0,
5995                       pDest, addrEnd, addrEnd);
5996       sqlite3ExprListDelete(db, pDel);
5997     }
5998     sqlite3VdbeResolveLabel(v, addrEnd);
5999 
6000   } /* endif aggregate query */
6001 
6002   if( sDistinct.eTnctType==WHERE_DISTINCT_UNORDERED ){
6003     explainTempTable(pParse, "DISTINCT");
6004   }
6005 
6006   /* If there is an ORDER BY clause, then we need to sort the results
6007   ** and send them to the callback one by one.
6008   */
6009   if( sSort.pOrderBy ){
6010     explainTempTable(pParse,
6011                      sSort.nOBSat>0 ? "RIGHT PART OF ORDER BY":"ORDER BY");
6012     generateSortTail(pParse, p, &sSort, pEList->nExpr, pDest);
6013   }
6014 
6015   /* Jump here to skip this query
6016   */
6017   sqlite3VdbeResolveLabel(v, iEnd);
6018 
6019   /* The SELECT has been coded. If there is an error in the Parse structure,
6020   ** set the return code to 1. Otherwise 0. */
6021   rc = (pParse->nErr>0);
6022 
6023   /* Control jumps to here if an error is encountered above, or upon
6024   ** successful coding of the SELECT.
6025   */
6026 select_end:
6027   explainSetInteger(pParse->iSelectId, iRestoreSelectId);
6028 
6029   /* Identify column names if results of the SELECT are to be output.
6030   */
6031   if( rc==SQLITE_OK && pDest->eDest==SRT_Output ){
6032     generateColumnNames(pParse, pTabList, pEList);
6033   }
6034 
6035   sqlite3DbFree(db, sAggInfo.aCol);
6036   sqlite3DbFree(db, sAggInfo.aFunc);
6037 #if SELECTTRACE_ENABLED
6038   SELECTTRACE(1,pParse,p,("end processing\n"));
6039   pParse->nSelectIndent--;
6040 #endif
6041   return rc;
6042 }
6043