device_memory_resource derived class that uses cudaMallocAsync/cudaFreeAsync for allocation/deallocation. More...

#include <cuda_async_view_memory_resource.hpp>

Inheritance diagram for rmm::mr::cuda_async_view_memory_resource:

Collaboration diagram for rmm::mr::cuda_async_view_memory_resource:

Public Member Functions
	cuda_async_view_memory_resource (cudaMemPool_t pool_handle)
	Constructs a cuda_async_view_memory_resource which uses an existing CUDA memory pool. The provided pool is not owned by cuda_async_view_memory_resource and must remain valid during the lifetime of the memory resource. More...

cudaMemPool_t	pool_handle () const noexcept
	Returns the underlying native handle to the CUDA pool. More...

	cuda_async_view_memory_resource (cuda_async_view_memory_resource const &)=default
	Default copy constructor.

	cuda_async_view_memory_resource (cuda_async_view_memory_resource &&)=default
	Default move constructor.

cuda_async_view_memory_resource &	operator= (cuda_async_view_memory_resource const &)=default
	Default copy assignment operator. More...

cuda_async_view_memory_resource &	operator= (cuda_async_view_memory_resource &&)=default
	Default move assignment operator. 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_resource &	operator= (device_memory_resource const &)=default
	Default copy assignment operator. More...

device_memory_resource &	operator= (device_memory_resource &&) noexcept=default
	Default move assignment operator. More...

void *	allocate_sync (std::size_t bytes, std::size_t alignment=rmm::CUDA_ALLOCATION_ALIGNMENT)
	Allocates memory of size at least `bytes`. More...

void	deallocate_sync (void *ptr, std::size_t bytes, [[maybe_unused]] std::size_t alignment=rmm::CUDA_ALLOCATION_ALIGNMENT) noexcept
	Deallocate memory pointed to by `p`. More...

void *	allocate (cuda_stream_view stream, std::size_t bytes, std::size_t alignment=rmm::CUDA_ALLOCATION_ALIGNMENT)
	Allocates memory of size at least `bytes` on the specified stream. More...

void	deallocate (cuda_stream_view stream, void *ptr, std::size_t bytes, [[maybe_unused]] std::size_t alignment=rmm::CUDA_ALLOCATION_ALIGNMENT) noexcept
	Deallocate memory pointed to by `ptr` on the specified stream. More...

bool	is_equal (device_memory_resource const &other) const noexcept
	Compare this resource to another. 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

device_memory_resource derived class that uses cudaMallocAsync/cudaFreeAsync for allocation/deallocation.

Constructor & Destructor Documentation

◆ cuda_async_view_memory_resource()

rmm::mr::cuda_async_view_memory_resource::cuda_async_view_memory_resource ( cudaMemPool_t pool_handle )

inline

Constructs a cuda_async_view_memory_resource which uses an existing CUDA memory pool. The provided pool is not owned by cuda_async_view_memory_resource and must remain valid during the lifetime of the memory resource.

Exceptions

rmm::logic_error if the CUDA version does not support cudaMallocAsync

Parameters

pool_handle Handle to a CUDA memory pool which will be used to serve allocation requests.

Member Function Documentation

◆ operator=() [1/2]

cuda_async_view_memory_resource& rmm::mr::cuda_async_view_memory_resource::operator= ( cuda_async_view_memory_resource && )

default

Default move assignment operator.

Returns: cuda_async_view_memory_resource& Reference to the assigned object

◆ operator=() [2/2]

cuda_async_view_memory_resource& rmm::mr::cuda_async_view_memory_resource::operator= ( cuda_async_view_memory_resource const & )

default

Default copy assignment operator.

Returns: cuda_async_view_memory_resource& Reference to the assigned object

◆ pool_handle()

cudaMemPool_t rmm::mr::cuda_async_view_memory_resource::pool_handle ( ) const

inlinenoexcept

Returns the underlying native handle to the CUDA pool.

Returns: cudaMemPool_t Handle to the underlying CUDA pool

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

cuda_async_view_memory_resource.hpp