#include "access/ginblock.h"
#include "access/itup.h"
#include "access/xlogreader.h"
#include "lib/stringinfo.h"
#include "storage/off.h"

Include dependency graph for ginxlog.h:

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

Go to the source code of this file.

Data Structures
struct	ginxlogCreatePostingTree

struct	ginxlogInsert

struct	ginxlogInsertEntry

struct	ginxlogRecompressDataLeaf

struct	ginxlogSegmentAction

struct	ginxlogInsertDataInternal

struct	ginxlogSplit

struct	ginxlogVacuumDataLeafPage

struct	ginxlogDeletePage

struct	ginxlogUpdateMeta

struct	ginxlogInsertListPage

struct	ginxlogDeleteListPages

Macros
#define	XLOG_GIN_CREATE_PTREE 0x10

#define	XLOG_GIN_INSERT 0x20

#define	GIN_SEGMENT_UNMODIFIED 0 /* no action (not used in WAL records) */

#define	GIN_SEGMENT_DELETE 1 /* a whole segment is removed */

#define	GIN_SEGMENT_INSERT 2 /* a whole segment is added */

#define	GIN_SEGMENT_REPLACE 3 /* a segment is replaced */

#define	GIN_SEGMENT_ADDITEMS 4 /* items are added to existing segment */

#define	XLOG_GIN_SPLIT 0x30

#define	GIN_INSERT_ISDATA 0x01 /* for both insert and split records */

#define	GIN_INSERT_ISLEAF 0x02 /* ditto */

#define	GIN_SPLIT_ROOT 0x04 /* only for split records */

#define	XLOG_GIN_VACUUM_PAGE 0x40

#define	XLOG_GIN_VACUUM_DATA_LEAF_PAGE 0x90

#define	XLOG_GIN_DELETE_PAGE 0x50

#define	XLOG_GIN_UPDATE_META_PAGE 0x60

#define	XLOG_GIN_INSERT_LISTPAGE 0x70

#define	XLOG_GIN_DELETE_LISTPAGE 0x80

#define	GIN_NDELETE_AT_ONCE Min(16, XLR_MAX_BLOCK_ID - 1)

Functions
void	gin_redo (XLogReaderState *record)

void	gin_desc (StringInfo buf, XLogReaderState *record)

const char *	gin_identify (uint8 info)

void	gin_xlog_startup (void)

void	gin_xlog_cleanup (void)

void	gin_mask (char *pagedata, BlockNumber blkno)

Macro Definition Documentation

◆ GIN_INSERT_ISDATA

#define GIN_INSERT_ISDATA 0x01 /* for both insert and split records */

Definition at line 124 of file ginxlog.h.

◆ GIN_INSERT_ISLEAF

#define GIN_INSERT_ISLEAF 0x02 /* ditto */

Definition at line 125 of file ginxlog.h.

◆ GIN_NDELETE_AT_ONCE

#define GIN_NDELETE_AT_ONCE Min(16, XLR_MAX_BLOCK_ID - 1)

Definition at line 205 of file ginxlog.h.

◆ GIN_SEGMENT_ADDITEMS

#define GIN_SEGMENT_ADDITEMS 4 /* items are added to existing segment */

Definition at line 95 of file ginxlog.h.

◆ GIN_SEGMENT_DELETE

#define GIN_SEGMENT_DELETE 1 /* a whole segment is removed */

Definition at line 92 of file ginxlog.h.

◆ GIN_SEGMENT_INSERT

#define GIN_SEGMENT_INSERT 2 /* a whole segment is added */

Definition at line 93 of file ginxlog.h.

◆ GIN_SEGMENT_REPLACE

#define GIN_SEGMENT_REPLACE 3 /* a segment is replaced */

Definition at line 94 of file ginxlog.h.

◆ GIN_SEGMENT_UNMODIFIED

#define GIN_SEGMENT_UNMODIFIED 0 /* no action (not used in WAL records) */

Definition at line 91 of file ginxlog.h.

◆ GIN_SPLIT_ROOT

#define GIN_SPLIT_ROOT 0x04 /* only for split records */

Definition at line 126 of file ginxlog.h.

