hash_xlog.h File Reference

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

Include dependency graph for hash_xlog.h:

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

Go to the source code of this file.

Data Structures
struct	xl_hash_insert
struct	xl_hash_add_ovfl_page
struct	xl_hash_split_allocate_page
struct	xl_hash_split_complete
struct	xl_hash_move_page_contents
struct	xl_hash_squeeze_page
struct	xl_hash_delete
struct	xl_hash_update_meta_page
struct	xl_hash_init_meta_page
struct	xl_hash_init_bitmap_page
struct	xl_hash_vacuum_one_page

Macros
#define	HASH_XLOG_FREE_OVFL_BUFS   6
#define	XLOG_HASH_INIT_META_PAGE   0x00 /* initialize the meta page */
#define	XLOG_HASH_INIT_BITMAP_PAGE   0x10 /* initialize the bitmap page */
#define	XLOG_HASH_INSERT   0x20 /* add index tuple without split */
#define	XLOG_HASH_ADD_OVFL_PAGE   0x30 /* add overflow page */
#define	XLOG_HASH_SPLIT_ALLOCATE_PAGE   0x40 /* allocate new page for split */
#define	XLOG_HASH_SPLIT_PAGE   0x50 /* split page */
#define	XLOG_HASH_SPLIT_COMPLETE   0x60 /* completion of split operation */
#define	XLOG_HASH_MOVE_PAGE_CONTENTS
#define	XLOG_HASH_SQUEEZE_PAGE
#define	XLOG_HASH_DELETE   0x90 /* delete index tuples from a page */
#define	XLOG_HASH_SPLIT_CLEANUP
#define	XLOG_HASH_UPDATE_META_PAGE   0xB0 /* update meta page after vacuum */
#define	XLOG_HASH_VACUUM_ONE_PAGE
#define	XLH_SPLIT_META_UPDATE_MASKS   (1<<0)
#define	XLH_SPLIT_META_UPDATE_SPLITPOINT   (1<<1)
#define	SizeOfHashInsert   (offsetof(xl_hash_insert, offnum) + sizeof(OffsetNumber))
#define	SizeOfHashAddOvflPage    (offsetof(xl_hash_add_ovfl_page, bmpage_found) + sizeof(bool))
#define	SizeOfHashSplitAllocPage    (offsetof(xl_hash_split_allocate_page, flags) + sizeof(uint8))
#define	SizeOfHashSplitComplete    (offsetof(xl_hash_split_complete, new_bucket_flag) + sizeof(uint16))
#define	SizeOfHashMovePageContents    (offsetof(xl_hash_move_page_contents, is_prim_bucket_same_wrt) + sizeof(bool))
#define	SizeOfHashSqueezePage    (offsetof(xl_hash_squeeze_page, is_prev_bucket_same_wrt) + sizeof(bool))
#define	SizeOfHashDelete   (offsetof(xl_hash_delete, is_primary_bucket_page) + sizeof(bool))
#define	SizeOfHashUpdateMetaPage    (offsetof(xl_hash_update_meta_page, ntuples) + sizeof(double))
#define	SizeOfHashInitMetaPage    (offsetof(xl_hash_init_meta_page, ffactor) + sizeof(uint16))
#define	SizeOfHashInitBitmapPage    (offsetof(xl_hash_init_bitmap_page, bmsize) + sizeof(uint16))
#define	SizeOfHashVacuumOnePage   offsetof(xl_hash_vacuum_one_page, offsets)

Typedefs
typedef struct xl_hash_insert	xl_hash_insert
typedef struct xl_hash_add_ovfl_page	xl_hash_add_ovfl_page
typedef struct xl_hash_split_allocate_page	xl_hash_split_allocate_page
typedef struct xl_hash_split_complete	xl_hash_split_complete
typedef struct xl_hash_move_page_contents	xl_hash_move_page_contents
typedef struct xl_hash_squeeze_page	xl_hash_squeeze_page
typedef struct xl_hash_delete	xl_hash_delete
typedef struct xl_hash_update_meta_page	xl_hash_update_meta_page
typedef struct xl_hash_init_meta_page	xl_hash_init_meta_page
typedef struct xl_hash_init_bitmap_page	xl_hash_init_bitmap_page
typedef struct xl_hash_vacuum_one_page	xl_hash_vacuum_one_page

