#include <ClImportTensorHandle.hpp>

Inheritance diagram for ClImportTensorHandle:

Public Member Functions
	ClImportTensorHandle (const TensorInfo &tensorInfo, MemorySourceFlags importFlags)

	ClImportTensorHandle (const TensorInfo &tensorInfo, DataLayout dataLayout, MemorySourceFlags importFlags)

arm_compute::CLTensor &	GetTensor () override

arm_compute::CLTensor const &	GetTensor () const override

virtual void	Allocate () override
	Indicate to the memory manager that this resource is no longer active. More...

virtual void	Manage () override
	Indicate to the memory manager that this resource is active. More...

virtual const void *	Map (bool blocking=true) const override
	Map the tensor data for access. More...

virtual void	Unmap () const override
	Unmap the tensor data. More...

virtual ITensorHandle *	GetParent () const override
	Get the parent tensor if this is a subtensor. More...

virtual arm_compute::DataType	GetDataType () const override

virtual void	SetMemoryGroup (const std::shared_ptr< arm_compute::IMemoryGroup > &memoryGroup) override

TensorShape	GetStrides () const override
	Get the strides for each dimension ordered from largest to smallest where the smallest value is the same as the size of a single element in the tensor. More...

TensorShape	GetShape () const override
	Get the number of elements for each dimension ordered from slowest iterating dimension to fastest iterating dimension. More...

void	SetImportFlags (MemorySourceFlags importFlags)

MemorySourceFlags	GetImportFlags () const override
	Get flags describing supported import sources. More...

virtual bool	Import (void *memory, MemorySource source) override
	Import externally allocated memory. More...

virtual bool	CanBeImported (void *memory, MemorySource source) override
	Implementations must determine if this memory block can be imported. More...

Public Member Functions inherited from ITensorHandle
virtual	~ITensorHandle ()

void *	Map (bool blocking=true)
	Map the tensor data for access. More...

void	Unmap ()
	Unmap the tensor data that was previously mapped with call to Map(). More...

virtual void	Unimport ()
	Unimport externally allocated memory. More...

Detailed Description

Definition at line 30 of file ClImportTensorHandle.hpp.

Constructor & Destructor Documentation

◆ ClImportTensorHandle() [1/2]

ClImportTensorHandle	(	const TensorInfo &	tensorInfo,
		MemorySourceFlags	importFlags
	)

inline

Definition at line 33 of file ClImportTensorHandle.hpp.

         : m_ImportFlags(importFlags)
     {
         armnn::armcomputetensorutils::BuildArmComputeTensor(m_Tensor, tensorInfo);
     }

◆ ClImportTensorHandle() [2/2]

ClImportTensorHandle	(	const TensorInfo &	tensorInfo,
		DataLayout	dataLayout,
		MemorySourceFlags	importFlags
	)

inline

Definition at line 39 of file ClImportTensorHandle.hpp.

         : m_ImportFlags(importFlags), m_Imported(false)
     {
         armnn::armcomputetensorutils::BuildArmComputeTensor(m_Tensor, tensorInfo, dataLayout);
     }

Member Function Documentation

◆ Allocate()

virtual void Allocate ( )

inlineoverridevirtual

Indicate to the memory manager that this resource is no longer active.

This is used to compute overlapping lifetimes of resources.

Implements ITensorHandle.

Definition at line 49 of file ClImportTensorHandle.hpp.

49 {}

◆ CanBeImported()

virtual bool CanBeImported	(	void *	memory,
		MemorySource	source
	)

inlineoverridevirtual

Implementations must determine if this memory block can be imported.

This might be based on alignment or memory source type.

Returns: true if this memory can be imported.; false by default, cannot be imported.

Reimplemented from ITensorHandle.

Definition at line 188 of file ClImportTensorHandle.hpp.

