PostgreSQL Source Code  git master
spgist_private.h File Reference
#include "access/itup.h"
#include "access/spgist.h"
#include "nodes/tidbitmap.h"
#include "storage/buf.h"
#include "utils/geo_decls.h"
#include "utils/relcache.h"
Include dependency graph for spgist_private.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SpGistPageOpaqueData
 
struct  SpGistLastUsedPage
 
struct  SpGistLUPCache
 
struct  SpGistMetaPageData
 
struct  SpGistTypeDesc
 
struct  SpGistState
 
struct  SpGistSearchItem
 
struct  SpGistScanOpaqueData
 
struct  SpGistCache
 
struct  SpGistInnerTupleData
 
struct  SpGistLeafTupleData
 
struct  SpGistDeadTupleData
 

Macros

#define SPGIST_METAPAGE_BLKNO   (0) /* metapage */
 
#define SPGIST_ROOT_BLKNO   (1) /* root for normal entries */
 
#define SPGIST_NULL_BLKNO   (2) /* root for null-value entries */
 
#define SPGIST_LAST_FIXED_BLKNO   SPGIST_NULL_BLKNO
 
#define SpGistBlockIsRoot(blkno)   ((blkno) == SPGIST_ROOT_BLKNO || (blkno) == SPGIST_NULL_BLKNO)
 
#define SpGistBlockIsFixed(blkno)   ((BlockNumber) (blkno) <= (BlockNumber) SPGIST_LAST_FIXED_BLKNO)
 
#define SPGIST_META   (1<<0)
 
#define SPGIST_DELETED
 
#define SPGIST_LEAF   (1<<2)
 
#define SPGIST_NULLS   (1<<3)
 
#define SpGistPageGetOpaque(page)   ((SpGistPageOpaque) PageGetSpecialPointer(page))
 
#define SpGistPageIsMeta(page)   (SpGistPageGetOpaque(page)->flags & SPGIST_META)
 
#define SpGistPageIsDeleted(page)   (SpGistPageGetOpaque(page)->flags & SPGIST_DELETED)
 
#define SpGistPageIsLeaf(page)   (SpGistPageGetOpaque(page)->flags & SPGIST_LEAF)
 
#define SpGistPageStoresNulls(page)   (SpGistPageGetOpaque(page)->flags & SPGIST_NULLS)
 
#define SPGIST_PAGE_ID   0xFF82
 
#define SPGIST_CACHED_PAGES   8
 
#define SPGIST_MAGIC_NUMBER   (0xBA0BABEE)
 
#define SpGistPageGetMeta(p)   ((SpGistMetaPageData *) PageGetContents(p))
 
#define SizeOfSpGistSearchItem(n_distances)   (offsetof(SpGistSearchItem, distances) + sizeof(double) * (n_distances))
 
#define SPGIST_LIVE   0 /* normal live tuple (either inner or leaf) */
 
#define SPGIST_REDIRECT   1 /* temporary redirection placeholder */
 
#define SPGIST_DEAD   2 /* dead, cannot be removed because of links */
 
#define SPGIST_PLACEHOLDER   3 /* placeholder, used to preserve offsets */
 
#define SGITMAXNNODES   0x1FFF
 
#define SGITMAXPREFIXSIZE   0xFFFF
 
#define SGITMAXSIZE   0xFFFF
 
#define SGITHDRSZ   MAXALIGN(sizeof(SpGistInnerTupleData))
 
#define _SGITDATA(x)   (((char *) (x)) + SGITHDRSZ)
 
#define SGITDATAPTR(x)   ((x)->prefixSize ? _SGITDATA(x) : NULL)
 
#define SGITDATUM(x, s)
 
#define SGITNODEPTR(x)   ((SpGistNodeTuple) (_SGITDATA(x) + (x)->prefixSize))
 
#define SGITITERATE(x, i, nt)
 
#define SGNTHDRSZ   MAXALIGN(sizeof(SpGistNodeTupleData))
 
#define SGNTDATAPTR(x)   (((char *) (x)) + SGNTHDRSZ)
 
#define SGNTDATUM(x, s)
 
#define SGLTHDRSZ   MAXALIGN(sizeof(SpGistLeafTupleData))
 
#define SGLTDATAPTR(x)   (((char *) (x)) + SGLTHDRSZ)
 
#define SGLTDATUM(x, s)
 
#define SGDTSIZE   MAXALIGN(sizeof(SpGistDeadTupleData))
 
#define SPGIST_PAGE_CAPACITY
 
#define SpGistPageGetFreeSpace(p, n)
 
#define STORE_STATE(s, d)
 
#define GBUF_LEAF   0x03
 
#define GBUF_INNER_PARITY(x)   ((x) % 3)
 
#define GBUF_NULLS   0x04
 
#define GBUF_PARITY_MASK   0x03
 
#define GBUF_REQ_LEAF(flags)   (((flags) & GBUF_PARITY_MASK) == GBUF_LEAF)
 
#define GBUF_REQ_NULLS(flags)   ((flags) & GBUF_NULLS)
 

Typedefs

typedef struct SpGistPageOpaqueData SpGistPageOpaqueData
 
typedef SpGistPageOpaqueDataSpGistPageOpaque
 
typedef struct SpGistLastUsedPage SpGistLastUsedPage
 
typedef struct SpGistLUPCache SpGistLUPCache
 
typedef struct SpGistMetaPageData SpGistMetaPageData
 
typedef struct SpGistTypeDesc SpGistTypeDesc
 
typedef struct SpGistState SpGistState
 
typedef struct SpGistSearchItem SpGistSearchItem
 
typedef struct SpGistScanOpaqueData SpGistScanOpaqueData
 
typedef SpGistScanOpaqueDataSpGistScanOpaque
 
typedef struct SpGistCache SpGistCache
 
typedef struct SpGistInnerTupleData SpGistInnerTupleData
 
typedef SpGistInnerTupleDataSpGistInnerTuple
 
typedef IndexTupleData SpGistNodeTupleData
 
typedef SpGistNodeTupleDataSpGistNodeTuple
 
typedef struct SpGistLeafTupleData SpGistLeafTupleData
 
typedef SpGistLeafTupleDataSpGistLeafTuple
 
typedef struct SpGistDeadTupleData SpGistDeadTupleData
 
typedef SpGistDeadTupleDataSpGistDeadTuple
 

Functions

SpGistCachespgGetCache (Relation index)
 
void initSpGistState (SpGistState *state, Relation index)
 
Buffer SpGistNewBuffer (Relation index)
 
void SpGistUpdateMetaPage (Relation index)
 
Buffer SpGistGetBuffer (Relation index, int flags, int needSpace, bool *isNew)
 
void SpGistSetLastUsedPage (Relation index, Buffer buffer)
 
void SpGistInitPage (Page page, uint16 f)
 
void SpGistInitBuffer (Buffer b, uint16 f)
 
void SpGistInitMetapage (Page page)
 
unsigned int SpGistGetTypeSize (SpGistTypeDesc *att, Datum datum)
 
SpGistLeafTuple spgFormLeafTuple (SpGistState *state, ItemPointer heapPtr, Datum datum, bool isnull)
 
SpGistNodeTuple spgFormNodeTuple (SpGistState *state, Datum label, bool isnull)
 
SpGistInnerTuple spgFormInnerTuple (SpGistState *state, bool hasPrefix, Datum prefix, int nNodes, SpGistNodeTuple *nodes)
 
SpGistDeadTuple spgFormDeadTuple (SpGistState *state, int tupstate, BlockNumber blkno, OffsetNumber offnum)
 
DatumspgExtractNodeLabels (SpGistState *state, SpGistInnerTuple innerTuple)
 
OffsetNumber SpGistPageAddNewItem (SpGistState *state, Page page, Item item, Size size, OffsetNumber *startOffset, bool errorOK)
 
bool spgproperty (Oid index_oid, int attno, IndexAMProperty prop, const char *propname, bool *res, bool *isnull)
 
void spgUpdateNodeLink (SpGistInnerTuple tup, int nodeN, BlockNumber blkno, OffsetNumber offset)
 
void spgPageIndexMultiDelete (SpGistState *state, Page page, OffsetNumber *itemnos, int nitems, int firststate, int reststate, BlockNumber blkno, OffsetNumber offnum)
 
bool spgdoinsert (Relation index, SpGistState *state, ItemPointer heapPtr, Datum datum, bool isnull)
 
double * spg_key_orderbys_distances (Datum key, bool isLeaf, ScanKey orderbys, int norderbys)
 
BOXbox_copy (BOX *orig)
 

Macro Definition Documentation

◆ _SGITDATA

#define _SGITDATA (   x)    (((char *) (x)) + SGITHDRSZ)

Definition at line 266 of file spgist_private.h.

◆ GBUF_INNER_PARITY

#define GBUF_INNER_PARITY (   x)    ((x) % 3)

◆ GBUF_LEAF

#define GBUF_LEAF   0x03

Definition at line 411 of file spgist_private.h.

Referenced by doPickSplit(), moveLeafs(), spgdoinsert(), and SpGistSetLastUsedPage().

◆ GBUF_NULLS

#define GBUF_NULLS   0x04

◆ GBUF_PARITY_MASK

#define GBUF_PARITY_MASK   0x03

Definition at line 415 of file spgist_private.h.

Referenced by allocNewBuffer().

◆ GBUF_REQ_LEAF

#define GBUF_REQ_LEAF (   flags)    (((flags) & GBUF_PARITY_MASK) == GBUF_LEAF)

Definition at line 416 of file spgist_private.h.

Referenced by allocNewBuffer(), and SpGistGetBuffer().

◆ GBUF_REQ_NULLS

#define GBUF_REQ_NULLS (   flags)    ((flags) & GBUF_NULLS)

Definition at line 417 of file spgist_private.h.

Referenced by allocNewBuffer(), and SpGistGetBuffer().

◆ SGDTSIZE

◆ SGITDATAPTR

#define SGITDATAPTR (   x)    ((x)->prefixSize ? _SGITDATA(x) : NULL)

Definition at line 267 of file spgist_private.h.

Referenced by spgFormInnerTuple().

◆ SGITDATUM

#define SGITDATUM (   x,
 
)
Value:
((x)->prefixSize ? \
((s)->attPrefixType.attbyval ? \
*(Datum *) _SGITDATA(x) : \
PointerGetDatum(_SGITDATA(x))) \
: (Datum) 0)
#define _SGITDATA(x)
uintptr_t Datum
Definition: postgres.h:367

Definition at line 268 of file spgist_private.h.

Referenced by addNode(), spgdoinsert(), and spgInitInnerConsistentIn().

◆ SGITHDRSZ

#define SGITHDRSZ   MAXALIGN(sizeof(SpGistInnerTupleData))

Definition at line 265 of file spgist_private.h.

Referenced by spgFormInnerTuple().

◆ SGITITERATE

#define SGITITERATE (   x,
  i,
  nt 
)
Value:
for ((i) = 0, (nt) = SGITNODEPTR(x); \
(i) < (x)->nNodes; \
(i)++, (nt) = (SpGistNodeTuple) (((char *) (nt)) + IndexTupleSize(nt)))
#define SGITNODEPTR(x)
int i
#define IndexTupleSize(itup)
Definition: itup.h:71
SpGistNodeTupleData * SpGistNodeTuple

Definition at line 276 of file spgist_private.h.

Referenced by addNode(), doPickSplit(), spgExtractNodeLabels(), spgInnerTest(), spgMatchNodeAction(), spgprocesspending(), spgSplitNodeAction(), and spgUpdateNodeLink().

◆ SGITMAXNNODES

#define SGITMAXNNODES   0x1FFF

Definition at line 261 of file spgist_private.h.

Referenced by spgFormInnerTuple(), and spgSplitNodeAction().

◆ SGITMAXPREFIXSIZE

#define SGITMAXPREFIXSIZE   0xFFFF

Definition at line 262 of file spgist_private.h.

Referenced by spgFormInnerTuple().

◆ SGITMAXSIZE

#define SGITMAXSIZE   0xFFFF

Definition at line 263 of file spgist_private.h.