Functions
void	hash_redo (XLogReaderState *record)
void	hash_desc (StringInfo buf, XLogReaderState *record)
const char *	hash_identify (uint8 info)
void	hash_mask (char *pagedata, BlockNumber blkno)

Macro Definition Documentation

HASH_XLOG_FREE_OVFL_BUFS

#define HASH_XLOG_FREE_OVFL_BUFS   6

Definition at line 22 of file hash_xlog.h.

SizeOfHashAddOvflPage

#define SizeOfHashAddOvflPage    (offsetof(xl_hash_add_ovfl_page, bmpage_found) + sizeof(bool))

Definition at line 80 of file hash_xlog.h.

SizeOfHashDelete

#define SizeOfHashDelete   (offsetof(xl_hash_delete, is_primary_bucket_page) + sizeof(bool))

Definition at line 186 of file hash_xlog.h.

SizeOfHashInitBitmapPage

#define SizeOfHashInitBitmapPage    (offsetof(xl_hash_init_bitmap_page, bmsize) + sizeof(uint16))

Definition at line 233 of file hash_xlog.h.

SizeOfHashInitMetaPage

#define SizeOfHashInitMetaPage    (offsetof(xl_hash_init_meta_page, ffactor) + sizeof(uint16))

Definition at line 217 of file hash_xlog.h.

SizeOfHashInsert

#define SizeOfHashInsert   (offsetof(xl_hash_insert, offnum) + sizeof(OffsetNumber))

Definition at line 61 of file hash_xlog.h.

SizeOfHashMovePageContents

#define SizeOfHashMovePageContents    (offsetof(xl_hash_move_page_contents, is_prim_bucket_same_wrt) + sizeof(bool))

Definition at line 138 of file hash_xlog.h.

SizeOfHashSplitAllocPage

#define SizeOfHashSplitAllocPage    (offsetof(xl_hash_split_allocate_page, flags) + sizeof(uint8))

Definition at line 100 of file hash_xlog.h.

SizeOfHashSplitComplete

#define SizeOfHashSplitComplete    (offsetof(xl_hash_split_complete, new_bucket_flag) + sizeof(uint16))

Definition at line 117 of file hash_xlog.h.

SizeOfHashSqueezePage

#define SizeOfHashSqueezePage    (offsetof(xl_hash_squeeze_page, is_prev_bucket_same_wrt) + sizeof(bool))

Definition at line 167 of file hash_xlog.h.

SizeOfHashUpdateMetaPage

#define SizeOfHashUpdateMetaPage    (offsetof(xl_hash_update_meta_page, ntuples) + sizeof(double))

Definition at line 200 of file hash_xlog.h.

SizeOfHashVacuumOnePage

#define SizeOfHashVacuumOnePage   offsetof(xl_hash_vacuum_one_page, offsets)

Definition at line 256 of file hash_xlog.h.

XLH_SPLIT_META_UPDATE_MASKS

#define XLH_SPLIT_META_UPDATE_MASKS   (1<<0)

Definition at line 45 of file hash_xlog.h.

XLH_SPLIT_META_UPDATE_SPLITPOINT

#define XLH_SPLIT_META_UPDATE_SPLITPOINT   (1<<1)

Definition at line 46 of file hash_xlog.h.

XLOG_HASH_ADD_OVFL_PAGE

#define XLOG_HASH_ADD_OVFL_PAGE   0x30 /* add overflow page */

Definition at line 30 of file hash_xlog.h.

XLOG_HASH_DELETE

#define XLOG_HASH_DELETE   0x90 /* delete index tuples from a page */

Definition at line 36 of file hash_xlog.h.

XLOG_HASH_INIT_BITMAP_PAGE

#define XLOG_HASH_INIT_BITMAP_PAGE   0x10 /* initialize the bitmap page */

Definition at line 28 of file hash_xlog.h.

XLOG_HASH_INIT_META_PAGE

#define XLOG_HASH_INIT_META_PAGE   0x00 /* initialize the meta page */

Definition at line 27 of file hash_xlog.h.

XLOG_HASH_INSERT

#define XLOG_HASH_INSERT   0x20 /* add index tuple without split */