References ARMNN_ASSERT, armnn::error, ClImportTensorHandle::GetDataType(), armnn::Malloc, and ClImportTensorHandle::Map().

     {
         if (m_ImportFlags & static_cast<MemorySourceFlags>(source))
         {
             if (source == MemorySource::Malloc)
             {
                 const cl_import_properties_arm importProperties[] =
                         {
                                 CL_IMPORT_TYPE_ARM,
                                 CL_IMPORT_TYPE_HOST_ARM,
                                 0
                         };
 
                 size_t totalBytes = m_Tensor.info()->total_size();
 
                 // Round the size of the mapping to match the CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE
                 // This does not change the size of the buffer, only the size of the mapping the buffer is mapped to
                 // We do this to match the behaviour of the Import function later on.
                 auto cachelineAlignment =
                         arm_compute::CLKernelLibrary::get().get_device().getInfo<CL_DEVICE_GLOBAL_MEM_CACHELINE_SIZE>();
                 auto roundedSize = totalBytes;
                 if (totalBytes % cachelineAlignment != 0)
                 {
                     roundedSize = cachelineAlignment + totalBytes - (totalBytes % cachelineAlignment);
                 }
 
                 cl_int error = CL_SUCCESS;
                 cl_mem buffer;
                 buffer = clImportMemoryARM(arm_compute::CLKernelLibrary::get().context().get(),
                                            CL_MEM_READ_WRITE, importProperties, memory, roundedSize, &error);
 
                 // If we fail to map we know the import will not succeed and can return false.
                 // There is no memory to be released if error is not CL_SUCCESS
                 if (error != CL_SUCCESS)
                 {
                     return false;
                 }
                 else
                 {
                     // If import was successful we can release the mapping knowing import will succeed at workload
                     // execution and return true
                     error = clReleaseMemObject(buffer);
                     if (error == CL_SUCCESS)
                     {
                         return true;
                     }
                     else
                     {
                         // If we couldn't release the mapping this constitutes a memory leak and throw an exception
                         throw MemoryImportException("ClImportTensorHandle::Failed to unmap cl_mem buffer: "
                                                     + std::to_string(error));
                     }
                 }
             }
         }
         else
         {
             throw MemoryImportException("ClImportTensorHandle::Incorrect import flag");
         }
         return false;
     }

◆ GetDataType()

virtual arm_compute::DataType GetDataType ( ) const

inlineoverridevirtual

Implements IClTensorHandle.

Definition at line 62 of file ClImportTensorHandle.hpp.

Referenced by ClImportTensorHandle::CanBeImported().

     {
         return m_Tensor.info()->data_type();
     }

◆ GetImportFlags()

MemorySourceFlags GetImportFlags ( ) const

inlineoverridevirtual

Get flags describing supported import sources.

Reimplemented from ITensorHandle.

Definition at line 87 of file ClImportTensorHandle.hpp.

     {
         return m_ImportFlags;
     }

◆ GetParent()

virtual ITensorHandle* GetParent ( ) const

inlineoverridevirtual

Get the parent tensor if this is a subtensor.

Returns: a pointer to the parent tensor. Otherwise nullptr if not a subtensor.

Implements ITensorHandle.

Definition at line 60 of file ClImportTensorHandle.hpp.

60 { return nullptr; }

◆ GetShape()

TensorShape GetShape ( ) const

inlineoverridevirtual

Get the number of elements for each dimension ordered from slowest iterating dimension to fastest iterating dimension.

Returns: a TensorShape filled with the number of elements for each dimension.

Implements ITensorHandle.

Definition at line 77 of file ClImportTensorHandle.hpp.

     {
         return armcomputetensorutils::GetShape(m_Tensor.info()->tensor_shape());
     }

◆ GetStrides()

TensorShape GetStrides ( ) const

inlineoverridevirtual

Get the strides for each dimension ordered from largest to smallest where the smallest value is the same as the size of a single element in the tensor.

Returns: a TensorShape filled with the strides for each dimension

Implements ITensorHandle.

Definition at line 72 of file ClImportTensorHandle.hpp.

     {
         return armcomputetensorutils::GetStrides(m_Tensor.info()->strides_in_bytes());
     }

◆ GetTensor() [1/2]

arm_compute::CLTensor& GetTensor ( )

inlineoverridevirtual

Implements IClTensorHandle.

Definition at line 47 of file ClImportTensorHandle.hpp.

47 { return m_Tensor; }

◆ GetTensor() [2/2]

arm_compute::CLTensor const& GetTensor ( ) const

inlineoverridevirtual

Implements IClTensorHandle.

Definition at line 48 of file ClImportTensorHandle.hpp.

48 { return m_Tensor; }

◆ Import()

virtual bool Import	(	void *	memory,
		MemorySource	source
	)

inlineoverridevirtual

Import externally allocated memory.

Parameters

memory	base address of the memory being imported.
source	source of the allocation for the memory being imported.

Returns: true on success or false on failure

Reimplemented from ITensorHandle.

Definition at line 92 of file ClImportTensorHandle.hpp.

References armnn::DmaBuf, armnn::DmaBufProtected, armnn::Gralloc, and armnn::Malloc.

     {
         if (m_ImportFlags & static_cast<MemorySourceFlags>(source))
         {
             if (source == MemorySource::Malloc)
             {
                 const cl_import_properties_arm importProperties[] =
                 {
                     CL_IMPORT_TYPE_ARM,
                     CL_IMPORT_TYPE_HOST_ARM,
                     0
                 };
 
                 return ClImport(importProperties, memory);
             }
             if (source == MemorySource::DmaBuf)
             {
                 const cl_import_properties_arm importProperties[] =
                 {
                     CL_IMPORT_TYPE_ARM,
                     CL_IMPORT_TYPE_DMA_BUF_ARM,
                     CL_IMPORT_DMA_BUF_DATA_CONSISTENCY_WITH_HOST_ARM,
                     CL_TRUE,
                     0
                 };
 
                 return ClImport(importProperties, memory);
 
             }
             if (source == MemorySource::DmaBufProtected)
             {
                 const cl_import_properties_arm importProperties[] =
                 {
                     CL_IMPORT_TYPE_ARM,
                     CL_IMPORT_TYPE_DMA_BUF_ARM,
                     CL_IMPORT_TYPE_PROTECTED_ARM,
                     CL_TRUE,
                     0
                 };
 
                 return ClImport(importProperties, memory, true);
 
             }
             // Case for importing memory allocated by OpenCl externally directly into the tensor
             else if (source == MemorySource::Gralloc)
             {
                 // m_Tensor not yet Allocated
                 if (!m_Imported && !m_Tensor.buffer())
                 {
                     // Importing memory allocated by OpenCl into the tensor directly.
                     arm_compute::Status status =
                         m_Tensor.allocator()->import_memory(cl::Buffer(static_cast<cl_mem>(memory)));
                     m_Imported = bool(status);
                     if (!m_Imported)
                     {
                         throw MemoryImportException(status.error_description());
                     }
                     return m_Imported;
                 }
 
                 // m_Tensor.buffer() initially allocated with Allocate().
                 else if (!m_Imported && m_Tensor.buffer())
                 {
                     throw MemoryImportException(
                         "ClImportTensorHandle::Import Attempting to import on an already allocated tensor");
                 }
 
                 // m_Tensor.buffer() previously imported.
                 else if (m_Imported)
                 {
                     // Importing memory allocated by OpenCl into the tensor directly.
                     arm_compute::Status status =
                         m_Tensor.allocator()->import_memory(cl::Buffer(static_cast<cl_mem>(memory)));
                     m_Imported = bool(status);
                     if (!m_Imported)
                     {
                         throw MemoryImportException(status.error_description());
                     }
                     return m_Imported;
                 }
                 else
                 {
                     throw MemoryImportException("ClImportTensorHandle::Failed to Import Gralloc Memory");
                 }
             }
             else
             {
                 throw MemoryImportException("ClImportTensorHandle::Import flag is not supported");
             }
         }
         else
         {
             throw MemoryImportException("ClImportTensorHandle::Incorrect import flag");
         }
     }

◆ Manage()

virtual void Manage ( )

inlineoverridevirtual

Indicate to the memory manager that this resource is active.

This is used to compute overlapping lifetimes of resources.

Implements ITensorHandle.

Definition at line 50 of file ClImportTensorHandle.hpp.

50 {}

◆ Map()

virtual const void* Map ( bool blocking = true ) const

inlineoverridevirtual

Map the tensor data for access.

Parameters

blocking hint to block the calling thread until all other accesses are complete. (backend dependent)

Returns: pointer to the first element of the mapped data.

Implements ITensorHandle.

Definition at line 52 of file ClImportTensorHandle.hpp.

References armnn::IgnoreUnused().

Referenced by ClImportTensorHandle::CanBeImported().

     {
         IgnoreUnused(blocking);
         return static_cast<const void*>(m_Tensor.buffer() + m_Tensor.info()->offset_first_element_in_bytes());
     }

◆ SetImportFlags()

void SetImportFlags ( MemorySourceFlags importFlags )

inline

Definition at line 82 of file ClImportTensorHandle.hpp.

     {
         m_ImportFlags = importFlags;
     }

◆ SetMemoryGroup()

virtual void SetMemoryGroup ( const std::shared_ptr< arm_compute::IMemoryGroup > & memoryGroup )

inlineoverridevirtual

Implements IClTensorHandle.

Definition at line 67 of file ClImportTensorHandle.hpp.

References armnn::IgnoreUnused().

     {
         IgnoreUnused(memoryGroup);
     }

◆ Unmap()

virtual void Unmap ( ) const

inlineoverridevirtual

Unmap the tensor data.

Implements ITensorHandle.

Definition at line 58 of file ClImportTensorHandle.hpp.

58 {}

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

src/backends/cl/ClImportTensorHandle.hpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ClImportTensorHandle() [1/2]

◆ ClImportTensorHandle() [2/2]

Member Function Documentation

◆ Allocate()

◆ CanBeImported()

◆ GetDataType()

◆ GetImportFlags()

◆ GetParent()

◆ GetShape()

◆ GetStrides()

◆ GetTensor() [1/2]

◆ GetTensor() [2/2]

◆ Import()

◆ Manage()

◆ Map()

◆ SetImportFlags()

◆ SetMemoryGroup()

◆ Unmap()