Class thrust::mr::unsynchronized_pool_resource
A memory resource adaptor allowing for pooling and caching allocations from Upstream
, using memory allocated from it for both blocks then allocated to the user and for internal bookkeeping of the cached memory.
On a typical memory resource, calls to allocate
and deallocate
actually allocate and deallocate memory. Pooling memory resources only allocate and deallocate memory from an external resource (the upstream memory resource) when there’s no suitable memory currently cached; otherwise, they use memory they have acquired beforehand, to make memory allocation faster and more efficient.
The non-disjoint version of the pool resource uses a single upstream memory resource. Every allocation is larger than strictly necessary to fulfill the end-user’s request, because it needs to account for the memory overhead of tracking the memory blocks and chunks inside those same memory regions. Nevertheless, this version should be more memory-efficient than the disjoint_unsynchronized_pool_resource
, because it doesn’t need to allocate additional blocks of memory from a separate resource, which in turn would necessitate the bookkeeping overhead in the upstream resource.
This version requires that memory allocated from Upstream is accessible from device. It supports smart references, meaning that the non-managed CUDA resource, returning a device-tagged pointer, will work, but will be much less efficient than the disjoint version, which wouldn’t need to touch device memory at all, and therefore wouldn’t need to transfer it back and forth between the host and the device whenever an allocation or a deallocation happens.
Template Parameters: Upstream
: the type of memory resources that will be used for allocating memory blocks
Inherits From:
thrust::mr::memory_resource< Upstream::pointer >
thrust::mr::validator< Upstream >
#include <thrust/mr/pool.h>
template <typename Upstream> class thrust::mr::unsynchronized_pool_resource { public:
/* Inherited from thrust::mr::memory_resource< Upstream::pointer >
*/ typedef see below pointer;
static pool_options get_default_options();
unsynchronized_pool_resource(Upstream * upstream, pool_options options = get_default_options());
unsynchronized_pool_resource(pool_options options = get_default_options());
~unsynchronized_pool_resource();
void release();
virtual _CCCL_NODISCARD void_ptr do_allocate(std::size_t bytes, std::size_t alignment = alignof(std::max_align_t)) override;
virtual void do_deallocate(void_ptr p, std::size_t bytes, std::size_t alignment = alignof(std::max_align_t)) override;
/* Inherited from thrust::mr::memory_resource< Upstream::pointer >
*/ virtual ~memory_resource() = default;
/* Inherited from thrust::mr::memory_resource< Upstream::pointer >
*/ _CCCL_NODISCARD pointer allocate(std::size_t bytes, std::size_t alignment = alignof(std::max_align_t));
/* Inherited from thrust::mr::memory_resource< Upstream::pointer >
*/ void deallocate(pointer p, std::size_t bytes, std::size_t alignment = alignof(std::max_align_t));
/* Inherited from thrust::mr::memory_resource< Upstream::pointer >
*/ _CCCL_HOST_DEVICE bool is_equal(const memory_resource & other) const;
/* Inherited from thrust::mr::memory_resource< Upstream::pointer >
*/ virtual _CCCL_HOST_DEVICE bool do_is_equal(const memory_resource & other) const; };
Member Functions
Function thrust::mr::unsynchronized_pool_resource::get_default_options
static pool_options get_default_options();
Get the default options for a pool. These are meant to be a sensible set of values for many use cases, and as such, may be tuned in the future. This function is exposed so that creating a set of options that are just a slight departure from the defaults is easy.
Function thrust::mr::unsynchronized_pool_resource::unsynchronized_pool_resource
unsynchronized_pool_resource(Upstream * upstream, pool_options options = get_default_options());
Constructor.
Function Parameters:
upstream
the upstream memory resource for allocationsoptions
pool options to use
Function thrust::mr::unsynchronized_pool_resource::unsynchronized_pool_resource
unsynchronized_pool_resource(pool_options options = get_default_options());
Constructor. The upstream resource is obtained by calling get_global_resource<Upstream>
.
Function Parameters: options
: pool options to use
Function thrust::mr::unsynchronized_pool_resource::~unsynchronized_pool_resource
~unsynchronized_pool_resource();
Destructor. Releases all held memory to upstream.
Function thrust::mr::unsynchronized_pool_resource::release
void release();
Releases all held memory to upstream.
Function thrust::mr::unsynchronized_pool_resource::do_allocate
virtual _CCCL_NODISCARD void_ptr do_allocate(std::size_t bytes, std::size_t alignment = alignof(std::max_align_t)) override;
Allocates memory of size at least bytes
and alignment at least alignment
.
Function Parameters:
bytes
size, in bytes, that is requested from this allocationalignment
alignment that is requested from this allocation
Returns: A pointer to void to the newly allocated memory.
Exceptions: thrust::bad_alloc
: when no memory with requested size and alignment can be allocated.
Implements: do_allocate
Function thrust::mr::unsynchronized_pool_resource::do_deallocate
virtual void do_deallocate(void_ptr p, std::size_t bytes, std::size_t alignment = alignof(std::max_align_t)) override;
Deallocates memory pointed to by p
.
Function Parameters:
p
pointer to be deallocatedbytes
the size of the allocation. This must be equivalent to the value ofbytes
that was passed to the allocation function that returnedp
.alignment
the size of the allocation. This must be equivalent to the value ofalignment
that was passed to the allocation function that returnedp
.
Implements: do_deallocate