#include <RefTensorHandle.hpp>

Inheritance diagram for RefTensorHandle:

Public Member Functions
	RefTensorHandle (const TensorInfo &tensorInfo, std::shared_ptr< RefMemoryManager > &memoryManager)

	RefTensorHandle (const TensorInfo &tensorInfo, MemorySourceFlags importFlags)

	~RefTensorHandle ()

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

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

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

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

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

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...

const TensorInfo &	GetTensorInfo () const

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

virtual bool	Import (void *memory, MemorySource source) override
	Import externally allocated memory. 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...

Detailed Description

Definition at line 15 of file RefTensorHandle.hpp.

Constructor & Destructor Documentation

◆ RefTensorHandle() [1/2]

RefTensorHandle	(	const TensorInfo &	tensorInfo,
		std::shared_ptr< RefMemoryManager > &	memoryManager
	)

Definition at line 10 of file RefTensorHandle.cpp.

Referenced by RefTensorHandle::GetImportFlags().

                                                                                                             :
     m_TensorInfo(tensorInfo),
     m_MemoryManager(memoryManager),
     m_Pool(nullptr),
     m_UnmanagedMemory(nullptr),
     m_ImportFlags(static_cast<MemorySourceFlags>(MemorySource::Undefined)),
     m_Imported(false),
     m_IsImportEnabled(false)
 {
 
 }

◆ RefTensorHandle() [2/2]

RefTensorHandle	(	const TensorInfo &	tensorInfo,
		MemorySourceFlags	importFlags
	)

Definition at line 22 of file RefTensorHandle.cpp.

                                  : m_TensorInfo(tensorInfo),
                                    m_Pool(nullptr),
                                    m_UnmanagedMemory(nullptr),
                                    m_ImportFlags(importFlags),
                                    m_Imported(false),
                                    m_IsImportEnabled(true)
 {
 
 }

◆ ~RefTensorHandle()

~RefTensorHandle ( )

Definition at line 34 of file RefTensorHandle.cpp.

 {
     if (!m_Pool)
     {
         // unmanaged
         if (!m_Imported)
         {
             ::operator delete(m_UnmanagedMemory);
         }
     }
 }

Member Function Documentation

◆ Allocate()

void Allocate ( )

overridevirtual

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 57 of file RefTensorHandle.cpp.

References TensorInfo::GetNumBytes().

 {
     // If import is enabled, do not allocate the tensor
     if (!m_IsImportEnabled)
     {
 
         if (!m_UnmanagedMemory)
         {
             if (!m_Pool)
             {
                 // unmanaged
                 m_UnmanagedMemory = ::operator new(m_TensorInfo.GetNumBytes());
             }
             else
             {
                 m_MemoryManager->Allocate(m_Pool);
             }
         }
         else
         {
             throw InvalidArgumentException("RefTensorHandle::Allocate Trying to allocate a RefTensorHandle"
                                            "that already has allocated memory.");
         }
     }
 }

◆ GetImportFlags()

virtual MemorySourceFlags GetImportFlags ( ) const

inlineoverridevirtual

Get flags describing supported import sources.

Reimplemented from ITensorHandle.

Definition at line 54 of file RefTensorHandle.hpp.

References RefTensorHandle::Import(), and RefTensorHandle::RefTensorHandle().

     {
         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 28 of file RefTensorHandle.hpp.

References RefTensorHandle::Map(), and ITensorHandle::Map().

     {
         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 44 of file RefTensorHandle.hpp.

References TensorInfo::GetShape().

     {
         return m_TensorInfo.GetShape();
     }

◆ 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 39 of file RefTensorHandle.hpp.

References armnn::GetUnpaddedTensorStrides().

     {
         return GetUnpaddedTensorStrides(m_TensorInfo);
     }

◆ GetTensorInfo()

const TensorInfo& GetTensorInfo ( ) const

inline

Definition at line 49 of file RefTensorHandle.hpp.

Referenced by armnn::GetTensorInfo().

     {
         return m_TensorInfo;
     }

◆ Import()

bool Import	(	void *	memory,
		MemorySource	source
	)

overridevirtual

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 118 of file RefTensorHandle.cpp.

References armnn::Malloc.

Referenced by RefTensorHandle::GetImportFlags().

 {
     if (m_ImportFlags & static_cast<MemorySourceFlags>(source))
     {
         if (m_IsImportEnabled && source == MemorySource::Malloc)
         {
             // Check memory alignment
             constexpr uintptr_t alignment = sizeof(size_t);
             if (reinterpret_cast<uintptr_t>(memory) % alignment)
             {
                 if (m_Imported)
                 {
                     m_Imported = false;
                     m_UnmanagedMemory = nullptr;
                 }
 
                 return false;
             }
 
             // m_UnmanagedMemory not yet allocated.
             if (!m_Imported && !m_UnmanagedMemory)
             {
                 m_UnmanagedMemory = memory;
                 m_Imported = true;
                 return true;
             }
 
             // m_UnmanagedMemory initially allocated with Allocate().
             if (!m_Imported && m_UnmanagedMemory)
             {
                 return false;
             }
 
             // m_UnmanagedMemory previously imported.
             if (m_Imported)
             {
                 m_UnmanagedMemory = memory;
                 return true;
             }
         }
     }
 
     return false;
 }

◆ Manage()

void Manage ( )

overridevirtual

Indicate to the memory manager that this resource is active.

This is used to compute overlapping lifetimes of resources.

Implements ITensorHandle.

Definition at line 46 of file RefTensorHandle.cpp.

References ARMNN_ASSERT_MSG, and TensorInfo::GetNumBytes().

 {
     if (!m_IsImportEnabled)
     {
         ARMNN_ASSERT_MSG(!m_Pool, "RefTensorHandle::Manage() called twice");
         ARMNN_ASSERT_MSG(!m_UnmanagedMemory, "RefTensorHandle::Manage() called after Allocate()");
 
         m_Pool = m_MemoryManager->Manage(m_TensorInfo.GetNumBytes());
     }
 }

◆ Map()

const void * Map ( bool blocking ) const

overridevirtual

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 83 of file RefTensorHandle.cpp.

References ARMNN_ASSERT, and TensorInfo::GetNumBytes().

Referenced by RefTensorHandle::GetParent().

 {
     return GetPointer();
 }

◆ Unmap()

virtual void Unmap ( ) const

inlineoverridevirtual

Unmap the tensor data.

Implements ITensorHandle.

Definition at line 36 of file RefTensorHandle.hpp.

37 {}

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

src/backends/reference/RefTensorHandle.hpp
src/backends/reference/RefTensorHandle.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RefTensorHandle() [1/2]

◆ RefTensorHandle() [2/2]

◆ ~RefTensorHandle()

Member Function Documentation

◆ Allocate()

◆ GetImportFlags()

◆ GetParent()

◆ GetShape()

◆ GetStrides()

◆ GetTensorInfo()

◆ Import()

◆ Manage()

◆ Map()

◆ Unmap()