ClBackendDefaultAllocator Class Reference

Default Memory Allocator class returned from IBackendInternal::GetDefaultAllocator(MemorySource) More...

#include <ClBackendDefaultAllocator.hpp>

Inheritance diagram for ClBackendDefaultAllocator:

Collaboration diagram for ClBackendDefaultAllocator:

Public Member Functions
	ClBackendDefaultAllocator ()=default
void *	allocate (size_t size, size_t alignment=0) override
	Interface to be implemented by the child class to allocate bytes.
void	free (void *ptr) override
	Interface to be implemented by the child class to free the allocated bytes.
armnn::MemorySource	GetMemorySourceType () override
	Used to specify what type of memory is being allocated by this allocator.
void *	GetMemoryRegionAtOffset (void *buffer, size_t offset, size_t alignment=0) override
	Interface that may be implemented to allow retrieval of Memory Region from allocated buffer at a certain offset.
Public Member Functions inherited from ICustomAllocator
virtual	~ICustomAllocator ()=default
	Default virtual destructor.

Detailed Description

Default Memory Allocator class returned from IBackendInternal::GetDefaultAllocator(MemorySource)

Definition at line 14 of file ClBackendDefaultAllocator.hpp.

Constructor & Destructor Documentation

ClBackendDefaultAllocator()

ClBackendDefaultAllocator ( )

default

Member Function Documentation

allocate()

void * allocate ( size_t size, size_t alignment = 0 )

inlineoverridevirtual

Interface to be implemented by the child class to allocate bytes.

Parameters

[in]	size	Size to allocate
[in]	alignment	Alignment that the returned pointer should comply with

Returns

A pointer to the allocated memory The returned pointer must be host write accessible

Implements ICustomAllocator.

Definition at line 19 of file ClBackendDefaultAllocator.hpp.

    {
        IgnoreUnused(alignment);
        cl_mem buf{ clCreateBuffer(arm_compute::CLScheduler::get().context().get(),
                                   CL_MEM_ALLOC_HOST_PTR | CL_MEM_READ_WRITE,
                                   size,
                                   nullptr,
                                   nullptr)};
        return static_cast<void *>(buf);
    }

References armnn::IgnoreUnused().

free()

void free ( void * ptr )

inlineoverridevirtual

Interface to be implemented by the child class to free the allocated bytes.

Implements ICustomAllocator.

Definition at line 30 of file ClBackendDefaultAllocator.hpp.

    {
        ARM_COMPUTE_ERROR_ON(ptr == nullptr);
        clReleaseMemObject(static_cast<cl_mem>(ptr));
    }

GetMemoryRegionAtOffset()

void * GetMemoryRegionAtOffset ( void * buffer, size_t offset, size_t alignment = 0 )

inlineoverridevirtual

Interface that may be implemented to allow retrieval of Memory Region from allocated buffer at a certain offset.

Reimplemented from ICustomAllocator.

Definition at line 41 of file ClBackendDefaultAllocator.hpp.

    {
        IgnoreUnused(alignment);
        return static_cast<char*>(buffer) + offset;
    }

References armnn::IgnoreUnused().

GetMemorySourceType()

armnn::MemorySource GetMemorySourceType ( )

inlineoverridevirtual

Used to specify what type of memory is being allocated by this allocator.

Supported types are: MemorySource::Malloc MemorySource::DmaBuf MemorySource::DmaBufProtected

Implements ICustomAllocator.

Definition at line 36 of file ClBackendDefaultAllocator.hpp.

    {
        return armnn::MemorySource::Gralloc;
    }

References armnn::Gralloc.

---

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

• src/backends/cl/ClBackendDefaultAllocator.hpp