#include "access/transam.h"
#include "storage/block.h"
#include "storage/bufpage.h"
#include "storage/itemptr.h"
#include "storage/off.h"

Include dependency graph for ginblock.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GinPageOpaqueData

struct	GinMetaPageData

struct	PostingItem

struct	GinPostingList

Macros
#define	GIN_DATA (1 << 0)

#define	GIN_LEAF (1 << 1)

#define	GIN_DELETED (1 << 2)

#define	GIN_META (1 << 3)

#define	GIN_LIST (1 << 4)

#define	GIN_LIST_FULLROW (1 << 5) /* makes sense only on GIN_LIST page */

#define	GIN_INCOMPLETE_SPLIT

#define	GIN_COMPRESSED (1 << 7)

#define	GIN_METAPAGE_BLKNO (0)

#define	GIN_ROOT_BLKNO (1)

#define	GIN_CURRENT_VERSION 2

#define	GinPageGetMeta(p) ((GinMetaPageData *) PageGetContents(p))

#define	GinPageGetOpaque(page) ( (GinPageOpaque) PageGetSpecialPointer(page) )

#define	GinPageIsLeaf(page) ( (GinPageGetOpaque(page)->flags & GIN_LEAF) != 0 )

#define	GinPageSetLeaf(page) ( GinPageGetOpaque(page)->flags \|= GIN_LEAF )

#define	GinPageSetNonLeaf(page) ( GinPageGetOpaque(page)->flags &= ~GIN_LEAF )

#define	GinPageIsData(page) ( (GinPageGetOpaque(page)->flags & GIN_DATA) != 0 )

#define	GinPageSetData(page) ( GinPageGetOpaque(page)->flags \|= GIN_DATA )

#define	GinPageIsList(page) ( (GinPageGetOpaque(page)->flags & GIN_LIST) != 0 )

#define	GinPageSetList(page) ( GinPageGetOpaque(page)->flags \|= GIN_LIST )

#define	GinPageHasFullRow(page) ( (GinPageGetOpaque(page)->flags & GIN_LIST_FULLROW) != 0 )

#define	GinPageSetFullRow(page) ( GinPageGetOpaque(page)->flags \|= GIN_LIST_FULLROW )

#define	GinPageIsCompressed(page) ( (GinPageGetOpaque(page)->flags & GIN_COMPRESSED) != 0 )

#define	GinPageSetCompressed(page) ( GinPageGetOpaque(page)->flags \|= GIN_COMPRESSED )

#define	GinPageIsDeleted(page) ( (GinPageGetOpaque(page)->flags & GIN_DELETED) != 0 )

#define	GinPageSetDeleted(page) ( GinPageGetOpaque(page)->flags \|= GIN_DELETED)

#define	GinPageSetNonDeleted(page) ( GinPageGetOpaque(page)->flags &= ~GIN_DELETED)

#define	GinPageIsIncompleteSplit(page) ( (GinPageGetOpaque(page)->flags & GIN_INCOMPLETE_SPLIT) != 0 )

#define	GinPageRightMost(page) ( GinPageGetOpaque(page)->rightlink == InvalidBlockNumber)

#define	GinPageGetDeleteXid(page) ( ((PageHeader) (page))->pd_prune_xid )

#define	GinPageSetDeleteXid(page, xid) ( ((PageHeader) (page))->pd_prune_xid = xid)

#define	GinItemPointerGetBlockNumber(pointer) (ItemPointerGetBlockNumberNoCheck(pointer))

#define	GinItemPointerGetOffsetNumber(pointer) (ItemPointerGetOffsetNumberNoCheck(pointer))

#define	GinItemPointerSetBlockNumber(pointer, blkno) (ItemPointerSetBlockNumber((pointer), (blkno)))

#define	GinItemPointerSetOffsetNumber(pointer, offnum) (ItemPointerSetOffsetNumber((pointer), (offnum)))

#define	ItemPointerSetMin(p) ItemPointerSet((p), (BlockNumber)0, (OffsetNumber)0)

#define	ItemPointerIsMin(p)

#define	ItemPointerSetMax(p) ItemPointerSet((p), InvalidBlockNumber, (OffsetNumber)0xffff)

#define	ItemPointerSetLossyPage(p, b) ItemPointerSet((p), (b), (OffsetNumber)0xffff)

#define	ItemPointerIsLossyPage(p)

#define	PostingItemGetBlockNumber(pointer) BlockIdGetBlockNumber(&(pointer)->child_blkno)

#define	PostingItemSetBlockNumber(pointer, blockNumber) BlockIdSet(&((pointer)->child_blkno), (blockNumber))

#define	GIN_CAT_NORM_KEY 0 /* normal, non-null key value */

#define	GIN_CAT_NULL_KEY 1 /* null key value */

#define	GIN_CAT_EMPTY_ITEM 2 /* placeholder for zero-key item */

#define	GIN_CAT_NULL_ITEM 3 /* placeholder for null item */

#define	GIN_CAT_EMPTY_QUERY (-1) /* placeholder for full-scan query */

#define	GinCategoryOffset(itup, ginstate)

#define	GinGetNullCategory(itup, ginstate) (((GinNullCategory ) ((char*)(itup) + GinCategoryOffset(itup,ginstate))))

#define	GinSetNullCategory(itup, ginstate, c) (((GinNullCategory ) ((char*)(itup) + GinCategoryOffset(itup,ginstate))) = (c))

#define	GinGetNPosting(itup) GinItemPointerGetOffsetNumber(&(itup)->t_tid)

#define	GinSetNPosting(itup, n) ItemPointerSetOffsetNumber(&(itup)->t_tid,n)

#define	GIN_TREE_POSTING ((OffsetNumber)0xffff)

#define	GinIsPostingTree(itup) (GinGetNPosting(itup) == GIN_TREE_POSTING)

#define	GinSetPostingTree(itup, blkno) ( GinSetNPosting((itup),GIN_TREE_POSTING), ItemPointerSetBlockNumber(&(itup)->t_tid, blkno) )

#define	GinGetPostingTree(itup) GinItemPointerGetBlockNumber(&(itup)->t_tid)

#define	GIN_ITUP_COMPRESSED (1U << 31)

#define	GinGetPostingOffset(itup) (GinItemPointerGetBlockNumber(&(itup)->t_tid) & (~GIN_ITUP_COMPRESSED))

#define	GinSetPostingOffset(itup, n) ItemPointerSetBlockNumber(&(itup)->t_tid,(n)\|GIN_ITUP_COMPRESSED)

#define	GinGetPosting(itup) ((Pointer) ((char*)(itup) + GinGetPostingOffset(itup)))

#define	GinItupIsCompressed(itup) ((GinItemPointerGetBlockNumber(&(itup)->t_tid) & GIN_ITUP_COMPRESSED) != 0)

#define	GinMaxItemSize

#define	GinGetDownlink(itup) GinItemPointerGetBlockNumber(&(itup)->t_tid)

#define	GinSetDownlink(itup, blkno) ItemPointerSet(&(itup)->t_tid, blkno, InvalidOffsetNumber)

#define	GinDataLeafPageGetPostingList(page) (GinPostingList *) ((PageGetContents(page) + MAXALIGN(sizeof(ItemPointerData))))

#define	GinDataLeafPageGetPostingListSize(page) (((PageHeader) page)->pd_lower - MAXALIGN(SizeOfPageHeaderData) - MAXALIGN(sizeof(ItemPointerData)))

#define	GinDataLeafPageIsEmpty(page) (GinPageIsCompressed(page) ? (GinDataLeafPageGetPostingListSize(page) == 0) : (GinPageGetOpaque(page)->maxoff < FirstOffsetNumber))

#define	GinDataLeafPageGetFreeSpace(page) PageGetExactFreeSpace(page)

#define	GinDataPageGetRightBound(page) ((ItemPointer) PageGetContents(page))

#define	GinDataPageGetData(page) (PageGetContents(page) + MAXALIGN(sizeof(ItemPointerData)))

#define	GinDataPageGetPostingItem(page, i) ((PostingItem ) (GinDataPageGetData(page) + ((i)-1) sizeof(PostingItem)))

#define	GinDataPageSetDataSize(page, size)

#define	GinNonLeafDataPageGetFreeSpace(page)

#define	GinDataPageMaxDataSize

#define	GinListPageSize ( BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(GinPageOpaqueData)) )

#define	SizeOfGinPostingList(plist) (offsetof(GinPostingList, bytes) + SHORTALIGN((plist)->nbytes) )

#define	GinNextPostingListSegment(cur) ((GinPostingList ) (((char ) (cur)) + SizeOfGinPostingList((cur))))

Typedefs
typedef struct GinPageOpaqueData	GinPageOpaqueData

typedef GinPageOpaqueData *	GinPageOpaque

typedef struct GinMetaPageData	GinMetaPageData

typedef signed char	GinNullCategory

Functions
bool	GinPageIsRecyclable (Page page)

Macro Definition Documentation

◆ GIN_CAT_EMPTY_ITEM

#define GIN_CAT_EMPTY_ITEM 2 /* placeholder for zero-key item */

Definition at line 211 of file ginblock.h.

Referenced by ginExtractEntries(), and ginFillScanKey().

◆ GIN_CAT_EMPTY_QUERY

#define GIN_CAT_EMPTY_QUERY (-1) /* placeholder for full-scan query */

Definition at line 213 of file ginblock.h.

Referenced by collectMatchesForHeapRow(), ginFillScanKey(), and startScanEntry().

◆ GIN_CAT_NORM_KEY

#define GIN_CAT_NORM_KEY 0 /* normal, non-null key value */

Definition at line 209 of file ginblock.h.

Referenced by collectMatchBitmap(), ginCompareEntries(), ginExtractEntries(), GinFormTuple(), ginInsertBAEntry(), gintuple_get_key(), and matchPartialInPendingList().

◆ GIN_CAT_NULL_ITEM

#define GIN_CAT_NULL_ITEM 3 /* placeholder for null item */

Definition at line 212 of file ginblock.h.

Referenced by collectMatchBitmap(), collectMatchesForHeapRow(), and ginExtractEntries().

◆ GIN_CAT_NULL_KEY

#define GIN_CAT_NULL_KEY 1 /* null key value */

Definition at line 210 of file ginblock.h.

Referenced by ginExtractEntries().

◆ GIN_COMPRESSED

#define GIN_COMPRESSED (1 << 7)

Definition at line 49 of file ginblock.h.

Referenced by createPostingTree(), dataPlaceToPageLeafSplit(), gin_leafpage_items(), gin_page_opaque_info(), ginPlaceToPage(), and ginRedoCreatePTree().

◆ GIN_CURRENT_VERSION

#define GIN_CURRENT_VERSION 2

Definition at line 103 of file ginblock.h.

Referenced by GinInitMetabuffer().

◆ GIN_DATA

#define GIN_DATA (1 << 0)

Definition at line 41 of file ginblock.h.

Referenced by createPostingTree(), dataPlaceToPageLeafSplit(), gin_leafpage_items(), gin_page_opaque_info(), and ginRedoCreatePTree().

◆ GIN_DELETED

#define GIN_DELETED (1 << 2)

Definition at line 43 of file ginblock.h.

Referenced by entryLoadMoreItems(), gin_mask(), gin_page_opaque_info(), ginRedoDeleteListPages(), scanPostingTree(), and shiftList().

◆ GIN_INCOMPLETE_SPLIT

#define GIN_INCOMPLETE_SPLIT

Value:

(1 << 6) /* page was split, but parent not

* updated */

Definition at line 47 of file ginblock.h.

Referenced by gin_page_opaque_info(), ginPlaceToPage(), and ginRedoClearIncompleteSplit().

◆ GIN_ITUP_COMPRESSED

#define GIN_ITUP_COMPRESSED (1U << 31)

Definition at line 236 of file ginblock.h.

◆ GIN_LEAF

#define GIN_LEAF (1 << 1)

Definition at line 42 of file ginblock.h.

Referenced by createPostingTree(), dataPlaceToPageLeafSplit(), gin_leafpage_items(), gin_page_opaque_info(), ginbuild(), ginbuildempty(), ginPlaceToPage(), and ginRedoCreatePTree().

◆ GIN_LIST

#define GIN_LIST (1 << 4)

Definition at line 45 of file ginblock.h.

Referenced by gin_page_opaque_info(), ginRedoInsertListPage(), and writeListPage().

◆ GIN_LIST_FULLROW

#define GIN_LIST_FULLROW (1 << 5) /* makes sense only on GIN_LIST page */

Definition at line 46 of file ginblock.h.

Referenced by gin_page_opaque_info().

◆ GIN_META

#define GIN_META (1 << 3)

Definition at line 44 of file ginblock.h.

Referenced by gin_metapage_info(), gin_page_opaque_info(), and GinInitMetabuffer().

◆ GIN_METAPAGE_BLKNO

#define GIN_METAPAGE_BLKNO (0)

Definition at line 52 of file ginblock.h.

Referenced by ginGetStats(), ginHeapTupleFastInsert(), ginInsertCleanup(), ginRedoDeleteListPages(), ginRedoUpdateMetapage(), ginUpdateStats(), pgstatginindex_internal(), and scanPendingInsert().

◆ GIN_ROOT_BLKNO

#define GIN_ROOT_BLKNO (1)

Definition at line 53 of file ginblock.h.

Referenced by entryLocateEntry(), ginbulkdelete(), ginPrepareEntryScan(), and ginvacuumcleanup().

◆ GIN_TREE_POSTING

#define GIN_TREE_POSTING ((OffsetNumber)0xffff)

Definition at line 231 of file ginblock.h.

◆ GinCategoryOffset

#define GinCategoryOffset	(	itup,
		ginstate
	)

Value:

(IndexInfoFindDataOffset((itup)->t_info) + \

((ginstate)->oneCol ? 0 : sizeof(int16)))

int16

signed short int16

Definition: c.h:416

IndexInfoFindDataOffset

#define IndexInfoFindDataOffset(t_info)

Definition: itup.h:80

Definition at line 218 of file ginblock.h.

Referenced by GinFormTuple().

◆ GinDataLeafPageGetFreeSpace

#define GinDataLeafPageGetFreeSpace ( page ) PageGetExactFreeSpace(page)

Definition at line 287 of file ginblock.h.

Referenced by dataBeginPlaceToPageLeaf().

◆ GinDataLeafPageGetPostingList

#define GinDataLeafPageGetPostingList ( page ) (GinPostingList *) ((PageGetContents(page) + MAXALIGN(sizeof(ItemPointerData))))

Definition at line 279 of file ginblock.h.

