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	XLOG_GIST_ASSIGN_LSN   0x70 /* nop, assign new LSN */
#define	SizeOfGistxlogDelete   (offsetof(gistxlogDelete, ntodelete) + sizeof(uint16))
#define	SizeOfGistxlogPageDelete   (offsetof(gistxlogPageDelete, downlinkOffset) + sizeof(OffsetNumber))
#define	SizeOfGistxlogPageReuse   (offsetof(gistxlogPageReuse, snapshotConflictHorizon) + sizeof(FullTransactionId))

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, ntodelete) + sizeof(uint16))

Definition at line 56 of file gistxlog.h.

SizeOfGistxlogPageDelete

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

Definition at line 88 of file gistxlog.h.

SizeOfGistxlogPageReuse

#define SizeOfGistxlogPageReuse   (offsetof(gistxlogPageReuse, snapshotConflictHorizon) + sizeof(FullTransactionId))

Definition at line 101 of file gistxlog.h.

XLOG_GIST_ASSIGN_LSN

#define XLOG_GIST_ASSIGN_LSN   0x70 /* nop, assign new LSN */

Definition at line 27 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.

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
	)

Definition at line 60 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;
        case XLOG_GIST_ASSIGN_LSN:
            /* No details to write out */
            break;
    }
}

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

gist_identify()

const char* gist_identify

(

uint8

info

)

Definition at line 89 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;
        case XLOG_GIST_ASSIGN_LSN:
            id = "ASSIGN_LSN";
            break;
    }
 
    return id;
}

References XLOG_GIST_ASSIGN_LSN, 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
	)

Definition at line 459 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 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

)

Definition at line 403 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;
        case XLOG_GIST_ASSIGN_LSN:
            /* nop. See gistGetFakeLSN(). */
            break;
        default:
            elog(PANIC, "gist_redo: unknown op code %u", info);
    }
 
    MemoryContextSwitchTo(oldCxt);
    MemoryContextReset(opCtx);
}

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

gist_xlog_cleanup()

void gist_xlog_cleanup

(

void

)

Definition at line 450 of file gistxlog.c.

{
    MemoryContextDelete(opCtx);
}

References MemoryContextDelete(), and opCtx.

gist_xlog_startup()

void gist_xlog_startup

(

void

)

Definition at line 444 of file gistxlog.c.

{
    opCtx = createTempGistContext();
}

References createTempGistContext(), and opCtx.