Definition at line 29 of file hash_xlog.h.

XLOG_HASH_MOVE_PAGE_CONTENTS

#define XLOG_HASH_MOVE_PAGE_CONTENTS

Value:

                                                 0x70   /* remove tuples from one page
                                                 * and add to another page */

Definition at line 34 of file hash_xlog.h.

XLOG_HASH_SPLIT_ALLOCATE_PAGE

#define XLOG_HASH_SPLIT_ALLOCATE_PAGE   0x40 /* allocate new page for split */

Definition at line 31 of file hash_xlog.h.

XLOG_HASH_SPLIT_CLEANUP

#define XLOG_HASH_SPLIT_CLEANUP

Value:

                                         0xA0   /* clear split-cleanup flag in primary
                                         * bucket page after deleting tuples
                                         * that are moved due to split  */

Definition at line 37 of file hash_xlog.h.

XLOG_HASH_SPLIT_COMPLETE

#define XLOG_HASH_SPLIT_COMPLETE   0x60 /* completion of split operation */

Definition at line 33 of file hash_xlog.h.

XLOG_HASH_SPLIT_PAGE

#define XLOG_HASH_SPLIT_PAGE   0x50 /* split page */

Definition at line 32 of file hash_xlog.h.

XLOG_HASH_SQUEEZE_PAGE

#define XLOG_HASH_SQUEEZE_PAGE

Value:

                                         0x80   /* add tuples to one of the previous
                                         * pages in chain and free the ovfl
                                         * page */

Definition at line 35 of file hash_xlog.h.

XLOG_HASH_UPDATE_META_PAGE

#define XLOG_HASH_UPDATE_META_PAGE   0xB0 /* update meta page after vacuum */

Definition at line 38 of file hash_xlog.h.

XLOG_HASH_VACUUM_ONE_PAGE

#define XLOG_HASH_VACUUM_ONE_PAGE

Value:

                                             0xC0   /* remove dead tuples from index
                                             * page */

Definition at line 40 of file hash_xlog.h.

Typedef Documentation

xl_hash_add_ovfl_page

typedef struct xl_hash_add_ovfl_page xl_hash_add_ovfl_page

xl_hash_delete

typedef struct xl_hash_delete xl_hash_delete

xl_hash_init_bitmap_page

typedef struct xl_hash_init_bitmap_page xl_hash_init_bitmap_page

xl_hash_init_meta_page

typedef struct xl_hash_init_meta_page xl_hash_init_meta_page

xl_hash_insert

typedef struct xl_hash_insert xl_hash_insert

xl_hash_move_page_contents

typedef struct xl_hash_move_page_contents xl_hash_move_page_contents

xl_hash_split_allocate_page

typedef struct xl_hash_split_allocate_page xl_hash_split_allocate_page

xl_hash_split_complete

typedef struct xl_hash_split_complete xl_hash_split_complete

xl_hash_squeeze_page

typedef struct xl_hash_squeeze_page xl_hash_squeeze_page

xl_hash_update_meta_page

typedef struct xl_hash_update_meta_page xl_hash_update_meta_page

xl_hash_vacuum_one_page

typedef struct xl_hash_vacuum_one_page xl_hash_vacuum_one_page

Function Documentation

hash_desc()

void hash_desc	(	StringInfo	buf,
		XLogReaderState *	record
	)

Definition at line 20 of file hashdesc.c.

