]> git.ipfire.org Git - thirdparty/postgresql.git/commit
Add EXPLAIN (IO) infrastructure with BitmapHeapScan support
authorTomas Vondra <tomas.vondra@postgresql.org>
Tue, 7 Apr 2026 20:33:32 +0000 (22:33 +0200)
committerTomas Vondra <tomas.vondra@postgresql.org>
Tue, 7 Apr 2026 20:33:34 +0000 (22:33 +0200)
commit681daed93169ff5bed2796dd5c8c76ee2fae1ebd
tree69f9bf02751ac203574b1a40fa2f55f8061a7a0f
parent10d5a12a93150deb15f600492bbd4e46a2212b3b
Add EXPLAIN (IO) infrastructure with BitmapHeapScan support

Allows collecting details about AIO / prefetch for scan nodes backed by
a ReadStream. This may be enabled by a new "IO" option in EXPLAIN, and
it shows information about the prefetch distance and I/O requests.

As of this commit this applies only to BitmapHeapScan, because that's
the only scan node using a ReadStream and collecting instrumentation
from workers in a parallel query. Support for SeqScan and TidRangeScan,
the other scan nodes using ReadStream, will be added in subsequent
commits.

The stats are collected only when required by EXPLAIN ANALYZE, with the
IO option (disabled by default). The amount of collected statistics is
very limited, but we don't want to clutter EXPLAIN with too much data.

The IOStats struct is stored in the scan descriptor as a field, next to
other fields used by table AMs. A pointer to the field is passed to the
ReadStream, and updated directly.

It's the responsibility of the table AM to allocate the struct (e.g. in
ambeginscan) whenever the flag SO_SCAN_INSTRUMENT flag is passed to the
scan, so that the executor and ReadStream has access to it.

The collected stats are designed for ReadStream, but are meant to be
reasonably generic in case a TAM manages I/Os in different ways.

Author: Tomas Vondra <tomas@vondra.me>
Reviewed-by: Melanie Plageman <melanieplageman@gmail.com>
Reviewed-by: Lukas Fittl <lukas@fittl.com>
Reviewed-by: Andres Freund <andres@anarazel.de>
Discussion: https://postgr.es/m/flat/a177a6dd-240b-455a-8f25-aca0b1c08c6e%40vondra.me
13 files changed:
doc/src/sgml/ref/explain.sgml
src/backend/access/heap/heapam.c
src/backend/commands/explain.c
src/backend/commands/explain_state.c
src/backend/executor/nodeBitmapHeapscan.c
src/backend/storage/aio/read_stream.c
src/include/access/relscan.h
src/include/access/tableam.h
src/include/commands/explain_state.h
src/include/executor/instrument.h
src/include/executor/instrument_node.h
src/include/storage/read_stream.h
src/tools/pgindent/typedefs.list