Referenced by spgFormInnerTuple().

◆ SGITNODEPTR

#define SGITNODEPTR (   x)    ((SpGistNodeTuple) (_SGITDATA(x) + (x)->prefixSize))

Definition at line 273 of file spgist_private.h.

Referenced by spgExtractNodeLabels(), and spgFormInnerTuple().

◆ SGLTDATAPTR

#define SGLTDATAPTR (   x)    (((char *) (x)) + SGLTHDRSZ)

Definition at line 339 of file spgist_private.h.

Referenced by spgFormLeafTuple().

◆ SGLTDATUM

#define SGLTDATUM (   x,
 
)
Value:
((s)->attLeafType.attbyval ? \
*(Datum *) SGLTDATAPTR(x) : \
#define PointerGetDatum(X)
Definition: postgres.h:556
#define SGLTDATAPTR(x)
uintptr_t Datum
Definition: postgres.h:367

Definition at line 340 of file spgist_private.h.

Referenced by doPickSplit(), and spgLeafTest().

◆ SGLTHDRSZ

#define SGLTHDRSZ   MAXALIGN(sizeof(SpGistLeafTupleData))

Definition at line 338 of file spgist_private.h.

Referenced by spgdoinsert(), and spgFormLeafTuple().

◆ SGNTDATAPTR

#define SGNTDATAPTR (   x)    (((char *) (x)) + SGNTHDRSZ)

Definition at line 296 of file spgist_private.h.

Referenced by spgFormNodeTuple().

◆ SGNTDATUM

#define SGNTDATUM (   x,
 
)
Value:
((s)->attLabelType.attbyval ? \
*(Datum *) SGNTDATAPTR(x) : \
#define PointerGetDatum(X)
Definition: postgres.h:556
uintptr_t Datum
Definition: postgres.h:367
#define SGNTDATAPTR(x)

Definition at line 297 of file spgist_private.h.

Referenced by spgExtractNodeLabels().

◆ SGNTHDRSZ

#define SGNTHDRSZ   MAXALIGN(sizeof(SpGistNodeTupleData))

Definition at line 295 of file spgist_private.h.

Referenced by spgFormNodeTuple().

◆ SizeOfSpGistSearchItem

#define SizeOfSpGistSearchItem (   n_distances)    (offsetof(SpGistSearchItem, distances) + sizeof(double) * (n_distances))

Definition at line 151 of file spgist_private.h.

Referenced by spgAllocSearchItem().

◆ SPGIST_CACHED_PAGES

#define SPGIST_CACHED_PAGES   8

Definition at line 85 of file spgist_private.h.

Referenced by SpGistInitMetapage().

◆ SPGIST_DEAD

#define SPGIST_DEAD   2 /* dead, cannot be removed because of links */

◆ SPGIST_DELETED

#define SPGIST_DELETED
Value:
(1<<1) /* never set, but keep for backwards
* compatibility */

Definition at line 52 of file spgist_private.h.

◆ SPGIST_LAST_FIXED_BLKNO

#define SPGIST_LAST_FIXED_BLKNO   SPGIST_NULL_BLKNO

Definition at line 29 of file spgist_private.h.

Referenced by spgvacuumscan().

◆ SPGIST_LEAF

#define SPGIST_LEAF   (1<<2)

◆ SPGIST_LIVE

#define SPGIST_LIVE   0 /* normal live tuple (either inner or leaf) */

◆ SPGIST_MAGIC_NUMBER

#define SPGIST_MAGIC_NUMBER   (0xBA0BABEE)

Definition at line 101 of file spgist_private.h.

Referenced by spgGetCache(), and SpGistInitMetapage().

◆ SPGIST_META

#define SPGIST_META   (1<<0)

Definition at line 51 of file spgist_private.h.

Referenced by SpGistInitMetapage().

◆ SPGIST_METAPAGE_BLKNO

#define SPGIST_METAPAGE_BLKNO   (0) /* metapage */

◆ SPGIST_NULL_BLKNO

#define SPGIST_NULL_BLKNO   (2) /* root for null-value entries */

Definition at line 28 of file spgist_private.h.

Referenced by spgAddStartItem(), spgbuild(), spgbuildempty(), and spgdoinsert().

◆ SPGIST_NULLS

#define SPGIST_NULLS   (1<<3)

◆ SPGIST_PAGE_CAPACITY

#define SPGIST_PAGE_CAPACITY
Value:
MAXALIGN_DOWN(BLCKSZ - \
#define SizeOfPageHeaderData
Definition: bufpage.h:216
#define MAXALIGN(LEN)
Definition: c.h:685
#define MAXALIGN_DOWN(LEN)
Definition: c.h:697

Definition at line 376 of file spgist_private.h.

Referenced by doPickSplit(), spgdoinsert(), spgFormInnerTuple(), and SpGistGetBuffer().

◆ SPGIST_PAGE_ID

#define SPGIST_PAGE_ID   0xFF82

Definition at line 71 of file spgist_private.h.

Referenced by SpGistInitPage().

◆ SPGIST_PLACEHOLDER

◆ SPGIST_REDIRECT

◆ SPGIST_ROOT_BLKNO

#define SPGIST_ROOT_BLKNO   (1) /* root for normal entries */

Definition at line 27 of file spgist_private.h.

Referenced by spgAddStartItem(), spgbuild(), spgbuildempty(), and spgdoinsert().

◆ SpGistBlockIsFixed

#define SpGistBlockIsFixed (   blkno)    ((BlockNumber) (blkno) <= (BlockNumber) SPGIST_LAST_FIXED_BLKNO)

Definition at line 33 of file spgist_private.h.

Referenced by SpGistGetBuffer(), SpGistNewBuffer(), and SpGistSetLastUsedPage().

◆ SpGistBlockIsRoot

#define SpGistBlockIsRoot (   blkno)    ((blkno) == SPGIST_ROOT_BLKNO || (blkno) == SPGIST_NULL_BLKNO)

◆ SpGistPageGetFreeSpace

#define SpGistPageGetFreeSpace (   p,
 
)
Value:
Min(SpGistPageGetOpaque(p)->nPlaceholder, n) * \
(SGDTSIZE + sizeof(ItemIdData)))
#define SGDTSIZE
struct ItemIdData ItemIdData
Size PageGetExactFreeSpace(Page page)
Definition: bufpage.c:632
#define SpGistPageGetOpaque(page)

Definition at line 385 of file spgist_private.h.

Referenced by doPickSplit(), spgdoinsert(), and spgSplitNodeAction().

◆ SpGistPageGetMeta

#define SpGistPageGetMeta (   p)    ((SpGistMetaPageData *) PageGetContents(p))

Definition at line 103 of file spgist_private.h.

Referenced by spgGetCache(), SpGistInitMetapage(), and SpGistUpdateMetaPage().

◆ SpGistPageGetOpaque

◆ SpGistPageIsDeleted

#define SpGistPageIsDeleted (   page)    (SpGistPageGetOpaque(page)->flags & SPGIST_DELETED)

Definition at line 59 of file spgist_private.h.

Referenced by SpGistGetBuffer(), SpGistNewBuffer(), and spgprocesspending().

◆ SpGistPageIsLeaf

#define SpGistPageIsLeaf (   page)    (SpGistPageGetOpaque(page)->flags & SPGIST_LEAF)

◆ SpGistPageIsMeta

#define SpGistPageIsMeta (   page)    (SpGistPageGetOpaque(page)->flags & SPGIST_META)

Definition at line 58 of file spgist_private.h.

◆ SpGistPageStoresNulls

#define SpGistPageStoresNulls (   page)    (SpGistPageGetOpaque(page)->flags & SPGIST_NULLS)

◆ STORE_STATE

#define STORE_STATE (   s,
 
)
Value:
do { \
(d).myXid = (s)->myXid; \
(d).isBuild = (s)->isBuild; \
} while(0)

Definition at line 394 of file spgist_private.h.

Referenced by doPickSplit(), moveLeafs(), spgAddNodeAction(), vacuumLeafPage(), and vacuumLeafRoot().

Typedef Documentation

◆ SpGistCache

◆ SpGistDeadTuple

◆ SpGistDeadTupleData

◆ SpGistInnerTuple

◆ SpGistInnerTupleData

◆ SpGistLastUsedPage

◆ SpGistLeafTuple

◆ SpGistLeafTupleData

◆ SpGistLUPCache

◆ SpGistMetaPageData

◆ SpGistNodeTuple

◆ SpGistNodeTupleData

◆ SpGistPageOpaque

◆ SpGistPageOpaqueData

◆ SpGistScanOpaque

◆ SpGistScanOpaqueData

◆ SpGistSearchItem

◆ SpGistState

◆ SpGistTypeDesc

Function Documentation

◆ box_copy()

BOX* box_copy ( BOX orig)

Definition at line 82 of file spgproc.c.

References palloc().

Referenced by spg_kd_inner_consistent(), and spg_quad_inner_consistent().

83 {
84  BOX *result = palloc(sizeof(BOX));
85 
86  *result = *orig;
87  return result;
88 }
Definition: geo_decls.h:99
void * palloc(Size size)
Definition: mcxt.c:924

◆ initSpGistState()

void initSpGistState ( SpGistState state,
Relation  index 
)

Definition at line 181 of file spgutils.c.

References SpGistState::attLabelType, SpGistCache::attLabelType, SpGistState::attLeafType, SpGistCache::attLeafType, SpGistState::attPrefixType, SpGistCache::attPrefixType, SpGistState::attType, SpGistCache::attType, SpGistState::config, SpGistCache::config, SpGistState::deadTupleStorage, GetTopTransactionIdIfAny(), SpGistState::isBuild, SpGistState::myXid, palloc0(), SGDTSIZE, and spgGetCache().

Referenced by spgbeginscan(), spgbuild(), spginsert(), and spgvacuumscan().

182 {
183  SpGistCache *cache;
184 
185  /* Get cached static information about index */
186  cache = spgGetCache(index);
187 
188  state->config = cache->config;
189  state->attType = cache->attType;
190  state->attLeafType = cache->attLeafType;
191  state->attPrefixType = cache->attPrefixType;
192  state->attLabelType = cache->attLabelType;
193 
194  /* Make workspace for constructing dead tuples */
196 
197  /* Set XID to use in redirection tuples */
198  state->myXid = GetTopTransactionIdIfAny();
199 
200  /* Assume we're not in an index build (spgbuild will override) */
201  state->isBuild = false;
202 }
SpGistTypeDesc attLeafType
SpGistTypeDesc attPrefixType
SpGistCache * spgGetCache(Relation index)
Definition: spgutils.c:99
#define SGDTSIZE
SpGistTypeDesc attLeafType
SpGistTypeDesc attType
SpGistTypeDesc attLabelType
SpGistTypeDesc attType
spgConfigOut config
TransactionId myXid
TransactionId GetTopTransactionIdIfAny(void)
Definition: xact.c:410
spgConfigOut config
void * palloc0(Size size)
Definition: mcxt.c:955
char * deadTupleStorage
SpGistTypeDesc attLabelType
SpGistTypeDesc attPrefixType

◆ spg_key_orderbys_distances()

double* spg_key_orderbys_distances ( Datum  key,
bool  isLeaf,
ScanKey  orderbys,
int  norderbys 
)

Definition at line 63 of file spgproc.c.

References DatumGetBoxP, DatumGetPointP, palloc(), point_box_distance(), and point_point_distance.

Referenced by spg_box_quad_leaf_consistent(), spg_kd_inner_consistent(), spg_quad_inner_consistent(), and spg_quad_leaf_consistent().

65 {
66  int sk_num;
67  double *distances = (double *) palloc(norderbys * sizeof(double)),
68  *distance = distances;
69 
70  for (sk_num = 0; sk_num < norderbys; ++sk_num, ++orderbys, ++distance)
71  {
72  Point *point = DatumGetPointP(orderbys->sk_argument);
73 
74  *distance = isLeaf ? point_point_distance(point, DatumGetPointP(key))
76  }
77 
78  return distances;
79 }
#define point_point_distance(p1, p2)
Definition: spgproc.c:25
#define DatumGetPointP(X)
Definition: geo_decls.h:134
#define DatumGetBoxP(X)
Definition: geo_decls.h:156
void * palloc(Size size)
Definition: mcxt.c:924
static double point_box_distance(Point *point, BOX *box)
Definition: spgproc.c:31

