nbtxlog.h File Reference

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

Include dependency graph for nbtxlog.h:

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

Go to the source code of this file.

Data Structures
struct	xl_btree_metadata
struct	xl_btree_insert
struct	xl_btree_split
struct	xl_btree_dedup
struct	xl_btree_reuse_page
struct	xl_btree_vacuum
struct	xl_btree_delete
struct	xl_btree_update
struct	xl_btree_mark_page_halfdead
struct	xl_btree_unlink_page
struct	xl_btree_newroot

Macros
#define	XLOG_BTREE_INSERT_LEAF   0x00 /* add index tuple without split */
#define	XLOG_BTREE_INSERT_UPPER   0x10 /* same, on a non-leaf page */
#define	XLOG_BTREE_INSERT_META   0x20 /* same, plus update metapage */
#define	XLOG_BTREE_SPLIT_L   0x30 /* add index tuple with split */
#define	XLOG_BTREE_SPLIT_R   0x40 /* as above, new item on right */
#define	XLOG_BTREE_INSERT_POST   0x50 /* add index tuple with posting split */
#define	XLOG_BTREE_DEDUP   0x60 /* deduplicate tuples for a page */
#define	XLOG_BTREE_DELETE   0x70 /* delete leaf index tuples for a page */
#define	XLOG_BTREE_UNLINK_PAGE   0x80 /* delete a half-dead page */
#define	XLOG_BTREE_UNLINK_PAGE_META   0x90 /* same, and update metapage */
#define	XLOG_BTREE_NEWROOT   0xA0 /* new root page */
#define	XLOG_BTREE_MARK_PAGE_HALFDEAD   0xB0 /* mark a leaf as half-dead */
#define	XLOG_BTREE_VACUUM
#define	XLOG_BTREE_REUSE_PAGE
#define	XLOG_BTREE_META_CLEANUP
#define	SizeOfBtreeInsert   (offsetof(xl_btree_insert, offnum) + sizeof(OffsetNumber))
#define	SizeOfBtreeSplit   (offsetof(xl_btree_split, postingoff) + sizeof(uint16))
#define	SizeOfBtreeDedup   (offsetof(xl_btree_dedup, nintervals) + sizeof(uint16))
#define	SizeOfBtreeReusePage   (offsetof(xl_btree_reuse_page, isCatalogRel) + sizeof(bool))
#define	SizeOfBtreeVacuum   (offsetof(xl_btree_vacuum, nupdated) + sizeof(uint16))
#define	SizeOfBtreeDelete   (offsetof(xl_btree_delete, isCatalogRel) + sizeof(bool))
#define	SizeOfBtreeUpdate   (offsetof(xl_btree_update, ndeletedtids) + sizeof(uint16))
#define	SizeOfBtreeMarkPageHalfDead   (offsetof(xl_btree_mark_page_halfdead, topparent) + sizeof(BlockNumber))
#define	SizeOfBtreeUnlinkPage   (offsetof(xl_btree_unlink_page, leaftopparent) + sizeof(BlockNumber))
#define	SizeOfBtreeNewroot   (offsetof(xl_btree_newroot, level) + sizeof(uint32))

Typedefs
typedef struct xl_btree_metadata	xl_btree_metadata
typedef struct xl_btree_insert	xl_btree_insert
typedef struct xl_btree_split	xl_btree_split
typedef struct xl_btree_dedup	xl_btree_dedup
typedef struct xl_btree_reuse_page	xl_btree_reuse_page
typedef struct xl_btree_vacuum	xl_btree_vacuum
typedef struct xl_btree_delete	xl_btree_delete
typedef struct xl_btree_update	xl_btree_update
typedef struct xl_btree_mark_page_halfdead	xl_btree_mark_page_halfdead
typedef struct xl_btree_unlink_page	xl_btree_unlink_page
typedef struct xl_btree_newroot	xl_btree_newroot

Functions
void	btree_redo (XLogReaderState *record)
void	btree_xlog_startup (void)
void	btree_xlog_cleanup (void)
void	btree_mask (char *pagedata, BlockNumber blkno)
void	btree_desc (StringInfo buf, XLogReaderState *record)
const char *	btree_identify (uint8 info)

Macro Definition Documentation

SizeOfBtreeDedup

#define SizeOfBtreeDedup   (offsetof(xl_btree_dedup, nintervals) + sizeof(uint16))

Definition at line 174 of file nbtxlog.h.

SizeOfBtreeDelete

#define SizeOfBtreeDelete   (offsetof(xl_btree_delete, isCatalogRel) + sizeof(bool))

Definition at line 253 of file nbtxlog.h.

SizeOfBtreeInsert

