v1-0001-Add-amgetbatch-interface-for-index-scan-prefetchi.patch
application/octet-stream
Filename: v1-0001-Add-amgetbatch-interface-for-index-scan-prefetchi.patch
Type: application/octet-stream
Part: 0
Message:
Re: index prefetching
Patch
Same data as JSON:
GET /api/v1/attachments/:id/patch
the parsed metadata as JSON — format, series position, per-file stats; never the diff bytes.
API reference →
Format: format-patch
Series: patch v1-0001
Subject: Add amgetbatch interface for index scan prefetching.
| File | + | − |
|---|---|---|
| contrib/bloom/blutils.c | 0 | 1 |
| doc/src/sgml/indexam.sgml | 1 | 18 |
| src/backend/access/brin/brin.c | 0 | 1 |
| src/backend/access/gin/ginutil.c | 0 | 1 |
| src/backend/access/gist/gist.c | 0 | 1 |
| src/backend/access/hash/hash.c | 0 | 1 |
| src/backend/access/heap/heapam_handler.c | 120 | 4 |
| src/backend/access/index/genam.c | 1 | 0 |
| src/backend/access/index/indexam.c | 1197 | 10 |
| src/backend/access/nbtree/nbtree.c | 74 | 232 |
| src/backend/access/nbtree/nbtsearch.c | 271 | 400 |
| src/backend/access/nbtree/nbtutils.c | 24 | 25 |
| src/backend/access/spgist/spgutils.c | 0 | 1 |
| src/backend/access/table/tableam.c | 1 | 1 |
| src/backend/commands/constraint.c | 2 | 1 |
| src/backend/commands/indexcmds.c | 1 | 1 |
| src/backend/executor/nodeIndexonlyscan.c | 98 | 3 |
| src/backend/optimizer/util/plancat.c | 3 | 3 |
| src/backend/replication/logical/relation.c | 2 | 1 |
| src/backend/storage/aio/read_stream.c | 12 | 2 |
| src/backend/utils/adt/amutils.c | 2 | 2 |
| src/include/access/amapi.h | 13 | 5 |
| src/include/access/genam.h | 4 | 0 |
| src/include/access/heapam.h | 1 | 0 |
| src/include/access/nbtree.h | 14 | 86 |
| src/include/access/relscan.h | 130 | 0 |
| src/include/access/tableam.h | 9 | 3 |
| src/include/nodes/pathnodes.h | 1 | 1 |
| src/test/modules/dummy_index_am/dummy_index_am.c | 0 | 1 |
| src/tools/pgindent/typedefs.list | 7 | 1 |
From 112446c3c60996eee0ff76debc18a23eae161748 Mon Sep 17 00:00:00 2001
From: Tomas Vondra <tomas@vondra.me>
Date: Mon, 30 Sep 2024 22:48:12 +0200
Subject: [PATCH v1] Add amgetbatch interface for index scan prefetching.
Allows the index AM to provide items (TIDs and tuples) in batches, which
is then used to implement prefetching of heap tuples in index scans
(including index-only scans). This is similar to prefetching already
done in bitmap scans, and can result in significant speedups.
The index AM may implement an optional "amgetbatch" callback, returning
a batch of items. The indexam.c code then handles this transparently
through the existing "getnext" interface.
---
src/include/access/amapi.h | 18 +-
src/include/access/genam.h | 4 +
src/include/access/heapam.h | 1 +
src/include/access/nbtree.h | 100 +-
src/include/access/relscan.h | 130 ++
src/include/access/tableam.h | 12 +-
src/include/nodes/pathnodes.h | 2 +-
src/backend/access/brin/brin.c | 1 -
src/backend/access/gin/ginutil.c | 1 -
src/backend/access/gist/gist.c | 1 -
src/backend/access/hash/hash.c | 1 -
src/backend/access/heap/heapam_handler.c | 124 +-
src/backend/access/index/genam.c | 1 +
src/backend/access/index/indexam.c | 1207 ++++++++++++++++-
src/backend/access/nbtree/nbtree.c | 306 +----
src/backend/access/nbtree/nbtsearch.c | 671 ++++-----
src/backend/access/nbtree/nbtutils.c | 49 +-
src/backend/access/spgist/spgutils.c | 1 -
src/backend/access/table/tableam.c | 2 +-
src/backend/commands/constraint.c | 3 +-
src/backend/commands/indexcmds.c | 2 +-
src/backend/executor/nodeIndexonlyscan.c | 101 +-
src/backend/optimizer/util/plancat.c | 6 +-
src/backend/replication/logical/relation.c | 3 +-
src/backend/storage/aio/read_stream.c | 14 +-
src/backend/utils/adt/amutils.c | 4 +-
contrib/bloom/blutils.c | 1 -
doc/src/sgml/indexam.sgml | 19 +-
.../modules/dummy_index_am/dummy_index_am.c | 1 -
src/tools/pgindent/typedefs.list | 8 +-
30 files changed, 1988 insertions(+), 806 deletions(-)
diff --git a/src/include/access/amapi.h b/src/include/access/amapi.h
index 70949de56..9b2e22c4c 100644
--- a/src/include/access/amapi.h
+++ b/src/include/access/amapi.h
@@ -196,6 +196,15 @@ typedef void (*amrescan_function) (IndexScanDesc scan,
typedef bool (*amgettuple_function) (IndexScanDesc scan,
ScanDirection direction);
+/* next batch of valid tuples */
+typedef IndexScanBatch(*amgetbatch_function) (IndexScanDesc scan,
+ IndexScanBatch batch,
+ ScanDirection direction);
+
+/* release batch of valid tuples */
+typedef void (*amfreebatch_function) (IndexScanDesc scan,
+ IndexScanBatch batch);
+
/* fetch all valid tuples */
typedef int64 (*amgetbitmap_function) (IndexScanDesc scan,
TIDBitmap *tbm);
@@ -203,11 +212,9 @@ typedef int64 (*amgetbitmap_function) (IndexScanDesc scan,
/* end index scan */
typedef void (*amendscan_function) (IndexScanDesc scan);
-/* mark current scan position */
-typedef void (*ammarkpos_function) (IndexScanDesc scan);
-
/* restore marked scan position */
-typedef void (*amrestrpos_function) (IndexScanDesc scan);
+typedef void (*amrestrpos_function) (IndexScanDesc scan,
+ IndexScanBatch batch);
/*
* Callback function signatures - for parallel index scans.
@@ -307,9 +314,10 @@ typedef struct IndexAmRoutine
ambeginscan_function ambeginscan;
amrescan_function amrescan;
amgettuple_function amgettuple; /* can be NULL */
+ amgetbatch_function amgetbatch; /* can be NULL */
+ amfreebatch_function amfreebatch; /* can be NULL */
amgetbitmap_function amgetbitmap; /* can be NULL */
amendscan_function amendscan;
- ammarkpos_function ammarkpos; /* can be NULL */
amrestrpos_function amrestrpos; /* can be NULL */
/* interface functions to support parallel index scans */
diff --git a/src/include/access/genam.h b/src/include/access/genam.h
index 5b2ab181b..39382d8e0 100644
--- a/src/include/access/genam.h
+++ b/src/include/access/genam.h
@@ -15,6 +15,7 @@
#define GENAM_H
#include "access/htup.h"
+#include "access/itup.h"
#include "access/sdir.h"
#include "access/skey.h"
#include "nodes/tidbitmap.h"
@@ -111,6 +112,7 @@ typedef bool (*IndexBulkDeleteCallback) (ItemPointer itemptr, void *state);
/* struct definitions appear in relscan.h */
typedef struct IndexScanDescData *IndexScanDesc;
+typedef struct IndexScanBatchData *IndexScanBatch;
typedef struct SysScanDescData *SysScanDesc;
typedef struct ParallelIndexScanDescData *ParallelIndexScanDesc;
@@ -231,6 +233,8 @@ extern void index_store_float8_orderby_distances(IndexScanDesc scan,
bool recheckOrderBy);
extern bytea *index_opclass_options(Relation indrel, AttrNumber attnum,
Datum attoptions, bool validate);
+extern IndexScanBatch index_batch_alloc(int maxitems, bool want_itup);
+extern void index_batch_unlock(Relation rel, bool dropPin, IndexScanBatch batch);
/*
diff --git a/src/include/access/heapam.h b/src/include/access/heapam.h
index a2bd5a897..18108c52c 100644
--- a/src/include/access/heapam.h
+++ b/src/include/access/heapam.h
@@ -116,6 +116,7 @@ typedef struct IndexFetchHeapData
IndexFetchTableData xs_base; /* AM independent part of the descriptor */
Buffer xs_cbuf; /* current heap buffer in scan, if any */
+ BlockNumber xs_cbuf_blk;
/* NB: if xs_cbuf is not InvalidBuffer, we hold a pin on that buffer */
} IndexFetchHeapData;
diff --git a/src/include/access/nbtree.h b/src/include/access/nbtree.h
index e709d2e0a..93b5ea709 100644
--- a/src/include/access/nbtree.h
+++ b/src/include/access/nbtree.h
@@ -939,10 +939,10 @@ typedef BTVacuumPostingData *BTVacuumPosting;
* processing. This approach minimizes lock/unlock traffic. We must always
* drop the lock to make it okay for caller to process the returned items.
* Whether or not we can also release the pin during this window will vary.
- * We drop the pin (when so->dropPin) to avoid blocking progress by VACUUM
- * (see nbtree/README section about making concurrent TID recycling safe).
- * We'll always release both the lock and the pin on the current page before
- * moving on to its sibling page.
+ * We drop the pin (when dropPin is set in batch state) to avoid blocking
+ * progress by VACUUM (see nbtree/README section about making concurrent TID
+ * recycling safe). We'll always release both the lock and the pin on the
+ * current page before moving on to its sibling page.
*
* If we are doing an index-only scan, we save the entire IndexTuple for each
* matched item, otherwise only its heap TID and offset. The IndexTuples go
@@ -961,74 +961,25 @@ typedef struct BTScanPosItem /* what we remember about each match */
typedef struct BTScanPosData
{
- Buffer buf; /* currPage buf (invalid means unpinned) */
-
/* page details as of the saved position's call to _bt_readpage */
BlockNumber currPage; /* page referenced by items array */
BlockNumber prevPage; /* currPage's left link */
BlockNumber nextPage; /* currPage's right link */
- XLogRecPtr lsn; /* currPage's LSN (when so->dropPin) */
/* scan direction for the saved position's call to _bt_readpage */
ScanDirection dir;
- /*
- * If we are doing an index-only scan, nextTupleOffset is the first free
- * location in the associated tuple storage workspace.
- */
- int nextTupleOffset;
-
/*
* moreLeft and moreRight track whether we think there may be matching
* index entries to the left and right of the current page, respectively.
*/
bool moreLeft;
bool moreRight;
-
- /*
- * The items array is always ordered in index order (ie, increasing
- * indexoffset). When scanning backwards it is convenient to fill the
- * array back-to-front, so we start at the last slot and fill downwards.
- * Hence we need both a first-valid-entry and a last-valid-entry counter.
- * itemIndex is a cursor showing which entry was last returned to caller.
- */
- int firstItem; /* first valid index in items[] */
- int lastItem; /* last valid index in items[] */
- int itemIndex; /* current index in items[] */
-
- BTScanPosItem items[MaxTIDsPerBTreePage]; /* MUST BE LAST */
} BTScanPosData;
typedef BTScanPosData *BTScanPos;
-#define BTScanPosIsPinned(scanpos) \
-( \
- AssertMacro(BlockNumberIsValid((scanpos).currPage) || \
- !BufferIsValid((scanpos).buf)), \
- BufferIsValid((scanpos).buf) \
-)
-#define BTScanPosUnpin(scanpos) \
- do { \
- ReleaseBuffer((scanpos).buf); \
- (scanpos).buf = InvalidBuffer; \
- } while (0)
-#define BTScanPosUnpinIfPinned(scanpos) \
- do { \
- if (BTScanPosIsPinned(scanpos)) \
- BTScanPosUnpin(scanpos); \
- } while (0)
-
-#define BTScanPosIsValid(scanpos) \
-( \
- AssertMacro(BlockNumberIsValid((scanpos).currPage) || \
- !BufferIsValid((scanpos).buf)), \
- BlockNumberIsValid((scanpos).currPage) \
-)
-#define BTScanPosInvalidate(scanpos) \
- do { \
- (scanpos).buf = InvalidBuffer; \
- (scanpos).currPage = InvalidBlockNumber; \
- } while (0)
+#define BTScanPosIsValid(scanpos) BlockNumberIsValid((scanpos).currPage)
/* We need one of these for each equality-type SK_SEARCHARRAY scan key */
typedef struct BTArrayKeyInfo
@@ -1066,32 +1017,7 @@ typedef struct BTScanOpaqueData
BTArrayKeyInfo *arrayKeys; /* info about each equality-type array key */
FmgrInfo *orderProcs; /* ORDER procs for required equality keys */
MemoryContext arrayContext; /* scan-lifespan context for array data */
-
- /* info about killed items if any (killedItems is NULL if never used) */
- int *killedItems; /* currPos.items indexes of killed items */
- int numKilled; /* number of currently stored items */
- bool dropPin; /* drop leaf pin before btgettuple returns? */
-
- /*
- * If we are doing an index-only scan, these are the tuple storage
- * workspaces for the currPos and markPos respectively. Each is of size
- * BLCKSZ, so it can hold as much as a full page's worth of tuples.
- */
- char *currTuples; /* tuple storage for currPos */
- char *markTuples; /* tuple storage for markPos */
-
- /*
- * If the marked position is on the same page as current position, we
- * don't use markPos, but just keep the marked itemIndex in markItemIndex
- * (all the rest of currPos is valid for the mark position). Hence, to
- * determine if there is a mark, first look at markItemIndex, then at
- * markPos.
- */
- int markItemIndex; /* itemIndex, or -1 if not valid */
-
- /* keep these last in struct for efficiency */
- BTScanPosData currPos; /* current position data */
- BTScanPosData markPos; /* marked position, if any */
+ BTScanPos pos;
} BTScanOpaqueData;
typedef BTScanOpaqueData *BTScanOpaque;
@@ -1191,14 +1117,15 @@ extern bool btinsert(Relation rel, Datum *values, bool *isnull,
extern IndexScanDesc btbeginscan(Relation rel, int nkeys, int norderbys);
extern Size btestimateparallelscan(Relation rel, int nkeys, int norderbys);
extern void btinitparallelscan(void *target);
-extern bool btgettuple(IndexScanDesc scan, ScanDirection dir);
+extern IndexScanBatch btgetbatch(IndexScanDesc scan, IndexScanBatch batch,
+ ScanDirection dir);
extern int64 btgetbitmap(IndexScanDesc scan, TIDBitmap *tbm);
extern void btrescan(IndexScanDesc scan, ScanKey scankey, int nscankeys,
ScanKey orderbys, int norderbys);
+extern void btfreebatch(IndexScanDesc scan, IndexScanBatch batch);
extern void btparallelrescan(IndexScanDesc scan);
extern void btendscan(IndexScanDesc scan);
-extern void btmarkpos(IndexScanDesc scan);
-extern void btrestrpos(IndexScanDesc scan);
+extern void btrestrpos(IndexScanDesc scan, IndexScanBatch markbatch);
extern IndexBulkDeleteResult *btbulkdelete(IndexVacuumInfo *info,
IndexBulkDeleteResult *stats,
IndexBulkDeleteCallback callback,
@@ -1305,8 +1232,9 @@ extern BTStack _bt_search(Relation rel, Relation heaprel, BTScanInsert key,
Buffer *bufP, int access);
extern OffsetNumber _bt_binsrch_insert(Relation rel, BTInsertState insertstate);
extern int32 _bt_compare(Relation rel, BTScanInsert key, Page page, OffsetNumber offnum);
-extern bool _bt_first(IndexScanDesc scan, ScanDirection dir);
-extern bool _bt_next(IndexScanDesc scan, ScanDirection dir);
+extern IndexScanBatch _bt_first(IndexScanDesc scan, ScanDirection dir);
+extern IndexScanBatch _bt_next(IndexScanDesc scan, ScanDirection dir,
+ IndexScanBatch priorbatch);
extern Buffer _bt_get_endpoint(Relation rel, uint32 level, bool rightmost);
/*
@@ -1326,7 +1254,7 @@ extern bool _bt_checkkeys(IndexScanDesc scan, BTReadPageState *pstate, bool arra
extern bool _bt_scanbehind_checkkeys(IndexScanDesc scan, ScanDirection dir,
IndexTuple finaltup);
extern void _bt_set_startikey(IndexScanDesc scan, BTReadPageState *pstate);
-extern void _bt_killitems(IndexScanDesc scan);
+extern void _bt_killitems(IndexScanDesc scan, IndexScanBatch batch);
extern BTCycleId _bt_vacuum_cycleid(Relation rel);
extern BTCycleId _bt_start_vacuum(Relation rel);
extern void _bt_end_vacuum(Relation rel);
diff --git a/src/include/access/relscan.h b/src/include/access/relscan.h
index b5e0fb386..d9731332b 100644
--- a/src/include/access/relscan.h
+++ b/src/include/access/relscan.h
@@ -16,9 +16,11 @@
#include "access/htup_details.h"
#include "access/itup.h"
+#include "access/sdir.h"
#include "nodes/tidbitmap.h"
#include "port/atomics.h"
#include "storage/buf.h"
+#include "storage/read_stream.h"
#include "storage/relfilelocator.h"
#include "storage/spin.h"
#include "utils/relcache.h"
@@ -121,10 +123,136 @@ typedef struct ParallelBlockTableScanWorkerData *ParallelBlockTableScanWorker;
typedef struct IndexFetchTableData
{
Relation rel;
+ ReadStream *rs;
} IndexFetchTableData;
struct IndexScanInstrumentation;
+/* Forward declaration, the prefetch callback needs IndexScanDescData. */
+typedef struct IndexScanBatchData IndexScanBatchData;
+
+typedef struct IndexScanBatchPosItem /* what we remember about each match */
+{
+ ItemPointerData heapTid; /* TID of referenced heap item */
+ OffsetNumber indexOffset; /* index item's location within page */
+ LocationIndex tupleOffset; /* IndexTuple's offset in workspace, if any */
+} IndexScanBatchPosItem;
+
+/*
+ * Data about one batch of items returned by the index AM
+ */
+typedef struct IndexScanBatchData
+{
+ Buffer buf; /* currPage buf (invalid means unpinned) */
+ XLogRecPtr lsn; /* currPage's LSN (when dropPin) */
+
+ /*
+ * AM-specific state representing the current position of the scan within
+ * the index
+ */
+ void *pos;
+
+ /*
+ * The items array is always ordered in index order (ie, increasing
+ * indexoffset). When scanning backwards it is convenient to fill the
+ * array back-to-front, so we start at the last slot and fill downwards.
+ * Hence we need both a first-valid-entry and a last-valid-entry counter.
+ * itemIndex is a cursor showing which entry was last returned to caller.
+ */
+ int firstItem; /* first valid index in items[] */
+ int lastItem; /* last valid index in items[] */
+ int itemIndex; /* current index in items[] */
+
+ /* info about killed items if any (killedItems is NULL if never used) */
+ int *killedItems; /* indexes of killed items */
+ int numKilled; /* number of currently stored items */
+
+ /*
+ * If we are doing an index-only scan, these are the tuple storage
+ * workspaces for the currPos and markPos respectively. Each is of size
+ * BLCKSZ, so it can hold as much as a full page's worth of tuples.
+ *
+ * XXX maybe currTuples should be part of the am-specific per-batch state
+ * stored in "position" field?
+ */
+ char *currTuples; /* tuple storage for currPos */
+ IndexScanBatchPosItem *items;
+
+ /*
+ * batch contents (TIDs, index tuples, kill bitmap, ...)
+ *
+ * XXX Shouldn't this be part of the "IndexScanBatchPosItem" struct? To
+ * keep everything in one place? Or why should we have separate arrays?
+ * One advantage is that we don't need to allocate memory for arrays that
+ * we don't need ... e.g. if we don't need heap tuples, we don't allocate
+ * that. We couldn't do that with everything in one struct.
+ */
+ char *itemsvisibility; /* Index-only scan visibility cache */
+
+} IndexScanBatchData;
+
+/*
+ * Position in the queue of batches - index of a batch, index of item in a batch.
+ */
+typedef struct IndexScanBatchPos
+{
+ int batch;
+ int index;
+} IndexScanBatchPos;
+
+typedef struct IndexScanDescData IndexScanDescData;
+typedef bool (*IndexPrefetchCallback) (IndexScanDescData * scan, void *arg, IndexScanBatchPos *pos);
+
+/*
+ * State used by amgetbatch index AMs, which manage per-page batches of items
+ * with matching index tuples using a circular buffer
+ */
+typedef struct IndexScanBatchState
+{
+ /* Index AM drops leaf pin before amgetbatch returns? */
+ bool dropPin;
+
+ /*
+ * Did we read the last batch? The batches may be loaded from multiple
+ * places, and we need to remember when we fail to load the next batch in
+ * a given scan (which means "no more batches"). amgetbatch may restart
+ * the scan on the get call, so we need to remember it's over.
+ */
+ bool finished;
+ bool reset;
+
+ BlockNumber lastBlock;
+
+ /*
+ * Current scan direction, for the currently loaded batches. This is used
+ * to load data in the read stream API callback, etc.
+ */
+ ScanDirection direction;
+
+ /* positions in the queue of batches (batch + item) */
+ IndexScanBatchPos readPos; /* read position */
+ IndexScanBatchPos streamPos; /* prefetch position (for read stream API) */
+ IndexScanBatchPos markPos; /* mark/restore position */
+
+ IndexScanBatchData *markBatch;
+
+ /*
+ * Array of batches returned by the AM. The array has a capacity (but can
+ * be resized if needed). The firstBatch is an index of the first batch,
+ * but needs to be translated by (modulo maxBatches) into index in the
+ * batches array.
+ */
+ int maxBatches; /* size of the batches array */
+ int firstBatch; /* first used batch slot */
+ int nextBatch; /* next empty batch slot */
+
+ IndexScanBatchData **batches;
+
+ /* callback to skip prefetching in IOS etc. */
+ IndexPrefetchCallback prefetch;
+ void *prefetchArg;
+} IndexScanBatchState;
+
/*
* We use the same IndexScanDescData structure for both amgettuple-based
* and amgetbitmap-based index scans. Some fields are only relevant in
@@ -138,6 +266,8 @@ typedef struct IndexScanDescData
struct SnapshotData *xs_snapshot; /* snapshot to see */
int numberOfKeys; /* number of index qualifier conditions */
int numberOfOrderBys; /* number of ordering operators */
+ IndexScanBatchState *batchState; /* amgetbatch related state */
+
struct ScanKeyData *keyData; /* array of index qualifier descriptors */
struct ScanKeyData *orderByData; /* array of ordering op descriptors */
bool xs_want_itup; /* caller requests index tuples */
diff --git a/src/include/access/tableam.h b/src/include/access/tableam.h
index 1c9e802a6..8d4691fb9 100644
--- a/src/include/access/tableam.h
+++ b/src/include/access/tableam.h
@@ -413,8 +413,14 @@ typedef struct TableAmRoutine
* structure with additional information.
*
* Tuples for an index scan can then be fetched via index_fetch_tuple.
+ *
+ * The ReadStream pointer is optional - NULL means the regular buffer
+ * reads are used. If a valid ReadStream is provided, the callback
+ * (generating the blocks to read) and index_fetch_tuple (consuming the
+ * buffers) need to agree on the exact order.
*/
- struct IndexFetchTableData *(*index_fetch_begin) (Relation rel);
+ struct IndexFetchTableData *(*index_fetch_begin) (Relation rel,
+ ReadStream *rs);
/*
* Reset index fetch. Typically this will release cross index fetch
@@ -1149,9 +1155,9 @@ table_parallelscan_reinitialize(Relation rel, ParallelTableScanDesc pscan)
* Tuples for an index scan can then be fetched via table_index_fetch_tuple().
*/
static inline IndexFetchTableData *
-table_index_fetch_begin(Relation rel)
+table_index_fetch_begin(Relation rel, ReadStream *rs)
{
- return rel->rd_tableam->index_fetch_begin(rel);
+ return rel->rd_tableam->index_fetch_begin(rel, rs);
}
/*
diff --git a/src/include/nodes/pathnodes.h b/src/include/nodes/pathnodes.h
index ad2726f02..70cc5be7a 100644
--- a/src/include/nodes/pathnodes.h
+++ b/src/include/nodes/pathnodes.h
@@ -1232,7 +1232,7 @@ struct IndexOptInfo
/* does AM have amgetbitmap interface? */
bool amhasgetbitmap;
bool amcanparallel;
- /* does AM have ammarkpos interface? */
+ /* does AM know how to mark/restore? */
bool amcanmarkpos;
/* AM's cost estimator */
/* Rather than include amapi.h here, we declare amcostestimate like this */
diff --git a/src/backend/access/brin/brin.c b/src/backend/access/brin/brin.c
index 7ff7467e4..410d3b1fa 100644
--- a/src/backend/access/brin/brin.c
+++ b/src/backend/access/brin/brin.c
@@ -296,7 +296,6 @@ brinhandler(PG_FUNCTION_ARGS)
amroutine->amgettuple = NULL;
amroutine->amgetbitmap = bringetbitmap;
amroutine->amendscan = brinendscan;
- amroutine->ammarkpos = NULL;
amroutine->amrestrpos = NULL;
amroutine->amestimateparallelscan = NULL;
amroutine->aminitparallelscan = NULL;
diff --git a/src/backend/access/gin/ginutil.c b/src/backend/access/gin/ginutil.c
index 78f7b7a24..c4e6b412e 100644
--- a/src/backend/access/gin/ginutil.c
+++ b/src/backend/access/gin/ginutil.c
@@ -84,7 +84,6 @@ ginhandler(PG_FUNCTION_ARGS)
amroutine->amgettuple = NULL;
amroutine->amgetbitmap = gingetbitmap;
amroutine->amendscan = ginendscan;
- amroutine->ammarkpos = NULL;
amroutine->amrestrpos = NULL;
amroutine->amestimateparallelscan = NULL;
amroutine->aminitparallelscan = NULL;
diff --git a/src/backend/access/gist/gist.c b/src/backend/access/gist/gist.c
index 7b24380c9..ed4925683 100644
--- a/src/backend/access/gist/gist.c
+++ b/src/backend/access/gist/gist.c
@@ -105,7 +105,6 @@ gisthandler(PG_FUNCTION_ARGS)
amroutine->amgettuple = gistgettuple;
amroutine->amgetbitmap = gistgetbitmap;
amroutine->amendscan = gistendscan;
- amroutine->ammarkpos = NULL;
amroutine->amrestrpos = NULL;
amroutine->amestimateparallelscan = NULL;
amroutine->aminitparallelscan = NULL;
diff --git a/src/backend/access/hash/hash.c b/src/backend/access/hash/hash.c
index 53061c819..9ddb0c53a 100644
--- a/src/backend/access/hash/hash.c
+++ b/src/backend/access/hash/hash.c
@@ -104,7 +104,6 @@ hashhandler(PG_FUNCTION_ARGS)
amroutine->amgettuple = hashgettuple;
amroutine->amgetbitmap = hashgetbitmap;
amroutine->amendscan = hashendscan;
- amroutine->ammarkpos = NULL;
amroutine->amrestrpos = NULL;
amroutine->amestimateparallelscan = NULL;
amroutine->aminitparallelscan = NULL;
diff --git a/src/backend/access/heap/heapam_handler.c b/src/backend/access/heap/heapam_handler.c
index cb4bc35c9..fd60fda6f 100644
--- a/src/backend/access/heap/heapam_handler.c
+++ b/src/backend/access/heap/heapam_handler.c
@@ -79,12 +79,14 @@ heapam_slot_callbacks(Relation relation)
*/
static IndexFetchTableData *
-heapam_index_fetch_begin(Relation rel)
+heapam_index_fetch_begin(Relation rel, ReadStream *rs)
{
IndexFetchHeapData *hscan = palloc0(sizeof(IndexFetchHeapData));
hscan->xs_base.rel = rel;
+ hscan->xs_base.rs = rs;
hscan->xs_cbuf = InvalidBuffer;
+ hscan->xs_cbuf_blk = InvalidBlockNumber;
return &hscan->xs_base;
}
@@ -94,10 +96,14 @@ heapam_index_fetch_reset(IndexFetchTableData *scan)
{
IndexFetchHeapData *hscan = (IndexFetchHeapData *) scan;
+ if (scan->rs)
+ read_stream_reset(scan->rs);
+
if (BufferIsValid(hscan->xs_cbuf))
{
ReleaseBuffer(hscan->xs_cbuf);
hscan->xs_cbuf = InvalidBuffer;
+ hscan->xs_cbuf_blk = InvalidBlockNumber;
}
}
@@ -108,6 +114,9 @@ heapam_index_fetch_end(IndexFetchTableData *scan)
heapam_index_fetch_reset(scan);
+ if (scan->rs)
+ read_stream_end(scan->rs);
+
pfree(hscan);
}
@@ -129,16 +138,123 @@ heapam_index_fetch_tuple(struct IndexFetchTableData *scan,
{
/* Switch to correct buffer if we don't have it already */
Buffer prev_buf = hscan->xs_cbuf;
+ bool release_prev = hscan->xs_cbuf_blk != InvalidBlockNumber;
- hscan->xs_cbuf = ReleaseAndReadBuffer(hscan->xs_cbuf,
- hscan->xs_base.rel,
- ItemPointerGetBlockNumber(tid));
+ /*
+ * Read the block for the requested TID. With a read stream, simply
+ * read the next block we queued earlier (from the callback).
+ * Otherwise just do the regular read using the TID.
+ *
+ * XXX It's a bit fragile to just read buffers, expecting the right
+ * block, which we queued from the callback sometime much earlier. If
+ * the two streams get out of sync in any way (which can happen
+ * easily, due to some optimization heuristics), it may misbehave in
+ * strange ways.
+ *
+ * XXX We need to support both the old ReadBuffer and ReadStream, as
+ * some places are unlikely to benefit from a read stream - e.g.
+ * because they only fetch a single tuple. So better to support this.
+ *
+ * XXX Another reason is that some index AMs may not support the
+ * batching interface, which is a prerequisite for using read_stream
+ * API.
+ */
+ if (scan->rs)
+ {
+ /*
+ * If we're trying to read the same block as the last time, don't
+ * try reading it from the stream again, but just return the last
+ * buffer. We need to check if the previous buffer is still pinned
+ * and contains the correct block (it might have been unpinned,
+ * used for a different block, so we need to be careful).
+ *
+ * The place scheduling the blocks (index_scan_stream_read_next)
+ * needs to do the same thing and not schedule the blocks if it
+ * matches the previous one. Otherwise the stream will get out of
+ * sync, causing confusion.
+ *
+ * This is what ReleaseAndReadBuffer does too, but it does not
+ * have a queue of requests scheduled from somewhere else, so it
+ * does not need to worry about that.
+ *
+ * XXX Maybe we should remember the block in IndexFetchTableData,
+ * so that we can make the check even cheaper, without looking at
+ * the buffer descriptor? But that assumes the buffer was not
+ * unpinned (or repinned) elsewhere, before we got back here. But
+ * can that even happen? If yes, I guess we shouldn't be releasing
+ * the prev buffer anyway.
+ *
+ * XXX This has undesired impact on prefetch distance. The read
+ * stream schedules reads for a certain number of future blocks,
+ * but if we skip duplicate blocks, the prefetch distance may get
+ * unexpectedly large (e.g. for correlated indexes, with long runs
+ * of TIDs from the same heap page). This may spend a lot of CPU
+ * time in the index_scan_stream_read_next callback, but more
+ * importantly it may require reading (and keeping) a lot of leaf
+ * pages from the index.
+ *
+ * XXX What if we pinned the buffer twice (increase the refcount),
+ * so that if the caller unpins the buffer, we still keep the
+ * second pin. Wouldn't that mean we don't need to worry about the
+ * possibility someone loaded another page into the buffer?
+ *
+ * XXX We might also keep a longer history of recent blocks, not
+ * just the immediately preceding one. But that makes it harder,
+ * because the two places (read_next callback and here) need to
+ * have a slightly different view.
+ */
+ if (hscan->xs_cbuf_blk == ItemPointerGetBlockNumber(tid))
+ release_prev = false;
+ else
+ {
+ hscan->xs_cbuf = read_stream_next_buffer(scan->rs, NULL);
+ hscan->xs_cbuf_blk = BufferGetBlockNumber(hscan->xs_cbuf);
+ }
+ }
+ else
+ hscan->xs_cbuf = ReleaseAndReadBuffer(hscan->xs_cbuf,
+ hscan->xs_base.rel,
+ ItemPointerGetBlockNumber(tid));
+
+ /* We should always get a valid buffer for a valid TID. */
+ Assert(BufferIsValid(hscan->xs_cbuf));
+
+ /*
+ * Did we read the expected block number (per the TID)? For the
+ * regular buffer reads this should always match, but with the read
+ * stream it might disagree due to a bug elsewhere (happened
+ * repeatedly).
+ */
+ Assert(BufferGetBlockNumber(hscan->xs_cbuf) == ItemPointerGetBlockNumber(tid));
/*
* Prune page, but only if we weren't already on this page
*/
if (prev_buf != hscan->xs_cbuf)
heap_page_prune_opt(hscan->xs_base.rel, hscan->xs_cbuf);
+
+ /*
+ * When using the read stream, release the old buffer - but only if
+ * we're reading a different block.
+ *
+ * XXX Not sure this is really needed, or maybe this is not the right
+ * place to do this, and buffers should be released elsewhere. The
+ * problem is that other place may not really know if the index scan
+ * uses read stream API.
+ *
+ * XXX We need to do this, because otherwise the caller would need to
+ * do different things depending on whether the read_stream was used
+ * or not. With the read_stream it'd have to also explicitly release
+ * the buffers, but doing that for every caller seems error prone
+ * (easy to forget). It's also not clear whether it would free the
+ * buffer before or after the index_fetch_tuple call (we don't know if
+ * the buffer changed until *after* the call, etc.).
+ *
+ * XXX Does this do the right thing when reading the same page? That
+ * should return the same buffer, so won't we release it prematurely?
+ */
+ if (scan->rs && prev_buf != InvalidBuffer && release_prev)
+ ReleaseBuffer(prev_buf);
}
/* Obtain share-lock on the buffer so we can examine visibility */
diff --git a/src/backend/access/index/genam.c b/src/backend/access/index/genam.c
index 0cb27af13..55e60c9ff 100644
--- a/src/backend/access/index/genam.c
+++ b/src/backend/access/index/genam.c
@@ -89,6 +89,7 @@ RelationGetIndexScan(Relation indexRelation, int nkeys, int norderbys)
scan->xs_snapshot = InvalidSnapshot; /* caller must initialize this */
scan->numberOfKeys = nkeys;
scan->numberOfOrderBys = norderbys;
+ scan->batchState = NULL; /* used by amgetbatch index AMs */
/*
* We allocate key workspace here, but it won't get filled until amrescan.
diff --git a/src/backend/access/index/indexam.c b/src/backend/access/index/indexam.c
index 219df1971..d831ebde2 100644
--- a/src/backend/access/index/indexam.c
+++ b/src/backend/access/index/indexam.c
@@ -44,6 +44,7 @@
#include "postgres.h"
#include "access/amapi.h"
+#include "access/nbtree.h" /* XXX for MaxTIDsPerBTreePage (should remove) */
#include "access/relation.h"
#include "access/reloptions.h"
#include "access/relscan.h"
@@ -107,8 +108,69 @@ do { \
static IndexScanDesc index_beginscan_internal(Relation indexRelation,
int nkeys, int norderbys, Snapshot snapshot,
ParallelIndexScanDesc pscan, bool temp_snap);
+static ItemPointer index_batch_getnext_tid(IndexScanDesc scan, ScanDirection direction);
+static ItemPointer index_retail_getnext_tid(IndexScanDesc scan, ScanDirection direction);
static inline void validate_relation_kind(Relation r);
+/* index batching */
+static void index_batch_init(IndexScanDesc scan);
+static void index_batch_reset(IndexScanDesc scan, bool complete);
+static void index_batch_end(IndexScanDesc scan);
+static bool index_batch_getnext(IndexScanDesc scan);
+static void index_batch_free(IndexScanDesc scan, IndexScanBatch batch);
+
+static BlockNumber index_scan_stream_read_next(ReadStream *stream,
+ void *callback_private_data,
+ void *per_buffer_data);
+
+static bool index_batch_pos_advance(IndexScanDesc scan, IndexScanBatchPos *pos);
+static void index_batch_pos_reset(IndexScanDesc scan, IndexScanBatchPos *pos);
+static void index_batch_kill_item(IndexScanDesc scan);
+
+static void AssertCheckBatchPosValid(IndexScanDesc scan, IndexScanBatchPos *pos);
+static void AssertCheckBatch(IndexScanDesc scan, IndexScanBatch batch);
+static void AssertCheckBatches(IndexScanDesc scan);
+
+
+#define INDEX_SCAN_BATCH(scan, idx) \
+ ((scan)->batchState->batches[(idx) % (scan)->batchState->maxBatches])
+
+#ifdef INDEXAM_DEBUG
+#define DEBUG_LOG(...) elog(AmRegularBackendProcess() ? NOTICE : DEBUG2, __VA_ARGS__)
+#else
+#define DEBUG_LOG(...)
+#endif
+
+/* debug: print info about current batches */
+static void
+index_batch_print(const char *label, IndexScanDesc scan)
+{
+#ifdef INDEXAM_DEBUG
+ IndexScanBatchState *batches = scan->batchState;
+
+ if (!scan->batchState)
+ return;
+
+ if (!AmRegularBackendProcess())
+ return;
+ if (IsCatalogRelation(scan->indexRelation))
+ return;
+
+ DEBUG_LOG("%s: batches firstBatch %d nextBatch %d maxBatches %d",
+ label,
+ batches->firstBatch, batches->nextBatch, batches->maxBatches);
+
+ for (int i = batches->firstBatch; i < batches->nextBatch; i++)
+ {
+ IndexScanBatchData *batch = INDEX_SCAN_BATCH(scan, i);
+ BTScanPos pos = (BTScanPos) batch->pos;
+
+ DEBUG_LOG("%s: batch %d currPage %u %p first %d last %d item %d killed %d",
+ label, i, pos->currPage, batch, batch->firstItem, batch->lastItem,
+ batch->itemIndex, batch->numKilled);
+ }
+#endif
+}
/* ----------------------------------------------------------------
* index_ interface functions
@@ -259,6 +321,7 @@ index_beginscan(Relation heapRelation,
IndexScanInstrumentation *instrument,
int nkeys, int norderbys)
{
+ ReadStream *rs = NULL;
IndexScanDesc scan;
Assert(snapshot != InvalidSnapshot);
@@ -273,8 +336,22 @@ index_beginscan(Relation heapRelation,
scan->xs_snapshot = snapshot;
scan->instrument = instrument;
+ if (indexRelation->rd_indam->amgetbatch != NULL)
+ {
+ index_batch_init(scan);
+
+ /* initialize stream */
+ rs = read_stream_begin_relation(READ_STREAM_DEFAULT,
+ NULL,
+ heapRelation,
+ MAIN_FORKNUM,
+ index_scan_stream_read_next,
+ scan,
+ 0);
+ }
+
/* prepare to fetch index matches from table */
- scan->xs_heapfetch = table_index_fetch_begin(heapRelation);
+ scan->xs_heapfetch = table_index_fetch_begin(heapRelation, rs);
return scan;
}
@@ -370,6 +447,19 @@ index_rescan(IndexScanDesc scan,
scan->kill_prior_tuple = false; /* for safety */
scan->xs_heap_continue = false;
+ /*
+ * Reset the batching. This makes it look like there are no batches,
+ * discards reads already scheduled to the read stream, etc.
+ *
+ * XXX We do this before calling amrescan, so that it could reinitialize
+ * everything (this probably does not matter very much, now that we've
+ * moved all the batching logic to indexam.c, it was more important when
+ * the index AM was responsible for more of it).
+ *
+ * XXX Maybe this should also happen before table_index_fetch_reset?
+ */
+ index_batch_reset(scan, true);
+
scan->indexRelation->rd_indam->amrescan(scan, keys, nkeys,
orderbys, norderbys);
}
@@ -384,6 +474,9 @@ index_endscan(IndexScanDesc scan)
SCAN_CHECKS;
CHECK_SCAN_PROCEDURE(amendscan);
+ /* Cleanup batching, so that the AM can release pins and so on. */
+ index_batch_end(scan);
+
/* Release resources (like buffer pins) from table accesses */
if (scan->xs_heapfetch)
{
@@ -411,10 +504,37 @@ index_endscan(IndexScanDesc scan)
void
index_markpos(IndexScanDesc scan)
{
- SCAN_CHECKS;
- CHECK_SCAN_PROCEDURE(ammarkpos);
+ IndexScanBatchState *batchState = scan->batchState;
+ IndexScanBatchPos *pos = &batchState->markPos;
+ IndexScanBatchData *batch = batchState->markBatch;
- scan->indexRelation->rd_indam->ammarkpos(scan);
+ SCAN_CHECKS;
+
+ /*
+ * Free the previous mark batch (if any), but only if the batch is no
+ * longer valid (in the current first/next range). This means that if
+ * we're marking the same batch (different item), we don't really do
+ * anything.
+ *
+ * XXX Should have some macro for this check, I guess.
+ */
+ if (batch != NULL && (pos->batch < batchState->firstBatch ||
+ pos->batch >= batchState->nextBatch))
+ {
+ batchState->markBatch = NULL;
+ index_batch_free(scan, batch);
+ }
+
+ /* just copy the read position (which has to be valid) */
+ batchState->markPos = batchState->readPos;
+ batchState->markBatch = INDEX_SCAN_BATCH(scan, batchState->markPos.batch);
+
+ /*
+ * FIXME we need to make sure the batch does not get freed during the
+ * regular advances.
+ */
+
+ AssertCheckBatchPosValid(scan, &batchState->markPos);
}
/* ----------------
@@ -435,9 +555,14 @@ index_markpos(IndexScanDesc scan)
void
index_restrpos(IndexScanDesc scan)
{
+ IndexScanBatchState *batchState;
+ IndexScanBatchPos *markPos;
+ IndexScanBatchData *markBatch;
+
Assert(IsMVCCSnapshot(scan->xs_snapshot));
SCAN_CHECKS;
+ CHECK_SCAN_PROCEDURE(amgetbatch);
CHECK_SCAN_PROCEDURE(amrestrpos);
/* release resources (like buffer pins) from table accesses */
@@ -447,7 +572,46 @@ index_restrpos(IndexScanDesc scan)
scan->kill_prior_tuple = false; /* for safety */
scan->xs_heap_continue = false;
- scan->indexRelation->rd_indam->amrestrpos(scan);
+ batchState = scan->batchState;
+ markPos = &batchState->markPos;
+ markBatch = scan->batchState->markBatch;
+
+ /*
+ * Call amrestrpos to let index AM know that we're doing this (just resets
+ * scan's array keys currently)
+ */
+ scan->indexRelation->rd_indam->amrestrpos(scan, markBatch);
+
+ /*
+ * XXX The pos can be invalid, if we already advanced past the the marked
+ * batch (and stashed it in markBatch instead of freeing). So this assert
+ * would be incorrect.
+ */
+ /* AssertCheckBatchPosValid(scan, &pos); */
+
+ /* FIXME we should still check the batch was not freed yet */
+
+ /*
+ * Reset the batching state, except for the marked batch, and make it look
+ * like we have a single batch - the marked one.
+ *
+ * XXX This seems a bit ugly / hacky, maybe there's a more elegant way to
+ * do this?
+ */
+ index_batch_reset(scan, false);
+
+ batchState->markPos = *markPos;
+ batchState->readPos = *markPos;
+ batchState->firstBatch = markPos->batch;
+ batchState->nextBatch = (batchState->firstBatch + 1);
+
+ INDEX_SCAN_BATCH(scan, batchState->markPos.batch) = markBatch;
+
+ /*
+ * XXX I really dislike that we have so many definitions of "current"
+ * batch. We have readPos, streamPos, ... seems very ad hoc
+ */
+ batchState->markBatch = markBatch; /* also remember this */
}
/*
@@ -569,6 +733,18 @@ index_parallelrescan(IndexScanDesc scan)
if (scan->xs_heapfetch)
table_index_fetch_reset(scan->xs_heapfetch);
+ /*
+ * Reset the batching. This makes it look like there are no batches,
+ * discards reads already scheduled to the read stream, etc. We Do this
+ * before calling amrescan, so that it can reinitialize everything.
+ *
+ * XXX We do this before calling amparallelrescan, so that it could
+ * reinitialize everything (this probably does not matter very much, now
+ * that we've moved all the batching logic to indexam.c, it was more
+ * important when the index AM was responsible for more of it).
+ */
+ index_batch_reset(scan, true);
+
/* amparallelrescan is optional; assume no-op if not provided by AM */
if (scan->indexRelation->rd_indam->amparallelrescan != NULL)
scan->indexRelation->rd_indam->amparallelrescan(scan);
@@ -587,6 +763,7 @@ index_beginscan_parallel(Relation heaprel, Relation indexrel,
{
Snapshot snapshot;
IndexScanDesc scan;
+ ReadStream *rs = NULL;
Assert(RelFileLocatorEquals(heaprel->rd_locator, pscan->ps_locator));
Assert(RelFileLocatorEquals(indexrel->rd_locator, pscan->ps_indexlocator));
@@ -604,8 +781,22 @@ index_beginscan_parallel(Relation heaprel, Relation indexrel,
scan->xs_snapshot = snapshot;
scan->instrument = instrument;
+ if (indexrel->rd_indam->amgetbatch != NULL)
+ {
+ index_batch_init(scan);
+
+ /* initialize stream */
+ rs = read_stream_begin_relation(READ_STREAM_DEFAULT,
+ NULL,
+ heaprel,
+ MAIN_FORKNUM,
+ index_scan_stream_read_next,
+ scan,
+ 0);
+ }
+
/* prepare to fetch index matches from table */
- scan->xs_heapfetch = table_index_fetch_begin(heaprel);
+ scan->xs_heapfetch = table_index_fetch_begin(heaprel, rs);
return scan;
}
@@ -620,14 +811,259 @@ index_beginscan_parallel(Relation heaprel, Relation indexrel,
ItemPointer
index_getnext_tid(IndexScanDesc scan, ScanDirection direction)
{
- bool found;
-
SCAN_CHECKS;
- CHECK_SCAN_PROCEDURE(amgettuple);
/* XXX: we should assert that a snapshot is pushed or registered */
Assert(TransactionIdIsValid(RecentXmin));
+ /*
+ * Index AMs that support plain index scans must provide exactly one of
+ * either the amgetbatch or amgettuple callbacks
+ */
+ Assert(!(scan->indexRelation->rd_indam->amgettuple != NULL &&
+ scan->indexRelation->rd_indam->amgetbatch != NULL));
+
+ if (scan->batchState != NULL)
+ return index_batch_getnext_tid(scan, direction);
+ else
+ return index_retail_getnext_tid(scan, direction);
+}
+
+/* ----------------
+ * index_getnext_batch_tid - ambatch index_getnext_tid implementation
+ *
+ * If we advance to the next batch, we release the previous one (unless it's
+ * tracked for mark/restore).
+ *
+ * Returns the first/next TID, or NULL if no more items.
+ *
+ * FIXME This only sets xs_heaptid and xs_itup (if requested). Not sure if
+ * we need to do something with xs_hitup. Should this set xs_hitup?
+ *
+ * XXX Maybe if we advance the position to the next batch, we could keep the
+ * batch for a bit more, in case the scan direction changes (as long as it
+ * fits into maxBatches)? But maybe that's unnecessary complexity for too
+ * little gain, we'd need to be careful about releasing the batches lazily.
+ * ----------------
+ */
+static ItemPointer
+index_batch_getnext_tid(IndexScanDesc scan, ScanDirection direction)
+{
+ IndexScanBatchPos *pos;
+
+ CHECK_SCAN_PROCEDURE(amgetbatch);
+
+ /* shouldn't get here without batching */
+ AssertCheckBatches(scan);
+
+ /* read the next TID from the index */
+ pos = &scan->batchState->readPos;
+
+ /*
+ * Handle change of scan direction (reset stream, ...).
+ *
+ * Release future batches properly, to make it look like the current batch
+ * is the last one we loaded. Also reset the stream position, as if we are
+ * just starting the scan.
+ */
+ if (scan->batchState->direction != direction)
+ {
+ /* release "future" batches in the wrong direction */
+ while (scan->batchState->nextBatch > scan->batchState->firstBatch + 1)
+ {
+ IndexScanBatch batch;
+
+ scan->batchState->nextBatch--;
+ batch = INDEX_SCAN_BATCH(scan, scan->batchState->nextBatch);
+ index_batch_free(scan, batch);
+ }
+
+ /*
+ * Remember the new direction, and make sure the scan is not marked as
+ * "finished" (we might have already read the last batch, but now we
+ * need to start over). Do this before resetting the stream - it
+ * should not invoke the callback until the first read, but it may
+ * seem a bit confusing otherwise.
+ */
+ scan->batchState->direction = direction;
+ scan->batchState->finished = false;
+ scan->batchState->lastBlock = InvalidBlockNumber;
+
+ index_batch_pos_reset(scan, &scan->batchState->streamPos);
+ read_stream_reset(scan->xs_heapfetch->rs);
+ }
+
+ DEBUG_LOG("index_batch_getnext_tid pos %d %d direction %d",
+ pos->batch, pos->index, direction);
+
+ /*
+ * Try advancing the batch position. If that doesn't succeed, it means we
+ * don't have more items in the current batch, and there's no future batch
+ * loaded. So try loading another batch, and maybe retry.
+ *
+ * FIXME This loop shouldn't happen more than twice. Maybe we should have
+ * some protection against infinite loops? If the advance/getnext
+ * functions get to disagree?
+ */
+ while (true)
+ {
+ /*
+ * If we manage to advance to the next items, return it and we're
+ * done. Otherwise try loading another batch.
+ */
+ if (index_batch_pos_advance(scan, pos))
+ {
+ IndexScanBatchData *batch = INDEX_SCAN_BATCH(scan, pos->batch);
+
+ /* set the TID / itup for the scan */
+ scan->xs_heaptid = batch->items[pos->index].heapTid;
+ if (scan->xs_want_itup)
+ scan->xs_itup =
+ (IndexTuple) (batch->currTuples +
+ batch->items[pos->index].tupleOffset);
+
+ DEBUG_LOG("pos batch %p first %d last %d pos %d/%d TID (%u,%u)",
+ batch, batch->firstItem, batch->lastItem,
+ pos->batch, pos->index,
+ ItemPointerGetBlockNumber(&scan->xs_heaptid),
+ ItemPointerGetOffsetNumber(&scan->xs_heaptid));
+
+ /*
+ * If we advanced to the next batch, release the batch we no
+ * longer need. The positions is the "read" position, and we can
+ * compare it to firstBatch.
+ */
+ if (pos->batch != scan->batchState->firstBatch)
+ {
+ batch = INDEX_SCAN_BATCH(scan, scan->batchState->firstBatch);
+ Assert(batch != NULL);
+
+ /*
+ * XXX When advancing readPos, the streamPos may get behind as
+ * we're only advancing it when actually requesting heap
+ * blocks. But we may not do that often enough - e.g. IOS may
+ * not need to access all-visible heap blocks, so the
+ * read_next callback does not get invoked for a long time.
+ * It's possible the stream gets so mucu behind the position
+ * gets invalid, as we already removed the batch. But that
+ * means we don't need any heap blocks until the current read
+ * position - if we did, we would not be in this situation (or
+ * it's a sign of a bug, as those two places are expected to
+ * be in sync). So if the streamPos still points at the batch
+ * we're about to free, just reset the position - we'll set it
+ * to readPos in the read_next callback later.
+ *
+ * XXX This can happen after the queue gets full, we "pause"
+ * the stream, and then reset it to continue. But I think that
+ * just increases the probability of hitting the issue, it's
+ * just more chance to to not advance the streamPos, which
+ * depends on when we try to fetch the first heap block after
+ * calling read_stream_reset().
+ */
+ if (scan->batchState->streamPos.batch == scan->batchState->firstBatch)
+ {
+ elog(WARNING, "index_batch_pos_reset called early due to scan->batchState->streamPos.batch == scan->batchState->firstBatch");
+ index_batch_pos_reset(scan, &scan->batchState->streamPos);
+ }
+
+ DEBUG_LOG("index_batch_getnext_tid free batch %p firstBatch %d nextBatch %d",
+ batch,
+ scan->batchState->firstBatch,
+ scan->batchState->nextBatch);
+
+ /* Free the batch (except when it's needed for mark/restore). */
+ index_batch_free(scan, batch);
+
+ /*
+ * In any case, remove the batch from the regular queue, even
+ * if we kept it for mar/restore.
+ */
+ scan->batchState->firstBatch++;
+
+ DEBUG_LOG("index_batch_getnext_tid batch freed firstBatch %d nextBatch %d",
+ scan->batchState->firstBatch,
+ scan->batchState->nextBatch);
+
+ index_batch_print("index_batch_getnext_tid / free old batch", scan);
+
+ /* we can't skip any batches */
+ Assert(scan->batchState->firstBatch == pos->batch);
+ }
+
+ return &scan->xs_heaptid;
+ }
+
+ /*
+ * We failed to advance, i.e. we ran out of currently loaded batches.
+ * So if we filled the queue, this is a good time to reset the stream
+ * (before we try loading the next batch).
+ */
+ if (scan->batchState->reset)
+ {
+ DEBUG_LOG("resetting read stream pos %d,%d",
+ scan->batchState->readPos.batch, scan->batchState->readPos.index);
+
+ scan->batchState->reset = false;
+ scan->batchState->lastBlock = InvalidBlockNumber;
+
+ /*
+ * Need to reset the stream position, it might be too far behind.
+ * Ultimately we want to set it to readPos, but we can't do that
+ * yet - readPos still point sat the old batch, so just reset it
+ * and we'll init it to readPos later in the callback.
+ */
+ index_batch_pos_reset(scan, &scan->batchState->streamPos);
+
+ read_stream_reset(scan->xs_heapfetch->rs);
+ }
+
+ /*
+ * Failed to advance the read position, so try reading the next batch.
+ * If this fails, we're done - there's nothing more to load.
+ *
+ * Most of the batches should be loaded from read_stream_next_buffer,
+ * but we need to call index_batch_getnext here too, for two reasons.
+ * First, the read_stream only gets working after we try fetching the
+ * first heap tuple, so we need to load the first batch from here.
+ * Second, while most batches will be preloaded by the stream thank's
+ * to prefetching, it's possible to set effective_io_concurrency=0, in
+ * which case all the batch loads happen from here.
+ */
+ if (!index_batch_getnext(scan))
+ break;
+
+ DEBUG_LOG("loaded next batch, retry to advance position");
+ }
+
+ /*
+ * If we get here, we failed to advance the position and there are no more
+ * batches, so we're done.
+ */
+ DEBUG_LOG("no more batches to process");
+
+ /*
+ * Reset the position - we must not keep the last valid position, in case
+ * we change direction of the scan and start scanning again. If we kept
+ * the position, we'd skip the first item.
+ */
+ index_batch_pos_reset(scan, pos);
+
+ return NULL;
+}
+
+/* ----------------
+ * index_retail_getnext_tid - amgettuple index_getnext_tid implementation
+ *
+ * Returns the first/next TID, or NULL if no more items.
+ * ----------------
+ */
+static ItemPointer
+index_retail_getnext_tid(IndexScanDesc scan, ScanDirection direction)
+{
+ bool found;
+
+ CHECK_SCAN_PROCEDURE(amgettuple);
+
/*
* The AM's amgettuple proc finds the next index entry matching the scan
* keys, and puts the TID into scan->xs_heaptid. It should also set
@@ -694,9 +1130,18 @@ index_fetch_heap(IndexScanDesc scan, TupleTableSlot *slot)
* amgettuple call, in index_getnext_tid). We do not do this when in
* recovery because it may violate MVCC to do so. See comments in
* RelationGetIndexScan().
+ *
+ * XXX For scans using batching, record the flag in the batch (we will
+ * pass it to the AM later, when freeing it). Otherwise just pass it to
+ * the AM using the kill_prior_tuple field.
*/
if (!scan->xactStartedInRecovery)
- scan->kill_prior_tuple = all_dead;
+ {
+ if (scan->batchState == NULL)
+ scan->kill_prior_tuple = all_dead;
+ else if (all_dead)
+ index_batch_kill_item(scan);
+ }
return found;
}
@@ -1084,3 +1529,745 @@ index_opclass_options(Relation indrel, AttrNumber attnum, Datum attoptions,
return build_local_reloptions(&relopts, attoptions, validate);
}
+
+/*
+ * Maximum number of batches (leaf pages) we can keep in memory.
+ *
+ * The value 64 value is arbitrary, it's about 1MB of data with 8KB pages. We
+ * should not really need this many batches - we need a certain number of TIDs,
+ * to satisfy the prefetch distance, and there usually are many index tuples
+ * per page. In the worst case we might have one index tuple per leaf page,
+ * but even that may not quite work in some cases.
+ *
+ * But there may be cases when this does not work - some examples:
+ *
+ * a) the index may be bloated, with many pages only have a single index item
+ *
+ * b) the index is correlated, and we skip prefetches of duplicate blocks
+ *
+ * c) we may be doing index-only scan, and we don't prefetch all-visible pages
+ *
+ * So we might need to load huge number of batches before we find the first
+ * block to load from the table. Or enough pages to satisfy the prefetch
+ * distance.
+ *
+ * XXX Currently, once we hit this number of batches, we fail in the stream
+ * callback (or rather in index_batch_getnext), because that's where we load
+ * batches. It'd be nice to "pause" the read stream for a bit instead, but
+ * there's no built-in way to do that. So we can only "stop" the stream by
+ * returning InvalidBlockNumber. But we could also remember this, and do
+ * read_stream_reset() to continue, after consuming all the already scheduled
+ * blocks.
+ *
+ * XXX Maybe 64 is too high - it also defines the maximum amount of overhead
+ * allowed. In the worst case, reading a single row might trigger reading this
+ * many leaf pages (e.g. with IOS). Which might be an issue with LIMIT queries,
+ * when we actually won't need most of the leaf pages.
+ *
+ * XXX We could/should use a lower value for testing, to make it more likely
+ * we hit this issue. With 64 the whole check-world passes without hitting
+ * the limit, wo we wouldn't test it's handled correctly.
+ */
+#define INDEX_SCAN_MAX_BATCHES 64
+
+#define INDEX_SCAN_BATCH_COUNT(scan) \
+ ((scan)->batchState->nextBatch - (scan)->batchState->firstBatch)
+
+#define INDEX_SCAN_BATCH_LOADED(scan, idx) \
+ ((idx) < (scan)->batchState->nextBatch)
+
+#define INDEX_SCAN_BATCH_FULL(scan) \
+ (INDEX_SCAN_BATCH_COUNT(scan) == scan->batchState->maxBatches)
+
+/*
+ * Check that a position (batch,item) is valid with respect to the batches we
+ * have currently loaded.
+ *
+ * XXX The "marked" batch is an exception. The marked batch may get outside
+ * the range of current batches, so make sure to never check the position
+ * for that.
+ */
+static void
+AssertCheckBatchPosValid(IndexScanDesc scan, IndexScanBatchPos *pos)
+{
+#ifdef USE_ASSERT_CHECKING
+ IndexScanBatchState *batchState = scan->batchState;
+
+ /* make sure the position is valid for currently loaded batches */
+ Assert(pos->batch >= batchState->firstBatch);
+ Assert(pos->batch < batchState->nextBatch);
+#endif
+}
+
+/*
+ * Check a single batch is valid.
+ */
+static void
+AssertCheckBatch(IndexScanDesc scan, IndexScanBatch batch)
+{
+#ifdef USE_ASSERT_CHECKING
+ /* there must be valid range of items */
+ Assert(batch->firstItem <= batch->lastItem);
+ Assert(batch->firstItem >= 0);
+ Assert(batch->lastItem <= MaxTIDsPerBTreePage); /* XXX tied to BTREE */
+
+ /* we should have items (buffer and pointers) */
+ Assert(batch->items != NULL);
+
+ /*
+ * The number of killed items must be valid, and there must be an array of
+ * indexes if there are items.
+ */
+ Assert(batch->numKilled >= 0);
+ Assert(batch->numKilled <= MaxTIDsPerBTreePage); /* XXX tied to BTREE */
+ Assert(!(batch->numKilled > 0 && batch->killedItems == NULL));
+
+ /* XXX can we check some of the other batch fields? */
+#endif
+}
+
+/*
+ * Check invariants on current batches
+ *
+ * Makes sure the indexes are set as expected, the buffer size is within
+ * limits, and so on.
+ */
+static void
+AssertCheckBatches(IndexScanDesc scan)
+{
+#ifdef USE_ASSERT_CHECKING
+ IndexScanBatchState *batchState = scan->batchState;
+
+ /* we should have batches initialized */
+ Assert(batchState != NULL);
+
+ /* We should not have too many batches. */
+ Assert(batchState->maxBatches > 0 &&
+ batchState->maxBatches <= INDEX_SCAN_MAX_BATCHES);
+
+ /*
+ * The first/next indexes should define a valid range (in the cyclic
+ * buffer, and should not overflow maxBatches.
+ */
+ Assert(batchState->firstBatch >= 0 &&
+ batchState->firstBatch <= batchState->nextBatch);
+ Assert(batchState->nextBatch - batchState->firstBatch <=
+ batchState->maxBatches);
+
+ /* Check all current batches */
+ for (int i = batchState->firstBatch; i < batchState->nextBatch; i++)
+ {
+ IndexScanBatch batch = INDEX_SCAN_BATCH(scan, i);
+
+ AssertCheckBatch(scan, batch);
+ }
+#endif
+}
+
+/*
+ * index_batch_pos_advance
+ * Advance the position to the next item, depending on scan direction.
+ *
+ * Advance the position to the next item, either in the same batch or the
+ * following one (if already available).
+ *
+ * We can advance only if we already have some batches loaded, and there's
+ * either enough items in the current batch, or some more items in the
+ * subsequent batches.
+ *
+ * If this is the first advance, right after loading the first batch, the
+ * position is still be undefined. Otherwise we expect the position to be
+ * valid.
+ *
+ * Returns true if the position was advanced, false otherwise.
+ *
+ * The poisition is guaranteed to be valid only after an advance.
+ */
+static bool
+index_batch_pos_advance(IndexScanDesc scan, IndexScanBatchPos *pos)
+{
+ IndexScanBatchData *batch;
+ ScanDirection direction = scan->batchState->direction;
+
+ /* make sure we have batching initialized and consistent */
+ AssertCheckBatches(scan);
+
+ /* should know direction by now */
+ Assert(direction != NoMovementScanDirection);
+
+ /* We can't advance if there are no batches available. */
+ if (INDEX_SCAN_BATCH_COUNT(scan) == 0)
+ return false;
+
+ /*
+ * If the position has not been advanced yet, it has to be right after we
+ * loaded the first batch. In that case just initialize it to the first
+ * item in the batch (or last item, if it's backwards scaa).
+ *
+ * XXX Maybe we should just explicitly initialize the postition after
+ * loading the first batch, without having to go through the advance.
+ *
+ * XXX Add a macro INDEX_SCAN_POS_DEFINED() or something like this, to
+ * make this easier to understand.
+ */
+ if (pos->batch == -1 && pos->index == -1)
+ {
+ /*
+ * we should have loaded the very first batch
+ *
+ * XXX Actually, we might have changed the direction of the scan, and
+ * scanned all the way to the beginning/end. We reset the position,
+ * but we're not on the first batch - we should have only one batch,
+ * though.
+ */
+ batch = INDEX_SCAN_BATCH(scan, scan->batchState->firstBatch);
+
+ pos->batch = scan->batchState->firstBatch;
+
+ if (ScanDirectionIsForward(direction))
+ pos->index = batch->firstItem;
+ else
+ pos->index = batch->lastItem;
+
+ /* the position we just set has to be valid */
+ AssertCheckBatchPosValid(scan, pos);
+
+ return true;
+ }
+
+ /*
+ * The position is already defined, so we should have some batches loaded
+ * and the position has to be valid with respect to those.
+ */
+ AssertCheckBatchPosValid(scan, pos);
+
+ /*
+ * Advance to the next item in the same batch. If the position is for the
+ * last item in the batch, try advancing to the next batch (if loaded).
+ */
+ batch = INDEX_SCAN_BATCH(scan, pos->batch);
+
+ if (ScanDirectionIsForward(direction))
+ {
+ if (pos->index < batch->lastItem)
+ {
+ pos->index++;
+
+ /* the position has to be valid */
+ AssertCheckBatchPosValid(scan, pos);
+
+ return true;
+ }
+ }
+ else /* ScanDirectionIsBackward */
+ {
+ if (pos->index > batch->firstItem)
+ {
+ pos->index--;
+
+ /* the position has to be valid */
+ AssertCheckBatchPosValid(scan, pos);
+
+ return true;
+ }
+ }
+
+ /*
+ * We couldn't advance within the same batch, try advancing to the next
+ * batch, if it's already loaded.
+ */
+ if (INDEX_SCAN_BATCH_LOADED(scan, pos->batch + 1))
+ {
+ /* advance to the next batch */
+ pos->batch++;
+
+ batch = INDEX_SCAN_BATCH(scan, pos->batch);
+ Assert(batch != NULL);
+
+ if (ScanDirectionIsForward(direction))
+ pos->index = batch->firstItem;
+ else
+ pos->index = batch->lastItem;
+
+ /* the position has to be valid */
+ AssertCheckBatchPosValid(scan, pos);
+
+ return true;
+ }
+
+ /* can't advance */
+ return false;
+}
+
+/*
+ * index_batch_pos_reset
+ * Reset the position, so that it looks as if never advanced.
+ */
+static void
+index_batch_pos_reset(IndexScanDesc scan, IndexScanBatchPos *pos)
+{
+ pos->batch = -1;
+ pos->index = -1;
+}
+
+/*
+ * index_scan_stream_read_next
+ * return the next block to pass to the read stream
+ *
+ * This assumes the "current" scan direction, requested by the caller. If
+ * that changes before consuming all buffers, we'll reset the stream and start
+ * from scratch.
+ *
+ * The position of the read_stream is stored in streamPos, which may be
+ * ahead of the current readPos (which is what got consumed by the scan).
+ *
+ * The scan direction change is checked / handled elsewhere. Here we rely
+ * on having the correct value in xs_batches->direction.
+ */
+static BlockNumber
+index_scan_stream_read_next(ReadStream *stream,
+ void *callback_private_data,
+ void *per_buffer_data)
+{
+ IndexScanDesc scan = (IndexScanDesc) callback_private_data;
+ IndexScanBatchPos *pos = &scan->batchState->streamPos;
+
+ /* we should have set the direction already */
+ Assert(scan->batchState->direction != NoMovementScanDirection);
+
+ /*
+ * The read position has to be valid, because we initialize/advance it
+ * before maybe even attempting to read the heap tuple. And it lags behind
+ * the stream position, so it can't be invalid yet. If this is the first
+ * time for this callback, we will use the readPos to init streamPos, so
+ * better check it's valid.
+ */
+ AssertCheckBatchPosValid(scan, &scan->batchState->readPos);
+
+ /*
+ * Try to advance to the next item, and if there's none in the current
+ * batch, try loading the next batch.
+ *
+ * XXX This loop shouldn't happen more than twice, because if we fail to
+ * advance the position, we'll try to load the next batch and then in the
+ * next loop the advance has to succeed.
+ */
+ while (true)
+ {
+ bool advanced = false;
+
+ /*
+ * If the stream position is undefined, just use the read position.
+ *
+ * It's possible we got here only fairly late in the scan, e.g. if
+ * many tuples got skipped in the index-only scan, etc. In this case
+ * just use the read position as a starting point.
+ *
+ * The first batch is loaded from index_batch_getnext_tid(), because
+ * we don't get here until the first index_fetch_heap() call - only
+ * then can read_stream start loading more batches. It's also possible
+ * to disable prefetching (effective_io_concurrency=0), in which case
+ * all batches get loaded in index_batch_getnext_tid.
+ */
+ if (pos->batch == -1 && pos->index == -1)
+ {
+ *pos = scan->batchState->readPos;
+ advanced = true;
+ }
+ else if (index_batch_pos_advance(scan, pos))
+ {
+ advanced = true;
+ }
+
+ /* FIXME maybe check the streamPos is not behind readPos? */
+
+ /* If we advanced the position, return the block for the TID. */
+ if (advanced)
+ {
+ IndexScanBatch batch = INDEX_SCAN_BATCH(scan, pos->batch);
+ ItemPointer tid = &batch->items[pos->index].heapTid;
+
+ DEBUG_LOG("index_scan_stream_read_next: index %d TID (%u,%u)",
+ pos->index,
+ ItemPointerGetBlockNumber(tid),
+ ItemPointerGetOffsetNumber(tid));
+
+ /*
+ * if there's a prefetch callback, use it to decide if we will
+ * need to read the block
+ */
+ if (scan->batchState->prefetch &&
+ !scan->batchState->prefetch(scan,
+ scan->batchState->prefetchArg, pos))
+ {
+ DEBUG_LOG("index_scan_stream_read_next: skip block (callback)");
+ continue;
+ }
+
+ /* same block as before, don't need to read it */
+ if (scan->batchState->lastBlock == ItemPointerGetBlockNumber(tid))
+ {
+ DEBUG_LOG("index_scan_stream_read_next: skip block (lastBlock)");
+ continue;
+ }
+
+ scan->batchState->lastBlock = ItemPointerGetBlockNumber(tid);
+
+ return ItemPointerGetBlockNumber(tid);
+ }
+
+ /*
+ * Couldn't advance the position, so either there are no more items in
+ * the current batch, or maybe we don't have any batches yet (if is
+ * the first time through). Try loading the next batch - if that
+ * succeeds, try the advance again (and this time the advance should
+ * work).
+ *
+ * If we fail to load the next batch, we're done.
+ */
+ if (!index_batch_getnext(scan))
+ break;
+ }
+
+ /* no more items in this scan */
+ return InvalidBlockNumber;
+}
+
+/* ----------------
+ * index_batch_getnext - get the next batch of TIDs from a scan
+ *
+ * Returns true if we managed to read at least some TIDs into the batch, or
+ * false if there are no more TIDs in the scan. The batch load may fail for
+ * multiple reasons - there really may not be more batches in the scan, or
+ * maybe we reached INDEX_SCAN_MAX_BATCHES.
+ *
+ * Returns true if the batch was loaded successfully, false otherwise.
+ *
+ * XXX This only loads the TIDs and resets the various batch fields to
+ * fresh state. It does not set xs_heaptid/xs_itup/xs_hitup, that's the
+ * responsibility of the following index_batch_getnext_tid() calls.
+ * ----------------
+ */
+static bool
+index_batch_getnext(IndexScanDesc scan)
+{
+ IndexScanBatch batch = NULL;
+ ScanDirection direction = scan->batchState->direction;
+
+ SCAN_CHECKS;
+ CHECK_SCAN_PROCEDURE(amgetbatch);
+
+ /* XXX: we should assert that a snapshot is pushed or registered */
+ Assert(TransactionIdIsValid(RecentXmin));
+
+ /*
+ * If we already used the maximum number of batch slots available, it's
+ * pointless to try loading another one. This can happen for various
+ * reasons, e.g. for index-only scans on all-visible table, or skipping
+ * duplicate blocks on perfectly correlated indexes, etc.
+ *
+ * We could enlarge the array to allow more batches, but that's futile, we
+ * can always construct a case using more memory. Not only it would risk
+ * OOM, it'd also be inefficient because this happens early in the scan
+ * (so it'd interfere with LIMIT queries).
+ */
+ if (INDEX_SCAN_BATCH_FULL(scan))
+ {
+ DEBUG_LOG("index_batch_getnext: ran out of space for batches");
+ scan->batchState->reset = true;
+ }
+
+ /*
+ * Did we fill the batch queue, either in this or some earlier call? If
+ * yes, we have to consume everything from currently loaded batch before
+ * we reset the stream and continue. It's a bit like 'finished' but it's
+ * only a temporary pause, not the end of the stream.
+ */
+ if (scan->batchState->reset)
+ return NULL;
+
+ /*
+ * Did we already read the last batch for this scan?
+ *
+ * We may read the batches in two places, so we need to remember that,
+ * otherwise the retry restarts the scan.
+ *
+ * XXX This comment might be obsolete, from before using the read_stream.
+ *
+ * XXX Also, maybe we should do this before calling INDEX_SCAN_BATCH_FULL?
+ */
+ if (scan->batchState->finished)
+ return NULL;
+
+ index_batch_print("index_batch_getnext / start", scan);
+
+ /*
+ * Check if there's an existing batch that amgetbatch has to pick things
+ * up from
+ */
+ if (scan->batchState->firstBatch < scan->batchState->nextBatch)
+ batch = INDEX_SCAN_BATCH(scan, scan->batchState->nextBatch - 1);
+
+ batch = scan->indexRelation->rd_indam->amgetbatch(scan, batch, direction);
+ if (batch != NULL)
+ {
+ /*
+ * We got the batch from the AM, but we need to add it to the queue.
+ * Maybe that should be part of the "batch allocation" that happens in
+ * the AM?
+ */
+ int batchIndex = scan->batchState->nextBatch;
+
+ INDEX_SCAN_BATCH(scan, batchIndex) = batch;
+
+ scan->batchState->nextBatch++;
+
+ DEBUG_LOG("index_batch_getnext firstBatch %d nextBatch %d batch %p",
+ scan->batchState->firstBatch, scan->batchState->nextBatch, batch);
+ }
+ else
+ scan->batchState->finished = true;
+
+ AssertCheckBatches(scan);
+
+ index_batch_print("index_batch_getnext / end", scan);
+
+ return (batch != NULL);
+}
+
+/*
+ * index_batch_init
+ * Initialize various fields / arrays needed by batching.
+ *
+ * FIXME This is a bit ad-hoc hodge podge, due to how I was adding more and
+ * more pieces. Some of the fields may be not quite necessary, needs cleanup.
+ */
+static void
+index_batch_init(IndexScanDesc scan)
+{
+ /* init batching info, assume batching is supported by the AM */
+ Assert(scan->indexRelation->rd_indam->amgetbatch != NULL);
+ Assert(scan->indexRelation->rd_indam->amfreebatch != NULL);
+
+ scan->batchState = palloc0(sizeof(IndexScanBatchState));
+
+ /* We don't know direction of the scan yet. */
+ scan->batchState->direction = NoMovementScanDirection;
+
+ /*
+ * Initialize the batch.
+ *
+ * We prefer to eagerly drop leaf page pins before amgetbatch returns.
+ * This avoids making VACUUM wait to acquire a cleanup lock on the page.
+ *
+ * We cannot safely drop leaf page pins during index-only scans due to a
+ * race condition involving VACUUM setting pages all-visible in the VM.
+ * It's also unsafe for plain index scans that use a non-MVCC snapshot.
+ *
+ * When we drop pins eagerly, the mechanism that marks index tuples as
+ * LP_DEAD has to deal with concurrent TID recycling races. The scheme
+ * used to detect unsafe TID recycling won't work when scanning unlogged
+ * relations (since it involves saving an affected page's LSN). Opt out
+ * of eager pin dropping during unlogged relation scans for now.
+ */
+ scan->batchState->dropPin =
+ (!scan->xs_want_itup && IsMVCCSnapshot(scan->xs_snapshot) &&
+ RelationNeedsWAL(scan->indexRelation));
+ scan->batchState->maxBatches = INDEX_SCAN_MAX_BATCHES;
+ scan->batchState->firstBatch = 0; /* first batch */
+ scan->batchState->nextBatch = 0; /* first batch is empty */
+
+ scan->batchState->batches =
+ palloc(sizeof(IndexScanBatchData *) * scan->batchState->maxBatches);
+
+ /* positions in the queue of batches */
+ index_batch_pos_reset(scan, &scan->batchState->readPos);
+ index_batch_pos_reset(scan, &scan->batchState->streamPos);
+ index_batch_pos_reset(scan, &scan->batchState->markPos);
+
+ scan->batchState->lastBlock = InvalidBlockNumber;
+}
+
+/*
+ * index_batch_reset
+ * Reset the batch before reading the next chunk of data.
+ *
+ * complete - true means we reset even marked batch
+ *
+ * XXX Should this reset the batch memory context, xs_itup, xs_hitup, etc?
+ */
+static void
+index_batch_reset(IndexScanDesc scan, bool complete)
+{
+ IndexScanBatchState *batchState = scan->batchState;
+
+ /* bail out if batching not enabled */
+ if (!batchState)
+ return;
+
+ AssertCheckBatches(scan);
+
+ index_batch_print("index_batch_reset", scan);
+
+ /* With batching enabled, we should have a read stream. Reset it. */
+ Assert(scan->xs_heapfetch);
+ read_stream_reset(scan->xs_heapfetch->rs);
+
+ /* reset the positions */
+ index_batch_pos_reset(scan, &batchState->readPos);
+ index_batch_pos_reset(scan, &batchState->streamPos);
+
+ /*
+ * With "complete" reset, make sure to also free the marked batch, either
+ * by just forgetting it (if it's still in the queue), or by explicitly
+ * freeing it.
+ *
+ * XXX Do this before the loop, so that it calls the amfreebatch().
+ */
+ if (complete && batchState->markBatch != NULL)
+ {
+ IndexScanBatchPos *pos = &batchState->markPos;
+ IndexScanBatch batch = batchState->markBatch;
+
+ /* always reset the position, forget the marked batch */
+ batchState->markBatch = NULL;
+
+ /*
+ * If we've already moved past the marked batch (it's not in the
+ * current queue), free it explicitly. Otherwise it'll be in the freed
+ * later.
+ */
+ if (pos->batch < batchState->firstBatch ||
+ pos->batch >= batchState->nextBatch)
+ index_batch_free(scan, batch);
+
+ /* reset position only after the queue range check */
+ index_batch_pos_reset(scan, &batchState->markPos);
+ }
+
+ /* release all currently loaded batches */
+ while (batchState->firstBatch < batchState->nextBatch)
+ {
+ IndexScanBatch batch = INDEX_SCAN_BATCH(scan, batchState->firstBatch);
+
+ DEBUG_LOG("freeing batch %d %p", batchState->firstBatch, batch);
+
+ index_batch_free(scan, batch);
+
+ /* update the valid range, so that asserts / debugging works */
+ batchState->firstBatch++;
+ }
+
+ /* reset relevant batch state fields */
+ batchState->maxBatches = INDEX_SCAN_MAX_BATCHES;
+ batchState->firstBatch = 0; /* first batch */
+ batchState->nextBatch = 0; /* first batch is empty */
+
+ batchState->finished = false;
+ batchState->reset = false;
+ batchState->lastBlock = InvalidBlockNumber;
+
+ AssertCheckBatches(scan);
+}
+
+static void
+index_batch_kill_item(IndexScanDesc scan)
+{
+ IndexScanBatchPos *pos = &scan->batchState->readPos;
+ IndexScanBatchData *batch = INDEX_SCAN_BATCH(scan, pos->batch);
+
+ AssertCheckBatchPosValid(scan, pos);
+
+ /*
+ * XXX Maybe we can move the state that indicates if an item has been
+ * killed into IndexScanBatchData.items[] array.
+ *
+ * See:
+ * https://postgr.es/m/CAH2-WznLN7P0i2-YEnv3QGmeA5AMjdcjkraO_nz3H2Va1V1WOA@mail.gmail.com
+ */
+ if (batch->killedItems == NULL)
+ batch->killedItems = (int *)
+ palloc(MaxTIDsPerBTreePage * sizeof(int));
+ if (batch->numKilled < MaxTIDsPerBTreePage)
+ batch->killedItems[batch->numKilled++] = pos->index;
+}
+
+static void
+index_batch_free(IndexScanDesc scan, IndexScanBatch batch)
+{
+ SCAN_CHECKS;
+ CHECK_SCAN_PROCEDURE(amfreebatch);
+
+ AssertCheckBatch(scan, batch);
+
+ /* don't free the batch that is marked */
+ if (batch == scan->batchState->markBatch)
+ return;
+
+ scan->indexRelation->rd_indam->amfreebatch(scan, batch);
+}
+
+/* */
+static void
+index_batch_end(IndexScanDesc scan)
+{
+ index_batch_reset(scan, true);
+}
+
+IndexScanBatch
+index_batch_alloc(int maxitems, bool want_itup)
+{
+ IndexScanBatch batch = palloc(sizeof(IndexScanBatchData));
+
+ batch->firstItem = -1;
+ batch->lastItem = -1;
+ batch->itemIndex = -1;
+ batch->killedItems = NULL;
+ batch->numKilled = 0;
+
+ /*
+ * If we are doing an index-only scan, these are the tuple storage
+ * workspaces for the currPos and markPos respectively. Each is of size
+ * BLCKSZ, so it can hold as much as a full page's worth of tuples.
+ */
+ batch->currTuples = NULL; /* tuple storage for currPos */
+ if (want_itup)
+ batch->currTuples = palloc(BLCKSZ);
+
+ batch->items = palloc(sizeof(IndexScanBatchPosItem) * maxitems);
+ batch->pos = NULL;
+ batch->itemsvisibility = NULL; /* per-batch IOS visibility */
+
+ return batch;
+}
+
+/*
+ * Unlock batch->buf. If batch scan is dropPin, drop the pin, too. Dropping
+ * the pin prevents VACUUM from blocking on acquiring a cleanup lock.
+ *
+ * TODO: Restore Valgrind nbtree buffer lock instrumentation.
+ */
+void
+index_batch_unlock(Relation rel, bool dropPin, IndexScanBatch batch)
+{
+ if (!dropPin)
+ {
+ /* Just drop the lock (not the pin) */
+ LockBuffer(batch->buf, BUFFER_LOCK_UNLOCK);
+ return;
+ }
+
+ /*
+ * Drop both the lock and the pin.
+ *
+ * Have to set batch->lsn so that amfreebatch has a way to detect when
+ * concurrent heap TID recycling by VACUUM might have taken place. It'll
+ * only be safe to set any index tuple LP_DEAD bits when the page LSN
+ * hasn't advanced.
+ */
+ Assert(RelationNeedsWAL(rel));
+ batch->lsn = BufferGetLSNAtomic(batch->buf);
+ LockBuffer(batch->buf, BUFFER_LOCK_UNLOCK);
+ ReleaseBuffer(batch->buf);
+ batch->buf = InvalidBuffer; /* defensive */
+}
diff --git a/src/backend/access/nbtree/nbtree.c b/src/backend/access/nbtree/nbtree.c
index fdff960c1..e7ae7c7c7 100644
--- a/src/backend/access/nbtree/nbtree.c
+++ b/src/backend/access/nbtree/nbtree.c
@@ -158,10 +158,11 @@ bthandler(PG_FUNCTION_ARGS)
amroutine->amadjustmembers = btadjustmembers;
amroutine->ambeginscan = btbeginscan;
amroutine->amrescan = btrescan;
- amroutine->amgettuple = btgettuple;
+ amroutine->amgettuple = NULL;
+ amroutine->amgetbatch = btgetbatch;
+ amroutine->amfreebatch = btfreebatch;
amroutine->amgetbitmap = btgetbitmap;
amroutine->amendscan = btendscan;
- amroutine->ammarkpos = btmarkpos;
amroutine->amrestrpos = btrestrpos;
amroutine->amestimateparallelscan = btestimateparallelscan;
amroutine->aminitparallelscan = btinitparallelscan;
@@ -220,13 +221,12 @@ btinsert(Relation rel, Datum *values, bool *isnull,
}
/*
- * btgettuple() -- Get the next tuple in the scan.
+ * btgetbatch() -- Get the next batch of tuples in the scan.
*/
-bool
-btgettuple(IndexScanDesc scan, ScanDirection dir)
+IndexScanBatch
+btgetbatch(IndexScanDesc scan, IndexScanBatch batch, ScanDirection dir)
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
- bool res;
Assert(scan->heapRelation != NULL);
@@ -241,44 +241,18 @@ btgettuple(IndexScanDesc scan, ScanDirection dir)
* the appropriate direction. If we haven't done so yet, we call
* _bt_first() to get the first item in the scan.
*/
- if (!BTScanPosIsValid(so->currPos))
- res = _bt_first(scan, dir);
+ if (batch == NULL)
+ batch = _bt_first(scan, dir);
else
- {
- /*
- * Check to see if we should kill the previously-fetched tuple.
- */
- if (scan->kill_prior_tuple)
- {
- /*
- * Yes, remember it for later. (We'll deal with all such
- * tuples at once right before leaving the index page.) The
- * test for numKilled overrun is not just paranoia: if the
- * caller reverses direction in the indexscan then the same
- * item might get entered multiple times. It's not worth
- * trying to optimize that, so we don't detect it, but instead
- * just forget any excess entries.
- */
- if (so->killedItems == NULL)
- so->killedItems = (int *)
- palloc(MaxTIDsPerBTreePage * sizeof(int));
- if (so->numKilled < MaxTIDsPerBTreePage)
- so->killedItems[so->numKilled++] = so->currPos.itemIndex;
- }
+ batch = _bt_next(scan, dir, batch);
- /*
- * Now continue the scan.
- */
- res = _bt_next(scan, dir);
- }
-
- /* If we have a tuple, return it ... */
- if (res)
+ /* If we have a batch, return it ... */
+ if (batch)
break;
/* ... otherwise see if we need another primitive index scan */
} while (so->numArrayKeys && _bt_start_prim_scan(scan, dir));
- return res;
+ return batch;
}
/*
@@ -288,6 +262,7 @@ int64
btgetbitmap(IndexScanDesc scan, TIDBitmap *tbm)
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
+ IndexScanBatch batch;
int64 ntids = 0;
ItemPointer heapTid;
@@ -296,29 +271,30 @@ btgetbitmap(IndexScanDesc scan, TIDBitmap *tbm)
/* Each loop iteration performs another primitive index scan */
do
{
- /* Fetch the first page & tuple */
- if (_bt_first(scan, ForwardScanDirection))
+ /* Fetch the first batch */
+ if ((batch = _bt_first(scan, ForwardScanDirection)))
{
- /* Save tuple ID, and continue scanning */
- heapTid = &scan->xs_heaptid;
+ /* Save first tuple's TID */
+ heapTid = &batch->items[batch->firstItem].heapTid;
tbm_add_tuples(tbm, heapTid, 1, false);
ntids++;
for (;;)
{
- /*
- * Advance to next tuple within page. This is the same as the
- * easy case in _bt_next().
- */
- if (++so->currPos.itemIndex > so->currPos.lastItem)
+ /* Advance to next TID within page-sized batch */
+ if (++batch->itemIndex > batch->lastItem)
{
+ /* btfreebatch won't be called */
+ ReleaseBuffer(batch->buf);
+
/* let _bt_next do the heavy lifting */
- if (!_bt_next(scan, ForwardScanDirection))
+ batch = _bt_next(scan, ForwardScanDirection, batch);
+ if (!batch)
break;
}
/* Save tuple ID, and continue scanning */
- heapTid = &so->currPos.items[so->currPos.itemIndex].heapTid;
+ heapTid = &batch->items[batch->itemIndex].heapTid;
tbm_add_tuples(tbm, heapTid, 1, false);
ntids++;
}
@@ -346,8 +322,6 @@ btbeginscan(Relation rel, int nkeys, int norderbys)
/* allocate private workspace */
so = (BTScanOpaque) palloc(sizeof(BTScanOpaqueData));
- BTScanPosInvalidate(so->currPos);
- BTScanPosInvalidate(so->markPos);
if (scan->numberOfKeys > 0)
so->keyData = (ScanKey) palloc(scan->numberOfKeys * sizeof(ScanKeyData));
else
@@ -361,16 +335,6 @@ btbeginscan(Relation rel, int nkeys, int norderbys)
so->orderProcs = NULL;
so->arrayContext = NULL;
- so->killedItems = NULL; /* until needed */
- so->numKilled = 0;
-
- /*
- * We don't know yet whether the scan will be index-only, so we do not
- * allocate the tuple workspace arrays until btrescan. However, we set up
- * scan->xs_itupdesc whether we'll need it or not, since that's so cheap.
- */
- so->currTuples = so->markTuples = NULL;
-
scan->xs_itupdesc = RelationGetDescr(rel);
scan->opaque = so;
@@ -387,82 +351,53 @@ btrescan(IndexScanDesc scan, ScanKey scankey, int nscankeys,
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
- /* we aren't holding any read locks, but gotta drop the pins */
- if (BTScanPosIsValid(so->currPos))
- {
- /* Before leaving current page, deal with any killed items */
- if (so->numKilled > 0)
- _bt_killitems(scan);
- BTScanPosUnpinIfPinned(so->currPos);
- BTScanPosInvalidate(so->currPos);
- }
-
- /*
- * We prefer to eagerly drop leaf page pins before btgettuple returns.
- * This avoids making VACUUM wait to acquire a cleanup lock on the page.
- *
- * We cannot safely drop leaf page pins during index-only scans due to a
- * race condition involving VACUUM setting pages all-visible in the VM.
- * It's also unsafe for plain index scans that use a non-MVCC snapshot.
- *
- * When we drop pins eagerly, the mechanism that marks so->killedItems[]
- * index tuples LP_DEAD has to deal with concurrent TID recycling races.
- * The scheme used to detect unsafe TID recycling won't work when scanning
- * unlogged relations (since it involves saving an affected page's LSN).
- * Opt out of eager pin dropping during unlogged relation scans for now
- * (this is preferable to opting out of kill_prior_tuple LP_DEAD setting).
- *
- * Also opt out of dropping leaf page pins eagerly during bitmap scans.
- * Pins cannot be held for more than an instant during bitmap scans either
- * way, so we might as well avoid wasting cycles on acquiring page LSNs.
- *
- * See nbtree/README section on making concurrent TID recycling safe.
- *
- * Note: so->dropPin should never change across rescans.
- */
- so->dropPin = (!scan->xs_want_itup &&
- IsMVCCSnapshot(scan->xs_snapshot) &&
- RelationNeedsWAL(scan->indexRelation) &&
- scan->heapRelation != NULL);
-
- so->markItemIndex = -1;
- so->needPrimScan = false;
- so->scanBehind = false;
- so->oppositeDirCheck = false;
- BTScanPosUnpinIfPinned(so->markPos);
- BTScanPosInvalidate(so->markPos);
-
- /*
- * Allocate tuple workspace arrays, if needed for an index-only scan and
- * not already done in a previous rescan call. To save on palloc
- * overhead, both workspaces are allocated as one palloc block; only this
- * function and btendscan know that.
- *
- * NOTE: this data structure also makes it safe to return data from a
- * "name" column, even though btree name_ops uses an underlying storage
- * datatype of cstring. The risk there is that "name" is supposed to be
- * padded to NAMEDATALEN, but the actual index tuple is probably shorter.
- * However, since we only return data out of tuples sitting in the
- * currTuples array, a fetch of NAMEDATALEN bytes can at worst pull some
- * data out of the markTuples array --- running off the end of memory for
- * a SIGSEGV is not possible. Yeah, this is ugly as sin, but it beats
- * adding special-case treatment for name_ops elsewhere.
- */
- if (scan->xs_want_itup && so->currTuples == NULL)
- {
- so->currTuples = (char *) palloc(BLCKSZ * 2);
- so->markTuples = so->currTuples + BLCKSZ;
- }
-
/*
* Reset the scan keys
*/
if (scankey && scan->numberOfKeys > 0)
memcpy(scan->keyData, scankey, scan->numberOfKeys * sizeof(ScanKeyData));
+ so->needPrimScan = false;
+ so->scanBehind = false;
+ so->oppositeDirCheck = false;
so->numberOfKeys = 0; /* until _bt_preprocess_keys sets it */
so->numArrayKeys = 0; /* ditto */
}
+/*
+ * btfreebatch() -- Free batch, releasing its buffer pin
+ *
+ * XXX Should we really be freeing memory like this? What if we were to just
+ * reuse most memory across distinct pages, avoiding pfree/palloc cycles?
+ */
+void
+btfreebatch(IndexScanDesc scan, IndexScanBatch batch)
+{
+ /*
+ * Check to see if we should kill tuples from the previous batch.
+ */
+ if (batch->numKilled > 0)
+ _bt_killitems(scan, batch);
+
+ if (batch->items)
+ pfree(batch->items);
+
+ if (batch->itemsvisibility)
+ pfree(batch->itemsvisibility);
+
+ if (batch->currTuples)
+ pfree(batch->currTuples);
+
+ if (batch->pos)
+ {
+ if (!scan->batchState || !scan->batchState->dropPin)
+ ReleaseBuffer(batch->buf);
+
+ pfree(batch->pos);
+ }
+
+ pfree(batch);
+}
+
/*
* btendscan() -- close down a scan
*/
@@ -471,116 +406,34 @@ btendscan(IndexScanDesc scan)
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
- /* we aren't holding any read locks, but gotta drop the pins */
- if (BTScanPosIsValid(so->currPos))
- {
- /* Before leaving current page, deal with any killed items */
- if (so->numKilled > 0)
- _bt_killitems(scan);
- BTScanPosUnpinIfPinned(so->currPos);
- }
-
- so->markItemIndex = -1;
- BTScanPosUnpinIfPinned(so->markPos);
-
- /* No need to invalidate positions, the RAM is about to be freed. */
-
/* Release storage */
if (so->keyData != NULL)
pfree(so->keyData);
/* so->arrayKeys and so->orderProcs are in arrayContext */
if (so->arrayContext != NULL)
MemoryContextDelete(so->arrayContext);
- if (so->killedItems != NULL)
- pfree(so->killedItems);
- if (so->currTuples != NULL)
- pfree(so->currTuples);
- /* so->markTuples should not be pfree'd, see btrescan */
pfree(so);
}
/*
- * btmarkpos() -- save current scan position
+ * btrestrpos() -- prepare for restoring scan using a mark
*/
void
-btmarkpos(IndexScanDesc scan)
+btrestrpos(IndexScanDesc scan, IndexScanBatch markbatch)
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
+ BTScanPos pos;
- /* There may be an old mark with a pin (but no lock). */
- BTScanPosUnpinIfPinned(so->markPos);
+ if (!so->numArrayKeys)
+ return;
- /*
- * Just record the current itemIndex. If we later step to next page
- * before releasing the marked position, _bt_steppage makes a full copy of
- * the currPos struct in markPos. If (as often happens) the mark is moved
- * before we leave the page, we don't have to do that work.
- */
- if (BTScanPosIsValid(so->currPos))
- so->markItemIndex = so->currPos.itemIndex;
+ pos = (BTScanPos) markbatch->pos;
+ _bt_start_array_keys(scan, pos->dir);
+ so->needPrimScan = false;
+ if (ScanDirectionIsForward(pos->dir))
+ pos->moreRight = true;
else
- {
- BTScanPosInvalidate(so->markPos);
- so->markItemIndex = -1;
- }
-}
-
-/*
- * btrestrpos() -- restore scan to last saved position
- */
-void
-btrestrpos(IndexScanDesc scan)
-{
- BTScanOpaque so = (BTScanOpaque) scan->opaque;
-
- if (so->markItemIndex >= 0)
- {
- /*
- * The scan has never moved to a new page since the last mark. Just
- * restore the itemIndex.
- *
- * NB: In this case we can't count on anything in so->markPos to be
- * accurate.
- */
- so->currPos.itemIndex = so->markItemIndex;
- }
- else
- {
- /*
- * The scan moved to a new page after last mark or restore, and we are
- * now restoring to the marked page. We aren't holding any read
- * locks, but if we're still holding the pin for the current position,
- * we must drop it.
- */
- if (BTScanPosIsValid(so->currPos))
- {
- /* Before leaving current page, deal with any killed items */
- if (so->numKilled > 0)
- _bt_killitems(scan);
- BTScanPosUnpinIfPinned(so->currPos);
- }
-
- if (BTScanPosIsValid(so->markPos))
- {
- /* bump pin on mark buffer for assignment to current buffer */
- if (BTScanPosIsPinned(so->markPos))
- IncrBufferRefCount(so->markPos.buf);
- memcpy(&so->currPos, &so->markPos,
- offsetof(BTScanPosData, items[1]) +
- so->markPos.lastItem * sizeof(BTScanPosItem));
- if (so->currTuples)
- memcpy(so->currTuples, so->markTuples,
- so->markPos.nextTupleOffset);
- /* Reset the scan's array keys (see _bt_steppage for why) */
- if (so->numArrayKeys)
- {
- _bt_start_array_keys(scan, so->currPos.dir);
- so->needPrimScan = false;
- }
- }
- else
- BTScanPosInvalidate(so->currPos);
- }
+ pos->moreLeft = true;
}
/*
@@ -827,15 +680,6 @@ _bt_parallel_seize(IndexScanDesc scan, BlockNumber *next_scan_page,
*next_scan_page = InvalidBlockNumber;
*last_curr_page = InvalidBlockNumber;
- /*
- * Reset so->currPos, and initialize moreLeft/moreRight such that the next
- * call to _bt_readnextpage treats this backend similarly to a serial
- * backend that steps from *last_curr_page to *next_scan_page (unless this
- * backend's so->currPos is initialized by _bt_readfirstpage before then).
- */
- BTScanPosInvalidate(so->currPos);
- so->currPos.moreLeft = so->currPos.moreRight = true;
-
if (first)
{
/*
@@ -985,8 +829,6 @@ _bt_parallel_done(IndexScanDesc scan)
BTParallelScanDesc btscan;
bool status_changed = false;
- Assert(!BTScanPosIsValid(so->currPos));
-
/* Do nothing, for non-parallel scans */
if (parallel_scan == NULL)
return;
diff --git a/src/backend/access/nbtree/nbtsearch.c b/src/backend/access/nbtree/nbtsearch.c
index d69798795..3bae53c7c 100644
--- a/src/backend/access/nbtree/nbtsearch.c
+++ b/src/backend/access/nbtree/nbtsearch.c
@@ -24,63 +24,33 @@
#include "utils/lsyscache.h"
#include "utils/rel.h"
-
-static inline void _bt_drop_lock_and_maybe_pin(Relation rel, BTScanOpaque so);
static Buffer _bt_moveright(Relation rel, Relation heaprel, BTScanInsert key,
Buffer buf, bool forupdate, BTStack stack,
int access);
static OffsetNumber _bt_binsrch(Relation rel, BTScanInsert key, Buffer buf);
static int _bt_binsrch_posting(BTScanInsert key, Page page,
OffsetNumber offnum);
-static bool _bt_readpage(IndexScanDesc scan, ScanDirection dir,
- OffsetNumber offnum, bool firstpage);
-static void _bt_saveitem(BTScanOpaque so, int itemIndex,
- OffsetNumber offnum, IndexTuple itup);
-static int _bt_setuppostingitems(BTScanOpaque so, int itemIndex,
+static bool _bt_readpage(IndexScanDesc scan, IndexScanBatch newbatch,
+ ScanDirection dir, OffsetNumber offnum,
+ bool firstpage);
+static void _bt_saveitem(IndexScanBatch newbatch, int itemIndex,
+ OffsetNumber offnum, IndexTuple itup,
+ int *tupleOffset);
+static int _bt_setuppostingitems(IndexScanBatch newbatch, int itemIndex,
OffsetNumber offnum, ItemPointer heapTid,
- IndexTuple itup);
-static inline void _bt_savepostingitem(BTScanOpaque so, int itemIndex,
+ IndexTuple itup, int *tupleOffset);
+static inline void _bt_savepostingitem(IndexScanBatch newbatch, int itemIndex,
OffsetNumber offnum,
- ItemPointer heapTid, int tupleOffset);
-static inline void _bt_returnitem(IndexScanDesc scan, BTScanOpaque so);
-static bool _bt_steppage(IndexScanDesc scan, ScanDirection dir);
-static bool _bt_readfirstpage(IndexScanDesc scan, OffsetNumber offnum,
- ScanDirection dir);
-static bool _bt_readnextpage(IndexScanDesc scan, BlockNumber blkno,
- BlockNumber lastcurrblkno, ScanDirection dir,
- bool seized);
+ ItemPointer heapTid, int baseOffset);
+static IndexScanBatch _bt_readfirstpage(IndexScanDesc scan, IndexScanBatch firstbatch,
+ OffsetNumber offnum, ScanDirection dir);
+static IndexScanBatch _bt_readnextpage(IndexScanDesc scan, BlockNumber blkno,
+ BlockNumber lastcurrblkno,
+ ScanDirection dir, bool firstpage);
static Buffer _bt_lock_and_validate_left(Relation rel, BlockNumber *blkno,
BlockNumber lastcurrblkno);
-static bool _bt_endpoint(IndexScanDesc scan, ScanDirection dir);
-
-
-/*
- * _bt_drop_lock_and_maybe_pin()
- *
- * Unlock so->currPos.buf. If scan is so->dropPin, drop the pin, too.
- * Dropping the pin prevents VACUUM from blocking on acquiring a cleanup lock.
- */
-static inline void
-_bt_drop_lock_and_maybe_pin(Relation rel, BTScanOpaque so)
-{
- if (!so->dropPin)
- {
- /* Just drop the lock (not the pin) */
- _bt_unlockbuf(rel, so->currPos.buf);
- return;
- }
-
- /*
- * Drop both the lock and the pin.
- *
- * Have to set so->currPos.lsn so that _bt_killitems has a way to detect
- * when concurrent heap TID recycling by VACUUM might have taken place.
- */
- Assert(RelationNeedsWAL(rel));
- so->currPos.lsn = BufferGetLSNAtomic(so->currPos.buf);
- _bt_relbuf(rel, so->currPos.buf);
- so->currPos.buf = InvalidBuffer;
-}
+static IndexScanBatch _bt_endpoint(IndexScanDesc scan, ScanDirection dir,
+ IndexScanBatch firstbatch);
/*
* _bt_search() -- Search the tree for a particular scankey,
@@ -872,8 +842,7 @@ _bt_compare(Relation rel,
* qualifications in the scan key. On success exit, data about the
* matching tuple(s) on the page has been loaded into so->currPos. We'll
* drop all locks and hold onto a pin on page's buffer, except during
- * so->dropPin scans, when we drop both the lock and the pin.
- * _bt_returnitem sets the next item to return to scan on success exit.
+ * dropPin scans, when we drop both the lock and the pin.
*
* If there are no matching items in the index, we return false, with no
* pins or locks held. so->currPos will remain invalid.
@@ -883,7 +852,7 @@ _bt_compare(Relation rel,
* Within this routine, we build a temporary insertion-type scankey to use
* in locating the scan start position.
*/
-bool
+IndexScanBatch
_bt_first(IndexScanDesc scan, ScanDirection dir)
{
Relation rel = scan->indexRelation;
@@ -897,8 +866,7 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
StrategyNumber strat_total = InvalidStrategy;
BlockNumber blkno = InvalidBlockNumber,
lastcurrblkno;
-
- Assert(!BTScanPosIsValid(so->currPos));
+ IndexScanBatch firstbatch;
/*
* Examine the scan keys and eliminate any redundant keys; also mark the
@@ -923,7 +891,7 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
*/
if (scan->parallel_scan != NULL &&
!_bt_parallel_seize(scan, &blkno, &lastcurrblkno, true))
- return false;
+ return false; /* definitely done (so->needPrimscan is unset) */
/*
* Initialize the scan's arrays (if any) for the current scan direction
@@ -940,14 +908,8 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
* _bt_readnextpage releases the scan for us (not _bt_readfirstpage).
*/
Assert(scan->parallel_scan != NULL);
- Assert(!so->needPrimScan);
- Assert(blkno != P_NONE);
- if (!_bt_readnextpage(scan, blkno, lastcurrblkno, dir, true))
- return false;
-
- _bt_returnitem(scan, so);
- return true;
+ return _bt_readnextpage(scan, blkno, lastcurrblkno, dir, true);
}
/*
@@ -1239,6 +1201,14 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
}
}
+ /*
+ * Allocate space for first batch
+ *
+ * XXX Should we be recyling memory used for prior batches?
+ */
+ firstbatch = index_batch_alloc(MaxTIDsPerBTreePage, scan->xs_want_itup);
+ firstbatch->pos = palloc(sizeof(BTScanPosData));
+
/*
* If we found no usable boundary keys, we have to start from one end of
* the tree. Walk down that edge to the first or last key, and scan from
@@ -1247,7 +1217,7 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
* Note: calls _bt_readfirstpage for us, which releases the parallel scan.
*/
if (keysz == 0)
- return _bt_endpoint(scan, dir);
+ return _bt_endpoint(scan, dir, firstbatch);
/*
* We want to start the scan somewhere within the index. Set up an
@@ -1513,12 +1483,12 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
* position ourselves on the target leaf page.
*/
Assert(ScanDirectionIsBackward(dir) == inskey.backward);
- stack = _bt_search(rel, NULL, &inskey, &so->currPos.buf, BT_READ);
+ stack = _bt_search(rel, NULL, &inskey, &firstbatch->buf, BT_READ);
/* don't need to keep the stack around... */
_bt_freestack(stack);
- if (!BufferIsValid(so->currPos.buf))
+ if (!BufferIsValid(firstbatch->buf))
{
Assert(!so->needPrimScan);
@@ -1534,11 +1504,11 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
if (IsolationIsSerializable())
{
PredicateLockRelation(rel, scan->xs_snapshot);
- stack = _bt_search(rel, NULL, &inskey, &so->currPos.buf, BT_READ);
+ stack = _bt_search(rel, NULL, &inskey, &firstbatch->buf, BT_READ);
_bt_freestack(stack);
}
- if (!BufferIsValid(so->currPos.buf))
+ if (!BufferIsValid(firstbatch->buf))
{
_bt_parallel_done(scan);
return false;
@@ -1546,7 +1516,7 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
}
/* position to the precise item on the page */
- offnum = _bt_binsrch(rel, &inskey, so->currPos.buf);
+ offnum = _bt_binsrch(rel, &inskey, firstbatch->buf);
/*
* Now load data from the first page of the scan (usually the page
@@ -1568,11 +1538,7 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
* for the page. For example, when inskey is both < the leaf page's high
* key and > all of its non-pivot tuples, offnum will be "maxoff + 1".
*/
- if (!_bt_readfirstpage(scan, offnum, dir))
- return false;
-
- _bt_returnitem(scan, so);
- return true;
+ return _bt_readfirstpage(scan, firstbatch, offnum, dir);
}
/*
@@ -1589,36 +1555,50 @@ _bt_first(IndexScanDesc scan, ScanDirection dir)
* still be possible for the scan to return tuples by changing direction,
* though we'll need to call _bt_first anew in that other direction.
*/
-bool
-_bt_next(IndexScanDesc scan, ScanDirection dir)
+IndexScanBatch
+_bt_next(IndexScanDesc scan, ScanDirection dir, IndexScanBatch priorbatch)
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
+ BlockNumber blkno,
+ lastcurrblkno;
+ BTScanPos priorpos = (BTScanPos) priorbatch->pos;
- Assert(BTScanPosIsValid(so->currPos));
+ Assert(BTScanPosIsValid(*priorpos));
+
+ /* Walk to the next page with data */
+ if (ScanDirectionIsForward(dir))
+ blkno = priorpos->nextPage;
+ else
+ blkno = priorpos->prevPage;
+ lastcurrblkno = priorpos->currPage;
/*
- * Advance to next tuple on current page; or if there's no more, try to
- * step to the next page with data.
+ * Cancel primitive index scans that were scheduled when the call to
+ * _bt_readpage for pos happened to use the opposite direction to the one
+ * that we're stepping in now. (It's okay to leave the scan's array keys
+ * as-is, since the next _bt_readpage will advance them.)
*/
- if (ScanDirectionIsForward(dir))
+ if (priorpos->dir != dir)
+ so->needPrimScan = false;
+
+ if (blkno == P_NONE ||
+ (ScanDirectionIsForward(dir) ?
+ !priorpos->moreRight : !priorpos->moreLeft))
{
- if (++so->currPos.itemIndex > so->currPos.lastItem)
- {
- if (!_bt_steppage(scan, dir))
- return false;
- }
- }
- else
- {
- if (--so->currPos.itemIndex < so->currPos.firstItem)
- {
- if (!_bt_steppage(scan, dir))
- return false;
- }
+ /*
+ * priorpos _bt_readpage call ended scan in this direction (though if
+ * so->needPrimScan was set the scan will continue in _bt_first)
+ */
+ _bt_parallel_done(scan);
+ return NULL;
}
- _bt_returnitem(scan, so);
- return true;
+ /* parallel scan must seize the scan to get next blkno */
+ if (scan->parallel_scan != NULL &&
+ !_bt_parallel_seize(scan, &blkno, &lastcurrblkno, false))
+ return NULL; /* done iff so->needPrimScan wasn't set */
+
+ return _bt_readnextpage(scan, blkno, lastcurrblkno, dir, false);
}
/*
@@ -1642,8 +1622,8 @@ _bt_next(IndexScanDesc scan, ScanDirection dir)
* Returns true if any matching items found on the page, false if none.
*/
static bool
-_bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
- bool firstpage)
+_bt_readpage(IndexScanDesc scan, IndexScanBatch newbatch, ScanDirection dir,
+ OffsetNumber offnum, bool firstpage)
{
Relation rel = scan->indexRelation;
BTScanOpaque so = (BTScanOpaque) scan->opaque;
@@ -1654,37 +1634,35 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
BTReadPageState pstate;
bool arrayKeys;
int itemIndex,
+ tupleOffset = 0,
indnatts;
+ BTScanPos pos = newbatch->pos;
/* save the page/buffer block number, along with its sibling links */
- page = BufferGetPage(so->currPos.buf);
+ page = BufferGetPage(newbatch->buf);
opaque = BTPageGetOpaque(page);
- so->currPos.currPage = BufferGetBlockNumber(so->currPos.buf);
- so->currPos.prevPage = opaque->btpo_prev;
- so->currPos.nextPage = opaque->btpo_next;
- /* delay setting so->currPos.lsn until _bt_drop_lock_and_maybe_pin */
- so->currPos.dir = dir;
- so->currPos.nextTupleOffset = 0;
+ pos->currPage = BufferGetBlockNumber(newbatch->buf);
+ pos->prevPage = opaque->btpo_prev;
+ pos->nextPage = opaque->btpo_next;
+ pos->dir = dir;
+
+ so->pos = pos; /* _bt_checkkeys needs this */
/* either moreRight or moreLeft should be set now (may be unset later) */
- Assert(ScanDirectionIsForward(dir) ? so->currPos.moreRight :
- so->currPos.moreLeft);
+ Assert(ScanDirectionIsForward(dir) ? pos->moreRight : pos->moreLeft);
Assert(!P_IGNORE(opaque));
- Assert(BTScanPosIsPinned(so->currPos));
Assert(!so->needPrimScan);
if (scan->parallel_scan)
{
/* allow next/prev page to be read by other worker without delay */
if (ScanDirectionIsForward(dir))
- _bt_parallel_release(scan, so->currPos.nextPage,
- so->currPos.currPage);
+ _bt_parallel_release(scan, pos->nextPage, pos->currPage);
else
- _bt_parallel_release(scan, so->currPos.prevPage,
- so->currPos.currPage);
+ _bt_parallel_release(scan, pos->prevPage, pos->currPage);
}
- PredicateLockPage(rel, so->currPos.currPage, scan->xs_snapshot);
+ PredicateLockPage(rel, pos->currPage, scan->xs_snapshot);
/* initialize local variables */
indnatts = IndexRelationGetNumberOfAttributes(rel);
@@ -1722,11 +1700,10 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
!_bt_scanbehind_checkkeys(scan, dir, pstate.finaltup))
{
/* Schedule another primitive index scan after all */
- so->currPos.moreRight = false;
+ pos->moreRight = false;
so->needPrimScan = true;
if (scan->parallel_scan)
- _bt_parallel_primscan_schedule(scan,
- so->currPos.currPage);
+ _bt_parallel_primscan_schedule(scan, pos->currPage);
return false;
}
}
@@ -1790,28 +1767,28 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
if (!BTreeTupleIsPosting(itup))
{
/* Remember it */
- _bt_saveitem(so, itemIndex, offnum, itup);
+ _bt_saveitem(newbatch, itemIndex, offnum, itup, &tupleOffset);
itemIndex++;
}
else
{
- int tupleOffset;
+ int baseOffset;
/*
* Set up state to return posting list, and remember first
* TID
*/
- tupleOffset =
- _bt_setuppostingitems(so, itemIndex, offnum,
+ baseOffset =
+ _bt_setuppostingitems(newbatch, itemIndex, offnum,
BTreeTupleGetPostingN(itup, 0),
- itup);
+ itup, &tupleOffset);
itemIndex++;
/* Remember additional TIDs */
for (int i = 1; i < BTreeTupleGetNPosting(itup); i++)
{
- _bt_savepostingitem(so, itemIndex, offnum,
+ _bt_savepostingitem(newbatch, itemIndex, offnum,
BTreeTupleGetPostingN(itup, i),
- tupleOffset);
+ baseOffset);
itemIndex++;
}
}
@@ -1851,12 +1828,12 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
}
if (!pstate.continuescan)
- so->currPos.moreRight = false;
+ pos->moreRight = false;
Assert(itemIndex <= MaxTIDsPerBTreePage);
- so->currPos.firstItem = 0;
- so->currPos.lastItem = itemIndex - 1;
- so->currPos.itemIndex = 0;
+ newbatch->firstItem = 0;
+ newbatch->lastItem = itemIndex - 1;
+ newbatch->itemIndex = 0;
}
else
{
@@ -1873,11 +1850,10 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
!_bt_scanbehind_checkkeys(scan, dir, pstate.finaltup))
{
/* Schedule another primitive index scan after all */
- so->currPos.moreLeft = false;
+ pos->moreLeft = false;
so->needPrimScan = true;
if (scan->parallel_scan)
- _bt_parallel_primscan_schedule(scan,
- so->currPos.currPage);
+ _bt_parallel_primscan_schedule(scan, pos->currPage);
return false;
}
}
@@ -1978,11 +1954,11 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
{
/* Remember it */
itemIndex--;
- _bt_saveitem(so, itemIndex, offnum, itup);
+ _bt_saveitem(newbatch, itemIndex, offnum, itup, &tupleOffset);
}
else
{
- int tupleOffset;
+ int baseOffset;
/*
* Set up state to return posting list, and remember first
@@ -1995,17 +1971,17 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
* associated with the same posting list tuple.
*/
itemIndex--;
- tupleOffset =
- _bt_setuppostingitems(so, itemIndex, offnum,
+ baseOffset =
+ _bt_setuppostingitems(newbatch, itemIndex, offnum,
BTreeTupleGetPostingN(itup, 0),
- itup);
+ itup, &tupleOffset);
/* Remember additional TIDs */
for (int i = 1; i < BTreeTupleGetNPosting(itup); i++)
{
itemIndex--;
- _bt_savepostingitem(so, itemIndex, offnum,
+ _bt_savepostingitem(newbatch, itemIndex, offnum,
BTreeTupleGetPostingN(itup, i),
- tupleOffset);
+ baseOffset);
}
}
}
@@ -2021,12 +1997,12 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
* be found there
*/
if (!pstate.continuescan)
- so->currPos.moreLeft = false;
+ pos->moreLeft = false;
Assert(itemIndex >= 0);
- so->currPos.firstItem = itemIndex;
- so->currPos.lastItem = MaxTIDsPerBTreePage - 1;
- so->currPos.itemIndex = MaxTIDsPerBTreePage - 1;
+ newbatch->firstItem = itemIndex;
+ newbatch->lastItem = MaxTIDsPerBTreePage - 1;
+ newbatch->itemIndex = MaxTIDsPerBTreePage - 1;
}
/*
@@ -2043,27 +2019,27 @@ _bt_readpage(IndexScanDesc scan, ScanDirection dir, OffsetNumber offnum,
*/
Assert(!pstate.forcenonrequired);
- return (so->currPos.firstItem <= so->currPos.lastItem);
+ return (newbatch->firstItem <= newbatch->lastItem);
}
/* Save an index item into so->currPos.items[itemIndex] */
static void
-_bt_saveitem(BTScanOpaque so, int itemIndex,
- OffsetNumber offnum, IndexTuple itup)
+_bt_saveitem(IndexScanBatch newbatch, int itemIndex, OffsetNumber offnum,
+ IndexTuple itup, int *tupleOffset)
{
- BTScanPosItem *currItem = &so->currPos.items[itemIndex];
-
Assert(!BTreeTupleIsPivot(itup) && !BTreeTupleIsPosting(itup));
- currItem->heapTid = itup->t_tid;
- currItem->indexOffset = offnum;
- if (so->currTuples)
+ /* copy the populated part of the items array */
+ newbatch->items[itemIndex].heapTid = itup->t_tid;
+ newbatch->items[itemIndex].indexOffset = offnum;
+
+ if (newbatch->currTuples)
{
Size itupsz = IndexTupleSize(itup);
- currItem->tupleOffset = so->currPos.nextTupleOffset;
- memcpy(so->currTuples + so->currPos.nextTupleOffset, itup, itupsz);
- so->currPos.nextTupleOffset += MAXALIGN(itupsz);
+ newbatch->items[itemIndex].tupleOffset = *tupleOffset;
+ memcpy(newbatch->currTuples + *tupleOffset, itup, itupsz);
+ *tupleOffset += MAXALIGN(itupsz);
}
}
@@ -2074,35 +2050,37 @@ _bt_saveitem(BTScanOpaque so, int itemIndex,
* returned to scan first. Second or subsequent TIDs for posting list should
* be saved by calling _bt_savepostingitem().
*
- * Returns an offset into tuple storage space that main tuple is stored at if
- * needed.
+ * Returns baseOffset, an offset into tuple storage space that main tuple is
+ * stored at if needed.
*/
static int
-_bt_setuppostingitems(BTScanOpaque so, int itemIndex, OffsetNumber offnum,
- ItemPointer heapTid, IndexTuple itup)
+_bt_setuppostingitems(IndexScanBatch newbatch, int itemIndex, OffsetNumber offnum,
+ ItemPointer heapTid, IndexTuple itup, int *tupleOffset)
{
- BTScanPosItem *currItem = &so->currPos.items[itemIndex];
+ IndexScanBatchPosItem *item = &newbatch->items[itemIndex];
Assert(BTreeTupleIsPosting(itup));
- currItem->heapTid = *heapTid;
- currItem->indexOffset = offnum;
- if (so->currTuples)
+ /* copy the populated part of the items array */
+ item->heapTid = *heapTid;
+ item->indexOffset = offnum;
+
+ if (newbatch->currTuples)
{
/* Save base IndexTuple (truncate posting list) */
IndexTuple base;
Size itupsz = BTreeTupleGetPostingOffset(itup);
itupsz = MAXALIGN(itupsz);
- currItem->tupleOffset = so->currPos.nextTupleOffset;
- base = (IndexTuple) (so->currTuples + so->currPos.nextTupleOffset);
+ item->tupleOffset = *tupleOffset;
+ base = (IndexTuple) (newbatch->currTuples + *tupleOffset);
memcpy(base, itup, itupsz);
/* Defensively reduce work area index tuple header size */
base->t_info &= ~INDEX_SIZE_MASK;
base->t_info |= itupsz;
- so->currPos.nextTupleOffset += itupsz;
+ *tupleOffset += itupsz;
- return currItem->tupleOffset;
+ return item->tupleOffset;
}
return 0;
@@ -2113,132 +2091,23 @@ _bt_setuppostingitems(BTScanOpaque so, int itemIndex, OffsetNumber offnum,
* tuple.
*
* Assumes that _bt_setuppostingitems() has already been called for current
- * posting list tuple. Caller passes its return value as tupleOffset.
+ * posting list tuple. Caller passes its return value as baseOffset.
*/
static inline void
-_bt_savepostingitem(BTScanOpaque so, int itemIndex, OffsetNumber offnum,
- ItemPointer heapTid, int tupleOffset)
+_bt_savepostingitem(IndexScanBatch newbatch, int itemIndex, OffsetNumber offnum,
+ ItemPointer heapTid, int baseOffset)
{
- BTScanPosItem *currItem = &so->currPos.items[itemIndex];
+ IndexScanBatchPosItem *item = &newbatch->items[itemIndex];
- currItem->heapTid = *heapTid;
- currItem->indexOffset = offnum;
+ item->heapTid = *heapTid;
+ item->indexOffset = offnum;
/*
* Have index-only scans return the same base IndexTuple for every TID
* that originates from the same posting list
*/
- if (so->currTuples)
- currItem->tupleOffset = tupleOffset;
-}
-
-/*
- * Return the index item from so->currPos.items[so->currPos.itemIndex] to the
- * index scan by setting the relevant fields in caller's index scan descriptor
- */
-static inline void
-_bt_returnitem(IndexScanDesc scan, BTScanOpaque so)
-{
- BTScanPosItem *currItem = &so->currPos.items[so->currPos.itemIndex];
-
- /* Most recent _bt_readpage must have succeeded */
- Assert(BTScanPosIsValid(so->currPos));
- Assert(so->currPos.itemIndex >= so->currPos.firstItem);
- Assert(so->currPos.itemIndex <= so->currPos.lastItem);
-
- /* Return next item, per amgettuple contract */
- scan->xs_heaptid = currItem->heapTid;
- if (so->currTuples)
- scan->xs_itup = (IndexTuple) (so->currTuples + currItem->tupleOffset);
-}
-
-/*
- * _bt_steppage() -- Step to next page containing valid data for scan
- *
- * Wrapper on _bt_readnextpage that performs final steps for the current page.
- *
- * On entry, so->currPos must be valid. Its buffer will be pinned, though
- * never locked. (Actually, when so->dropPin there won't even be a pin held,
- * though so->currPos.currPage must still be set to a valid block number.)
- */
-static bool
-_bt_steppage(IndexScanDesc scan, ScanDirection dir)
-{
- BTScanOpaque so = (BTScanOpaque) scan->opaque;
- BlockNumber blkno,
- lastcurrblkno;
-
- Assert(BTScanPosIsValid(so->currPos));
-
- /* Before leaving current page, deal with any killed items */
- if (so->numKilled > 0)
- _bt_killitems(scan);
-
- /*
- * Before we modify currPos, make a copy of the page data if there was a
- * mark position that needs it.
- */
- if (so->markItemIndex >= 0)
- {
- /* bump pin on current buffer for assignment to mark buffer */
- if (BTScanPosIsPinned(so->currPos))
- IncrBufferRefCount(so->currPos.buf);
- memcpy(&so->markPos, &so->currPos,
- offsetof(BTScanPosData, items[1]) +
- so->currPos.lastItem * sizeof(BTScanPosItem));
- if (so->markTuples)
- memcpy(so->markTuples, so->currTuples,
- so->currPos.nextTupleOffset);
- so->markPos.itemIndex = so->markItemIndex;
- so->markItemIndex = -1;
-
- /*
- * If we're just about to start the next primitive index scan
- * (possible with a scan that has arrays keys, and needs to skip to
- * continue in the current scan direction), moreLeft/moreRight only
- * indicate the end of the current primitive index scan. They must
- * never be taken to indicate that the top-level index scan has ended
- * (that would be wrong).
- *
- * We could handle this case by treating the current array keys as
- * markPos state. But depending on the current array state like this
- * would add complexity. Instead, we just unset markPos's copy of
- * moreRight or moreLeft (whichever might be affected), while making
- * btrestrpos reset the scan's arrays to their initial scan positions.
- * In effect, btrestrpos leaves advancing the arrays up to the first
- * _bt_readpage call (that takes place after it has restored markPos).
- */
- if (so->needPrimScan)
- {
- if (ScanDirectionIsForward(so->currPos.dir))
- so->markPos.moreRight = true;
- else
- so->markPos.moreLeft = true;
- }
-
- /* mark/restore not supported by parallel scans */
- Assert(!scan->parallel_scan);
- }
-
- BTScanPosUnpinIfPinned(so->currPos);
-
- /* Walk to the next page with data */
- if (ScanDirectionIsForward(dir))
- blkno = so->currPos.nextPage;
- else
- blkno = so->currPos.prevPage;
- lastcurrblkno = so->currPos.currPage;
-
- /*
- * Cancel primitive index scans that were scheduled when the call to
- * _bt_readpage for currPos happened to use the opposite direction to the
- * one that we're stepping in now. (It's okay to leave the scan's array
- * keys as-is, since the next _bt_readpage will advance them.)
- */
- if (so->currPos.dir != dir)
- so->needPrimScan = false;
-
- return _bt_readnextpage(scan, blkno, lastcurrblkno, dir, false);
+ if (newbatch->currTuples)
+ item->tupleOffset = baseOffset;
}
/*
@@ -2264,62 +2133,81 @@ _bt_steppage(IndexScanDesc scan, ScanDirection dir)
* We always release the scan for a parallel scan caller, regardless of
* success or failure; we'll call _bt_parallel_release as soon as possible.
*/
-static bool
-_bt_readfirstpage(IndexScanDesc scan, OffsetNumber offnum, ScanDirection dir)
+static IndexScanBatch
+_bt_readfirstpage(IndexScanDesc scan, IndexScanBatch firstbatch,
+ OffsetNumber offnum, ScanDirection dir)
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
-
- so->numKilled = 0; /* just paranoia */
- so->markItemIndex = -1; /* ditto */
+ Relation rel = scan->indexRelation;
+ BlockNumber blkno,
+ lastcurrblkno;
+ BTScanPos firstpos = firstbatch->pos;
/* Initialize so->currPos for the first page (page in so->currPos.buf) */
if (so->needPrimScan)
{
Assert(so->numArrayKeys);
- so->currPos.moreLeft = true;
- so->currPos.moreRight = true;
+ firstpos->moreLeft = true;
+ firstpos->moreRight = true;
so->needPrimScan = false;
}
else if (ScanDirectionIsForward(dir))
{
- so->currPos.moreLeft = false;
- so->currPos.moreRight = true;
+ firstpos->moreLeft = false;
+ firstpos->moreRight = true;
}
else
{
- so->currPos.moreLeft = true;
- so->currPos.moreRight = false;
+ firstpos->moreLeft = true;
+ firstpos->moreRight = false;
}
/*
* Attempt to load matching tuples from the first page.
*
- * Note that _bt_readpage will finish initializing the so->currPos fields.
+ * Note that _bt_readpage will finish initializing the firstbatch fields.
* _bt_readpage also releases parallel scan (even when it returns false).
*/
- if (_bt_readpage(scan, dir, offnum, true))
+ if (_bt_readpage(scan, firstbatch, dir, offnum, true))
{
- Relation rel = scan->indexRelation;
-
- /*
- * _bt_readpage succeeded. Drop the lock (and maybe the pin) on
- * so->currPos.buf in preparation for btgettuple returning tuples.
- */
- Assert(BTScanPosIsPinned(so->currPos));
- _bt_drop_lock_and_maybe_pin(rel, so);
- return true;
+ /* _bt_readpage succeeded */
+ index_batch_unlock(rel, scan->batchState && scan->batchState->dropPin,
+ firstbatch);
+ return firstbatch;
}
- /* There's no actually-matching data on the page in so->currPos.buf */
- _bt_unlockbuf(scan->indexRelation, so->currPos.buf);
+ /* There's no actually-matching data on the page in firstbatch->buf */
+ _bt_relbuf(rel, firstbatch->buf);
+ firstbatch->buf = InvalidBuffer;
- /* Call _bt_readnextpage using its _bt_steppage wrapper function */
- if (!_bt_steppage(scan, dir))
- return false;
+ /* Walk to the next page with data */
+ if (ScanDirectionIsForward(dir))
+ blkno = firstpos->nextPage;
+ else
+ blkno = firstpos->prevPage;
+ lastcurrblkno = firstpos->currPage;
- /* _bt_readpage for a later page (now in so->currPos) succeeded */
- return true;
+ Assert(firstpos->dir == dir);
+
+ if (blkno == P_NONE ||
+ (ScanDirectionIsForward(dir) ?
+ !firstpos->moreRight : !firstpos->moreLeft))
+ {
+ /*
+ * firstbatch _bt_readpage call ended scan in this direction (though
+ * if so->needPrimScan was set the scan will continue in _bt_first)
+ */
+ _bt_parallel_done(scan);
+ return NULL;
+ }
+
+ /* parallel scan must seize the scan to get next blkno */
+ if (scan->parallel_scan != NULL &&
+ !_bt_parallel_seize(scan, &blkno, &lastcurrblkno, false))
+ return NULL; /* done iff so->needPrimScan wasn't set */
+
+ return _bt_readnextpage(scan, blkno, lastcurrblkno, dir, false);
}
/*
@@ -2329,102 +2217,74 @@ _bt_readfirstpage(IndexScanDesc scan, OffsetNumber offnum, ScanDirection dir)
* previously-saved right link or left link. lastcurrblkno is the page that
* was current at the point where the blkno link was saved, which we use to
* reason about concurrent page splits/page deletions during backwards scans.
- * In the common case where seized=false, blkno is either so->currPos.nextPage
- * or so->currPos.prevPage, and lastcurrblkno is so->currPos.currPage.
+ * blkno is the prior scan position's nextPage or prevPage (depending on scan
+ * direction), and lastcurrblkno is the prior position's currPage.
*
- * On entry, so->currPos shouldn't be locked by caller. so->currPos.buf must
- * be InvalidBuffer/unpinned as needed by caller (note that lastcurrblkno
- * won't need to be read again in almost all cases). Parallel scan callers
- * that seized the scan before calling here should pass seized=true; such a
- * caller's blkno and lastcurrblkno arguments come from the seized scan.
- * seized=false callers just pass us the blkno/lastcurrblkno taken from their
- * so->currPos, which (along with so->currPos itself) can be used to end the
- * scan. A seized=false caller's blkno can never be assumed to be the page
- * that must be read next during a parallel scan, though. We must figure that
- * part out for ourselves by seizing the scan (the correct page to read might
- * already be beyond the seized=false caller's blkno during a parallel scan,
- * unless blkno/so->currPos.nextPage/so->currPos.prevPage is already P_NONE,
- * or unless so->currPos.moreRight/so->currPos.moreLeft is already unset).
+ * On entry, no page should be locked by caller.
*
- * On success exit, so->currPos is updated to contain data from the next
- * interesting page, and we return true. We hold a pin on the buffer on
- * success exit (except during so->dropPin index scans, when we drop the pin
- * eagerly to avoid blocking VACUUM).
+ * On success exit, returns scan batch containing data from the next
+ * interesting page. We hold a pin on the buffer on success exit (except
+ * during dropPin plain index scans, when we drop the pin eagerly to avoid
+ * blocking VACUUM). If there are no more matching records in the given
+ * direction, we just return NULL.
*
- * If there are no more matching records in the given direction, we invalidate
- * so->currPos (while ensuring it retains no locks or pins), and return false.
- *
- * We always release the scan for a parallel scan caller, regardless of
- * success or failure; we'll call _bt_parallel_release as soon as possible.
+ * Parallel scan callers must seize the scan before calling here. blkno and
+ * lastcurrblkno should come from the seized scan. We'll release the scan as
+ * soon as possible.
*/
-static bool
+static IndexScanBatch
_bt_readnextpage(IndexScanDesc scan, BlockNumber blkno,
- BlockNumber lastcurrblkno, ScanDirection dir, bool seized)
+ BlockNumber lastcurrblkno, ScanDirection dir, bool firstpage)
{
Relation rel = scan->indexRelation;
- BTScanOpaque so = (BTScanOpaque) scan->opaque;
-
- Assert(so->currPos.currPage == lastcurrblkno || seized);
- Assert(!(blkno == P_NONE && seized));
- Assert(!BTScanPosIsPinned(so->currPos));
+ IndexScanBatch newbatch;
+ BTScanPos newpos;
/*
- * Remember that the scan already read lastcurrblkno, a page to the left
- * of blkno (or remember reading a page to the right, for backwards scans)
+ * Allocate space for next batch
+ *
+ * XXX Should we be recyling memory used for prior batches?
*/
- if (ScanDirectionIsForward(dir))
- so->currPos.moreLeft = true;
- else
- so->currPos.moreRight = true;
+ newbatch = index_batch_alloc(MaxTIDsPerBTreePage, scan->xs_want_itup);
+ newbatch->pos = palloc(sizeof(BTScanPosData));
+ newpos = newbatch->pos;
+
+ /*
+ * pos is the first valid page to the right (or to the left) of
+ * lastcurrblkno. Also provisionally assume that there'll be another page
+ * we'll need to the right (or to the left) ahead of _bt_readpage call.
+ */
+ newpos->moreLeft = true;
+ newpos->moreRight = true;
for (;;)
{
Page page;
BTPageOpaque opaque;
- if (blkno == P_NONE ||
- (ScanDirectionIsForward(dir) ?
- !so->currPos.moreRight : !so->currPos.moreLeft))
- {
- /* most recent _bt_readpage call (for lastcurrblkno) ended scan */
- Assert(so->currPos.currPage == lastcurrblkno && !seized);
- BTScanPosInvalidate(so->currPos);
- _bt_parallel_done(scan); /* iff !so->needPrimScan */
- return false;
- }
-
- Assert(!so->needPrimScan);
-
- /* parallel scan must never actually visit so->currPos blkno */
- if (!seized && scan->parallel_scan != NULL &&
- !_bt_parallel_seize(scan, &blkno, &lastcurrblkno, false))
- {
- /* whole scan is now done (or another primitive scan required) */
- BTScanPosInvalidate(so->currPos);
- return false;
- }
+ Assert(!((BTScanOpaque) scan->opaque)->needPrimScan);
+ Assert(blkno != P_NONE && lastcurrblkno != P_NONE);
if (ScanDirectionIsForward(dir))
{
/* read blkno, but check for interrupts first */
CHECK_FOR_INTERRUPTS();
- so->currPos.buf = _bt_getbuf(rel, blkno, BT_READ);
+ newbatch->buf = _bt_getbuf(rel, blkno, BT_READ);
}
else
{
/* read blkno, avoiding race (also checks for interrupts) */
- so->currPos.buf = _bt_lock_and_validate_left(rel, &blkno,
- lastcurrblkno);
- if (so->currPos.buf == InvalidBuffer)
+ newbatch->buf = _bt_lock_and_validate_left(rel, &blkno,
+ lastcurrblkno);
+ if (newbatch->buf == InvalidBuffer)
{
/* must have been a concurrent deletion of leftmost page */
- BTScanPosInvalidate(so->currPos);
_bt_parallel_done(scan);
- return false;
+ return NULL;
}
}
- page = BufferGetPage(so->currPos.buf);
+ page = BufferGetPage(newbatch->buf);
opaque = BTPageGetOpaque(page);
lastcurrblkno = blkno;
if (likely(!P_IGNORE(opaque)))
@@ -2432,17 +2292,17 @@ _bt_readnextpage(IndexScanDesc scan, BlockNumber blkno,
/* see if there are any matches on this page */
if (ScanDirectionIsForward(dir))
{
- /* note that this will clear moreRight if we can stop */
- if (_bt_readpage(scan, dir, P_FIRSTDATAKEY(opaque), seized))
+ if (_bt_readpage(scan, newbatch, dir,
+ P_FIRSTDATAKEY(opaque), firstpage))
break;
- blkno = so->currPos.nextPage;
+ blkno = newpos->nextPage;
}
else
{
- /* note that this will clear moreLeft if we can stop */
- if (_bt_readpage(scan, dir, PageGetMaxOffsetNumber(page), seized))
+ if (_bt_readpage(scan, newbatch, dir,
+ PageGetMaxOffsetNumber(page), firstpage))
break;
- blkno = so->currPos.prevPage;
+ blkno = newpos->prevPage;
}
}
else
@@ -2457,19 +2317,36 @@ _bt_readnextpage(IndexScanDesc scan, BlockNumber blkno,
}
/* no matching tuples on this page */
- _bt_relbuf(rel, so->currPos.buf);
- seized = false; /* released by _bt_readpage (or by us) */
+ _bt_relbuf(rel, newbatch->buf);
+ newbatch->buf = InvalidBuffer;
+
+ /* Continue the scan in this direction? */
+ if (blkno == P_NONE ||
+ (ScanDirectionIsForward(dir) ?
+ !newpos->moreRight : !newpos->moreLeft))
+ {
+ /*
+ * blkno _bt_readpage call ended scan in this direction (though if
+ * so->needPrimScan was set the scan will continue in _bt_first)
+ */
+ _bt_parallel_done(scan);
+ return NULL;
+ }
+
+ /* parallel scan must seize the scan to get next blkno */
+ if (scan->parallel_scan != NULL &&
+ !_bt_parallel_seize(scan, &blkno, &lastcurrblkno, false))
+ return NULL; /* done iff so->needPrimScan wasn't set */
+
+ firstpage = false; /* next page cannot be first */
}
- /*
- * _bt_readpage succeeded. Drop the lock (and maybe the pin) on
- * so->currPos.buf in preparation for btgettuple returning tuples.
- */
- Assert(so->currPos.currPage == blkno);
- Assert(BTScanPosIsPinned(so->currPos));
- _bt_drop_lock_and_maybe_pin(rel, so);
+ /* _bt_readpage succeeded */
+ Assert(newpos->currPage == blkno);
+ index_batch_unlock(rel, scan->batchState && scan->batchState->dropPin,
+ newbatch);
- return true;
+ return newbatch;
}
/*
@@ -2692,25 +2569,23 @@ _bt_get_endpoint(Relation rel, uint32 level, bool rightmost)
* Parallel scan callers must have seized the scan before calling here.
* Exit conditions are the same as for _bt_first().
*/
-static bool
-_bt_endpoint(IndexScanDesc scan, ScanDirection dir)
+static IndexScanBatch
+_bt_endpoint(IndexScanDesc scan, ScanDirection dir, IndexScanBatch firstbatch)
{
Relation rel = scan->indexRelation;
- BTScanOpaque so = (BTScanOpaque) scan->opaque;
Page page;
BTPageOpaque opaque;
OffsetNumber start;
- Assert(!BTScanPosIsValid(so->currPos));
- Assert(!so->needPrimScan);
+ Assert(!((BTScanOpaque) scan->opaque)->needPrimScan);
/*
* Scan down to the leftmost or rightmost leaf page. This is a simplified
* version of _bt_search().
*/
- so->currPos.buf = _bt_get_endpoint(rel, 0, ScanDirectionIsBackward(dir));
+ firstbatch->buf = _bt_get_endpoint(rel, 0, ScanDirectionIsBackward(dir));
- if (!BufferIsValid(so->currPos.buf))
+ if (!BufferIsValid(firstbatch->buf))
{
/*
* Empty index. Lock the whole relation, as nothing finer to lock
@@ -2721,7 +2596,7 @@ _bt_endpoint(IndexScanDesc scan, ScanDirection dir)
return false;
}
- page = BufferGetPage(so->currPos.buf);
+ page = BufferGetPage(firstbatch->buf);
opaque = BTPageGetOpaque(page);
Assert(P_ISLEAF(opaque));
@@ -2747,9 +2622,5 @@ _bt_endpoint(IndexScanDesc scan, ScanDirection dir)
/*
* Now load data from the first page of the scan.
*/
- if (!_bt_readfirstpage(scan, start, dir))
- return false;
-
- _bt_returnitem(scan, so);
- return true;
+ return _bt_readfirstpage(scan, firstbatch, start, dir);
}
diff --git a/src/backend/access/nbtree/nbtutils.c b/src/backend/access/nbtree/nbtutils.c
index 9aed20799..609d79beb 100644
--- a/src/backend/access/nbtree/nbtutils.c
+++ b/src/backend/access/nbtree/nbtutils.c
@@ -1392,7 +1392,7 @@ _bt_advance_array_keys(IndexScanDesc scan, BTReadPageState *pstate,
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
Relation rel = scan->indexRelation;
- ScanDirection dir = so->currPos.dir;
+ ScanDirection dir = so->pos->dir;
int arrayidx = 0;
bool beyond_end_advance = false,
skip_array_advanced = false,
@@ -2037,7 +2037,7 @@ new_prim_scan:
so->needPrimScan = true; /* ...but call _bt_first again */
if (scan->parallel_scan)
- _bt_parallel_primscan_schedule(scan, so->currPos.currPage);
+ _bt_parallel_primscan_schedule(scan, so->pos->currPage);
/* Caller's tuple doesn't match the new qual */
return false;
@@ -2150,7 +2150,7 @@ _bt_checkkeys(IndexScanDesc scan, BTReadPageState *pstate, bool arrayKeys,
{
TupleDesc tupdesc = RelationGetDescr(scan->indexRelation);
BTScanOpaque so = (BTScanOpaque) scan->opaque;
- ScanDirection dir = so->currPos.dir;
+ ScanDirection dir = so->pos->dir;
int ikey = pstate->startikey;
bool res;
@@ -3157,7 +3157,7 @@ _bt_checkkeys_look_ahead(IndexScanDesc scan, BTReadPageState *pstate,
int tupnatts, TupleDesc tupdesc)
{
BTScanOpaque so = (BTScanOpaque) scan->opaque;
- ScanDirection dir = so->currPos.dir;
+ ScanDirection dir = so->pos->dir;
OffsetNumber aheadoffnum;
IndexTuple ahead;
@@ -3253,48 +3253,46 @@ _bt_checkkeys_look_ahead(IndexScanDesc scan, BTReadPageState *pstate,
* and just give up on it.
*/
void
-_bt_killitems(IndexScanDesc scan)
+_bt_killitems(IndexScanDesc scan, IndexScanBatch batch)
{
Relation rel = scan->indexRelation;
- BTScanOpaque so = (BTScanOpaque) scan->opaque;
+ BTScanPos pos = (BTScanPos) batch->pos;
Page page;
BTPageOpaque opaque;
OffsetNumber minoff;
OffsetNumber maxoff;
- int numKilled = so->numKilled;
+ int numKilled = batch->numKilled;
bool killedsomething = false;
Buffer buf;
Assert(numKilled > 0);
- Assert(BTScanPosIsValid(so->currPos));
+ Assert(BTScanPosIsValid(*pos));
Assert(scan->heapRelation != NULL); /* can't be a bitmap index scan */
- /* Always invalidate so->killedItems[] before leaving so->currPos */
- so->numKilled = 0;
+ /* Always invalidate batch->killedItems[] before freeing batch */
+ batch->numKilled = 0;
- if (!so->dropPin)
+ if (!scan->batchState->dropPin)
{
/*
* We have held the pin on this page since we read the index tuples,
* so all we need to do is lock it. The pin will have prevented
* concurrent VACUUMs from recycling any of the TIDs on the page.
*/
- Assert(BTScanPosIsPinned(so->currPos));
- buf = so->currPos.buf;
+ buf = batch->buf;
_bt_lockbuf(rel, buf, BT_READ);
}
else
{
XLogRecPtr latestlsn;
- Assert(!BTScanPosIsPinned(so->currPos));
Assert(RelationNeedsWAL(rel));
- buf = _bt_getbuf(rel, so->currPos.currPage, BT_READ);
+ buf = _bt_getbuf(rel, pos->currPage, BT_READ);
latestlsn = BufferGetLSNAtomic(buf);
- Assert(!XLogRecPtrIsInvalid(so->currPos.lsn));
- Assert(so->currPos.lsn <= latestlsn);
- if (so->currPos.lsn != latestlsn)
+ Assert(!XLogRecPtrIsInvalid(batch->lsn));
+ Assert(batch->lsn <= latestlsn);
+ if (batch->lsn != latestlsn)
{
/* Modified, give up on hinting */
_bt_relbuf(rel, buf);
@@ -3311,12 +3309,12 @@ _bt_killitems(IndexScanDesc scan)
for (int i = 0; i < numKilled; i++)
{
- int itemIndex = so->killedItems[i];
- BTScanPosItem *kitem = &so->currPos.items[itemIndex];
+ int itemIndex = batch->killedItems[i];
+ IndexScanBatchPosItem *kitem = &batch->items[itemIndex];
OffsetNumber offnum = kitem->indexOffset;
- Assert(itemIndex >= so->currPos.firstItem &&
- itemIndex <= so->currPos.lastItem);
+ Assert(itemIndex >= batch->firstItem &&
+ itemIndex <= batch->lastItem);
if (offnum < minoff)
continue; /* pure paranoia */
while (offnum <= maxoff)
@@ -3357,7 +3355,8 @@ _bt_killitems(IndexScanDesc scan)
* though only in the common case where the page can't
* have been concurrently modified
*/
- Assert(kitem->indexOffset == offnum || !so->dropPin);
+ Assert(kitem->indexOffset == offnum ||
+ !scan->batchState->dropPin);
/*
* Read-ahead to later kitems here.
@@ -3374,7 +3373,7 @@ _bt_killitems(IndexScanDesc scan)
* correctly -- posting tuple still gets killed).
*/
if (pi < numKilled)
- kitem = &so->currPos.items[so->killedItems[pi++]];
+ kitem = &batch->items[batch->killedItems[pi++]];
}
/*
@@ -3424,7 +3423,7 @@ _bt_killitems(IndexScanDesc scan)
MarkBufferDirtyHint(buf, true);
}
- if (!so->dropPin)
+ if (!scan->batchState->dropPin)
_bt_unlockbuf(rel, buf);
else
_bt_relbuf(rel, buf);
diff --git a/src/backend/access/spgist/spgutils.c b/src/backend/access/spgist/spgutils.c
index 9b86c016a..4b2c674d9 100644
--- a/src/backend/access/spgist/spgutils.c
+++ b/src/backend/access/spgist/spgutils.c
@@ -90,7 +90,6 @@ spghandler(PG_FUNCTION_ARGS)
amroutine->amgettuple = spggettuple;
amroutine->amgetbitmap = spggetbitmap;
amroutine->amendscan = spgendscan;
- amroutine->ammarkpos = NULL;
amroutine->amrestrpos = NULL;
amroutine->amestimateparallelscan = NULL;
amroutine->aminitparallelscan = NULL;
diff --git a/src/backend/access/table/tableam.c b/src/backend/access/table/tableam.c
index a56c5eceb..be8e02a9c 100644
--- a/src/backend/access/table/tableam.c
+++ b/src/backend/access/table/tableam.c
@@ -217,7 +217,7 @@ table_index_fetch_tuple_check(Relation rel,
bool found;
slot = table_slot_create(rel, NULL);
- scan = table_index_fetch_begin(rel);
+ scan = table_index_fetch_begin(rel, NULL);
found = table_index_fetch_tuple(scan, tid, snapshot, slot, &call_again,
all_dead);
table_index_fetch_end(scan);
diff --git a/src/backend/commands/constraint.c b/src/backend/commands/constraint.c
index 3497a8221..8a5d79a27 100644
--- a/src/backend/commands/constraint.c
+++ b/src/backend/commands/constraint.c
@@ -106,7 +106,8 @@ unique_key_recheck(PG_FUNCTION_ARGS)
*/
tmptid = checktid;
{
- IndexFetchTableData *scan = table_index_fetch_begin(trigdata->tg_relation);
+ IndexFetchTableData *scan = table_index_fetch_begin(trigdata->tg_relation,
+ NULL);
bool call_again = false;
if (!table_index_fetch_tuple(scan, &tmptid, SnapshotSelf, slot,
diff --git a/src/backend/commands/indexcmds.c b/src/backend/commands/indexcmds.c
index 6f753ab6d..a32f9bdba 100644
--- a/src/backend/commands/indexcmds.c
+++ b/src/backend/commands/indexcmds.c
@@ -881,7 +881,7 @@ DefineIndex(Oid tableId,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
errmsg("access method \"%s\" does not support multicolumn indexes",
accessMethodName)));
- if (exclusion && amRoutine->amgettuple == NULL)
+ if (exclusion && amRoutine->amgettuple == NULL && amRoutine->amgetbatch == NULL)
ereport(ERROR,
(errcode(ERRCODE_FEATURE_NOT_SUPPORTED),
errmsg("access method \"%s\" does not support exclusion constraints",
diff --git a/src/backend/executor/nodeIndexonlyscan.c b/src/backend/executor/nodeIndexonlyscan.c
index f464cca95..5e7bafe07 100644
--- a/src/backend/executor/nodeIndexonlyscan.c
+++ b/src/backend/executor/nodeIndexonlyscan.c
@@ -49,7 +49,13 @@
static TupleTableSlot *IndexOnlyNext(IndexOnlyScanState *node);
static void StoreIndexTuple(IndexOnlyScanState *node, TupleTableSlot *slot,
IndexTuple itup, TupleDesc itupdesc);
+static bool ios_prefetch_block(IndexScanDesc scan, void *arg,
+ IndexScanBatchPos *pos);
+/* values stored in ios_prefetch_block in the batch cache */
+#define IOS_UNKNOWN_VISIBILITY 0 /* default value */
+#define IOS_ALL_VISIBLE 1
+#define IOS_NOT_ALL_VISIBLE 2
/* ----------------------------------------------------------------
* IndexOnlyNext
@@ -103,6 +109,17 @@ IndexOnlyNext(IndexOnlyScanState *node)
node->ioss_ScanDesc->xs_want_itup = true;
node->ioss_VMBuffer = InvalidBuffer;
+ /*
+ * Set the prefetch callback info, if the scan has batching enabled
+ * (we only know what after index_beginscan, which also checks which
+ * callbacks are defined for the AM.
+ */
+ if (scandesc->batchState != NULL)
+ {
+ scandesc->batchState->prefetch = ios_prefetch_block;
+ scandesc->batchState->prefetchArg = (void *) node;
+ }
+
/*
* If no run-time keys to calculate or they are ready, go ahead and
* pass the scankeys to the index AM.
@@ -120,10 +137,42 @@ IndexOnlyNext(IndexOnlyScanState *node)
*/
while ((tid = index_getnext_tid(scandesc, direction)) != NULL)
{
+ bool all_visible;
bool tuple_from_heap = false;
CHECK_FOR_INTERRUPTS();
+ /*
+ * Without batching, inspect the VM directly. With batching, we need
+ * to retrieve the visibility information seen by the read_stream
+ * callback (or rather by ios_prefetch_block), otherwise the
+ * read_stream might get out of sync (if the VM got updated since
+ * then).
+ */
+ if (scandesc->batchState == NULL)
+ {
+ all_visible = VM_ALL_VISIBLE(scandesc->heapRelation,
+ ItemPointerGetBlockNumber(tid),
+ &node->ioss_VMBuffer);
+ }
+ else
+ {
+ /*
+ * Reuse the previously determined page visibility info, or
+ * calculate it now. If we decided not to prefetch the block, the
+ * page had to be all-visible at that point. The VM bit might have
+ * changed since then, but the tuple visibility could not have.
+ *
+ * XXX It's a bit weird we use the visibility to decide if we
+ * should skip prefetching the block, and then deduce the
+ * visibility from that (even if it matches pretty clearly). But
+ * maybe we could/should have a more direct way to read the
+ * private state?
+ */
+ all_visible = !ios_prefetch_block(scandesc, node,
+ &scandesc->batchState->readPos);
+ }
+
/*
* We can skip the heap fetch if the TID references a heap page on
* which all tuples are known visible to everybody. In any case,
@@ -158,9 +207,7 @@ IndexOnlyNext(IndexOnlyScanState *node)
* It's worth going through this complexity to avoid needing to lock
* the VM buffer, which could cause significant contention.
*/
- if (!VM_ALL_VISIBLE(scandesc->heapRelation,
- ItemPointerGetBlockNumber(tid),
- &node->ioss_VMBuffer))
+ if (!all_visible)
{
/*
* Rats, we have to visit the heap to check visibility.
@@ -889,3 +936,51 @@ ExecIndexOnlyScanRetrieveInstrumentation(IndexOnlyScanState *node)
node->ioss_SharedInfo = palloc(size);
memcpy(node->ioss_SharedInfo, SharedInfo, size);
}
+
+/* FIXME duplicate from indexam.c */
+#define INDEX_SCAN_BATCH(scan, idx) \
+ ((scan)->batchState->batches[(idx) % (scan)->batchState->maxBatches])
+
+/*
+ * ios_prefetch_block
+ * Callback to only prefetch blocks that are not all-visible.
+ *
+ * We don't want to inspect the visibility map repeatedly, so the result of
+ * VM_ALL_VISIBLE is stored in the batch private data. The values are set
+ * to 0 by default, so we use two constants to remember if all-visible or
+ * not all-visible.
+ *
+ * However, this is not merely a question of performance. The VM may get
+ * modified during the scan, and we need to make sure the two places (the
+ * read_next callback and the index_fetch_heap here) make the same decision,
+ * otherwise we might get out of sync with the stream. For example, the
+ * callback might find a page is all-visible (and skips reading the block),
+ * and then someone might update the page, resetting the VM bit. If this
+ * place attempts to read the page from the stream, it'll fail because it
+ * will probably receive an entirely different page.
+ */
+static bool
+ios_prefetch_block(IndexScanDesc scan, void *arg, IndexScanBatchPos *pos)
+{
+ IndexOnlyScanState *node = (IndexOnlyScanState *) arg;
+ IndexScanBatch batch = INDEX_SCAN_BATCH(scan, pos->batch);
+
+ if (batch->itemsvisibility == NULL)
+ batch->itemsvisibility = palloc0(sizeof(char) * (batch->lastItem + 1));
+
+ if (batch->itemsvisibility[pos->index] == IOS_UNKNOWN_VISIBILITY)
+ {
+ bool all_visible;
+ ItemPointer tid = &batch->items[pos->index].heapTid;
+
+ all_visible = VM_ALL_VISIBLE(scan->heapRelation,
+ ItemPointerGetBlockNumber(tid),
+ &node->ioss_VMBuffer);
+
+ batch->itemsvisibility[pos->index] =
+ all_visible ? IOS_ALL_VISIBLE : IOS_NOT_ALL_VISIBLE;
+ }
+
+ /* prefetch only blocks that are not all-visible */
+ return (batch->itemsvisibility[pos->index] == IOS_NOT_ALL_VISIBLE);
+}
diff --git a/src/backend/optimizer/util/plancat.c b/src/backend/optimizer/util/plancat.c
index 6ce4efea1..f0c7cc9b6 100644
--- a/src/backend/optimizer/util/plancat.c
+++ b/src/backend/optimizer/util/plancat.c
@@ -311,11 +311,11 @@ get_relation_info(PlannerInfo *root, Oid relationObjectId, bool inhparent,
info->amsearcharray = amroutine->amsearcharray;
info->amsearchnulls = amroutine->amsearchnulls;
info->amcanparallel = amroutine->amcanparallel;
- info->amhasgettuple = (amroutine->amgettuple != NULL);
+ info->amhasgettuple = (amroutine->amgettuple != NULL ||
+ amroutine->amgetbatch != NULL);
info->amhasgetbitmap = amroutine->amgetbitmap != NULL &&
relation->rd_tableam->scan_bitmap_next_tuple != NULL;
- info->amcanmarkpos = (amroutine->ammarkpos != NULL &&
- amroutine->amrestrpos != NULL);
+ info->amcanmarkpos = amroutine->amrestrpos != NULL;
info->amcostestimate = amroutine->amcostestimate;
Assert(info->amcostestimate != NULL);
diff --git a/src/backend/replication/logical/relation.c b/src/backend/replication/logical/relation.c
index f59046ad6..9fea68a9b 100644
--- a/src/backend/replication/logical/relation.c
+++ b/src/backend/replication/logical/relation.c
@@ -876,7 +876,8 @@ IsIndexUsableForReplicaIdentityFull(Relation idxrel, AttrMap *attrmap)
* The given index access method must implement "amgettuple", which will
* be used later to fetch the tuples. See RelationFindReplTupleByIndex().
*/
- if (GetIndexAmRoutineByAmId(idxrel->rd_rel->relam, false)->amgettuple == NULL)
+ if (GetIndexAmRoutineByAmId(idxrel->rd_rel->relam, false)->amgettuple == NULL &&
+ GetIndexAmRoutineByAmId(idxrel->rd_rel->relam, false)->amgetbatch == NULL)
return false;
return true;
diff --git a/src/backend/storage/aio/read_stream.c b/src/backend/storage/aio/read_stream.c
index 031fde9f4..e34e60060 100644
--- a/src/backend/storage/aio/read_stream.c
+++ b/src/backend/storage/aio/read_stream.c
@@ -99,6 +99,7 @@ struct ReadStream
int16 forwarded_buffers;
int16 pinned_buffers;
int16 distance;
+ int16 distance_old;
int16 initialized_buffers;
int read_buffers_flags;
bool sync_mode; /* using io_method=sync */
@@ -464,6 +465,7 @@ read_stream_look_ahead(ReadStream *stream)
if (blocknum == InvalidBlockNumber)
{
/* End of stream. */
+ stream->distance_old = stream->distance;
stream->distance = 0;
break;
}
@@ -862,6 +864,7 @@ read_stream_next_buffer(ReadStream *stream, void **per_buffer_data)
else
{
/* No more blocks, end of stream. */
+ stream->distance_old = stream->distance;
stream->distance = 0;
stream->oldest_buffer_index = stream->next_buffer_index;
stream->pinned_buffers = 0;
@@ -1046,6 +1049,9 @@ read_stream_reset(ReadStream *stream)
int16 index;
Buffer buffer;
+ /* remember the old distance (if we reset before end of the stream) */
+ stream->distance_old = Max(stream->distance, stream->distance_old);
+
/* Stop looking ahead. */
stream->distance = 0;
@@ -1078,8 +1084,12 @@ read_stream_reset(ReadStream *stream)
Assert(stream->pinned_buffers == 0);
Assert(stream->ios_in_progress == 0);
- /* Start off assuming data is cached. */
- stream->distance = 1;
+ /*
+ * Restore the old distance, if we have one. Otherwise start assuming data
+ * is cached.
+ */
+ stream->distance = Max(1, stream->distance_old);
+ stream->distance_old = 0;
}
/*
diff --git a/src/backend/utils/adt/amutils.c b/src/backend/utils/adt/amutils.c
index 0af26d6ac..1ebe0a76a 100644
--- a/src/backend/utils/adt/amutils.c
+++ b/src/backend/utils/adt/amutils.c
@@ -363,7 +363,7 @@ indexam_property(FunctionCallInfo fcinfo,
PG_RETURN_BOOL(routine->amclusterable);
case AMPROP_INDEX_SCAN:
- PG_RETURN_BOOL(routine->amgettuple ? true : false);
+ PG_RETURN_BOOL(routine->amgettuple || routine->amgetbatch ? true : false);
case AMPROP_BITMAP_SCAN:
PG_RETURN_BOOL(routine->amgetbitmap ? true : false);
@@ -392,7 +392,7 @@ indexam_property(FunctionCallInfo fcinfo,
PG_RETURN_BOOL(routine->amcanmulticol);
case AMPROP_CAN_EXCLUDE:
- PG_RETURN_BOOL(routine->amgettuple ? true : false);
+ PG_RETURN_BOOL(routine->amgettuple || routine->amgetbatch ? true : false);
case AMPROP_CAN_INCLUDE:
PG_RETURN_BOOL(routine->amcaninclude);
diff --git a/contrib/bloom/blutils.c b/contrib/bloom/blutils.c
index 2c0e71eed..12b3986be 100644
--- a/contrib/bloom/blutils.c
+++ b/contrib/bloom/blutils.c
@@ -148,7 +148,6 @@ blhandler(PG_FUNCTION_ARGS)
amroutine->amgettuple = NULL;
amroutine->amgetbitmap = blgetbitmap;
amroutine->amendscan = blendscan;
- amroutine->ammarkpos = NULL;
amroutine->amrestrpos = NULL;
amroutine->amestimateparallelscan = NULL;
amroutine->aminitparallelscan = NULL;
diff --git a/doc/src/sgml/indexam.sgml b/doc/src/sgml/indexam.sgml
index 63d7e376f..1a034bcf5 100644
--- a/doc/src/sgml/indexam.sgml
+++ b/doc/src/sgml/indexam.sgml
@@ -163,7 +163,6 @@ typedef struct IndexAmRoutine
amgettuple_function amgettuple; /* can be NULL */
amgetbitmap_function amgetbitmap; /* can be NULL */
amendscan_function amendscan;
- ammarkpos_function ammarkpos; /* can be NULL */
amrestrpos_function amrestrpos; /* can be NULL */
/* interface functions to support parallel index scans */
@@ -789,25 +788,9 @@ amendscan (IndexScanDesc scan);
<para>
<programlisting>
void
-ammarkpos (IndexScanDesc scan);
-</programlisting>
- Mark current scan position. The access method need only support one
- remembered scan position per scan.
- </para>
-
- <para>
- The <function>ammarkpos</function> function need only be provided if the access
- method supports ordered scans. If it doesn't,
- the <structfield>ammarkpos</structfield> field in its <structname>IndexAmRoutine</structname>
- struct may be set to NULL.
- </para>
-
- <para>
-<programlisting>
-void
amrestrpos (IndexScanDesc scan);
</programlisting>
- Restore the scan to the most recently marked position.
+ Notify index AM that core code restored the scan using a mark.
</para>
<para>
diff --git a/src/test/modules/dummy_index_am/dummy_index_am.c b/src/test/modules/dummy_index_am/dummy_index_am.c
index 94ef639b6..434653527 100644
--- a/src/test/modules/dummy_index_am/dummy_index_am.c
+++ b/src/test/modules/dummy_index_am/dummy_index_am.c
@@ -319,7 +319,6 @@ dihandler(PG_FUNCTION_ARGS)
amroutine->amgettuple = NULL;
amroutine->amgetbitmap = NULL;
amroutine->amendscan = diendscan;
- amroutine->ammarkpos = NULL;
amroutine->amrestrpos = NULL;
amroutine->amestimateparallelscan = NULL;
amroutine->aminitparallelscan = NULL;
diff --git a/src/tools/pgindent/typedefs.list b/src/tools/pgindent/typedefs.list
index e6f2e93b2..2a41f00ec 100644
--- a/src/tools/pgindent/typedefs.list
+++ b/src/tools/pgindent/typedefs.list
@@ -192,6 +192,8 @@ BOOL
BOOLEAN
BOX
BTArrayKeyInfo
+BTBatchInfo
+BTBatchScanPosData
BTBuildState
BTCallbackState
BTCycleId
@@ -1265,6 +1267,10 @@ IndexOrderByDistance
IndexPath
IndexRuntimeKeyInfo
IndexScan
+IndexScanBatchData
+IndexScanBatchPos
+IndexScanBatchPosItem
+IndexScanBatches
IndexScanDesc
IndexScanInstrumentation
IndexScanState
@@ -3416,10 +3422,10 @@ amestimateparallelscan_function
amgetbitmap_function
amgettreeheight_function
amgettuple_function
+amgetbatch_function
aminitparallelscan_function
aminsert_function
aminsertcleanup_function
-ammarkpos_function
amoptions_function
amparallelrescan_function
amproperty_function
--
2.50.0