◆ spgdoinsert()

bool spgdoinsert ( Relation  index,
SpGistState state,
ItemPointer  heapPtr,
Datum  datum,
bool  isnull 
)

Definition at line 1891 of file spgdoinsert.c.

References addLeafTuple(), spgChooseOut::addNode, spgChooseIn::allTheSame, SpGistInnerTupleData::allTheSame, Assert, SpGistState::attLeafType, SpGistTypeDesc::attlen, SpGistState::attType, SPPageDesc::blkno, SPPageDesc::buffer, BUFFER_LOCK_EXCLUSIVE, BufferGetBlockNumber(), BufferGetPage, CHECK_FOR_INTERRUPTS, checkSplitConditions(), ConditionalLockBuffer(), SpGistState::config, spgChooseIn::datum, doPickSplit(), elog, ereport, errcode(), errhint(), errmsg(), ERROR, FirstOffsetNumber, FunctionCall1Coll(), FunctionCall2Coll(), GBUF_LEAF, GBUF_NULLS, spgChooseIn::hasPrefix, index_getprocid(), index_getprocinfo(), InvalidBlockNumber, InvalidBuffer, InvalidOffsetNumber, spgChooseIn::leafDatum, spgChooseIn::level, LockBuffer(), spgConfigOut::longValuesOK, spgChooseOut::matchNode, Min, moveLeafs(), spgChooseIn::nNodes, SpGistInnerTupleData::nNodes, SPPageDesc::node, spgChooseIn::nodeLabels, SPPageDesc::offnum, OidIsValid, SPPageDesc::page, PageGetItem, PageGetItemId, pfree(), PG_DETOAST_DATUM, PointerGetDatum, spgChooseIn::prefixDatum, SpGistInnerTupleData::prefixSize, random(), RelationData::rd_indcollation, ReadBuffer(), RelationGetRelationName, ReleaseBuffer(), spgChooseOut::result, spgChooseOut::resultType, SGDTSIZE, SGITDATUM, SGLTHDRSZ, SpGistLeafTupleData::size, spgAddNode, spgAddNodeAction(), spgExtractNodeLabels(), spgFormLeafTuple(), SPGIST_CHOOSE_PROC, SPGIST_COMPRESS_PROC, SPGIST_NULL_BLKNO, SPGIST_PAGE_CAPACITY, SPGIST_ROOT_BLKNO, SpGistGetBuffer(), SpGistGetTypeSize(), SpGistPageGetFreeSpace, SpGistPageIsLeaf, SpGistPageStoresNulls, SpGistSetLastUsedPage(), spgMatchNode, spgMatchNodeAction(), spgSplitNodeAction(), spgSplitTuple, SpGistTypeDesc::type, and UnlockReleaseBuffer().

Referenced by spginsert(), and spgistBuildCallback().