{
    char       *rec = XLogRecGetData(record);
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    switch (info)
    {
        case XLOG_HASH_INIT_META_PAGE:
            {
                xl_hash_init_meta_page *xlrec = (xl_hash_init_meta_page *) rec;
 
                appendStringInfo(buf, "num_tuples %g, fillfactor %d",
                                 xlrec->num_tuples, xlrec->ffactor);
                break;
            }
        case XLOG_HASH_INIT_BITMAP_PAGE:
            {
                xl_hash_init_bitmap_page *xlrec = (xl_hash_init_bitmap_page *) rec;
 
                appendStringInfo(buf, "bmsize %d", xlrec->bmsize);
                break;
            }
        case XLOG_HASH_INSERT:
            {
                xl_hash_insert *xlrec = (xl_hash_insert *) rec;
 
                appendStringInfo(buf, "off %u", xlrec->offnum);
                break;
            }
        case XLOG_HASH_ADD_OVFL_PAGE:
            {
                xl_hash_add_ovfl_page *xlrec = (xl_hash_add_ovfl_page *) rec;
 
                appendStringInfo(buf, "bmsize %d, bmpage_found %c",
                                 xlrec->bmsize, (xlrec->bmpage_found) ? 'T' : 'F');
                break;
            }
        case XLOG_HASH_SPLIT_ALLOCATE_PAGE:
            {
                xl_hash_split_allocate_page *xlrec = (xl_hash_split_allocate_page *) rec;
 
                appendStringInfo(buf, "new_bucket %u, meta_page_masks_updated %c, issplitpoint_changed %c",
                                 xlrec->new_bucket,
                                 (xlrec->flags & XLH_SPLIT_META_UPDATE_MASKS) ? 'T' : 'F',
                                 (xlrec->flags & XLH_SPLIT_META_UPDATE_SPLITPOINT) ? 'T' : 'F');
                break;
            }
        case XLOG_HASH_SPLIT_COMPLETE:
            {
                xl_hash_split_complete *xlrec = (xl_hash_split_complete *) rec;
 
                appendStringInfo(buf, "old_bucket_flag %u, new_bucket_flag %u",
                                 xlrec->old_bucket_flag, xlrec->new_bucket_flag);
                break;
            }
        case XLOG_HASH_MOVE_PAGE_CONTENTS:
            {
                xl_hash_move_page_contents *xlrec = (xl_hash_move_page_contents *) rec;
 
                appendStringInfo(buf, "ntups %d, is_primary %c",
                                 xlrec->ntups,
                                 xlrec->is_prim_bucket_same_wrt ? 'T' : 'F');
                break;
            }
        case XLOG_HASH_SQUEEZE_PAGE:
            {
                xl_hash_squeeze_page *xlrec = (xl_hash_squeeze_page *) rec;
 
                appendStringInfo(buf, "prevblkno %u, nextblkno %u, ntups %d, is_primary %c",
                                 xlrec->prevblkno,
                                 xlrec->nextblkno,
                                 xlrec->ntups,
                                 xlrec->is_prim_bucket_same_wrt ? 'T' : 'F');
                break;
            }
        case XLOG_HASH_DELETE:
            {
                xl_hash_delete *xlrec = (xl_hash_delete *) rec;
 
                appendStringInfo(buf, "clear_dead_marking %c, is_primary %c",
                                 xlrec->clear_dead_marking ? 'T' : 'F',
                                 xlrec->is_primary_bucket_page ? 'T' : 'F');
                break;
            }
        case XLOG_HASH_UPDATE_META_PAGE:
            {
                xl_hash_update_meta_page *xlrec = (xl_hash_update_meta_page *) rec;
 
                appendStringInfo(buf, "ntuples %g",
                                 xlrec->ntuples);
                break;
            }
        case XLOG_HASH_VACUUM_ONE_PAGE:
            {
                xl_hash_vacuum_one_page *xlrec = (xl_hash_vacuum_one_page *) rec;
 
                appendStringInfo(buf, "ntuples %d, snapshotConflictHorizon %u, isCatalogRel %c",
                                 xlrec->ntuples,
                                 xlrec->snapshotConflictHorizon,
                                 xlrec->isCatalogRel ? 'T' : 'F');
                break;
            }
    }
}

