tidstore.h File Reference

#include "storage/itemptr.h"
#include "utils/dsa.h"

Include dependency graph for tidstore.h:

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

Go to the source code of this file.

Data Structures
struct	TidStoreIterResult

Typedefs
typedef struct TidStore	TidStore
typedef struct TidStoreIter	TidStoreIter
typedef struct TidStoreIterResult	TidStoreIterResult

Functions
TidStore *	TidStoreCreateLocal (size_t max_bytes, bool insert_only)
TidStore *	TidStoreCreateShared (size_t max_bytes, int tranche_id)
TidStore *	TidStoreAttach (dsa_handle area_handle, dsa_pointer handle)
void	TidStoreDetach (TidStore *ts)
void	TidStoreLockExclusive (TidStore *ts)
void	TidStoreLockShare (TidStore *ts)
void	TidStoreUnlock (TidStore *ts)
void	TidStoreDestroy (TidStore *ts)
void	TidStoreSetBlockOffsets (TidStore *ts, BlockNumber blkno, OffsetNumber *offsets, int num_offsets)
bool	TidStoreIsMember (TidStore *ts, const ItemPointerData *tid)
TidStoreIter *	TidStoreBeginIterate (TidStore *ts)
TidStoreIterResult *	TidStoreIterateNext (TidStoreIter *iter)
int	TidStoreGetBlockOffsets (TidStoreIterResult *result, OffsetNumber *offsets, int max_offsets)
void	TidStoreEndIterate (TidStoreIter *iter)
size_t	TidStoreMemoryUsage (TidStore *ts)
dsa_pointer	TidStoreGetHandle (TidStore *ts)
dsa_area *	TidStoreGetDSA (TidStore *ts)

Typedef Documentation

TidStore

typedef struct TidStore TidStore

Definition at line 20 of file tidstore.h.

TidStoreIter

typedef struct TidStoreIter TidStoreIter

Definition at line 21 of file tidstore.h.

TidStoreIterResult

typedef struct TidStoreIterResult TidStoreIterResult

Function Documentation

TidStoreAttach()

TidStore * TidStoreAttach ( dsa_handle  area_handle, dsa_pointer  handle  )

extern

Definition at line 244 of file tidstore.c.

{
    TidStore   *ts;
    dsa_area   *area;
 
    Assert(area_handle != DSA_HANDLE_INVALID);
    Assert(DsaPointerIsValid(handle));
 
    /* create per-backend state */
    ts = palloc0_object(TidStore);
 
    area = dsa_attach(area_handle);
 
    /* Find the shared the shared radix tree */
    ts->tree.shared = shared_ts_attach(area, handle);
    ts->area = area;
 
    return ts;
}

References TidStore::area, Assert, dsa_attach(), DSA_HANDLE_INVALID, DsaPointerIsValid, fb(), palloc0_object, TidStore::shared, and TidStore::tree.

Referenced by parallel_vacuum_main().

TidStoreBeginIterate()

TidStoreIter * TidStoreBeginIterate ( TidStore *  ts )

extern

Definition at line 471 of file tidstore.c.

{
    TidStoreIter *iter;
 
    iter = palloc0_object(TidStoreIter);
    iter->ts = ts;
 
    if (TidStoreIsShared(ts))
        iter->tree_iter.shared = shared_ts_begin_iterate(ts->tree.shared);
    else
        iter->tree_iter.local = local_ts_begin_iterate(ts->tree.local);
 
    return iter;
}

References fb(), TidStore::local, TidStoreIter::local, palloc0_object, TidStore::shared, TidStoreIter::shared, TidStoreIsShared, TidStore::tree, TidStoreIter::tree_iter, and TidStoreIter::ts.

Referenced by check_set_block_offsets(), and lazy_vacuum_heap_rel().

TidStoreCreateLocal()

TidStore * TidStoreCreateLocal ( size_t  max_bytes, bool  insert_only  )

extern

Definition at line 162 of file tidstore.c.

{
    TidStore   *ts;
    size_t      initBlockSize = ALLOCSET_DEFAULT_INITSIZE;
    size_t      minContextSize = ALLOCSET_DEFAULT_MINSIZE;
    size_t      maxBlockSize = ALLOCSET_DEFAULT_MAXSIZE;
 
    ts = palloc0_object(TidStore);
 
    /* choose the maxBlockSize to be no larger than 1/16 of max_bytes */
    while (16 * maxBlockSize > max_bytes)
        maxBlockSize >>= 1;
 
    if (maxBlockSize < ALLOCSET_DEFAULT_INITSIZE)
        maxBlockSize = ALLOCSET_DEFAULT_INITSIZE;
 
    /* Create a memory context for the TID storage */
    if (insert_only)
    {
        ts->rt_context = BumpContextCreate(CurrentMemoryContext,
                                           "TID storage",
                                           minContextSize,
                                           initBlockSize,
                                           maxBlockSize);
    }
    else
    {
        ts->rt_context = AllocSetContextCreate(CurrentMemoryContext,
                                               "TID storage",
                                               minContextSize,
                                               initBlockSize,
                                               maxBlockSize);
    }
 
    ts->tree.local = local_ts_create(ts->rt_context);
 
    return ts;
}

