Refactor tidstore.c iterator buffering.
authorThomas Munro <[email protected]>
Wed, 24 Jul 2024 05:24:59 +0000 (17:24 +1200)
committerThomas Munro <[email protected]>
Wed, 24 Jul 2024 05:32:35 +0000 (17:32 +1200)
Previously, TidStoreIterateNext() would expand the set of offsets for
each block into an internal buffer that it overwrote each time.  In
order to be able to collect the offsets for multiple blocks before
working with them, change the contract.  Now, the offsets are obtained
by a separate call to TidStoreGetBlockOffsets(), which can be called at
a later time.  TidStoreIteratorResult objects are safe to copy and store
in a queue.

Reviewed-by: Noah Misch <[email protected]>
Discussion: https://postgr.es/m/CAAKRu_bbkmwAzSBgnezancgJeXrQZXy4G4kBTd+5=cr86H5yew@mail.gmail.com

src/backend/access/common/tidstore.c
src/backend/access/heap/vacuumlazy.c
src/include/access/tidstore.h
src/test/modules/test_tidstore/test_tidstore.c

index fb3949d69f69fb1200ddd1d49634457891bcb16f..a7179759d67d2c3d7e7b9f9b46e38a9ece77c964 100644 (file)
@@ -147,9 +147,6 @@ struct TidStoreIter
    TidStoreIterResult output;
 };
 
-static void tidstore_iter_extract_tids(TidStoreIter *iter, BlockNumber blkno,
-                                      BlocktableEntry *page);
-
 /*
  * Create a TidStore. The TidStore will live in the memory context that is
  * CurrentMemoryContext at the time of this call. The TID storage, backed
@@ -486,13 +483,6 @@ TidStoreBeginIterate(TidStore *ts)
    iter = palloc0(sizeof(TidStoreIter));
    iter->ts = ts;
 
-   /*
-    * We start with an array large enough to contain at least the offsets
-    * from one completely full bitmap element.
-    */
-   iter->output.max_offset = 2 * BITS_PER_BITMAPWORD;
-   iter->output.offsets = palloc(sizeof(OffsetNumber) * iter->output.max_offset);
-
    if (TidStoreIsShared(ts))
        iter->tree_iter.shared = shared_ts_begin_iterate(ts->tree.shared);
    else
@@ -503,9 +493,9 @@ TidStoreBeginIterate(TidStore *ts)
 
 
 /*
- * Scan the TidStore and return the TIDs of the next block. The offsets in
- * each iteration result are ordered, as are the block numbers over all
- * iterations.
+ * Return a result that contains the next block number and that can be used to
+ * obtain the set of offsets by calling TidStoreGetBlockOffsets().  The result
+ * is copyable.
  */
 TidStoreIterResult *
 TidStoreIterateNext(TidStoreIter *iter)
@@ -521,8 +511,8 @@ TidStoreIterateNext(TidStoreIter *iter)
    if (page == NULL)
        return NULL;
 
-   /* Collect TIDs from the key-value pair */
-   tidstore_iter_extract_tids(iter, (BlockNumber) key, page);
+   iter->output.blkno = key;
+   iter->output.internal_page = page;
 
    return &(iter->output);
 }
@@ -540,7 +530,6 @@ TidStoreEndIterate(TidStoreIter *iter)
    else
        local_ts_end_iterate(iter->tree_iter.local);
 
-   pfree(iter->output.offsets);
    pfree(iter);
 }
 
@@ -575,24 +564,32 @@ TidStoreGetHandle(TidStore *ts)
    return (dsa_pointer) shared_ts_get_handle(ts->tree.shared);
 }
 
-/* Extract TIDs from the given key-value pair */
-static void
-tidstore_iter_extract_tids(TidStoreIter *iter, BlockNumber blkno,
-                          BlocktableEntry *page)
+/*
+ * Given a TidStoreIterResult returned by TidStoreIterateNext(), extract the
+ * offset numbers.  Returns the number of offsets filled in, if <=
+ * max_offsets.  Otherwise, fills in as much as it can in the given space, and
+ * returns the size of the buffer that would be needed.
+ */
+int
+TidStoreGetBlockOffsets(TidStoreIterResult *result,
+                       OffsetNumber *offsets,
+                       int max_offsets)
 {
-   TidStoreIterResult *result = (&iter->output);
+   BlocktableEntry *page = result->internal_page;
+   int         num_offsets = 0;
    int         wordnum;
 
-   result->num_offsets = 0;
-   result->blkno = blkno;
-
    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)
-               result->offsets[result->num_offsets++] = page->header.full_offsets[i];
+           {
+               if (num_offsets < max_offsets)
+                   offsets[num_offsets] = page->header.full_offsets[i];
+               num_offsets++;
+           }
        }
    }
    else
