#include <RefBackend.hpp>

Inheritance diagram for RefBackend:

Public Member Functions
	RefBackend ()=default

	~RefBackend ()=default

const BackendId &	GetId () const override

IBackendInternal::IMemoryManagerUniquePtr	CreateMemoryManager () const override

IBackendInternal::IWorkloadFactoryPtr	CreateWorkloadFactory (const IBackendInternal::IMemoryManagerSharedPtr &memoryManager=nullptr) const override

IBackendInternal::IWorkloadFactoryPtr	CreateWorkloadFactory (class TensorHandleFactoryRegistry &tensorHandleFactoryRegistry) const override

IBackendInternal::IBackendContextPtr	CreateBackendContext (const IRuntime::CreationOptions &) const override
	Create the runtime context of the backend. More...

IBackendInternal::IBackendProfilingContextPtr	CreateBackendProfilingContext (const IRuntime::CreationOptions &creationOptions, IBackendProfilingPtr &backendProfiling) override
	Create context specifically used for profiling interaction from backends. More...

IBackendInternal::ILayerSupportSharedPtr	GetLayerSupport () const override

OptimizationViews	OptimizeSubgraphView (const SubgraphView &subgraph, const ModelOptions &modelOptions) const override

std::vector< ITensorHandleFactory::FactoryId >	GetHandleFactoryPreferences () const override
	(Optional) Returns a vector of supported TensorHandleFactory ids in preference order. More...

void	RegisterTensorHandleFactories (class TensorHandleFactoryRegistry &registry) override
	(Optional) Register TensorHandleFactories Either this method or CreateMemoryManager() and IWorkloadFactory::CreateTensor()/IWorkloadFactory::CreateSubtensor() methods must be implemented. More...

BackendCapabilities	GetCapabilities () const override
	Returns a BackendCapability if the backend lists the capability The BackendCapability must then be inspected to check whether or not that BackendCapability is supported Otherwise returns an EmptyOptional if the BackendCapability is unlisted. More...

std::unique_ptr< ICustomAllocator >	GetDefaultAllocator () const override
	Returns the default memory allocator for the backend. More...

ExecutionData	CreateExecutionData (WorkingMemDescriptor &workingMemDescriptor) const override
	Returns ExecutionData for the backend. More...

void	UpdateExecutionData (ExecutionData &executionData, WorkingMemDescriptor &workingMemDescriptor) const override
	Update the ExecutionData for a layer. More...

Public Member Functions inherited from IBackendInternal
	~IBackendInternal () override=default
	Allow backends created by the factory function to be destroyed through IBackendInternal. More...

virtual IWorkloadFactoryPtr	CreateWorkloadFactory (const IMemoryManagerSharedPtr &memoryManager, const ModelOptions &modelOptions) const

virtual IWorkloadFactoryPtr	CreateWorkloadFactory (class TensorHandleFactoryRegistry &tensorHandleFactoryRegistry, const ModelOptions &modelOptions) const

virtual IWorkloadFactoryPtr	CreateWorkloadFactory (class TensorHandleFactoryRegistry &tensorHandleFactoryRegistry, const ModelOptions &modelOptions, MemorySourceFlags inputFlags, MemorySourceFlags outputFlags) const

virtual IBackendSpecificModelContextPtr	CreateBackendSpecificModelContext (const ModelOptions &modelOptions) const

virtual ILayerSupportSharedPtr	GetLayerSupport (const ModelOptions &modelOptions) const

virtual OptimizationViews	OptimizeSubgraphView (const SubgraphView &subgraph) const

bool	SupportsTensorAllocatorAPI () const

ITensorHandleFactory::FactoryId	GetBackwardCompatibleFavoriteHandleFactory ()

virtual void	RegisterTensorHandleFactories (class TensorHandleFactoryRegistry &registry, MemorySourceFlags inputFlags, MemorySourceFlags outputFlags)
	(Optional) Register TensorHandleFactories Either this method or CreateMemoryManager() and IWorkloadFactory::CreateTensor()/IWorkloadFactory::CreateSubtensor() methods must be implemented. More...

virtual bool	UseCustomMemoryAllocator (std::shared_ptr< ICustomAllocator > allocator, armnn::Optional< std::string &> errMsg)
	Signals the backend to use a custom memory allocator provided by the user. More...

virtual unsigned int	GetNumberOfCacheFiles () const
	Returns the number of files cached if backend supports caching. More...

Static Public Member Functions
static const BackendId &	GetIdStatic ()

Static Public Member Functions inherited from IBackendInternal
static constexpr BackendVersion	GetApiVersion ()
	Returns the version of the Backend API. More...

