MockTensorHandle Class Reference

#include <MockTensorHandle.hpp>

Inheritance diagram for MockTensorHandle:

Public Member Functions
	MockTensorHandle (const TensorInfo &tensorInfo, std::shared_ptr< MockMemoryManager > &memoryManager)
	MockTensorHandle (const TensorInfo &tensorInfo, MemorySourceFlags importFlags)
	~MockTensorHandle () override
void	Manage () override
	Indicate to the memory manager that this resource is active. More...
void	Allocate () override
	Indicate to the memory manager that this resource is no longer active. More...
ITensorHandle *	GetParent () const override
	Get the parent tensor if this is a subtensor. More...
const void *	Map (bool) const override
	Map the tensor data for access. More...
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
MemorySourceFlags	GetImportFlags () const override
	Get flags describing supported import sources. More...
bool	Import (void *memory, MemorySource source) override
	Import externally allocated memory. More...
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 14 of file MockTensorHandle.hpp.

Constructor & Destructor Documentation

MockTensorHandle() [1/2]

MockTensorHandle	(	const TensorInfo &	tensorInfo,
		std::shared_ptr< MockMemoryManager > &	memoryManager
	)

Definition at line 11 of file MockTensorHandle.cpp.

Referenced by MockTensorHandle::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)
{}

MockTensorHandle() [2/2]

MockTensorHandle	(	const TensorInfo &	tensorInfo,
		MemorySourceFlags	importFlags
	)

Definition at line 21 of file MockTensorHandle.cpp.

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

~MockTensorHandle()

~MockTensorHandle ( )

override

Definition at line 30 of file MockTensorHandle.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 53 of file MockTensorHandle.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("MockTensorHandle::Allocate Trying to allocate a MockTensorHandle"
                                           "that already has allocated memory.");
        }
    }
}

CanBeImported()

bool CanBeImported ( void *  memory, MemorySource  source  )

overridevirtual

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 158 of file MockTensorHandle.cpp.

References TensorInfo::GetDataType(), armnn::GetDataTypeSize(), and armnn::Malloc.

Referenced by MockTensorHandle::GetImportFlags(), and MockTensorHandle::Import().

{
    if (m_ImportFlags & static_cast<MemorySourceFlags>(source))
    {
        if (m_IsImportEnabled && source == MemorySource::Malloc)
        {
            uintptr_t alignment = GetDataTypeSize(m_TensorInfo.GetDataType());
            if (reinterpret_cast<uintptr_t>(memory) % alignment)
            {
                return false;
            }

            return true;
        }
    }
    return false;
}

GetImportFlags()

MemorySourceFlags GetImportFlags ( ) const

inlineoverridevirtual

Get flags describing supported import sources.

Reimplemented from ITensorHandle.

Definition at line 53 of file MockTensorHandle.hpp.

References MockTensorHandle::CanBeImported(), MockTensorHandle::Import(), and MockTensorHandle::MockTensorHandle().

    {
        return m_ImportFlags;
    }

GetParent()

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 27 of file MockTensorHandle.hpp.

References MockTensorHandle::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 43 of file MockTensorHandle.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 38 of file MockTensorHandle.hpp.

References armnn::GetUnpaddedTensorStrides().

    {
        return GetUnpaddedTensorStrides(m_TensorInfo);
    }

GetTensorInfo()

const TensorInfo& GetTensorInfo ( ) const

inline

Definition at line 48 of file MockTensorHandle.hpp.

    {
        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 114 of file MockTensorHandle.cpp.

References MockTensorHandle::CanBeImported(), and armnn::Malloc.

Referenced by MockTensorHandle::GetImportFlags().

{
    if (m_ImportFlags & static_cast<MemorySourceFlags>(source))
    {
        if (m_IsImportEnabled && source == MemorySource::Malloc)
        {
            // Check memory alignment
            if (!CanBeImported(memory, source))
            {
                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 42 of file MockTensorHandle.cpp.

References ARMNN_ASSERT_MSG, and TensorInfo::GetNumBytes().

{
    if (!m_IsImportEnabled)
    {
        ARMNN_ASSERT_MSG(!m_Pool, "MockTensorHandle::Manage() called twice");
        ARMNN_ASSERT_MSG(!m_UnmanagedMemory, "MockTensorHandle::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 79 of file MockTensorHandle.cpp.

References ARMNN_ASSERT, and TensorInfo::GetNumBytes().

Referenced by MockTensorHandle::GetParent().

{
    return GetPointer();
}

Unmap()

void Unmap ( ) const

inlineoverridevirtual

Unmap the tensor data.

Implements ITensorHandle.

Definition at line 35 of file MockTensorHandle.hpp.

    {}

---

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

• include/armnnTestUtils/MockTensorHandle.hpp
• src/armnnTestUtils/MockTensorHandle.cpp