cetl::pf17::pmr::UnsynchronizedArrayMemoryResource< array_size > Class Template Reference

#include "cetl/pf17/array_memory_resource.hpp"

Public Member Functions
	UnsynchronizedArrayMemoryResource (cetl::pf17::pmr::memory_resource *upstream, std::size_t upstream_max_size_bytes) noexcept
	UnsynchronizedArrayMemoryResource () noexcept
	UnsynchronizedArrayMemoryResource (const UnsynchronizedArrayMemoryResource &)=delete
UnsynchronizedArrayMemoryResource &	operator= (const UnsynchronizedArrayMemoryResource &)=delete
	UnsynchronizedArrayMemoryResource (UnsynchronizedArrayMemoryResource &&) noexcept=delete
UnsynchronizedArrayMemoryResource &	operator= (UnsynchronizedArrayMemoryResource &&)=delete
void *	data () noexcept
const void *	data () const noexcept
std::size_t	size () const noexcept
Public Member Functions inherited from cetl::pf17::pmr::memory_resource
	memory_resource ()=default
	memory_resource (const memory_resource &rhs)=default
virtual	~memory_resource ()=default
memory_resource &	operator= (const memory_resource &rhs)=default
void *	allocate (std::size_t size_bytes, std::size_t alignment=alignof(std::max_align_t))
void	deallocate (void *p, std::size_t size_bytes, std::size_t alignment=alignof(std::max_align_t))
bool	is_equal (const memory_resource &rhs) const noexcept
std::size_t	max_size () const noexcept
void *	reallocate (void *ptr, std::size_t old_size_bytes, std::size_t new_size_bytes, std::size_t alignment=alignof(std::max_align_t))

Detailed Description

template<std::size_t array_size>
class cetl::pf17::pmr::UnsynchronizedArrayMemoryResource< array_size >

Implementation of cetl::pf17::pmr::memory_resource that uses cetl::pmr::UnsynchronizedBufferMemoryResourceDelegate as the internal implementation backed by an std::array data member using array_size * sizeof(cetl::pf17::byte)s of memory.

Note

This object cannot be moved since there may be outstanding pointers to the internal memory store. If you need a movable memory resource with similar semantics see cetl::pf17::pmr::UnsynchronizedBufferMemoryResource.

Example Usage

    constexpr std::size_t                                               BufferSizeBytes = 64;
    cetl::pf17::pmr::UnsynchronizedArrayMemoryResource<BufferSizeBytes> resource{};
 
    // let's say we have a buffer that must be aligned to a 128-byte (1024-bit) boundary. If we tried to use
    // UnsynchronizedArrayMemoryResource with a 64-byte internal array, on a typical system, the allocation would fail.
 
    void* r = nullptr;
#if defined(__cpp_exceptions)
    try
    {
#endif
        r = resource.allocate(64, 128);
#if defined(__cpp_exceptions)
    } catch (const std::bad_alloc&)
    {
        // This is expected.
    }
#endif
    std::cout << "Over-aligned attempt failed: " << r << std::endl;
 

By over-provisioning the buffer the same alignment will succeed:

// By over-provisioning the buffer you can now get the alignment you want:
constexpr std::size_t                                               BufferSizeBytes = 64 + 128;
cetl::pf17::pmr::UnsynchronizedArrayMemoryResource<BufferSizeBytes> resource{};
 
void* r = resource.allocate(64, 128);
 
std::cout << "Over-aligned address at: " << r << std::endl;
 
resource.deallocate(r, 64, 128);

(See full example here...)

Constructor & Destructor Documentation

UnsynchronizedArrayMemoryResource() [1/2]

template<std::size_t array_size>

cetl::pf17::pmr::UnsynchronizedArrayMemoryResource< array_size >::UnsynchronizedArrayMemoryResource ( cetl::pf17::pmr::memory_resource * upstream, std::size_t upstream_max_size_bytes )

inlinenoexcept

See cetl::pmr::UnsynchronizedBufferMemoryResourceDelegate for details.

Parameters

upstream	The upstream memory resource to provide to cetl::pmr::UnsynchronizedBufferMemoryResourceDelegate. This cannot be null.
upstream_max_size_bytes	The maximum size of the upstream memory resource.

UnsynchronizedArrayMemoryResource() [2/2]

template<std::size_t array_size>

cetl::pf17::pmr::UnsynchronizedArrayMemoryResource< array_size >::UnsynchronizedArrayMemoryResource ( )

inlinenoexcept

Constructor version that uses cetl::pf17::pmr::null_memory_resource as the upstream resource.

Member Function Documentation

data() [1/2]

template<std::size_t array_size>

const void * cetl::pf17::pmr::UnsynchronizedArrayMemoryResource< array_size >::data ( ) const

inlinenoexcept

Direct access to the internal data. It is generally not safe to use this memory directly.

data() [2/2]

template<std::size_t array_size>

void * cetl::pf17::pmr::UnsynchronizedArrayMemoryResource< array_size >::data ( )

inlinenoexcept

Direct access to the internal data. It is generally not safe to use this memory directly.

References data().

Referenced by data().

Here is the caller graph for this function:

size()

template<std::size_t array_size>

std::size_t cetl::pf17::pmr::UnsynchronizedArrayMemoryResource< array_size >::size ( ) const

inlinenoexcept

The size in bytes of the internal buffer.

---

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

• /__w/CETL/CETL/include/cetl/pf17/array_memory_resource.hpp