Additional Inherited Members
Public Types inherited from IBackendInternal
using	IWorkloadFactoryPtr = std::unique_ptr< IWorkloadFactory >

using	IBackendContextPtr = std::unique_ptr< IBackendContext >

using	IBackendProfilingContextPtr = std::shared_ptr< arm::pipe::IBackendProfilingContext >
	This is the bridge between backend and backend profiling we'll keep it in the backend namespace. More...

using	IBackendProfilingPtr = std::unique_ptr< arm::pipe::IBackendProfiling >

using	ILayerSupportSharedPtr = std::shared_ptr< ILayerSupport >

using	IBackendSpecificModelContextPtr = std::shared_ptr< IBackendModelContext >

using	IMemoryManagerUniquePtr = std::unique_ptr< IMemoryManager >

using	IMemoryManagerSharedPtr = std::shared_ptr< IMemoryManager >

Protected Member Functions inherited from IBackendInternal
	IBackendInternal ()=default
	Creation must be done through a specific backend interface. More...

Protected Member Functions inherited from IBackend
	IBackend ()

virtual	~IBackend ()

Detailed Description

Definition at line 29 of file RefBackend.hpp.

Constructor & Destructor Documentation

◆ RefBackend()

RefBackend ( )

default

◆ ~RefBackend()

~RefBackend ( )

default

Member Function Documentation

◆ CreateBackendContext()

IBackendInternal::IBackendContextPtr CreateBackendContext ( const IRuntime::CreationOptions & ) const

overridevirtual

Create the runtime context of the backend.

Implementations may return a default-constructed IBackendContextPtr if no context is needed at runtime. Implementations must throw BackendUnavailableException if the backend cannot be used (for example, necessary accelerator hardware is not present). The default implementation always returns a default-constructed pointer.

Reimplemented from IBackendInternal.

Definition at line 52 of file RefBackend.cpp.

Referenced by RefBackend::GetId().

 {
     return IBackendContextPtr{};
 }

◆ CreateBackendProfilingContext()

IBackendInternal::IBackendProfilingContextPtr CreateBackendProfilingContext	(	const IRuntime::CreationOptions &	creationOptions,
		IBackendProfilingPtr &	backendProfiling
	)

overridevirtual

Create context specifically used for profiling interaction from backends.

Reimplemented from IBackendInternal.

Definition at line 57 of file RefBackend.cpp.

Referenced by RefBackend::GetId().

 {
     return IBackendProfilingContextPtr{};
 }

◆ CreateExecutionData()

ExecutionData CreateExecutionData ( WorkingMemDescriptor & workingMemDescriptor ) const

overridevirtual

Returns ExecutionData for the backend.

Parameters

workingMemDescriptor - Vectors of input and output TensorHandles for a layer

Returns: - Returns backend specific ExecutionData generated for a layer

Reimplemented from IBackendInternal.

Definition at line 157 of file RefBackend.cpp.

References ExecutionData::m_Data.

Referenced by RefBackend::GetCapabilities().

 {
     ExecutionData executionData;
     executionData.m_Data = &workingMemDescriptor;
     return executionData;
 }

◆ CreateMemoryManager()

IBackendInternal::IMemoryManagerUniquePtr CreateMemoryManager ( ) const

overridevirtual

Reimplemented from IBackendInternal.

Definition at line 63 of file RefBackend.cpp.

Referenced by RefBackend::GetId().

 {
     return std::make_unique<RefMemoryManager>();
 }

◆ CreateWorkloadFactory() [1/2]

IBackendInternal::IWorkloadFactoryPtr CreateWorkloadFactory ( const IBackendInternal::IMemoryManagerSharedPtr & memoryManager = nullptr ) const

overridevirtual

Implements IBackendInternal.

Definition at line 30 of file RefBackend.cpp.

Referenced by RefBackend::GetId().

 {
     return std::make_unique<RefWorkloadFactory>(PolymorphicPointerDowncast<RefMemoryManager>(memoryManager));
 }

◆ CreateWorkloadFactory() [2/2]

IBackendInternal::IWorkloadFactoryPtr CreateWorkloadFactory ( class TensorHandleFactoryRegistry & tensorHandleFactoryRegistry ) const

overridevirtual

Reimplemented from IBackendInternal.

Definition at line 36 of file RefBackend.cpp.

References TensorHandleFactoryRegistry::RegisterCopyAndImportFactoryPair(), TensorHandleFactoryRegistry::RegisterFactory(), and TensorHandleFactoryRegistry::RegisterMemoryManager().

 {
     auto memoryManager = std::make_shared<RefMemoryManager>();
 
     tensorHandleFactoryRegistry.RegisterMemoryManager(memoryManager);
 
     std::unique_ptr<RefTensorHandleFactory> factory = std::make_unique<RefTensorHandleFactory>(memoryManager);
     // Register copy and import factory pair
     tensorHandleFactoryRegistry.RegisterCopyAndImportFactoryPair(factory->GetId(), factory->GetId());
     // Register the factory
     tensorHandleFactoryRegistry.RegisterFactory(std::move(factory));
 
     return std::make_unique<RefWorkloadFactory>(PolymorphicPointerDowncast<RefMemoryManager>(memoryManager));
 }

◆ GetCapabilities()

BackendCapabilities GetCapabilities ( ) const

inlineoverridevirtual

Returns a BackendCapability if the backend lists the capability The BackendCapability must then be inspected to check whether or not that BackendCapability is supported Otherwise returns an EmptyOptional if the BackendCapability is unlisted.

Reimplemented from IBackendInternal.

Definition at line 60 of file RefBackend.hpp.

References armnn::cpuRefCapabilities, RefBackend::CreateExecutionData(), RefBackend::GetDefaultAllocator(), and RefBackend::UpdateExecutionData().

     {
         return cpuRefCapabilities;
     };

◆ GetDefaultAllocator()

std::unique_ptr< ICustomAllocator > GetDefaultAllocator ( ) const

overridevirtual

Returns the default memory allocator for the backend.

Returns: - Returns unique pointer to the Default Allocator of the Backend

Reimplemented from IBackendInternal.

Definition at line 152 of file RefBackend.cpp.

Referenced by RefBackend::GetCapabilities().

 {
     return std::make_unique<DefaultAllocator>();
 }

◆ GetHandleFactoryPreferences()

std::vector< ITensorHandleFactory::FactoryId > GetHandleFactoryPreferences ( ) const

overridevirtual

(Optional) Returns a vector of supported TensorHandleFactory ids in preference order.

Reimplemented from IBackendInternal.

Definition at line 133 of file RefBackend.cpp.

References RefTensorHandleFactory::GetIdStatic().

Referenced by RefBackend::GetId().

 {
     return std::vector<ITensorHandleFactory::FactoryId> { RefTensorHandleFactory::GetIdStatic() };
 }

◆ GetId()

const BackendId& GetId ( ) const

inlineoverridevirtual

Implements IBackend.

Definition at line 36 of file RefBackend.hpp.

References RefBackend::CreateBackendContext(), RefBackend::CreateBackendProfilingContext(), RefBackend::CreateMemoryManager(), RefBackend::CreateWorkloadFactory(), RefBackend::GetHandleFactoryPreferences(), RefBackend::GetIdStatic(), RefBackend::GetLayerSupport(), RefBackend::OptimizeSubgraphView(), and RefBackend::RegisterTensorHandleFactories().

36 { return GetIdStatic(); }

armnn::RefBackend::GetIdStatic

static const BackendId & GetIdStatic()

Definition: RefBackend.cpp:24

◆ GetIdStatic()

const BackendId & GetIdStatic ( )

static

Definition at line 24 of file RefBackend.cpp.

References armnn::RefBackendId().

Referenced by GetBackendId(), and RefBackend::GetId().

 {
     static const BackendId s_Id{RefBackendId()};
     return s_Id;
 }

◆ GetLayerSupport()

IBackendInternal::ILayerSupportSharedPtr GetLayerSupport ( ) const

overridevirtual

Implements IBackendInternal.

Definition at line 68 of file RefBackend.cpp.

Referenced by RefBackend::GetId().

 {
     static ILayerSupportSharedPtr layerSupport{new RefLayerSupport};
     return layerSupport;
 }

◆ OptimizeSubgraphView()

OptimizationViews OptimizeSubgraphView	(	const SubgraphView &	subgraph,
		const ModelOptions &	modelOptions
	)		const

overridevirtual

Reimplemented from IBackendInternal.

Definition at line 74 of file RefBackend.cpp.

References OptimizationViews::AddUntouchedSubgraph(), SubgraphView::beginIConnectable(), SubgraphView::endIConnectable(), InputSlot::GetConnectedOutputSlot(), Layer::GetGuid(), Layer::GetInputSlot(), OutputSlot::GetNumConnections(), Layer::GetOutputSlot(), OutputSlot::GetOwningLayer(), LayerWithParameters< Parameters >::GetParameters(), OptimizationViews::GetSubstitutions(), OutputSlot::GetTensorInfo(), Layer::GetType(), armnn::Pad, armnn::Pooling2d, armnn::ReportUntouchedLayers(), and armnn::optimizations::pad_fold::TryFoldPadIntoLayer2d().

