#include "access/itup.h"
#include "access/transam.h"
#include "access/xlog.h"
#include "access/xlogdefs.h"
#include "storage/block.h"
#include "storage/bufpage.h"
#include "utils/relcache.h"

Include dependency graph for gist.h:

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

Go to the source code of this file.

Data Structures
struct	GISTPageOpaqueData

struct	GIST_SPLITVEC

struct	GISTENTRY

struct	GISTDeletedPageContents

struct	GistEntryVector

Macros
#define	GIST_CONSISTENT_PROC 1

#define	GIST_UNION_PROC 2

#define	GIST_COMPRESS_PROC 3

#define	GIST_DECOMPRESS_PROC 4

#define	GIST_PENALTY_PROC 5

#define	GIST_PICKSPLIT_PROC 6

#define	GIST_EQUAL_PROC 7

#define	GIST_DISTANCE_PROC 8

#define	GIST_FETCH_PROC 9

#define	GIST_OPTIONS_PROC 10

#define	GISTNProcs 10

#define	F_LEAF (1 << 0) /* leaf page */

#define	F_DELETED (1 << 1) /* the page has been deleted */

#define	F_TUPLES_DELETED

#define	F_FOLLOW_RIGHT (1 << 3) /* page to the right has no downlink */

#define	F_HAS_GARBAGE

#define	GistBuildLSN ((XLogRecPtr) 1)

#define	GISTMaxIndexTupleSize

#define	GISTMaxIndexKeySize (GISTMaxIndexTupleSize - MAXALIGN(sizeof(IndexTupleData)))

#define	GIST_PAGE_ID 0xFF81

#define	GistPageGetOpaque(page) ( (GISTPageOpaque) PageGetSpecialPointer(page) )

#define	GistPageIsLeaf(page) ( GistPageGetOpaque(page)->flags & F_LEAF)

#define	GIST_LEAF(entry) (GistPageIsLeaf((entry)->page))

#define	GistPageIsDeleted(page) ( GistPageGetOpaque(page)->flags & F_DELETED)

#define	GistTuplesDeleted(page) ( GistPageGetOpaque(page)->flags & F_TUPLES_DELETED)

#define	GistMarkTuplesDeleted(page) ( GistPageGetOpaque(page)->flags \|= F_TUPLES_DELETED)

#define	GistClearTuplesDeleted(page) ( GistPageGetOpaque(page)->flags &= ~F_TUPLES_DELETED)

#define	GistPageHasGarbage(page) ( GistPageGetOpaque(page)->flags & F_HAS_GARBAGE)

#define	GistMarkPageHasGarbage(page) ( GistPageGetOpaque(page)->flags \|= F_HAS_GARBAGE)

#define	GistClearPageHasGarbage(page) ( GistPageGetOpaque(page)->flags &= ~F_HAS_GARBAGE)

#define	GistFollowRight(page) ( GistPageGetOpaque(page)->flags & F_FOLLOW_RIGHT)

#define	GistMarkFollowRight(page) ( GistPageGetOpaque(page)->flags \|= F_FOLLOW_RIGHT)

#define	GistClearFollowRight(page) ( GistPageGetOpaque(page)->flags &= ~F_FOLLOW_RIGHT)

#define	GistPageGetNSN(page) ( PageXLogRecPtrGet(GistPageGetOpaque(page)->nsn))

#define	GistPageSetNSN(page, val) ( PageXLogRecPtrSet(GistPageGetOpaque(page)->nsn, val))

#define	GEVHDRSZ (offsetof(GistEntryVector, vector))

#define	gistentryinit(e, k, r, pg, o, l)

Typedefs
typedef XLogRecPtr	GistNSN

typedef PageXLogRecPtr	PageGistNSN

typedef struct GISTPageOpaqueData	GISTPageOpaqueData

typedef GISTPageOpaqueData *	GISTPageOpaque

typedef struct GIST_SPLITVEC	GIST_SPLITVEC

typedef struct GISTENTRY	GISTENTRY

typedef struct GISTDeletedPageContents	GISTDeletedPageContents

Functions
static void	GistPageSetDeleted (Page page, FullTransactionId deletexid)

static FullTransactionId	GistPageGetDeleteXid (Page page)

Macro Definition Documentation

◆ F_DELETED

#define F_DELETED (1 << 1) /* the page has been deleted */

Definition at line 46 of file gist.h.

Referenced by GistPageSetDeleted().

◆ F_FOLLOW_RIGHT

#define F_FOLLOW_RIGHT (1 << 3) /* page to the right has no downlink */

Definition at line 49 of file gist.h.

◆ F_HAS_GARBAGE

#define F_HAS_GARBAGE

Value:

(1 << 4) /* some tuples on the page are dead,

* but not deleted yet */

Definition at line 50 of file gist.h.

◆ F_LEAF

#define F_LEAF (1 << 0) /* leaf page */

Definition at line 45 of file gist.h.

Referenced by gistbuild(), gistbuildempty(), gistplacetopage(), and gistRedoPageSplitRecord().

◆ F_TUPLES_DELETED

#define F_TUPLES_DELETED

Value:

(1 << 2) /* some tuples on the page were

* deleted */

Definition at line 47 of file gist.h.

◆ GEVHDRSZ

#define GEVHDRSZ (offsetof(GistEntryVector, vector))

Definition at line 230 of file gist.h.

Referenced by genericPickSplit(), gistMakeUnionItVec(), gistMakeUnionKey(), and gistSplitByKey().

◆ GIST_COMPRESS_PROC

#define GIST_COMPRESS_PROC 3

Definition at line 32 of file gist.h.

Referenced by gistcanreturn(), gistproperty(), gistvalidate(), and initGISTstate().

◆ GIST_CONSISTENT_PROC

#define GIST_CONSISTENT_PROC 1

Definition at line 30 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

◆ GIST_DECOMPRESS_PROC

#define GIST_DECOMPRESS_PROC 4

Definition at line 33 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

◆ GIST_DISTANCE_PROC

#define GIST_DISTANCE_PROC 8

Definition at line 37 of file gist.h.

Referenced by gistproperty(), gistrescan(), gistvalidate(), and initGISTstate().

◆ GIST_EQUAL_PROC

#define GIST_EQUAL_PROC 7

Definition at line 36 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

◆ GIST_FETCH_PROC

#define GIST_FETCH_PROC 9

Definition at line 38 of file gist.h.

Referenced by gistcanreturn(), gistproperty(), gistvalidate(), and initGISTstate().

◆ GIST_LEAF

#define GIST_LEAF ( entry ) (GistPageIsLeaf((entry)->page))

Definition at line 161 of file gist.h.

Referenced by g_cube_consistent(), g_int_consistent(), g_intbig_consistent(), gbt_bit_consistent(), gbt_bpchar_consistent(), gbt_bytea_consistent(), gbt_cash_consistent(), gbt_cash_distance(), gbt_date_consistent(), gbt_date_distance(), gbt_enum_consistent(), gbt_float4_consistent(), gbt_float4_distance(), gbt_float8_consistent(), gbt_float8_distance(), gbt_inet_consistent(), gbt_int2_consistent(), gbt_int2_distance(), gbt_int4_consistent(), gbt_int4_distance(), gbt_int8_consistent(), gbt_int8_distance(), gbt_intv_consistent(), gbt_intv_distance(), gbt_macad8_consistent(), gbt_macad_consistent(), gbt_numeric_consistent(), gbt_oid_consistent(), gbt_oid_distance(), gbt_text_consistent(), gbt_time_consistent(), gbt_time_distance(), gbt_timetz_consistent(), gbt_ts_consistent(), gbt_ts_distance(), gbt_tstz_consistent(), gbt_tstz_distance(), gbt_uuid_consistent(), gist_box_consistent(), gist_point_consistent(), gist_point_distance(), gseg_consistent(), gtrgm_consistent(), gtrgm_distance(), gtsquery_consistent(), inet_gist_consistent(), ltree_consistent(), and range_gist_consistent().

◆ GIST_OPTIONS_PROC

#define GIST_OPTIONS_PROC 10

Definition at line 39 of file gist.h.

Referenced by gisthandler(), and gistvalidate().

◆ GIST_PAGE_ID

#define GIST_PAGE_ID 0xFF81

Definition at line 102 of file gist.h.

Referenced by GISTInitBuffer().

◆ GIST_PENALTY_PROC

#define GIST_PENALTY_PROC 5

Definition at line 34 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

◆ GIST_PICKSPLIT_PROC

#define GIST_PICKSPLIT_PROC 6

Definition at line 35 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

◆ GIST_UNION_PROC

#define GIST_UNION_PROC 2

Definition at line 31 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

◆ GistBuildLSN

#define GistBuildLSN ((XLogRecPtr) 1)

Definition at line 60 of file gist.h.

Referenced by gistbuild(), and gistplacetopage().

◆ GistClearFollowRight

#define GistClearFollowRight ( page ) ( GistPageGetOpaque(page)->flags &= ~F_FOLLOW_RIGHT)

Definition at line 175 of file gist.h.

Referenced by gistplacetopage(), gistRedoClearFollowRight(), and gistRedoPageSplitRecord().

◆ GistClearPageHasGarbage

#define GistClearPageHasGarbage ( page ) ( GistPageGetOpaque(page)->flags &= ~F_HAS_GARBAGE)

Definition at line 171 of file gist.h.

Referenced by gist_mask(), gistprunepage(), and gistRedoDeleteRecord().

◆ GistClearTuplesDeleted

#define GistClearTuplesDeleted ( page ) ( GistPageGetOpaque(page)->flags &= ~F_TUPLES_DELETED)

Definition at line 167 of file gist.h.

◆ gistentryinit

#define gistentryinit	(	e,
		k,
		r,
		pg,
		o,
		l
	)

Value:

do { (e).key = (k); (e).rel = (r); (e).page = (pg); \

(e).offset = (o); (e).leafkey = (l); } while (0)

sort-test.key

key

Definition: sort-test.py:17

e

Definition: preproc-init.c:82

Definition at line 235 of file gist.h.

Referenced by _ltree_compress(), findDontCares(), g_cube_decompress(), g_int_compress(), g_int_decompress(), g_intbig_compress(), gbt_bpchar_compress(), gbt_inet_compress(), gbt_intv_compress(), gbt_intv_decompress(), gbt_num_compress(), gbt_num_fetch(), gbt_timetz_compress(), gbt_tstz_compress(), gbt_uuid_compress(), gbt_var_compress(), gbt_var_decompress(), gbt_var_fetch(), ghstore_compress(), gist_circle_compress(), gist_point_compress(), gist_point_fetch(), gist_poly_compress(), gistdentryinit(), gistFetchAtt(), gistFormTuple(), gtrgm_compress(), gtrgm_decompress(), gtsquery_compress(), gtsvector_compress(), gtsvector_decompress(), inet_gist_compress(), inet_gist_fetch(), ltree_compress(), ltree_decompress(), placeOne(), and supportSecondarySplit().

◆ GistFollowRight

#define GistFollowRight ( page ) ( GistPageGetOpaque(page)->flags & F_FOLLOW_RIGHT)

Definition at line 173 of file gist.h.

Referenced by gistdeletepage(), gistdoinsert(), gistFindPath(), gistfixsplit(), gistplacetopage(), gistScanPage(), and gistvacuumpage().

◆ GistMarkFollowRight

#define GistMarkFollowRight ( page ) ( GistPageGetOpaque(page)->flags |= F_FOLLOW_RIGHT)

Definition at line 174 of file gist.h.

Referenced by gist_mask(), gistplacetopage(), and gistRedoPageSplitRecord().

◆ GistMarkPageHasGarbage

#define GistMarkPageHasGarbage ( page ) ( GistPageGetOpaque(page)->flags |= F_HAS_GARBAGE)

Definition at line 170 of file gist.h.

Referenced by gistkillitems().

◆ GistMarkTuplesDeleted

#define GistMarkTuplesDeleted ( page ) ( GistPageGetOpaque(page)->flags |= F_TUPLES_DELETED)