References appendStringInfo(), xl_hash_add_ovfl_page::bmpage_found, xl_hash_add_ovfl_page::bmsize, xl_hash_init_bitmap_page::bmsize, buf, xl_hash_delete::clear_dead_marking, xl_hash_init_meta_page::ffactor, xl_hash_split_allocate_page::flags, xl_hash_move_page_contents::is_prim_bucket_same_wrt, xl_hash_squeeze_page::is_prim_bucket_same_wrt, xl_hash_delete::is_primary_bucket_page, xl_hash_vacuum_one_page::isCatalogRel, xl_hash_split_allocate_page::new_bucket, xl_hash_split_complete::new_bucket_flag, xl_hash_squeeze_page::nextblkno, xl_hash_update_meta_page::ntuples, xl_hash_vacuum_one_page::ntuples, xl_hash_move_page_contents::ntups, xl_hash_squeeze_page::ntups, xl_hash_init_meta_page::num_tuples, xl_hash_insert::offnum, xl_hash_split_complete::old_bucket_flag, xl_hash_squeeze_page::prevblkno, xl_hash_vacuum_one_page::snapshotConflictHorizon, XLH_SPLIT_META_UPDATE_MASKS, XLH_SPLIT_META_UPDATE_SPLITPOINT, XLOG_HASH_ADD_OVFL_PAGE, XLOG_HASH_DELETE, XLOG_HASH_INIT_BITMAP_PAGE, XLOG_HASH_INIT_META_PAGE, XLOG_HASH_INSERT, XLOG_HASH_MOVE_PAGE_CONTENTS, XLOG_HASH_SPLIT_ALLOCATE_PAGE, XLOG_HASH_SPLIT_COMPLETE, XLOG_HASH_SQUEEZE_PAGE, XLOG_HASH_UPDATE_META_PAGE, XLOG_HASH_VACUUM_ONE_PAGE, XLogRecGetData, and XLogRecGetInfo.

hash_identify()

const char * hash_identify

(

uint8

info

)

Definition at line 126 of file hashdesc.c.

{
    const char *id = NULL;
 
    switch (info & ~XLR_INFO_MASK)
    {
        case XLOG_HASH_INIT_META_PAGE:
            id = "INIT_META_PAGE";
            break;
        case XLOG_HASH_INIT_BITMAP_PAGE:
            id = "INIT_BITMAP_PAGE";
            break;
        case XLOG_HASH_INSERT:
            id = "INSERT";
            break;
        case XLOG_HASH_ADD_OVFL_PAGE:
            id = "ADD_OVFL_PAGE";
            break;
        case XLOG_HASH_SPLIT_ALLOCATE_PAGE:
            id = "SPLIT_ALLOCATE_PAGE";
            break;
        case XLOG_HASH_SPLIT_PAGE:
            id = "SPLIT_PAGE";
            break;
        case XLOG_HASH_SPLIT_COMPLETE:
            id = "SPLIT_COMPLETE";
            break;
        case XLOG_HASH_MOVE_PAGE_CONTENTS:
            id = "MOVE_PAGE_CONTENTS";
            break;
        case XLOG_HASH_SQUEEZE_PAGE:
            id = "SQUEEZE_PAGE";
            break;
        case XLOG_HASH_DELETE:
            id = "DELETE";
            break;
        case XLOG_HASH_SPLIT_CLEANUP:
            id = "SPLIT_CLEANUP";
            break;
        case XLOG_HASH_UPDATE_META_PAGE:
            id = "UPDATE_META_PAGE";
            break;
        case XLOG_HASH_VACUUM_ONE_PAGE:
            id = "VACUUM_ONE_PAGE";
    }
 
    return id;
}

References XLOG_HASH_ADD_OVFL_PAGE, XLOG_HASH_DELETE, XLOG_HASH_INIT_BITMAP_PAGE, XLOG_HASH_INIT_META_PAGE, XLOG_HASH_INSERT, XLOG_HASH_MOVE_PAGE_CONTENTS, XLOG_HASH_SPLIT_ALLOCATE_PAGE, XLOG_HASH_SPLIT_CLEANUP, XLOG_HASH_SPLIT_COMPLETE, XLOG_HASH_SPLIT_PAGE, XLOG_HASH_SQUEEZE_PAGE, XLOG_HASH_UPDATE_META_PAGE, XLOG_HASH_VACUUM_ONE_PAGE, and XLR_INFO_MASK.

hash_mask()

void hash_mask	(	char *	pagedata,
		BlockNumber	blkno
	)

Definition at line 1121 of file hash_xlog.c.

