Allocates memory from upstream resources associated with bin sizes. More...
#include <binning_memory_resource.hpp>
Public Member Functions | |
| binning_memory_resource (Upstream *upstream_resource) | |
| Construct a new binning memory resource object. More... | |
| binning_memory_resource (Upstream *upstream_resource, int8_t min_size_exponent, int8_t max_size_exponent) | |
| Construct a new binning memory resource object with a range of initial bins. More... | |
| ~binning_memory_resource ()=default | |
| Destroy the binning_memory_resource and free all memory allocated from the upstream resource. | |
| binning_memory_resource (binning_memory_resource const &)=delete | |
| binning_memory_resource (binning_memory_resource &&)=delete | |
| binning_memory_resource & | operator= (binning_memory_resource const &)=delete |
| binning_memory_resource & | operator= (binning_memory_resource &&)=delete |
| bool | supports_streams () const noexcept override |
| Query whether the resource supports use of non-null streams for allocation/deallocation. More... | |
| bool | supports_get_mem_info () const noexcept override |
| Query whether the resource supports the get_mem_info API. More... | |
| Upstream * | get_upstream () const noexcept |
| Get the upstream memory_resource object. More... | |
| void | add_bin (std::size_t allocation_size, device_memory_resource *bin_resource=nullptr) |
| Add a bin allocator to this resource. More... | |
 Public Member Functions inherited from rmm::mr::device_memory_resource | |
| void * | allocate (std::size_t bytes, cuda_stream_view stream=cuda_stream_view{}) |
Allocates memory of size at least bytes. More... | |
| void | deallocate (void *p, std::size_t bytes, cuda_stream_view stream=cuda_stream_view{}) |
Deallocate memory pointed to by p. More... | |
| bool | is_equal (device_memory_resource const &other) const noexcept |
| Compare this resource to another. More... | |
| std::pair< std::size_t, std::size_t > | get_mem_info (cuda_stream_view stream) const |
| Queries the amount of free and total memory for the resource. More... | |
Static Public Attributes | |
| static constexpr std::size_t | allocation_alignment = 256 |
Detailed Description
template<typename Upstream>
class rmm::mr::binning_memory_resource< Upstream >
Allocates memory from upstream resources associated with bin sizes.
- Template Parameters
-
UpstreamResource memory_resource to use for allocations that don't fall within any configured bin size. Implements rmm::mr::device_memory_resource interface.
Constructor & Destructor Documentation
◆ binning_memory_resource() [1/2]
|
inlineexplicit |
Construct a new binning memory resource object.
Initially has no bins, so simply uses the upstream_resource until bin resources are added with add_bin.
- Exceptions
-
rmm::logic_error if size_base is not a power of two.
- Parameters
-
upstream_resource The upstream memory resource used to allocate bin pools.
◆ binning_memory_resource() [2/2]
|
inline |
Construct a new binning memory resource object with a range of initial bins.
Constructs a new binning memory resource and adds bins backed by fixed_size_memory_resource in the range [2^min_size_exponent, 2^max_size_exponent]. For example if min_size_exponent==18 and max_size_exponent==22, creates bins of sizes 256KiB, 512KiB, 1024KiB, 2048KiB and 4096KiB.
- Parameters
-
upstream_resource The upstream memory resource used to allocate bin pools. min_size_exponent The minimum base-2 exponent bin size. max_size_exponent The maximum base-2 exponent bin size.
Member Function Documentation
◆ add_bin()
|
inline |
Add a bin allocator to this resource.
Adds bin_resource if it is not null; otherwise constructs and adds a fixed_size_memory_resource.
This bin will be used for any allocation smaller than allocation_size that is larger than the next smaller bin's allocation size.
If there is already a bin of the specified size nothing is changed.
This function is not thread safe.
- Parameters
-
allocation_size The maximum size that this bin allocates bin_resource The memory resource for the bin
◆ get_upstream()
|
inlinenoexcept |
Get the upstream memory_resource object.
- Returns
- UpstreamResource* the upstream memory resource.
◆ supports_get_mem_info()
|
inlineoverridevirtualnoexcept |
Query whether the resource supports the get_mem_info API.
- Returns
- bool true if the resource supports get_mem_info, false otherwise.
Implements rmm::mr::device_memory_resource.
◆ supports_streams()
|
inlineoverridevirtualnoexcept |
Query whether the resource supports use of non-null streams for allocation/deallocation.
- Returns
- true
Implements rmm::mr::device_memory_resource.
The documentation for this class was generated from the following file:
