#include <ICustomAllocator.hpp>

Inheritance diagram for ICustomAllocator:

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

Detailed Description

Custom Allocator interface.

Examples: CustomMemoryAllocatorSample.cpp.

Definition at line 16 of file ICustomAllocator.hpp.

Constructor & Destructor Documentation

◆ ~ICustomAllocator()

virtual ~ICustomAllocator ( )

virtualdefault

Default virtual destructor.

Member Function Documentation

◆ allocate()

virtual void * allocate	(	size_t	size,
		size_t	alignment )

pure virtual

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

Implemented in ClBackendDefaultAllocator, and DefaultAllocator.

Examples: CustomMemoryAllocatorSample.cpp.

◆ free()

virtual void free ( void * ptr )

pure virtual

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

Implemented in ClBackendDefaultAllocator, and DefaultAllocator.

Examples: CustomMemoryAllocatorSample.cpp.

◆ GetMemoryRegionAtOffset()

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

inlinevirtual

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

Reimplemented in ClBackendDefaultAllocator, and DefaultAllocator.

Definition at line 46 of file ICustomAllocator.hpp.

    {
        IgnoreUnused(offset);
        IgnoreUnused(alignment);
        IgnoreUnused(buffer);
        throw armnn::Exception(
                "ICustomerAllocator::GetMemoryRegionAtOffset(): This function should be overridden in subclass.");
    }