rmm::mr::detail::arena::arena< Upstream > Class Template Reference

An arena for allocating memory for a thread. More...

#include <arena.hpp>

Public Member Functions
	arena (global_arena< Upstream > &global_arena)
	Construct an arena. More...
	arena (const arena &)=delete
arena &	operator= (const arena &)=delete
void *	allocate (std::size_t bytes)
	Allocates memory of size at least bytes. More...
bool	deallocate (void *p, std::size_t bytes, cuda_stream_view stream)
	Deallocate memory pointed to by p, and possibly return superblocks to upstream. More...
bool	deallocate (void *p, std::size_t bytes)
	Deallocate memory pointed to by p, keeping all free superblocks. More...
void	clean ()
	Clean the arena and deallocate free blocks from the global arena. More...

Detailed Description

template<typename Upstream>
class rmm::mr::detail::arena::arena< Upstream >

An arena for allocating memory for a thread.

An arena is a per-thread or per-non-default-stream memory pool. It allocates superblocks from the global arena, and return them when the superblocks become empty.

Template Parameters

Upstream

Memory resource to use for allocating the global arena. Implements rmm::mr::device_memory_resource interface.

Constructor & Destructor Documentation

arena()

template<typename Upstream >

rmm::mr::detail::arena::arena< Upstream >::arena ( global_arena< Upstream > &  global_arena )

inlineexplicit

Construct an arena.

Parameters

global_arena

The global arena from which to allocate superblocks.

Member Function Documentation

allocate()

template<typename Upstream >

void* rmm::mr::detail::arena::arena< Upstream >::allocate ( std::size_t  bytes )

inline

Allocates memory of size at least bytes.

Exceptions

<tt>std::bad_alloc</tt>

if the requested allocation could not be fulfilled.

Parameters

bytes

The size in bytes of the allocation.

Returns

void* Pointer to the newly allocated memory.

clean()

template<typename Upstream >

void rmm::mr::detail::arena::arena< Upstream >::clean ( )

inline

Clean the arena and deallocate free blocks from the global arena.

This is only needed when a per-thread arena is about to die.

deallocate() [1/2]

template<typename Upstream >

bool rmm::mr::detail::arena::arena< Upstream >::deallocate ( void *  p, std::size_t  bytes  )

inline

Deallocate memory pointed to by p, keeping all free superblocks.

This is done when deallocating from another arena. Since we don't have access to the CUDA stream associated with this arena, we don't coalesce the freed block and return it directly to the global arena.

Parameters

p	Pointer to be deallocated.
bytes	The size in bytes of the allocation. This must be equal to the value of bytes that was passed to the allocate call that returned p.

Returns

true if the allocation is found, false otherwise.

deallocate() [2/2]

template<typename Upstream >

bool rmm::mr::detail::arena::arena< Upstream >::deallocate ( void *  p, std::size_t  bytes, cuda_stream_view  stream  )

inline

Deallocate memory pointed to by p, and possibly return superblocks to upstream.

Parameters

p	Pointer to be deallocated.
bytes	The size in bytes of the allocation. This must be equal to the value of bytes that was passed to the allocate call that returned p.
stream	Stream on which to perform deallocation.

Returns

true if the allocation is found, false otherwise.

---

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

• arena.hpp