Referenced by RefBackend::GetId().

 {
     OptimizationViews optimizationViews(modelOptions);
 
     auto it = subgraph.endIConnectable();
     std::map<LayerGuid, Layer*> untouched;
 
     while (it != subgraph.beginIConnectable())
     {
         --it;
         Layer& base = *(PolymorphicDowncast<Layer*>(*it));
         untouched.insert({base.GetGuid(), &base});
     }
 
     it = subgraph.endIConnectable();
     while (it != subgraph.beginIConnectable())
     {
         --it;
         Layer& base = *(PolymorphicDowncast<Layer*>(*it));
 
         // Special case to fuse padding into average pooling 2d for quantized datatype.
         // Required to be done as a backend specific optimization as Neon does not support this special case.
         if (base.GetType() == LayerType::Pooling2d)
         {
             Pooling2dLayer* baseLayer = PolymorphicDowncast<Pooling2dLayer*>(&base);
             Pooling2dDescriptor poolingDescriptor = baseLayer->GetParameters();
 
             if (baseLayer->GetInputSlot(0).GetConnectedOutputSlot()->GetOwningLayer().GetType() == LayerType::Pad)
             {
                 PadLayer* padLayer = PolymorphicDowncast<PadLayer*>(
                     &baseLayer->GetInputSlot(0).GetConnectedOutputSlot()->GetOwningLayer());
                 if (padLayer->GetOutputSlot(0).GetNumConnections() == 1 &&
                     optimizations::pad_fold::TryFoldPadIntoLayer2d(padLayer->GetParameters(),
                                                                    poolingDescriptor,
                                                                    padLayer->GetOutputSlot().GetTensorInfo(),
                                                                    true))
                 {
                     FoldPadIntoAveragePool2d<Pooling2dLayer>(optimizationViews, baseLayer,
                                                              poolingDescriptor, padLayer);
                     untouched.erase(baseLayer->GetGuid());
                     untouched.erase(padLayer->GetGuid());
                 }
             }
         }
     }
 
     if (optimizationViews.GetSubstitutions().empty())
     {
         optimizationViews.AddUntouchedSubgraph(SubgraphView(subgraph));
     }
     else
     {
         ReportUntouchedLayers(optimizationViews, untouched);
     }
 
     return optimizationViews;
 }

◆ RegisterTensorHandleFactories()

void RegisterTensorHandleFactories ( class TensorHandleFactoryRegistry & )

overridevirtual

(Optional) Register TensorHandleFactories Either this method or CreateMemoryManager() and IWorkloadFactory::CreateTensor()/IWorkloadFactory::CreateSubtensor() methods must be implemented.

Reimplemented from IBackendInternal.

Definition at line 138 of file RefBackend.cpp.

References TensorHandleFactoryRegistry::RegisterCopyAndImportFactoryPair(), TensorHandleFactoryRegistry::RegisterFactory(), and TensorHandleFactoryRegistry::RegisterMemoryManager().

Referenced by RefBackend::GetId().

 {
     auto memoryManager = std::make_shared<RefMemoryManager>();
 
     registry.RegisterMemoryManager(memoryManager);
 
     std::unique_ptr<RefTensorHandleFactory> factory = std::make_unique<RefTensorHandleFactory>(memoryManager);
 
     // Register copy and import factory pair
     registry.RegisterCopyAndImportFactoryPair(factory->GetId(), factory->GetId());
     // Register the factory
     registry.RegisterFactory(std::move(factory));
 }

◆ UpdateExecutionData()

void UpdateExecutionData	(	ExecutionData &	executionData,
		WorkingMemDescriptor &	workingMemDescriptor
	)		const

overridevirtual

Update the ExecutionData for a layer.

It is used to swap in pre-imported tensor handles

Parameters

executionData	- Backend specific ExecutionData generated for a layer
workingMemDescriptor	- Vectors of input and output TensorHandles for a layer

Reimplemented from IBackendInternal.

Definition at line 164 of file RefBackend.cpp.

References ExecutionData::m_Data.

Referenced by RefBackend::GetCapabilities().

 {
     executionData.m_Data = &workingMemDescriptor;
 }

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

src/backends/reference/RefBackend.hpp
src/backends/reference/RefBackend.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RefBackend()

◆ ~RefBackend()

Member Function Documentation

◆ CreateBackendContext()

◆ CreateBackendProfilingContext()

◆ CreateExecutionData()

◆ CreateMemoryManager()

◆ CreateWorkloadFactory() [1/2]

◆ CreateWorkloadFactory() [2/2]

◆ GetCapabilities()

◆ GetDefaultAllocator()

◆ GetHandleFactoryPreferences()

◆ GetId()

◆ GetIdStatic()

◆ GetLayerSupport()

◆ OptimizeSubgraphView()

◆ RegisterTensorHandleFactories()

◆ UpdateExecutionData()