Classes | Public Types | Public Member Functions | List of all members
rmm::mr::tracking_resource_adaptor< Upstream > Class Template Referencefinal

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

#include <tracking_resource_adaptor.hpp>

Inheritance diagram for rmm::mr::tracking_resource_adaptor< Upstream >:
Inheritance graph
[legend]
Collaboration diagram for rmm::mr::tracking_resource_adaptor< Upstream >:
Collaboration graph
[legend]

Classes

struct  allocation_info
 Information stored about an allocation. Includes the size and a stack trace if the tracking_resource_adaptor was initialized to capture stacks. 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

 tracking_resource_adaptor (Upstream *upstream, bool capture_stacks=false)
 Construct a new tracking resource adaptor using upstream to satisfy allocation requests. More...
 
 tracking_resource_adaptor (tracking_resource_adaptor const &)=delete
 
 tracking_resource_adaptor (tracking_resource_adaptor &&)=default
 
tracking_resource_adaptoroperator= (tracking_resource_adaptor const &)=delete
 
tracking_resource_adaptoroperator= (tracking_resource_adaptor &&)=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...
 
std::map< void *, allocation_info > const & get_outstanding_allocations () const noexcept
 Get the outstanding allocations map. More...
 
std::size_t get_allocated_bytes () const noexcept
 Query the number of bytes that have been allocated. Note that this can not be used to know how large of an allocation is possible due to both possible fragmentation and also internal page sizes and alignment that is not tracked by this allocator. More...
 
void log_outstanding_allocations () const
 Log any outstanding allocations via RMM_LOG_DEBUG.
 
- 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...
 

Detailed Description

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

Resource that uses Upstream to allocate memory and tracks 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 stores a size and pointer for every allocation, and a stack frame if capture_stacks is true, so it can add significant overhead. tracking_resource_adaptor is intended as a debug adaptor and shouldn't be used in performance-sensitive code. Note that callstacks may not contain all symbols unless the project is linked with -rdynamic. This can be accomplished with add_link_options(-rdynamic) in cmake.

Template Parameters
UpstreamType of the upstream resource used for allocation/deallocation.

Constructor & Destructor Documentation

◆ tracking_resource_adaptor()

template<typename Upstream >
rmm::mr::tracking_resource_adaptor< Upstream >::tracking_resource_adaptor ( Upstream *  upstream,
bool  capture_stacks = false 
)
inline

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

Exceptions
<tt>rmm::logic_error</tt>if upstream == nullptr
Parameters
upstreamThe resource used for allocating/deallocating device memory
capture_stacksIf true, capture stacks for allocation calls

Member Function Documentation

◆ get_allocated_bytes()

template<typename Upstream >
std::size_t rmm::mr::tracking_resource_adaptor< Upstream >::get_allocated_bytes ( ) const
inlinenoexcept

Query the number of bytes that have been allocated. Note that this can not be used to know how large of an allocation is possible due to both possible fragmentation and also internal page sizes and alignment that is not tracked by this allocator.

Returns
std::size_t number of bytes that have been allocated through this allocator.

◆ get_outstanding_allocations()

template<typename Upstream >
std::map<void*, allocation_info> const& rmm::mr::tracking_resource_adaptor< Upstream >::get_outstanding_allocations ( ) const
inlinenoexcept

Get the outstanding allocations map.

Returns
std::map<void*, allocation_info> const& of a map of allocations. The key is the allocated memory pointer and the data is the allocation_info structure, which contains size and, potentially, stack traces.

◆ get_upstream()

template<typename Upstream >
Upstream* rmm::mr::tracking_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::tracking_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::tracking_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: