PostgreSQL Source Code  git master
gin.h File Reference
#include "access/xlogreader.h"
#include "lib/stringinfo.h"
#include "storage/block.h"
#include "utils/relcache.h"
Include dependency graph for gin.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  GinStatsData
 

Macros

#define GIN_COMPARE_PROC   1
 
#define GIN_EXTRACTVALUE_PROC   2
 
#define GIN_EXTRACTQUERY_PROC   3
 
#define GIN_CONSISTENT_PROC   4
 
#define GIN_COMPARE_PARTIAL_PROC   5
 
#define GIN_TRICONSISTENT_PROC   6
 
#define GINNProcs   6
 
#define GIN_SEARCH_MODE_DEFAULT   0
 
#define GIN_SEARCH_MODE_INCLUDE_EMPTY   1
 
#define GIN_SEARCH_MODE_ALL   2
 
#define GIN_SEARCH_MODE_EVERYTHING   3 /* for internal use only */
 
#define GIN_FALSE   0 /* item is not present / does not match */
 
#define GIN_TRUE   1 /* item is present / matches */
 
#define GIN_MAYBE
 
#define DatumGetGinTernaryValue(X)   ((GinTernaryValue)(X))
 
#define GinTernaryValueGetDatum(X)   ((Datum)(X))
 
#define PG_RETURN_GIN_TERNARY_VALUE(x)   return GinTernaryValueGetDatum(x)
 

Typedefs

typedef struct GinStatsData GinStatsData
 
typedef char GinTernaryValue
 

Functions

void ginGetStats (Relation index, GinStatsData *stats)
 
void ginUpdateStats (Relation index, const GinStatsData *stats)
 

Variables

PGDLLIMPORT int GinFuzzySearchLimit
 
int gin_pending_list_limit
 

Macro Definition Documentation

◆ DatumGetGinTernaryValue

#define DatumGetGinTernaryValue (   X)    ((GinTernaryValue)(X))

Definition at line 64 of file gin.h.

Referenced by directTriConsistentFn(), and shimBoolConsistentFn().

◆ GIN_COMPARE_PARTIAL_PROC

#define GIN_COMPARE_PARTIAL_PROC   5

Definition at line 26 of file gin.h.

Referenced by ginvalidate(), and initGinState().

◆ GIN_COMPARE_PROC

#define GIN_COMPARE_PROC   1

Definition at line 22 of file gin.h.

Referenced by ginvalidate(), and initGinState().

◆ GIN_CONSISTENT_PROC

#define GIN_CONSISTENT_PROC   4

Definition at line 25 of file gin.h.

Referenced by ginvalidate(), and initGinState().

◆ GIN_EXTRACTQUERY_PROC

#define GIN_EXTRACTQUERY_PROC   3

Definition at line 24 of file gin.h.

Referenced by gincost_pattern(), ginvalidate(), and initGinState().

◆ GIN_EXTRACTVALUE_PROC

#define GIN_EXTRACTVALUE_PROC   2

Definition at line 23 of file gin.h.

Referenced by ginvalidate(), and initGinState().

◆ GIN_FALSE

◆ GIN_MAYBE

#define GIN_MAYBE

◆ GIN_SEARCH_MODE_ALL

◆ GIN_SEARCH_MODE_DEFAULT

#define GIN_SEARCH_MODE_DEFAULT   0

◆ GIN_SEARCH_MODE_EVERYTHING

#define GIN_SEARCH_MODE_EVERYTHING   3 /* for internal use only */

Definition at line 36 of file gin.h.

Referenced by ginFillScanKey(), ginInitConsistentFunction(), and ginNewScanKey().

◆ GIN_SEARCH_MODE_INCLUDE_EMPTY

#define GIN_SEARCH_MODE_INCLUDE_EMPTY   1

Definition at line 34 of file gin.h.

Referenced by gincost_pattern(), ginFillScanKey(), ginint4_queryextract(), and ginqueryarrayextract().

◆ GIN_TRICONSISTENT_PROC

#define GIN_TRICONSISTENT_PROC   6

Definition at line 27 of file gin.h.

Referenced by ginvalidate(), and initGinState().

◆ GIN_TRUE

#define GIN_TRUE   1 /* item is present / matches */

◆ GINNProcs

#define GINNProcs   6

Definition at line 28 of file gin.h.

Referenced by ginhandler(), and ginvalidate().

◆ GinTernaryValueGetDatum

#define GinTernaryValueGetDatum (   X)    ((Datum)(X))

Definition at line 65 of file gin.h.

◆ PG_RETURN_GIN_TERNARY_VALUE

