X-Git-Url: http://plrg.eecs.uci.edu/git/?p=folly.git;a=blobdiff_plain;f=folly%2FIndexedMemPool.h;h=82ae62954d97f05b3967723c069b604e6a224f2c;hp=d9e84935a077cedec6acc8fd75fe729d0507fed1;hb=b010847b060f99a988069ca387416a08e9dc221e;hpb=bba519bfb1b4c4d24fd210696e31fcf5e25d13e8 diff --git a/folly/IndexedMemPool.h b/folly/IndexedMemPool.h index d9e84935..82ae6295 100644 --- a/folly/IndexedMemPool.h +++ b/folly/IndexedMemPool.h @@ -16,26 +16,88 @@ #pragma once -#include #include #include #include + +#include + #include #include -#include +#include +#include #include #include // Ignore shadowing warnings within this file, so includers can use -Wshadow. -#pragma GCC diagnostic push -#pragma GCC diagnostic ignored "-Wshadow" +FOLLY_PUSH_WARNING +FOLLY_GCC_DISABLE_WARNING("-Wshadow") namespace folly { namespace detail { template struct IndexedMemPoolRecycler; -} +} // namespace detail + +template < + typename T, + bool EagerRecycleWhenTrivial = false, + bool EagerRecycleWhenNotTrivial = true> +struct IndexedMemPoolTraits { + static constexpr bool eagerRecycle() { + return std::is_trivial::value ? EagerRecycleWhenTrivial + : EagerRecycleWhenNotTrivial; + } + + /// Called when the element pointed to by ptr is allocated for the + /// first time. + static void initialize(T* ptr) { + if (!eagerRecycle()) { + new (ptr) T(); + } + } + + /// Called when the element pointed to by ptr is freed at the pool + /// destruction time. + static void cleanup(T* ptr) { + if (!eagerRecycle()) { + ptr->~T(); + } + } + + /// Called when the element is allocated with the arguments forwarded from + /// IndexedMemPool::allocElem. + template + static void onAllocate(T* ptr, Args&&... args) { + static_assert( + sizeof...(Args) == 0 || eagerRecycle(), + "emplace-style allocation requires eager recycle, " + "which is defaulted only for non-trivial types"); + if (eagerRecycle()) { + new (ptr) T(std::forward(args)...); + } + } + + /// Called when the element is recycled. + static void onRecycle(T* ptr) { + if (eagerRecycle()) { + ptr->~T(); + } + } +}; + +/// IndexedMemPool traits that implements the lazy lifecycle strategy. In this +/// strategy elements are default-constructed the first time they are allocated, +/// and destroyed when the pool itself is destroyed. +template +using IndexedMemPoolTraitsLazyRecycle = IndexedMemPoolTraits; + +/// IndexedMemPool traits that implements the eager lifecycle strategy. In this +/// strategy elements are constructed when they are allocated from the pool and +/// destroyed when recycled. +template +using IndexedMemPoolTraitsEagerRecycle = IndexedMemPoolTraits; /// Instances of IndexedMemPool dynamically allocate and then pool their /// element type (T), returning 4-byte integer indices that can be passed @@ -54,13 +116,17 @@ struct IndexedMemPoolRecycler; /// there won't be an ABA match due to the element being overwritten with /// a different type that has the same bit pattern. /// -/// IndexedMemPool has two object lifecycle strategies. The first -/// is to construct objects when they are allocated from the pool and -/// destroy them when they are recycled. In this mode allocIndex and -/// allocElem have emplace-like semantics. In the second mode, objects -/// are default-constructed the first time they are removed from the pool, -/// and deleted when the pool itself is deleted. By default the first -/// mode is used for non-trivial T, and the second is used for trivial T. +/// The object lifecycle strategy is controlled by the Traits parameter. +/// One strategy, implemented by IndexedMemPoolTraitsEagerRecycle, is to +/// construct objects when they are allocated from the pool and destroy +/// them when they are recycled. In this mode allocIndex and allocElem +/// have emplace-like semantics. In another strategy, implemented by +/// IndexedMemPoolTraitsLazyRecycle, objects are default-constructed the +/// first time they are removed from the pool, and deleted when the pool +/// itself is deleted. By default the first mode is used for non-trivial +/// T, and the second is used for trivial T. Clients can customize the +/// object lifecycle by providing their own Traits implementation. +/// See IndexedMemPoolTraits for a Traits example. /// /// IMPORTANT: Space for extra elements is allocated to account for those /// that are inaccessible because they are in other local lists, so the @@ -89,8 +155,7 @@ template < uint32_t NumLocalLists_ = 32, uint32_t LocalListLimit_ = 200, template class Atom = std::atomic, - bool EagerRecycleWhenTrivial = false, - bool EagerRecycleWhenNotTrivial = true> + typename Traits = IndexedMemPoolTraits> struct IndexedMemPool : boost::noncopyable { typedef T value_type; @@ -103,12 +168,6 @@ struct IndexedMemPool : boost::noncopyable { LocalListLimit = LocalListLimit_ }; - - static constexpr bool eagerRecycle() { - return std::is_trivial::value - ? EagerRecycleWhenTrivial : EagerRecycleWhenNotTrivial; - } - // these are public because clients may need to reason about the number // of bits required to hold indices from a pool, given its capacity @@ -149,14 +208,8 @@ struct IndexedMemPool : boost::noncopyable { /// Destroys all of the contained elements ~IndexedMemPool() { - if (!eagerRecycle()) { - // Take the minimum since it is possible that size_ > actualCapacity_. - // This can happen if there are multiple concurrent requests - // when size_ == actualCapacity_ - 1. - uint32_t last = std::min(uint32_t(size_), uint32_t(actualCapacity_)); - for (uint32_t i = last; i > 0; --i) { - slots_[i].~Slot(); - } + for (uint32_t i = maxAllocatedIndex(); i > 0; --i) { + Traits::cleanup(&slots_[i].elem); } munmap(slots_, mmapLength_); } @@ -169,25 +222,35 @@ struct IndexedMemPool : boost::noncopyable { return capacityForMaxIndex(actualCapacity_); } + /// Returns the maximum index of elements ever allocated in this pool + /// including elements that have been recycled. + uint32_t maxAllocatedIndex() const { + // Take the minimum since it is possible that size_ > actualCapacity_. + // This can happen if there are multiple concurrent requests + // when size_ == actualCapacity_ - 1. + return std::min(uint32_t(size_), uint32_t(actualCapacity_)); + } + /// Finds a slot with a non-zero index, emplaces a T there if we're /// using the eager recycle lifecycle mode, and returns the index, - /// or returns 0 if no elements are available. + /// or returns 0 if no elements are available. Passes a pointer to + /// the element to Traits::onAllocate before the slot is marked as + /// allocated. template uint32_t allocIndex(Args&&... args) { - static_assert(sizeof...(Args) == 0 || eagerRecycle(), - "emplace-style allocation requires eager recycle, " - "which is defaulted only for non-trivial types"); auto idx = localPop(localHead()); - if (idx != 0 && eagerRecycle()) { - T* ptr = &slot(idx).elem; - new (ptr) T(std::forward(args)...); + if (idx != 0) { + Slot& s = slot(idx); + Traits::onAllocate(&s.elem, std::forward(args)...); + markAllocated(s); } return idx; } /// If an element is available, returns a std::unique_ptr to it that will /// recycle the element to the pool when it is reclaimed, otherwise returns - /// a null (falsy) std::unique_ptr + /// a null (falsy) std::unique_ptr. Passes a pointer to the element to + /// Traits::onAllocate before the slot is marked as allocated. template UniquePtr allocElem(Args&&... args) { auto idx = allocIndex(std::forward(args)...); @@ -198,9 +261,6 @@ struct IndexedMemPool : boost::noncopyable { /// Gives up ownership previously granted by alloc() void recycleIndex(uint32_t idx) { assert(isAllocated(idx)); - if (eagerRecycle()) { - slot(idx).elem.~T(); - } localPush(localHead(), idx); } @@ -234,7 +294,7 @@ struct IndexedMemPool : boost::noncopyable { /// Returns true iff idx has been alloc()ed and not recycleIndex()ed bool isAllocated(uint32_t idx) const { - return slot(idx).localNext.load(std::memory_order_relaxed) == uint32_t(-1); + return slot(idx).localNext.load(std::memory_order_acquire) == uint32_t(-1); } @@ -363,7 +423,8 @@ struct IndexedMemPool : boost::noncopyable { Slot& s = slot(idx); TaggedPtr h = head.load(std::memory_order_acquire); while (true) { - s.localNext.store(h.idx, std::memory_order_relaxed); + s.localNext.store(h.idx, std::memory_order_release); + Traits::onRecycle(&slot(idx).elem); if (h.size() == LocalListLimit) { // push will overflow local list, steal it instead @@ -408,7 +469,6 @@ struct IndexedMemPool : boost::noncopyable { auto next = s.localNext.load(std::memory_order_relaxed); if (head.compare_exchange_strong(h, h.withIdx(next).withSizeDecr())) { // success - s.localNext.store(uint32_t(-1), std::memory_order_relaxed); return h.idx; } continue; @@ -422,13 +482,7 @@ struct IndexedMemPool : boost::noncopyable { // allocation failed return 0; } - // default-construct it now if we aren't going to construct and - // destroy on each allocation - if (!eagerRecycle()) { - T* ptr = &slot(idx).elem; - new (ptr) T(); - } - slot(idx).localNext.store(uint32_t(-1), std::memory_order_relaxed); + Traits::initialize(&slot(idx).elem); return idx; } @@ -437,7 +491,6 @@ struct IndexedMemPool : boost::noncopyable { if (head.compare_exchange_strong( h, h.withIdx(next).withSize(LocalListLimit))) { // global list moved to local list, keep head for us - s.localNext.store(uint32_t(-1), std::memory_order_relaxed); return idx; } // local bulk push failed, return idx to the global list and try again @@ -446,9 +499,16 @@ struct IndexedMemPool : boost::noncopyable { } AtomicStruct& localHead() { - auto stripe = detail::AccessSpreader::current(NumLocalLists); + auto stripe = AccessSpreader::current(NumLocalLists); return local_[stripe].head; } + + void markAllocated(Slot& slot) { + slot.localNext.store(uint32_t(-1), std::memory_order_release); + } + + public: + static constexpr std::size_t kSlotSize = sizeof(Slot); }; namespace detail { @@ -472,8 +532,8 @@ struct IndexedMemPoolRecycler { } }; -} +} // namespace detail } // namespace folly -# pragma GCC diagnostic pop +FOLLY_POP_WARNING