{
    Page        page = (Page) pagedata;
    HashPageOpaque opaque;
    int         pagetype;
 
    mask_page_lsn_and_checksum(page);
 
    mask_page_hint_bits(page);
    mask_unused_space(page);
 
    opaque = HashPageGetOpaque(page);
 
    pagetype = opaque->hasho_flag & LH_PAGE_TYPE;
    if (pagetype == LH_UNUSED_PAGE)
    {
        /*
         * Mask everything on a UNUSED page.
         */
        mask_page_content(page);
    }
    else if (pagetype == LH_BUCKET_PAGE ||
             pagetype == LH_OVERFLOW_PAGE)
    {
        /*
         * In hash bucket and overflow pages, it is possible to modify the
         * LP_FLAGS without emitting any WAL record. Hence, mask the line
         * pointer flags. See hashgettuple(), _hash_kill_items() for details.
         */
        mask_lp_flags(page);
    }
 
    /*
     * It is possible that the hint bit LH_PAGE_HAS_DEAD_TUPLES may remain
     * unlogged. So, mask it. See _hash_kill_items() for details.
     */
    opaque->hasho_flag &= ~LH_PAGE_HAS_DEAD_TUPLES;
}

References HashPageOpaqueData::hasho_flag, HashPageGetOpaque, LH_BUCKET_PAGE, LH_OVERFLOW_PAGE, LH_PAGE_TYPE, LH_UNUSED_PAGE, mask_lp_flags(), mask_page_content(), mask_page_hint_bits(), mask_page_lsn_and_checksum(), and mask_unused_space().

hash_redo()

void hash_redo

(

XLogReaderState *

record

)

Definition at line 1067 of file hash_xlog.c.

{
    uint8       info = XLogRecGetInfo(record) & ~XLR_INFO_MASK;
 
    switch (info)
    {
        case XLOG_HASH_INIT_META_PAGE:
            hash_xlog_init_meta_page(record);
            break;
        case XLOG_HASH_INIT_BITMAP_PAGE:
            hash_xlog_init_bitmap_page(record);
            break;
        case XLOG_HASH_INSERT:
            hash_xlog_insert(record);
            break;
        case XLOG_HASH_ADD_OVFL_PAGE:
            hash_xlog_add_ovfl_page(record);
            break;
        case XLOG_HASH_SPLIT_ALLOCATE_PAGE:
            hash_xlog_split_allocate_page(record);
            break;
        case XLOG_HASH_SPLIT_PAGE:
            hash_xlog_split_page(record);
            break;
        case XLOG_HASH_SPLIT_COMPLETE:
            hash_xlog_split_complete(record);
            break;
        case XLOG_HASH_MOVE_PAGE_CONTENTS:
            hash_xlog_move_page_contents(record);
            break;
        case XLOG_HASH_SQUEEZE_PAGE:
            hash_xlog_squeeze_page(record);
            break;
        case XLOG_HASH_DELETE:
            hash_xlog_delete(record);
            break;
        case XLOG_HASH_SPLIT_CLEANUP:
            hash_xlog_split_cleanup(record);
            break;
        case XLOG_HASH_UPDATE_META_PAGE:
            hash_xlog_update_meta_page(record);
            break;
        case XLOG_HASH_VACUUM_ONE_PAGE:
            hash_xlog_vacuum_one_page(record);
            break;
        default:
            elog(PANIC, "hash_redo: unknown op code %u", info);
    }
}

References elog, hash_xlog_add_ovfl_page(), hash_xlog_delete(), hash_xlog_init_bitmap_page(), hash_xlog_init_meta_page(), hash_xlog_insert(), hash_xlog_move_page_contents(), hash_xlog_split_allocate_page(), hash_xlog_split_cleanup(), hash_xlog_split_complete(), hash_xlog_split_page(), hash_xlog_squeeze_page(), hash_xlog_update_meta_page(), hash_xlog_vacuum_one_page(), PANIC, XLOG_HASH_ADD_OVFL_PAGE, XLOG_HASH_DELETE, XLOG_HASH_INIT_BITMAP_PAGE, XLOG_HASH_INIT_META_PAGE, XLOG_HASH_INSERT, XLOG_HASH_MOVE_PAGE_CONTENTS, XLOG_HASH_SPLIT_ALLOCATE_PAGE, XLOG_HASH_SPLIT_CLEANUP, XLOG_HASH_SPLIT_COMPLETE, XLOG_HASH_SPLIT_PAGE, XLOG_HASH_SQUEEZE_PAGE, XLOG_HASH_UPDATE_META_PAGE, XLOG_HASH_VACUUM_ONE_PAGE, and XLogRecGetInfo.