BackendRegistry Class Reference

#include <BackendRegistry.hpp>

Inheritance diagram for BackendRegistry:

Classes
struct	StaticRegistryInitializer

Public Types
using	PointerType = IBackendInternalUniquePtr
using	FactoryFunction = std::function< PointerType()>

Public Member Functions
void	Register (const BackendId &id, FactoryFunction factory)
bool	IsBackendRegistered (const BackendId &id) const
FactoryFunction	GetFactory (const BackendId &id) const
size_t	Size () const
BackendIdSet	GetBackendIds () const
std::string	GetBackendIdsAsString () const
void	SetProfilingService (armnn::Optional< profiling::ProfilingService &> profilingService)
void	RegisterAllocator (const BackendId &id, std::shared_ptr< ICustomAllocator > alloc)
std::unordered_map< BackendId, std::shared_ptr< ICustomAllocator > >	GetAllocators ()
void	RegisterMemoryOptimizerStrategy (const BackendId &id, std::shared_ptr< IMemoryOptimizerStrategy > strategy)
MemoryOptimizerStrategiesMapRef	GetMemoryOptimizerStrategies ()
	BackendRegistry ()
virtual	~BackendRegistry ()
void	Deregister (const BackendId &id)
void	DeregisterAllocator (const BackendId &id)
void	DeregisterMemoryOptimizerStrategy (const BackendId &id)

Protected Types
using	FactoryStorage = std::unordered_map< BackendId, FactoryFunction >

Static Protected Member Functions
static void	Swap (BackendRegistry &instance, FactoryStorage &other)
	For testing only. More...

Detailed Description

Definition at line 29 of file BackendRegistry.hpp.

Member Typedef Documentation

FactoryFunction

using FactoryFunction = std::function<PointerType()>

Definition at line 33 of file BackendRegistry.hpp.

FactoryStorage

using FactoryStorage = std::unordered_map<BackendId, FactoryFunction>

protected

Definition at line 65 of file BackendRegistry.hpp.

PointerType

using PointerType = IBackendInternalUniquePtr

Definition at line 32 of file BackendRegistry.hpp.

Constructor & Destructor Documentation

BackendRegistry()

BackendRegistry ( )

inline

Definition at line 47 of file BackendRegistry.hpp.

{}

~BackendRegistry()

virtual ~BackendRegistry ( )

inlinevirtual

Definition at line 48 of file BackendRegistry.hpp.

{}

Member Function Documentation

Deregister()

void Deregister

(

const BackendId &

id

)

Definition at line 39 of file BackendRegistry.cpp.

References BackendRegistry::DeregisterAllocator().

Referenced by DynamicBackendUtils::DeregisterDynamicBackends(), TEST_SUITE(), MockBackendInitialiser::~MockBackendInitialiser(), and MockImportBackendInitialiser::~MockImportBackendInitialiser().

{
    m_Factories.erase(id);
    DeregisterAllocator(id);

    if (m_ProfilingService.has_value() && m_ProfilingService.value().IsProfilingEnabled())
    {
        m_ProfilingService.value().IncrementCounterValue(armnn::profiling::UNREGISTERED_BACKENDS);
    }
}

DeregisterAllocator()

void DeregisterAllocator

(

const BackendId &

id

)

Definition at line 121 of file BackendRegistry.cpp.

Referenced by BackendRegistry::Deregister().

{
    m_CustomMemoryAllocatorMap.erase(id);
}

DeregisterMemoryOptimizerStrategy()

void DeregisterMemoryOptimizerStrategy

(

const BackendId &

id

)

Definition at line 143 of file BackendRegistry.cpp.

Referenced by TEST_SUITE().

{
    m_MemoryOptimizerStrategyMap.erase(id);
}

GetAllocators()

std::unordered_map< BackendId, std::shared_ptr< ICustomAllocator > > GetAllocators

(

)

Definition at line 126 of file BackendRegistry.cpp.

Referenced by LoadedNetwork::RegisterDebugCallback().

{
    return m_CustomMemoryAllocatorMap;
}

GetBackendIds()

BackendIdSet GetBackendIds

(

)

const

Definition at line 73 of file BackendRegistry.cpp.

Referenced by BackendRegistry::GetBackendIdsAsString(), and TEST_SUITE().

{
    BackendIdSet result;
    for (const auto& it : m_Factories)
    {
        result.insert(it.first);
    }
    return result;
}

GetBackendIdsAsString()

std::string GetBackendIdsAsString

(

)

const

Definition at line 83 of file BackendRegistry.cpp.

References BackendRegistry::GetBackendIds().

Referenced by InferenceModel< IParser, TDataType >::AddCommandLineOptions(), main(), and ProgramOptions::ProgramOptions().