Definition at line 166 of file gist.h.

Referenced by gistRedoDeleteRecord(), gistRedoPageUpdateRecord(), and gistvacuumpage().

◆ GISTMaxIndexKeySize

#define GISTMaxIndexKeySize (GISTMaxIndexTupleSize - MAXALIGN(sizeof(IndexTupleData)))

Definition at line 93 of file gist.h.

◆ GISTMaxIndexTupleSize

#define GISTMaxIndexTupleSize

Value:

MAXALIGN_DOWN((BLCKSZ - SizeOfPageHeaderData - sizeof(GISTPageOpaqueData)) / \

4 - sizeof(ItemIdData))

SizeOfPageHeaderData

#define SizeOfPageHeaderData

Definition: bufpage.h:216

ItemIdData

Definition: itemid.h:25

MAXALIGN_DOWN

#define MAXALIGN_DOWN(LEN)

Definition: c.h:703

GISTPageOpaqueData

Definition: gist.h:68

Definition at line 89 of file gist.h.

◆ GISTNProcs

#define GISTNProcs 10

Definition at line 40 of file gist.h.

Referenced by gisthandler(), and gistvalidate().

◆ GistPageGetNSN

#define GistPageGetNSN ( page ) ( PageXLogRecPtrGet(GistPageGetOpaque(page)->nsn))

Definition at line 177 of file gist.h.

Referenced by gistdoinsert(), gistFindPath(), gistplacetopage(), gistScanPage(), and gistvacuumpage().

◆ GistPageGetOpaque

#define GistPageGetOpaque ( page ) ( (GISTPageOpaque) PageGetSpecialPointer(page) )

Definition at line 158 of file gist.h.

Referenced by gistFindCorrectParent(), gistFindPath(), gistfixsplit(), GISTInitBuffer(), GistPageSetDeleted(), gistplacetopage(), gistRedoPageSplitRecord(), gistScanPage(), and gistvacuumpage().

◆ GistPageHasGarbage

#define GistPageHasGarbage ( page ) ( GistPageGetOpaque(page)->flags & F_HAS_GARBAGE)

Definition at line 169 of file gist.h.

Referenced by gistplacetopage().

◆ GistPageIsDeleted

#define GistPageIsDeleted ( page ) ( GistPageGetOpaque(page)->flags & F_DELETED)

Definition at line 163 of file gist.h.

Referenced by gistdeletepage(), gistdoinsert(), gistFindPath(), GistPageGetDeleteXid(), gistPageRecyclable(), gistScanPage(), gistvacuum_delete_empty_pages(), and gistvacuumpage().

◆ GistPageIsLeaf

#define GistPageIsLeaf ( page ) ( GistPageGetOpaque(page)->flags & F_LEAF)

Definition at line 160 of file gist.h.

Referenced by g_cube_distance(), gist_mask(), gistchoose(), gistdeletepage(), gistdoinsert(), gistFindPath(), gistGetMaxLevel(), gistindex_keytest(), gistkillitems(), gistMemorizeAllDownlinks(), gistplacetopage(), gistprunepage(), gistRedoPageUpdateRecord(), gistScanPage(), gistvacuum_delete_empty_pages(), gistvacuumpage(), and pgstat_gist_page().

◆ GistPageSetNSN

#define GistPageSetNSN	(	page,
		val
	)	( PageXLogRecPtrSet(GistPageGetOpaque(page)->nsn, val))

Definition at line 178 of file gist.h.

Referenced by gist_mask(), gistplacetopage(), gistRedoClearFollowRight(), and gistRedoPageSplitRecord().

◆ GistTuplesDeleted

#define GistTuplesDeleted ( page ) ( GistPageGetOpaque(page)->flags & F_TUPLES_DELETED)

Definition at line 165 of file gist.h.

Typedef Documentation

◆ GIST_SPLITVEC

typedef struct GIST_SPLITVEC GIST_SPLITVEC

◆ GISTDeletedPageContents

typedef struct GISTDeletedPageContents GISTDeletedPageContents

◆ GISTENTRY

typedef struct GISTENTRY GISTENTRY