1893 {
1894  int level = 0;
1895  Datum leafDatum;
1896  int leafSize;
1897  SPPageDesc current,
1898  parent;
1899  FmgrInfo *procinfo = NULL;
1900 
1901  /*
1902  * Look up FmgrInfo of the user-defined choose function once, to save
1903  * cycles in the loop below.
1904  */
1905  if (!isnull)
1906  procinfo = index_getprocinfo(index, 1, SPGIST_CHOOSE_PROC);
1907 
1908  /*
1909  * Prepare the leaf datum to insert.
1910  *
1911  * If an optional "compress" method is provided, then call it to form the
1912  * leaf datum from the input datum. Otherwise store the input datum as
1913  * is. Since we don't use index_form_tuple in this AM, we have to make
1914  * sure value to be inserted is not toasted; FormIndexDatum doesn't
1915  * guarantee that. But we assume the "compress" method to return an
1916  * untoasted value.
1917  */
1918  if (!isnull)
1919  {
1921  {
1922  FmgrInfo *compressProcinfo = NULL;
1923 
1924  compressProcinfo = index_getprocinfo(index, 1, SPGIST_COMPRESS_PROC);
1925  leafDatum = FunctionCall1Coll(compressProcinfo,
1926  index->rd_indcollation[0],
1927  datum);
1928  }
1929  else
1930  {
1931  Assert(state->attLeafType.type == state->attType.type);
1932 
1933  if (state->attType.attlen == -1)
1934  leafDatum = PointerGetDatum(PG_DETOAST_DATUM(datum));
1935  else
1936  leafDatum = datum;
1937  }
1938  }
1939  else
1940  leafDatum = (Datum) 0;
1941 
1942  /*
1943  * Compute space needed for a leaf tuple containing the given datum.
1944  *
1945  * If it isn't gonna fit, and the opclass can't reduce the datum size by
1946  * suffixing, bail out now rather than getting into an endless loop.
1947  */
1948  if (!isnull)
1949  leafSize = SGLTHDRSZ + sizeof(ItemIdData) +
1950  SpGistGetTypeSize(&state->attLeafType, leafDatum);
1951  else
1952  leafSize = SGDTSIZE + sizeof(ItemIdData);
1953 
1954  if (leafSize > SPGIST_PAGE_CAPACITY && !state->config.longValuesOK)
1955  ereport(ERROR,
1956  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
1957  errmsg("index row size %zu exceeds maximum %zu for index \"%s\"",
1958  leafSize - sizeof(ItemIdData),
1959  SPGIST_PAGE_CAPACITY - sizeof(ItemIdData),
1960  RelationGetRelationName(index)),
1961  errhint("Values larger than a buffer page cannot be indexed.")));
1962 
1963  /* Initialize "current" to the appropriate root page */
1964  current.blkno = isnull ? SPGIST_NULL_BLKNO : SPGIST_ROOT_BLKNO;
1965  current.buffer = InvalidBuffer;
1966  current.page = NULL;
1967  current.offnum = FirstOffsetNumber;
1968  current.node = -1;
1969 
1970  /* "parent" is invalid for the moment */
1971  parent.blkno = InvalidBlockNumber;
1972  parent.buffer = InvalidBuffer;
1973  parent.page = NULL;
1974  parent.offnum = InvalidOffsetNumber;
1975  parent.node = -1;
1976 
1977  for (;;)
1978  {
1979  bool isNew = false;
1980 
1981  /*
1982  * Bail out if query cancel is pending. We must have this somewhere
1983  * in the loop since a broken opclass could produce an infinite
1984  * picksplit loop.
1985  */
1987 
1988  if (current.blkno == InvalidBlockNumber)
1989  {
1990  /*
1991  * Create a leaf page. If leafSize is too large to fit on a page,
1992  * we won't actually use the page yet, but it simplifies the API
1993  * for doPickSplit to always have a leaf page at hand; so just
1994  * quietly limit our request to a page size.
1995  */
1996  current.buffer =
1997  SpGistGetBuffer(index,
1998  GBUF_LEAF | (isnull ? GBUF_NULLS : 0),
1999  Min(leafSize, SPGIST_PAGE_CAPACITY),
2000  &isNew);
2001  current.blkno = BufferGetBlockNumber(current.buffer);
2002  }
2003  else if (parent.buffer == InvalidBuffer)
2004  {
2005  /* we hold no parent-page lock, so no deadlock is possible */
2006  current.buffer = ReadBuffer(index, current.blkno);
2008  }
2009  else if (current.blkno != parent.blkno)
2010  {
2011  /* descend to a new child page */
2012  current.buffer = ReadBuffer(index, current.blkno);
2013 
2014  /*
2015  * Attempt to acquire lock on child page. We must beware of
2016  * deadlock against another insertion process descending from that
2017  * page to our parent page (see README). If we fail to get lock,
2018  * abandon the insertion and tell our caller to start over.
2019  *
2020  * XXX this could be improved, because failing to get lock on a
2021  * buffer is not proof of a deadlock situation; the lock might be
2022  * held by a reader, or even just background writer/checkpointer
2023  * process. Perhaps it'd be worth retrying after sleeping a bit?
2024  */
2025  if (!ConditionalLockBuffer(current.buffer))
2026  {
2027  ReleaseBuffer(current.buffer);
2028  UnlockReleaseBuffer(parent.buffer);
2029  return false;
2030  }
2031  }
2032  else
2033  {
2034  /* inner tuple can be stored on the same page as parent one */
2035  current.buffer = parent.buffer;
2036  }
2037  current.page = BufferGetPage(current.buffer);
2038 
2039  /* should not arrive at a page of the wrong type */
2040  if (isnull ? !SpGistPageStoresNulls(current.page) :
2041  SpGistPageStoresNulls(current.page))
2042  elog(ERROR, "SPGiST index page %u has wrong nulls flag",
2043  current.blkno);
2044 
2045  if (SpGistPageIsLeaf(current.page))
2046  {
2047  SpGistLeafTuple leafTuple;
2048  int nToSplit,
2049  sizeToSplit;
2050 
2051  leafTuple = spgFormLeafTuple(state, heapPtr, leafDatum, isnull);
2052  if (leafTuple->size + sizeof(ItemIdData) <=
2053  SpGistPageGetFreeSpace(current.page, 1))
2054  {
2055  /* it fits on page, so insert it and we're done */
2056  addLeafTuple(index, state, leafTuple,
2057  &current, &parent, isnull, isNew);
2058  break;
2059  }
2060  else if ((sizeToSplit =
2061  checkSplitConditions(index, state, &current,
2062  &nToSplit)) < SPGIST_PAGE_CAPACITY / 2 &&
2063  nToSplit < 64 &&
2064  leafTuple->size + sizeof(ItemIdData) + sizeToSplit <= SPGIST_PAGE_CAPACITY)
2065  {
2066  /*
2067  * the amount of data is pretty small, so just move the whole
2068  * chain to another leaf page rather than splitting it.
2069  */
2070  Assert(!isNew);
2071  moveLeafs(index, state, &current, &parent, leafTuple, isnull);
2072  break; /* we're done */
2073  }
2074  else
2075  {
2076  /* picksplit */
2077  if (doPickSplit(index, state, &current, &parent,
2078  leafTuple, level, isnull, isNew))
2079  break; /* doPickSplit installed new tuples */
2080 
2081  /* leaf tuple will not be inserted yet */
2082  pfree(leafTuple);
2083 
2084  /*
2085  * current now describes new inner tuple, go insert into it
2086  */
2087  Assert(!SpGistPageIsLeaf(current.page));
2088  goto process_inner_tuple;
2089  }
2090  }
2091  else /* non-leaf page */
2092  {
2093  /*
2094  * Apply the opclass choose function to figure out how to insert
2095  * the given datum into the current inner tuple.
2096  */
2097  SpGistInnerTuple innerTuple;
2098  spgChooseIn in;
2099  spgChooseOut out;
2100 
2101  /*
2102  * spgAddNode and spgSplitTuple cases will loop back to here to
2103  * complete the insertion operation. Just in case the choose
2104  * function is broken and produces add or split requests
2105  * repeatedly, check for query cancel.
2106  */
2107  process_inner_tuple:
2109 
2110  innerTuple = (SpGistInnerTuple) PageGetItem(current.page,
2111  PageGetItemId(current.page, current.offnum));
2112 
2113  in.datum = datum;
2114  in.leafDatum = leafDatum;
2115  in.level = level;
2116  in.allTheSame = innerTuple->allTheSame;
2117  in.hasPrefix = (innerTuple->prefixSize > 0);
2118  in.prefixDatum = SGITDATUM(innerTuple, state);
2119  in.nNodes = innerTuple->nNodes;
2120  in.nodeLabels = spgExtractNodeLabels(state, innerTuple);
2121 
2122  memset(&out, 0, sizeof(out));
2123 
2124  if (!isnull)
2125  {
2126  /* use user-defined choose method */
2127  FunctionCall2Coll(procinfo,
2128  index->rd_indcollation[0],
2129  PointerGetDatum(&in),
2130  PointerGetDatum(&out));
2131  }
2132  else
2133  {
2134  /* force "match" action (to insert to random subnode) */
2135  out.resultType = spgMatchNode;
2136  }
2137 
2138  if (innerTuple->allTheSame)
2139  {
2140  /*
2141  * It's not allowed to do an AddNode at an allTheSame tuple.
2142  * Opclass must say "match", in which case we choose a random
2143  * one of the nodes to descend into, or "split".
2144  */
2145  if (out.resultType == spgAddNode)
2146  elog(ERROR, "cannot add a node to an allTheSame inner tuple");
2147  else if (out.resultType == spgMatchNode)
2148  out.result.matchNode.nodeN = random() % innerTuple->nNodes;
2149  }
2150 
2151  switch (out.resultType)
2152  {
2153  case spgMatchNode:
2154  /* Descend to N'th child node */
2155  spgMatchNodeAction(index, state, innerTuple,
2156  &current, &parent,
2157  out.result.matchNode.nodeN);
2158  /* Adjust level as per opclass request */
2159  level += out.result.matchNode.levelAdd;
2160  /* Replace leafDatum and recompute leafSize */
2161  if (!isnull)
2162  {
2163  leafDatum = out.result.matchNode.restDatum;
2164  leafSize = SGLTHDRSZ + sizeof(ItemIdData) +
2165  SpGistGetTypeSize(&state->attLeafType, leafDatum);
2166  }
2167 
2168  /*
2169  * Loop around and attempt to insert the new leafDatum at
2170  * "current" (which might reference an existing child
2171  * tuple, or might be invalid to force us to find a new
2172  * page for the tuple).
2173  *
2174  * Note: if the opclass sets longValuesOK, we rely on the
2175  * choose function to eventually shorten the leafDatum
2176  * enough to fit on a page. We could add a test here to
2177  * complain if the datum doesn't get visibly shorter each
2178  * time, but that could get in the way of opclasses that
2179  * "simplify" datums in a way that doesn't necessarily
2180  * lead to physical shortening on every cycle.
2181  */
2182  break;
2183  case spgAddNode:
2184  /* AddNode is not sensible if nodes don't have labels */
2185  if (in.nodeLabels == NULL)
2186  elog(ERROR, "cannot add a node to an inner tuple without node labels");
2187  /* Add node to inner tuple, per request */
2188  spgAddNodeAction(index, state, innerTuple,
2189  &current, &parent,
2190  out.result.addNode.nodeN,
2191  out.result.addNode.nodeLabel);
2192 
2193  /*
2194  * Retry insertion into the enlarged node. We assume that
2195  * we'll get a MatchNode result this time.
2196  */
2197  goto process_inner_tuple;
2198  break;
2199  case spgSplitTuple:
2200  /* Split inner tuple, per request */
2201  spgSplitNodeAction(index, state, innerTuple,
2202  &current, &out);
2203 
2204  /* Retry insertion into the split node */
2205  goto process_inner_tuple;
2206  break;
2207  default:
2208  elog(ERROR, "unrecognized SPGiST choose result: %d",
2209  (int) out.resultType);
2210  break;
2211  }
2212  }
2213  } /* end loop */
2214 
2215  /*
2216  * Release any buffers we're still holding. Beware of possibility that
2217  * current and parent reference same buffer.
2218  */
2219  if (current.buffer != InvalidBuffer)
2220  {
2221  SpGistSetLastUsedPage(index, current.buffer);
2222  UnlockReleaseBuffer(current.buffer);
2223  }
2224  if (parent.buffer != InvalidBuffer &&
2225  parent.buffer != current.buffer)
2226  {
2227  SpGistSetLastUsedPage(index, parent.buffer);
2228  UnlockReleaseBuffer(parent.buffer);
2229  }
2230 
2231  return true;
2232 }
Definition: fmgr.h:56
Datum * spgExtractNodeLabels(SpGistState *state, SpGistInnerTuple innerTuple)
Definition: spgutils.c:828
Datum datum
Definition: spgist.h:58
SpGistInnerTupleData * SpGistInnerTuple
#define SpGistPageIsLeaf(page)
bool hasPrefix
Definition: spgist.h:64
int errhint(const char *fmt,...)
Definition: elog.c:974
#define SpGistPageGetFreeSpace(p, n)
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:794
#define SGDTSIZE
int level
Definition: spgist.h:60
struct spgChooseOut::@48::@49 matchNode
#define PointerGetDatum(X)
Definition: postgres.h:556
long random(void)
Definition: random.c:22
SpGistTypeDesc attLeafType
#define Min(x, y)
Definition: c.h:904
SpGistTypeDesc attType
void SpGistSetLastUsedPage(Relation index, Buffer buffer)
Definition: spgutils.c:500
#define InvalidBuffer
Definition: buf.h:25
Datum prefixDatum
Definition: spgist.h:65
int errcode(int sqlerrcode)
Definition: elog.c:570
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3353
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:88
Datum FunctionCall2Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2)
Definition: fmgr.c:1150
#define SPGIST_ROOT_BLKNO
#define OidIsValid(objectId)
Definition: c.h:638
#define SGITDATUM(x, s)
static void addLeafTuple(Relation index, SpGistState *state, SpGistLeafTuple leafTuple, SPPageDesc *current, SPPageDesc *parent, bool isNulls, bool isNew)
Definition: spgdoinsert.c:203
spgConfigOut config
void pfree(void *pointer)
Definition: mcxt.c:1031
unsigned int allTheSame
static bool doPickSplit(Relation index, SpGistState *state, SPPageDesc *current, SPPageDesc *parent, SpGistLeafTuple newLeafTuple, int level, bool isNulls, bool isNew)
Definition: spgdoinsert.c:675
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3376
Oid * rd_indcollation
Definition: rel.h:168
#define ERROR
Definition: elog.h:43
unsigned int prefixSize
#define SPGIST_NULL_BLKNO
#define FirstOffsetNumber
Definition: off.h:27
OffsetNumber offnum
Definition: spgdoinsert.c:39
static void spgSplitNodeAction(Relation index, SpGistState *state, SpGistInnerTuple innerTuple, SPPageDesc *current, spgChooseOut *out)
Definition: spgdoinsert.c:1692
#define RelationGetRelationName(relation)
Definition: rel.h:450
struct ItemIdData ItemIdData
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define ereport(elevel, rest)
Definition: elog.h:141
bool ConditionalLockBuffer(Buffer buffer)
Definition: bufmgr.c:3616
int nNodes
Definition: spgist.h:66
#define SGLTHDRSZ
#define GBUF_LEAF
unsigned int SpGistGetTypeSize(SpGistTypeDesc *att, Datum datum)
Definition: spgutils.c:599
#define PageGetItemId(page, offsetNumber)
Definition: bufpage.h:235
SpGistLeafTuple spgFormLeafTuple(SpGistState *state, ItemPointer heapPtr, Datum datum, bool isnull)
Definition: spgutils.c:636
bool longValuesOK
Definition: spgist.h:50
uintptr_t Datum
Definition: postgres.h:367
Datum FunctionCall1Coll(FmgrInfo *flinfo, Oid collation, Datum arg1)
Definition: fmgr.c:1130
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3590
#define SPGIST_PAGE_CAPACITY
spgChooseResultType resultType
Definition: spgist.h:79
#define InvalidOffsetNumber
Definition: off.h:26
#define SpGistPageStoresNulls(page)
static void spgMatchNodeAction(Relation index, SpGistState *state, SpGistInnerTuple innerTuple, SPPageDesc *current, SPPageDesc *parent, int nodeN)
Definition: spgdoinsert.c:1436
#define Assert(condition)
Definition: c.h:732
Datum leafDatum
Definition: spgist.h:59
struct spgChooseOut::@48::@50 addNode
Buffer SpGistGetBuffer(Relation index, int flags, int needSpace, bool *isNew)
Definition: spgutils.c:395
#define SPGIST_COMPRESS_PROC
Definition: spgist.h:32
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define InvalidBlockNumber
Definition: block.h:33
#define GBUF_NULLS
union spgChooseOut::@48 result
static void spgAddNodeAction(Relation index, SpGistState *state, SpGistInnerTuple innerTuple, SPPageDesc *current, SPPageDesc *parent, int nodeN, Datum nodeLabel)
Definition: spgdoinsert.c:1490
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2613
Datum * nodeLabels
Definition: spgist.h:67
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
bool allTheSame
Definition: spgist.h:63
static int checkSplitConditions(Relation index, SpGistState *state, SPPageDesc *current, int *nToSplit)
Definition: spgdoinsert.c:333
Buffer buffer
Definition: spgdoinsert.c:37
#define PG_DETOAST_DATUM(datum)
Definition: fmgr.h:235
#define CHECK_FOR_INTERRUPTS()
Definition: miscadmin.h:99
#define SPGIST_CHOOSE_PROC
Definition: spgist.h:28
static void moveLeafs(Relation index, SpGistState *state, SPPageDesc *current, SPPageDesc *parent, SpGistLeafTuple newLeafTuple, bool isNulls)
Definition: spgdoinsert.c:387
#define PageGetItem(page, itemId)
Definition: bufpage.h:340
BlockNumber blkno
Definition: spgdoinsert.c:36
RegProcedure index_getprocid(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:760

◆ spgExtractNodeLabels()

Datum* spgExtractNodeLabels ( SpGistState state,
SpGistInnerTuple  innerTuple 
)

Definition at line 828 of file spgutils.c.

References elog, ERROR, i, IndexTupleHasNulls, SpGistInnerTupleData::nNodes, palloc(), SGITITERATE, SGITNODEPTR, and SGNTDATUM.

Referenced by spgdoinsert(), and spgInitInnerConsistentIn().

829 {
830  Datum *nodeLabels;
831  int i;
832  SpGistNodeTuple node;
833 
834  /* Either all the labels must be NULL, or none. */
835  node = SGITNODEPTR(innerTuple);
836  if (IndexTupleHasNulls(node))
837  {
838  SGITITERATE(innerTuple, i, node)
839  {
840  if (!IndexTupleHasNulls(node))
841  elog(ERROR, "some but not all node labels are null in SPGiST inner tuple");
842  }
843  /* They're all null, so just return NULL */
844  return NULL;
845  }
846  else
847  {
848  nodeLabels = (Datum *) palloc(sizeof(Datum) * innerTuple->nNodes);
849  SGITITERATE(innerTuple, i, node)
850  {
851  if (IndexTupleHasNulls(node))
852  elog(ERROR, "some but not all node labels are null in SPGiST inner tuple");
853  nodeLabels[i] = SGNTDATUM(node, state);
854  }
855  return nodeLabels;
856  }
857 }
#define SGITNODEPTR(x)
#define SGITITERATE(x, i, nt)
#define IndexTupleHasNulls(itup)
Definition: itup.h:72
#define ERROR
Definition: elog.h:43
uintptr_t Datum
Definition: postgres.h:367
void * palloc(Size size)
Definition: mcxt.c:924
#define elog(elevel,...)
Definition: elog.h:226
int i
#define SGNTDATUM(x, s)

◆ spgFormDeadTuple()

SpGistDeadTuple spgFormDeadTuple ( SpGistState state,
int  tupstate,
BlockNumber  blkno,
OffsetNumber  offnum 
)

Definition at line 798 of file spgutils.c.

References Assert, SpGistState::deadTupleStorage, InvalidOffsetNumber, InvalidTransactionId, ItemPointerSet, ItemPointerSetInvalid, SpGistState::myXid, SpGistDeadTupleData::nextOffset, SpGistDeadTupleData::pointer, SGDTSIZE, SpGistDeadTupleData::size, SPGIST_REDIRECT, TransactionIdIsValid, SpGistDeadTupleData::tupstate, and SpGistDeadTupleData::xid.

Referenced by spgAddNodeAction(), spgPageIndexMultiDelete(), and spgRedoAddNode().

800 {
802 
803  tuple->tupstate = tupstate;
804  tuple->size = SGDTSIZE;
806 
807  if (tupstate == SPGIST_REDIRECT)
808  {
809  ItemPointerSet(&tuple->pointer, blkno, offnum);
811  tuple->xid = state->myXid;
812  }
813  else
814  {
816  tuple->xid = InvalidTransactionId;
817  }
818 
819  return tuple;
820 }
#define SGDTSIZE
#define SPGIST_REDIRECT
ItemPointerData pointer
SpGistDeadTupleData * SpGistDeadTuple
#define InvalidTransactionId
Definition: transam.h:31
TransactionId myXid
unsigned int tupstate
char * deadTupleStorage
OffsetNumber nextOffset
#define InvalidOffsetNumber
Definition: off.h:26
#define Assert(condition)
Definition: c.h:732
#define ItemPointerSetInvalid(pointer)
Definition: itemptr.h:172
#define TransactionIdIsValid(xid)
Definition: transam.h:41
#define ItemPointerSet(pointer, blockNumber, offNum)
Definition: itemptr.h:127

◆ spgFormInnerTuple()

SpGistInnerTuple spgFormInnerTuple ( SpGistState state,
bool  hasPrefix,
Datum  prefix,
int  nNodes,
SpGistNodeTuple nodes 
)

Definition at line 715 of file spgutils.c.

References SpGistState::attPrefixType, elog, ereport, errcode(), errhint(), errmsg(), ERROR, i, IndexTupleSize, memcpyDatum(), SpGistInnerTupleData::nNodes, palloc0(), SpGistInnerTupleData::prefixSize, SGDTSIZE, SGITDATAPTR, SGITHDRSZ, SGITMAXNNODES, SGITMAXPREFIXSIZE, SGITMAXSIZE, SGITNODEPTR, SpGistInnerTupleData::size, SPGIST_PAGE_CAPACITY, and SpGistGetTypeSize().

Referenced by addNode(), doPickSplit(), and spgSplitNodeAction().

717 {
718  SpGistInnerTuple tup;
719  unsigned int size;
720  unsigned int prefixSize;
721  int i;
722  char *ptr;
723 
724  /* Compute size needed */
725  if (hasPrefix)
726  prefixSize = SpGistGetTypeSize(&state->attPrefixType, prefix);
727  else
728  prefixSize = 0;
729 
730  size = SGITHDRSZ + prefixSize;
731 
732  /* Note: we rely on node tuple sizes to be maxaligned already */
733  for (i = 0; i < nNodes; i++)
734  size += IndexTupleSize(nodes[i]);
735 
736  /*
737  * Ensure that we can replace the tuple with a dead tuple later. This
738  * test is unnecessary given current tuple layouts, but let's be safe.
739  */
740  if (size < SGDTSIZE)
741  size = SGDTSIZE;
742 
743  /*
744  * Inner tuple should be small enough to fit on a page
745  */
746  if (size > SPGIST_PAGE_CAPACITY - sizeof(ItemIdData))
747  ereport(ERROR,
748  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
749  errmsg("SP-GiST inner tuple size %zu exceeds maximum %zu",
750  (Size) size,
751  SPGIST_PAGE_CAPACITY - sizeof(ItemIdData)),
752  errhint("Values larger than a buffer page cannot be indexed.")));
753 
754  /*
755  * Check for overflow of header fields --- probably can't fail if the
756  * above succeeded, but let's be paranoid
757  */
758  if (size > SGITMAXSIZE ||
759  prefixSize > SGITMAXPREFIXSIZE ||
760  nNodes > SGITMAXNNODES)
761  elog(ERROR, "SPGiST inner tuple header field is too small");
762 
763  /* OK, form the tuple */
764  tup = (SpGistInnerTuple) palloc0(size);
765 
766  tup->nNodes = nNodes;
767  tup->prefixSize = prefixSize;
768  tup->size = size;
769 
770  if (hasPrefix)
771  memcpyDatum(SGITDATAPTR(tup), &state->attPrefixType, prefix);
772 
773  ptr = (char *) SGITNODEPTR(tup);
774 
775  for (i = 0; i < nNodes; i++)
776  {
777  SpGistNodeTuple node = nodes[i];
778 
779  memcpy(ptr, node, IndexTupleSize(node));
780  ptr += IndexTupleSize(node);
781  }
782 
783  return tup;
784 }
#define SGITNODEPTR(x)
SpGistTypeDesc attPrefixType
SpGistInnerTupleData * SpGistInnerTuple
int errhint(const char *fmt,...)
Definition: elog.c:974
#define SGITMAXPREFIXSIZE
#define SGDTSIZE
int errcode(int sqlerrcode)
Definition: elog.c:570
#define ERROR
Definition: elog.h:43
unsigned int prefixSize
#define SGITMAXSIZE
#define SGITDATAPTR(x)
#define SGITMAXNNODES
#define ereport(elevel, rest)
Definition: elog.h:141
unsigned int SpGistGetTypeSize(SpGistTypeDesc *att, Datum datum)
Definition: spgutils.c:599
void * palloc0(Size size)
Definition: mcxt.c:955
#define SPGIST_PAGE_CAPACITY
size_t Size
Definition: c.h:466
static void memcpyDatum(void *target, SpGistTypeDesc *att, Datum datum)
Definition: spgutils.c:617
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
int i
#define SGITHDRSZ
#define IndexTupleSize(itup)
Definition: itup.h:71

