test_tidstore.c File Reference

#include "postgres.h"
#include "access/tidstore.h"
#include "fmgr.h"
#include "storage/block.h"
#include "storage/itemptr.h"
#include "storage/lwlock.h"
#include "utils/array.h"
#include "utils/memutils.h"

Include dependency graph for test_tidstore.c:

Go to the source code of this file.

Data Structures
struct	ItemArray

Typedefs
typedef struct ItemArray	ItemArray

Functions
	PG_FUNCTION_INFO_V1 (test_create)
	PG_FUNCTION_INFO_V1 (do_set_block_offsets)
	PG_FUNCTION_INFO_V1 (check_set_block_offsets)
	PG_FUNCTION_INFO_V1 (test_is_full)
	PG_FUNCTION_INFO_V1 (test_destroy)
static int	itemptr_cmp (const void *left, const void *right)
static int	offsetnumber_cmp (const void *a, const void *b)
Datum	test_create (PG_FUNCTION_ARGS)
static void	sanity_check_array (ArrayType *ta)
static void	check_tidstore_available (void)
static void	purge_from_verification_array (BlockNumber blkno)
Datum	do_set_block_offsets (PG_FUNCTION_ARGS)
Datum	check_set_block_offsets (PG_FUNCTION_ARGS)
Datum	test_is_full (PG_FUNCTION_ARGS)
Datum	test_destroy (PG_FUNCTION_ARGS)

Variables
	PG_MODULE_MAGIC
static TidStore *	tidstore = NULL
static size_t	tidstore_empty_size
static ItemArray	items

Typedef Documentation

ItemArray

typedef struct ItemArray ItemArray

Function Documentation

check_set_block_offsets()

Datum check_set_block_offsets

(

PG_FUNCTION_ARGS

)

Definition at line 234 of file test_tidstore.c.

{
    TidStoreIter *iter;
    TidStoreIterResult *iter_result;
    int         num_iter_tids = 0;
    int         num_lookup_tids = 0;
    BlockNumber prevblkno = 0;
 
    check_tidstore_available();
 
    /* lookup each member in the verification array */
    for (int i = 0; i < items.num_tids; i++)
        if (!TidStoreIsMember(tidstore, &items.insert_tids[i]))
            elog(ERROR, "missing TID with block %u, offset %u",
                 ItemPointerGetBlockNumber(&items.insert_tids[i]),
                 ItemPointerGetOffsetNumber(&items.insert_tids[i]));
 
    /*
     * Lookup all possible TIDs for each distinct block in the verification
     * array and save successful lookups in the lookup array.
     */
 
    for (int i = 0; i < items.num_tids; i++)
    {
        BlockNumber blkno = ItemPointerGetBlockNumber(&items.insert_tids[i]);
 
        if (i > 0 && blkno == prevblkno)
            continue;
 
        for (OffsetNumber offset = FirstOffsetNumber; offset < MaxOffsetNumber; offset++)
        {
            ItemPointerData tid;
 
            ItemPointerSet(&tid, blkno, offset);
 
            TidStoreLockShare(tidstore);
            if (TidStoreIsMember(tidstore, &tid))
                ItemPointerSet(&items.lookup_tids[num_lookup_tids++], blkno, offset);
            TidStoreUnlock(tidstore);
        }
 
        prevblkno = blkno;
    }
 
    /* Collect TIDs stored in the tidstore, in order */
 
    TidStoreLockShare(tidstore);
    iter = TidStoreBeginIterate(tidstore);
    while ((iter_result = TidStoreIterateNext(iter)) != NULL)
    {
        OffsetNumber offsets[MaxOffsetNumber];
        int         num_offsets;
 
        num_offsets = TidStoreGetBlockOffsets(iter_result, offsets, lengthof(offsets));
        Assert(num_offsets <= lengthof(offsets));
        for (int i = 0; i < num_offsets; i++)
            ItemPointerSet(&(items.iter_tids[num_iter_tids++]), iter_result->blkno,
                           offsets[i]);
    }
    TidStoreEndIterate(iter);
    TidStoreUnlock(tidstore);
 
    /*
     * Sort verification and lookup arrays and test that all arrays are the
     * same.
     */
 
    if (num_lookup_tids != items.num_tids)
        elog(ERROR, "should have %d TIDs, have %d", items.num_tids, num_lookup_tids);
    if (num_iter_tids != items.num_tids)
        elog(ERROR, "should have %d TIDs, have %d", items.num_tids, num_iter_tids);
 
    qsort(items.insert_tids, items.num_tids, sizeof(ItemPointerData), itemptr_cmp);
    qsort(items.lookup_tids, items.num_tids, sizeof(ItemPointerData), itemptr_cmp);
    for (int i = 0; i < items.num_tids; i++)
    {
        if (itemptr_cmp(&items.insert_tids[i], &items.iter_tids[i]) != 0)
            elog(ERROR, "TID iter array doesn't match verification array, got (%u,%u) expected (%u,%u)",
                 ItemPointerGetBlockNumber(&items.iter_tids[i]),
                 ItemPointerGetOffsetNumber(&items.iter_tids[i]),
                 ItemPointerGetBlockNumber(&items.insert_tids[i]),
                 ItemPointerGetOffsetNumber(&items.insert_tids[i]));
        if (itemptr_cmp(&items.insert_tids[i], &items.lookup_tids[i]) != 0)
            elog(ERROR, "TID lookup array doesn't match verification array, got (%u,%u) expected (%u,%u)",
                 ItemPointerGetBlockNumber(&items.lookup_tids[i]),
                 ItemPointerGetOffsetNumber(&items.lookup_tids[i]),
                 ItemPointerGetBlockNumber(&items.insert_tids[i]),
                 ItemPointerGetOffsetNumber(&items.insert_tids[i]));
    }
 
    PG_RETURN_VOID();
}