◆ GistNSN

typedef XLogRecPtr GistNSN

Definition at line 53 of file gist.h.

◆ GISTPageOpaque

typedef GISTPageOpaqueData* GISTPageOpaque

Definition at line 76 of file gist.h.

◆ GISTPageOpaqueData

typedef struct GISTPageOpaqueData GISTPageOpaqueData

◆ PageGistNSN

typedef PageXLogRecPtr PageGistNSN

Definition at line 66 of file gist.h.

Function Documentation

◆ GistPageGetDeleteXid()

static FullTransactionId GistPageGetDeleteXid ( Page page )

inlinestatic

Definition at line 206 of file gist.h.

References Assert, FirstNormalTransactionId, FullTransactionIdFromEpochAndXid(), GistPageIsDeleted, MAXALIGN, offsetof, PageGetContents, and SizeOfPageHeaderData.

Referenced by gistNewBuffer(), and gistPageRecyclable().

 {
     Assert(GistPageIsDeleted(page));
 
     /* Is the deleteXid field present? */
     if (((PageHeader) page)->pd_lower >= MAXALIGN(SizeOfPageHeaderData) +
         offsetof(GISTDeletedPageContents, deleteXid) + sizeof(FullTransactionId))
     {
         return ((GISTDeletedPageContents *) PageGetContents(page))->deleteXid;
     }
     else
         return FullTransactionIdFromEpochAndXid(0, FirstNormalTransactionId);
 }

◆ GistPageSetDeleted()

static void GistPageSetDeleted	(	Page	page,
		FullTransactionId	deletexid
	)

inlinestatic

Definition at line 195 of file gist.h.

References Assert, F_DELETED, GistPageGetOpaque, MAXALIGN, PageGetContents, PageIsEmpty, and SizeOfPageHeaderData.

Referenced by gistdeletepage(), and gistRedoPageDelete().

 {
     Assert(PageIsEmpty(page));
 
     GistPageGetOpaque(page)->flags |= F_DELETED;
     ((PageHeader) page)->pd_lower = MAXALIGN(SizeOfPageHeaderData) + sizeof(GISTDeletedPageContents);
 
     ((GISTDeletedPageContents *) PageGetContents(page))->deleteXid = deletexid;
 }

Data Structures

Macros

Typedefs

Functions

Macro Definition Documentation

◆ F_DELETED

◆ F_FOLLOW_RIGHT

◆ F_HAS_GARBAGE

◆ F_LEAF

◆ F_TUPLES_DELETED

◆ GEVHDRSZ

◆ GIST_COMPRESS_PROC

◆ GIST_CONSISTENT_PROC

◆ GIST_DECOMPRESS_PROC

◆ GIST_DISTANCE_PROC

◆ GIST_EQUAL_PROC

◆ GIST_FETCH_PROC

◆ GIST_LEAF

◆ GIST_OPTIONS_PROC

◆ GIST_PAGE_ID

◆ GIST_PENALTY_PROC

◆ GIST_PICKSPLIT_PROC

◆ GIST_UNION_PROC

◆ GistBuildLSN

◆ GistClearFollowRight

◆ GistClearPageHasGarbage

◆ GistClearTuplesDeleted

◆ gistentryinit

◆ GistFollowRight

◆ GistMarkFollowRight

◆ GistMarkPageHasGarbage

◆ GistMarkTuplesDeleted

◆ GISTMaxIndexKeySize

◆ GISTMaxIndexTupleSize

◆ GISTNProcs

◆ GistPageGetNSN

◆ GistPageGetOpaque

◆ GistPageHasGarbage

◆ GistPageIsDeleted

◆ GistPageIsLeaf

◆ GistPageSetNSN

◆ GistTuplesDeleted

Typedef Documentation

◆ GIST_SPLITVEC

◆ GISTDeletedPageContents

◆ GISTENTRY

◆ GistNSN

◆ GISTPageOpaque

◆ GISTPageOpaqueData

◆ PageGistNSN

Function Documentation

◆ GistPageGetDeleteXid()

◆ GistPageSetDeleted()