#define SizeOfBtreeInsert   (offsetof(xl_btree_insert, offnum) + sizeof(OffsetNumber))

Definition at line 84 of file nbtxlog.h.

SizeOfBtreeMarkPageHalfDead

#define SizeOfBtreeMarkPageHalfDead   (offsetof(xl_btree_mark_page_halfdead, topparent) + sizeof(BlockNumber))

Definition at line 291 of file nbtxlog.h.

SizeOfBtreeNewroot

#define SizeOfBtreeNewroot   (offsetof(xl_btree_newroot, level) + sizeof(uint32))

Definition at line 347 of file nbtxlog.h.

SizeOfBtreeReusePage

#define SizeOfBtreeReusePage   (offsetof(xl_btree_reuse_page, isCatalogRel) + sizeof(bool))

Definition at line 192 of file nbtxlog.h.

SizeOfBtreeSplit

#define SizeOfBtreeSplit   (offsetof(xl_btree_split, postingoff) + sizeof(uint16))

Definition at line 158 of file nbtxlog.h.

SizeOfBtreeUnlinkPage

#define SizeOfBtreeUnlinkPage   (offsetof(xl_btree_unlink_page, leaftopparent) + sizeof(BlockNumber))

Definition at line 328 of file nbtxlog.h.

SizeOfBtreeUpdate

#define SizeOfBtreeUpdate   (offsetof(xl_btree_update, ndeletedtids) + sizeof(uint16))

Definition at line 268 of file nbtxlog.h.

SizeOfBtreeVacuum

#define SizeOfBtreeVacuum   (offsetof(xl_btree_vacuum, nupdated) + sizeof(uint16))

Definition at line 234 of file nbtxlog.h.

XLOG_BTREE_DEDUP

#define XLOG_BTREE_DEDUP   0x60 /* deduplicate tuples for a page */

Definition at line 33 of file nbtxlog.h.

XLOG_BTREE_DELETE

#define XLOG_BTREE_DELETE   0x70 /* delete leaf index tuples for a page */

Definition at line 34 of file nbtxlog.h.

XLOG_BTREE_INSERT_LEAF

#define XLOG_BTREE_INSERT_LEAF   0x00 /* add index tuple without split */

Definition at line 27 of file nbtxlog.h.

XLOG_BTREE_INSERT_META

#define XLOG_BTREE_INSERT_META   0x20 /* same, plus update metapage */

Definition at line 29 of file nbtxlog.h.

XLOG_BTREE_INSERT_POST

#define XLOG_BTREE_INSERT_POST   0x50 /* add index tuple with posting split */

Definition at line 32 of file nbtxlog.h.

XLOG_BTREE_INSERT_UPPER

#define XLOG_BTREE_INSERT_UPPER   0x10 /* same, on a non-leaf page */

Definition at line 28 of file nbtxlog.h.

XLOG_BTREE_MARK_PAGE_HALFDEAD

#define XLOG_BTREE_MARK_PAGE_HALFDEAD   0xB0 /* mark a leaf as half-dead */

Definition at line 38 of file nbtxlog.h.

XLOG_BTREE_META_CLEANUP

#define XLOG_BTREE_META_CLEANUP

Value:

                                         0xE0   /* update cleanup-related data in the
                                         * metapage */

Definition at line 41 of file nbtxlog.h.

{
    uint32      version;
    BlockNumber root;
    uint32      level;
    BlockNumber fastroot;
    uint32      fastlevel;
    uint32      last_cleanup_num_delpages;
    bool        allequalimage;
} xl_btree_metadata;
 
/*
 * This is what we need to know about simple (without split) insert.
 *
 * This data record is used for INSERT_LEAF, INSERT_UPPER, INSERT_META, and
 * INSERT_POST.  Note that INSERT_META and INSERT_UPPER implies it's not a
 * leaf page, while INSERT_POST and INSERT_LEAF imply that it must be a leaf
 * page.
 *
 * Backup Blk 0: original page
 * Backup Blk 1: child's left sibling, if INSERT_UPPER or INSERT_META
 * Backup Blk 2: xl_btree_metadata, if INSERT_META
 *
 * Note: The new tuple is actually the "original" new item in the posting
 * list split insert case (i.e. the INSERT_POST case).  A split offset for
 * the posting list is logged before the original new item.  Recovery needs
 * both, since it must do an in-place update of the existing posting list
 * that was split as an extra step.  Also, recovery generates a "final"
 * newitem.  See _bt_swap_posting() for details on posting list splits.
 */
typedef struct xl_btree_insert
{
    OffsetNumber offnum;
 
    /* POSTING SPLIT OFFSET FOLLOWS (INSERT_POST case) */
    /* NEW TUPLE ALWAYS FOLLOWS AT THE END */
} xl_btree_insert;
 
