gistxlog.h File Reference

#include "access/gist.h"
#include "access/xlogreader.h"
#include "lib/stringinfo.h"

Include dependency graph for gistxlog.h:

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

Go to the source code of this file.

Data Structures
struct	gistxlogPageUpdate
struct	gistxlogDelete
struct	gistxlogPageSplit
struct	gistxlogPageDelete
struct	gistxlogPageReuse

Macros
#define	XLOG_GIST_PAGE_UPDATE   0x00
#define	XLOG_GIST_DELETE
#define	XLOG_GIST_PAGE_REUSE
#define	XLOG_GIST_PAGE_SPLIT   0x30
#define	XLOG_GIST_PAGE_DELETE   0x60
#define	SizeOfGistxlogDelete   offsetof(gistxlogDelete, offsets)
#define	SizeOfGistxlogPageDelete   (offsetof(gistxlogPageDelete, downlinkOffset) + sizeof(OffsetNumber))
#define	SizeOfGistxlogPageReuse   (offsetof(gistxlogPageReuse, isCatalogRel) + sizeof(bool))

Typedefs
typedef struct gistxlogPageUpdate	gistxlogPageUpdate
typedef struct gistxlogDelete	gistxlogDelete
typedef struct gistxlogPageSplit	gistxlogPageSplit
typedef struct gistxlogPageDelete	gistxlogPageDelete
typedef struct gistxlogPageReuse	gistxlogPageReuse

Functions
void	gist_redo (XLogReaderState *record)
void	gist_desc (StringInfo buf, XLogReaderState *record)
const char *	gist_identify (uint8 info)
void	gist_xlog_startup (void)
void	gist_xlog_cleanup (void)
void	gist_mask (char *pagedata, BlockNumber blkno)

Macro Definition Documentation

SizeOfGistxlogDelete

#define SizeOfGistxlogDelete   offsetof(gistxlogDelete, offsets)

Definition at line 59 of file gistxlog.h.

SizeOfGistxlogPageDelete

#define SizeOfGistxlogPageDelete   (offsetof(gistxlogPageDelete, downlinkOffset) + sizeof(OffsetNumber))

Definition at line 91 of file gistxlog.h.

SizeOfGistxlogPageReuse

#define SizeOfGistxlogPageReuse   (offsetof(gistxlogPageReuse, isCatalogRel) + sizeof(bool))

Definition at line 106 of file gistxlog.h.

XLOG_GIST_DELETE

#define XLOG_GIST_DELETE

Value:

                                             0x10   /* delete leaf index tuples for a
                                             * page */

Definition at line 21 of file gistxlog.h.

{
    /* number of deleted offsets */
    uint16      ntodelete;
    uint16      ntoinsert;
 
    /*
     * In payload of blk 0 : 1. todelete OffsetNumbers 2. tuples to insert
     */
} gistxlogPageUpdate;
 
/*
 * Backup Blk 0: Leaf page, whose index tuples are deleted.
 */
typedef struct gistxlogDelete
{
    TransactionId snapshotConflictHorizon;
    uint16      ntodelete;      /* number of deleted offsets */
    bool        isCatalogRel;   /* to handle recovery conflict during logical
                                 * decoding on standby */
 
    /* TODELETE OFFSET NUMBERS */
    OffsetNumber offsets[FLEXIBLE_ARRAY_MEMBER];
} gistxlogDelete;
 
#define SizeOfGistxlogDelete    offsetof(gistxlogDelete, offsets)
 
/*
 * Backup Blk 0: If this operation completes a page split, by inserting a
 *               downlink for the split page, the left half of the split
 * Backup Blk 1 - npage: split pages (1 is the original page)
 */
typedef struct gistxlogPageSplit
{
    BlockNumber origrlink;      /* rightlink of the page before split */
    GistNSN     orignsn;        /* NSN of the page before split */
    bool        origleaf;       /* was split page a leaf page? */
 
    uint16      npage;          /* # of pages in the split */
    bool        markfollowright;    /* set F_FOLLOW_RIGHT flags */
 
    /*
     * follow: 1. gistxlogPage and array of IndexTupleData per page
     */
} gistxlogPageSplit;
 
/*
 * Backup Blk 0: page that was deleted.
 * Backup Blk 1: parent page, containing the downlink to the deleted page.
 */