Referenced by createPostingTree(), dataPlaceToPageLeafRecompress(), dataPlaceToPageLeafSplit(), disassembleLeaf(), gin_leafpage_items(), GinDataLeafPageGetItems(), GinDataLeafPageGetItemsToTbm(), ginRedoCreatePTree(), and ginRedoRecompress().

◆ GinDataLeafPageGetPostingListSize

#define GinDataLeafPageGetPostingListSize ( page ) (((PageHeader) page)->pd_lower - MAXALIGN(SizeOfPageHeaderData) - MAXALIGN(sizeof(ItemPointerData)))

Definition at line 281 of file ginblock.h.

Referenced by disassembleLeaf(), gin_leafpage_items(), GinDataLeafPageGetItems(), GinDataLeafPageGetItemsToTbm(), and ginRedoRecompress().

◆ GinDataLeafPageIsEmpty

#define GinDataLeafPageIsEmpty ( page ) (GinPageIsCompressed(page) ? (GinDataLeafPageGetPostingListSize(page) == 0) : (GinPageGetOpaque(page)->maxoff < FirstOffsetNumber))

Definition at line 284 of file ginblock.h.

Referenced by ginScanToDelete(), and ginVacuumPostingTreeLeaves().

◆ GinDataPageGetData

#define GinDataPageGetData ( page ) (PageGetContents(page) + MAXALIGN(sizeof(ItemPointerData)))

Definition at line 296 of file ginblock.h.

Referenced by dataLeafPageGetUncompressed(), and ginRedoRecompress().

◆ GinDataPageGetPostingItem

#define GinDataPageGetPostingItem	(	page,
		i
	)	((PostingItem ) (GinDataPageGetData(page) + ((i)-1) sizeof(PostingItem)))

Definition at line 299 of file ginblock.h.

Referenced by dataExecPlaceToPageInternal(), dataFindChildPtr(), dataGetLeftMostPage(), dataLocateItem(), dataSplitPageInternal(), GinDataPageAddPostingItem(), ginDeletePage(), GinPageDeletePostingItem(), ginRedoInsertData(), ginScanToDelete(), and ginVacuumPostingTreeLeaves().

◆ GinDataPageGetRightBound

#define GinDataPageGetRightBound ( page ) ((ItemPointer) PageGetContents(page))

Definition at line 289 of file ginblock.h.

Referenced by dataBeginPlaceToPageLeaf(), dataIsMoveRight(), dataPlaceToPageLeafSplit(), dataPrepareDownlink(), dataSplitPageInternal(), entryLoadMoreItems(), and ginDataFillRoot().

◆ GinDataPageMaxDataSize

#define GinDataPageMaxDataSize

Value:

(BLCKSZ - MAXALIGN(SizeOfPageHeaderData) \
     - MAXALIGN(sizeof(ItemPointerData)) \
     - MAXALIGN(sizeof(GinPageOpaqueData)))

Definition at line 320 of file ginblock.h.

Referenced by createPostingTree(), dataBeginPlaceToPageLeaf(), dataPlaceToPageLeafRecompress(), ginVacuumPostingTreeLeaf(), and leafRepackItems().

◆ GinDataPageSetDataSize

#define GinDataPageSetDataSize	(	page,
		size
	)

Value:

{ \
        Assert(size <= GinDataPageMaxDataSize); \
        ((PageHeader) page)->pd_lower = (size) + MAXALIGN(SizeOfPageHeaderData) + MAXALIGN(sizeof(ItemPointerData)); \
    }

Definition at line 310 of file ginblock.h.

Referenced by createPostingTree(), dataPlaceToPageLeafRecompress(), dataPlaceToPageLeafSplit(), dataSplitPageInternal(), GinDataPageAddPostingItem(), GinPageDeletePostingItem(), ginRedoCreatePTree(), and ginRedoRecompress().

◆ GinGetDownlink

#define GinGetDownlink ( itup ) GinItemPointerGetBlockNumber(&(itup)->t_tid)

Definition at line 258 of file ginblock.h.

Referenced by entryFindChildPtr(), entryGetLeftMostPage(), entryLocateEntry(), ginbulkdelete(), and ginVacuumEntryPage().

◆ GinGetNPosting

#define GinGetNPosting ( itup ) GinItemPointerGetOffsetNumber(&(itup)->t_tid)

Definition at line 229 of file ginblock.h.

Referenced by collectMatchBitmap(), ginReadTuple(), ginVacuumEntryPage(), and startScanEntry().

◆ GinGetNullCategory

#define GinGetNullCategory	(	itup,
		ginstate
	)	(((GinNullCategory ) ((char*)(itup) + GinCategoryOffset(itup,ginstate))))

Definition at line 221 of file ginblock.h.

Referenced by gintuple_get_key().

◆ GinGetPosting

#define GinGetPosting ( itup ) ((Pointer) ((char*)(itup) + GinGetPostingOffset(itup)))

Definition at line 239 of file ginblock.h.

Referenced by GinFormTuple(), ginReadTuple(), and ginVacuumEntryPage().

◆ GinGetPostingOffset