{
    static const std::string delimitator = ", ";

    std::stringstream output;
    for (auto& backendId : GetBackendIds())
    {
        if (output.tellp() != std::streampos(0))
        {
            output << delimitator;
        }
        output << backendId;
    }

    return output.str();
}

GetFactory()

BackendRegistry::FactoryFunction GetFactory

(

const BackendId &

id

)

const

Definition at line 55 of file BackendRegistry.cpp.

References CHECK_LOCATION.

Referenced by armnn::GetILayerSupportByBackendId(), LoadedNetwork::MakeLoadedNetwork(), RuntimeImpl::RuntimeImpl(), and TEST_SUITE().

{
    auto it = m_Factories.find(id);
    if (it == m_Factories.end())
    {
        throw InvalidArgumentException(
            std::string(id) + " has no IBackend factory registered",
            CHECK_LOCATION());
    }

    return it->second;
}

GetMemoryOptimizerStrategies()

MemoryOptimizerStrategiesMapRef GetMemoryOptimizerStrategies

(

)

Definition at line 148 of file BackendRegistry.cpp.

Referenced by LoadedNetwork::MakeLoadedNetwork().

{
    return m_MemoryOptimizerStrategyMap;
}

IsBackendRegistered()

bool IsBackendRegistered

(

const BackendId &

id

)

const

Definition at line 50 of file BackendRegistry.cpp.

Referenced by armnn::GetILayerSupportByBackendId(), and DynamicBackendUtils::RegisterDynamicBackendsImpl().

{
    return (m_Factories.find(id) != m_Factories.end());
}

Register()

void Register	(	const BackendId &	id,
		BackendRegistry::FactoryFunction	factory
	)

Definition at line 19 of file BackendRegistry.cpp.

References CHECK_LOCATION.

Referenced by MockBackendInitialiser::MockBackendInitialiser(), MockImportBackendInitialiser::MockImportBackendInitialiser(), DynamicBackendUtils::RegisterDynamicBackendsImpl(), BackendRegistry::StaticRegistryInitializer::StaticRegistryInitializer(), and TEST_SUITE().

{
    if (m_Factories.find(id) != m_Factories.end())
    {
        throw InvalidArgumentException(
            std::string(id) + " already registered as IBackend factory",
            CHECK_LOCATION());
    }
    m_Factories[id] = factory;

    if (m_ProfilingService.has_value())
    {
        if (m_ProfilingService.has_value() && m_ProfilingService.value().IsProfilingEnabled())
        {
            m_ProfilingService.value().IncrementCounterValue(armnn::profiling::REGISTERED_BACKENDS);
        }
    }

}

RegisterAllocator()

void RegisterAllocator	(	const BackendId &	id,
		std::shared_ptr< ICustomAllocator >	alloc
	)

Definition at line 110 of file BackendRegistry.cpp.

References CHECK_LOCATION.

Referenced by RuntimeImpl::RuntimeImpl().

{
    if (m_CustomMemoryAllocatorMap.find(id) != m_CustomMemoryAllocatorMap.end())
    {
        throw InvalidArgumentException(
            std::string(id) + " already has an allocator associated with it",
            CHECK_LOCATION());
    }
    m_CustomMemoryAllocatorMap[id] = alloc;
}

RegisterMemoryOptimizerStrategy()

void RegisterMemoryOptimizerStrategy	(	const BackendId &	id,
		std::shared_ptr< IMemoryOptimizerStrategy >	strategy
	)

Definition at line 131 of file BackendRegistry.cpp.

References CHECK_LOCATION.

Referenced by RuntimeImpl::RuntimeImpl(), and TEST_SUITE().

{
    if (m_MemoryOptimizerStrategyMap.find(id) != m_MemoryOptimizerStrategyMap.end())
    {
        throw InvalidArgumentException(
            std::string(id) + " already has an memory optimizer strategy associated with it",
            CHECK_LOCATION());
    }
    m_MemoryOptimizerStrategyMap[id] = strategy;
}

SetProfilingService()

void SetProfilingService

(

armnn::Optional< profiling::ProfilingService &>

profilingService

)

Definition at line 105 of file BackendRegistry.cpp.

Referenced by RuntimeImpl::RuntimeImpl(), and RuntimeImpl::~RuntimeImpl().

{
    m_ProfilingService = profilingService;
}

Size()

size_t Size

(

)

const

Definition at line 68 of file BackendRegistry.cpp.

Referenced by RuntimeEmptyTestImpl(), RuntimeInvalidOverridePathTestImpl(), and TEST_SUITE().

{
    return m_Factories.size();
}

Swap()

void Swap ( BackendRegistry &  instance, BackendRegistry::FactoryStorage &  other  )

staticprotected

For testing only.

Definition at line 100 of file BackendRegistry.cpp.

References armnn::swap().

{
    std::swap(instance.m_Factories, other);
}

---

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

• include/armnn/BackendRegistry.hpp
• src/armnn/BackendRegistry.cpp