◆ XLOG_GIN_CREATE_PTREE

#define XLOG_GIN_CREATE_PTREE 0x10

Definition at line 19 of file ginxlog.h.

◆ XLOG_GIN_DELETE_LISTPAGE

#define XLOG_GIN_DELETE_LISTPAGE 0x80

Definition at line 197 of file ginxlog.h.

◆ XLOG_GIN_DELETE_PAGE

#define XLOG_GIN_DELETE_PAGE 0x50

Definition at line 153 of file ginxlog.h.

◆ XLOG_GIN_INSERT

#define XLOG_GIN_INSERT 0x20

Definition at line 35 of file ginxlog.h.

◆ XLOG_GIN_INSERT_LISTPAGE

#define XLOG_GIN_INSERT_LISTPAGE 0x70

Definition at line 180 of file ginxlog.h.

◆ XLOG_GIN_SPLIT

#define XLOG_GIN_SPLIT 0x30

Definition at line 109 of file ginxlog.h.

◆ XLOG_GIN_UPDATE_META_PAGE

#define XLOG_GIN_UPDATE_META_PAGE 0x60

Definition at line 162 of file ginxlog.h.

◆ XLOG_GIN_VACUUM_DATA_LEAF_PAGE

#define XLOG_GIN_VACUUM_DATA_LEAF_PAGE 0x90

Definition at line 141 of file ginxlog.h.

◆ XLOG_GIN_VACUUM_PAGE

#define XLOG_GIN_VACUUM_PAGE 0x40

Definition at line 135 of file ginxlog.h.

Typedef Documentation

◆ ginxlogCreatePostingTree

typedef struct ginxlogCreatePostingTree ginxlogCreatePostingTree

◆ ginxlogDeleteListPages

typedef struct ginxlogDeleteListPages ginxlogDeleteListPages

◆ ginxlogDeletePage

typedef struct ginxlogDeletePage ginxlogDeletePage

◆ ginxlogInsertListPage

typedef struct ginxlogInsertListPage ginxlogInsertListPage

◆ ginxlogSplit

typedef struct ginxlogSplit ginxlogSplit

◆ ginxlogUpdateMeta

typedef struct ginxlogUpdateMeta ginxlogUpdateMeta

◆ ginxlogVacuumDataLeafPage

typedef struct ginxlogVacuumDataLeafPage ginxlogVacuumDataLeafPage

Function Documentation

◆ gin_desc()

void gin_desc	(	StringInfo	buf,
		XLogReaderState *	record
	)

extern

Definition at line 72 of file gindesc.c.