References ALLOCSET_DEFAULT_INITSIZE, ALLOCSET_DEFAULT_MAXSIZE, ALLOCSET_DEFAULT_MINSIZE, AllocSetContextCreate, BumpContextCreate(), CurrentMemoryContext, fb(), TidStore::local, palloc0_object, TidStore::rt_context, and TidStore::tree.

Referenced by dead_items_alloc(), dead_items_reset(), and test_create().

TidStoreCreateShared()

TidStore * TidStoreCreateShared ( size_t  max_bytes, int  tranche_id  )

extern

Definition at line 208 of file tidstore.c.

{
    TidStore   *ts;
    dsa_area   *area;
    size_t      dsa_init_size = DSA_DEFAULT_INIT_SEGMENT_SIZE;
    size_t      dsa_max_size = DSA_MAX_SEGMENT_SIZE;
 
    ts = palloc0_object(TidStore);
 
    /*
     * Choose the initial and maximum DSA segment sizes to be no longer than
     * 1/8 of max_bytes.
     */
    while (8 * dsa_max_size > max_bytes)
        dsa_max_size >>= 1;
 
    if (dsa_max_size < DSA_MIN_SEGMENT_SIZE)
        dsa_max_size = DSA_MIN_SEGMENT_SIZE;
 
    if (dsa_init_size > dsa_max_size)
        dsa_init_size = dsa_max_size;
 
    area = dsa_create_ext(tranche_id, dsa_init_size, dsa_max_size);
    ts->tree.shared = shared_ts_create(area, tranche_id);
    ts->area = area;
 
    return ts;
}

References TidStore::area, dsa_create_ext(), DSA_DEFAULT_INIT_SEGMENT_SIZE, DSA_MAX_SEGMENT_SIZE, DSA_MIN_SEGMENT_SIZE, fb(), palloc0_object, TidStore::shared, and TidStore::tree.

Referenced by parallel_vacuum_init(), parallel_vacuum_reset_dead_items(), and test_create().

TidStoreDestroy()

void TidStoreDestroy ( TidStore *  ts )

extern

Definition at line 317 of file tidstore.c.

{
    /* Destroy underlying radix tree */
    if (TidStoreIsShared(ts))
    {
        shared_ts_free(ts->tree.shared);
        dsa_detach(ts->area);
    }
    else
    {
        local_ts_free(ts->tree.local);
        MemoryContextDelete(ts->rt_context);
    }
 
    pfree(ts);
}

References TidStore::area, dsa_detach(), fb(), TidStore::local, MemoryContextDelete(), pfree(), TidStore::rt_context, TidStore::shared, TidStoreIsShared, and TidStore::tree.

Referenced by dead_items_reset(), parallel_vacuum_end(), parallel_vacuum_reset_dead_items(), and test_destroy().

TidStoreDetach()

void TidStoreDetach ( TidStore *  ts )

extern

Definition at line 269 of file tidstore.c.

{
    Assert(TidStoreIsShared(ts));
 
    shared_ts_detach(ts->tree.shared);
    dsa_detach(ts->area);
 
    pfree(ts);
}

References TidStore::area, Assert, dsa_detach(), fb(), pfree(), TidStore::shared, TidStoreIsShared, and TidStore::tree.

Referenced by parallel_vacuum_main().

TidStoreEndIterate()

void TidStoreEndIterate ( TidStoreIter *  iter )

extern

Definition at line 518 of file tidstore.c.

{
    if (TidStoreIsShared(iter->ts))
        shared_ts_end_iterate(iter->tree_iter.shared);
    else
        local_ts_end_iterate(iter->tree_iter.local);
 
    pfree(iter);
}

References fb(), TidStoreIter::local, pfree(), TidStoreIter::shared, TidStoreIsShared, TidStoreIter::tree_iter, and TidStoreIter::ts.

Referenced by check_set_block_offsets(), and lazy_vacuum_heap_rel().

TidStoreGetBlockOffsets()

int TidStoreGetBlockOffsets ( TidStoreIterResult *  result, OffsetNumber *  offsets, int  max_offsets  )

extern

Definition at line 566 of file tidstore.c.