#define GinGetPostingOffset ( itup ) (GinItemPointerGetBlockNumber(&(itup)->t_tid) & (~GIN_ITUP_COMPRESSED))

Definition at line 237 of file ginblock.h.

Referenced by GinFormInteriorTuple().

◆ GinGetPostingTree

#define GinGetPostingTree ( itup ) GinItemPointerGetBlockNumber(&(itup)->t_tid)

Definition at line 234 of file ginblock.h.

Referenced by collectMatchBitmap(), ginEntryInsert(), and startScanEntry().

◆ GinIsPostingTree

#define GinIsPostingTree ( itup ) (GinGetNPosting(itup) == GIN_TREE_POSTING)

Definition at line 232 of file ginblock.h.

Referenced by addItemPointersToLeafTuple(), collectMatchBitmap(), ginEntryInsert(), GinFormInteriorTuple(), ginVacuumEntryPage(), and startScanEntry().

◆ GinItemPointerGetBlockNumber

#define GinItemPointerGetBlockNumber ( pointer ) (ItemPointerGetBlockNumberNoCheck(pointer))

Definition at line 144 of file ginblock.h.

Referenced by entryGetItem(), entryLoadMoreItems(), ginCompareItemPointers(), itemptr_to_uint64(), keyGetItem(), and scanGetItem().

◆ GinItemPointerGetOffsetNumber

#define GinItemPointerGetOffsetNumber ( pointer ) (ItemPointerGetOffsetNumberNoCheck(pointer))

Definition at line 147 of file ginblock.h.

Referenced by entryGetItem(), entryLoadMoreItems(), ginCompareItemPointers(), itemptr_to_uint64(), keyGetItem(), and scanGetItem().

◆ GinItemPointerSetBlockNumber

#define GinItemPointerSetBlockNumber	(	pointer,
		blkno
	)	(ItemPointerSetBlockNumber((pointer), (blkno)))

Definition at line 150 of file ginblock.h.

Referenced by uint64_to_itemptr().

◆ GinItemPointerSetOffsetNumber

#define GinItemPointerSetOffsetNumber	(	pointer,
		offnum
	)	(ItemPointerSetOffsetNumber((pointer), (offnum)))

Definition at line 153 of file ginblock.h.

Referenced by uint64_to_itemptr().

◆ GinItupIsCompressed

#define GinItupIsCompressed ( itup ) ((GinItemPointerGetBlockNumber(&(itup)->t_tid) & GIN_ITUP_COMPRESSED) != 0)

Definition at line 240 of file ginblock.h.

Referenced by ginReadTuple(), and ginVacuumEntryPage().

◆ GinListPageSize

#define GinListPageSize ( BLCKSZ - SizeOfPageHeaderData - MAXALIGN(sizeof(GinPageOpaqueData)) )

Definition at line 328 of file ginblock.h.

Referenced by ginHeapTupleFastInsert(), and makeSublist().

◆ GinMaxItemSize

#define GinMaxItemSize

Value:

Min(INDEX_SIZE_MASK, \
        MAXALIGN_DOWN(((BLCKSZ - \
                        MAXALIGN(SizeOfPageHeaderData + 3 * sizeof(ItemIdData)) - \
                        MAXALIGN(sizeof(GinPageOpaqueData))) / 3)))

Definition at line 249 of file ginblock.h.

Referenced by addItemPointersToLeafTuple(), buildFreshLeafTuple(), GinFormTuple(), and ginVacuumEntryPage().

◆ GinNextPostingListSegment

#define GinNextPostingListSegment ( cur ) ((GinPostingList *) (((char *) (cur)) + SizeOfGinPostingList((cur))))

Definition at line 344 of file ginblock.h.

Referenced by disassembleLeaf(), gin_leafpage_items(), GinDataLeafPageGetItems(), ginPostingListDecodeAllSegments(), and ginRedoRecompress().

◆ GinNonLeafDataPageGetFreeSpace

#define GinNonLeafDataPageGetFreeSpace ( page )

Value:

(GinDataPageMaxDataSize - \

GinPageGetOpaque(page)->maxoff * sizeof(PostingItem))

PostingItem

Definition: ginblock.h:183

GinDataPageMaxDataSize

#define GinDataPageMaxDataSize

Definition: ginblock.h:320

Definition at line 316 of file ginblock.h.

Referenced by dataBeginPlaceToPageInternal(), and dataSplitPageInternal().

◆ GinPageGetDeleteXid

#define GinPageGetDeleteXid ( page ) ( ((PageHeader) (page))->pd_prune_xid )

Definition at line 136 of file ginblock.h.

Referenced by ginDeletePage(), and GinPageIsRecyclable().

◆ GinPageGetMeta

#define GinPageGetMeta ( p ) ((GinMetaPageData *) PageGetContents(p))

Definition at line 105 of file ginblock.h.

Referenced by gin_metapage_info(), ginGetStats(), ginHeapTupleFastInsert(), GinInitMetabuffer(), ginInsertCleanup(), ginRedoDeleteListPages(), ginRedoUpdateMetapage(), ginUpdateStats(), pgstatginindex_internal(), scanPendingInsert(), and shiftList().