{
    char       *rec = XLogRecGetData(record);
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    switch (info)
    {
        case XLOG_GIN_CREATE_PTREE:
            /* no further information */
            break;
        case XLOG_GIN_INSERT:
            {
                ginxlogInsert *xlrec = (ginxlogInsert *) rec;
 
                appendStringInfo(buf, "isdata: %c isleaf: %c",
                                 (xlrec->flags & GIN_INSERT_ISDATA) ? 'T' : 'F',
                                 (xlrec->flags & GIN_INSERT_ISLEAF) ? 'T' : 'F');
                if (!(xlrec->flags & GIN_INSERT_ISLEAF))
                {
                    char       *payload = rec + sizeof(ginxlogInsert);
                    BlockNumber leftChildBlkno;
                    BlockNumber rightChildBlkno;
 
                    leftChildBlkno = BlockIdGetBlockNumber((BlockId) payload);
                    payload += sizeof(BlockIdData);
                    rightChildBlkno = BlockIdGetBlockNumber((BlockId) payload);
                    payload += sizeof(BlockNumber);
                    appendStringInfo(buf, " children: %u/%u",
                                     leftChildBlkno, rightChildBlkno);
                }
                if (!XLogRecHasBlockImage(record, 0))
                {
                    char       *payload = XLogRecGetBlockData(record, 0, NULL);
 
                    if (!(xlrec->flags & GIN_INSERT_ISDATA))
                        appendStringInfo(buf, " isdelete: %c",
                                         (((ginxlogInsertEntry *) payload)->isDelete) ? 'T' : 'F');
                    else if (xlrec->flags & GIN_INSERT_ISLEAF)
                        desc_recompress_leaf(buf, (ginxlogRecompressDataLeaf *) payload);
                    else
                    {
                        ginxlogInsertDataInternal *insertData =
                            (ginxlogInsertDataInternal *) payload;
 
                        appendStringInfo(buf, " pitem: %u-%u/%u",
                                         PostingItemGetBlockNumber(&insertData->newitem),
                                         ItemPointerGetBlockNumber(&insertData->newitem.key),
                                         ItemPointerGetOffsetNumber(&insertData->newitem.key));
                    }
                }
            }
            break;
        case XLOG_GIN_SPLIT:
            {
                ginxlogSplit *xlrec = (ginxlogSplit *) rec;
 
                appendStringInfo(buf, "isrootsplit: %c",
                                 (((ginxlogSplit *) rec)->flags & GIN_SPLIT_ROOT) ? 'T' : 'F');
                appendStringInfo(buf, " isdata: %c isleaf: %c",
                                 (xlrec->flags & GIN_INSERT_ISDATA) ? 'T' : 'F',
                                 (xlrec->flags & GIN_INSERT_ISLEAF) ? 'T' : 'F');
                if (xlrec->leftChildBlkno != InvalidBlockNumber)
                    appendStringInfo(buf, " children: %u/%u",
                                     xlrec->leftChildBlkno, xlrec->rightChildBlkno);
            }
            break;
        case XLOG_GIN_VACUUM_PAGE:
            /* no further information */
            break;
        case XLOG_GIN_VACUUM_DATA_LEAF_PAGE:
            {
                if (!XLogRecHasBlockImage(record, 0))
                {
                    ginxlogVacuumDataLeafPage *xlrec =
                        (ginxlogVacuumDataLeafPage *) XLogRecGetBlockData(record, 0, NULL);
 
                    desc_recompress_leaf(buf, &xlrec->data);
                }
            }
            break;
        case XLOG_GIN_DELETE_PAGE:
            /* no further information */
            break;
        case XLOG_GIN_UPDATE_META_PAGE:
            {
                ginxlogUpdateMeta *xlrec = (ginxlogUpdateMeta *) rec;
 
                appendStringInfo(buf, "ntuples: %d", xlrec->ntuples);
                if (xlrec->prevTail != InvalidBlockNumber)
                    appendStringInfo(buf, " prevTail: %u",
                                     xlrec->prevTail);
                if (xlrec->newRightlink != InvalidBlockNumber)
                    appendStringInfo(buf, " newRightlink: %u",
                                     xlrec->newRightlink);
            }
            break;
        case XLOG_GIN_INSERT_LISTPAGE:
            {
                ginxlogInsertListPage *xlrec = (ginxlogInsertListPage *) rec;
 
                appendStringInfo(buf, "ntuples: %d", xlrec->ntuples);
                if (xlrec->rightlink != InvalidBlockNumber)
                    appendStringInfo(buf, " rightlink: %u",
                                     xlrec->rightlink);
            }
            break;
        case XLOG_GIN_DELETE_LISTPAGE:
            appendStringInfo(buf, "ndeleted: %d",
                             ((ginxlogDeleteListPages *) rec)->ndeleted);
            break;
    }
}

References appendStringInfo(), BlockIdGetBlockNumber(), buf, desc_recompress_leaf(), fb(), GIN_INSERT_ISDATA, GIN_INSERT_ISLEAF, GIN_SPLIT_ROOT, InvalidBlockNumber, ItemPointerGetBlockNumber(), ItemPointerGetOffsetNumber(), PostingItemGetBlockNumber, XLOG_GIN_CREATE_PTREE, XLOG_GIN_DELETE_LISTPAGE, XLOG_GIN_DELETE_PAGE, XLOG_GIN_INSERT, XLOG_GIN_INSERT_LISTPAGE, XLOG_GIN_SPLIT, XLOG_GIN_UPDATE_META_PAGE, XLOG_GIN_VACUUM_DATA_LEAF_PAGE, XLOG_GIN_VACUUM_PAGE, XLogRecGetBlockData(), XLogRecGetData, XLogRecGetInfo, and XLogRecHasBlockImage.

◆ gin_identify()

const char * gin_identify ( uint8 info )

extern

Definition at line 186 of file gindesc.c.

{
    const char *id = NULL;
 
    switch (info & ~XLR_INFO_MASK)
    {
        case XLOG_GIN_CREATE_PTREE:
            id = "CREATE_PTREE";
            break;
        case XLOG_GIN_INSERT:
            id = "INSERT";
            break;
        case XLOG_GIN_SPLIT:
            id = "SPLIT";
            break;
        case XLOG_GIN_VACUUM_PAGE:
            id = "VACUUM_PAGE";
            break;
        case XLOG_GIN_VACUUM_DATA_LEAF_PAGE:
            id = "VACUUM_DATA_LEAF_PAGE";
            break;
        case XLOG_GIN_DELETE_PAGE:
            id = "DELETE_PAGE";
            break;
        case XLOG_GIN_UPDATE_META_PAGE:
            id = "UPDATE_META_PAGE";
            break;
        case XLOG_GIN_INSERT_LISTPAGE:
            id = "INSERT_LISTPAGE";
            break;
        case XLOG_GIN_DELETE_LISTPAGE:
            id = "DELETE_LISTPAGE";
            break;
    }
 
    return id;
}

References fb(), XLOG_GIN_CREATE_PTREE, XLOG_GIN_DELETE_LISTPAGE, XLOG_GIN_DELETE_PAGE, XLOG_GIN_INSERT, XLOG_GIN_INSERT_LISTPAGE, XLOG_GIN_SPLIT, XLOG_GIN_UPDATE_META_PAGE, XLOG_GIN_VACUUM_DATA_LEAF_PAGE, XLOG_GIN_VACUUM_PAGE, and XLR_INFO_MASK.

◆ gin_mask()

void gin_mask	(	char *	pagedata,
		BlockNumber	blkno
	)

extern

Definition at line 791 of file ginxlog.c.

{
    Page        page = (Page) pagedata;
    PageHeader  pagehdr = (PageHeader) page;
    GinPageOpaque opaque;
 
    mask_page_lsn_and_checksum(page);
    opaque = GinPageGetOpaque(page);
 
    mask_page_hint_bits(page);
 
    /*
     * For a GIN_DELETED page, the page is initialized to empty.  Hence, mask
     * the whole page content.  For other pages, mask the hole if pd_lower
     * appears to have been set correctly.
     */
    if (opaque->flags & GIN_DELETED)
        mask_page_content(page);
    else if (pagehdr->pd_lower > SizeOfPageHeaderData)
        mask_unused_space(page);
}

References fb(), GinPageOpaqueData::flags, GIN_DELETED, GinPageGetOpaque, mask_page_content(), mask_page_hint_bits(), mask_page_lsn_and_checksum(), mask_unused_space(), and SizeOfPageHeaderData.

◆ gin_redo()

void gin_redo ( XLogReaderState * record )

extern

Definition at line 724 of file ginxlog.c.

{
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
    MemoryContext oldCtx;
 
    /*
     * GIN indexes do not require any conflict processing. NB: If we ever
     * implement a similar optimization as we have in b-tree, and remove
     * killed tuples outside VACUUM, we'll need to handle that here.
     */
 
    oldCtx = MemoryContextSwitchTo(opCtx);
    switch (info)
    {
        case XLOG_GIN_CREATE_PTREE:
            ginRedoCreatePTree(record);
            break;
        case XLOG_GIN_INSERT:
            ginRedoInsert(record);
            break;
        case XLOG_GIN_SPLIT:
            ginRedoSplit(record);
            break;
        case XLOG_GIN_VACUUM_PAGE:
            ginRedoVacuumPage(record);
            break;
        case XLOG_GIN_VACUUM_DATA_LEAF_PAGE:
            ginRedoVacuumDataLeafPage(record);
            break;
        case XLOG_GIN_DELETE_PAGE:
            ginRedoDeletePage(record);
            break;
        case XLOG_GIN_UPDATE_META_PAGE:
            ginRedoUpdateMetapage(record);
            break;
        case XLOG_GIN_INSERT_LISTPAGE:
            ginRedoInsertListPage(record);
            break;
        case XLOG_GIN_DELETE_LISTPAGE:
            ginRedoDeleteListPages(record);
            break;
        default:
            elog(PANIC, "gin_redo: unknown op code %u", info);
    }
    MemoryContextSwitchTo(oldCtx);
    MemoryContextReset(opCtx);
}

References elog, fb(), ginRedoCreatePTree(), ginRedoDeleteListPages(), ginRedoDeletePage(), ginRedoInsert(), ginRedoInsertListPage(), ginRedoSplit(), ginRedoUpdateMetapage(), ginRedoVacuumDataLeafPage(), ginRedoVacuumPage(), MemoryContextReset(), MemoryContextSwitchTo(), opCtx, PANIC, XLOG_GIN_CREATE_PTREE, XLOG_GIN_DELETE_LISTPAGE, XLOG_GIN_DELETE_PAGE, XLOG_GIN_INSERT, XLOG_GIN_INSERT_LISTPAGE, XLOG_GIN_SPLIT, XLOG_GIN_UPDATE_META_PAGE, XLOG_GIN_VACUUM_DATA_LEAF_PAGE, XLOG_GIN_VACUUM_PAGE, and XLogRecGetInfo.

◆ gin_xlog_cleanup()

void gin_xlog_cleanup ( void )

extern

Definition at line 781 of file ginxlog.c.

{
    MemoryContextDelete(opCtx);
    opCtx = NULL;
}

References fb(), MemoryContextDelete(), and opCtx.

◆ gin_xlog_startup()

void gin_xlog_startup ( void )

extern

Definition at line 773 of file ginxlog.c.

{
    opCtx = AllocSetContextCreate(CurrentMemoryContext,
                                  "GIN recovery temporary context",
                                  ALLOCSET_DEFAULT_SIZES);
}

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, CurrentMemoryContext, and opCtx.

Typedefs
typedef struct ginxlogCreatePostingTree	ginxlogCreatePostingTree

typedef struct ginxlogSplit	ginxlogSplit

typedef struct ginxlogVacuumDataLeafPage	ginxlogVacuumDataLeafPage

typedef struct ginxlogDeletePage	ginxlogDeletePage

typedef struct ginxlogUpdateMeta	ginxlogUpdateMeta

typedef struct ginxlogInsertListPage	ginxlogInsertListPage

typedef struct ginxlogDeleteListPages	ginxlogDeleteListPages

Data Structures

Macros

Typedefs

Functions

Macro Definition Documentation

◆ GIN_INSERT_ISDATA

◆ GIN_INSERT_ISLEAF

◆ GIN_NDELETE_AT_ONCE

◆ GIN_SEGMENT_ADDITEMS

◆ GIN_SEGMENT_DELETE

◆ GIN_SEGMENT_INSERT

◆ GIN_SEGMENT_REPLACE

◆ GIN_SEGMENT_UNMODIFIED

◆ GIN_SPLIT_ROOT

◆ XLOG_GIN_CREATE_PTREE

◆ XLOG_GIN_DELETE_LISTPAGE

◆ XLOG_GIN_DELETE_PAGE

◆ XLOG_GIN_INSERT

◆ XLOG_GIN_INSERT_LISTPAGE

◆ XLOG_GIN_SPLIT

◆ XLOG_GIN_UPDATE_META_PAGE

◆ XLOG_GIN_VACUUM_DATA_LEAF_PAGE

◆ XLOG_GIN_VACUUM_PAGE

Typedef Documentation

◆ ginxlogCreatePostingTree

◆ ginxlogDeleteListPages

◆ ginxlogDeletePage

◆ ginxlogInsertListPage

◆ ginxlogSplit

◆ ginxlogUpdateMeta

◆ ginxlogVacuumDataLeafPage

Function Documentation

◆ gin_desc()

◆ gin_identify()

◆ gin_mask()

◆ gin_redo()

◆ gin_xlog_cleanup()

◆ gin_xlog_startup()