pgsql: tableam: Add and use scan APIs.

From: Andres Freund <andres(at)anarazel(dot)de>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: tableam: Add and use scan APIs.
Date: 2019-03-11 20:00:30
Message-ID: E1h3R66-0005tl-BP@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

tableam: Add and use scan APIs.

Too allow table accesses to be not directly dependent on heap, several
new abstractions are needed. Specifically:

1) Heap scans need to be generalized into table scans. Do this by
introducing TableScanDesc, which will be the "base class" for
individual AMs. This contains the AM independent fields from
HeapScanDesc.

The previous heap_{beginscan,rescan,endscan} et al. have been
replaced with a table_ version.

There's no direct replacement for heap_getnext(), as that returned
a HeapTuple, which is undesirable for a other AMs. Instead there's
table_scan_getnextslot(). But note that heap_getnext() lives on,
it's still used widely to access catalog tables.

This is achieved by new scan_begin, scan_end, scan_rescan,
scan_getnextslot callbacks.

2) The portion of parallel scans that's shared between backends need
to be able to do so without the user doing per-AM work. To achieve
that new parallelscan_{estimate, initialize, reinitialize}
callbacks are introduced, which operate on a new
ParallelTableScanDesc, which again can be subclassed by AMs.

As it is likely that several AMs are going to be block oriented,
block oriented callbacks that can be shared between such AMs are
provided and used by heap. table_block_parallelscan_{estimate,
intiialize, reinitialize} as callbacks, and
table_block_parallelscan_{nextpage, init} for use in AMs. These
operate on a ParallelBlockTableScanDesc.

3) Index scans need to be able to access tables to return a tuple, and
there needs to be state across individual accesses to the heap to
store state like buffers. That's now handled by introducing a
sort-of-scan IndexFetchTable, which again is intended to be
subclassed by individual AMs (for heap IndexFetchHeap).

The relevant callbacks for an AM are index_fetch_{end, begin,
reset} to create the necessary state, and index_fetch_tuple to
retrieve an indexed tuple. Note that index_fetch_tuple
implementations need to be smarter than just blindly fetching the
tuples for AMs that have optimizations similar to heap's HOT - the
currently alive tuple in the update chain needs to be fetched if
appropriate.

Similar to table_scan_getnextslot(), it's undesirable to continue
to return HeapTuples. Thus index_fetch_heap (might want to rename
that later) now accepts a slot as an argument. Core code doesn't
have a lot of call sites performing index scans without going
through the systable_* API (in contrast to loads of heap_getnext
calls and working directly with HeapTuples).

Index scans now store the result of a search in
IndexScanDesc->xs_heaptid, rather than xs_ctup->t_self. As the
target is not generally a HeapTuple anymore that seems cleaner.

To be able to sensible adapt code to use the above, two further
callbacks have been introduced:

a) slot_callbacks returns a TupleTableSlotOps* suitable for creating
slots capable of holding a tuple of the AMs
type. table_slot_callbacks() and table_slot_create() are based
upon that, but have additional logic to deal with views, foreign
tables, etc.

While this change could have been done separately, nearly all the
call sites that needed to be adapted for the rest of this commit
also would have been needed to be adapted for
table_slot_callbacks(), making separation not worthwhile.

b) tuple_satisfies_snapshot checks whether the tuple in a slot is
currently visible according to a snapshot. That's required as a few
places now don't have a buffer + HeapTuple around, but a
slot (which in heap's case internally has that information).

Additionally a few infrastructure changes were needed:

I) SysScanDesc, as used by systable_{beginscan, getnext} et al. now
internally uses a slot to keep track of tuples. While
systable_getnext() still returns HeapTuples, and will so for the
foreseeable future, the index API (see 1) above) now only deals with
slots.

The remainder, and largest part, of this commit is then adjusting all
scans in postgres to use the new APIs.

Author: Andres Freund, Haribabu Kommi, Alvaro Herrera
Discussion:
https://postgr.es/m/20180703070645.wchpu5muyto5n647@alap3.anarazel.de
https://postgr.es/m/20160812231527.GA690404@alvherre.pgsql

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/c2fe139c201c48f1133e9fbea2dd99b8efe2fadd

