bufmask.h File Reference

#include "storage/block.h"
#include "storage/bufmgr.h"

Include dependency graph for bufmask.h:

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

Go to the source code of this file.

Macros
#define	MASK_MARKER   0

Functions
void	mask_page_lsn_and_checksum (Page page)
void	mask_page_hint_bits (Page page)
void	mask_unused_space (Page page)
void	mask_lp_flags (Page page)
void	mask_page_content (Page page)

Macro Definition Documentation

MASK_MARKER

#define MASK_MARKER   0

Definition at line 24 of file bufmask.h.

Function Documentation

mask_lp_flags()

void mask_lp_flags ( Page  page )

extern

Definition at line 94 of file bufmask.c.

{
    OffsetNumber offnum,
                maxoff;
 
    maxoff = PageGetMaxOffsetNumber(page);
    for (offnum = FirstOffsetNumber;
         offnum <= maxoff;
         offnum = OffsetNumberNext(offnum))
    {
        ItemId      itemId = PageGetItemId(page, offnum);
 
        if (ItemIdIsUsed(itemId))
            itemId->lp_flags = LP_UNUSED;
    }
}

References fb(), FirstOffsetNumber, ItemIdIsUsed, LP_UNUSED, OffsetNumberNext, PageGetItemId(), and PageGetMaxOffsetNumber().

Referenced by btree_mask(), gist_mask(), and hash_mask().

mask_page_content()

void mask_page_content ( Page  page )

extern

Definition at line 118 of file bufmask.c.

{
    /* Mask Page Content */
    memset(page + SizeOfPageHeaderData, MASK_MARKER,
           BLCKSZ - SizeOfPageHeaderData);
 
    /* Mask pd_lower and pd_upper */
    memset(&((PageHeader) page)->pd_lower, MASK_MARKER,
           sizeof(uint16));
    memset(&((PageHeader) page)->pd_upper, MASK_MARKER,
           sizeof(uint16));
}

References fb(), MASK_MARKER, and SizeOfPageHeaderData.

Referenced by gin_mask(), and hash_mask().

mask_page_hint_bits()

void mask_page_hint_bits ( Page  page )

extern

Definition at line 46 of file bufmask.c.

{
    PageHeader  phdr = (PageHeader) page;
 
    /* Ignore prune_xid (it's like a hint-bit) */
    phdr->pd_prune_xid = MASK_MARKER;
 
    /* Ignore PD_PAGE_FULL and PD_HAS_FREE_LINES flags, they are just hints. */
    PageClearFull(page);
    PageClearHasFreeLinePointers(page);
 
    /*
     * PD_ALL_VISIBLE is masked during WAL consistency checking. XXX: It is
     * worth investigating if we could stop doing this.
     */
    PageClearAllVisible(page);
}

References MASK_MARKER, PageClearAllVisible(), PageClearFull(), PageClearHasFreeLinePointers(), and PageHeaderData::pd_prune_xid.

Referenced by brin_mask(), btree_mask(), gin_mask(), gist_mask(), hash_mask(), heap_mask(), and spg_mask().

mask_page_lsn_and_checksum()

void mask_page_lsn_and_checksum ( Page  page )

extern

Definition at line 31 of file bufmask.c.

{
    PageHeader  phdr = (PageHeader) page;
 
    PageXLogRecPtrSet(&phdr->pd_lsn, (uint64) MASK_MARKER);
    phdr->pd_checksum = MASK_MARKER;
}

References MASK_MARKER, PageXLogRecPtrSet(), PageHeaderData::pd_checksum, and PageHeaderData::pd_lsn.

Referenced by brin_mask(), btree_mask(), generic_mask(), gin_mask(), gist_mask(), hash_mask(), heap_mask(), seq_mask(), and spg_mask().

mask_unused_space()

void mask_unused_space ( Page  page )

extern

Definition at line 70 of file bufmask.c.

{
    int         pd_lower = ((PageHeader) page)->pd_lower;
    int         pd_upper = ((PageHeader) page)->pd_upper;
    int         pd_special = ((PageHeader) page)->pd_special;
 
    /* Sanity check */
    if (pd_lower > pd_upper || pd_special < pd_upper ||
        pd_lower < SizeOfPageHeaderData || pd_special > BLCKSZ)
    {
        elog(ERROR, "invalid page pd_lower %u pd_upper %u pd_special %u",
             pd_lower, pd_upper, pd_special);
    }
 
    memset(page + pd_lower, MASK_MARKER, pd_upper - pd_lower);
}

References elog, ERROR, fb(), and MASK_MARKER.

Referenced by brin_mask(), btree_mask(), generic_mask(), gin_mask(), gist_mask(), hash_mask(), heap_mask(), seq_mask(), and spg_mask().