References Assert, check_tidstore_available(), elog, ERROR, fb(), FirstOffsetNumber, i, ItemArray::insert_tids, ItemPointerGetBlockNumber(), ItemPointerGetOffsetNumber(), ItemPointerSet(), itemptr_cmp(), items, ItemArray::iter_tids, lengthof, ItemArray::lookup_tids, MaxOffsetNumber, ItemArray::num_tids, PG_RETURN_VOID, qsort, tidstore, TidStoreBeginIterate(), TidStoreEndIterate(), TidStoreGetBlockOffsets(), TidStoreIsMember(), TidStoreIterateNext(), TidStoreLockShare(), and TidStoreUnlock().

check_tidstore_available()

static void check_tidstore_available ( void  )

static

Definition at line 161 of file test_tidstore.c.

{
    if (tidstore == NULL)
        elog(ERROR, "tidstore is not created");
}

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

Referenced by check_set_block_offsets(), do_set_block_offsets(), test_destroy(), and test_is_full().

do_set_block_offsets()

Datum do_set_block_offsets

(

PG_FUNCTION_ARGS

)

Definition at line 181 of file test_tidstore.c.

{
    BlockNumber blkno = PG_GETARG_INT64(0);
    ArrayType  *ta = PG_GETARG_ARRAYTYPE_P_COPY(1);
    OffsetNumber *offs;
    int         noffs;
 
    check_tidstore_available();
    sanity_check_array(ta);
 
    noffs = ArrayGetNItems(ARR_NDIM(ta), ARR_DIMS(ta));
    offs = ((OffsetNumber *) ARR_DATA_PTR(ta));
 
    /* TidStoreSetBlockOffsets() requires offsets to be strictly ascending. */
    qsort(offs, noffs, sizeof(OffsetNumber), offsetnumber_cmp);
 
    /* Set TIDs in the store */
    TidStoreLockExclusive(tidstore);
    TidStoreSetBlockOffsets(tidstore, blkno, offs, noffs);
    TidStoreUnlock(tidstore);
 
    /* Remove the existing items of blkno from the verification array */
    purge_from_verification_array(blkno);
 
    /* Set TIDs in verification array */
    for (int i = 0; i < noffs; i++)
    {
        ItemPointer tid;
        int         idx = items.num_tids + i;
 
        /* Enlarge the TID arrays if necessary */
        if (idx >= items.max_tids)
        {
            items.max_tids *= 2;
            items.insert_tids = repalloc(items.insert_tids, sizeof(ItemPointerData) * items.max_tids);
            items.lookup_tids = repalloc(items.lookup_tids, sizeof(ItemPointerData) * items.max_tids);
            items.iter_tids = repalloc(items.iter_tids, sizeof(ItemPointerData) * items.max_tids);
        }
 
        tid = &(items.insert_tids[idx]);
        ItemPointerSet(tid, blkno, offs[i]);
    }
 
    /* Update statistics */
    items.num_tids += noffs;
 
    PG_RETURN_INT64(blkno);
}

References ARR_DATA_PTR, ARR_DIMS, ARR_NDIM, ArrayGetNItems(), check_tidstore_available(), fb(), i, idx(), ItemArray::insert_tids, ItemPointerSet(), items, ItemArray::iter_tids, ItemArray::lookup_tids, ItemArray::max_tids, ItemArray::num_tids, offsetnumber_cmp(), PG_GETARG_ARRAYTYPE_P_COPY, PG_GETARG_INT64, PG_RETURN_INT64, purge_from_verification_array(), qsort, repalloc(), sanity_check_array(), tidstore, TidStoreLockExclusive(), TidStoreSetBlockOffsets(), and TidStoreUnlock().