#define SizeOfBtreeInsert   (offsetof(xl_btree_insert, offnum) + sizeof(OffsetNumber))
 
/*
 * On insert with split, we save all the items going into the right sibling
 * so that we can restore it completely from the log record.  This way takes
 * less xlog space than the normal approach, because if we did it standardly,
 * XLogInsert would almost always think the right page is new and store its
 * whole page image.  The left page, however, is handled in the normal
 * incremental-update fashion.
 *
 * Note: XLOG_BTREE_SPLIT_L and XLOG_BTREE_SPLIT_R share this data record.
 * There are two variants to indicate whether the inserted tuple went into the
 * left or right split page (and thus, whether the new item is stored or not).
 * We always log the left page high key because suffix truncation can generate
 * a new leaf high key using user-defined code.  This is also necessary on
 * internal pages, since the firstright item that the left page's high key was
 * based on will have been truncated to zero attributes in the right page (the
 * separator key is unavailable from the right page).
 *
 * Backup Blk 0: original page / new left page
 *
 * The left page's data portion contains the new item, if it's the _L variant.
 * _R variant split records generally do not have a newitem (_R variant leaf
 * page split records that must deal with a posting list split will include an
 * explicit newitem, though it is never used on the right page -- it is
 * actually an orignewitem needed to update existing posting list).  The new
 * high key of the left/original page appears last of all (and must always be
 * present).
 *
 * Page split records that need the REDO routine to deal with a posting list
 * split directly will have an explicit newitem, which is actually an
 * orignewitem (the newitem as it was before the posting list split, not
 * after).  A posting list split always has a newitem that comes immediately
 * after the posting list being split (which would have overlapped with
 * orignewitem prior to split).  Usually REDO must deal with posting list
 * splits with an _L variant page split record, and usually both the new
 * posting list and the final newitem go on the left page (the existing
 * posting list will be inserted instead of the old, and the final newitem
 * will be inserted next to that).  However, _R variant split records will
 * include an orignewitem when the split point for the page happens to have a
 * lastleft tuple that is also the posting list being split (leaving newitem
 * as the page split's firstright tuple).  The existence of this corner case
 * does not change the basic fact about newitem/orignewitem for the REDO
 * routine: it is always state used for the left page alone.  (This is why the
 * record's postingoff field isn't a reliable indicator of whether or not a
 * posting list split occurred during the page split; a non-zero value merely
 * indicates that the REDO routine must reconstruct a new posting list tuple
 * that is needed for the left page.)
 *
 * This posting list split handling is equivalent to the xl_btree_insert REDO
 * routine's INSERT_POST handling.  While the details are more complicated
 * here, the concept and goals are exactly the same.  See _bt_swap_posting()
 * for details on posting list splits.
 *
 * Backup Blk 1: new right page
 *
 * The right page's data portion contains the right page's tuples in the form
 * used by _bt_restore_page.  This includes the new item, if it's the _R
 * variant.  The right page's tuples also include the right page's high key
 * with either variant (moved from the left/original page during the split),
 * unless the split happened to be of the rightmost page on its level, where
 * there is no high key for new right page.
 *
 * Backup Blk 2: next block (orig page's rightlink), if any
 * Backup Blk 3: child's left sibling, if non-leaf split
 */
typedef struct xl_btree_split
{
    uint32      level;          /* tree level of page being split */
    OffsetNumber firstrightoff; /* first origpage item on rightpage */
    OffsetNumber newitemoff;    /* new item's offset */
    uint16      postingoff;     /* offset inside orig posting tuple */
} xl_btree_split;
 
#define SizeOfBtreeSplit    (offsetof(xl_btree_split, postingoff) + sizeof(uint16))
 
/*
 * When page is deduplicated, consecutive groups of tuples with equal keys are
 * merged together into posting list tuples.
 *
 * The WAL record represents a deduplication pass for a leaf page.  An array
 * of BTDedupInterval structs follows.
 */
typedef struct xl_btree_dedup
{
    uint16      nintervals;
 
    /* DEDUPLICATION INTERVALS FOLLOW */
} xl_btree_dedup;
 
#define SizeOfBtreeDedup    (offsetof(xl_btree_dedup, nintervals) + sizeof(uint16))
 
/*
 * This is what we need to know about page reuse within btree.  This record
 * only exists to generate a conflict point for Hot Standby.
 *
 * Note that we must include a RelFileLocator in the record because we don't
 * actually register the buffer with the record.
 */
typedef struct xl_btree_reuse_page
{
    RelFileLocator locator;
    BlockNumber block;
    FullTransactionId snapshotConflictHorizon;
    bool        isCatalogRel;   /* to handle recovery conflict during logical
                                 * decoding on standby */
} xl_btree_reuse_page;
 
