Fix multiple bugs in contrib/pgstattuple's pgstatindex() function.
authorTom Lane <tgl@sss.pgh.pa.us>
Thu, 18 Feb 2016 20:40:35 +0000 (15:40 -0500)
committerTom Lane <tgl@sss.pgh.pa.us>
Thu, 18 Feb 2016 20:40:35 +0000 (15:40 -0500)
commit48e6c943e5f11f5d80cabdbcd98f79e3dbad1988
tree9e50f5ee717a015866eb68fc395da9446f286b86
parent18777c38e9cc2e032b919a7f532971745b32aec0
Fix multiple bugs in contrib/pgstattuple's pgstatindex() function.

Dead or half-dead index leaf pages were incorrectly reported as live, as a
consequence of a code rearrangement I made (during a moment of severe brain
fade, evidently) in commit d287818eb514d431.

The index metapage was not counted in index_size, causing that result to
not agree with the actual index size on-disk.

Index root pages were not counted in internal_pages, which is inconsistent
compared to the case of a root that's also a leaf (one-page index), where
the root would be counted in leaf_pages.  Aside from that inconsistency,
this could lead to additional transient discrepancies between the reported
page counts and index_size, since it's possible for pgstatindex's scan to
see zero or multiple pages marked as BTP_ROOT, if the root moves due to
a split during the scan.  With these fixes, index_size will always be
exactly one page more than the sum of the displayed page counts.

Also, the index_size result was incorrectly documented as being measured in
pages; it's always been measured in bytes.  (While fixing that, I couldn't
resist doing some small additional wordsmithing on the pgstattuple docs.)

Including the metapage causes the reported index_size to not be zero for
an empty index.  To preserve the desired property that the pgstattuple
regression test results are platform-independent (ie, BLCKSZ configuration
independent), scale the index_size result in the regression tests.

The documentation issue was reported by Otsuka Kenji, and the inconsistent
root page counting by Peter Geoghegan; the other problems noted by me.
Back-patch to all supported branches, because this has been broken for
a long time.
contrib/pgstattuple/expected/pgstattuple.out
contrib/pgstattuple/pgstatindex.c
contrib/pgstattuple/sql/pgstattuple.sql
doc/src/sgml/pgstattuple.sgml