itemptr_cmp()

static int itemptr_cmp ( const void *  left, const void *  right  )

static

Definition at line 52 of file test_tidstore.c.

{
    BlockNumber lblk,
                rblk;
    OffsetNumber loff,
                roff;
 
    lblk = ItemPointerGetBlockNumber((const ItemPointerData *) left);
    rblk = ItemPointerGetBlockNumber((const ItemPointerData *) right);
 
    if (lblk < rblk)
        return -1;
    if (lblk > rblk)
        return 1;
 
    loff = ItemPointerGetOffsetNumber((const ItemPointerData *) left);
    roff = ItemPointerGetOffsetNumber((const ItemPointerData *) right);
 
    if (loff < roff)
        return -1;
    if (loff > roff)
        return 1;
 
    return 0;
}

References fb(), ItemPointerGetBlockNumber(), and ItemPointerGetOffsetNumber().

Referenced by check_set_block_offsets().

offsetnumber_cmp()

static int offsetnumber_cmp ( const void *  a, const void *  b  )

static

Definition at line 79 of file test_tidstore.c.

{
    OffsetNumber l = *(const OffsetNumber *) a;
    OffsetNumber r = *(const OffsetNumber *) b;
 
    if (l < r)
        return -1;
    else if (l > r)
        return 1;
    return 0;
}

References a, and b.

Referenced by do_set_block_offsets().

PG_FUNCTION_INFO_V1() [1/5]

PG_FUNCTION_INFO_V1

(

check_set_block_offsets

)

PG_FUNCTION_INFO_V1() [2/5]

PG_FUNCTION_INFO_V1

(

do_set_block_offsets

)

PG_FUNCTION_INFO_V1() [3/5]

PG_FUNCTION_INFO_V1

(

test_create

)

PG_FUNCTION_INFO_V1() [4/5]

PG_FUNCTION_INFO_V1

(

test_destroy

)

PG_FUNCTION_INFO_V1() [5/5]

PG_FUNCTION_INFO_V1

(

test_is_full

)

purge_from_verification_array()

static void purge_from_verification_array ( BlockNumber  blkno )

static

Definition at line 168 of file test_tidstore.c.

{
    int         dst = 0;
 
    for (int src = 0; src < items.num_tids; src++)
        if (ItemPointerGetBlockNumber(&items.insert_tids[src]) != blkno)
            items.insert_tids[dst++] = items.insert_tids[src];
    items.num_tids = dst;
}

References fb(), ItemArray::insert_tids, ItemPointerGetBlockNumber(), items, and ItemArray::num_tids.

Referenced by do_set_block_offsets().

sanity_check_array()

static void sanity_check_array ( ArrayType *  ta )

static

Definition at line 147 of file test_tidstore.c.

{
    if (ARR_HASNULL(ta) && array_contains_nulls(ta))
        ereport(ERROR,
                (errcode(ERRCODE_NULL_VALUE_NOT_ALLOWED),
                 errmsg("array must not contain nulls")));
 
    if (ARR_NDIM(ta) > 1)
        ereport(ERROR,
                (errcode(ERRCODE_DATA_EXCEPTION),
                 errmsg("argument must be empty or one-dimensional array")));
}

References ARR_HASNULL, ARR_NDIM, array_contains_nulls(), ereport, errcode(), errmsg, ERROR, and fb().

Referenced by do_set_block_offsets().

test_create()

Datum test_create

(

PG_FUNCTION_ARGS

)

Definition at line 98 of file test_tidstore.c.

{
    bool        shared = PG_GETARG_BOOL(0);
    MemoryContext old_ctx;
 
    /* doesn't really matter, since it's just a hint */
    size_t      tidstore_max_size = 2 * 1024 * 1024;
    size_t      array_init_size = 1024;
 
    Assert(tidstore == NULL);
 
    /*
     * Create the TidStore on TopMemoryContext so that the same process use it
     * for subsequent tests.
     */
    old_ctx = MemoryContextSwitchTo(TopMemoryContext);
 
    if (shared)
    {
        int         tranche_id;
 
        tranche_id = LWLockNewTrancheId("test_tidstore");
 
        tidstore = TidStoreCreateShared(tidstore_max_size, tranche_id);
 
        /*
         * Remain attached until end of backend or explicitly detached so that
         * the same process use the tidstore for subsequent tests.
         */
        dsa_pin_mapping(TidStoreGetDSA(tidstore));
    }
    else
        /* VACUUM uses insert only, so we test the other option. */
        tidstore = TidStoreCreateLocal(tidstore_max_size, false);
 
    tidstore_empty_size = TidStoreMemoryUsage(tidstore);
 
    items.num_tids = 0;
    items.max_tids = array_init_size / sizeof(ItemPointerData);
    items.insert_tids = (ItemPointerData *) palloc0(array_init_size);
    items.lookup_tids = (ItemPointerData *) palloc0(array_init_size);
    items.iter_tids = (ItemPointerData *) palloc0(array_init_size);
 
    MemoryContextSwitchTo(old_ctx);
 
    PG_RETURN_VOID();
}

