From eda398ca05230d30468119b3c23cd3847dc4f29c Mon Sep 17 00:00:00 2001 From: David Christensen Date: Sun, 26 Nov 2023 16:24:09 -0500 Subject: [PATCH] Create PageUsableSpace to represent space post-smgr Work to abstract out the direct usage of SizeOfPageHeaderData and BLCKSZ from access methods; they should only need to operate from a sense of what space is available to them and not be party to the details. This is in preparation for allowing space to be reserved at the end of the page for, e.g., authenticated encryption tags and/or evs which will prevent future churn when we redefine this value in the future. --- contrib/bloom/bloom.h | 4 ++-- contrib/pageinspect/btreefuncs.c | 2 +- contrib/pgstattuple/pgstatapprox.c | 2 +- contrib/pgstattuple/pgstatindex.c | 2 +- src/backend/access/common/bufmask.c | 2 +- src/backend/access/gin/ginfast.c | 2 +- src/backend/access/gist/gistbuild.c | 4 ++-- src/backend/access/heap/heapam.c | 4 ++-- src/backend/access/heap/heapam_handler.c | 2 +- src/backend/access/heap/vacuumlazy.c | 2 +- src/backend/access/heap/visibilitymap.c | 2 +- src/backend/optimizer/util/plancat.c | 2 +- src/bin/pg_upgrade/file.c | 2 +- src/include/access/brin_page.h | 2 +- src/include/access/ginblock.h | 4 ++-- src/include/access/gist.h | 2 +- src/include/access/gist_private.h | 2 +- src/include/access/htup_details.h | 4 ++-- src/include/access/itup.h | 2 +- src/include/access/nbtree.h | 2 +- src/include/storage/bufpage.h | 7 +++++++ src/include/storage/fsm_internals.h | 2 +- 22 files changed, 33 insertions(+), 26 deletions(-) diff --git a/contrib/bloom/bloom.h b/contrib/bloom/bloom.h index 330811ec60..8331b2ab15 100644 --- a/contrib/bloom/bloom.h +++ b/contrib/bloom/bloom.h @@ -112,7 +112,7 @@ typedef struct BloomOptions */ typedef BlockNumber FreeBlockNumberArray[ MAXALIGN_DOWN( - BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(BloomPageOpaqueData)) + PageUsableSpace - MAXALIGN(sizeof(BloomPageOpaqueData)) - MAXALIGN(sizeof(uint16) * 2 + sizeof(uint32) + sizeof(BloomOptions)) ) / sizeof(BlockNumber) ]; @@ -150,7 +150,7 @@ typedef struct BloomState } BloomState; #define BloomPageGetFreeSpace(state, page) \ - (BLCKSZ - MAXALIGN(SizeOfPageHeaderData) \ + (PageUsableSpace \ - BloomPageGetMaxOffset(page) * (state)->sizeOfBloomTuple \ - MAXALIGN(sizeof(BloomPageOpaqueData))) diff --git a/contrib/pageinspect/btreefuncs.c b/contrib/pageinspect/btreefuncs.c index 9cdc8e182b..1e20fecf2f 100644 --- a/contrib/pageinspect/btreefuncs.c +++ b/contrib/pageinspect/btreefuncs.c @@ -116,7 +116,7 @@ GetBTPageStatistics(BlockNumber blkno, Buffer buffer, BTPageStat *stat) stat->blkno = blkno; - stat->max_avail = BLCKSZ - (BLCKSZ - phdr->pd_special + SizeOfPageHeaderData); + stat->max_avail = PageUsableSpace - (BLCKSZ - phdr->pd_special); stat->dead_items = stat->live_items = 0; diff --git a/contrib/pgstattuple/pgstatapprox.c b/contrib/pgstattuple/pgstatapprox.c index f601dc6121..3d2c9d186c 100644 --- a/contrib/pgstattuple/pgstatapprox.c +++ b/contrib/pgstattuple/pgstatapprox.c @@ -113,7 +113,7 @@ statapprox_heap(Relation rel, output_type *stat) if (!PageIsNew(page)) stat->free_space += PageGetHeapFreeSpace(page); else - stat->free_space += BLCKSZ - SizeOfPageHeaderData; + stat->free_space += PageUsableSpace; /* We may count the page as scanned even if it's new/empty */ scanned++; diff --git a/contrib/pgstattuple/pgstatindex.c b/contrib/pgstattuple/pgstatindex.c index 8e5a4d6a66..5ce45952cc 100644 --- a/contrib/pgstattuple/pgstatindex.c +++ b/contrib/pgstattuple/pgstatindex.c @@ -309,7 +309,7 @@ pgstatindex_impl(Relation rel, FunctionCallInfo fcinfo) { int max_avail; - max_avail = BLCKSZ - (BLCKSZ - ((PageHeader) page)->pd_special + SizeOfPageHeaderData); + max_avail = PageUsableSpace - (BLCKSZ - ((PageHeader) page)->pd_special); indexStat.max_avail += max_avail; indexStat.free_space += PageGetFreeSpace(page); diff --git a/src/backend/access/common/bufmask.c b/src/backend/access/common/bufmask.c index 5e392dab1e..dd67b53e03 100644 --- a/src/backend/access/common/bufmask.c +++ b/src/backend/access/common/bufmask.c @@ -120,7 +120,7 @@ mask_page_content(Page page) { /* Mask Page Content */ memset(page + SizeOfPageHeaderData, MASK_MARKER, - BLCKSZ - SizeOfPageHeaderData); + PageUsableSpace); /* Mask pd_lower and pd_upper */ memset(&((PageHeader) page)->pd_lower, MASK_MARKER, diff --git a/src/backend/access/gin/ginfast.c b/src/backend/access/gin/ginfast.c index 8798fbe963..9bcb2b0b95 100644 --- a/src/backend/access/gin/ginfast.c +++ b/src/backend/access/gin/ginfast.c @@ -39,7 +39,7 @@ int gin_pending_list_limit = 0; #define GIN_PAGE_FREESIZE \ - ( BLCKSZ - MAXALIGN(SizeOfPageHeaderData) - MAXALIGN(sizeof(GinPageOpaqueData)) ) + ( PageUsableSpace - MAXALIGN(sizeof(GinPageOpaqueData)) ) typedef struct KeyArray { diff --git a/src/backend/access/gist/gistbuild.c b/src/backend/access/gist/gistbuild.c index a45e2fe375..d79e7a824a 100644 --- a/src/backend/access/gist/gistbuild.c +++ b/src/backend/access/gist/gistbuild.c @@ -702,7 +702,7 @@ gistInitBuffering(GISTBuildState *buildstate) int levelStep; /* Calc space of index page which is available for index tuples */ - pageFreeSpace = BLCKSZ - SizeOfPageHeaderData - sizeof(GISTPageOpaqueData) + pageFreeSpace = PageUsableSpace - sizeof(GISTPageOpaqueData) - sizeof(ItemIdData) - buildstate->freespace; @@ -858,7 +858,7 @@ calculatePagesPerBuffer(GISTBuildState *buildstate, int levelStep) Size pageFreeSpace; /* Calc space of index page which is available for index tuples */ - pageFreeSpace = BLCKSZ - SizeOfPageHeaderData - sizeof(GISTPageOpaqueData) + pageFreeSpace = PageUsableSpace - sizeof(GISTPageOpaqueData) - sizeof(ItemIdData) - buildstate->freespace; diff --git a/src/backend/access/heap/heapam.c b/src/backend/access/heap/heapam.c index 14de8158d4..7eccd5f531 100644 --- a/src/backend/access/heap/heapam.c +++ b/src/backend/access/heap/heapam.c @@ -2064,7 +2064,7 @@ heap_prepare_insert(Relation relation, HeapTuple tup, TransactionId xid, static int heap_multi_insert_pages(HeapTuple *heaptuples, int done, int ntuples, Size saveFreeSpace) { - size_t page_avail = BLCKSZ - SizeOfPageHeaderData - saveFreeSpace; + size_t page_avail = PageUsableSpace - saveFreeSpace; int npages = 1; for (int i = done; i < ntuples; i++) @@ -2074,7 +2074,7 @@ heap_multi_insert_pages(HeapTuple *heaptuples, int done, int ntuples, Size saveF if (page_avail < tup_sz) { npages++; - page_avail = BLCKSZ - SizeOfPageHeaderData - saveFreeSpace; + page_avail = PageUsableSpace - saveFreeSpace; } page_avail -= tup_sz; } diff --git a/src/backend/access/heap/heapam_handler.c b/src/backend/access/heap/heapam_handler.c index 7c28dafb72..58e92b87a2 100644 --- a/src/backend/access/heap/heapam_handler.c +++ b/src/backend/access/heap/heapam_handler.c @@ -2092,7 +2092,7 @@ heapam_relation_toast_am(Relation rel) #define HEAP_OVERHEAD_BYTES_PER_TUPLE \ (MAXALIGN(SizeofHeapTupleHeader) + sizeof(ItemIdData)) #define HEAP_USABLE_BYTES_PER_PAGE \ - (BLCKSZ - SizeOfPageHeaderData) + (PageUsableSpace) static void heapam_estimate_rel_size(Relation rel, int32 *attr_widths, diff --git a/src/backend/access/heap/vacuumlazy.c b/src/backend/access/heap/vacuumlazy.c index 59f51f40e1..69aada1280 100644 --- a/src/backend/access/heap/vacuumlazy.c +++ b/src/backend/access/heap/vacuumlazy.c @@ -1445,7 +1445,7 @@ lazy_scan_new_or_empty(LVRelState *vacrel, Buffer buf, BlockNumber blkno, if (GetRecordedFreeSpace(vacrel->rel, blkno) == 0) { - freespace = BLCKSZ - SizeOfPageHeaderData; + freespace = PageUsableSpace; RecordPageWithFreeSpace(vacrel->rel, blkno, freespace); } diff --git a/src/backend/access/heap/visibilitymap.c b/src/backend/access/heap/visibilitymap.c index 2e18cd88bc..0bbd95be8f 100644 --- a/src/backend/access/heap/visibilitymap.c +++ b/src/backend/access/heap/visibilitymap.c @@ -105,7 +105,7 @@ * extra headers, so the whole page minus the standard page header is * used for the bitmap. */ -#define MAPSIZE (BLCKSZ - MAXALIGN(SizeOfPageHeaderData)) +#define MAPSIZE (PageUsableSpace) /* Number of heap blocks we can represent in one byte */ #define HEAPBLOCKS_PER_BYTE (BITS_PER_BYTE / BITS_PER_HEAPBLOCK) diff --git a/src/backend/optimizer/util/plancat.c b/src/backend/optimizer/util/plancat.c index 7159c775fb..7f49baeb76 100644 --- a/src/backend/optimizer/util/plancat.c +++ b/src/backend/optimizer/util/plancat.c @@ -1089,7 +1089,7 @@ estimate_rel_size(Relation rel, int32 *attr_widths, tuple_width += MAXALIGN(SizeofHeapTupleHeader); tuple_width += sizeof(ItemIdData); /* note: integer division is intentional here */ - density = (BLCKSZ - SizeOfPageHeaderData) / tuple_width; + density = (PageUsableSpace) / tuple_width; } *tuples = rint(density * (double) curpages); diff --git a/src/bin/pg_upgrade/file.c b/src/bin/pg_upgrade/file.c index d173602882..bf6c8cc5b9 100644 --- a/src/bin/pg_upgrade/file.c +++ b/src/bin/pg_upgrade/file.c @@ -187,7 +187,7 @@ rewriteVisibilityMap(const char *fromfile, const char *tofile, struct stat statbuf; /* Compute number of old-format bytes per new page */ - rewriteVmBytesPerPage = (BLCKSZ - SizeOfPageHeaderData) / 2; + rewriteVmBytesPerPage = (PageUsableSpace) / 2; if ((src_fd = open(fromfile, O_RDONLY | PG_BINARY, 0)) < 0) pg_fatal("error while copying relation \"%s.%s\": could not open file \"%s\": %s", diff --git a/src/include/access/brin_page.h b/src/include/access/brin_page.h index 3670ca6010..49f45ee9e5 100644 --- a/src/include/access/brin_page.h +++ b/src/include/access/brin_page.h @@ -86,7 +86,7 @@ typedef struct RevmapContents } RevmapContents; #define REVMAP_CONTENT_SIZE \ - (BLCKSZ - MAXALIGN(SizeOfPageHeaderData) - \ + (PageUsableSpace - \ offsetof(RevmapContents, rm_tids) - \ MAXALIGN(sizeof(BrinSpecialSpace))) /* max num of items in the array */ diff --git a/src/include/access/ginblock.h b/src/include/access/ginblock.h index c59790ec5a..0db8fa0dda 100644 --- a/src/include/access/ginblock.h +++ b/src/include/access/ginblock.h @@ -318,7 +318,7 @@ typedef signed char GinNullCategory; GinPageGetOpaque(page)->maxoff * sizeof(PostingItem)) #define GinDataPageMaxDataSize \ - (BLCKSZ - MAXALIGN(SizeOfPageHeaderData) \ + (PageUsableSpace \ - MAXALIGN(sizeof(ItemPointerData)) \ - MAXALIGN(sizeof(GinPageOpaqueData))) @@ -326,7 +326,7 @@ typedef signed char GinNullCategory; * List pages */ #define GinListPageSize \ - ( BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(GinPageOpaqueData)) ) + ( PageUsableSpace - MAXALIGN(sizeof(GinPageOpaqueData)) ) /* * A compressed posting list. diff --git a/src/include/access/gist.h b/src/include/access/gist.h index 0235716c06..6d735223ec 100644 --- a/src/include/access/gist.h +++ b/src/include/access/gist.h @@ -96,7 +96,7 @@ typedef GISTPageOpaqueData *GISTPageOpaque; * key size using opclass parameters. */ #define GISTMaxIndexTupleSize \ - MAXALIGN_DOWN((BLCKSZ - SizeOfPageHeaderData - sizeof(GISTPageOpaqueData)) / \ + MAXALIGN_DOWN((PageUsableSpace - sizeof(GISTPageOpaqueData)) / \ 4 - sizeof(ItemIdData)) #define GISTMaxIndexKeySize \ diff --git a/src/include/access/gist_private.h b/src/include/access/gist_private.h index 82eb7b4bd8..5bf5000c97 100644 --- a/src/include/access/gist_private.h +++ b/src/include/access/gist_private.h @@ -474,7 +474,7 @@ extern void gistadjustmembers(Oid opfamilyoid, /* gistutil.c */ #define GiSTPageSize \ - ( BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(GISTPageOpaqueData)) ) + ( PageUsableSpace - MAXALIGN(sizeof(GISTPageOpaqueData)) ) #define GIST_MIN_FILLFACTOR 10 #define GIST_DEFAULT_FILLFACTOR 90 diff --git a/src/include/access/htup_details.h b/src/include/access/htup_details.h index 6fd87dc108..0f7a96820c 100644 --- a/src/include/access/htup_details.h +++ b/src/include/access/htup_details.h @@ -560,7 +560,7 @@ StaticAssertDecl(MaxOffsetNumber < SpecTokenOffsetNumber, * ItemIds and tuples have different alignment requirements, don't assume that * you can, say, fit 2 tuples of size MaxHeapTupleSize/2 on the same page. */ -#define MaxHeapTupleSize (BLCKSZ - MAXALIGN(SizeOfPageHeaderData + sizeof(ItemIdData))) +#define MaxHeapTupleSize (PageUsableSpace - MAXALIGN(sizeof(ItemIdData))) #define MinHeapTupleSize MAXALIGN(SizeofHeapTupleHeader) /* @@ -575,7 +575,7 @@ StaticAssertDecl(MaxOffsetNumber < SpecTokenOffsetNumber, * require increases in the size of work arrays. */ #define MaxHeapTuplesPerPage \ - ((int) ((BLCKSZ - SizeOfPageHeaderData) / \ + ((int) ((PageUsableSpace) / \ (MAXALIGN(SizeofHeapTupleHeader) + sizeof(ItemIdData)))) /* diff --git a/src/include/access/itup.h b/src/include/access/itup.h index 1d55536dbd..4e248cb2bb 100644 --- a/src/include/access/itup.h +++ b/src/include/access/itup.h @@ -164,7 +164,7 @@ index_getattr(IndexTuple tup, int attnum, TupleDesc tupleDesc, bool *isnull) * But such a page always has at least MAXALIGN special space, so we're safe. */ #define MaxIndexTuplesPerPage \ - ((int) ((BLCKSZ - SizeOfPageHeaderData) / \ + ((int) ((PageUsableSpace) / \ (MAXALIGN(sizeof(IndexTupleData) + 1) + sizeof(ItemIdData)))) #endif /* ITUP_H */ diff --git a/src/include/access/nbtree.h b/src/include/access/nbtree.h index 7bfbf3086c..16060e09c8 100644 --- a/src/include/access/nbtree.h +++ b/src/include/access/nbtree.h @@ -183,7 +183,7 @@ typedef struct BTMetaPageData * than necessary as a result, which is considered acceptable. */ #define MaxTIDsPerBTreePage \ - (int) ((BLCKSZ - SizeOfPageHeaderData - sizeof(BTPageOpaqueData)) / \ + (int) ((PageUsableSpace - sizeof(BTPageOpaqueData)) / \ sizeof(ItemPointerData)) /* diff --git a/src/include/storage/bufpage.h b/src/include/storage/bufpage.h index 424ecba028..3d36a74385 100644 --- a/src/include/storage/bufpage.h +++ b/src/include/storage/bufpage.h @@ -213,6 +213,13 @@ typedef PageHeaderData *PageHeader; */ #define SizeOfPageHeaderData (offsetof(PageHeaderData, pd_linp)) +/* + * how much space is left after smgr's bookkeeping, etc + */ +#define PageUsableSpace (BLCKSZ - SizeOfPageHeaderData) +StaticAssertDecl(PageUsableSpace == MAXALIGN(PageUsableSpace), + "SizeOfPageHeaderData must be MAXALIGN'd"); + /* * PageIsEmpty * returns true iff no itemid has been allocated on the page diff --git a/src/include/storage/fsm_internals.h b/src/include/storage/fsm_internals.h index 9e314c83fa..2b9138f7a7 100644 --- a/src/include/storage/fsm_internals.h +++ b/src/include/storage/fsm_internals.h @@ -48,7 +48,7 @@ typedef FSMPageData *FSMPage; * Number of non-leaf and leaf nodes, and nodes in total, on an FSM page. * These definitions are internal to fsmpage.c. */ -#define NodesPerPage (BLCKSZ - MAXALIGN(SizeOfPageHeaderData) - \ +#define NodesPerPage (PageUsableSpace - \ offsetof(FSMPageData, fp_nodes)) #define NonLeafNodesPerPage (BLCKSZ / 2 - 1) -- 2.40.1