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	GIN_OPTIONS_PROC   7
#define	GINNProcs   7
#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	PG_RETURN_GIN_TERNARY_VALUE(x)   return GinTernaryValueGetDatum(x)

Typedefs
typedef struct GinStatsData	GinStatsData
typedef char	GinTernaryValue

Functions
	StaticAssertDecl (sizeof(GinTernaryValue)==sizeof(bool), "sizes of GinTernaryValue and bool are not equal")
static GinTernaryValue	DatumGetGinTernaryValue (Datum X)
static Datum	GinTernaryValueGetDatum (GinTernaryValue X)
void	ginGetStats (Relation index, GinStatsData *stats)
void	ginUpdateStats (Relation index, const GinStatsData *stats, bool is_build)

Variables
PGDLLIMPORT int	GinFuzzySearchLimit
PGDLLIMPORT int	gin_pending_list_limit

Macro Definition Documentation

GIN_COMPARE_PARTIAL_PROC

#define GIN_COMPARE_PARTIAL_PROC   5

Definition at line 26 of file gin.h.

GIN_COMPARE_PROC

#define GIN_COMPARE_PROC   1

Definition at line 22 of file gin.h.

GIN_CONSISTENT_PROC

#define GIN_CONSISTENT_PROC   4

Definition at line 25 of file gin.h.

GIN_EXTRACTQUERY_PROC

#define GIN_EXTRACTQUERY_PROC   3

Definition at line 24 of file gin.h.

GIN_EXTRACTVALUE_PROC

#define GIN_EXTRACTVALUE_PROC   2

Definition at line 23 of file gin.h.

GIN_FALSE

#define GIN_FALSE   0 /* item is not present / does not match */

Definition at line 63 of file gin.h.

GIN_MAYBE

#define GIN_MAYBE

Value:

                                 2      /* don't know if item is present / don't know
                                 * if matches */

Definition at line 65 of file gin.h.

GIN_OPTIONS_PROC

#define GIN_OPTIONS_PROC   7

Definition at line 28 of file gin.h.

GIN_SEARCH_MODE_ALL

#define GIN_SEARCH_MODE_ALL   2

Definition at line 36 of file gin.h.

GIN_SEARCH_MODE_DEFAULT

#define GIN_SEARCH_MODE_DEFAULT   0

Definition at line 34 of file gin.h.

GIN_SEARCH_MODE_EVERYTHING

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

Definition at line 37 of file gin.h.

GIN_SEARCH_MODE_INCLUDE_EMPTY

#define GIN_SEARCH_MODE_INCLUDE_EMPTY   1

Definition at line 35 of file gin.h.

GIN_TRICONSISTENT_PROC

#define GIN_TRICONSISTENT_PROC   6

Definition at line 27 of file gin.h.

GIN_TRUE

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

Definition at line 64 of file gin.h.

GINNProcs

#define GINNProcs   7

Definition at line 29 of file gin.h.

PG_RETURN_GIN_TERNARY_VALUE

#define PG_RETURN_GIN_TERNARY_VALUE

(

x

)

return GinTernaryValueGetDatum(x)

Definition at line 79 of file gin.h.

Typedef Documentation

GinStatsData

typedef struct GinStatsData GinStatsData

GinTernaryValue

typedef char GinTernaryValue

Definition at line 58 of file gin.h.

Function Documentation

DatumGetGinTernaryValue()

static GinTernaryValue DatumGetGinTernaryValue ( Datum  X )

inlinestatic

Definition at line 68 of file gin.h.