References Assert, dsa_pin_mapping(), fb(), ItemArray::insert_tids, items, ItemArray::iter_tids, ItemArray::lookup_tids, LWLockNewTrancheId(), ItemArray::max_tids, MemoryContextSwitchTo(), ItemArray::num_tids, palloc0(), PG_GETARG_BOOL, PG_RETURN_VOID, tidstore, tidstore_empty_size, TidStoreCreateLocal(), TidStoreCreateShared(), TidStoreGetDSA(), TidStoreMemoryUsage(), and TopMemoryContext.

test_destroy()

Datum test_destroy

(

PG_FUNCTION_ARGS

)

Definition at line 346 of file test_tidstore.c.

{
    check_tidstore_available();
 
    TidStoreDestroy(tidstore);
    tidstore = NULL;
    items.num_tids = 0;
    pfree(items.insert_tids);
    pfree(items.lookup_tids);
    pfree(items.iter_tids);
 
    PG_RETURN_VOID();
}

References check_tidstore_available(), fb(), ItemArray::insert_tids, items, ItemArray::iter_tids, ItemArray::lookup_tids, ItemArray::num_tids, pfree(), PG_RETURN_VOID, tidstore, and TidStoreDestroy().

test_is_full()

Datum test_is_full

(

PG_FUNCTION_ARGS

)

Definition at line 333 of file test_tidstore.c.

{
    bool        is_full;
 
    check_tidstore_available();
 
    is_full = (TidStoreMemoryUsage(tidstore) > tidstore_empty_size);
 
    PG_RETURN_BOOL(is_full);
}

References check_tidstore_available(), fb(), PG_RETURN_BOOL, tidstore, tidstore_empty_size, and TidStoreMemoryUsage().

Variable Documentation

items

ItemArray items

static

Definition at line 48 of file test_tidstore.c.

Referenced by _bt_restore_page(), _bt_steppage(), _gin_build_tuple(), _gin_parse_tuple_items(), add_sp_items_to_pathtarget(), addItemPointersToLeafTuple(), AlterOpFamilyAdd(), AlterOpFamilyDrop(), btreevacuumposting(), btrestrpos(), build_distinct_groups(), build_mvndistinct(), build_sorted_items(), buildFreshLeafTuple(), check_set_block_offsets(), cleanup_tsquery_stopwords(), collect_corrupt_items(), count_distinct_groups(), createPostingTree(), dataBeginPlaceToPageLeaf(), dataLeafPageGetUncompressed(), dependency_degree(), do_set_block_offsets(), findComments(), findSecLabels(), gin_bool_consistent(), GinBufferStoreTuple(), ginEntryInsert(), ginInsertItemPointers(), ginint4_queryextract(), ginPostingListDecodeAllSegmentsToTbm(), ginRedoRecompress(), ginVacuumEntryPage(), ginVacuumItemPointers(), JsonValueListAppend(), load_enum_cache_data(), multirange_get_bounds_offset(), ndistinct_for_combination(), order_qual_clauses(), parsePGArray(), pg_check_frozen(), pg_check_visible(), pgstat_execute_transactional_drops(), pgstat_get_transactional_drops(), plpython_to_hstore(), PLyMapping_ToJsonbValue(), purge_from_verification_array(), record_corrupt_item(), ResourceOwnerReleaseAll(), ResourceOwnerSort(), statext_mcv_build(), statext_mcv_deserialize(), statext_mcv_import(), statext_ndistinct_build(), statext_ndistinct_deserialize(), test_create(), test_destroy(), TopologicalSort(), wrapItemsInArray(), and write_multirange_data().

PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 27 of file test_tidstore.c.

tidstore

TidStore* tidstore = NULL

static

Definition at line 35 of file test_tidstore.c.

Referenced by check_set_block_offsets(), check_tidstore_available(), do_set_block_offsets(), test_create(), test_destroy(), and test_is_full().

tidstore_empty_size

size_t tidstore_empty_size

static

Definition at line 36 of file test_tidstore.c.

Referenced by test_create(), and test_is_full().