typedef struct gistxlogPageDelete
{
    FullTransactionId deleteXid;    /* last Xid which could see page in scan */
    OffsetNumber downlinkOffset;    /* Offset of downlink referencing this
                                     * page */
} gistxlogPageDelete;
 
#define SizeOfGistxlogPageDelete    (offsetof(gistxlogPageDelete, downlinkOffset) + sizeof(OffsetNumber))
 
 
/*
 * This is what we need to know about page reuse, for hot standby.
 */
typedef struct gistxlogPageReuse
{
    RelFileLocator locator;
    BlockNumber block;
    FullTransactionId snapshotConflictHorizon;
    bool        isCatalogRel;   /* to handle recovery conflict during logical
                                 * decoding on standby */
} gistxlogPageReuse;
 
#define SizeOfGistxlogPageReuse (offsetof(gistxlogPageReuse, isCatalogRel) + sizeof(bool))
 
extern void gist_redo(XLogReaderState *record);
extern void gist_desc(StringInfo buf, XLogReaderState *record);
extern const char *gist_identify(uint8 info);
extern void gist_xlog_startup(void);
extern void gist_xlog_cleanup(void);
extern void gist_mask(char *pagedata, BlockNumber blkno);
 
#endif

XLOG_GIST_PAGE_DELETE

#define XLOG_GIST_PAGE_DELETE   0x60

Definition at line 26 of file gistxlog.h.

XLOG_GIST_PAGE_REUSE

#define XLOG_GIST_PAGE_REUSE

Value:

                                             0x20   /* old page is about to be reused
                                             * from FSM */

Definition at line 22 of file gistxlog.h.

XLOG_GIST_PAGE_SPLIT

#define XLOG_GIST_PAGE_SPLIT   0x30

Definition at line 23 of file gistxlog.h.

XLOG_GIST_PAGE_UPDATE

#define XLOG_GIST_PAGE_UPDATE   0x00

Definition at line 20 of file gistxlog.h.

Typedef Documentation

gistxlogDelete

typedef struct gistxlogDelete gistxlogDelete

gistxlogPageDelete

typedef struct gistxlogPageDelete gistxlogPageDelete

gistxlogPageReuse

typedef struct gistxlogPageReuse gistxlogPageReuse

gistxlogPageSplit

typedef struct gistxlogPageSplit gistxlogPageSplit

gistxlogPageUpdate

typedef struct gistxlogPageUpdate gistxlogPageUpdate

Function Documentation

gist_desc()

void gist_desc ( StringInfo  buf, XLogReaderState *  record  )

extern

Definition at line 61 of file gistdesc.c.

{
    char       *rec = XLogRecGetData(record);
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    switch (info)
    {
        case XLOG_GIST_PAGE_UPDATE:
            out_gistxlogPageUpdate(buf, (gistxlogPageUpdate *) rec);
            break;
        case XLOG_GIST_PAGE_REUSE:
            out_gistxlogPageReuse(buf, (gistxlogPageReuse *) rec);
            break;
        case XLOG_GIST_DELETE:
            out_gistxlogDelete(buf, (gistxlogDelete *) rec);
            break;
        case XLOG_GIST_PAGE_SPLIT:
            out_gistxlogPageSplit(buf, (gistxlogPageSplit *) rec);
            break;
        case XLOG_GIST_PAGE_DELETE:
            out_gistxlogPageDelete(buf, (gistxlogPageDelete *) rec);
            break;
    }
}

References buf, fb(), out_gistxlogDelete(), out_gistxlogPageDelete(), out_gistxlogPageReuse(), out_gistxlogPageSplit(), out_gistxlogPageUpdate(), XLOG_GIST_DELETE, XLOG_GIST_PAGE_DELETE, XLOG_GIST_PAGE_REUSE, XLOG_GIST_PAGE_SPLIT, XLOG_GIST_PAGE_UPDATE, XLogRecGetData, and XLogRecGetInfo.

gist_identify()

const char * gist_identify ( uint8  info )

extern

Definition at line 87 of file gistdesc.c.