#define SizeOfBtreeReusePage    (offsetof(xl_btree_reuse_page, isCatalogRel) + sizeof(bool))
 
/*
 * xl_btree_vacuum and xl_btree_delete records describe deletion of index
 * tuples on a leaf page.  The former variant is used by VACUUM, while the
 * latter variant is used by the ad-hoc deletions that sometimes take place
 * when btinsert() is called.
 *
 * The records are very similar.  The only difference is that xl_btree_delete
 * have snapshotConflictHorizon/isCatalogRel fields for recovery conflicts.
 * (VACUUM operations can just rely on earlier conflicts generated during
 * pruning of the table whose TIDs the to-be-deleted index tuples point to.
 * There are also small differences between each REDO routine that we don't go
 * into here.)
 *
 * xl_btree_vacuum and xl_btree_delete both represent deletion of any number
 * of index tuples on a single leaf page using page offset numbers.  Both also
 * support "updates" of index tuples, which is how deletes of a subset of TIDs
 * contained in an existing posting list tuple are implemented.
 *
 * Updated posting list tuples are represented using xl_btree_update metadata.
 * The REDO routines each use the xl_btree_update entries (plus each
 * corresponding original index tuple from the target leaf page) to generate
 * the final updated tuple.
 *
 * Updates are only used when there will be some remaining TIDs left by the
 * REDO routine.  Otherwise the posting list tuple just gets deleted outright.
 */
typedef struct xl_btree_vacuum
{
    uint16      ndeleted;
    uint16      nupdated;
 
    /*----
     * In payload of blk 0 :
     * - DELETED TARGET OFFSET NUMBERS
     * - UPDATED TARGET OFFSET NUMBERS
     * - UPDATED TUPLES METADATA (xl_btree_update) ITEMS
     *----
     */
} xl_btree_vacuum;
 
#define SizeOfBtreeVacuum   (offsetof(xl_btree_vacuum, nupdated) + sizeof(uint16))
 
typedef struct xl_btree_delete
{
    TransactionId snapshotConflictHorizon;
    uint16      ndeleted;
    uint16      nupdated;
    bool        isCatalogRel;   /* to handle recovery conflict during logical
                                 * decoding on standby */
 
    /*----
     * In payload of blk 0 :
     * - DELETED TARGET OFFSET NUMBERS
     * - UPDATED TARGET OFFSET NUMBERS
     * - UPDATED TUPLES METADATA (xl_btree_update) ITEMS
     *----
     */
} xl_btree_delete;
 
#define SizeOfBtreeDelete   (offsetof(xl_btree_delete, isCatalogRel) + sizeof(bool))
 
/*
 * The offsets that appear in xl_btree_update metadata are offsets into the
 * original posting list from tuple, not page offset numbers.  These are
 * 0-based.  The page offset number for the original posting list tuple comes
 * from the main xl_btree_vacuum/xl_btree_delete record.
 */
typedef struct xl_btree_update
{
    uint16      ndeletedtids;
 
    /* POSTING LIST uint16 OFFSETS TO A DELETED TID FOLLOW */
} xl_btree_update;
 
#define SizeOfBtreeUpdate   (offsetof(xl_btree_update, ndeletedtids) + sizeof(uint16))
 
/*
 * This is what we need to know about marking an empty subtree for deletion.
 * The target identifies the tuple removed from the parent page (note that we
 * remove this tuple's downlink and the *following* tuple's key).  Note that
 * the leaf page is empty, so we don't need to store its content --- it is
 * just reinitialized during recovery using the rest of the fields.
 *
 * Backup Blk 0: leaf block
 * Backup Blk 1: top parent
 */
typedef struct xl_btree_mark_page_halfdead
{
    OffsetNumber poffset;       /* deleted tuple id in parent page */
 
    /* information needed to recreate the leaf page: */
    BlockNumber leafblk;        /* leaf block ultimately being deleted */
    BlockNumber leftblk;        /* leaf block's left sibling, if any */
    BlockNumber rightblk;       /* leaf block's right sibling */
    BlockNumber topparent;      /* topmost internal page in the subtree */
} xl_btree_mark_page_halfdead;
 
#define SizeOfBtreeMarkPageHalfDead (offsetof(xl_btree_mark_page_halfdead, topparent) + sizeof(BlockNumber))
 