#define PG_RETURN_GIN_TERNARY_VALUE (   x)    return GinTernaryValueGetDatum(x)

Typedef Documentation

◆ GinStatsData

◆ GinTernaryValue

Definition at line 57 of file gin.h.

Function Documentation

◆ ginGetStats()

void ginGetStats ( Relation  index,
GinStatsData stats 
)

Definition at line 642 of file ginutil.c.

References BufferGetPage, GIN_METAPAGE_BLKNO, GIN_SHARE, GinPageGetMeta, GinStatsData::ginVersion, GinMetaPageData::ginVersion, LockBuffer(), GinStatsData::nDataPages, GinMetaPageData::nDataPages, GinStatsData::nEntries, GinMetaPageData::nEntries, GinStatsData::nEntryPages, GinMetaPageData::nEntryPages, GinStatsData::nPendingPages, GinMetaPageData::nPendingPages, GinStatsData::nTotalPages, GinMetaPageData::nTotalPages, ReadBuffer(), and UnlockReleaseBuffer().

Referenced by gincostestimate(), and ginNewScanKey().

643 {
644  Buffer metabuffer;
645  Page metapage;
646  GinMetaPageData *metadata;
647 
648  metabuffer = ReadBuffer(index, GIN_METAPAGE_BLKNO);
649  LockBuffer(metabuffer, GIN_SHARE);
650  metapage = BufferGetPage(metabuffer);
651  metadata = GinPageGetMeta(metapage);
652 
653  stats->nPendingPages = metadata->nPendingPages;
654  stats->nTotalPages = metadata->nTotalPages;
655  stats->nEntryPages = metadata->nEntryPages;
656  stats->nDataPages = metadata->nDataPages;
657  stats->nEntries = metadata->nEntries;
658  stats->ginVersion = metadata->ginVersion;
659 
660  UnlockReleaseBuffer(metabuffer);
661 }
BlockNumber nEntryPages
Definition: ginblock.h:79
BlockNumber nEntryPages
Definition: gin.h:45
int64 nEntries
Definition: gin.h:47
BlockNumber nTotalPages
Definition: ginblock.h:78
#define GIN_METAPAGE_BLKNO
Definition: ginblock.h:50
int64 nEntries
Definition: ginblock.h:81
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3332
#define BufferGetPage(buffer)
Definition: bufmgr.h:160
#define GIN_SHARE
Definition: gin_private.h:44
BlockNumber nPendingPages
Definition: gin.h:43
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3546
BlockNumber nDataPages
Definition: gin.h:46
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:594
BlockNumber nTotalPages
Definition: gin.h:44
int32 ginVersion
Definition: ginblock.h:98
int32 ginVersion
Definition: gin.h:48
BlockNumber nDataPages
Definition: ginblock.h:80
#define GinPageGetMeta(p)
Definition: ginblock.h:103
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:74
BlockNumber nPendingPages
Definition: ginblock.h:72

◆ ginUpdateStats()

void ginUpdateStats ( Relation  index,
const GinStatsData stats 
)

Definition at line 669 of file ginutil.c.

References BufferGetPage, END_CRIT_SECTION, GIN_EXCLUSIVE, GIN_METAPAGE_BLKNO, GinPageGetMeta, InvalidBlockNumber, LockBuffer(), MarkBufferDirty(), ginxlogUpdateMeta::metadata, GinStatsData::nDataPages, GinMetaPageData::nDataPages, GinStatsData::nEntries, GinMetaPageData::nEntries, GinStatsData::nEntryPages, GinMetaPageData::nEntryPages, ginxlogUpdateMeta::newRightlink, ginxlogUpdateMeta::node, GinStatsData::nTotalPages, GinMetaPageData::nTotalPages, ginxlogUpdateMeta::ntuples, PageSetLSN, ginxlogUpdateMeta::prevTail, RelationData::rd_node, ReadBuffer(), REGBUF_STANDARD, REGBUF_WILL_INIT, RelationNeedsWAL, START_CRIT_SECTION, UnlockReleaseBuffer(), XLOG_GIN_UPDATE_META_PAGE, XLogBeginInsert(), XLogInsert(), XLogRegisterBuffer(), and XLogRegisterData().

Referenced by ginbuild(), and ginvacuumcleanup().

