18 #include <common/include/LabelsAndEventClasses.hpp> 24 using namespace armnn;
52 return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network));
57 std::string& errorMessage)
59 return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network), errorMessage);
64 std::string& errorMessage,
67 return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network), errorMessage, networkProperties);
72 return pRuntimeImpl->GetInputTensorInfo(networkId, layerId);
77 return pRuntimeImpl->GetOutputTensorInfo(networkId, layerId);
83 return pRuntimeImpl->ImportInputs(networkId, inputTensors, forceImportMemorySource);
89 return pRuntimeImpl->ImportOutputs(networkId, outputTensors, forceImportMemorySource);
94 return pRuntimeImpl->ClearImportedInputs(networkId, inputIds);
98 return pRuntimeImpl->ClearImportedOutputs(networkId, outputIds);
104 std::vector<ImportedInputId> preImportedInputIds,
105 std::vector<ImportedOutputId> preImportedOutputIds)
107 return pRuntimeImpl->EnqueueWorkload(networkId, inputTensors, outputTensors,
108 preImportedInputIds, preImportedOutputIds);
114 std::vector<ImportedInputId> preImportedInputs,
115 std::vector<ImportedOutputId> preImportedOutputs)
117 return pRuntimeImpl->Execute(workingMemHandle, inputTensors, outputTensors, preImportedInputs, preImportedOutputs);
142 return pRuntimeImpl->RegisterDebugCallback(networkId, func);
145 int RuntimeImpl::GenerateNetworkId()
147 return m_NetworkIdCounter++;
152 std::string ignoredErrorMessage;
153 return LoadNetwork(networkIdOut, std::move(inNetwork), ignoredErrorMessage);
158 std::string& errorMessage)
162 return LoadNetwork(networkIdOut, std::move(inNetwork), errorMessage, networkProperties);
167 std::string& errorMessage,
171 auto profiler = inNetwork->GetProfiler();
176 networkIdOut = GenerateNetworkId();
178 for (
auto&& context : m_BackendContexts)
180 context.second->BeforeLoadNetwork(networkIdOut);
184 std::unique_ptr<IOptimizedNetwork>(rawNetwork),
195 std::lock_guard<std::mutex> lockGuard(m_Mutex);
198 m_LoadedNetworks[networkIdOut] = std::move(loadedNetwork);
201 for (
auto&& context : m_BackendContexts)
203 context.second->AfterLoadNetwork(networkIdOut);
206 if (m_ProfilingService.IsProfilingEnabled())
208 m_ProfilingService.IncrementCounterValue(armnn::profiling::NETWORK_LOADS);
216 bool unloadOk =
true;
217 for (
auto&& context : m_BackendContexts)
219 unloadOk &= context.second->BeforeUnloadNetwork(networkId);
225 "network with ID:" << networkId <<
" because BeforeUnloadNetwork failed";
229 std::unique_ptr<profiling::TimelineUtilityMethods> timelineUtils =
232 std::lock_guard<std::mutex> lockGuard(m_Mutex);
237 auto search = m_LoadedNetworks.find(networkId);
238 if (search != m_LoadedNetworks.end())
240 profiling::ProfilingGuid networkGuid = search->second->GetNetworkGuid();
241 timelineUtils->RecordEvent(networkGuid,
242 profiling::LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS);
246 if (m_LoadedNetworks.erase(networkId) == 0)
248 ARMNN_LOG(
warning) <<
"WARNING: RuntimeImpl::UnloadNetwork(): " << networkId <<
" not found!";
252 if (m_ProfilingService.IsProfilingEnabled())
254 m_ProfilingService.IncrementCounterValue(armnn::profiling::NETWORK_UNLOADS);
258 for (
auto&& context : m_BackendContexts)
260 context.second->AfterUnloadNetwork(networkId);
266 ARMNN_LOG(
debug) <<
"RuntimeImpl::UnloadNetwork(): Unloaded network with ID: " << networkId;
272 auto it = m_LoadedNetworks.find(networkId);
273 if (it != m_LoadedNetworks.end())
275 auto& loadedNetwork = it->second;
276 return loadedNetwork->GetProfiler();
287 LoadedNetworks::iterator it = m_LoadedNetworks.begin();
288 while (it != m_LoadedNetworks.end())
290 auto& loadedNetwork = it->second;
291 loadedNetwork->SendNetworkStructure();
298 : m_NetworkIdCounter(0),
299 m_ProfilingService(*this)
306 "It is not possible to enable timeline reporting without profiling being enabled");
320 auto backend = factoryFun();
326 customAllocatorMapIterator->second ==
nullptr)
331 throw armnn::Exception(
"Allocator associated with id " +
id.Get() +
" is null");
339 BackendCapability protectedContentCapability {
"ProtectedContentAllocation",
true};
346 <<
" is not registered as does not support protected content allocation.";
354 if (customAllocatorMapIterator->second->GetMemorySourceType()
357 if (!backend->UseCustomMemoryAllocator(customAllocatorMapIterator->second, err))
361 <<
" reported an error when entering protected mode. Backend won't be" 362 <<
" used. ErrorMsg: " << err;
370 ARMNN_LOG(
error) <<
"The CustomAllocator provided with the runtime options doesn't support " 371 "protected memory. Protected mode can't be activated. The backend " 373 <<
" is not going to be used. MemorySource must be MemorySource::DmaBufProtected";
379 ARMNN_LOG(
error) <<
"Protected mode can't be activated for backend: " 381 <<
" no custom allocator was provided to the runtime options.";
391 if (!backend->UseCustomMemoryAllocator(customAllocatorMapIterator->second, err))
395 <<
" reported an error when trying to use the provided custom allocator." 396 " Backend won't be used." 397 <<
" ErrorMsg: " << err;
414 id, customMemoryOptimizerStrategyMapIterator->second);
417 << customMemoryOptimizerStrategyMapIterator->second->GetName()
418 <<
" set for the backend " <<
id <<
".";
424 std::string memoryOptimizerStrategyName =
"";
427 if (name ==
"MemoryOptimizerStrategy")
429 memoryOptimizerStrategyName = ParseStringBackendOption(value,
"");
432 if (memoryOptimizerStrategyName !=
"")
434 std::shared_ptr<IMemoryOptimizerStrategy> strategy =
439 ARMNN_LOG(
warning) <<
"MemoryOptimizerStrategy: " << memoryOptimizerStrategyName
440 <<
" was not found.";
452 << memoryOptimizerStrategyName <<
" set for the backend " <<
id <<
".";
458 <<
" does not have multi-axis packing capability and cannot support" 459 <<
"MemoryOptimizerStrategy: " << memoryOptimizerStrategyName <<
".";
465 auto context = backend->CreateBackendContext(options);
471 m_BackendContexts.emplace(std::make_pair(
id, std::move(context)));
473 supportedBackends.emplace(
id);
475 unique_ptr<armnn::profiling::IBackendProfiling> profilingIface =
477 options, m_ProfilingService,
id));
480 auto profilingContext = backend->CreateBackendProfilingContext(options, profilingIface);
482 if (profilingContext)
497 if (options.m_ProfilingOptions.m_EnableProfiling)
505 ARMNN_LOG(
info) <<
"Initialization time: " << std::setprecision(2)
512 std::vector<int> networkIDs;
516 std::transform(m_LoadedNetworks.begin(), m_LoadedNetworks.end(),
517 std::back_inserter(networkIDs),
518 [](
const auto &pair) {
return pair.first; });
520 catch (
const std::exception& e)
525 std::cerr <<
"WARNING: An error has occurred when getting the IDs of the networks to unload: " << e.what()
526 <<
"\nSome of the loaded networks may not be unloaded" << std::endl;
531 for (
auto networkID : networkIDs)
539 catch (
const std::exception& e)
544 std::cerr <<
"WARNING: An error has occurred when unloading network " << networkID <<
": " << e.what()
552 m_BackendContexts.clear();
561 std::lock_guard<std::mutex> lockGuard(m_Mutex);
562 return m_LoadedNetworks.at(networkId).get();
578 return GetLoadedNetworkPtr(networkId)->
ImportInputs(inputTensors, forceImportMemorySource);
584 return GetLoadedNetworkPtr(networkId)->
ImportOutputs(outputTensors, forceImportMemorySource);
599 std::vector<ImportedInputId> preImportedInputIds,
600 std::vector<ImportedOutputId> preImportedOutputIds)
604 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
608 ARMNN_LOG(
error) <<
"A Network with an id of " << networkId <<
" does not exist.";
613 ARMNN_LOG(
error) <<
"Network " << networkId <<
" is async enabled.";
620 static thread_local
NetworkId lastId = networkId;
621 if (lastId != networkId)
630 auto status = loadedNetwork->
EnqueueWorkload(inputTensors, outputTensors,
631 preImportedInputIds, preImportedOutputIds);
635 if (!preImportedInputIds.empty() || !preImportedOutputIds.empty())
638 for (
auto&& context : m_BackendContexts)
640 context.second->AfterEnqueueWorkload(networkId);
643 ARMNN_LOG(
info) <<
"Execution time: " << std::setprecision(2)
651 std::vector<ImportedInputId> preImportedInputs,
652 std::vector<ImportedOutputId> preImportedOutputs)
657 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
661 ARMNN_LOG(
error) <<
"A Network with an id of " << networkId <<
" does not exist.";
666 ARMNN_LOG(
error) <<
"Attempting execute " << networkId <<
" when it is not async enabled.";
673 auto status = loadedNetwork->
Execute(inputTensors,
679 ARMNN_LOG(
info) <<
"Execution time: " << std::setprecision(2)
689 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
693 ARMNN_LOG(
error) <<
"A Network with an id of " << networkId <<
" does not exist.";
698 ARMNN_LOG(
error) <<
"Network " << networkId <<
" is not async enabled.";
705 static thread_local
NetworkId lastId = networkId;
706 if (lastId != networkId)
720 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
724 void RuntimeImpl::LoadDynamicBackends(
const std::string& overrideBackendPath)
void AddSupportedBackends(const BackendIdSet &backendIds, bool isDynamic=false)
Status Execute(const InputTensors &inputTensors, const OutputTensors &outputTensors, IWorkingMemHandle &workingMemHandle, std::vector< ImportedInputId > preImportedInputs={}, std::vector< ImportedOutputId > preImportedOutputs={})
Thread safe execution of the loaded network.
armnn::TensorInfo GetInputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
std::unique_ptr< IWorkingMemHandle > CreateWorkingMemHandle(NetworkId networkId)
Create a new unique WorkingMemHandle object.
void WaitForProfilingServiceActivation(unsigned int timeout) override
bool HasCapability(const std::string &name, const BackendCapabilities &capabilities)
Convenience function to check if a capability exists in a BackendCapabilites struct.
static IRuntimePtr Create(const CreationOptions &options)
FactoryFunction GetFactory(const BackendId &id) const
const std::shared_ptr< IProfiler > GetProfiler(NetworkId networkId) const
Gets the profiler corresponding to the given network id.
std::chrono::duration< double, std::milli > GetTimeDuration(std::chrono::high_resolution_clock::time_point start_time)
Very basic type safe variant.
static void DeregisterDynamicBackends(const BackendIdSet &dynamicBackends)
virtual NetworkId GetNetworkId()=0
Returns the NetworkId of the Network that this IWorkingMemHandle works with.
std::unordered_set< BackendId > BackendIdSet
static std::unique_ptr< TimelineUtilityMethods > GetTimelineUtils(ProfilingService &profilingService)
static ProfilerManager & GetInstance()
void ParseOptions(const std::vector< BackendOptions > &options, BackendId backend, F f)
Status Execute(IWorkingMemHandle &workingMemHandle, const InputTensors &inputTensors, const OutputTensors &outputTensors, std::vector< ImportedInputId > preImportedInputs, std::vector< ImportedOutputId > preImportedOutputs)
This is an experimental function.
#define ARMNN_VERSION
ARMNN_VERSION: "X.Y.Z" where: X = Major version number Y = Minor version number Z = Patch version num...
Status UnloadNetwork(NetworkId networkId)
Unloads a network from the Runtime.
void RegisterMemoryOptimizerStrategy(const BackendId &id, std::shared_ptr< IMemoryOptimizerStrategy > strategy)
std::unique_ptr< IRuntime, void(*)(IRuntime *runtime)> IRuntimePtr
TensorInfo GetInputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
void RegisterAllocator(const BackendId &id, std::shared_ptr< ICustomAllocator > alloc)
TensorInfo GetInputTensorInfo(LayerBindingId layerId) const
#define ARMNN_LOG(severity)
BackendRegistry & BackendRegistryInstance()
Status LoadNetwork(NetworkId &networkIdOut, IOptimizedNetworkPtr network)
Loads a complete network into the Runtime.
std::vector< std::pair< LayerBindingId, class ConstTensor > > InputTensors
static std::vector< DynamicBackendPtr > CreateDynamicBackends(const std::vector< std::string > &sharedObjects)
armnn::TensorInfo GetOutputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
std::chrono::high_resolution_clock::time_point GetTimeNow()
std::map< BackendId, std::shared_ptr< IMemoryOptimizerStrategy > > m_MemoryOptimizerStrategyMap
A map to define a custom memory optimizer strategy for specific backend Ids.
TensorInfo GetOutputTensorInfo(LayerBindingId layerId) const
Copyright (c) 2021 ARM Limited and Contributors.
std::vector< ImportedInputId > ImportInputs(const InputTensors &inputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
bool m_EnableProfiling
Indicates whether external profiling is enabled or not.
void RegisterDebugCallback(NetworkId networkId, const DebugCallbackFunction &func)
Registers a callback function to debug layers performing custom computations on intermediate tensors...
const std::shared_ptr< IProfiler > GetProfiler(NetworkId networkId) const
Gets the profiler corresponding to the given network id.
std::function< void(LayerGuid guid, unsigned int slotIndex, ITensorHandle *tensorHandle)> DebugCallbackFunction
Define the type of callback for the Debug layer to call.
static std::vector< std::string > GetBackendPaths(const std::string &overrideBackendPath="")
#define ARMNN_SCOPED_PROFILING_EVENT(backendId, name)
int LayerBindingId
Type of identifiers for bindable layers (inputs, outputs).
static void Destroy(IRuntime *runtime)
void RegisterDebugCallback(NetworkId networkId, const DebugCallbackFunction &func)
Registers a callback function to debug layers performing custom computations on intermediate tensors...
std::vector< BackendOptions > m_BackendOptions
Pass backend specific options.
BackendCapability
BackendCapability class.
static std::vector< std::string > GetSharedObjects(const std::vector< std::string > &backendPaths)
Status UnloadNetwork(NetworkId networkId)
Unloads a network from the IRuntime.
void ClearImportedInputs(NetworkId networkId, const std::vector< ImportedInputId > inputIds)
Un-import and delete the imported InputTensor/s This function is not thread safe and must not be used...
std::vector< std::pair< LayerBindingId, class Tensor > > OutputTensors
std::unique_ptr< IOptimizedNetwork, void(*)(IOptimizedNetwork *network)> IOptimizedNetworkPtr
void SetProfilingService(armnn::Optional< profiling::ProfilingService &> profilingService)
void ClearImportedInputs(NetworkId networkId, const std::vector< ImportedInputId > inputIds)
std::map< BackendId, std::shared_ptr< ICustomAllocator > > m_CustomAllocatorMap
A map to define a custom memory allocator for specific backend Ids.
#define ARMNN_ASSERT(COND)
Status Execute(IWorkingMemHandle &workingMemHandle, const InputTensors &inputTensors, const OutputTensors &outputTensors, std::vector< ImportedInputId > preImportedInputs={}, std::vector< ImportedOutputId > preImportedOutputs={})
This is an experimental function.
std::unique_ptr< RuntimeImpl > pRuntimeImpl
Status EnqueueWorkload(NetworkId networkId, const InputTensors &inputTensors, const OutputTensors &outputTensors, std::vector< ImportedInputId > preImportedInputIds={}, std::vector< ImportedOutputId > preImportedOutputIds={})
Evaluates a network using input in inputTensors and outputs filled into outputTensors.
void ClearImportedInputs(const std::vector< ImportedInputId > inputIds)
Status LoadNetwork(NetworkId &networkIdOut, IOptimizedNetworkPtr network)
Loads a complete network into the IRuntime.
Device specific knowledge to be passed to the optimizer.
static IRuntime * CreateRaw(const CreationOptions &options)
std::unique_ptr< IMemoryOptimizerStrategy > GetMemoryOptimizerStrategy(const std::string &strategyName)
const IDeviceSpec & GetDeviceSpec() const
bool m_ProtectedMode
Setting this flag will allow the user to create the Runtime in protected mode.
std::vector< ImportedInputId > ImportInputs(NetworkId networkId, const InputTensors &inputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
ImportInputs separates the importing and mapping of InputTensors from network execution.
std::string m_DynamicBackendsPath
Setting this value will override the paths set by the DYNAMIC_BACKEND_PATHS compiler directive Only a...
TensorInfo GetOutputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
Status EnqueueWorkload(const InputTensors &inputTensors, const OutputTensors &outputTensors, std::vector< ImportedInputId > preImportedInputIds={}, std::vector< ImportedOutputId > preImportedOutputIds={})
Single thread execution of the loaded network.
EmptyOptional is used to initialize the Optional class in case we want to have default value for an O...
void RegisterProfiler(IProfiler *profiler)
Status EnqueueWorkload(NetworkId networkId, const InputTensors &inputTensors, const OutputTensors &outputTensors, std::vector< ImportedInputId > preImportedInputIds={}, std::vector< ImportedOutputId > preImportedOutputIds={})
Base class for all ArmNN exceptions so that users can filter to just those.
const std::shared_ptr< IProfiler > & GetProfiler() const
std::vector< ImportedOutputId > ImportOutputs(const OutputTensors &outputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
MemorySource
Define the Memory Source to reduce copies.
void RegisterDebugCallback(const DebugCallbackFunction &func)
constexpr const char * GetMemBlockStrategyTypeName(MemBlockStrategyType memBlockStrategyType)
std::vector< ImportedInputId > ImportInputs(NetworkId networkId, const InputTensors &inputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
RuntimeImpl(const IRuntime::CreationOptions &options)
Creates a runtime for workload execution.
const BackendIdSet & GetDynamicBackends() const
std::unique_ptr< IWorkingMemHandle > CreateWorkingMemHandle(NetworkId networkId)
Create a new unique WorkingMemHandle object.
bool m_TimelineEnabled
Indicates whether external timeline profiling is enabled or not.
void ClearDynamicBackends()
std::vector< ImportedOutputId > ImportOutputs(NetworkId networkId, const OutputTensors &outputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
ImportOutputs separates the importing and mapping of OutputTensors from network execution.
void ClearImportedOutputs(NetworkId networkId, const std::vector< ImportedOutputId > outputIds)
Un-import and delete the imported OutputTensor/s This function is not thread safe and must not be use...
std::unique_ptr< IWorkingMemHandle > CreateWorkingMemHandle(NetworkId networkId)
Create a new unique WorkingMemHandle object.
static BackendIdSet RegisterDynamicBackends(const std::vector< DynamicBackendPtr > &dynamicBackends)
void AddBackendProfilingContext(const BackendId backendId, std::shared_ptr< armnn::profiling::IBackendProfilingContext > profilingContext)
ExternalProfilingOptions m_ProfilingOptions
std::vector< ImportedOutputId > ImportOutputs(NetworkId networkId, const OutputTensors &outputTensors, MemorySource forceImportMemorySource=MemorySource::Undefined)
ProfilingState ConfigureProfilingService(const ExternalProfilingOptions &options, bool resetProfilingService=false)
static std::unique_ptr< LoadedNetwork > MakeLoadedNetwork(std::unique_ptr< IOptimizedNetwork > net, std::string &errorMessage, const INetworkProperties &networkProperties, profiling::ProfilingService &profilingService)
void ClearImportedOutputs(NetworkId networkId, const std::vector< ImportedOutputId > outputIds)
void ClearImportedOutputs(const std::vector< ImportedOutputId > outputIds)
Class for non-fatal exceptions raised while initialising a backend.