{
    return (GinTernaryValue) X;

Referenced by directTriConsistentFn(), and shimBoolConsistentFn().

ginGetStats()

void ginGetStats	(	Relation	index,
		GinStatsData *	stats
	)

Definition at line 623 of file ginutil.c.

{
    Buffer      metabuffer;
    Page        metapage;
    GinMetaPageData *metadata;
 
    metabuffer = ReadBuffer(index, GIN_METAPAGE_BLKNO);
    LockBuffer(metabuffer, GIN_SHARE);
    metapage = BufferGetPage(metabuffer);
    metadata = GinPageGetMeta(metapage);
 
    stats->nPendingPages = metadata->nPendingPages;
    stats->nTotalPages = metadata->nTotalPages;
    stats->nEntryPages = metadata->nEntryPages;
    stats->nDataPages = metadata->nDataPages;
    stats->nEntries = metadata->nEntries;
    stats->ginVersion = metadata->ginVersion;
 
    UnlockReleaseBuffer(metabuffer);
}

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().

GinTernaryValueGetDatum()

static Datum GinTernaryValueGetDatum ( GinTernaryValue  X )

inlinestatic

Definition at line 74 of file gin.h.

{
    return (Datum) X;

ginUpdateStats()

void ginUpdateStats	(	Relation	index,
		const GinStatsData *	stats,
		bool	is_build
	)

Definition at line 650 of file ginutil.c.

{
    Buffer      metabuffer;
    Page        metapage;
    GinMetaPageData *metadata;
 
    metabuffer = ReadBuffer(index, GIN_METAPAGE_BLKNO);
    LockBuffer(metabuffer, GIN_EXCLUSIVE);
    metapage = BufferGetPage(metabuffer);
    metadata = GinPageGetMeta(metapage);
 
    START_CRIT_SECTION();
 
    metadata->nTotalPages = stats->nTotalPages;
    metadata->nEntryPages = stats->nEntryPages;
    metadata->nDataPages = stats->nDataPages;
    metadata->nEntries = stats->nEntries;
 
    /*
     * Set pd_lower just past the end of the metadata.  This is essential,
     * because without doing so, metadata will be lost if xlog.c compresses
     * the page.  (We must do this here because pre-v11 versions of PG did not
     * set the metapage's pd_lower correctly, so a pg_upgraded index might
     * contain the wrong value.)
     */
    ((PageHeader) metapage)->pd_lower =
        ((char *) metadata + sizeof(GinMetaPageData)) - (char *) metapage;
 
    MarkBufferDirty(metabuffer);
 
    if (RelationNeedsWAL(index) && !is_build)
    {
        XLogRecPtr  recptr;
        ginxlogUpdateMeta data;
 
        data.locator = index->rd_locator;
        data.ntuples = 0;
        data.newRightlink = data.prevTail = InvalidBlockNumber;
        memcpy(&data.metadata, metadata, sizeof(GinMetaPageData));
 
        XLogBeginInsert();
        XLogRegisterData((char *) &data, sizeof(ginxlogUpdateMeta));
        XLogRegisterBuffer(0, metabuffer, REGBUF_WILL_INIT | REGBUF_STANDARD);
 
        recptr = XLogInsert(RM_GIN_ID, XLOG_GIN_UPDATE_META_PAGE);
        PageSetLSN(metapage, recptr);
    }
 
    UnlockReleaseBuffer(metabuffer);
 
    END_CRIT_SECTION();
}

References BufferGetPage(), data, END_CRIT_SECTION, GIN_EXCLUSIVE, GIN_METAPAGE_BLKNO, GinPageGetMeta, InvalidBlockNumber, LockBuffer(), MarkBufferDirty(), GinStatsData::nDataPages, GinMetaPageData::nDataPages, GinStatsData::nEntries, GinMetaPageData::nEntries, GinStatsData::nEntryPages, GinMetaPageData::nEntryPages, GinStatsData::nTotalPages, GinMetaPageData::nTotalPages, PageSetLSN(), 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().

StaticAssertDecl()

StaticAssertDecl	(	sizeof(GinTernaryValue)	= =sizeof(bool),
		"sizes of GinTernaryValue and bool are not equal"
	)

Variable Documentation

gin_pending_list_limit

PGDLLIMPORT int gin_pending_list_limit

extern

Definition at line 39 of file ginfast.c.

GinFuzzySearchLimit

PGDLLIMPORT int GinFuzzySearchLimit

extern

Definition at line 27 of file ginget.c.

Referenced by startScan().