rmm::mr::statistics_resource_adaptor< Upstream > Class Template Reference

Resource that uses Upstream to allocate memory and tracks statistics on memory allocations. More...

#include <statistics_resource_adaptor.hpp>

Inheritance diagram for rmm::mr::statistics_resource_adaptor< Upstream >:

Collaboration diagram for rmm::mr::statistics_resource_adaptor< Upstream >:

Classes
struct	counter
	Utility struct for counting the current, peak, and total value of a number. More...

Public Types
using	read_lock_t = std::shared_lock< std::shared_timed_mutex >
using	write_lock_t = std::unique_lock< std::shared_timed_mutex >

Public Member Functions
	statistics_resource_adaptor (Upstream *upstream)
	Construct a new statistics resource adaptor using upstream to satisfy allocation requests. More...
	statistics_resource_adaptor (statistics_resource_adaptor const &)=delete
statistics_resource_adaptor &	operator= (statistics_resource_adaptor const &)=delete
	statistics_resource_adaptor (statistics_resource_adaptor &&) noexcept=default
statistics_resource_adaptor &	operator= (statistics_resource_adaptor &&) noexcept=default
Upstream *	get_upstream () const noexcept
	Return pointer to the upstream resource. More...
bool	supports_streams () const noexcept override
	Checks whether the upstream resource supports streams. More...
bool	supports_get_mem_info () const noexcept override
	Query whether the resource supports the get_mem_info API. More...
counter	get_bytes_counter () const noexcept
	Returns a counter struct for this adaptor containing the current, peak, and total number of allocated bytes for this adaptor since it was created. More...
counter	get_allocations_counter () const noexcept
	Returns a counter struct for this adaptor containing the current, peak, and total number of allocation counts for this adaptor since it was created. More...
Public Member Functions inherited from rmm::mr::device_memory_resource
	device_memory_resource (device_memory_resource const &)=default
device_memory_resource &	operator= (device_memory_resource const &)=default
	device_memory_resource (device_memory_resource &&) noexcept=default
device_memory_resource &	operator= (device_memory_resource &&) noexcept=default
void *	allocate (std::size_t bytes, cuda_stream_view stream=cuda_stream_view{})
	Allocates memory of size at least bytes. More...
void	deallocate (void *ptr, 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...

Detailed Description

template<typename Upstream>
class rmm::mr::statistics_resource_adaptor< Upstream >

Resource that uses Upstream to allocate memory and tracks statistics on memory allocations.

An instance of this resource can be constructed with an existing, upstream resource in order to satisfy allocation requests, but any existing allocations will be untracked. Tracking statistics stores the current, peak and total memory allocations for both the number of bytes and number of calls to the memory resource. statistics_resource_adaptor is intended as a debug adaptor and shouldn't be used in performance-sensitive code.

Template Parameters

Upstream

Type of the upstream resource used for allocation/deallocation.

Constructor & Destructor Documentation

statistics_resource_adaptor()

template<typename Upstream >

rmm::mr::statistics_resource_adaptor< Upstream >::statistics_resource_adaptor ( Upstream *  upstream )

inline

Construct a new statistics resource adaptor using upstream to satisfy allocation requests.

Exceptions

<tt>rmm::logic_error</tt>

if upstream == nullptr

Parameters

upstream

The resource used for allocating/deallocating device memory

Member Function Documentation

get_allocations_counter()

template<typename Upstream >

counter rmm::mr::statistics_resource_adaptor< Upstream >::get_allocations_counter ( ) const

inlinenoexcept

Returns a counter struct for this adaptor containing the current, peak, and total number of allocation counts for this adaptor since it was created.

Returns

counter struct containing allocations count

get_bytes_counter()

template<typename Upstream >

counter rmm::mr::statistics_resource_adaptor< Upstream >::get_bytes_counter ( ) const

inlinenoexcept

Returns a counter struct for this adaptor containing the current, peak, and total number of allocated bytes for this adaptor since it was created.

Returns

counter struct containing bytes count

get_upstream()

template<typename Upstream >

Upstream* rmm::mr::statistics_resource_adaptor< Upstream >::get_upstream ( ) const

inlinenoexcept

Return pointer to the upstream resource.

Returns

Upstream* Pointer to the upstream resource.

supports_get_mem_info()

template<typename Upstream >

bool rmm::mr::statistics_resource_adaptor< Upstream >::supports_get_mem_info ( ) const

inlineoverridevirtualnoexcept

Query whether the resource supports the get_mem_info API.

Returns

bool true if the upstream resource supports get_mem_info, false otherwise.

Implements rmm::mr::device_memory_resource.

supports_streams()

template<typename Upstream >

bool rmm::mr::statistics_resource_adaptor< Upstream >::supports_streams ( ) const

inlineoverridevirtualnoexcept

Checks whether the upstream resource supports streams.

Returns

true The upstream resource supports streams

false The upstream resource does not support streams.

Implements rmm::mr::device_memory_resource.

---

The documentation for this class was generated from the following file:

• statistics_resource_adaptor.hpp