/*
 * This is what we need to know about deletion of a btree page.  Note that we
 * only leave behind a small amount of bookkeeping information in deleted
 * pages (deleted pages must be kept around as tombstones for a while).  It is
 * convenient for the REDO routine to regenerate its target page from scratch.
 * This is why WAL record describes certain details that are actually directly
 * available from the target page.
 *
 * Backup Blk 0: target block being deleted
 * Backup Blk 1: target block's left sibling, if any
 * Backup Blk 2: target block's right sibling
 * Backup Blk 3: leaf block (if different from target)
 * Backup Blk 4: metapage (if rightsib becomes new fast root)
 */
typedef struct xl_btree_unlink_page
{
    BlockNumber leftsib;        /* target block's left sibling, if any */
    BlockNumber rightsib;       /* target block's right sibling */
    uint32      level;          /* target block's level */
    FullTransactionId safexid;  /* target block's BTPageSetDeleted() XID */
 
    /*
     * Information needed to recreate a half-dead leaf page with correct
     * topparent link.  The fields are only used when deletion operation's
     * target page is an internal page.  REDO routine creates half-dead page
     * from scratch to keep things simple (this is the same convenient
     * approach used for the target page itself).
     */
    BlockNumber leafleftsib;
    BlockNumber leafrightsib;
    BlockNumber leaftopparent;  /* next child down in the subtree */
 
    /* xl_btree_metadata FOLLOWS IF XLOG_BTREE_UNLINK_PAGE_META */
} xl_btree_unlink_page;
 
#define SizeOfBtreeUnlinkPage   (offsetof(xl_btree_unlink_page, leaftopparent) + sizeof(BlockNumber))
 
/*
 * New root log record.  There are zero tuples if this is to establish an
 * empty root, or two if it is the result of splitting an old root.
 *
 * Note that although this implies rewriting the metadata page, we don't need
 * an xl_btree_metadata record --- the rootblk and level are sufficient.
 *
 * Backup Blk 0: new root page (2 tuples as payload, if splitting old root)
 * Backup Blk 1: left child (if splitting an old root)
 * Backup Blk 2: metapage
 */
typedef struct xl_btree_newroot
{
    BlockNumber rootblk;        /* location of new root (redundant with blk 0) */
    uint32      level;          /* its tree level */
} xl_btree_newroot;
 
#define SizeOfBtreeNewroot  (offsetof(xl_btree_newroot, level) + sizeof(uint32))
 
 
/*
 * prototypes for functions in nbtxlog.c
 */
extern void btree_redo(XLogReaderState *record);
extern void btree_xlog_startup(void);
extern void btree_xlog_cleanup(void);
extern void btree_mask(char *pagedata, BlockNumber blkno);
 
/*
 * prototypes for functions in nbtdesc.c
 */
extern void btree_desc(StringInfo buf, XLogReaderState *record);
extern const char *btree_identify(uint8 info);
 
#endif                          /* NBTXLOG_H */

XLOG_BTREE_NEWROOT

#define XLOG_BTREE_NEWROOT   0xA0 /* new root page */

Definition at line 37 of file nbtxlog.h.

XLOG_BTREE_REUSE_PAGE

#define XLOG_BTREE_REUSE_PAGE

Value:

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

Definition at line 40 of file nbtxlog.h.

XLOG_BTREE_SPLIT_L

#define XLOG_BTREE_SPLIT_L   0x30 /* add index tuple with split */

Definition at line 30 of file nbtxlog.h.

XLOG_BTREE_SPLIT_R

#define XLOG_BTREE_SPLIT_R   0x40 /* as above, new item on right */

Definition at line 31 of file nbtxlog.h.

XLOG_BTREE_UNLINK_PAGE

#define XLOG_BTREE_UNLINK_PAGE   0x80 /* delete a half-dead page */

Definition at line 35 of file nbtxlog.h.

XLOG_BTREE_UNLINK_PAGE_META

#define XLOG_BTREE_UNLINK_PAGE_META   0x90 /* same, and update metapage */

Definition at line 36 of file nbtxlog.h.

XLOG_BTREE_VACUUM

#define XLOG_BTREE_VACUUM

Value:

                                         0xC0   /* delete entries on a page during
                                         * vacuum */

Definition at line 39 of file nbtxlog.h.

Typedef Documentation

xl_btree_dedup

typedef struct xl_btree_dedup xl_btree_dedup

xl_btree_delete

typedef struct xl_btree_delete xl_btree_delete

xl_btree_insert

typedef struct xl_btree_insert xl_btree_insert

xl_btree_mark_page_halfdead

typedef struct xl_btree_mark_page_halfdead xl_btree_mark_page_halfdead

xl_btree_metadata

typedef struct xl_btree_metadata xl_btree_metadata

xl_btree_newroot

typedef struct xl_btree_newroot xl_btree_newroot

xl_btree_reuse_page

typedef struct xl_btree_reuse_page xl_btree_reuse_page

xl_btree_split

