All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Types | Public Member Functions | List of all members
rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType > Class Template Referencefinal

A device memory resource that calls a callback function when allocations throw a specified exception type. More...

#include <failure_callback_resource_adaptor.hpp>

Inheritance diagram for rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType >:
Inheritance graph
[legend]
Collaboration diagram for rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType >:
Collaboration graph
[legend]

Public Types

using exception_type = ExceptionType
 The type of exception this object catches/throws.
 

Public Member Functions

 failure_callback_resource_adaptor (device_async_resource_ref upstream, failure_callback_t callback, void *callback_arg)
 Construct a new failure_callback_resource_adaptor using upstream to satisfy allocation requests. More...
 
 failure_callback_resource_adaptor (Upstream *upstream, failure_callback_t callback, void *callback_arg)
 Construct a new failure_callback_resource_adaptor using upstream to satisfy allocation requests. More...
 
 failure_callback_resource_adaptor (failure_callback_resource_adaptor const &)=delete
 
failure_callback_resource_adaptoroperator= (failure_callback_resource_adaptor const &)=delete
 
 failure_callback_resource_adaptor (failure_callback_resource_adaptor &&) noexcept=default
 Default move constructor.
 
failure_callback_resource_adaptoroperator= (failure_callback_resource_adaptor &&) noexcept=default
 Default move assignment operator. More...
 
rmm::device_async_resource_ref get_upstream_resource () const noexcept
 rmm::device_async_resource_ref to the upstream resource More...
 
- Public Member Functions inherited from rmm::mr::device_memory_resource
 device_memory_resource (device_memory_resource const &)=default
 Default copy constructor.
 
 device_memory_resource (device_memory_resource &&) noexcept=default
 Default move constructor.
 
device_memory_resourceoperator= (device_memory_resource const &)=default
 Default copy assignment operator. More...
 
device_memory_resourceoperator= (device_memory_resource &&) noexcept=default
 Default move assignment operator. More...
 
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...
 
void * allocate (std::size_t bytes, std::size_t alignment)
 Allocates memory of size at least bytes. More...
 
void deallocate (void *ptr, std::size_t bytes, std::size_t alignment)
 Deallocate memory pointed to by p. More...
 
void * allocate_async (std::size_t bytes, std::size_t alignment, cuda_stream_view stream)
 Allocates memory of size at least bytes. More...
 
void * allocate_async (std::size_t bytes, cuda_stream_view stream)
 Allocates memory of size at least bytes. More...
 
void deallocate_async (void *ptr, std::size_t bytes, std::size_t alignment, cuda_stream_view stream)
 Deallocate memory pointed to by p. More...
 
void deallocate_async (void *ptr, std::size_t bytes, cuda_stream_view stream)
 Deallocate memory pointed to by p. More...
 
bool operator== (device_memory_resource const &other) const noexcept
 Comparison operator with another device_memory_resource. More...
 
bool operator!= (device_memory_resource const &other) const noexcept
 Comparison operator with another device_memory_resource. More...
 

Detailed Description

template<typename Upstream, typename ExceptionType = rmm::out_of_memory>
class rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType >

A device memory resource that calls a callback function when allocations throw a specified exception type.

An instance of this resource must be constructed with an existing, upstream resource in order to satisfy allocation requests.

The callback function takes an allocation size and a callback argument and returns a bool representing whether to retry the allocation (true) or re-throw the caught exception (false).

When implementing a callback function for allocation retry, care must be taken to avoid an infinite loop. The following example makes sure to only retry the allocation once:

using failure_callback_adaptor =
bool failure_handler(std::size_t bytes, void* arg)
{
bool& retried = *reinterpret_cast<bool*>(arg);
if (!retried) {
retried = true;
return true; // First time we request an allocation retry
}
return false; // Second time we let the adaptor throw std::bad_alloc
}
int main()
{
bool retried{false};
failure_callback_adaptor mr{
rmm::mr::get_current_device_resource_ref(), failure_handler, &retried
};
}
A device memory resource that calls a callback function when allocations throw a specified exception ...
Definition: failure_callback_resource_adaptor.hpp:95
device_async_resource_ref set_current_device_resource_ref(device_async_resource_ref new_resource_ref)
Set the device_async_resource_ref for the current device.
Definition: per_device_resource.hpp:437
device_async_resource_ref get_current_device_resource_ref()
Get the device_async_resource_ref for the current device.
Definition: per_device_resource.hpp:411
Template Parameters
UpstreamThe type of the upstream resource used for allocation/deallocation.
ExceptionTypeThe type of exception that this adaptor should respond to

Constructor & Destructor Documentation

◆ failure_callback_resource_adaptor() [1/2]

template<typename Upstream , typename ExceptionType = rmm::out_of_memory>
rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType >::failure_callback_resource_adaptor ( device_async_resource_ref  upstream,
failure_callback_t  callback,
void *  callback_arg 
)
inline

Construct a new failure_callback_resource_adaptor using upstream to satisfy allocation requests.

Parameters
upstreamThe resource used for allocating/deallocating device memory
callbackCallback function
See also
failure_callback_t
Parameters
callback_argExtra argument passed to callback

◆ failure_callback_resource_adaptor() [2/2]

template<typename Upstream , typename ExceptionType = rmm::out_of_memory>
rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType >::failure_callback_resource_adaptor ( Upstream *  upstream,
failure_callback_t  callback,
void *  callback_arg 
)
inline

Construct a new failure_callback_resource_adaptor using upstream to satisfy allocation requests.

Exceptions
rmm::logic_errorif upstream == nullptr
Parameters
upstreamThe resource used for allocating/deallocating device memory
callbackCallback function
See also
failure_callback_t
Parameters
callback_argExtra argument passed to callback

Member Function Documentation

◆ get_upstream_resource()

template<typename Upstream , typename ExceptionType = rmm::out_of_memory>
rmm::device_async_resource_ref rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType >::get_upstream_resource ( ) const
inlinenoexcept

rmm::device_async_resource_ref to the upstream resource

Returns
rmm::device_async_resource_ref to the upstream resource

◆ operator=()

template<typename Upstream , typename ExceptionType = rmm::out_of_memory>
failure_callback_resource_adaptor& rmm::mr::failure_callback_resource_adaptor< Upstream, ExceptionType >::operator= ( failure_callback_resource_adaptor< Upstream, ExceptionType > &&  )
defaultnoexcept

Default move assignment operator.

Returns
failure_callback_resource_adaptor& Reference to the assigned object

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