{
    BlocktableEntry *page = result->internal_page;
    int         num_offsets = 0;
    int         wordnum;
 
    if (page->header.nwords == 0)
    {
        /* we have offsets in the header */
        for (int i = 0; i < NUM_FULL_OFFSETS; i++)
        {
            if (page->header.full_offsets[i] != InvalidOffsetNumber)
            {
                if (num_offsets < max_offsets)
                    offsets[num_offsets] = page->header.full_offsets[i];
                num_offsets++;
            }
        }
    }
    else
    {
        for (wordnum = 0; wordnum < page->header.nwords; wordnum++)
        {
            bitmapword  w = page->words[wordnum];
            int         off = wordnum * BITS_PER_BITMAPWORD;
 
            while (w != 0)
            {
                if (w & 1)
                {
                    if (num_offsets < max_offsets)
                        offsets[num_offsets] = (OffsetNumber) off;
                    num_offsets++;
                }
                off++;
                w >>= 1;
            }
        }
    }
 
    return num_offsets;
}

References BITS_PER_BITMAPWORD, fb(), BlocktableEntry::full_offsets, BlocktableEntry::header, i, TidStoreIterResult::internal_page, InvalidOffsetNumber, NUM_FULL_OFFSETS, BlocktableEntry::nwords, and BlocktableEntry::words.

Referenced by check_set_block_offsets(), and lazy_vacuum_heap_rel().

TidStoreGetDSA()

dsa_area * TidStoreGetDSA ( TidStore *  ts )

extern

Definition at line 544 of file tidstore.c.

{
    Assert(TidStoreIsShared(ts));
 
    return ts->area;
}

References TidStore::area, Assert, and TidStoreIsShared.

Referenced by parallel_vacuum_init(), parallel_vacuum_reset_dead_items(), and test_create().

TidStoreGetHandle()

dsa_pointer TidStoreGetHandle ( TidStore *  ts )

extern

Definition at line 552 of file tidstore.c.

{
    Assert(TidStoreIsShared(ts));
 
    return (dsa_pointer) shared_ts_get_handle(ts->tree.shared);
}

References Assert, fb(), TidStore::shared, TidStoreIsShared, and TidStore::tree.

Referenced by parallel_vacuum_init(), and parallel_vacuum_reset_dead_items().

TidStoreIsMember()

bool TidStoreIsMember ( TidStore *  ts, const ItemPointerData *  tid  )

extern

Definition at line 421 of file tidstore.c.

{
    int         wordnum;
    int         bitnum;
    BlocktableEntry *page;
    BlockNumber blk = ItemPointerGetBlockNumber(tid);
    OffsetNumber off = ItemPointerGetOffsetNumber(tid);
 
    if (TidStoreIsShared(ts))
        page = shared_ts_find(ts->tree.shared, blk);
    else
        page = local_ts_find(ts->tree.local, blk);
 
    /* no entry for the blk */
    if (page == NULL)
        return false;
 
    if (page->header.nwords == 0)
    {
        /* we have offsets in the header */
        for (int i = 0; i < NUM_FULL_OFFSETS; i++)
        {
            if (page->header.full_offsets[i] == off)
                return true;
        }
        return false;
    }
    else
    {
        wordnum = WORDNUM(off);
        bitnum = BITNUM(off);
 
        /* no bitmap for the off */
        if (wordnum >= page->header.nwords)
            return false;
 
        return (page->words[wordnum] & ((bitmapword) 1 << bitnum)) != 0;
    }
}

References BITNUM, fb(), BlocktableEntry::full_offsets, BlocktableEntry::header, i, ItemPointerGetBlockNumber(), ItemPointerGetOffsetNumber(), TidStore::local, NUM_FULL_OFFSETS, BlocktableEntry::nwords, TidStore::shared, TidStoreIsShared, TidStore::tree, WORDNUM, and BlocktableEntry::words.

Referenced by check_set_block_offsets(), and vac_tid_reaped().

TidStoreIterateNext()

TidStoreIterResult * TidStoreIterateNext ( TidStoreIter *  iter )

extern

Definition at line 493 of file tidstore.c.

{
    uint64      key;
    BlocktableEntry *page;
 
    if (TidStoreIsShared(iter->ts))
        page = shared_ts_iterate_next(iter->tree_iter.shared, &key);
    else
        page = local_ts_iterate_next(iter->tree_iter.local, &key);
 
    if (page == NULL)
        return NULL;
 
    iter->output.blkno = key;
    iter->output.internal_page = page;
 
    return &(iter->output);
}

References TidStoreIterResult::blkno, fb(), TidStoreIterResult::internal_page, TidStoreIter::local, TidStoreIter::output, TidStoreIter::shared, TidStoreIsShared, TidStoreIter::tree_iter, and TidStoreIter::ts.

Referenced by check_set_block_offsets(), and vacuum_reap_lp_read_stream_next().

TidStoreLockExclusive()

void TidStoreLockExclusive ( TidStore *  ts )