◆ spgFormLeafTuple()

SpGistLeafTuple spgFormLeafTuple ( SpGistState state,
ItemPointer  heapPtr,
Datum  datum,
bool  isnull 
)

Definition at line 636 of file spgutils.c.

References SpGistState::attLeafType, SpGistLeafTupleData::heapPtr, InvalidOffsetNumber, memcpyDatum(), SpGistLeafTupleData::nextOffset, palloc0(), SGDTSIZE, SGLTDATAPTR, SGLTHDRSZ, SpGistLeafTupleData::size, and SpGistGetTypeSize().

Referenced by doPickSplit(), and spgdoinsert().

638 {
639  SpGistLeafTuple tup;
640  unsigned int size;
641 
642  /* compute space needed (note result is already maxaligned) */
643  size = SGLTHDRSZ;
644  if (!isnull)
645  size += SpGistGetTypeSize(&state->attLeafType, datum);
646 
647  /*
648  * Ensure that we can replace the tuple with a dead tuple later. This
649  * test is unnecessary when !isnull, but let's be safe.
650  */
651  if (size < SGDTSIZE)
652  size = SGDTSIZE;
653 
654  /* OK, form the tuple */
655  tup = (SpGistLeafTuple) palloc0(size);
656 
657  tup->size = size;
659  tup->heapPtr = *heapPtr;
660  if (!isnull)
661  memcpyDatum(SGLTDATAPTR(tup), &state->attLeafType, datum);
662 
663  return tup;
664 }
#define SGDTSIZE
SpGistTypeDesc attLeafType
#define SGLTDATAPTR(x)
#define SGLTHDRSZ
unsigned int SpGistGetTypeSize(SpGistTypeDesc *att, Datum datum)
Definition: spgutils.c:599
void * palloc0(Size size)
Definition: mcxt.c:955
#define InvalidOffsetNumber
Definition: off.h:26
OffsetNumber nextOffset
static void memcpyDatum(void *target, SpGistTypeDesc *att, Datum datum)
Definition: spgutils.c:617
ItemPointerData heapPtr
SpGistLeafTupleData * SpGistLeafTuple

◆ spgFormNodeTuple()

SpGistNodeTuple spgFormNodeTuple ( SpGistState state,
Datum  label,
bool  isnull 
)

Definition at line 673 of file spgutils.c.

References SpGistState::attLabelType, ereport, errcode(), errmsg(), ERROR, INDEX_NULL_MASK, INDEX_SIZE_MASK, ItemPointerSetInvalid, memcpyDatum(), palloc0(), SGNTDATAPTR, SGNTHDRSZ, SpGistGetTypeSize(), IndexTupleData::t_info, and IndexTupleData::t_tid.

Referenced by addNode(), doPickSplit(), and spgSplitNodeAction().

674 {
675  SpGistNodeTuple tup;
676  unsigned int size;
677  unsigned short infomask = 0;
678 
679  /* compute space needed (note result is already maxaligned) */
680  size = SGNTHDRSZ;
681  if (!isnull)
682  size += SpGistGetTypeSize(&state->attLabelType, label);
683 
684  /*
685  * Here we make sure that the size will fit in the field reserved for it
686  * in t_info.
687  */
688  if ((size & INDEX_SIZE_MASK) != size)
689  ereport(ERROR,
690  (errcode(ERRCODE_PROGRAM_LIMIT_EXCEEDED),
691  errmsg("index row requires %zu bytes, maximum size is %zu",
692  (Size) size, (Size) INDEX_SIZE_MASK)));
693 
694  tup = (SpGistNodeTuple) palloc0(size);
695 
696  if (isnull)
697  infomask |= INDEX_NULL_MASK;
698  /* we don't bother setting the INDEX_VAR_MASK bit */
699  infomask |= size;
700  tup->t_info = infomask;
701 
702  /* The TID field will be filled in later */
704 
705  if (!isnull)
706  memcpyDatum(SGNTDATAPTR(tup), &state->attLabelType, label);
707 
708  return tup;
709 }
ItemPointerData t_tid
Definition: itup.h:37
#define INDEX_SIZE_MASK
Definition: itup.h:65
int errcode(int sqlerrcode)
Definition: elog.c:570
SpGistTypeDesc attLabelType
#define SGNTHDRSZ
#define ERROR
Definition: elog.h:43
#define INDEX_NULL_MASK
Definition: itup.h:69
#define ereport(elevel, rest)
Definition: elog.h:141
unsigned int SpGistGetTypeSize(SpGistTypeDesc *att, Datum datum)
Definition: spgutils.c:599
void * palloc0(Size size)
Definition: mcxt.c:955
static char * label
Definition: pg_basebackup.c:90
#define SGNTDATAPTR(x)
size_t Size
Definition: c.h:466
#define ItemPointerSetInvalid(pointer)
Definition: itemptr.h:172
static void memcpyDatum(void *target, SpGistTypeDesc *att, Datum datum)
Definition: spgutils.c:617
int errmsg(const char *fmt,...)
Definition: elog.c:784
unsigned short t_info
Definition: itup.h:49
SpGistNodeTupleData * SpGistNodeTuple

◆ spgGetCache()

SpGistCache* spgGetCache ( Relation  index)

Definition at line 99 of file spgutils.c.

References Assert, SpGistCache::attLabelType, SpGistCache::attLeafType, SpGistCache::attPrefixType, spgConfigIn::attType, SpGistCache::attType, BUFFER_LOCK_SHARE, BufferGetPage, SpGistCache::config, elog, ereport, errcode(), errmsg(), ERROR, fillTypeDesc(), FunctionCall2Coll(), index_getprocid(), index_getprocinfo(), spgConfigOut::labelType, SpGistMetaPageData::lastUsedPages, SpGistCache::lastUsedPages, spgConfigOut::leafType, LockBuffer(), SpGistMetaPageData::magicNumber, MemoryContextAllocZero(), TupleDescData::natts, OidIsValid, PointerGetDatum, spgConfigOut::prefixType, RelationData::rd_amcache, RelationData::rd_att, RelationData::rd_indcollation, RelationData::rd_indexcxt, ReadBuffer(), RelationGetRelationName, SPGIST_COMPRESS_PROC, SPGIST_CONFIG_PROC, SPGIST_MAGIC_NUMBER, SPGIST_METAPAGE_BLKNO, SpGistPageGetMeta, TupleDescAttr, and UnlockReleaseBuffer().

Referenced by allocNewBuffer(), initSpGistState(), spgcanreturn(), SpGistGetBuffer(), and SpGistSetLastUsedPage().

