xref: /sqlite-3.40.0/src/analyze.c (revision 49a76a8f)
1 /*
2 ** 2005-07-08
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 code associated with the ANALYZE command.
13 **
14 ** The ANALYZE command gather statistics about the content of tables
15 ** and indices.  These statistics are made available to the query planner
16 ** to help it make better decisions about how to perform queries.
17 **
18 ** The following system tables are or have been supported:
19 **
20 **    CREATE TABLE sqlite_stat1(tbl, idx, stat);
21 **    CREATE TABLE sqlite_stat2(tbl, idx, sampleno, sample);
22 **    CREATE TABLE sqlite_stat3(tbl, idx, nEq, nLt, nDLt, sample);
23 **    CREATE TABLE sqlite_stat4(tbl, idx, nEq, nLt, nDLt, sample);
24 **
25 ** Additional tables might be added in future releases of SQLite.
26 ** The sqlite_stat2 table is not created or used unless the SQLite version
27 ** is between 3.6.18 and 3.7.8, inclusive, and unless SQLite is compiled
28 ** with SQLITE_ENABLE_STAT2.  The sqlite_stat2 table is deprecated.
29 ** The sqlite_stat2 table is superseded by sqlite_stat3, which is only
30 ** created and used by SQLite versions 3.7.9 through 3.29.0 when
31 ** SQLITE_ENABLE_STAT3 defined.  The functionality of sqlite_stat3
32 ** is a superset of sqlite_stat2 and is also now deprecated.  The
33 ** sqlite_stat4 is an enhanced version of sqlite_stat3 and is only
34 ** available when compiled with SQLITE_ENABLE_STAT4 and in SQLite
35 ** versions 3.8.1 and later.  STAT4 is the only variant that is still
36 ** supported.
37 **
38 ** For most applications, sqlite_stat1 provides all the statistics required
39 ** for the query planner to make good choices.
40 **
41 ** Format of sqlite_stat1:
42 **
43 ** There is normally one row per index, with the index identified by the
44 ** name in the idx column.  The tbl column is the name of the table to
45 ** which the index belongs.  In each such row, the stat column will be
46 ** a string consisting of a list of integers.  The first integer in this
47 ** list is the number of rows in the index.  (This is the same as the
48 ** number of rows in the table, except for partial indices.)  The second
49 ** integer is the average number of rows in the index that have the same
50 ** value in the first column of the index.  The third integer is the average
51 ** number of rows in the index that have the same value for the first two
52 ** columns.  The N-th integer (for N>1) is the average number of rows in
53 ** the index which have the same value for the first N-1 columns.  For
54 ** a K-column index, there will be K+1 integers in the stat column.  If
55 ** the index is unique, then the last integer will be 1.
56 **
57 ** The list of integers in the stat column can optionally be followed
58 ** by the keyword "unordered".  The "unordered" keyword, if it is present,
59 ** must be separated from the last integer by a single space.  If the
60 ** "unordered" keyword is present, then the query planner assumes that
61 ** the index is unordered and will not use the index for a range query.
62 **
63 ** If the sqlite_stat1.idx column is NULL, then the sqlite_stat1.stat
64 ** column contains a single integer which is the (estimated) number of
65 ** rows in the table identified by sqlite_stat1.tbl.
66 **
67 ** Format of sqlite_stat2:
68 **
69 ** The sqlite_stat2 is only created and is only used if SQLite is compiled
70 ** with SQLITE_ENABLE_STAT2 and if the SQLite version number is between
71 ** 3.6.18 and 3.7.8.  The "stat2" table contains additional information
72 ** about the distribution of keys within an index.  The index is identified by
73 ** the "idx" column and the "tbl" column is the name of the table to which
74 ** the index belongs.  There are usually 10 rows in the sqlite_stat2
75 ** table for each index.
76 **
77 ** The sqlite_stat2 entries for an index that have sampleno between 0 and 9
78 ** inclusive are samples of the left-most key value in the index taken at
79 ** evenly spaced points along the index.  Let the number of samples be S
80 ** (10 in the standard build) and let C be the number of rows in the index.
81 ** Then the sampled rows are given by:
82 **
83 **     rownumber = (i*C*2 + C)/(S*2)
84 **
85 ** For i between 0 and S-1.  Conceptually, the index space is divided into
86 ** S uniform buckets and the samples are the middle row from each bucket.
87 **
88 ** The format for sqlite_stat2 is recorded here for legacy reference.  This
89 ** version of SQLite does not support sqlite_stat2.  It neither reads nor
90 ** writes the sqlite_stat2 table.  This version of SQLite only supports
91 ** sqlite_stat3.
92 **
93 ** Format for sqlite_stat3:
94 **
95 ** The sqlite_stat3 format is a subset of sqlite_stat4.  Hence, the
96 ** sqlite_stat4 format will be described first.  Further information
97 ** about sqlite_stat3 follows the sqlite_stat4 description.
98 **
99 ** Format for sqlite_stat4:
100 **
101 ** As with sqlite_stat2, the sqlite_stat4 table contains histogram data
102 ** to aid the query planner in choosing good indices based on the values
103 ** that indexed columns are compared against in the WHERE clauses of
104 ** queries.
105 **
106 ** The sqlite_stat4 table contains multiple entries for each index.
107 ** The idx column names the index and the tbl column is the table of the
108 ** index.  If the idx and tbl columns are the same, then the sample is
109 ** of the INTEGER PRIMARY KEY.  The sample column is a blob which is the
110 ** binary encoding of a key from the index.  The nEq column is a
111 ** list of integers.  The first integer is the approximate number
112 ** of entries in the index whose left-most column exactly matches
113 ** the left-most column of the sample.  The second integer in nEq
114 ** is the approximate number of entries in the index where the
115 ** first two columns match the first two columns of the sample.
116 ** And so forth.  nLt is another list of integers that show the approximate
117 ** number of entries that are strictly less than the sample.  The first
118 ** integer in nLt contains the number of entries in the index where the
119 ** left-most column is less than the left-most column of the sample.
120 ** The K-th integer in the nLt entry is the number of index entries
121 ** where the first K columns are less than the first K columns of the
122 ** sample.  The nDLt column is like nLt except that it contains the
123 ** number of distinct entries in the index that are less than the
124 ** sample.
125 **
126 ** There can be an arbitrary number of sqlite_stat4 entries per index.
127 ** The ANALYZE command will typically generate sqlite_stat4 tables
128 ** that contain between 10 and 40 samples which are distributed across
129 ** the key space, though not uniformly, and which include samples with
130 ** large nEq values.
131 **
132 ** Format for sqlite_stat3 redux:
133 **
134 ** The sqlite_stat3 table is like sqlite_stat4 except that it only
135 ** looks at the left-most column of the index.  The sqlite_stat3.sample
136 ** column contains the actual value of the left-most column instead
137 ** of a blob encoding of the complete index key as is found in
138 ** sqlite_stat4.sample.  The nEq, nLt, and nDLt entries of sqlite_stat3
139 ** all contain just a single integer which is the same as the first
140 ** integer in the equivalent columns in sqlite_stat4.
141 */
142 #ifndef SQLITE_OMIT_ANALYZE
143 #include "sqliteInt.h"
144 
145 #if defined(SQLITE_ENABLE_STAT4)
146 # define IsStat4     1
147 #else
148 # define IsStat4     0
149 # undef SQLITE_STAT4_SAMPLES
150 # define SQLITE_STAT4_SAMPLES 1
151 #endif
152 
153 /*
154 ** This routine generates code that opens the sqlite_statN tables.
155 ** The sqlite_stat1 table is always relevant.  sqlite_stat2 is now
156 ** obsolete.  sqlite_stat3 and sqlite_stat4 are only opened when
157 ** appropriate compile-time options are provided.
158 **
159 ** If the sqlite_statN tables do not previously exist, it is created.
160 **
161 ** Argument zWhere may be a pointer to a buffer containing a table name,
162 ** or it may be a NULL pointer. If it is not NULL, then all entries in
163 ** the sqlite_statN tables associated with the named table are deleted.
164 ** If zWhere==0, then code is generated to delete all stat table entries.
165 */
166 static void openStatTable(
167   Parse *pParse,          /* Parsing context */
168   int iDb,                /* The database we are looking in */
169   int iStatCur,           /* Open the sqlite_stat1 table on this cursor */
170   const char *zWhere,     /* Delete entries for this table or index */
171   const char *zWhereType  /* Either "tbl" or "idx" */
172 ){
173   static const struct {
174     const char *zName;
175     const char *zCols;
176   } aTable[] = {
177     { "sqlite_stat1", "tbl,idx,stat" },
178 #if defined(SQLITE_ENABLE_STAT4)
179     { "sqlite_stat4", "tbl,idx,neq,nlt,ndlt,sample" },
180 #else
181     { "sqlite_stat4", 0 },
182 #endif
183     { "sqlite_stat3", 0 },
184   };
185   int i;
186   sqlite3 *db = pParse->db;
187   Db *pDb;
188   Vdbe *v = sqlite3GetVdbe(pParse);
189   int aRoot[ArraySize(aTable)];
190   u8 aCreateTbl[ArraySize(aTable)];
191 #ifdef SQLITE_ENABLE_STAT4
192   const int nToOpen = OptimizationEnabled(db,SQLITE_Stat4) ? 2 : 1;
193 #else
194   const int nToOpen = 1;
195 #endif
196 
197   if( v==0 ) return;
198   assert( sqlite3BtreeHoldsAllMutexes(db) );
199   assert( sqlite3VdbeDb(v)==db );
200   pDb = &db->aDb[iDb];
201 
202   /* Create new statistic tables if they do not exist, or clear them
203   ** if they do already exist.
204   */
205   for(i=0; i<ArraySize(aTable); i++){
206     const char *zTab = aTable[i].zName;
207     Table *pStat;
208     aCreateTbl[i] = 0;
209     if( (pStat = sqlite3FindTable(db, zTab, pDb->zDbSName))==0 ){
210       if( i<nToOpen ){
211         /* The sqlite_statN table does not exist. Create it. Note that a
212         ** side-effect of the CREATE TABLE statement is to leave the rootpage
213         ** of the new table in register pParse->regRoot. This is important
214         ** because the OpenWrite opcode below will be needing it. */
215         sqlite3NestedParse(pParse,
216             "CREATE TABLE %Q.%s(%s)", pDb->zDbSName, zTab, aTable[i].zCols
217         );
218         aRoot[i] = pParse->regRoot;
219         aCreateTbl[i] = OPFLAG_P2ISREG;
220       }
221     }else{
222       /* The table already exists. If zWhere is not NULL, delete all entries
223       ** associated with the table zWhere. If zWhere is NULL, delete the
224       ** entire contents of the table. */
225       aRoot[i] = pStat->tnum;
226       sqlite3TableLock(pParse, iDb, aRoot[i], 1, zTab);
227       if( zWhere ){
228         sqlite3NestedParse(pParse,
229            "DELETE FROM %Q.%s WHERE %s=%Q",
230            pDb->zDbSName, zTab, zWhereType, zWhere
231         );
232 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
233       }else if( db->xPreUpdateCallback ){
234         sqlite3NestedParse(pParse, "DELETE FROM %Q.%s", pDb->zDbSName, zTab);
235 #endif
236       }else{
237         /* The sqlite_stat[134] table already exists.  Delete all rows. */
238         sqlite3VdbeAddOp2(v, OP_Clear, aRoot[i], iDb);
239       }
240     }
241   }
242 
243   /* Open the sqlite_stat[134] tables for writing. */
244   for(i=0; i<nToOpen; i++){
245     assert( i<ArraySize(aTable) );
246     sqlite3VdbeAddOp4Int(v, OP_OpenWrite, iStatCur+i, aRoot[i], iDb, 3);
247     sqlite3VdbeChangeP5(v, aCreateTbl[i]);
248     VdbeComment((v, aTable[i].zName));
249   }
250 }
251 
252 /*
253 ** Recommended number of samples for sqlite_stat4
254 */
255 #ifndef SQLITE_STAT4_SAMPLES
256 # define SQLITE_STAT4_SAMPLES 24
257 #endif
258 
259 /*
260 ** Three SQL functions - stat_init(), stat_push(), and stat_get() -
261 ** share an instance of the following structure to hold their state
262 ** information.
263 */
264 typedef struct StatAccum StatAccum;
265 typedef struct StatSample StatSample;
266 struct StatSample {
267   tRowcnt *anEq;                  /* sqlite_stat4.nEq */
268   tRowcnt *anDLt;                 /* sqlite_stat4.nDLt */
269 #ifdef SQLITE_ENABLE_STAT4
270   tRowcnt *anLt;                  /* sqlite_stat4.nLt */
271   union {
272     i64 iRowid;                     /* Rowid in main table of the key */
273     u8 *aRowid;                     /* Key for WITHOUT ROWID tables */
274   } u;
275   u32 nRowid;                     /* Sizeof aRowid[] */
276   u8 isPSample;                   /* True if a periodic sample */
277   int iCol;                       /* If !isPSample, the reason for inclusion */
278   u32 iHash;                      /* Tiebreaker hash */
279 #endif
280 };
281 struct StatAccum {
282   sqlite3 *db;              /* Database connection, for malloc() */
283   tRowcnt nEst;             /* Estimated number of rows */
284   tRowcnt nRow;             /* Number of rows visited so far */
285   int nLimit;               /* Analysis row-scan limit */
286   int nCol;                 /* Number of columns in index + pk/rowid */
287   int nKeyCol;              /* Number of index columns w/o the pk/rowid */
288   u8 nSkipAhead;            /* Number of times of skip-ahead */
289   StatSample current;       /* Current row as a StatSample */
290 #ifdef SQLITE_ENABLE_STAT4
291   tRowcnt nPSample;         /* How often to do a periodic sample */
292   int mxSample;             /* Maximum number of samples to accumulate */
293   u32 iPrn;                 /* Pseudo-random number used for sampling */
294   StatSample *aBest;        /* Array of nCol best samples */
295   int iMin;                 /* Index in a[] of entry with minimum score */
296   int nSample;              /* Current number of samples */
297   int nMaxEqZero;           /* Max leading 0 in anEq[] for any a[] entry */
298   int iGet;                 /* Index of current sample accessed by stat_get() */
299   StatSample *a;            /* Array of mxSample StatSample objects */
300 #endif
301 };
302 
303 /* Reclaim memory used by a StatSample
304 */
305 #ifdef SQLITE_ENABLE_STAT4
306 static void sampleClear(sqlite3 *db, StatSample *p){
307   assert( db!=0 );
308   if( p->nRowid ){
309     sqlite3DbFree(db, p->u.aRowid);
310     p->nRowid = 0;
311   }
312 }
313 #endif
314 
315 /* Initialize the BLOB value of a ROWID
316 */
317 #ifdef SQLITE_ENABLE_STAT4
318 static void sampleSetRowid(sqlite3 *db, StatSample *p, int n, const u8 *pData){
319   assert( db!=0 );
320   if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
321   p->u.aRowid = sqlite3DbMallocRawNN(db, n);
322   if( p->u.aRowid ){
323     p->nRowid = n;
324     memcpy(p->u.aRowid, pData, n);
325   }else{
326     p->nRowid = 0;
327   }
328 }
329 #endif
330 
331 /* Initialize the INTEGER value of a ROWID.
332 */
333 #ifdef SQLITE_ENABLE_STAT4
334 static void sampleSetRowidInt64(sqlite3 *db, StatSample *p, i64 iRowid){
335   assert( db!=0 );
336   if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
337   p->nRowid = 0;
338   p->u.iRowid = iRowid;
339 }
340 #endif
341 
342 
343 /*
344 ** Copy the contents of object (*pFrom) into (*pTo).
345 */
346 #ifdef SQLITE_ENABLE_STAT4
347 static void sampleCopy(StatAccum *p, StatSample *pTo, StatSample *pFrom){
348   pTo->isPSample = pFrom->isPSample;
349   pTo->iCol = pFrom->iCol;
350   pTo->iHash = pFrom->iHash;
351   memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
352   memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
353   memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
354   if( pFrom->nRowid ){
355     sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
356   }else{
357     sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
358   }
359 }
360 #endif
361 
362 /*
363 ** Reclaim all memory of a StatAccum structure.
364 */
365 static void statAccumDestructor(void *pOld){
366   StatAccum *p = (StatAccum*)pOld;
367 #ifdef SQLITE_ENABLE_STAT4
368   if( p->mxSample ){
369     int i;
370     for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
371     for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
372     sampleClear(p->db, &p->current);
373   }
374 #endif
375   sqlite3DbFree(p->db, p);
376 }
377 
378 /*
379 ** Implementation of the stat_init(N,K,C,L) SQL function. The four parameters
380 ** are:
381 **     N:    The number of columns in the index including the rowid/pk (note 1)
382 **     K:    The number of columns in the index excluding the rowid/pk.
383 **     C:    Estimated number of rows in the index
384 **     L:    A limit on the number of rows to scan, or 0 for no-limit
385 **
386 ** Note 1:  In the special case of the covering index that implements a
387 ** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
388 ** total number of columns in the table.
389 **
390 ** For indexes on ordinary rowid tables, N==K+1.  But for indexes on
391 ** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
392 ** PRIMARY KEY of the table.  The covering index that implements the
393 ** original WITHOUT ROWID table as N==K as a special case.
394 **
395 ** This routine allocates the StatAccum object in heap memory. The return
396 ** value is a pointer to the StatAccum object.  The datatype of the
397 ** return value is BLOB, but it is really just a pointer to the StatAccum
398 ** object.
399 */
400 static void statInit(
401   sqlite3_context *context,
402   int argc,
403   sqlite3_value **argv
404 ){
405   StatAccum *p;
406   int nCol;                       /* Number of columns in index being sampled */
407   int nKeyCol;                    /* Number of key columns */
408   int nColUp;                     /* nCol rounded up for alignment */
409   int n;                          /* Bytes of space to allocate */
410   sqlite3 *db = sqlite3_context_db_handle(context);   /* Database connection */
411 #ifdef SQLITE_ENABLE_STAT4
412   /* Maximum number of samples.  0 if STAT4 data is not collected */
413   int mxSample = OptimizationEnabled(db,SQLITE_Stat4) ?SQLITE_STAT4_SAMPLES :0;
414 #endif
415 
416   /* Decode the three function arguments */
417   UNUSED_PARAMETER(argc);
418   nCol = sqlite3_value_int(argv[0]);
419   assert( nCol>0 );
420   nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
421   nKeyCol = sqlite3_value_int(argv[1]);
422   assert( nKeyCol<=nCol );
423   assert( nKeyCol>0 );
424 
425   /* Allocate the space required for the StatAccum object */
426   n = sizeof(*p)
427     + sizeof(tRowcnt)*nColUp                  /* StatAccum.anEq */
428     + sizeof(tRowcnt)*nColUp;                 /* StatAccum.anDLt */
429 #ifdef SQLITE_ENABLE_STAT4
430   if( mxSample ){
431     n += sizeof(tRowcnt)*nColUp                  /* StatAccum.anLt */
432       + sizeof(StatSample)*(nCol+mxSample)       /* StatAccum.aBest[], a[] */
433       + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample);
434   }
435 #endif
436   db = sqlite3_context_db_handle(context);
437   p = sqlite3DbMallocZero(db, n);
438   if( p==0 ){
439     sqlite3_result_error_nomem(context);
440     return;
441   }
442 
443   p->db = db;
444   p->nEst = sqlite3_value_int64(argv[2]);
445   p->nRow = 0;
446   p->nLimit = sqlite3_value_int64(argv[3]);
447 #ifdef SQLITE_ENABLE_STAT4
448   /* Disable STAT4 statistics gathering if there is a analysis_limit set */
449   if( p->nLimit>0 ) p->mxSample = 0;
450 #endif
451   p->nCol = nCol;
452   p->nKeyCol = nKeyCol;
453   p->nSkipAhead = 0;
454   p->current.anDLt = (tRowcnt*)&p[1];
455   p->current.anEq = &p->current.anDLt[nColUp];
456 
457 #ifdef SQLITE_ENABLE_STAT4
458   p->mxSample = mxSample;
459   if( mxSample ){
460     u8 *pSpace;                     /* Allocated space not yet assigned */
461     int i;                          /* Used to iterate through p->aSample[] */
462 
463     p->iGet = -1;
464     p->nPSample = (tRowcnt)(p->nEst/(mxSample/3+1) + 1);
465     p->current.anLt = &p->current.anEq[nColUp];
466     p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
467 
468     /* Set up the StatAccum.a[] and aBest[] arrays */
469     p->a = (struct StatSample*)&p->current.anLt[nColUp];
470     p->aBest = &p->a[mxSample];
471     pSpace = (u8*)(&p->a[mxSample+nCol]);
472     for(i=0; i<(mxSample+nCol); i++){
473       p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
474       p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
475       p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
476     }
477     assert( (pSpace - (u8*)p)==n );
478 
479     for(i=0; i<nCol; i++){
480       p->aBest[i].iCol = i;
481     }
482   }
483 #endif
484 
485   /* Return a pointer to the allocated object to the caller.  Note that
486   ** only the pointer (the 2nd parameter) matters.  The size of the object
487   ** (given by the 3rd parameter) is never used and can be any positive
488   ** value. */
489   sqlite3_result_blob(context, p, sizeof(*p), statAccumDestructor);
490 }
491 static const FuncDef statInitFuncdef = {
492   2+IsStat4,       /* nArg */
493   SQLITE_UTF8,     /* funcFlags */
494   0,               /* pUserData */
495   0,               /* pNext */
496   statInit,        /* xSFunc */
497   0,               /* xFinalize */
498   0, 0,            /* xValue, xInverse */
499   "stat_init",     /* zName */
500   {0}
501 };
502 
503 #ifdef SQLITE_ENABLE_STAT4
504 /*
505 ** pNew and pOld are both candidate non-periodic samples selected for
506 ** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
507 ** considering only any trailing columns and the sample hash value, this
508 ** function returns true if sample pNew is to be preferred over pOld.
509 ** In other words, if we assume that the cardinalities of the selected
510 ** column for pNew and pOld are equal, is pNew to be preferred over pOld.
511 **
512 ** This function assumes that for each argument sample, the contents of
513 ** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
514 */
515 static int sampleIsBetterPost(
516   StatAccum *pAccum,
517   StatSample *pNew,
518   StatSample *pOld
519 ){
520   int nCol = pAccum->nCol;
521   int i;
522   assert( pNew->iCol==pOld->iCol );
523   for(i=pNew->iCol+1; i<nCol; i++){
524     if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
525     if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
526   }
527   if( pNew->iHash>pOld->iHash ) return 1;
528   return 0;
529 }
530 #endif
531 
532 #ifdef SQLITE_ENABLE_STAT4
533 /*
534 ** Return true if pNew is to be preferred over pOld.
535 **
536 ** This function assumes that for each argument sample, the contents of
537 ** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
538 */
539 static int sampleIsBetter(
540   StatAccum *pAccum,
541   StatSample *pNew,
542   StatSample *pOld
543 ){
544   tRowcnt nEqNew = pNew->anEq[pNew->iCol];
545   tRowcnt nEqOld = pOld->anEq[pOld->iCol];
546 
547   assert( pOld->isPSample==0 && pNew->isPSample==0 );
548   assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
549 
550   if( (nEqNew>nEqOld) ) return 1;
551   if( nEqNew==nEqOld ){
552     if( pNew->iCol<pOld->iCol ) return 1;
553     return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
554   }
555   return 0;
556 }
557 
558 /*
559 ** Copy the contents of sample *pNew into the p->a[] array. If necessary,
560 ** remove the least desirable sample from p->a[] to make room.
561 */
562 static void sampleInsert(StatAccum *p, StatSample *pNew, int nEqZero){
563   StatSample *pSample = 0;
564   int i;
565 
566   assert( IsStat4 || nEqZero==0 );
567 
568   /* StatAccum.nMaxEqZero is set to the maximum number of leading 0
569   ** values in the anEq[] array of any sample in StatAccum.a[]. In
570   ** other words, if nMaxEqZero is n, then it is guaranteed that there
571   ** are no samples with StatSample.anEq[m]==0 for (m>=n). */
572   if( nEqZero>p->nMaxEqZero ){
573     p->nMaxEqZero = nEqZero;
574   }
575   if( pNew->isPSample==0 ){
576     StatSample *pUpgrade = 0;
577     assert( pNew->anEq[pNew->iCol]>0 );
578 
579     /* This sample is being added because the prefix that ends in column
580     ** iCol occurs many times in the table. However, if we have already
581     ** added a sample that shares this prefix, there is no need to add
582     ** this one. Instead, upgrade the priority of the highest priority
583     ** existing sample that shares this prefix.  */
584     for(i=p->nSample-1; i>=0; i--){
585       StatSample *pOld = &p->a[i];
586       if( pOld->anEq[pNew->iCol]==0 ){
587         if( pOld->isPSample ) return;
588         assert( pOld->iCol>pNew->iCol );
589         assert( sampleIsBetter(p, pNew, pOld) );
590         if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
591           pUpgrade = pOld;
592         }
593       }
594     }
595     if( pUpgrade ){
596       pUpgrade->iCol = pNew->iCol;
597       pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
598       goto find_new_min;
599     }
600   }
601 
602   /* If necessary, remove sample iMin to make room for the new sample. */
603   if( p->nSample>=p->mxSample ){
604     StatSample *pMin = &p->a[p->iMin];
605     tRowcnt *anEq = pMin->anEq;
606     tRowcnt *anLt = pMin->anLt;
607     tRowcnt *anDLt = pMin->anDLt;
608     sampleClear(p->db, pMin);
609     memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
610     pSample = &p->a[p->nSample-1];
611     pSample->nRowid = 0;
612     pSample->anEq = anEq;
613     pSample->anDLt = anDLt;
614     pSample->anLt = anLt;
615     p->nSample = p->mxSample-1;
616   }
617 
618   /* The "rows less-than" for the rowid column must be greater than that
619   ** for the last sample in the p->a[] array. Otherwise, the samples would
620   ** be out of order. */
621   assert( p->nSample==0
622        || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
623 
624   /* Insert the new sample */
625   pSample = &p->a[p->nSample];
626   sampleCopy(p, pSample, pNew);
627   p->nSample++;
628 
629   /* Zero the first nEqZero entries in the anEq[] array. */
630   memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
631 
632 find_new_min:
633   if( p->nSample>=p->mxSample ){
634     int iMin = -1;
635     for(i=0; i<p->mxSample; i++){
636       if( p->a[i].isPSample ) continue;
637       if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
638         iMin = i;
639       }
640     }
641     assert( iMin>=0 );
642     p->iMin = iMin;
643   }
644 }
645 #endif /* SQLITE_ENABLE_STAT4 */
646 
647 #ifdef SQLITE_ENABLE_STAT4
648 /*
649 ** Field iChng of the index being scanned has changed. So at this point
650 ** p->current contains a sample that reflects the previous row of the
651 ** index. The value of anEq[iChng] and subsequent anEq[] elements are
652 ** correct at this point.
653 */
654 static void samplePushPrevious(StatAccum *p, int iChng){
655   int i;
656 
657   /* Check if any samples from the aBest[] array should be pushed
658   ** into IndexSample.a[] at this point.  */
659   for(i=(p->nCol-2); i>=iChng; i--){
660     StatSample *pBest = &p->aBest[i];
661     pBest->anEq[i] = p->current.anEq[i];
662     if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
663       sampleInsert(p, pBest, i);
664     }
665   }
666 
667   /* Check that no sample contains an anEq[] entry with an index of
668   ** p->nMaxEqZero or greater set to zero. */
669   for(i=p->nSample-1; i>=0; i--){
670     int j;
671     for(j=p->nMaxEqZero; j<p->nCol; j++) assert( p->a[i].anEq[j]>0 );
672   }
673 
674   /* Update the anEq[] fields of any samples already collected. */
675   if( iChng<p->nMaxEqZero ){
676     for(i=p->nSample-1; i>=0; i--){
677       int j;
678       for(j=iChng; j<p->nCol; j++){
679         if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
680       }
681     }
682     p->nMaxEqZero = iChng;
683   }
684 }
685 #endif /* SQLITE_ENABLE_STAT4 */
686 
687 /*
688 ** Implementation of the stat_push SQL function:  stat_push(P,C,R)
689 ** Arguments:
690 **
691 **    P     Pointer to the StatAccum object created by stat_init()
692 **    C     Index of left-most column to differ from previous row
693 **    R     Rowid for the current row.  Might be a key record for
694 **          WITHOUT ROWID tables.
695 **
696 ** The purpose of this routine is to collect statistical data and/or
697 ** samples from the index being analyzed into the StatAccum object.
698 ** The stat_get() SQL function will be used afterwards to
699 ** retrieve the information gathered.
700 **
701 ** This SQL function usually returns NULL, but might return an integer
702 ** if it wants the byte-code to do special processing.
703 **
704 ** The R parameter is only used for STAT4
705 */
706 static void statPush(
707   sqlite3_context *context,
708   int argc,
709   sqlite3_value **argv
710 ){
711   int i;
712 
713   /* The three function arguments */
714   StatAccum *p = (StatAccum*)sqlite3_value_blob(argv[0]);
715   int iChng = sqlite3_value_int(argv[1]);
716 
717   UNUSED_PARAMETER( argc );
718   UNUSED_PARAMETER( context );
719   assert( p->nCol>0 );
720   assert( iChng<p->nCol );
721 
722   if( p->nRow==0 ){
723     /* This is the first call to this function. Do initialization. */
724     for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
725   }else{
726     /* Second and subsequent calls get processed here */
727 #ifdef SQLITE_ENABLE_STAT4
728     if( p->mxSample ) samplePushPrevious(p, iChng);
729 #endif
730 
731     /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
732     ** to the current row of the index. */
733     for(i=0; i<iChng; i++){
734       p->current.anEq[i]++;
735     }
736     for(i=iChng; i<p->nCol; i++){
737       p->current.anDLt[i]++;
738 #ifdef SQLITE_ENABLE_STAT4
739       if( p->mxSample ) p->current.anLt[i] += p->current.anEq[i];
740 #endif
741       p->current.anEq[i] = 1;
742     }
743   }
744 
745   p->nRow++;
746 #ifdef SQLITE_ENABLE_STAT4
747   if( p->mxSample ){
748     tRowcnt nLt;
749     if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
750       sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
751     }else{
752       sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
753                                          sqlite3_value_blob(argv[2]));
754     }
755     p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
756 
757     nLt = p->current.anLt[p->nCol-1];
758     /* Check if this is to be a periodic sample. If so, add it. */
759     if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
760       p->current.isPSample = 1;
761       p->current.iCol = 0;
762       sampleInsert(p, &p->current, p->nCol-1);
763       p->current.isPSample = 0;
764     }
765 
766     /* Update the aBest[] array. */
767     for(i=0; i<(p->nCol-1); i++){
768       p->current.iCol = i;
769       if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
770         sampleCopy(p, &p->aBest[i], &p->current);
771       }
772     }
773   }else
774 #endif
775   if( p->nLimit && p->nRow>p->nLimit*(p->nSkipAhead+1) ){
776     p->nSkipAhead++;
777     sqlite3_result_int(context, p->current.anDLt[0]>0);
778   }
779 }
780 
781 static const FuncDef statPushFuncdef = {
782   2+IsStat4,       /* nArg */
783   SQLITE_UTF8,     /* funcFlags */
784   0,               /* pUserData */
785   0,               /* pNext */
786   statPush,        /* xSFunc */
787   0,               /* xFinalize */
788   0, 0,            /* xValue, xInverse */
789   "stat_push",     /* zName */
790   {0}
791 };
792 
793 #define STAT_GET_STAT1 0          /* "stat" column of stat1 table */
794 #define STAT_GET_ROWID 1          /* "rowid" column of stat[34] entry */
795 #define STAT_GET_NEQ   2          /* "neq" column of stat[34] entry */
796 #define STAT_GET_NLT   3          /* "nlt" column of stat[34] entry */
797 #define STAT_GET_NDLT  4          /* "ndlt" column of stat[34] entry */
798 
799 /*
800 ** Implementation of the stat_get(P,J) SQL function.  This routine is
801 ** used to query statistical information that has been gathered into
802 ** the StatAccum object by prior calls to stat_push().  The P parameter
803 ** has type BLOB but it is really just a pointer to the StatAccum object.
804 ** The content to returned is determined by the parameter J
805 ** which is one of the STAT_GET_xxxx values defined above.
806 **
807 ** The stat_get(P,J) function is not available to generic SQL.  It is
808 ** inserted as part of a manually constructed bytecode program.  (See
809 ** the callStatGet() routine below.)  It is guaranteed that the P
810 ** parameter will always be a pointer to a StatAccum object, never a
811 ** NULL.
812 **
813 ** If STAT4 is not enabled, then J is always
814 ** STAT_GET_STAT1 and is hence omitted and this routine becomes
815 ** a one-parameter function, stat_get(P), that always returns the
816 ** stat1 table entry information.
817 */
818 static void statGet(
819   sqlite3_context *context,
820   int argc,
821   sqlite3_value **argv
822 ){
823   StatAccum *p = (StatAccum*)sqlite3_value_blob(argv[0]);
824 #ifdef SQLITE_ENABLE_STAT4
825   /* STAT4 has a parameter on this routine. */
826   int eCall = sqlite3_value_int(argv[1]);
827   assert( argc==2 );
828   assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
829        || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
830        || eCall==STAT_GET_NDLT
831   );
832   assert( eCall==STAT_GET_STAT1 || p->mxSample );
833   if( eCall==STAT_GET_STAT1 )
834 #else
835   assert( argc==1 );
836 #endif
837   {
838     /* Return the value to store in the "stat" column of the sqlite_stat1
839     ** table for this index.
840     **
841     ** The value is a string composed of a list of integers describing
842     ** the index. The first integer in the list is the total number of
843     ** entries in the index. There is one additional integer in the list
844     ** for each indexed column. This additional integer is an estimate of
845     ** the number of rows matched by a equality query on the index using
846     ** a key with the corresponding number of fields. In other words,
847     ** if the index is on columns (a,b) and the sqlite_stat1 value is
848     ** "100 10 2", then SQLite estimates that:
849     **
850     **   * the index contains 100 rows,
851     **   * "WHERE a=?" matches 10 rows, and
852     **   * "WHERE a=? AND b=?" matches 2 rows.
853     **
854     ** If D is the count of distinct values and K is the total number of
855     ** rows, then each estimate is computed as:
856     **
857     **        I = (K+D-1)/D
858     */
859     char *z;
860     int i;
861 
862     char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
863     if( zRet==0 ){
864       sqlite3_result_error_nomem(context);
865       return;
866     }
867 
868     sqlite3_snprintf(24, zRet, "%llu",
869         p->nSkipAhead ? (u64)p->nEst : (u64)p->nRow);
870     z = zRet + sqlite3Strlen30(zRet);
871     for(i=0; i<p->nKeyCol; i++){
872       u64 nDistinct = p->current.anDLt[i] + 1;
873       u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
874       sqlite3_snprintf(24, z, " %llu", iVal);
875       z += sqlite3Strlen30(z);
876       assert( p->current.anEq[i] );
877     }
878     assert( z[0]=='\0' && z>zRet );
879 
880     sqlite3_result_text(context, zRet, -1, sqlite3_free);
881   }
882 #ifdef SQLITE_ENABLE_STAT4
883   else if( eCall==STAT_GET_ROWID ){
884     if( p->iGet<0 ){
885       samplePushPrevious(p, 0);
886       p->iGet = 0;
887     }
888     if( p->iGet<p->nSample ){
889       StatSample *pS = p->a + p->iGet;
890       if( pS->nRowid==0 ){
891         sqlite3_result_int64(context, pS->u.iRowid);
892       }else{
893         sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
894                             SQLITE_TRANSIENT);
895       }
896     }
897   }else{
898     tRowcnt *aCnt = 0;
899 
900     assert( p->iGet<p->nSample );
901     switch( eCall ){
902       case STAT_GET_NEQ:  aCnt = p->a[p->iGet].anEq; break;
903       case STAT_GET_NLT:  aCnt = p->a[p->iGet].anLt; break;
904       default: {
905         aCnt = p->a[p->iGet].anDLt;
906         p->iGet++;
907         break;
908       }
909     }
910 
911     {
912       char *zRet = sqlite3MallocZero(p->nCol * 25);
913       if( zRet==0 ){
914         sqlite3_result_error_nomem(context);
915       }else{
916         int i;
917         char *z = zRet;
918         for(i=0; i<p->nCol; i++){
919           sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
920           z += sqlite3Strlen30(z);
921         }
922         assert( z[0]=='\0' && z>zRet );
923         z[-1] = '\0';
924         sqlite3_result_text(context, zRet, -1, sqlite3_free);
925       }
926     }
927   }
928 #endif /* SQLITE_ENABLE_STAT4 */
929 #ifndef SQLITE_DEBUG
930   UNUSED_PARAMETER( argc );
931 #endif
932 }
933 static const FuncDef statGetFuncdef = {
934   1+IsStat4,       /* nArg */
935   SQLITE_UTF8,     /* funcFlags */
936   0,               /* pUserData */
937   0,               /* pNext */
938   statGet,         /* xSFunc */
939   0,               /* xFinalize */
940   0, 0,            /* xValue, xInverse */
941   "stat_get",      /* zName */
942   {0}
943 };
944 
945 static void callStatGet(Parse *pParse, int regStat, int iParam, int regOut){
946 #ifdef SQLITE_ENABLE_STAT4
947   sqlite3VdbeAddOp2(pParse->pVdbe, OP_Integer, iParam, regStat+1);
948 #elif SQLITE_DEBUG
949   assert( iParam==STAT_GET_STAT1 );
950 #else
951   UNUSED_PARAMETER( iParam );
952 #endif
953   assert( regOut!=regStat && regOut!=regStat+1 );
954   sqlite3VdbeAddFunctionCall(pParse, 0, regStat, regOut, 1+IsStat4,
955                              &statGetFuncdef, 0);
956 }
957 
958 /*
959 ** Generate code to do an analysis of all indices associated with
960 ** a single table.
961 */
962 static void analyzeOneTable(
963   Parse *pParse,   /* Parser context */
964   Table *pTab,     /* Table whose indices are to be analyzed */
965   Index *pOnlyIdx, /* If not NULL, only analyze this one index */
966   int iStatCur,    /* Index of VdbeCursor that writes the sqlite_stat1 table */
967   int iMem,        /* Available memory locations begin here */
968   int iTab         /* Next available cursor */
969 ){
970   sqlite3 *db = pParse->db;    /* Database handle */
971   Index *pIdx;                 /* An index to being analyzed */
972   int iIdxCur;                 /* Cursor open on index being analyzed */
973   int iTabCur;                 /* Table cursor */
974   Vdbe *v;                     /* The virtual machine being built up */
975   int i;                       /* Loop counter */
976   int jZeroRows = -1;          /* Jump from here if number of rows is zero */
977   int iDb;                     /* Index of database containing pTab */
978   u8 needTableCnt = 1;         /* True to count the table */
979   int regNewRowid = iMem++;    /* Rowid for the inserted record */
980   int regStat = iMem++;        /* Register to hold StatAccum object */
981   int regChng = iMem++;        /* Index of changed index field */
982   int regRowid = iMem++;       /* Rowid argument passed to stat_push() */
983   int regTemp = iMem++;        /* Temporary use register */
984   int regTemp2 = iMem++;       /* Second temporary use register */
985   int regTabname = iMem++;     /* Register containing table name */
986   int regIdxname = iMem++;     /* Register containing index name */
987   int regStat1 = iMem++;       /* Value for the stat column of sqlite_stat1 */
988   int regPrev = iMem;          /* MUST BE LAST (see below) */
989 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
990   Table *pStat1 = 0;
991 #endif
992 
993   pParse->nMem = MAX(pParse->nMem, iMem);
994   v = sqlite3GetVdbe(pParse);
995   if( v==0 || NEVER(pTab==0) ){
996     return;
997   }
998   if( pTab->tnum==0 ){
999     /* Do not gather statistics on views or virtual tables */
1000     return;
1001   }
1002   if( sqlite3_strlike("sqlite\\_%", pTab->zName, '\\')==0 ){
1003     /* Do not gather statistics on system tables */
1004     return;
1005   }
1006   assert( sqlite3BtreeHoldsAllMutexes(db) );
1007   iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1008   assert( iDb>=0 );
1009   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1010 #ifndef SQLITE_OMIT_AUTHORIZATION
1011   if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
1012       db->aDb[iDb].zDbSName ) ){
1013     return;
1014   }
1015 #endif
1016 
1017 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1018   if( db->xPreUpdateCallback ){
1019     pStat1 = (Table*)sqlite3DbMallocZero(db, sizeof(Table) + 13);
1020     if( pStat1==0 ) return;
1021     pStat1->zName = (char*)&pStat1[1];
1022     memcpy(pStat1->zName, "sqlite_stat1", 13);
1023     pStat1->nCol = 3;
1024     pStat1->iPKey = -1;
1025     sqlite3VdbeAddOp4(pParse->pVdbe, OP_Noop, 0, 0, 0,(char*)pStat1,P4_DYNBLOB);
1026   }
1027 #endif
1028 
1029   /* Establish a read-lock on the table at the shared-cache level.
1030   ** Open a read-only cursor on the table. Also allocate a cursor number
1031   ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1032   ** this time though.  */
1033   sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
1034   iTabCur = iTab++;
1035   iIdxCur = iTab++;
1036   pParse->nTab = MAX(pParse->nTab, iTab);
1037   sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
1038   sqlite3VdbeLoadString(v, regTabname, pTab->zName);
1039 
1040   for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1041     int nCol;                     /* Number of columns in pIdx. "N" */
1042     int addrRewind;               /* Address of "OP_Rewind iIdxCur" */
1043     int addrNextRow;              /* Address of "next_row:" */
1044     const char *zIdxName;         /* Name of the index */
1045     int nColTest;                 /* Number of columns to test for changes */
1046 
1047     if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
1048     if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
1049     if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
1050       nCol = pIdx->nKeyCol;
1051       zIdxName = pTab->zName;
1052       nColTest = nCol - 1;
1053     }else{
1054       nCol = pIdx->nColumn;
1055       zIdxName = pIdx->zName;
1056       nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
1057     }
1058 
1059     /* Populate the register containing the index name. */
1060     sqlite3VdbeLoadString(v, regIdxname, zIdxName);
1061     VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
1062 
1063     /*
1064     ** Pseudo-code for loop that calls stat_push():
1065     **
1066     **   Rewind csr
1067     **   if eof(csr) goto end_of_scan;
1068     **   regChng = 0
1069     **   goto chng_addr_0;
1070     **
1071     **  next_row:
1072     **   regChng = 0
1073     **   if( idx(0) != regPrev(0) ) goto chng_addr_0
1074     **   regChng = 1
1075     **   if( idx(1) != regPrev(1) ) goto chng_addr_1
1076     **   ...
1077     **   regChng = N
1078     **   goto chng_addr_N
1079     **
1080     **  chng_addr_0:
1081     **   regPrev(0) = idx(0)
1082     **  chng_addr_1:
1083     **   regPrev(1) = idx(1)
1084     **  ...
1085     **
1086     **  endDistinctTest:
1087     **   regRowid = idx(rowid)
1088     **   stat_push(P, regChng, regRowid)
1089     **   Next csr
1090     **   if !eof(csr) goto next_row;
1091     **
1092     **  end_of_scan:
1093     */
1094 
1095     /* Make sure there are enough memory cells allocated to accommodate
1096     ** the regPrev array and a trailing rowid (the rowid slot is required
1097     ** when building a record to insert into the sample column of
1098     ** the sqlite_stat4 table.  */
1099     pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
1100 
1101     /* Open a read-only cursor on the index being analyzed. */
1102     assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
1103     sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
1104     sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1105     VdbeComment((v, "%s", pIdx->zName));
1106 
1107     /* Invoke the stat_init() function. The arguments are:
1108     **
1109     **    (1) the number of columns in the index including the rowid
1110     **        (or for a WITHOUT ROWID table, the number of PK columns),
1111     **    (2) the number of columns in the key without the rowid/pk
1112     **    (3) estimated number of rows in the index,
1113     */
1114     sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat+1);
1115     assert( regRowid==regStat+2 );
1116     sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regRowid);
1117 #ifdef SQLITE_ENABLE_STAT4
1118     if( OptimizationEnabled(db, SQLITE_Stat4) ){
1119       sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regTemp);
1120       addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
1121       VdbeCoverage(v);
1122     }else
1123 #endif
1124     {
1125       addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
1126       VdbeCoverage(v);
1127       sqlite3VdbeAddOp3(v, OP_Count, iIdxCur, regTemp, 1);
1128     }
1129     assert( regTemp2==regStat+4 );
1130     sqlite3VdbeAddOp2(v, OP_Integer, db->nAnalysisLimit, regTemp2);
1131     sqlite3VdbeAddFunctionCall(pParse, 0, regStat+1, regStat, 4,
1132                                &statInitFuncdef, 0);
1133 
1134     /* Implementation of the following:
1135     **
1136     **   Rewind csr
1137     **   if eof(csr) goto end_of_scan;
1138     **   regChng = 0
1139     **   goto next_push_0;
1140     **
1141     */
1142     sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
1143     addrNextRow = sqlite3VdbeCurrentAddr(v);
1144 
1145     if( nColTest>0 ){
1146       int endDistinctTest = sqlite3VdbeMakeLabel(pParse);
1147       int *aGotoChng;               /* Array of jump instruction addresses */
1148       aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
1149       if( aGotoChng==0 ) continue;
1150 
1151       /*
1152       **  next_row:
1153       **   regChng = 0
1154       **   if( idx(0) != regPrev(0) ) goto chng_addr_0
1155       **   regChng = 1
1156       **   if( idx(1) != regPrev(1) ) goto chng_addr_1
1157       **   ...
1158       **   regChng = N
1159       **   goto endDistinctTest
1160       */
1161       sqlite3VdbeAddOp0(v, OP_Goto);
1162       addrNextRow = sqlite3VdbeCurrentAddr(v);
1163       if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
1164         /* For a single-column UNIQUE index, once we have found a non-NULL
1165         ** row, we know that all the rest will be distinct, so skip
1166         ** subsequent distinctness tests. */
1167         sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
1168         VdbeCoverage(v);
1169       }
1170       for(i=0; i<nColTest; i++){
1171         char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
1172         sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
1173         sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
1174         VdbeComment((v, "%s.column(%d)", pIdx->zName, i));
1175         aGotoChng[i] =
1176         sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
1177         sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
1178         VdbeCoverage(v);
1179       }
1180       sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
1181       sqlite3VdbeGoto(v, endDistinctTest);
1182 
1183 
1184       /*
1185       **  chng_addr_0:
1186       **   regPrev(0) = idx(0)
1187       **  chng_addr_1:
1188       **   regPrev(1) = idx(1)
1189       **  ...
1190       */
1191       sqlite3VdbeJumpHere(v, addrNextRow-1);
1192       for(i=0; i<nColTest; i++){
1193         sqlite3VdbeJumpHere(v, aGotoChng[i]);
1194         sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
1195         VdbeComment((v, "%s.column(%d)", pIdx->zName, i));
1196       }
1197       sqlite3VdbeResolveLabel(v, endDistinctTest);
1198       sqlite3DbFree(db, aGotoChng);
1199     }
1200 
1201     /*
1202     **  chng_addr_N:
1203     **   regRowid = idx(rowid)            // STAT4 only
1204     **   stat_push(P, regChng, regRowid)  // 3rd parameter STAT4 only
1205     **   Next csr
1206     **   if !eof(csr) goto next_row;
1207     */
1208 #ifdef SQLITE_ENABLE_STAT4
1209     if( OptimizationEnabled(db, SQLITE_Stat4) ){
1210       assert( regRowid==(regStat+2) );
1211       if( HasRowid(pTab) ){
1212         sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
1213       }else{
1214         Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1215         int j, k, regKey;
1216         regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1217         for(j=0; j<pPk->nKeyCol; j++){
1218           k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
1219           assert( k>=0 && k<pIdx->nColumn );
1220           sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
1221           VdbeComment((v, "%s.column(%d)", pIdx->zName, i));
1222         }
1223         sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
1224         sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
1225       }
1226     }
1227 #endif
1228     assert( regChng==(regStat+1) );
1229     {
1230       sqlite3VdbeAddFunctionCall(pParse, 1, regStat, regTemp, 2+IsStat4,
1231                                  &statPushFuncdef, 0);
1232       if( db->nAnalysisLimit ){
1233         int j1, j2, j3;
1234         j1 = sqlite3VdbeAddOp1(v, OP_IsNull, regTemp); VdbeCoverage(v);
1235         j2 = sqlite3VdbeAddOp1(v, OP_If, regTemp); VdbeCoverage(v);
1236         j3 = sqlite3VdbeAddOp4Int(v, OP_SeekGT, iIdxCur, 0, regPrev, 1);
1237         sqlite3VdbeJumpHere(v, j1);
1238         sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
1239         sqlite3VdbeJumpHere(v, j2);
1240         sqlite3VdbeJumpHere(v, j3);
1241       }else{
1242         sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
1243       }
1244     }
1245 
1246     /* Add the entry to the stat1 table. */
1247     callStatGet(pParse, regStat, STAT_GET_STAT1, regStat1);
1248     assert( "BBB"[0]==SQLITE_AFF_TEXT );
1249     sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
1250     sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
1251     sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
1252 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1253     sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1254 #endif
1255     sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1256 
1257     /* Add the entries to the stat4 table. */
1258 #ifdef SQLITE_ENABLE_STAT4
1259     if( OptimizationEnabled(db, SQLITE_Stat4) ){
1260       int regEq = regStat1;
1261       int regLt = regStat1+1;
1262       int regDLt = regStat1+2;
1263       int regSample = regStat1+3;
1264       int regCol = regStat1+4;
1265       int regSampleRowid = regCol + nCol;
1266       int addrNext;
1267       int addrIsNull;
1268       u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
1269 
1270       pParse->nMem = MAX(pParse->nMem, regCol+nCol);
1271 
1272       addrNext = sqlite3VdbeCurrentAddr(v);
1273       callStatGet(pParse, regStat, STAT_GET_ROWID, regSampleRowid);
1274       addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
1275       VdbeCoverage(v);
1276       callStatGet(pParse, regStat, STAT_GET_NEQ, regEq);
1277       callStatGet(pParse, regStat, STAT_GET_NLT, regLt);
1278       callStatGet(pParse, regStat, STAT_GET_NDLT, regDLt);
1279       sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
1280       VdbeCoverage(v);
1281       for(i=0; i<nCol; i++){
1282         sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
1283       }
1284       sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
1285       sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
1286       sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
1287       sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
1288       sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
1289       sqlite3VdbeJumpHere(v, addrIsNull);
1290     }
1291 #endif /* SQLITE_ENABLE_STAT4 */
1292 
1293     /* End of analysis */
1294     sqlite3VdbeJumpHere(v, addrRewind);
1295   }
1296 
1297 
1298   /* Create a single sqlite_stat1 entry containing NULL as the index
1299   ** name and the row count as the content.
1300   */
1301   if( pOnlyIdx==0 && needTableCnt ){
1302     VdbeComment((v, "%s", pTab->zName));
1303     sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
1304     jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
1305     sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
1306     assert( "BBB"[0]==SQLITE_AFF_TEXT );
1307     sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
1308     sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
1309     sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
1310     sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1311 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1312     sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1313 #endif
1314     sqlite3VdbeJumpHere(v, jZeroRows);
1315   }
1316 }
1317 
1318 
1319 /*
1320 ** Generate code that will cause the most recent index analysis to
1321 ** be loaded into internal hash tables where is can be used.
1322 */
1323 static void loadAnalysis(Parse *pParse, int iDb){
1324   Vdbe *v = sqlite3GetVdbe(pParse);
1325   if( v ){
1326     sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
1327   }
1328 }
1329 
1330 /*
1331 ** Generate code that will do an analysis of an entire database
1332 */
1333 static void analyzeDatabase(Parse *pParse, int iDb){
1334   sqlite3 *db = pParse->db;
1335   Schema *pSchema = db->aDb[iDb].pSchema;    /* Schema of database iDb */
1336   HashElem *k;
1337   int iStatCur;
1338   int iMem;
1339   int iTab;
1340 
1341   sqlite3BeginWriteOperation(pParse, 0, iDb);
1342   iStatCur = pParse->nTab;
1343   pParse->nTab += 3;
1344   openStatTable(pParse, iDb, iStatCur, 0, 0);
1345   iMem = pParse->nMem+1;
1346   iTab = pParse->nTab;
1347   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1348   for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
1349     Table *pTab = (Table*)sqliteHashData(k);
1350     analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
1351   }
1352   loadAnalysis(pParse, iDb);
1353 }
1354 
1355 /*
1356 ** Generate code that will do an analysis of a single table in
1357 ** a database.  If pOnlyIdx is not NULL then it is a single index
1358 ** in pTab that should be analyzed.
1359 */
1360 static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
1361   int iDb;
1362   int iStatCur;
1363 
1364   assert( pTab!=0 );
1365   assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
1366   iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1367   sqlite3BeginWriteOperation(pParse, 0, iDb);
1368   iStatCur = pParse->nTab;
1369   pParse->nTab += 3;
1370   if( pOnlyIdx ){
1371     openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
1372   }else{
1373     openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
1374   }
1375   analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
1376   loadAnalysis(pParse, iDb);
1377 }
1378 
1379 /*
1380 ** Generate code for the ANALYZE command.  The parser calls this routine
1381 ** when it recognizes an ANALYZE command.
1382 **
1383 **        ANALYZE                            -- 1
1384 **        ANALYZE  <database>                -- 2
1385 **        ANALYZE  ?<database>.?<tablename>  -- 3
1386 **
1387 ** Form 1 causes all indices in all attached databases to be analyzed.
1388 ** Form 2 analyzes all indices the single database named.
1389 ** Form 3 analyzes all indices associated with the named table.
1390 */
1391 void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
1392   sqlite3 *db = pParse->db;
1393   int iDb;
1394   int i;
1395   char *z, *zDb;
1396   Table *pTab;
1397   Index *pIdx;
1398   Token *pTableName;
1399   Vdbe *v;
1400 
1401   /* Read the database schema. If an error occurs, leave an error message
1402   ** and code in pParse and return NULL. */
1403   assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
1404   if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1405     return;
1406   }
1407 
1408   assert( pName2!=0 || pName1==0 );
1409   if( pName1==0 ){
1410     /* Form 1:  Analyze everything */
1411     for(i=0; i<db->nDb; i++){
1412       if( i==1 ) continue;  /* Do not analyze the TEMP database */
1413       analyzeDatabase(pParse, i);
1414     }
1415   }else if( pName2->n==0 && (iDb = sqlite3FindDb(db, pName1))>=0 ){
1416     /* Analyze the schema named as the argument */
1417     analyzeDatabase(pParse, iDb);
1418   }else{
1419     /* Form 3: Analyze the table or index named as an argument */
1420     iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
1421     if( iDb>=0 ){
1422       zDb = pName2->n ? db->aDb[iDb].zDbSName : 0;
1423       z = sqlite3NameFromToken(db, pTableName);
1424       if( z ){
1425         if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
1426           analyzeTable(pParse, pIdx->pTable, pIdx);
1427         }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
1428           analyzeTable(pParse, pTab, 0);
1429         }
1430         sqlite3DbFree(db, z);
1431       }
1432     }
1433   }
1434   if( db->nSqlExec==0 && (v = sqlite3GetVdbe(pParse))!=0 ){
1435     sqlite3VdbeAddOp0(v, OP_Expire);
1436   }
1437 }
1438 
1439 /*
1440 ** Used to pass information from the analyzer reader through to the
1441 ** callback routine.
1442 */
1443 typedef struct analysisInfo analysisInfo;
1444 struct analysisInfo {
1445   sqlite3 *db;
1446   const char *zDatabase;
1447 };
1448 
1449 /*
1450 ** The first argument points to a nul-terminated string containing a
1451 ** list of space separated integers. Read the first nOut of these into
1452 ** the array aOut[].
1453 */
1454 static void decodeIntArray(
1455   char *zIntArray,       /* String containing int array to decode */
1456   int nOut,              /* Number of slots in aOut[] */
1457   tRowcnt *aOut,         /* Store integers here */
1458   LogEst *aLog,          /* Or, if aOut==0, here */
1459   Index *pIndex          /* Handle extra flags for this index, if not NULL */
1460 ){
1461   char *z = zIntArray;
1462   int c;
1463   int i;
1464   tRowcnt v;
1465 
1466 #ifdef SQLITE_ENABLE_STAT4
1467   if( z==0 ) z = "";
1468 #else
1469   assert( z!=0 );
1470 #endif
1471   for(i=0; *z && i<nOut; i++){
1472     v = 0;
1473     while( (c=z[0])>='0' && c<='9' ){
1474       v = v*10 + c - '0';
1475       z++;
1476     }
1477 #ifdef SQLITE_ENABLE_STAT4
1478     if( aOut ) aOut[i] = v;
1479     if( aLog ) aLog[i] = sqlite3LogEst(v);
1480 #else
1481     assert( aOut==0 );
1482     UNUSED_PARAMETER(aOut);
1483     assert( aLog!=0 );
1484     aLog[i] = sqlite3LogEst(v);
1485 #endif
1486     if( *z==' ' ) z++;
1487   }
1488 #ifndef SQLITE_ENABLE_STAT4
1489   assert( pIndex!=0 ); {
1490 #else
1491   if( pIndex ){
1492 #endif
1493     pIndex->bUnordered = 0;
1494     pIndex->noSkipScan = 0;
1495     while( z[0] ){
1496       if( sqlite3_strglob("unordered*", z)==0 ){
1497         pIndex->bUnordered = 1;
1498       }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
1499         int sz = sqlite3Atoi(z+3);
1500         if( sz<2 ) sz = 2;
1501         pIndex->szIdxRow = sqlite3LogEst(sz);
1502       }else if( sqlite3_strglob("noskipscan*", z)==0 ){
1503         pIndex->noSkipScan = 1;
1504       }
1505 #ifdef SQLITE_ENABLE_COSTMULT
1506       else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
1507         pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
1508       }
1509 #endif
1510       while( z[0]!=0 && z[0]!=' ' ) z++;
1511       while( z[0]==' ' ) z++;
1512     }
1513   }
1514 }
1515 
1516 /*
1517 ** This callback is invoked once for each index when reading the
1518 ** sqlite_stat1 table.
1519 **
1520 **     argv[0] = name of the table
1521 **     argv[1] = name of the index (might be NULL)
1522 **     argv[2] = results of analysis - on integer for each column
1523 **
1524 ** Entries for which argv[1]==NULL simply record the number of rows in
1525 ** the table.
1526 */
1527 static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
1528   analysisInfo *pInfo = (analysisInfo*)pData;
1529   Index *pIndex;
1530   Table *pTable;
1531   const char *z;
1532 
1533   assert( argc==3 );
1534   UNUSED_PARAMETER2(NotUsed, argc);
1535 
1536   if( argv==0 || argv[0]==0 || argv[2]==0 ){
1537     return 0;
1538   }
1539   pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
1540   if( pTable==0 ){
1541     return 0;
1542   }
1543   if( argv[1]==0 ){
1544     pIndex = 0;
1545   }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
1546     pIndex = sqlite3PrimaryKeyIndex(pTable);
1547   }else{
1548     pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
1549   }
1550   z = argv[2];
1551 
1552   if( pIndex ){
1553     tRowcnt *aiRowEst = 0;
1554     int nCol = pIndex->nKeyCol+1;
1555 #ifdef SQLITE_ENABLE_STAT4
1556     /* Index.aiRowEst may already be set here if there are duplicate
1557     ** sqlite_stat1 entries for this index. In that case just clobber
1558     ** the old data with the new instead of allocating a new array.  */
1559     if( pIndex->aiRowEst==0 ){
1560       pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
1561       if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
1562     }
1563     aiRowEst = pIndex->aiRowEst;
1564 #endif
1565     pIndex->bUnordered = 0;
1566     decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
1567     pIndex->hasStat1 = 1;
1568     if( pIndex->pPartIdxWhere==0 ){
1569       pTable->nRowLogEst = pIndex->aiRowLogEst[0];
1570       pTable->tabFlags |= TF_HasStat1;
1571     }
1572   }else{
1573     Index fakeIdx;
1574     fakeIdx.szIdxRow = pTable->szTabRow;
1575 #ifdef SQLITE_ENABLE_COSTMULT
1576     fakeIdx.pTable = pTable;
1577 #endif
1578     decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
1579     pTable->szTabRow = fakeIdx.szIdxRow;
1580     pTable->tabFlags |= TF_HasStat1;
1581   }
1582 
1583   return 0;
1584 }
1585 
1586 /*
1587 ** If the Index.aSample variable is not NULL, delete the aSample[] array
1588 ** and its contents.
1589 */
1590 void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
1591 #ifdef SQLITE_ENABLE_STAT4
1592   if( pIdx->aSample ){
1593     int j;
1594     for(j=0; j<pIdx->nSample; j++){
1595       IndexSample *p = &pIdx->aSample[j];
1596       sqlite3DbFree(db, p->p);
1597     }
1598     sqlite3DbFree(db, pIdx->aSample);
1599   }
1600   if( db && db->pnBytesFreed==0 ){
1601     pIdx->nSample = 0;
1602     pIdx->aSample = 0;
1603   }
1604 #else
1605   UNUSED_PARAMETER(db);
1606   UNUSED_PARAMETER(pIdx);
1607 #endif /* SQLITE_ENABLE_STAT4 */
1608 }
1609 
1610 #ifdef SQLITE_ENABLE_STAT4
1611 /*
1612 ** Populate the pIdx->aAvgEq[] array based on the samples currently
1613 ** stored in pIdx->aSample[].
1614 */
1615 static void initAvgEq(Index *pIdx){
1616   if( pIdx ){
1617     IndexSample *aSample = pIdx->aSample;
1618     IndexSample *pFinal = &aSample[pIdx->nSample-1];
1619     int iCol;
1620     int nCol = 1;
1621     if( pIdx->nSampleCol>1 ){
1622       /* If this is stat4 data, then calculate aAvgEq[] values for all
1623       ** sample columns except the last. The last is always set to 1, as
1624       ** once the trailing PK fields are considered all index keys are
1625       ** unique.  */
1626       nCol = pIdx->nSampleCol-1;
1627       pIdx->aAvgEq[nCol] = 1;
1628     }
1629     for(iCol=0; iCol<nCol; iCol++){
1630       int nSample = pIdx->nSample;
1631       int i;                    /* Used to iterate through samples */
1632       tRowcnt sumEq = 0;        /* Sum of the nEq values */
1633       tRowcnt avgEq = 0;
1634       tRowcnt nRow;             /* Number of rows in index */
1635       i64 nSum100 = 0;          /* Number of terms contributing to sumEq */
1636       i64 nDist100;             /* Number of distinct values in index */
1637 
1638       if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
1639         nRow = pFinal->anLt[iCol];
1640         nDist100 = (i64)100 * pFinal->anDLt[iCol];
1641         nSample--;
1642       }else{
1643         nRow = pIdx->aiRowEst[0];
1644         nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
1645       }
1646       pIdx->nRowEst0 = nRow;
1647 
1648       /* Set nSum to the number of distinct (iCol+1) field prefixes that
1649       ** occur in the stat4 table for this index. Set sumEq to the sum of
1650       ** the nEq values for column iCol for the same set (adding the value
1651       ** only once where there exist duplicate prefixes).  */
1652       for(i=0; i<nSample; i++){
1653         if( i==(pIdx->nSample-1)
1654          || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
1655         ){
1656           sumEq += aSample[i].anEq[iCol];
1657           nSum100 += 100;
1658         }
1659       }
1660 
1661       if( nDist100>nSum100 && sumEq<nRow ){
1662         avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
1663       }
1664       if( avgEq==0 ) avgEq = 1;
1665       pIdx->aAvgEq[iCol] = avgEq;
1666     }
1667   }
1668 }
1669 
1670 /*
1671 ** Look up an index by name.  Or, if the name of a WITHOUT ROWID table
1672 ** is supplied instead, find the PRIMARY KEY index for that table.
1673 */
1674 static Index *findIndexOrPrimaryKey(
1675   sqlite3 *db,
1676   const char *zName,
1677   const char *zDb
1678 ){
1679   Index *pIdx = sqlite3FindIndex(db, zName, zDb);
1680   if( pIdx==0 ){
1681     Table *pTab = sqlite3FindTable(db, zName, zDb);
1682     if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
1683   }
1684   return pIdx;
1685 }
1686 
1687 /*
1688 ** Load the content from either the sqlite_stat4
1689 ** into the relevant Index.aSample[] arrays.
1690 **
1691 ** Arguments zSql1 and zSql2 must point to SQL statements that return
1692 ** data equivalent to the following:
1693 **
1694 **    zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1695 **    zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1696 **
1697 ** where %Q is replaced with the database name before the SQL is executed.
1698 */
1699 static int loadStatTbl(
1700   sqlite3 *db,                  /* Database handle */
1701   const char *zSql1,            /* SQL statement 1 (see above) */
1702   const char *zSql2,            /* SQL statement 2 (see above) */
1703   const char *zDb               /* Database name (e.g. "main") */
1704 ){
1705   int rc;                       /* Result codes from subroutines */
1706   sqlite3_stmt *pStmt = 0;      /* An SQL statement being run */
1707   char *zSql;                   /* Text of the SQL statement */
1708   Index *pPrevIdx = 0;          /* Previous index in the loop */
1709   IndexSample *pSample;         /* A slot in pIdx->aSample[] */
1710 
1711   assert( db->lookaside.bDisable );
1712   zSql = sqlite3MPrintf(db, zSql1, zDb);
1713   if( !zSql ){
1714     return SQLITE_NOMEM_BKPT;
1715   }
1716   rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1717   sqlite3DbFree(db, zSql);
1718   if( rc ) return rc;
1719 
1720   while( sqlite3_step(pStmt)==SQLITE_ROW ){
1721     int nIdxCol = 1;              /* Number of columns in stat4 records */
1722 
1723     char *zIndex;   /* Index name */
1724     Index *pIdx;    /* Pointer to the index object */
1725     int nSample;    /* Number of samples */
1726     int nByte;      /* Bytes of space required */
1727     int i;          /* Bytes of space required */
1728     tRowcnt *pSpace;
1729 
1730     zIndex = (char *)sqlite3_column_text(pStmt, 0);
1731     if( zIndex==0 ) continue;
1732     nSample = sqlite3_column_int(pStmt, 1);
1733     pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
1734     assert( pIdx==0 || pIdx->nSample==0 );
1735     if( pIdx==0 ) continue;
1736     assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
1737     if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
1738       nIdxCol = pIdx->nKeyCol;
1739     }else{
1740       nIdxCol = pIdx->nColumn;
1741     }
1742     pIdx->nSampleCol = nIdxCol;
1743     nByte = sizeof(IndexSample) * nSample;
1744     nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
1745     nByte += nIdxCol * sizeof(tRowcnt);     /* Space for Index.aAvgEq[] */
1746 
1747     pIdx->aSample = sqlite3DbMallocZero(db, nByte);
1748     if( pIdx->aSample==0 ){
1749       sqlite3_finalize(pStmt);
1750       return SQLITE_NOMEM_BKPT;
1751     }
1752     pSpace = (tRowcnt*)&pIdx->aSample[nSample];
1753     pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
1754     for(i=0; i<nSample; i++){
1755       pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
1756       pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
1757       pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
1758     }
1759     assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
1760   }
1761   rc = sqlite3_finalize(pStmt);
1762   if( rc ) return rc;
1763 
1764   zSql = sqlite3MPrintf(db, zSql2, zDb);
1765   if( !zSql ){
1766     return SQLITE_NOMEM_BKPT;
1767   }
1768   rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1769   sqlite3DbFree(db, zSql);
1770   if( rc ) return rc;
1771 
1772   while( sqlite3_step(pStmt)==SQLITE_ROW ){
1773     char *zIndex;                 /* Index name */
1774     Index *pIdx;                  /* Pointer to the index object */
1775     int nCol = 1;                 /* Number of columns in index */
1776 
1777     zIndex = (char *)sqlite3_column_text(pStmt, 0);
1778     if( zIndex==0 ) continue;
1779     pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
1780     if( pIdx==0 ) continue;
1781     /* This next condition is true if data has already been loaded from
1782     ** the sqlite_stat4 table. */
1783     nCol = pIdx->nSampleCol;
1784     if( pIdx!=pPrevIdx ){
1785       initAvgEq(pPrevIdx);
1786       pPrevIdx = pIdx;
1787     }
1788     pSample = &pIdx->aSample[pIdx->nSample];
1789     decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
1790     decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
1791     decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
1792 
1793     /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
1794     ** This is in case the sample record is corrupted. In that case, the
1795     ** sqlite3VdbeRecordCompare() may read up to two varints past the
1796     ** end of the allocated buffer before it realizes it is dealing with
1797     ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
1798     ** a buffer overread.  */
1799     pSample->n = sqlite3_column_bytes(pStmt, 4);
1800     pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
1801     if( pSample->p==0 ){
1802       sqlite3_finalize(pStmt);
1803       return SQLITE_NOMEM_BKPT;
1804     }
1805     if( pSample->n ){
1806       memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
1807     }
1808     pIdx->nSample++;
1809   }
1810   rc = sqlite3_finalize(pStmt);
1811   if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
1812   return rc;
1813 }
1814 
1815 /*
1816 ** Load content from the sqlite_stat4 table into
1817 ** the Index.aSample[] arrays of all indices.
1818 */
1819 static int loadStat4(sqlite3 *db, const char *zDb){
1820   int rc = SQLITE_OK;             /* Result codes from subroutines */
1821 
1822   assert( db->lookaside.bDisable );
1823   if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
1824     rc = loadStatTbl(db,
1825       "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
1826       "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1827       zDb
1828     );
1829   }
1830   return rc;
1831 }
1832 #endif /* SQLITE_ENABLE_STAT4 */
1833 
1834 /*
1835 ** Load the content of the sqlite_stat1 and sqlite_stat4 tables. The
1836 ** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
1837 ** arrays. The contents of sqlite_stat4 are used to populate the
1838 ** Index.aSample[] arrays.
1839 **
1840 ** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
1841 ** is returned. In this case, even if SQLITE_ENABLE_STAT4 was defined
1842 ** during compilation and the sqlite_stat4 table is present, no data is
1843 ** read from it.
1844 **
1845 ** If SQLITE_ENABLE_STAT4 was defined during compilation and the
1846 ** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
1847 ** returned. However, in this case, data is read from the sqlite_stat1
1848 ** table (if it is present) before returning.
1849 **
1850 ** If an OOM error occurs, this function always sets db->mallocFailed.
1851 ** This means if the caller does not care about other errors, the return
1852 ** code may be ignored.
1853 */
1854 int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
1855   analysisInfo sInfo;
1856   HashElem *i;
1857   char *zSql;
1858   int rc = SQLITE_OK;
1859   Schema *pSchema = db->aDb[iDb].pSchema;
1860 
1861   assert( iDb>=0 && iDb<db->nDb );
1862   assert( db->aDb[iDb].pBt!=0 );
1863 
1864   /* Clear any prior statistics */
1865   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1866   for(i=sqliteHashFirst(&pSchema->tblHash); i; i=sqliteHashNext(i)){
1867     Table *pTab = sqliteHashData(i);
1868     pTab->tabFlags &= ~TF_HasStat1;
1869   }
1870   for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
1871     Index *pIdx = sqliteHashData(i);
1872     pIdx->hasStat1 = 0;
1873 #ifdef SQLITE_ENABLE_STAT4
1874     sqlite3DeleteIndexSamples(db, pIdx);
1875     pIdx->aSample = 0;
1876 #endif
1877   }
1878 
1879   /* Load new statistics out of the sqlite_stat1 table */
1880   sInfo.db = db;
1881   sInfo.zDatabase = db->aDb[iDb].zDbSName;
1882   if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)!=0 ){
1883     zSql = sqlite3MPrintf(db,
1884         "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
1885     if( zSql==0 ){
1886       rc = SQLITE_NOMEM_BKPT;
1887     }else{
1888       rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
1889       sqlite3DbFree(db, zSql);
1890     }
1891   }
1892 
1893   /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
1894   assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1895   for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
1896     Index *pIdx = sqliteHashData(i);
1897     if( !pIdx->hasStat1 ) sqlite3DefaultRowEst(pIdx);
1898   }
1899 
1900   /* Load the statistics from the sqlite_stat4 table. */
1901 #ifdef SQLITE_ENABLE_STAT4
1902   if( rc==SQLITE_OK ){
1903     DisableLookaside;
1904     rc = loadStat4(db, sInfo.zDatabase);
1905     EnableLookaside;
1906   }
1907   for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
1908     Index *pIdx = sqliteHashData(i);
1909     sqlite3_free(pIdx->aiRowEst);
1910     pIdx->aiRowEst = 0;
1911   }
1912 #endif
1913 
1914   if( rc==SQLITE_NOMEM ){
1915     sqlite3OomFault(db);
1916   }
1917   return rc;
1918 }
1919 
1920 
1921 #endif /* SQLITE_OMIT_ANALYZE */
1922