670 {
671  Buffer metabuffer;
672  Page metapage;
673  GinMetaPageData *metadata;
674 
675  metabuffer = ReadBuffer(index, GIN_METAPAGE_BLKNO);
676  LockBuffer(metabuffer, GIN_EXCLUSIVE);
677  metapage = BufferGetPage(metabuffer);
678  metadata = GinPageGetMeta(metapage);
679 
681 
682  metadata->nTotalPages = stats->nTotalPages;
683  metadata->nEntryPages = stats->nEntryPages;
684  metadata->nDataPages = stats->nDataPages;
685  metadata->nEntries = stats->nEntries;
686 
687  /*
688  * Set pd_lower just past the end of the metadata. This is essential,
689  * because without doing so, metadata will be lost if xlog.c compresses
690  * the page. (We must do this here because pre-v11 versions of PG did not
691  * set the metapage's pd_lower correctly, so a pg_upgraded index might
692  * contain the wrong value.)
693  */
694  ((PageHeader) metapage)->pd_lower =
695  ((char *) metadata + sizeof(GinMetaPageData)) - (char *) metapage;
696 
697  MarkBufferDirty(metabuffer);
698 
699  if (RelationNeedsWAL(index))
700  {
701  XLogRecPtr recptr;
702  ginxlogUpdateMeta data;
703 
704  data.node = index->rd_node;
705  data.ntuples = 0;
707  memcpy(&data.metadata, metadata, sizeof(GinMetaPageData));
708 
709  XLogBeginInsert();
710  XLogRegisterData((char *) &data, sizeof(ginxlogUpdateMeta));
712 
713  recptr = XLogInsert(RM_GIN_ID, XLOG_GIN_UPDATE_META_PAGE);
714  PageSetLSN(metapage, recptr);
715  }
716 
717  UnlockReleaseBuffer(metabuffer);
718 
720 }
BlockNumber nEntryPages
Definition: ginblock.h:79
BlockNumber prevTail
Definition: ginxlog.h:173
BlockNumber nEntryPages
Definition: gin.h:45
RelFileNode node
Definition: ginxlog.h:171
void MarkBufferDirty(Buffer buffer)
Definition: bufmgr.c:1450
void XLogRegisterBuffer(uint8 block_id, Buffer buffer, uint8 flags)
Definition: xloginsert.c:213
#define END_CRIT_SECTION()
Definition: miscadmin.h:133
#define REGBUF_WILL_INIT
Definition: xloginsert.h:32
#define START_CRIT_SECTION()
Definition: miscadmin.h:131
int64 nEntries
Definition: gin.h:47
BlockNumber nTotalPages
Definition: ginblock.h:78
#define GIN_METAPAGE_BLKNO
Definition: ginblock.h:50
int64 nEntries
Definition: ginblock.h:81
void UnlockReleaseBuffer(Buffer buffer)
Definition: bufmgr.c:3332
#define XLOG_GIN_UPDATE_META_PAGE
Definition: ginxlog.h:163
#define REGBUF_STANDARD
Definition: xloginsert.h:34
#define BufferGetPage(buffer)
Definition: bufmgr.h:160
BlockNumber newRightlink
Definition: ginxlog.h:174
void XLogRegisterData(char *data, int len)
Definition: xloginsert.c:323
XLogRecPtr XLogInsert(RmgrId rmid, uint8 info)
Definition: xloginsert.c:415
#define GIN_EXCLUSIVE
Definition: gin_private.h:45
void LockBuffer(Buffer buffer, int mode)
Definition: bufmgr.c:3546
BlockNumber nDataPages
Definition: gin.h:46
GinMetaPageData metadata
Definition: ginxlog.h:172
RelFileNode rd_node
Definition: rel.h:85
PageHeaderData * PageHeader
Definition: bufpage.h:162
uint64 XLogRecPtr
Definition: xlogdefs.h:21
Buffer ReadBuffer(Relation reln, BlockNumber blockNum)
Definition: bufmgr.c:594
#define InvalidBlockNumber
Definition: block.h:33
BlockNumber nTotalPages
Definition: gin.h:44
#define RelationNeedsWAL(relation)
Definition: rel.h:514
BlockNumber nDataPages
Definition: ginblock.h:80
#define GinPageGetMeta(p)
Definition: ginblock.h:103
void XLogBeginInsert(void)
Definition: xloginsert.c:120
#define PageSetLSN(page, lsn)
Definition: bufpage.h:364
int Buffer
Definition: buf.h:23
Pointer Page
Definition: bufpage.h:74

Variable Documentation

◆ gin_pending_list_limit

int gin_pending_list_limit

Definition at line 37 of file ginfast.c.

◆ GinFuzzySearchLimit

PGDLLIMPORT int GinFuzzySearchLimit

Definition at line 24 of file ginget.c.

Referenced by startScan().