◆ GinPageGetOpaque

#define GinPageGetOpaque ( page ) ( (GinPageOpaque) PageGetSpecialPointer(page) )

◆ GinPageHasFullRow

#define GinPageHasFullRow ( page ) ( (GinPageGetOpaque(page)->flags & GIN_LIST_FULLROW) != 0 )

Definition at line 120 of file ginblock.h.

Referenced by collectMatchesForHeapRow(), ginInsertCleanup(), and scanGetCandidate().

◆ GinPageIsCompressed

#define GinPageIsCompressed ( page ) ( (GinPageGetOpaque(page)->flags & GIN_COMPRESSED) != 0 )

Definition at line 122 of file ginblock.h.

Referenced by dataBeginPlaceToPageLeaf(), dataLeafPageGetUncompressed(), dataPlaceToPageLeafRecompress(), disassembleLeaf(), GinDataLeafPageGetItems(), GinDataLeafPageGetItemsToTbm(), and ginRedoRecompress().

◆ GinPageIsData

#define GinPageIsData ( page ) ( (GinPageGetOpaque(page)->flags & GIN_DATA) != 0 )

◆ GinPageIsDeleted

#define GinPageIsDeleted ( page ) ( (GinPageGetOpaque(page)->flags & GIN_DELETED) != 0 )

Definition at line 125 of file ginblock.h.

Referenced by dataIsMoveRight(), ginInsertCleanup(), GinPageIsRecyclable(), and shiftList().

◆ GinPageIsIncompleteSplit

#define GinPageIsIncompleteSplit ( page ) ( (GinPageGetOpaque(page)->flags & GIN_INCOMPLETE_SPLIT) != 0 )

Definition at line 128 of file ginblock.h.

Referenced by ginFindLeafPage(), ginFindParents(), ginFinishSplit(), and ginInsertValue().

◆ GinPageIsLeaf

#define GinPageIsLeaf ( page ) ( (GinPageGetOpaque(page)->flags & GIN_LEAF) != 0 )

◆ GinPageIsList

#define GinPageIsList ( page ) ( (GinPageGetOpaque(page)->flags & GIN_LIST) != 0 )

Definition at line 118 of file ginblock.h.

Referenced by ginvacuumcleanup().

◆ GinPageRightMost

#define GinPageRightMost ( page ) ( GinPageGetOpaque(page)->rightlink == InvalidBlockNumber)

Definition at line 130 of file ginblock.h.

Referenced by dataBeginPlaceToPageLeaf(), dataIsMoveRight(), dataSplitPageInternal(), entryIsMoveRight(), entryLoadMoreItems(), entryLocateEntry(), ginFinishSplit(), ginScanToDelete(), moveRightIfItNeeded(), and scanPostingTree().

◆ GinPageSetCompressed

#define GinPageSetCompressed ( page ) ( GinPageGetOpaque(page)->flags |= GIN_COMPRESSED )

Definition at line 123 of file ginblock.h.

Referenced by dataPlaceToPageLeafRecompress(), and ginRedoRecompress().

◆ GinPageSetData

#define GinPageSetData ( page ) ( GinPageGetOpaque(page)->flags |= GIN_DATA )

Definition at line 117 of file ginblock.h.

◆ GinPageSetDeleted

#define GinPageSetDeleted ( page ) ( GinPageGetOpaque(page)->flags |= GIN_DELETED)

Definition at line 126 of file ginblock.h.

Referenced by ginDeletePage(), and ginRedoDeletePage().

◆ GinPageSetDeleteXid

#define GinPageSetDeleteXid	(	page,
		xid
	)	( ((PageHeader) (page))->pd_prune_xid = xid)

Definition at line 137 of file ginblock.h.

Referenced by ginDeletePage(), and ginRedoDeletePage().

◆ GinPageSetFullRow

#define GinPageSetFullRow ( page ) ( GinPageGetOpaque(page)->flags |= GIN_LIST_FULLROW )

Definition at line 121 of file ginblock.h.

Referenced by ginRedoInsertListPage(), and writeListPage().

◆ GinPageSetLeaf

#define GinPageSetLeaf ( page ) ( GinPageGetOpaque(page)->flags |= GIN_LEAF )

Definition at line 114 of file ginblock.h.

◆ GinPageSetList

#define GinPageSetList ( page ) ( GinPageGetOpaque(page)->flags |= GIN_LIST )

Definition at line 119 of file ginblock.h.

◆ GinPageSetNonDeleted

#define GinPageSetNonDeleted ( page ) ( GinPageGetOpaque(page)->flags &= ~GIN_DELETED)

Definition at line 127 of file ginblock.h.

◆ GinPageSetNonLeaf

#define GinPageSetNonLeaf ( page ) ( GinPageGetOpaque(page)->flags &= ~GIN_LEAF )

Definition at line 115 of file ginblock.h.

◆ GinSetDownlink

