Downstream allocator that ensures that allocations are contiguous. More...

#include <vecmem/memory/contiguous_memory_resource.hpp>

Inheritance diagram for vecmem::contiguous_memory_resource:

Public Member Functions
VECMEM_CORE_EXPORT	contiguous_memory_resource (memory_resource &upstream, std::size_t size)
	Constructs the contiguous memory resource.

VECMEM_CORE_EXPORT	contiguous_memory_resource (contiguous_memory_resource &&parent)
	Move constructor.

	contiguous_memory_resource (const contiguous_memory_resource &)=delete
	Disallow copying the memory resource.

VECMEM_CORE_EXPORT	~contiguous_memory_resource ()
	Deconstruct the contiguous memory resource.

VECMEM_CORE_EXPORT contiguous_memory_resource &	operator= (contiguous_memory_resource &&rhs)
	Move assignment operator.

contiguous_memory_resource &	operator= (const contiguous_memory_resource &)=delete
	Disallow copying the memory resource.

Protected Member Functions
Function(s) implementing @c vecmem::memory_resource
virtual VECMEM_CORE_EXPORT bool	do_is_equal (const memory_resource &other) const noexcept
	Compare the equality of `*this` memory resource with another.

Private Member Functions
Function(s) implementing @c vecmem::memory_resource
virtual VECMEM_CORE_EXPORT void *	do_allocate (std::size_t, std::size_t) override final
	Allocate memory with one of the underlying resources.

virtual VECMEM_CORE_EXPORT void	do_deallocate (void *p, std::size_t, std::size_t) override final
	De-allocate a previously allocated memory block.

Detailed Description

Downstream allocator that ensures that allocations are contiguous.

When programming for co-processors, it is often desriable to keep allocations contiguous. This downstream allocator fills that need. When configured with an upstream memory resource, it will start out by allocating a single, large, chunk of memory from the upstream. Then, it will hand out pointers along that memory in a contiguous fashion. This allocator guarantees that each consecutive allocation will start right at the end of the previous.

Note: The allocation size on the upstream allocator is also the maximum amount of memory that can be allocated from the contiguous memory resource.

Constructor & Destructor Documentation

◆ contiguous_memory_resource()

vecmem::contiguous_memory_resource::contiguous_memory_resource	(	memory_resource &	upstream,
		std::size_t	size
	)

Constructs the contiguous memory resource.

Parameters

[in]	upstream	The upstream memory resource to use.
[in]	size	The size of memory to allocate upstream.

◆ ~contiguous_memory_resource()

VECMEM_CORE_EXPORT vecmem::contiguous_memory_resource::~contiguous_memory_resource ( )

Deconstruct the contiguous memory resource.

This method deallocates the arena memory on the upstream allocator.

Member Function Documentation

◆ do_is_equal()

bool vecmem::details::memory_resource_base::do_is_equal ( const memory_resource & other ) const

protectedvirtualnoexceptinherited

Compare the equality of *this memory resource with another.

Parameters

other The other memory resource to compare with

Returns: true if the two memory resources are equal, false otherwise

Reimplemented in vecmem::identity_memory_resource, vecmem::host_memory_resource, and vecmem::terminal_memory_resource.

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

core/include/vecmem/memory/contiguous_memory_resource.hpp
core/src/memory/contiguous_memory_resource.cpp

Public Member Functions