{
    const char *id = NULL;
 
    switch (info & ~XLR_INFO_MASK)
    {
        case XLOG_GIST_PAGE_UPDATE:
            id = "PAGE_UPDATE";
            break;
        case XLOG_GIST_DELETE:
            id = "DELETE";
            break;
        case XLOG_GIST_PAGE_REUSE:
            id = "PAGE_REUSE";
            break;
        case XLOG_GIST_PAGE_SPLIT:
            id = "PAGE_SPLIT";
            break;
        case XLOG_GIST_PAGE_DELETE:
            id = "PAGE_DELETE";
            break;
    }
 
    return id;
}

References fb(), XLOG_GIST_DELETE, XLOG_GIST_PAGE_DELETE, XLOG_GIST_PAGE_REUSE, XLOG_GIST_PAGE_SPLIT, XLOG_GIST_PAGE_UPDATE, and XLR_INFO_MASK.

gist_mask()

void gist_mask ( char *  pagedata, BlockNumber  blkno  )

extern

Definition at line 448 of file gistxlog.c.

{
    Page        page = (Page) pagedata;
 
    mask_page_lsn_and_checksum(page);
 
    mask_page_hint_bits(page);
    mask_unused_space(page);
 
    /*
     * NSN is nothing but a special purpose LSN. Hence, mask it for the same
     * reason as mask_page_lsn_and_checksum.
     */
    GistPageSetNSN(page, (uint64) MASK_MARKER);
 
    /*
     * We update F_FOLLOW_RIGHT flag on the left child after writing WAL
     * record. Hence, mask this flag. See gistplacetopage() for details.
     */
    GistMarkFollowRight(page);
 
    if (GistPageIsLeaf(page))
    {
        /*
         * In gist leaf pages, it is possible to modify the LP_FLAGS without
         * emitting any WAL record. Hence, mask the line pointer flags. See
         * gistkillitems() for details.
         */
        mask_lp_flags(page);
    }
 
    /*
     * During gist redo, we never mark a page as garbage. Hence, mask it to
     * ignore any differences.
     */
    GistClearPageHasGarbage(page);
}

References fb(), GistClearPageHasGarbage, GistMarkFollowRight, GistPageIsLeaf, GistPageSetNSN, mask_lp_flags(), MASK_MARKER, mask_page_hint_bits(), mask_page_lsn_and_checksum(), and mask_unused_space().

gist_redo()

void gist_redo ( XLogReaderState *  record )

extern

Definition at line 395 of file gistxlog.c.

{
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
    MemoryContext oldCxt;
 
    /*
     * GiST indexes do not require any conflict processing. NB: If we ever
     * implement a similar optimization we have in b-tree, and remove killed
     * tuples outside VACUUM, we'll need to handle that here.
     */
 
    oldCxt = MemoryContextSwitchTo(opCtx);
    switch (info)
    {
        case XLOG_GIST_PAGE_UPDATE:
            gistRedoPageUpdateRecord(record);
            break;
        case XLOG_GIST_DELETE:
            gistRedoDeleteRecord(record);
            break;
        case XLOG_GIST_PAGE_REUSE:
            gistRedoPageReuse(record);
            break;
        case XLOG_GIST_PAGE_SPLIT:
            gistRedoPageSplitRecord(record);
            break;
        case XLOG_GIST_PAGE_DELETE:
            gistRedoPageDelete(record);
            break;
        default:
            elog(PANIC, "gist_redo: unknown op code %u", info);
    }
 
    MemoryContextSwitchTo(oldCxt);
    MemoryContextReset(opCtx);
}

References elog, fb(), gistRedoDeleteRecord(), gistRedoPageDelete(), gistRedoPageReuse(), gistRedoPageSplitRecord(), gistRedoPageUpdateRecord(), MemoryContextReset(), MemoryContextSwitchTo(), opCtx, PANIC, XLOG_GIST_DELETE, XLOG_GIST_PAGE_DELETE, XLOG_GIST_PAGE_REUSE, XLOG_GIST_PAGE_SPLIT, XLOG_GIST_PAGE_UPDATE, and XLogRecGetInfo.

gist_xlog_cleanup()

void gist_xlog_cleanup ( void  )

extern

Definition at line 439 of file gistxlog.c.

{
    MemoryContextDelete(opCtx);
}

References MemoryContextDelete(), and opCtx.

gist_xlog_startup()

void gist_xlog_startup ( void  )

extern

Definition at line 433 of file gistxlog.c.

{
    opCtx = createTempGistContext();
}

References createTempGistContext(), and opCtx.