if (entry->matchBitmap)
{
if (entry->matchIterator)
- tbm_end_iterate(entry->matchIterator);
+ tbm_end_private_iterate(entry->matchIterator);
entry->matchIterator = NULL;
tbm_free(entry->matchBitmap);
entry->matchBitmap = NULL;
if (entry->matchBitmap && !tbm_is_empty(entry->matchBitmap))
{
- entry->matchIterator = tbm_begin_iterate(entry->matchBitmap);
+ entry->matchIterator =
+ tbm_begin_private_iterate(entry->matchBitmap);
entry->isFinished = false;
}
}
(ItemPointerIsLossyPage(&advancePast) &&
entry->matchResult->blockno == advancePastBlk))
{
- entry->matchResult = tbm_iterate(entry->matchIterator);
+ entry->matchResult =
+ tbm_private_iterate(entry->matchIterator);
if (entry->matchResult == NULL)
{
ItemPointerSetInvalid(&entry->curItem);
- tbm_end_iterate(entry->matchIterator);
+ tbm_end_private_iterate(entry->matchIterator);
entry->matchIterator = NULL;
entry->isFinished = true;
break;
if (entry->list)
pfree(entry->list);
if (entry->matchIterator)
- tbm_end_iterate(entry->matchIterator);
+ tbm_end_private_iterate(entry->matchIterator);
if (entry->matchBitmap)
tbm_free(entry->matchBitmap);
}
if (scan->st.bitmap.rs_shared_iterator)
tbmres = tbm_shared_iterate(scan->st.bitmap.rs_shared_iterator);
else
- tbmres = tbm_iterate(scan->st.bitmap.rs_iterator);
+ tbmres = tbm_private_iterate(scan->st.bitmap.rs_iterator);
if (tbmres == NULL)
return false;
*/
if (!node->initialized)
{
- TBMIterator *tbmiterator = NULL;
+ TBMPrivateIterator *tbmiterator = NULL;
TBMSharedIterator *shared_tbmiterator = NULL;
if (!pstate)
elog(ERROR, "unrecognized result from subplan");
node->tbm = tbm;
- tbmiterator = tbm_begin_iterate(tbm);
+ tbmiterator = tbm_begin_private_iterate(tbm);
#ifdef USE_PREFETCH
if (node->prefetch_maximum > 0)
{
- node->prefetch_iterator = tbm_begin_iterate(tbm);
+ node->prefetch_iterator = tbm_begin_private_iterate(tbm);
node->prefetch_pages = 0;
node->prefetch_target = -1;
}
if (pstate == NULL)
{
- TBMIterator *prefetch_iterator = node->prefetch_iterator;
+ TBMPrivateIterator *prefetch_iterator = node->prefetch_iterator;
if (node->prefetch_pages > 0)
{
}
else if (prefetch_iterator)
{
- tbmpre = tbm_iterate(prefetch_iterator);
+ tbmpre = tbm_private_iterate(prefetch_iterator);
node->prefetch_blockno = tbmpre ? tbmpre->blockno :
InvalidBlockNumber;
}
if (pstate == NULL)
{
- TBMIterator *prefetch_iterator = node->prefetch_iterator;
+ TBMPrivateIterator *prefetch_iterator = node->prefetch_iterator;
if (prefetch_iterator)
{
while (node->prefetch_pages < node->prefetch_target)
{
- TBMIterateResult *tbmpre = tbm_iterate(prefetch_iterator);
+ TBMIterateResult *tbmpre;
bool skip_fetch;
+ tbmpre = tbm_private_iterate(prefetch_iterator);
if (tbmpre == NULL)
{
/* No more pages to prefetch */
- tbm_end_iterate(prefetch_iterator);
+ tbm_end_private_iterate(prefetch_iterator);
node->prefetch_iterator = NULL;
break;
}
if (scan->st.bitmap.rs_iterator)
{
- tbm_end_iterate(scan->st.bitmap.rs_iterator);
+ tbm_end_private_iterate(scan->st.bitmap.rs_iterator);
scan->st.bitmap.rs_iterator = NULL;
}
/* release bitmaps and buffers if any */
if (node->prefetch_iterator)
- tbm_end_iterate(node->prefetch_iterator);
+ tbm_end_private_iterate(node->prefetch_iterator);
if (node->shared_prefetch_iterator)
tbm_end_shared_iterate(node->shared_prefetch_iterator);
if (node->tbm)
if (scanDesc->st.bitmap.rs_iterator)
{
- tbm_end_iterate(scanDesc->st.bitmap.rs_iterator);
+ tbm_end_private_iterate(scanDesc->st.bitmap.rs_iterator);
scanDesc->st.bitmap.rs_iterator = NULL;
}
* release bitmaps and buffers if any
*/
if (node->prefetch_iterator)
- tbm_end_iterate(node->prefetch_iterator);
+ tbm_end_private_iterate(node->prefetch_iterator);
if (node->tbm)
tbm_free(node->tbm);
if (node->shared_prefetch_iterator)
};
/*
- * When iterating over a bitmap in sorted order, a TBMIterator is used to
- * track our progress. There can be several iterators scanning the same
- * bitmap concurrently. Note that the bitmap becomes read-only as soon as
- * any iterator is created.
+ * When iterating over a backend-local bitmap in sorted order, a
+ * TBMPrivateIterator is used to track our progress. There can be several
+ * iterators scanning the same bitmap concurrently. Note that the bitmap
+ * becomes read-only as soon as any iterator is created.
*/
-struct TBMIterator
+struct TBMPrivateIterator
{
TIDBitmap *tbm; /* TIDBitmap we're iterating over */
int spageptr; /* next spages index */
} PTIterationArray;
/*
- * same as TBMIterator, but it is used for joint iteration, therefore this
- * also holds a reference to the shared state.
+ * same as TBMPrivateIterator, but it is used for joint iteration, therefore
+ * this also holds a reference to the shared state.
*/
struct TBMSharedIterator
{
}
/*
- * tbm_begin_iterate - prepare to iterate through a TIDBitmap
+ * tbm_begin_private_iterate - prepare to iterate through a TIDBitmap
*
- * The TBMIterator struct is created in the caller's memory context.
- * For a clean shutdown of the iteration, call tbm_end_iterate; but it's
- * okay to just allow the memory context to be released, too. It is caller's
- * responsibility not to touch the TBMIterator anymore once the TIDBitmap
- * is freed.
+ * The TBMPrivateIterator struct is created in the caller's memory context.
+ * For a clean shutdown of the iteration, call tbm_end_private_iterate; but
+ * it's okay to just allow the memory context to be released, too. It is
+ * caller's responsibility not to touch the TBMPrivateIterator anymore once
+ * the TIDBitmap is freed.
*
* NB: after this is called, it is no longer allowed to modify the contents
* of the bitmap. However, you can call this multiple times to scan the
* contents repeatedly, including parallel scans.
*/
-TBMIterator *
-tbm_begin_iterate(TIDBitmap *tbm)
+TBMPrivateIterator *
+tbm_begin_private_iterate(TIDBitmap *tbm)
{
- TBMIterator *iterator;
+ TBMPrivateIterator *iterator;
Assert(tbm->iterating != TBM_ITERATING_SHARED);
/*
- * Create the TBMIterator struct, with enough trailing space to serve the
- * needs of the TBMIterateResult sub-struct.
+ * Create the TBMPrivateIterator struct, with enough trailing space to
+ * serve the needs of the TBMIterateResult sub-struct.
*/
- iterator = (TBMIterator *) palloc(sizeof(TBMIterator) +
- MAX_TUPLES_PER_PAGE * sizeof(OffsetNumber));
+ iterator = (TBMPrivateIterator *) palloc(sizeof(TBMPrivateIterator) +
+ MAX_TUPLES_PER_PAGE *
+ sizeof(OffsetNumber));
iterator->tbm = tbm;
/*
ptchunks = dsa_get_address(tbm->dsa, tbm->ptchunks);
/*
- * For every shared iterator, referring to pagetable and iterator array,
+ * For every shared iterator referring to pagetable and iterator array,
* increase the refcount by 1 so that while freeing the shared iterator we
* don't free pagetable and iterator array until its refcount becomes 0.
*/
}
/*
- * tbm_iterate - scan through next page of a TIDBitmap
+ * tbm_private_iterate - scan through next page of a TIDBitmap
*
* Returns a TBMIterateResult representing one page, or NULL if there are
* no more pages to scan. Pages are guaranteed to be delivered in numerical
* testing, recheck is always set true when ntuples < 0.)
*/
TBMIterateResult *
-tbm_iterate(TBMIterator *iterator)
+tbm_private_iterate(TBMPrivateIterator *iterator)
{
TIDBitmap *tbm = iterator->tbm;
TBMIterateResult *output = &(iterator->output);
}
/*
- * tbm_end_iterate - finish an iteration over a TIDBitmap
+ * tbm_end_private_iterate - finish an iteration over a TIDBitmap
*
* Currently this is just a pfree, but it might do more someday. (For
* instance, it could be useful to count open iterators and allow the
* bitmap to return to read/write status when there are no more iterators.)
*/
void
-tbm_end_iterate(TBMIterator *iterator)
+tbm_end_private_iterate(TBMPrivateIterator *iterator)
{
pfree(iterator);
}
return nbuckets;
}
+
+/*
+ * Create a shared or private bitmap iterator and start iteration.
+ *
+ * `tbm` is only used to create the private iterator and dsa and dsp are only
+ * used to create the shared iterator.
+ *
+ * Before invoking tbm_begin_iterate() to create a shared iterator, one
+ * process must already have invoked tbm_prepare_shared_iterate() to create
+ * and set up the TBMSharedIteratorState.
+ */
+TBMIterator
+tbm_begin_iterate(TIDBitmap *tbm, dsa_area *dsa, dsa_pointer dsp)
+{
+ TBMIterator iterator = {0};
+
+ /* Allocate a private iterator and attach the shared state to it */
+ if (DsaPointerIsValid(dsp))
+ {
+ iterator.shared = true;
+ iterator.i.shared_iterator = tbm_attach_shared_iterate(dsa, dsp);
+ }
+ else
+ {
+ iterator.shared = false;
+ iterator.i.private_iterator = tbm_begin_private_iterate(tbm);
+ }
+
+ return iterator;
+}
+
+/*
+ * Clean up shared or private bitmap iterator.
+ */
+void
+tbm_end_iterate(TBMIterator *iterator)
+{
+ Assert(iterator);
+
+ if (iterator->shared)
+ tbm_end_shared_iterate(iterator->i.shared_iterator);
+ else
+ tbm_end_private_iterate(iterator->i.private_iterator);
+
+ *iterator = (TBMIterator)
+ {
+ 0
+ };
+}
+
+/*
+ * Get the next TBMIterateResult from the shared or private bitmap iterator.
+ */
+TBMIterateResult *
+tbm_iterate(TBMIterator *iterator)
+{
+ Assert(iterator);
+
+ if (iterator->shared)
+ return tbm_shared_iterate(iterator->i.shared_iterator);
+ else
+ return tbm_private_iterate(iterator->i.private_iterator);
+}
/* for a partial-match or full-scan query, we accumulate all TIDs here */
TIDBitmap *matchBitmap;
- TBMIterator *matchIterator;
+ TBMPrivateIterator *matchIterator;
TBMIterateResult *matchResult;
/* used for Posting list and one page in Posting tree */
struct ParallelTableScanDescData;
-struct TBMIterator;
+struct TBMPrivateIterator;
struct TBMSharedIterator;
/*
/* Iterators for Bitmap Table Scans */
struct
{
- struct TBMIterator *rs_iterator;
+ struct TBMPrivateIterator *rs_iterator;
struct TBMSharedIterator *rs_shared_iterator;
} bitmap;
TIDBitmap *tbm;
Buffer pvmbuffer;
BitmapHeapScanInstrumentation stats;
- TBMIterator *prefetch_iterator;
+ TBMPrivateIterator *prefetch_iterator;
int prefetch_pages;
int prefetch_target;
int prefetch_maximum;
*/
typedef struct TIDBitmap TIDBitmap;
-/* Likewise, TBMIterator is private */
-typedef struct TBMIterator TBMIterator;
+/* Likewise, TBMPrivateIterator is private */
+typedef struct TBMPrivateIterator TBMPrivateIterator;
typedef struct TBMSharedIterator TBMSharedIterator;
+/*
+ * Callers with both private and shared implementations can use this unified
+ * API.
+ */
+typedef struct TBMIterator
+{
+ bool shared;
+ union
+ {
+ TBMPrivateIterator *private_iterator;
+ TBMSharedIterator *shared_iterator;
+ } i;
+} TBMIterator;
+
/* Result structure for tbm_iterate */
typedef struct TBMIterateResult
{
extern bool tbm_is_empty(const TIDBitmap *tbm);
-extern TBMIterator *tbm_begin_iterate(TIDBitmap *tbm);
+extern TBMPrivateIterator *tbm_begin_private_iterate(TIDBitmap *tbm);
extern dsa_pointer tbm_prepare_shared_iterate(TIDBitmap *tbm);
-extern TBMIterateResult *tbm_iterate(TBMIterator *iterator);
+extern TBMIterateResult *tbm_private_iterate(TBMPrivateIterator *iterator);
extern TBMIterateResult *tbm_shared_iterate(TBMSharedIterator *iterator);
-extern void tbm_end_iterate(TBMIterator *iterator);
+extern void tbm_end_private_iterate(TBMPrivateIterator *iterator);
extern void tbm_end_shared_iterate(TBMSharedIterator *iterator);
extern TBMSharedIterator *tbm_attach_shared_iterate(dsa_area *dsa,
dsa_pointer dp);
extern long tbm_calculate_entries(double maxbytes);
+extern TBMIterator tbm_begin_iterate(TIDBitmap *tbm,
+ dsa_area *dsa, dsa_pointer dsp);
+extern void tbm_end_iterate(TBMIterator *iterator);
+
+extern TBMIterateResult *tbm_iterate(TBMIterator *iterator);
+
#endif /* TIDBITMAP_H */
TBMIterateResult
TBMIteratingState
TBMIterator
+TBMPrivateIterator
TBMSharedIterator
TBMSharedIteratorState
TBMStatus