100 {
101  SpGistCache *cache;
102 
103  if (index->rd_amcache == NULL)
104  {
105  Oid atttype;
106  spgConfigIn in;
107  FmgrInfo *procinfo;
108  Buffer metabuffer;
109  SpGistMetaPageData *metadata;
110 
111  cache = MemoryContextAllocZero(index->rd_indexcxt,
112  sizeof(SpGistCache));
113 
114  /* SPGiST doesn't support multi-column indexes */
115  Assert(index->rd_att->natts == 1);
116 
117  /*
118  * Get the actual data type of the indexed column from the index
119  * tupdesc. We pass this to the opclass config function so that
120  * polymorphic opclasses are possible.
121  */
122  atttype = TupleDescAttr(index->rd_att, 0)->atttypid;
123 
124  /* Call the config function to get config info for the opclass */
125  in.attType = atttype;
126 
127  procinfo = index_getprocinfo(index, 1, SPGIST_CONFIG_PROC);
128  FunctionCall2Coll(procinfo,
129  index->rd_indcollation[0],
130  PointerGetDatum(&in),
131  PointerGetDatum(&cache->config));
132 
133  /* Get the information we need about each relevant datatype */
134  fillTypeDesc(&cache->attType, atttype);
135 
136  if (OidIsValid(cache->config.leafType) &&
137  cache->config.leafType != atttype)
138  {
140  ereport(ERROR,
141  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
142  errmsg("compress method must be defined when leaf type is different from input type")));
143 
144  fillTypeDesc(&cache->attLeafType, cache->config.leafType);
145  }
146  else
147  {
148  cache->attLeafType = cache->attType;
149  }
150 
151  fillTypeDesc(&cache->attPrefixType, cache->config.prefixType);
152  fillTypeDesc(&cache->attLabelType, cache->config.labelType);
153 
154  /* Last, get the lastUsedPages data from the metapage */
155  metabuffer = ReadBuffer(index, SPGIST_METAPAGE_BLKNO);
156  LockBuffer(metabuffer, BUFFER_LOCK_SHARE);
157 
158  metadata = SpGistPageGetMeta(BufferGetPage(metabuffer));
159 
160  if (metadata->magicNumber != SPGIST_MAGIC_NUMBER)
161  elog(ERROR, "index \"%s\" is not an SP-GiST index",
162  RelationGetRelationName(index));
163 
164  cache->lastUsedPages = metadata->lastUsedPages;
165 
166  UnlockReleaseBuffer(metabuffer);
167 
168  index->rd_amcache = (void *) cache;
169  }
170  else
171  {
172  /* assume it's up to date */
173  cache = (SpGistCache *) index->rd_amcache;
174  }
175 
176  return cache;
177 }
SpGistTypeDesc attLeafType
Definition: fmgr.h:56
FmgrInfo * index_getprocinfo(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:794
#define PointerGetDatum(X)
Definition: postgres.h:556
#define TupleDescAttr(tupdesc, i)
Definition: tupdesc.h:92
int errcode(int sqlerrcode)
Definition: elog.c:570
Oid attType
Definition: spgist.h:41
Datum FunctionCall2Coll(FmgrInfo *flinfo, Oid collation, Datum arg1, Datum arg2)
Definition: fmgr.c:1150
unsigned int Oid
Definition: postgres_ext.h:31
SpGistTypeDesc attType
#define OidIsValid(objectId)
Definition: c.h:638
SpGistLUPCache lastUsedPages
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3376
Oid * rd_indcollation
Definition: rel.h:168
#define ERROR
Definition: elog.h:43
#define SPGIST_METAPAGE_BLKNO
#define RelationGetRelationName(relation)
Definition: rel.h:450
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define ereport(elevel, rest)
Definition: elog.h:141
#define SPGIST_MAGIC_NUMBER
spgConfigOut config
SpGistLUPCache lastUsedPages
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3590
Oid prefixType
Definition: spgist.h:46
TupleDesc rd_att
Definition: rel.h:84
void * MemoryContextAllocZero(MemoryContext context, Size size)
Definition: mcxt.c:814
#define Assert(condition)
Definition: c.h:732
#define SPGIST_COMPRESS_PROC
Definition: spgist.h:32
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define SPGIST_CONFIG_PROC
Definition: spgist.h:27
#define SpGistPageGetMeta(p)
SpGistTypeDesc attLabelType
int errmsg(const char *fmt,...)
Definition: elog.c:784
#define elog(elevel,...)
Definition: elog.h:226
MemoryContext rd_indexcxt
Definition: rel.h:155
Oid labelType
Definition: spgist.h:47
Oid leafType
Definition: spgist.h:48
#define BUFFER_LOCK_SHARE
Definition: bufmgr.h:87
SpGistTypeDesc attPrefixType
static void fillTypeDesc(SpGistTypeDesc *desc, Oid type)
Definition: spgutils.c:88
void * rd_amcache
Definition: rel.h:179
int Buffer
Definition: buf.h:23
RegProcedure index_getprocid(Relation irel, AttrNumber attnum, uint16 procnum)
Definition: indexam.c:760

◆ SpGistGetBuffer()

Buffer SpGistGetBuffer ( Relation  index,
int  flags,
int  needSpace,
bool isNew 
)

Definition at line 395 of file spgutils.c.

References allocNewBuffer(), Assert, SpGistLastUsedPage::blkno, BufferGetPage, ConditionalLockBuffer(), elog, ERROR, SpGistLastUsedPage::freeSpace, GBUF_REQ_LEAF, GBUF_REQ_NULLS, GET_LUP, InvalidBlockNumber, Min, PageGetExactFreeSpace(), PageIsEmpty, PageIsNew, ReadBuffer(), RelationGetTargetPageFreeSpace, ReleaseBuffer(), spgGetCache(), SPGIST_DEFAULT_FILLFACTOR, SPGIST_LEAF, SPGIST_NULLS, SPGIST_PAGE_CAPACITY, SpGistBlockIsFixed, SpGistInitBuffer(), SpGistPageIsDeleted, SpGistPageIsLeaf, SpGistPageStoresNulls, and UnlockReleaseBuffer().

Referenced by doPickSplit(), moveLeafs(), spgAddNodeAction(), spgdoinsert(), and spgSplitNodeAction().

396 {
397  SpGistCache *cache = spgGetCache(index);
398  SpGistLastUsedPage *lup;
399 
400  /* Bail out if even an empty page wouldn't meet the demand */
401  if (needSpace > SPGIST_PAGE_CAPACITY)
402  elog(ERROR, "desired SPGiST tuple size is too big");
403 
404  /*
405  * If possible, increase the space request to include relation's
406  * fillfactor. This ensures that when we add unrelated tuples to a page,
407  * we try to keep 100-fillfactor% available for adding tuples that are
408  * related to the ones already on it. But fillfactor mustn't cause an
409  * error for requests that would otherwise be legal.
410  */
411  needSpace += RelationGetTargetPageFreeSpace(index,
413  needSpace = Min(needSpace, SPGIST_PAGE_CAPACITY);
414 
415  /* Get the cache entry for this flags setting */
416  lup = GET_LUP(cache, flags);
417 
418  /* If we have nothing cached, just turn it over to allocNewBuffer */
419  if (lup->blkno == InvalidBlockNumber)
420  {
421  *isNew = true;
422  return allocNewBuffer(index, flags);
423  }
424 
425  /* fixed pages should never be in cache */
427 
428  /* If cached freeSpace isn't enough, don't bother looking at the page */
429  if (lup->freeSpace >= needSpace)
430  {
431  Buffer buffer;
432  Page page;
433 
434  buffer = ReadBuffer(index, lup->blkno);
435 
436  if (!ConditionalLockBuffer(buffer))
437  {
438  /*
439  * buffer is locked by another process, so return a new buffer
440  */
441  ReleaseBuffer(buffer);
442  *isNew = true;
443  return allocNewBuffer(index, flags);
444  }
445 
446  page = BufferGetPage(buffer);
447 
448  if (PageIsNew(page) || SpGistPageIsDeleted(page) || PageIsEmpty(page))
449  {
450  /* OK to initialize the page */
451  uint16 pageflags = 0;
452 
453  if (GBUF_REQ_LEAF(flags))
454  pageflags |= SPGIST_LEAF;
455  if (GBUF_REQ_NULLS(flags))
456  pageflags |= SPGIST_NULLS;
457  SpGistInitBuffer(buffer, pageflags);
458  lup->freeSpace = PageGetExactFreeSpace(page) - needSpace;
459  *isNew = true;
460  return buffer;
461  }
462 
463  /*
464  * Check that page is of right type and has enough space. We must
465  * recheck this since our cache isn't necessarily up to date.
466  */
467  if ((GBUF_REQ_LEAF(flags) ? SpGistPageIsLeaf(page) : !SpGistPageIsLeaf(page)) &&
469  {
470  int freeSpace = PageGetExactFreeSpace(page);
471 
472  if (freeSpace >= needSpace)
473  {
474  /* Success, update freespace info and return the buffer */
475  lup->freeSpace = freeSpace - needSpace;
476  *isNew = false;
477  return buffer;
478  }
479  }
480 
481  /*
482  * fallback to allocation of new buffer
483  */
484  UnlockReleaseBuffer(buffer);
485  }
486 
487  /* No success with cache, so return a new buffer */
488  *isNew = true;
489  return allocNewBuffer(index, flags);
490 }
#define PageIsEmpty(page)
Definition: bufpage.h:222
#define SpGistPageIsLeaf(page)
SpGistCache * spgGetCache(Relation index)
Definition: spgutils.c:99
#define GET_LUP(c, f)
Definition: spgutils.c:316
#define Min(x, y)
Definition: c.h:904
#define SPGIST_NULLS
static Buffer allocNewBuffer(Relation index, int flags)
Definition: spgutils.c:339
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3353
#define SPGIST_DEFAULT_FILLFACTOR
Definition: spgist.h:24
#define GBUF_REQ_NULLS(flags)
unsigned short uint16
Definition: c.h:357
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3376
#define ERROR
Definition: elog.h:43
#define SpGistBlockIsFixed(blkno)
void SpGistInitBuffer(Buffer b, uint16 f)
Definition: spgutils.c:550
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
bool ConditionalLockBuffer(Buffer buffer)
Definition: bufmgr.c:3616
#define RelationGetTargetPageFreeSpace(relation, defaultff)
Definition: rel.h:307
#define SPGIST_PAGE_CAPACITY
#define SpGistPageStoresNulls(page)
#define Assert(condition)
Definition: c.h:732
#define SpGistPageIsDeleted(page)
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define InvalidBlockNumber
Definition: block.h:33
Size PageGetExactFreeSpace(Page page)
Definition: bufpage.c:632
#define PageIsNew(page)
Definition: bufpage.h:229
#define elog(elevel,...)
Definition: elog.h:226
#define SPGIST_LEAF
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78
#define GBUF_REQ_LEAF(flags)

◆ SpGistGetTypeSize()

unsigned int SpGistGetTypeSize ( SpGistTypeDesc att,
Datum  datum 
)

Definition at line 599 of file spgutils.c.

References SpGistTypeDesc::attbyval, SpGistTypeDesc::attlen, MAXALIGN, and VARSIZE_ANY.

Referenced by spgdoinsert(), spgFormInnerTuple(), spgFormLeafTuple(), and spgFormNodeTuple().

600 {
601  unsigned int size;
602 
603  if (att->attbyval)
604  size = sizeof(Datum);
605  else if (att->attlen > 0)
606  size = att->attlen;
607  else
608  size = VARSIZE_ANY(datum);
609 
610  return MAXALIGN(size);
611 }
uintptr_t Datum
Definition: postgres.h:367
#define VARSIZE_ANY(PTR)
Definition: postgres.h:335
#define MAXALIGN(LEN)
Definition: c.h:685

◆ SpGistInitBuffer()

void SpGistInitBuffer ( Buffer  b,
uint16  f 
)

Definition at line 550 of file spgutils.c.

References Assert, BufferGetPage, BufferGetPageSize, and SpGistInitPage().

Referenced by allocNewBuffer(), doPickSplit(), spgbuild(), SpGistGetBuffer(), spgRedoAddLeaf(), spgRedoAddNode(), spgRedoMoveLeafs(), spgRedoPickSplit(), and spgRedoSplitTuple().

551 {
552  Assert(BufferGetPageSize(b) == BLCKSZ);
554 }
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define BufferGetPageSize(buffer)
Definition: bufmgr.h:146
#define Assert(condition)
Definition: c.h:732
void SpGistInitPage(Page page, uint16 f)
Definition: spgutils.c:535

◆ SpGistInitMetapage()

void SpGistInitMetapage ( Page  page)

Definition at line 560 of file spgutils.c.

References SpGistLastUsedPage::blkno, SpGistLUPCache::cachedPage, i, InvalidBlockNumber, SpGistMetaPageData::lastUsedPages, SpGistMetaPageData::magicNumber, SPGIST_CACHED_PAGES, SPGIST_MAGIC_NUMBER, SPGIST_META, SpGistInitPage(), and SpGistPageGetMeta.

Referenced by spgbuild(), and spgbuildempty().

561 {
562  SpGistMetaPageData *metadata;
563  int i;
564 
566  metadata = SpGistPageGetMeta(page);
567  memset(metadata, 0, sizeof(SpGistMetaPageData));
568  metadata->magicNumber = SPGIST_MAGIC_NUMBER;
569 
570  /* initialize last-used-page cache to empty */
571  for (i = 0; i < SPGIST_CACHED_PAGES; i++)
573 
574  /*
575  * Set pd_lower just past the end of the metadata. This is essential,
576  * because without doing so, metadata will be lost if xlog.c compresses
577  * the page.
578  */
579  ((PageHeader) page)->pd_lower =
580  ((char *) metadata + sizeof(SpGistMetaPageData)) - (char *) page;
581 }
SpGistLastUsedPage cachedPage[SPGIST_CACHED_PAGES]
#define SPGIST_META
#define SPGIST_MAGIC_NUMBER
SpGistLUPCache lastUsedPages
#define InvalidBlockNumber
Definition: block.h:33
#define SPGIST_CACHED_PAGES
#define SpGistPageGetMeta(p)
void SpGistInitPage(Page page, uint16 f)
Definition: spgutils.c:535
int i

◆ SpGistInitPage()

void SpGistInitPage ( Page  page,
uint16  f 
)

Definition at line 535 of file spgutils.c.

References SpGistPageOpaqueData::flags, MAXALIGN, PageInit(), SpGistPageOpaqueData::spgist_page_id, SPGIST_PAGE_ID, and SpGistPageGetOpaque.

Referenced by spgbuildempty(), SpGistInitBuffer(), and SpGistInitMetapage().

536 {
537  SpGistPageOpaque opaque;
538 
539  PageInit(page, BLCKSZ, MAXALIGN(sizeof(SpGistPageOpaqueData)));
540  opaque = SpGistPageGetOpaque(page);
541  memset(opaque, 0, sizeof(SpGistPageOpaqueData));
542  opaque->flags = f;
543  opaque->spgist_page_id = SPGIST_PAGE_ID;
544 }
#define SPGIST_PAGE_ID
#define MAXALIGN(LEN)
Definition: c.h:685
#define SpGistPageGetOpaque(page)
void PageInit(Page page, Size pageSize, Size specialSize)
Definition: bufpage.c:42

◆ SpGistNewBuffer()

Buffer SpGistNewBuffer ( Relation  index)

Definition at line 211 of file spgutils.c.

References BUFFER_LOCK_EXCLUSIVE, BUFFER_LOCK_UNLOCK, BufferGetPage, ConditionalLockBuffer(), ExclusiveLock, GetFreeIndexPage(), InvalidBlockNumber, LockBuffer(), LockRelationForExtension(), P_NEW, PageIsEmpty, PageIsNew, ReadBuffer(), RELATION_IS_LOCAL, ReleaseBuffer(), SpGistBlockIsFixed, SpGistPageIsDeleted, and UnlockRelationForExtension().

Referenced by allocNewBuffer(), and spgbuild().

212 {
213  Buffer buffer;
214  bool needLock;
215 
216  /* First, try to get a page from FSM */
217  for (;;)
218  {
219  BlockNumber blkno = GetFreeIndexPage(index);
220 
221  if (blkno == InvalidBlockNumber)
222  break; /* nothing known to FSM */
223 
224  /*
225  * The fixed pages shouldn't ever be listed in FSM, but just in case
226  * one is, ignore it.
227  */
228  if (SpGistBlockIsFixed(blkno))
229  continue;
230 
231  buffer = ReadBuffer(index, blkno);
232 
233  /*
234  * We have to guard against the possibility that someone else already
235  * recycled this page; the buffer may be locked if so.
236  */
237  if (ConditionalLockBuffer(buffer))
238  {
239  Page page = BufferGetPage(buffer);
240 
241  if (PageIsNew(page))
242  return buffer; /* OK to use, if never initialized */
243 
244  if (SpGistPageIsDeleted(page) || PageIsEmpty(page))
245  return buffer; /* OK to use */
246 
248  }
249 
250  /* Can't use it, so release buffer and try again */
251  ReleaseBuffer(buffer);
252  }
253 
254  /* Must extend the file */
255  needLock = !RELATION_IS_LOCAL(index);
256  if (needLock)
258 
259  buffer = ReadBuffer(index, P_NEW);
261 
262  if (needLock)
264 
265  return buffer;
266 }
#define BUFFER_LOCK_UNLOCK
Definition: bufmgr.h:86
#define PageIsEmpty(page)
Definition: bufpage.h:222
#define ExclusiveLock
Definition: lockdefs.h:44
#define RELATION_IS_LOCAL(relation)
Definition: rel.h:536
uint32 BlockNumber
Definition: block.h:31
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3353
#define P_NEW
Definition: bufmgr.h:81
#define BUFFER_LOCK_EXCLUSIVE
Definition: bufmgr.h:88
#define SpGistBlockIsFixed(blkno)
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
bool ConditionalLockBuffer(Buffer buffer)
Definition: bufmgr.c:3616
void LockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:402
void UnlockRelationForExtension(Relation relation, LOCKMODE lockmode)
Definition: lmgr.c:452
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3590
BlockNumber GetFreeIndexPage(Relation rel)
Definition: indexfsm.c:38
#define SpGistPageIsDeleted(page)
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define InvalidBlockNumber
Definition: block.h:33
#define PageIsNew(page)
Definition: bufpage.h:229
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78

◆ SpGistPageAddNewItem()

OffsetNumber SpGistPageAddNewItem ( SpGistState state,
Page  page,
Item  item,
Size  size,
OffsetNumber startOffset,
bool  errorOK 
)

Definition at line 871 of file spgutils.c.

References Assert, elog, ERROR, FirstOffsetNumber, i, InvalidOffsetNumber, MAXALIGN, SpGistPageOpaqueData::nPlaceholder, PageAddItem, PageGetExactFreeSpace(), PageGetItem, PageGetItemId, PageGetMaxOffsetNumber, PageIndexTupleDelete(), PANIC, SGDTSIZE, SPGIST_PLACEHOLDER, SpGistPageGetOpaque, and SpGistDeadTupleData::tupstate.

Referenced by addLeafTuple(), doPickSplit(), moveLeafs(), spgAddNodeAction(), and spgSplitNodeAction().

873 {
874  SpGistPageOpaque opaque = SpGistPageGetOpaque(page);
875  OffsetNumber i,
876  maxoff,
877  offnum;
878 
879  if (opaque->nPlaceholder > 0 &&
880  PageGetExactFreeSpace(page) + SGDTSIZE >= MAXALIGN(size))
881  {
882  /* Try to replace a placeholder */
883  maxoff = PageGetMaxOffsetNumber(page);
884  offnum = InvalidOffsetNumber;
885 
886  for (;;)
887  {
888  if (startOffset && *startOffset != InvalidOffsetNumber)
889  i = *startOffset;
890  else
891  i = FirstOffsetNumber;
892  for (; i <= maxoff; i++)
893  {
895  PageGetItemId(page, i));
896 
897  if (it->tupstate == SPGIST_PLACEHOLDER)
898  {
899  offnum = i;
900  break;
901  }
902  }
903 
904  /* Done if we found a placeholder */
905  if (offnum != InvalidOffsetNumber)
906  break;
907 
908  if (startOffset && *startOffset != InvalidOffsetNumber)
909  {
910  /* Hint was no good, re-search from beginning */
911  *startOffset = InvalidOffsetNumber;
912  continue;
913  }
914 
915  /* Hmm, no placeholder found? */
916  opaque->nPlaceholder = 0;
917  break;
918  }
919 
920  if (offnum != InvalidOffsetNumber)
921  {
922  /* Replace the placeholder tuple */
923  PageIndexTupleDelete(page, offnum);
924 
925  offnum = PageAddItem(page, item, size, offnum, false, false);
926 
927  /*
928  * We should not have failed given the size check at the top of
929  * the function, but test anyway. If we did fail, we must PANIC
930  * because we've already deleted the placeholder tuple, and
931  * there's no other way to keep the damage from getting to disk.
932  */
933  if (offnum != InvalidOffsetNumber)
934  {
935  Assert(opaque->nPlaceholder > 0);
936  opaque->nPlaceholder--;
937  if (startOffset)
938  *startOffset = offnum + 1;
939  }
940  else
941  elog(PANIC, "failed to add item of size %u to SPGiST index page",
942  (int) size);
943 
944  return offnum;
945  }
946  }
947 
948  /* No luck in replacing a placeholder, so just add it to the page */
949  offnum = PageAddItem(page, item, size,
950  InvalidOffsetNumber, false, false);
951 
952  if (offnum == InvalidOffsetNumber && !errorOK)
953  elog(ERROR, "failed to add item of size %u to SPGiST index page",
954  (int) size);
955 
956  return offnum;
957 }
#define SGDTSIZE
void PageIndexTupleDelete(Page page, OffsetNumber offnum)
Definition: bufpage.c:726
#define SPGIST_PLACEHOLDER
#define PageAddItem(page, item, size, offsetNumber, overwrite, is_heap)
Definition: bufpage.h:416
#define PANIC
Definition: elog.h:53
#define PageGetMaxOffsetNumber(page)
Definition: bufpage.h:357
uint16 OffsetNumber
Definition: off.h:24
#define ERROR
Definition: elog.h:43
#define FirstOffsetNumber
Definition: off.h:27
SpGistDeadTupleData * SpGistDeadTuple
#define PageGetItemId(page, offsetNumber)
Definition: bufpage.h:235
unsigned int tupstate
#define InvalidOffsetNumber
Definition: off.h:26
#define Assert(condition)
Definition: c.h:732
#define MAXALIGN(LEN)
Definition: c.h:685
Size PageGetExactFreeSpace(Page page)
Definition: bufpage.c:632
#define SpGistPageGetOpaque(page)
#define elog(elevel,...)
Definition: elog.h:226
int i
#define PageGetItem(page, itemId)
Definition: bufpage.h:340

◆ SpGistSetLastUsedPage()

void SpGistSetLastUsedPage ( Relation  index,
Buffer  buffer 
)

Definition at line 500 of file spgutils.c.

References SpGistLastUsedPage::blkno, BufferGetBlockNumber(), BufferGetPage, SpGistLastUsedPage::freeSpace, GBUF_INNER_PARITY, GBUF_LEAF, GBUF_NULLS, GET_LUP, InvalidBlockNumber, PageGetExactFreeSpace(), spgGetCache(), SpGistBlockIsFixed, SpGistPageIsLeaf, and SpGistPageStoresNulls.

Referenced by doPickSplit(), moveLeafs(), spgAddNodeAction(), spgdoinsert(), spgMatchNodeAction(), spgprocesspending(), spgSplitNodeAction(), and spgvacuumpage().

501 {
502  SpGistCache *cache = spgGetCache(index);
503  SpGistLastUsedPage *lup;
504  int freeSpace;
505  Page page = BufferGetPage(buffer);
506  BlockNumber blkno = BufferGetBlockNumber(buffer);
507  int flags;
508 
509  /* Never enter fixed pages (root pages) in cache, though */
510  if (SpGistBlockIsFixed(blkno))
511  return;
512 
513  if (SpGistPageIsLeaf(page))
514  flags = GBUF_LEAF;
515  else
516  flags = GBUF_INNER_PARITY(blkno);
517  if (SpGistPageStoresNulls(page))
518  flags |= GBUF_NULLS;
519 
520  lup = GET_LUP(cache, flags);
521 
522  freeSpace = PageGetExactFreeSpace(page);
523  if (lup->blkno == InvalidBlockNumber || lup->blkno == blkno ||
524  lup->freeSpace < freeSpace)
525  {
526  lup->blkno = blkno;
527  lup->freeSpace = freeSpace;
528  }
529 }
#define SpGistPageIsLeaf(page)
SpGistCache * spgGetCache(Relation index)
Definition: spgutils.c:99
#define GET_LUP(c, f)
Definition: spgutils.c:316
uint32 BlockNumber
Definition: block.h:31
#define GBUF_INNER_PARITY(x)
#define SpGistBlockIsFixed(blkno)
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
#define GBUF_LEAF
#define SpGistPageStoresNulls(page)
#define InvalidBlockNumber
Definition: block.h:33
#define GBUF_NULLS
Size PageGetExactFreeSpace(Page page)
Definition: bufpage.c:632
BlockNumber BufferGetBlockNumber(Buffer buffer)
Definition: bufmgr.c:2613
Pointer Page
Definition: bufpage.h:78

◆ SpGistUpdateMetaPage()

void SpGistUpdateMetaPage ( Relation  index)

Definition at line 276 of file spgutils.c.

References BufferGetPage, ConditionalLockBuffer(), SpGistMetaPageData::lastUsedPages, SpGistCache::lastUsedPages, MarkBufferDirty(), RelationData::rd_amcache, ReadBuffer(), ReleaseBuffer(), SPGIST_METAPAGE_BLKNO, SpGistPageGetMeta, and UnlockReleaseBuffer().

Referenced by spgbuild(), spginsert(), and spgvacuumscan().

277 {
278  SpGistCache *cache = (SpGistCache *) index->rd_amcache;
279 
280  if (cache != NULL)
281  {
282  Buffer metabuffer;
283 
284  metabuffer = ReadBuffer(index, SPGIST_METAPAGE_BLKNO);
285 
286  if (ConditionalLockBuffer(metabuffer))
287  {
288  Page metapage = BufferGetPage(metabuffer);
289  SpGistMetaPageData *metadata = SpGistPageGetMeta(metapage);
290 
291  metadata->lastUsedPages = cache->lastUsedPages;
292 
293  /*
294  * Set pd_lower just past the end of the metadata. This is
295  * essential, because without doing so, metadata will be lost if
296  * xlog.c compresses the page. (We must do this here because
297  * pre-v11 versions of PG did not set the metapage's pd_lower
298  * correctly, so a pg_upgraded index might contain the wrong
299  * value.)
300  */
301  ((PageHeader) metapage)->pd_lower =
302  ((char *) metadata + sizeof(SpGistMetaPageData)) - (char *) metapage;
303 
304  MarkBufferDirty(metabuffer);
305  UnlockReleaseBuffer(metabuffer);
306  }
307  else
308  {
309  ReleaseBuffer(metabuffer);
310  }
311  }
312 }
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1458
void ReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3353
SpGistLUPCache lastUsedPages
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3376
#define SPGIST_METAPAGE_BLKNO
#define BufferGetPage(buffer)
Definition: bufmgr.h:159
bool ConditionalLockBuffer(Buffer buffer)
Definition: bufmgr.c:3616
SpGistLUPCache lastUsedPages
PageHeaderData * PageHeader
Definition: bufpage.h:166
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:596
#define SpGistPageGetMeta(p)
void * rd_amcache
Definition: rel.h:179
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:78

◆ spgPageIndexMultiDelete()

void spgPageIndexMultiDelete ( SpGistState state,
Page  page,
OffsetNumber itemnos,
int  nitems,
int  firststate,
int  reststate,
BlockNumber  blkno,
OffsetNumber  offnum 
)

Definition at line 131 of file spgdoinsert.c.

References cmpOffsetNumbers(), elog, ERROR, i, MaxIndexTuplesPerPage, PageAddItem, PageIndexMultiDelete(), qsort, SpGistDeadTupleData::size, spgFormDeadTuple(), SPGIST_PLACEHOLDER, SPGIST_REDIRECT, SpGistPageGetOpaque, and SpGistDeadTupleData::tupstate.

Referenced by doPickSplit(), moveLeafs(), spgRedoMoveLeafs(), spgRedoPickSplit(), spgRedoVacuumLeaf(), and vacuumLeafPage().

135 {
136  OffsetNumber firstItem;
138  SpGistDeadTuple tuple = NULL;
139  int i;
140 
141  if (nitems == 0)
142  return; /* nothing to do */
143 
144  /*
145  * For efficiency we want to use PageIndexMultiDelete, which requires the
146  * targets to be listed in sorted order, so we have to sort the itemnos
147  * array. (This also greatly simplifies the math for reinserting the
148  * replacement tuples.) However, we must not scribble on the caller's
149  * array, so we have to make a copy.
150  */
151  memcpy(sortednos, itemnos, sizeof(OffsetNumber) * nitems);
152  if (nitems > 1)
153  qsort(sortednos, nitems, sizeof(OffsetNumber), cmpOffsetNumbers);
154 
155  PageIndexMultiDelete(page, sortednos, nitems);
156 
157  firstItem = itemnos[0];
158 
159  for (i = 0; i < nitems; i++)
160  {
161  OffsetNumber itemno = sortednos[i];
162  int tupstate;
163 
164  tupstate = (itemno == firstItem) ? firststate : reststate;
165  if (tuple == NULL || tuple->tupstate != tupstate)
166  tuple = spgFormDeadTuple(state, tupstate, blkno, offnum);
167 
168  if (PageAddItem(page, (Item) tuple, tuple->size,
169  itemno, false, false) != itemno)
170  elog(ERROR, "failed to add item of size %u to SPGiST index page",
171  tuple->size);
172 
173  if (tupstate == SPGIST_REDIRECT)
174  SpGistPageGetOpaque(page)->nRedirection++;
175  else if (tupstate == SPGIST_PLACEHOLDER)
176  SpGistPageGetOpaque(page)->nPlaceholder++;
177  }
178 }
SpGistDeadTuple spgFormDeadTuple(SpGistState *state, int tupstate, BlockNumber blkno, OffsetNumber offnum)
Definition: spgutils.c:798
#define SPGIST_REDIRECT
#define SPGIST_PLACEHOLDER
Pointer Item
Definition: item.h:17
#define PageAddItem(page, item, size, offsetNumber, overwrite, is_heap)
Definition: bufpage.h:416
uint16 OffsetNumber
Definition: off.h:24
#define ERROR
Definition: elog.h:43
unsigned int tupstate
void PageIndexMultiDelete(Page page, OffsetNumber *itemnos, int nitems)
Definition: bufpage.c:835
#define SpGistPageGetOpaque(page)
#define MaxIndexTuplesPerPage
Definition: itup.h:145
#define elog(elevel,...)
Definition: elog.h:226
int i
#define qsort(a, b, c, d)
Definition: port.h:491
static int cmpOffsetNumbers(const void *a, const void *b)
Definition: spgdoinsert.c:110

◆ spgproperty()

bool spgproperty ( Oid  index_oid,
int  attno,
IndexAMProperty  prop,
const char *  propname,
bool res,
bool isnull 
)

Definition at line 966 of file spgutils.c.

References AMOPSTRATEGY, AMPROP_DISTANCE_ORDERABLE, get_index_column_opclass(), get_op_rettype(), get_opclass_opfamily_and_input_type(), GETSTRUCT, i, catclist::members, catclist::n_members, ObjectIdGetDatum, OidIsValid, opfamily_can_sort_type(), ReleaseSysCacheList, SearchSysCacheList1, and catctup::tuple.

Referenced by spghandler().

969 {
970  Oid opclass,
971  opfamily,
972  opcintype;
973  CatCList *catlist;
974  int i;
975 
976  /* Only answer column-level inquiries */
977  if (attno == 0)
978  return false;
979 
980  switch (prop)
981  {
983  break;
984  default:
985  return false;
986  }
987 
988  /*
989  * Currently, SP-GiST distance-ordered scans require that there be a
990  * distance operator in the opclass with the default types. So we assume
991  * that if such a operator exists, then there's a reason for it.
992  */
993 
994  /* First we need to know the column's opclass. */
995  opclass = get_index_column_opclass(index_oid, attno);
996  if (!OidIsValid(opclass))
997  {
998  *isnull = true;
999  return true;
1000  }
1001 
1002  /* Now look up the opclass family and input datatype. */
1003  if (!get_opclass_opfamily_and_input_type(opclass, &opfamily, &opcintype))
1004  {
1005  *isnull = true;
1006  return true;
1007  }
1008 
1009  /* And now we can check whether the operator is provided. */
1011  ObjectIdGetDatum(opfamily));
1012 
1013  *res = false;
1014 
1015  for (i = 0; i < catlist->n_members; i++)
1016  {
1017  HeapTuple amoptup = &catlist->members[i]->tuple;
1018  Form_pg_amop amopform = (Form_pg_amop) GETSTRUCT(amoptup);
1019 
1020  if (amopform->amoppurpose == AMOP_ORDER &&
1021  (amopform->amoplefttype == opcintype ||
1022  amopform->amoprighttype == opcintype) &&
1023  opfamily_can_sort_type(amopform->amopsortfamily,
1024  get_op_rettype(amopform->amopopr)))
1025  {
1026  *res = true;
1027  break;
1028  }
1029  }
1030 
1031  ReleaseSysCacheList(catlist);
1032 
1033  *isnull = false;
1034 
1035  return true;
1036 }
int n_members
Definition: catcache.h:176
#define GETSTRUCT(TUP)
Definition: htup_details.h:655
bool opfamily_can_sort_type(Oid opfamilyoid, Oid datatypeoid)
Definition: amvalidate.c:217
unsigned int Oid
Definition: postgres_ext.h:31
#define OidIsValid(objectId)
Definition: c.h:638
Oid get_op_rettype(Oid opno)
Definition: lsyscache.c:1140
CatCTup * members[FLEXIBLE_ARRAY_MEMBER]
Definition: catcache.h:178
bool get_opclass_opfamily_and_input_type(Oid opclass, Oid *opfamily, Oid *opcintype)
Definition: lsyscache.c:1064
#define ObjectIdGetDatum(X)
Definition: postgres.h:507
#define SearchSysCacheList1(cacheId, key1)
Definition: syscache.h:210
#define ReleaseSysCacheList(x)
Definition: syscache.h:217
Oid get_index_column_opclass(Oid index_oid, int attno)
Definition: lsyscache.c:3163
FormData_pg_amop * Form_pg_amop
Definition: pg_amop.h:88
int i
HeapTupleData tuple
Definition: catcache.h:121

◆ spgUpdateNodeLink()

void spgUpdateNodeLink ( SpGistInnerTuple  tup,
int  nodeN,
BlockNumber  blkno,
OffsetNumber  offset 
)

Definition at line 50 of file spgdoinsert.c.

References elog, ERROR, i, ItemPointerSet, SPPageDesc::node, SGITITERATE, and IndexTupleData::t_tid.

Referenced by saveNodeLink(), spgRedoAddLeaf(), spgRedoAddNode(), spgRedoMoveLeafs(), spgRedoPickSplit(), and spgSplitNodeAction().

52 {
53  int i;
54  SpGistNodeTuple node;
55 
56  SGITITERATE(tup, i, node)
57  {
58  if (i == nodeN)
59  {
60  ItemPointerSet(&node->t_tid, blkno, offset);
61  return;
62  }
63  }
64 
65  elog(ERROR, "failed to find requested node %d in SPGiST inner tuple",
66  nodeN);
67 }
#define SGITITERATE(x, i, nt)
ItemPointerData t_tid
Definition: itup.h:37
#define ERROR
Definition: elog.h:43
#define elog(elevel,...)
Definition: elog.h:226
int i
#define ItemPointerSet(pointer, blockNumber, offNum)
Definition: itemptr.h:127