Modified Files
--------------
contrib/amcheck/verify_nbtree.c | 15 +-
contrib/pgrowlocks/pgrowlocks.c | 20 +-
contrib/pgstattuple/pgstattuple.c | 22 +-
contrib/tsm_system_rows/tsm_system_rows.c | 14 +-
contrib/tsm_system_time/tsm_system_time.c | 9 +-
src/backend/access/gist/gistget.c | 4 +-
src/backend/access/hash/hashsearch.c | 4 +-
src/backend/access/heap/heapam.c | 650 +++++++++--------------------
src/backend/access/heap/heapam_handler.c | 166 ++++++++
src/backend/access/index/genam.c | 110 ++---
src/backend/access/index/indexam.c | 164 +++-----
src/backend/access/nbtree/nbtree.c | 2 +-
src/backend/access/nbtree/nbtsearch.c | 6 +-
src/backend/access/nbtree/nbtsort.c | 20 +-
src/backend/access/spgist/spgscan.c | 2 +-
src/backend/access/table/tableam.c | 293 ++++++++++++-
src/backend/access/table/tableamapi.c | 26 +-
src/backend/access/tablesample/system.c | 7 +-
src/backend/bootstrap/bootstrap.c | 21 +-
src/backend/catalog/aclchk.c | 13 +-
src/backend/catalog/index.c | 114 ++---
src/backend/catalog/pg_conversion.c | 7 +-
src/backend/catalog/pg_db_role_setting.c | 7 +-
src/backend/catalog/pg_publication.c | 7 +-
src/backend/catalog/pg_subscription.c | 7 +-
src/backend/commands/cluster.c | 29 +-
src/backend/commands/constraint.c | 68 +--
src/backend/commands/copy.c | 7 +-
src/backend/commands/dbcommands.c | 19 +-
src/backend/commands/indexcmds.c | 7 +-
src/backend/commands/tablecmds.c | 135 +++---
src/backend/commands/tablespace.c | 37 +-
src/backend/commands/typecmds.c | 29 +-
src/backend/commands/vacuum.c | 13 +-
src/backend/executor/execCurrent.c | 2 +-
src/backend/executor/execIndexing.c | 18 +-
src/backend/executor/execMain.c | 6 +-
src/backend/executor/execPartition.c | 11 +-
src/backend/executor/execReplication.c | 62 +--
src/backend/executor/execUtils.c | 7 +-
src/backend/executor/nodeBitmapHeapscan.c | 74 ++--
src/backend/executor/nodeIndexonlyscan.c | 25 +-
src/backend/executor/nodeIndexscan.c | 38 +-
src/backend/executor/nodeModifyTable.c | 17 +-
src/backend/executor/nodeSamplescan.c | 86 ++--
src/backend/executor/nodeSeqscan.c | 67 ++-
src/backend/executor/nodeTidscan.c | 3 +-
src/backend/partitioning/partbounds.c | 18 +-
src/backend/postmaster/autovacuum.c | 17 +-
src/backend/postmaster/pgstat.c | 7 +-
src/backend/replication/logical/launcher.c | 7 +-
src/backend/replication/logical/worker.c | 13 +-
src/backend/rewrite/rewriteDefine.c | 12 +-
src/backend/utils/adt/ri_triggers.c | 23 +-
src/backend/utils/adt/selfuncs.c | 17 +-
src/backend/utils/init/postinit.c | 7 +-
src/include/access/genam.h | 6 +-
src/include/access/heapam.h | 92 ++--
src/include/access/relscan.h | 122 +++---
src/include/access/tableam.h | 468 ++++++++++++++++++++-
src/include/catalog/index.h | 5 +-
src/include/nodes/execnodes.h | 2 +-
src/tools/pgindent/typedefs.list | 11 +-
63 files changed, 2031 insertions(+), 1266 deletions(-)

Responses

Browse pgsql-committers by date

  From Date Subject
Next Message Andres Freund 2019-03-11 20:32:42 Re: pgsql: tableam: Add and use scan APIs.
Previous Message Robert Haas 2019-03-11 19:30:22 Re: pgsql: Removed unused variable, openLogOff.