typedef struct xl_btree_split xl_btree_split

xl_btree_unlink_page

typedef struct xl_btree_unlink_page xl_btree_unlink_page

xl_btree_update

typedef struct xl_btree_update xl_btree_update

xl_btree_vacuum

typedef struct xl_btree_vacuum xl_btree_vacuum

Function Documentation

btree_desc()

void btree_desc ( StringInfo  buf, XLogReaderState *  record  )

extern

Definition at line 24 of file nbtdesc.c.

{
    char       *rec = XLogRecGetData(record);
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    switch (info)
    {
        case XLOG_BTREE_INSERT_LEAF:
        case XLOG_BTREE_INSERT_UPPER:
        case XLOG_BTREE_INSERT_META:
        case XLOG_BTREE_INSERT_POST:
            {
                xl_btree_insert *xlrec = (xl_btree_insert *) rec;
 
                appendStringInfo(buf, "off: %u", xlrec->offnum);
                break;
            }
        case XLOG_BTREE_SPLIT_L:
        case XLOG_BTREE_SPLIT_R:
            {
                xl_btree_split *xlrec = (xl_btree_split *) rec;
 
                appendStringInfo(buf, "level: %u, firstrightoff: %d, newitemoff: %d, postingoff: %d",
                                 xlrec->level, xlrec->firstrightoff,
                                 xlrec->newitemoff, xlrec->postingoff);
                break;
            }
        case XLOG_BTREE_DEDUP:
            {
                xl_btree_dedup *xlrec = (xl_btree_dedup *) rec;
 
                appendStringInfo(buf, "nintervals: %u", xlrec->nintervals);
                break;
            }
        case XLOG_BTREE_VACUUM:
            {
                xl_btree_vacuum *xlrec = (xl_btree_vacuum *) rec;
 
                appendStringInfo(buf, "ndeleted: %u, nupdated: %u",
                                 xlrec->ndeleted, xlrec->nupdated);
 
                if (XLogRecHasBlockData(record, 0))
                    delvacuum_desc(buf, XLogRecGetBlockData(record, 0, NULL),
                                   xlrec->ndeleted, xlrec->nupdated);
                break;
            }
        case XLOG_BTREE_DELETE:
            {
                xl_btree_delete *xlrec = (xl_btree_delete *) rec;
 
                appendStringInfo(buf, "snapshotConflictHorizon: %u, ndeleted: %u, nupdated: %u, isCatalogRel: %c",
                                 xlrec->snapshotConflictHorizon,
                                 xlrec->ndeleted, xlrec->nupdated,
                                 xlrec->isCatalogRel ? 'T' : 'F');
 
                if (XLogRecHasBlockData(record, 0))
                    delvacuum_desc(buf, XLogRecGetBlockData(record, 0, NULL),
                                   xlrec->ndeleted, xlrec->nupdated);
                break;
            }
        case XLOG_BTREE_MARK_PAGE_HALFDEAD:
            {
                xl_btree_mark_page_halfdead *xlrec = (xl_btree_mark_page_halfdead *) rec;
 
                appendStringInfo(buf, "topparent: %u, leaf: %u, left: %u, right: %u",
                                 xlrec->topparent, xlrec->leafblk, xlrec->leftblk, xlrec->rightblk);
                break;
            }
        case XLOG_BTREE_UNLINK_PAGE_META:
        case XLOG_BTREE_UNLINK_PAGE:
            {
                xl_btree_unlink_page *xlrec = (xl_btree_unlink_page *) rec;
 
                appendStringInfo(buf, "left: %u, right: %u, level: %u, safexid: %u:%u, ",
                                 xlrec->leftsib, xlrec->rightsib, xlrec->level,
                                 EpochFromFullTransactionId(xlrec->safexid),
                                 XidFromFullTransactionId(xlrec->safexid));
                appendStringInfo(buf, "leafleft: %u, leafright: %u, leaftopparent: %u",
                                 xlrec->leafleftsib, xlrec->leafrightsib,
                                 xlrec->leaftopparent);
                break;
            }
        case XLOG_BTREE_NEWROOT:
            {
                xl_btree_newroot *xlrec = (xl_btree_newroot *) rec;
 
                appendStringInfo(buf, "level: %u", xlrec->level);
                break;
            }
        case XLOG_BTREE_REUSE_PAGE:
            {
                xl_btree_reuse_page *xlrec = (xl_btree_reuse_page *) rec;
 
                appendStringInfo(buf, "rel: %u/%u/%u, snapshotConflictHorizon: %u:%u, isCatalogRel: %c",
                                 xlrec->locator.spcOid, xlrec->locator.dbOid,
                                 xlrec->locator.relNumber,
                                 EpochFromFullTransactionId(xlrec->snapshotConflictHorizon),
                                 XidFromFullTransactionId(xlrec->snapshotConflictHorizon),
                                 xlrec->isCatalogRel ? 'T' : 'F');
                break;
            }
        case XLOG_BTREE_META_CLEANUP:
            {
                xl_btree_metadata *xlrec;
 
                xlrec = (xl_btree_metadata *) XLogRecGetBlockData(record, 0,
                                                                  NULL);
                appendStringInfo(buf, "last_cleanup_num_delpages: %u",
                                 xlrec->last_cleanup_num_delpages);
                break;
            }
    }
}