#define GinSetDownlink	(	itup,
		blkno
	)	ItemPointerSet(&(itup)->t_tid, blkno, InvalidOffsetNumber)

Definition at line 259 of file ginblock.h.

Referenced by entryPreparePage(), GinFormInteriorTuple(), and ginRedoInsertEntry().

◆ GinSetNPosting

#define GinSetNPosting	(	itup,
		n
	)	ItemPointerSetOffsetNumber(&(itup)->t_tid,n)

Definition at line 230 of file ginblock.h.

Referenced by GinFormTuple().

◆ GinSetNullCategory

#define GinSetNullCategory	(	itup,
		ginstate,
		c
	)	(((GinNullCategory ) ((char*)(itup) + GinCategoryOffset(itup,ginstate))) = (c))

Definition at line 223 of file ginblock.h.

Referenced by GinFormTuple().

◆ GinSetPostingOffset

#define GinSetPostingOffset	(	itup,
		n
	)	ItemPointerSetBlockNumber(&(itup)->t_tid,(n)\|GIN_ITUP_COMPRESSED)

Definition at line 238 of file ginblock.h.

Referenced by GinFormTuple().

◆ GinSetPostingTree

#define GinSetPostingTree	(	itup,
		blkno
	)	( GinSetNPosting((itup),GIN_TREE_POSTING), ItemPointerSetBlockNumber(&(itup)->t_tid, blkno) )

Definition at line 233 of file ginblock.h.

Referenced by addItemPointersToLeafTuple(), and buildFreshLeafTuple().

◆ ItemPointerIsLossyPage

#define ItemPointerIsLossyPage ( p )

Value:

(GinItemPointerGetOffsetNumber(p) == (OffsetNumber)0xffff && \

GinItemPointerGetBlockNumber(p) != InvalidBlockNumber)

GinItemPointerGetOffsetNumber

#define GinItemPointerGetOffsetNumber(pointer)

Definition: ginblock.h:147

OffsetNumber

uint16 OffsetNumber

Definition: off.h:24

InvalidBlockNumber

#define InvalidBlockNumber

Definition: block.h:33

GinItemPointerGetBlockNumber

#define GinItemPointerGetBlockNumber(pointer)

Definition: ginblock.h:144

Definition at line 176 of file ginblock.h.

Referenced by entryGetItem(), entryLoadMoreItems(), gingetbitmap(), keyGetItem(), and scanGetItem().

◆ ItemPointerIsMin

#define ItemPointerIsMin ( p )

Value:

(GinItemPointerGetOffsetNumber(p) == (OffsetNumber)0 && \

GinItemPointerGetBlockNumber(p) == (BlockNumber)0)

GinItemPointerGetOffsetNumber

#define GinItemPointerGetOffsetNumber(pointer)

Definition: ginblock.h:147

BlockNumber

uint32 BlockNumber

Definition: block.h:31

OffsetNumber

uint16 OffsetNumber

Definition: off.h:24

GinItemPointerGetBlockNumber

#define GinItemPointerGetBlockNumber(pointer)

Definition: ginblock.h:144

Definition at line 169 of file ginblock.h.

Referenced by scanGetItem().

◆ ItemPointerSetLossyPage

#define ItemPointerSetLossyPage	(	p,
		b
	)	ItemPointerSet((p), (b), (OffsetNumber)0xffff)

Definition at line 174 of file ginblock.h.

Referenced by entryGetItem(), and keyGetItem().

◆ ItemPointerSetMax

#define ItemPointerSetMax ( p ) ItemPointerSet((p), InvalidBlockNumber, (OffsetNumber)0xffff)

Definition at line 172 of file ginblock.h.

Referenced by keyGetItem().

◆ ItemPointerSetMin

#define ItemPointerSetMin ( p ) ItemPointerSet((p), (BlockNumber)0, (OffsetNumber)0)

Definition at line 167 of file ginblock.h.

Referenced by dataBeginPlaceToPageLeaf(), ginFillScanEntry(), ginFillScanKey(), gingetbitmap(), scanGetItem(), startScanEntry(), and startScanKey().

◆ PostingItemGetBlockNumber

#define PostingItemGetBlockNumber ( pointer ) BlockIdGetBlockNumber(&(pointer)->child_blkno)

Definition at line 190 of file ginblock.h.

Referenced by dataFindChildPtr(), dataGetLeftMostPage(), dataLocateItem(), gin_desc(), GinDataPageAddPostingItem(), ginDeletePage(), ginScanToDelete(), and ginVacuumPostingTreeLeaves().

◆ PostingItemSetBlockNumber

#define PostingItemSetBlockNumber	(	pointer,
		blockNumber
	)	BlockIdSet(&((pointer)->child_blkno), (blockNumber))

Definition at line 193 of file ginblock.h.

Referenced by dataExecPlaceToPageInternal(), dataPrepareDownlink(), dataSplitPageInternal(), ginDataFillRoot(), and ginRedoInsertData().

◆ SizeOfGinPostingList