extern

Definition at line 287 of file tidstore.c.

{
    if (TidStoreIsShared(ts))
        shared_ts_lock_exclusive(ts->tree.shared);
}

References fb(), TidStore::shared, TidStoreIsShared, and TidStore::tree.

Referenced by do_set_block_offsets().

TidStoreLockShare()

void TidStoreLockShare ( TidStore *  ts )

extern

Definition at line 294 of file tidstore.c.

{
    if (TidStoreIsShared(ts))
        shared_ts_lock_share(ts->tree.shared);
}

References fb(), TidStore::shared, TidStoreIsShared, and TidStore::tree.

Referenced by check_set_block_offsets().

TidStoreMemoryUsage()

size_t TidStoreMemoryUsage ( TidStore *  ts )

extern

Definition at line 532 of file tidstore.c.

{
    if (TidStoreIsShared(ts))
        return shared_ts_memory_usage(ts->tree.shared);
    else
        return local_ts_memory_usage(ts->tree.local);
}

References fb(), TidStore::local, TidStore::shared, TidStoreIsShared, and TidStore::tree.

Referenced by dead_items_add(), dead_items_reset(), heap_vacuum_rel(), lazy_scan_heap(), lazy_vacuum(), test_create(), and test_is_full().

TidStoreSetBlockOffsets()

void TidStoreSetBlockOffsets ( TidStore *  ts, BlockNumber  blkno, OffsetNumber *  offsets, int  num_offsets  )

extern

Definition at line 345 of file tidstore.c.

{
    union
    {
        char        data[MaxBlocktableEntrySize];
        BlocktableEntry force_align_entry;
    }           data;
    BlocktableEntry *page = (BlocktableEntry *) data.data;
    bitmapword  word;
    int         wordnum;
    int         next_word_threshold;
    int         idx = 0;
 
    Assert(num_offsets > 0);
 
    /* Check if the given offset numbers are ordered */
    for (int i = 1; i < num_offsets; i++)
        Assert(offsets[i] > offsets[i - 1]);
 
    memset(page, 0, offsetof(BlocktableEntry, words));
 
    if (num_offsets <= NUM_FULL_OFFSETS)
    {
        for (int i = 0; i < num_offsets; i++)
        {
            OffsetNumber off = offsets[i];
 
            /* safety check to ensure we don't overrun bit array bounds */
            if (off == InvalidOffsetNumber || off > MAX_OFFSET_IN_BITMAP)
                elog(ERROR, "tuple offset out of range: %u", off);
 
            page->header.full_offsets[i] = off;
        }
 
        page->header.nwords = 0;
    }
    else
    {
        for (wordnum = 0, next_word_threshold = BITS_PER_BITMAPWORD;
             wordnum <= WORDNUM(offsets[num_offsets - 1]);
             wordnum++, next_word_threshold += BITS_PER_BITMAPWORD)
        {
            word = 0;
 
            while (idx < num_offsets)
            {
                OffsetNumber off = offsets[idx];
 
                /* safety check to ensure we don't overrun bit array bounds */
                if (off == InvalidOffsetNumber || off > MAX_OFFSET_IN_BITMAP)
                    elog(ERROR, "tuple offset out of range: %u", off);
 
                if (off >= next_word_threshold)
                    break;
 
                word |= ((bitmapword) 1 << BITNUM(off));
                idx++;
            }
 
            /* write out offset bitmap for this wordnum */
            page->words[wordnum] = word;
        }
 
        page->header.nwords = wordnum;
        Assert(page->header.nwords == WORDS_PER_PAGE(offsets[num_offsets - 1]));
    }
 
    if (TidStoreIsShared(ts))
        shared_ts_set(ts->tree.shared, blkno, page);
    else
        local_ts_set(ts->tree.local, blkno, page);
}

References Assert, BITNUM, BITS_PER_BITMAPWORD, data, elog, ERROR, fb(), BlocktableEntry::full_offsets, BlocktableEntry::header, i, idx(), InvalidOffsetNumber, TidStore::local, MAX_OFFSET_IN_BITMAP, MaxBlocktableEntrySize, NUM_FULL_OFFSETS, BlocktableEntry::nwords, TidStore::shared, TidStoreIsShared, TidStore::tree, word(), WORDNUM, BlocktableEntry::words, and WORDS_PER_PAGE.

Referenced by dead_items_add(), and do_set_block_offsets().

TidStoreUnlock()

void TidStoreUnlock ( TidStore *  ts )

extern

Definition at line 301 of file tidstore.c.

{
    if (TidStoreIsShared(ts))
        shared_ts_unlock(ts->tree.shared);
}

References fb(), TidStore::shared, TidStoreIsShared, and TidStore::tree.

Referenced by check_set_block_offsets(), and do_set_block_offsets().