References appendStringInfo(), buf, delvacuum_desc(), EpochFromFullTransactionId, fb(), XidFromFullTransactionId, XLOG_BTREE_DEDUP, XLOG_BTREE_DELETE, XLOG_BTREE_INSERT_LEAF, XLOG_BTREE_INSERT_META, XLOG_BTREE_INSERT_POST, XLOG_BTREE_INSERT_UPPER, XLOG_BTREE_MARK_PAGE_HALFDEAD, XLOG_BTREE_META_CLEANUP, XLOG_BTREE_NEWROOT, XLOG_BTREE_REUSE_PAGE, XLOG_BTREE_SPLIT_L, XLOG_BTREE_SPLIT_R, XLOG_BTREE_UNLINK_PAGE, XLOG_BTREE_UNLINK_PAGE_META, XLOG_BTREE_VACUUM, XLogRecGetBlockData(), XLogRecGetData, XLogRecGetInfo, and XLogRecHasBlockData.

btree_identify()

const char * btree_identify ( uint8  info )

extern

Definition at line 139 of file nbtdesc.c.

{
    const char *id = NULL;
 
    switch (info & ~XLR_INFO_MASK)
    {
        case XLOG_BTREE_INSERT_LEAF:
            id = "INSERT_LEAF";
            break;
        case XLOG_BTREE_INSERT_UPPER:
            id = "INSERT_UPPER";
            break;
        case XLOG_BTREE_INSERT_META:
            id = "INSERT_META";
            break;
        case XLOG_BTREE_SPLIT_L:
            id = "SPLIT_L";
            break;
        case XLOG_BTREE_SPLIT_R:
            id = "SPLIT_R";
            break;
        case XLOG_BTREE_INSERT_POST:
            id = "INSERT_POST";
            break;
        case XLOG_BTREE_DEDUP:
            id = "DEDUP";
            break;
        case XLOG_BTREE_VACUUM:
            id = "VACUUM";
            break;
        case XLOG_BTREE_DELETE:
            id = "DELETE";
            break;
        case XLOG_BTREE_MARK_PAGE_HALFDEAD:
            id = "MARK_PAGE_HALFDEAD";
            break;
        case XLOG_BTREE_UNLINK_PAGE:
            id = "UNLINK_PAGE";
            break;
        case XLOG_BTREE_UNLINK_PAGE_META:
            id = "UNLINK_PAGE_META";
            break;
        case XLOG_BTREE_NEWROOT:
            id = "NEWROOT";
            break;
        case XLOG_BTREE_REUSE_PAGE:
            id = "REUSE_PAGE";
            break;
        case XLOG_BTREE_META_CLEANUP:
            id = "META_CLEANUP";
            break;
    }
 
    return id;
}

References fb(), XLOG_BTREE_DEDUP, XLOG_BTREE_DELETE, XLOG_BTREE_INSERT_LEAF, XLOG_BTREE_INSERT_META, XLOG_BTREE_INSERT_POST, XLOG_BTREE_INSERT_UPPER, XLOG_BTREE_MARK_PAGE_HALFDEAD, XLOG_BTREE_META_CLEANUP, XLOG_BTREE_NEWROOT, XLOG_BTREE_REUSE_PAGE, XLOG_BTREE_SPLIT_L, XLOG_BTREE_SPLIT_R, XLOG_BTREE_UNLINK_PAGE, XLOG_BTREE_UNLINK_PAGE_META, XLOG_BTREE_VACUUM, and XLR_INFO_MASK.

btree_mask()

void btree_mask ( char *  pagedata, BlockNumber  blkno  )

extern

Definition at line 1081 of file nbtxlog.c.