@@ -602,21 +599,19 @@ tidstore_iter_extract_tids(TidStoreIter *iter, BlockNumber blkno,
            bitmapword  w = page->words[wordnum];
            int         off = wordnum * BITS_PER_BITMAPWORD;
 
-           /* Make sure there is enough space to add offsets */
-           if ((result->num_offsets + BITS_PER_BITMAPWORD) > result->max_offset)
-           {
-               result->max_offset *= 2;
-               result->offsets = repalloc(result->offsets,
-                                          sizeof(OffsetNumber) * result->max_offset);
-           }
-
            while (w != 0)
            {
                if (w & 1)
-                   result->offsets[result->num_offsets++] = (OffsetNumber) off;
+               {
+                   if (num_offsets < max_offsets)
+                       offsets[num_offsets] = (OffsetNumber) off;
+                   num_offsets++;
+               }
                off++;
                w >>= 1;
            }
        }
    }
+
+   return num_offsets;
 }
index abb47ae596098ea61f28fff5baa34de748a56494..835b53415d0b7b5861f3966944e622016432dcb4 100644 (file)
@@ -2126,12 +2126,17 @@ lazy_vacuum_heap_rel(LVRelState *vacrel)
        Buffer      buf;
        Page        page;
        Size        freespace;
+       OffsetNumber offsets[MaxOffsetNumber];
+       int         num_offsets;
 
        vacuum_delay_point();
 
        blkno = iter_result->blkno;
        vacrel->blkno = blkno;
 
+       num_offsets = TidStoreGetBlockOffsets(iter_result, offsets, lengthof(offsets));
+       Assert(num_offsets <= lengthof(offsets));
+
        /*
         * Pin the visibility map page in case we need to mark the page
         * all-visible.  In most cases this will be very cheap, because we'll
@@ -2143,8 +2148,8 @@ lazy_vacuum_heap_rel(LVRelState *vacrel)
        buf = ReadBufferExtended(vacrel->rel, MAIN_FORKNUM, blkno, RBM_NORMAL,
                                 vacrel->bstrategy);
        LockBuffer(buf, BUFFER_LOCK_EXCLUSIVE);
-       lazy_vacuum_heap_page(vacrel, blkno, buf, iter_result->offsets,
-                             iter_result->num_offsets, vmbuffer);
+       lazy_vacuum_heap_page(vacrel, blkno, buf, offsets,
+                             num_offsets, vmbuffer);
 
        /* Now that we've vacuumed the page, record its available space */
        page = BufferGetPage(buf);
index 32aa9995193fa54e26ea31afb1fa7f3d89aaf6be..d95cabd7b5e65fe4e2b848c453ed5ef54341d07b 100644 (file)
 typedef struct TidStore TidStore;
 typedef struct TidStoreIter TidStoreIter;
 
-/* Result struct for TidStoreIterateNext */
+/*
+ * Result struct for TidStoreIterateNext.  This is copyable, but should be
+ * treated as opaque.  Call TidStoreGetOffsets() to obtain the offsets.
+ */
 typedef struct TidStoreIterResult
 {
    BlockNumber blkno;
-   int         max_offset;
-   int         num_offsets;
-   OffsetNumber *offsets;
+   void       *internal_page;
 } TidStoreIterResult;
 
 extern TidStore *TidStoreCreateLocal(size_t max_bytes, bool insert_only);
@@ -42,6 +43,9 @@ extern void TidStoreSetBlockOffsets(TidStore *ts, BlockNumber blkno, OffsetNumbe
 extern bool TidStoreIsMember(TidStore *ts, ItemPointer tid);
 extern TidStoreIter *TidStoreBeginIterate(TidStore *ts);
 extern TidStoreIterResult *TidStoreIterateNext(TidStoreIter *iter);
+extern int TidStoreGetBlockOffsets(TidStoreIterResult *result,
+                                   OffsetNumber *offsets,
+                                   int max_offsets);
 extern void TidStoreEndIterate(TidStoreIter *iter);
 extern size_t TidStoreMemoryUsage(TidStore *ts);
 extern dsa_pointer TidStoreGetHandle(TidStore *ts);
index 3f6a11bf21c3889882d8c8b06d268109b0587c5b..94ddcf1de826ad77144493cd7a0e1fcbd52e577d 100644 (file)
@@ -267,9 +267,14 @@ check_set_block_offsets(PG_FUNCTION_ARGS)
    iter = TidStoreBeginIterate(tidstore);
    while ((iter_result = TidStoreIterateNext(iter)) != NULL)
    {
-       for (int i = 0; i < iter_result->num_offsets; i++)
+       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,
-                          iter_result->offsets[i]);
+                          offsets[i]);
    }
    TidStoreEndIterate(iter);
    TidStoreUnlock(tidstore);