#define SizeOfGinPostingList ( plist ) (offsetof(GinPostingList, bytes) + SHORTALIGN((plist)->nbytes) )

Definition at line 343 of file ginblock.h.

Referenced by addItemPointersToLeafTuple(), addItemsToLeaf(), buildFreshLeafTuple(), computeLeafRecompressWALData(), createPostingTree(), dataBeginPlaceToPageLeaf(), dataPlaceToPageLeafRecompress(), dataPlaceToPageLeafSplit(), desc_recompress_leaf(), ginCompressPostingList(), ginPostingListDecode(), ginRedoRecompress(), ginVacuumEntryPage(), ginVacuumPostingTreeLeaf(), leafRepackItems(), and test_itemptr_pair().

Typedef Documentation

◆ GinMetaPageData

typedef struct GinMetaPageData GinMetaPageData

◆ GinNullCategory

typedef signed char GinNullCategory

Definition at line 207 of file ginblock.h.

◆ GinPageOpaque

typedef GinPageOpaqueData* GinPageOpaque

Definition at line 39 of file ginblock.h.

◆ GinPageOpaqueData

typedef struct GinPageOpaqueData GinPageOpaqueData

Function Documentation

◆ GinPageIsRecyclable()

bool GinPageIsRecyclable ( Page page )

Definition at line 801 of file ginvacuum.c.

References GinPageGetDeleteXid, GinPageIsDeleted, GlobalVisCheckRemovableXid(), PageIsNew, and TransactionIdIsValid.

Referenced by GinNewBuffer(), and ginvacuumcleanup().

 {
     TransactionId delete_xid;
 
     if (PageIsNew(page))
         return true;
 
     if (!GinPageIsDeleted(page))
         return false;
 
     delete_xid = GinPageGetDeleteXid(page);
 
     if (!TransactionIdIsValid(delete_xid))
         return true;
 
     /*
      * If no backend still could view delete_xid as in running, all scans
      * concurrent with ginDeletePage() must have finished.
      */
     return GlobalVisCheckRemovableXid(NULL, delete_xid);
 }

Data Structures

Macros

Typedefs

Functions

Macro Definition Documentation

◆ GIN_CAT_EMPTY_ITEM

◆ GIN_CAT_EMPTY_QUERY

◆ GIN_CAT_NORM_KEY

◆ GIN_CAT_NULL_ITEM

◆ GIN_CAT_NULL_KEY

◆ GIN_COMPRESSED

◆ GIN_CURRENT_VERSION

◆ GIN_DATA

◆ GIN_DELETED

◆ GIN_INCOMPLETE_SPLIT

◆ GIN_ITUP_COMPRESSED

◆ GIN_LEAF

◆ GIN_LIST

◆ GIN_LIST_FULLROW

◆ GIN_META

◆ GIN_METAPAGE_BLKNO

◆ GIN_ROOT_BLKNO

◆ GIN_TREE_POSTING

◆ GinCategoryOffset

◆ GinDataLeafPageGetFreeSpace

◆ GinDataLeafPageGetPostingList

◆ GinDataLeafPageGetPostingListSize

◆ GinDataLeafPageIsEmpty

◆ GinDataPageGetData

◆ GinDataPageGetPostingItem

◆ GinDataPageGetRightBound

◆ GinDataPageMaxDataSize

◆ GinDataPageSetDataSize

◆ GinGetDownlink

◆ GinGetNPosting

◆ GinGetNullCategory

◆ GinGetPosting

◆ GinGetPostingOffset

◆ GinGetPostingTree

◆ GinIsPostingTree

◆ GinItemPointerGetBlockNumber

◆ GinItemPointerGetOffsetNumber

◆ GinItemPointerSetBlockNumber

◆ GinItemPointerSetOffsetNumber

◆ GinItupIsCompressed

◆ GinListPageSize

◆ GinMaxItemSize

◆ GinNextPostingListSegment

◆ GinNonLeafDataPageGetFreeSpace

◆ GinPageGetDeleteXid

◆ GinPageGetMeta

◆ GinPageGetOpaque

◆ GinPageHasFullRow

◆ GinPageIsCompressed

◆ GinPageIsData

◆ GinPageIsDeleted

◆ GinPageIsIncompleteSplit

◆ GinPageIsLeaf

◆ GinPageIsList

◆ GinPageRightMost

◆ GinPageSetCompressed

◆ GinPageSetData

◆ GinPageSetDeleted

◆ GinPageSetDeleteXid

◆ GinPageSetFullRow

◆ GinPageSetLeaf

◆ GinPageSetList

◆ GinPageSetNonDeleted

◆ GinPageSetNonLeaf

◆ GinSetDownlink

◆ GinSetNPosting

◆ GinSetNullCategory

◆ GinSetPostingOffset

◆ GinSetPostingTree

◆ ItemPointerIsLossyPage

◆ ItemPointerIsMin

◆ ItemPointerSetLossyPage

◆ ItemPointerSetMax

◆ ItemPointerSetMin

◆ PostingItemGetBlockNumber