{
    Page        page = (Page) pagedata;
    BTPageOpaque maskopaq;
 
    mask_page_lsn_and_checksum(page);
 
    mask_page_hint_bits(page);
    mask_unused_space(page);
 
    maskopaq = BTPageGetOpaque(page);
 
    if (P_ISLEAF(maskopaq))
    {
        /*
         * In btree leaf pages, it is possible to modify the LP_FLAGS without
         * emitting any WAL record. Hence, mask the line pointer flags. See
         * _bt_killitems(), _bt_check_unique() for details.
         */
        mask_lp_flags(page);
    }
 
    /*
     * BTP_HAS_GARBAGE is just an un-logged hint bit. So, mask it. See
     * _bt_delete_or_dedup_one_page(), _bt_killitems(), and _bt_check_unique()
     * for details.
     */
    maskopaq->btpo_flags &= ~BTP_HAS_GARBAGE;
 
    /*
     * During replay of a btree page split, we don't set the BTP_SPLIT_END
     * flag of the right sibling and initialize the cycle_id to 0 for the same
     * page. See btree_xlog_split() for details.
     */
    maskopaq->btpo_flags &= ~BTP_SPLIT_END;
    maskopaq->btpo_cycleid = 0;
}

References BTPageGetOpaque, fb(), mask_lp_flags(), mask_page_hint_bits(), mask_page_lsn_and_checksum(), mask_unused_space(), and P_ISLEAF.

btree_redo()

void btree_redo ( XLogReaderState *  record )

extern

Definition at line 1004 of file nbtxlog.c.

{
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
    MemoryContext oldCtx;
 
    oldCtx = MemoryContextSwitchTo(opCtx);
    switch (info)
    {
        case XLOG_BTREE_INSERT_LEAF:
            btree_xlog_insert(true, false, false, record);
            break;
        case XLOG_BTREE_INSERT_UPPER:
            btree_xlog_insert(false, false, false, record);
            break;
        case XLOG_BTREE_INSERT_META:
            btree_xlog_insert(false, true, false, record);
            break;
        case XLOG_BTREE_SPLIT_L:
            btree_xlog_split(true, record);
            break;
        case XLOG_BTREE_SPLIT_R:
            btree_xlog_split(false, record);
            break;
        case XLOG_BTREE_INSERT_POST:
            btree_xlog_insert(true, false, true, record);
            break;
        case XLOG_BTREE_DEDUP:
            btree_xlog_dedup(record);
            break;
        case XLOG_BTREE_VACUUM:
            btree_xlog_vacuum(record);
            break;
        case XLOG_BTREE_DELETE:
            btree_xlog_delete(record);
            break;
        case XLOG_BTREE_MARK_PAGE_HALFDEAD:
            btree_xlog_mark_page_halfdead(info, record);
            break;
        case XLOG_BTREE_UNLINK_PAGE:
        case XLOG_BTREE_UNLINK_PAGE_META:
            btree_xlog_unlink_page(info, record);
            break;
        case XLOG_BTREE_NEWROOT:
            btree_xlog_newroot(record);
            break;
        case XLOG_BTREE_REUSE_PAGE:
            btree_xlog_reuse_page(record);
            break;
        case XLOG_BTREE_META_CLEANUP:
            _bt_restore_meta(record, 0);
            break;
        default:
            elog(PANIC, "btree_redo: unknown op code %u", info);
    }
    MemoryContextSwitchTo(oldCtx);
    MemoryContextReset(opCtx);
}

References _bt_restore_meta(), btree_xlog_dedup(), btree_xlog_delete(), btree_xlog_insert(), btree_xlog_mark_page_halfdead(), btree_xlog_newroot(), btree_xlog_reuse_page(), btree_xlog_split(), btree_xlog_unlink_page(), btree_xlog_vacuum(), elog, fb(), MemoryContextReset(), MemoryContextSwitchTo(), opCtx, PANIC, XLOG_BTREE_DEDUP, XLOG_BTREE_DELETE, XLOG_BTREE_INSERT_LEAF, XLOG_BTREE_INSERT_META, XLOG_BTREE_INSERT_POST, XLOG_BTREE_INSERT_UPPER, XLOG_BTREE_MARK_PAGE_HALFDEAD, XLOG_BTREE_META_CLEANUP, XLOG_BTREE_NEWROOT, XLOG_BTREE_REUSE_PAGE, XLOG_BTREE_SPLIT_L, XLOG_BTREE_SPLIT_R, XLOG_BTREE_UNLINK_PAGE, XLOG_BTREE_UNLINK_PAGE_META, XLOG_BTREE_VACUUM, and XLogRecGetInfo.

btree_xlog_cleanup()

void btree_xlog_cleanup ( void  )

extern

Definition at line 1071 of file nbtxlog.c.

{
    MemoryContextDelete(opCtx);
    opCtx = NULL;
}

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

btree_xlog_startup()

void btree_xlog_startup ( void  )

extern

Definition at line 1063 of file nbtxlog.c.

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

References ALLOCSET_DEFAULT_SIZES, AllocSetContextCreate, CurrentMemoryContext, and opCtx.