gist.h File Reference

#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	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	GISTNProcs   9
#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	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	GistPageSetDeleted(page)   ( GistPageGetOpaque(page)->flags |= F_DELETED)
#define	GistPageSetNonDeleted(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

Macro Definition Documentation

F_DELETED

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

Definition at line 43 of file gist.h.

F_FOLLOW_RIGHT

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

Definition at line 46 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 47 of file gist.h.

F_LEAF

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

Definition at line 42 of file gist.h.

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

F_TUPLES_DELETED

#define F_TUPLES_DELETED

Value:

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

Definition at line 44 of file gist.h.

GEVHDRSZ

#define GEVHDRSZ   (offsetof(GistEntryVector, vector))

Definition at line 164 of file gist.h.

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

GIST_COMPRESS_PROC

#define GIST_COMPRESS_PROC   3

Definition at line 30 of file gist.h.

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

GIST_CONSISTENT_PROC

#define GIST_CONSISTENT_PROC   1

Definition at line 28 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

GIST_DECOMPRESS_PROC

#define GIST_DECOMPRESS_PROC   4

Definition at line 31 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

GIST_DISTANCE_PROC

#define GIST_DISTANCE_PROC   8

Definition at line 35 of file gist.h.

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

GIST_EQUAL_PROC

#define GIST_EQUAL_PROC   7

Definition at line 34 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

GIST_FETCH_PROC

#define GIST_FETCH_PROC   9

Definition at line 36 of file gist.h.

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

GIST_LEAF

#define GIST_LEAF

(

entry

)

(GistPageIsLeaf((entry)->page))

Definition at line 133 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_PAGE_ID

#define GIST_PAGE_ID   0xFF81

Definition at line 74 of file gist.h.

Referenced by GISTInitBuffer().

GIST_PENALTY_PROC

#define GIST_PENALTY_PROC   5

Definition at line 32 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

GIST_PICKSPLIT_PROC

#define GIST_PICKSPLIT_PROC   6

Definition at line 33 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

GIST_UNION_PROC

#define GIST_UNION_PROC   2

Definition at line 29 of file gist.h.

Referenced by gistvalidate(), and initGISTstate().

GistClearFollowRight

#define GistClearFollowRight

(

page

)

( GistPageGetOpaque(page)->flags &= ~F_FOLLOW_RIGHT)

Definition at line 149 of file gist.h.

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

GistClearPageHasGarbage

#define GistClearPageHasGarbage

(

page

)

( GistPageGetOpaque(page)->flags &= ~F_HAS_GARBAGE)

Definition at line 145 of file gist.h.

Referenced by gist_mask(), and gistvacuumpage().

GistClearTuplesDeleted

#define GistClearTuplesDeleted

(

page

)

( GistPageGetOpaque(page)->flags &= ~F_TUPLES_DELETED)

Definition at line 141 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)

Definition at line 169 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 147 of file gist.h.

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

GistMarkFollowRight

#define GistMarkFollowRight

(

page

)

( GistPageGetOpaque(page)->flags |= F_FOLLOW_RIGHT)

Definition at line 148 of file gist.h.

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

GistMarkPageHasGarbage

#define GistMarkPageHasGarbage

(

page

)

( GistPageGetOpaque(page)->flags |= F_HAS_GARBAGE)

Definition at line 144 of file gist.h.

Referenced by gistkillitems().

GistMarkTuplesDeleted

#define GistMarkTuplesDeleted

(

page

)

( GistPageGetOpaque(page)->flags |= F_TUPLES_DELETED)

Definition at line 140 of file gist.h.

Referenced by gistbulkdelete(), and gistRedoPageUpdateRecord().

GISTNProcs

#define GISTNProcs   9

Definition at line 37 of file gist.h.

Referenced by gisthandler(), and gistvalidate().

GistPageGetNSN

#define GistPageGetNSN

(

page

)

( PageXLogRecPtrGet(GistPageGetOpaque(page)->nsn))

Definition at line 151 of file gist.h.

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

GistPageGetOpaque

#define GistPageGetOpaque

(

page

)

( (GISTPageOpaque) PageGetSpecialPointer(page) )

Definition at line 130 of file gist.h.

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

GistPageHasGarbage

#define GistPageHasGarbage

(

page

)

( GistPageGetOpaque(page)->flags & F_HAS_GARBAGE)

Definition at line 143 of file gist.h.

Referenced by gistplacetopage().

GistPageIsDeleted

#define GistPageIsDeleted

(

page

)

( GistPageGetOpaque(page)->flags & F_DELETED)

Definition at line 135 of file gist.h.

Referenced by gistNewBuffer(), and gistvacuumcleanup().

GistPageIsLeaf

#define GistPageIsLeaf

(

page

)

( GistPageGetOpaque(page)->flags & F_LEAF)

Definition at line 132 of file gist.h.

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

GistPageSetDeleted

#define GistPageSetDeleted

(

page

)

( GistPageGetOpaque(page)->flags |= F_DELETED)

Definition at line 136 of file gist.h.

GistPageSetNonDeleted

#define GistPageSetNonDeleted

(

page

)

( GistPageGetOpaque(page)->flags &= ~F_DELETED)

Definition at line 137 of file gist.h.

GistPageSetNSN

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

Definition at line 152 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 139 of file gist.h.

Typedef Documentation

GIST_SPLITVEC

typedef struct GIST_SPLITVEC GIST_SPLITVEC

GISTENTRY

typedef struct GISTENTRY GISTENTRY

GistNSN

typedef XLogRecPtr GistNSN

Definition at line 50 of file gist.h.

GISTPageOpaque

typedef GISTPageOpaqueData* GISTPageOpaque

Definition at line 66 of file gist.h.

GISTPageOpaqueData

typedef struct GISTPageOpaqueData GISTPageOpaqueData

PageGistNSN

typedef PageXLogRecPtr PageGistNSN

Definition at line 56 of file gist.h.