+ +

#include <Runtime.hpp>

+

+Inheritance diagram for RuntimeImpl:

+

+ + + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions
Status	LoadNetwork (NetworkId &networkIdOut, IOptimizedNetworkPtr network)
	Loads a complete network into the Runtime. More...

Status	LoadNetwork (NetworkId &networkIdOut, IOptimizedNetworkPtr network, std::string &errorMessage)
	Load a complete network into the IRuntime. More...

Status	LoadNetwork (NetworkId &networkIdOut, IOptimizedNetworkPtr network, std::string &errorMessage, const INetworkProperties &networkProperties)

TensorInfo	GetInputTensorInfo (NetworkId networkId, LayerBindingId layerId) const

TensorInfo	GetOutputTensorInfo (NetworkId networkId, LayerBindingId layerId) const

Status	EnqueueWorkload (NetworkId networkId, const InputTensors &inputTensors, const OutputTensors &outputTensors)

Status	UnloadNetwork (NetworkId networkId)
	Unloads a network from the Runtime. More...

const IDeviceSpec &	GetDeviceSpec () const

const std::shared_ptr< IProfiler >	GetProfiler (NetworkId networkId) const
	Gets the profiler corresponding to the given network id. More...

void	RegisterDebugCallback (NetworkId networkId, const DebugCallbackFunction &func)
	Registers a callback function to debug layers performing custom computations on intermediate tensors. More...

	RuntimeImpl (const IRuntime::CreationOptions &options)
	Creates a runtime for workload execution. More...

	~RuntimeImpl ()

void	ReportStructure ()

Public Member Functions inherited from IReportStructure
virtual	~IReportStructure ()

+ + + + + +

+Friends
void	RuntimeLoadedNetworksReserve (RuntimeImpl *runtime)

profiling::ProfilingService &	GetProfilingService (RuntimeImpl *runtime)

+

Detailed Description

+

Definition at line 30 of file Runtime.hpp.

+

Constructor & Destructor Documentation

+ +

◆ RuntimeImpl()

+ +

+

+ + + + + + + + +

RuntimeImpl ( const IRuntime::CreationOptions & options )

+

+ +

Creates a runtime for workload execution.

+ +

Definition at line 247 of file Runtime.cpp.

+ +

References ProfilingService::AddBackendProfilingContext(), DeviceSpec::AddSupportedBackends(), ARMNN_ASSERT, ARMNN_LOG, ARMNN_VERSION, armnn::BackendRegistryInstance(), ProfilingService::ConfigureProfilingService(), BackendRegistry::GetFactory(), armnn::GetTimeDuration(), armnn::GetTimeNow(), armnn::info, IRuntime::CreationOptions::m_DynamicBackendsPath, IRuntime::CreationOptions::ExternalProfilingOptions::m_EnableProfiling, IRuntime::CreationOptions::m_ProfilingOptions, IRuntime::CreationOptions::ExternalProfilingOptions::m_TimelineEnabled, BackendRegistry::SetProfilingService(), and ProfilingService::WaitForProfilingServiceActivation().

+ +

Referenced by RuntimeImpl::GetDeviceSpec().

+

     : m_NetworkIdCounter(0),
       m_ProfilingService(*this)
 {
     const auto start_time = armnn::GetTimeNow();
     ARMNN_LOG(info) << "ArmNN v" << ARMNN_VERSION << "\n";
 
     if ( options.m_ProfilingOptions.m_TimelineEnabled && !options.m_ProfilingOptions.m_EnableProfiling )
     {
         throw RuntimeException("It is not possible to enable timeline reporting without profiling being enabled");
     }
 
     // Load any available/compatible dynamic backend before the runtime
     // goes through the backend registry
     LoadDynamicBackends(options.m_DynamicBackendsPath);
 
     BackendIdSet supportedBackends;
     for (const auto& id : BackendRegistryInstance().GetBackendIds())
     {
         // Store backend contexts for the supported ones
         try {
             auto factoryFun = BackendRegistryInstance().GetFactory(id);
             auto backend = factoryFun();
             ARMNN_ASSERT(backend.get() != nullptr);
 
             auto context = backend->CreateBackendContext(options);
 
             // backends are allowed to return nullptrs if they
             // don't wish to create a backend specific context
             if (context)
             {
                 m_BackendContexts.emplace(std::make_pair(id, std::move(context)));
             }
             supportedBackends.emplace(id);
 
             unique_ptr<armnn::profiling::IBackendProfiling> profilingIface =
                 std::make_unique<armnn::profiling::BackendProfiling>(armnn::profiling::BackendProfiling(
                     options, m_ProfilingService, id));
 
             // Backends may also provide a profiling context. Ask for it now.
             auto profilingContext = backend->CreateBackendProfilingContext(options, profilingIface);
             // Backends that don't support profiling will return a null profiling context.
             if (profilingContext)
             {
                 // Pass the context onto the profiling service.
                 m_ProfilingService.AddBackendProfilingContext(id, profilingContext);
             }
         }
         catch (const BackendUnavailableException&)
         {
             // Ignore backends which are unavailable
         }
     }
 
     BackendRegistryInstance().SetProfilingService(m_ProfilingService);
     // pass configuration info to the profiling service
     m_ProfilingService.ConfigureProfilingService(options.m_ProfilingOptions);
     if (options.m_ProfilingOptions.m_EnableProfiling)
     {
         // try to wait for the profiling service to initialise
         m_ProfilingService.WaitForProfilingServiceActivation(3000);
     }
 
     m_DeviceSpec.AddSupportedBackends(supportedBackends);
 
     ARMNN_LOG(info) << "Initialization time: " << std::setprecision(2)
                     << std::fixed << armnn::GetTimeDuration(start_time).count() << " ms\n";
 }

+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

+

+ +

◆ ~RuntimeImpl()

+ +

+

+ + + + + + + +

~RuntimeImpl ( )

+

+ +

Definition at line 316 of file Runtime.cpp.

+ +

References ARMNN_LOG, armnn::BackendRegistryInstance(), DeviceSpec::ClearDynamicBackends(), DynamicBackendUtils::DeregisterDynamicBackends(), DeviceSpec::GetDynamicBackends(), armnn::GetTimeDuration(), armnn::GetTimeNow(), armnn::info, BackendRegistry::SetProfilingService(), and RuntimeImpl::UnloadNetwork().

+ +

Referenced by RuntimeImpl::GetDeviceSpec().

+

 {
     const auto start_time = armnn::GetTimeNow();
     std::vector<int> networkIDs;
     try
     {
         // Coverity fix: The following code may throw an exception of type std::length_error.
         std::transform(m_LoadedNetworks.begin(), m_LoadedNetworks.end(),
                        std::back_inserter(networkIDs),
                        [](const auto &pair) { return pair.first; });
     }
     catch (const std::exception& e)
     {
         // Coverity fix: BOOST_LOG_TRIVIAL (typically used to report errors) may throw an
         // exception of type std::length_error.
         // Using stderr instead in this context as there is no point in nesting try-catch blocks here.
         std::cerr << "WARNING: An error has occurred when getting the IDs of the networks to unload: " << e.what()
                   << "\nSome of the loaded networks may not be unloaded" << std::endl;
     }
     // We then proceed to unload all the networks which IDs have been appended to the list
     // up to the point the exception was thrown (if any).
 
     for (auto networkID : networkIDs)
     {
         try
         {
             // Coverity fix: UnloadNetwork() may throw an exception of type std::length_error,
             // boost::log::v2s_mt_posix::odr_violation or boost::log::v2s_mt_posix::system_error
             UnloadNetwork(networkID);
         }
         catch (const std::exception& e)
         {
             // Coverity fix: BOOST_LOG_TRIVIAL (typically used to report errors) may throw an
             // exception of type std::length_error.
             // Using stderr instead in this context as there is no point in nesting try-catch blocks here.
             std::cerr << "WARNING: An error has occurred when unloading network " << networkID << ": " << e.what()
                       << std::endl;
         }
     }
 
     // Clear all dynamic backends.
     DynamicBackendUtils::DeregisterDynamicBackends(m_DeviceSpec.GetDynamicBackends());
     m_DeviceSpec.ClearDynamicBackends();
     m_BackendContexts.clear();
 
     BackendRegistryInstance().SetProfilingService(armnn::EmptyOptional());
     ARMNN_LOG(info) << "Shutdown time: " << std::setprecision(2)
                     << std::fixed << armnn::GetTimeDuration(start_time).count() << " ms\n";
 }

+
+
+
+
+
+
+
+
+
+
+

+

Member Function Documentation

+ +

◆ EnqueueWorkload()

+ +

+

+ + + + + + + + + + + + + + + + + + + + + + + + +

Status EnqueueWorkload	(	NetworkId	networkId,
		const InputTensors &	inputTensors,
		const OutputTensors &	outputTensors
	)

+

+ +

Definition at line 383 of file Runtime.cpp.

+ +

References ARMNN_SCOPED_PROFILING_EVENT, LoadedNetwork::EnqueueWorkload(), LoadedNetwork::FreeWorkingMemory(), ProfilerManager::GetInstance(), LoadedNetwork::GetProfiler(), ProfilerManager::RegisterProfiler(), and armnn::Undefined.

+ +

Referenced by BOOST_AUTO_TEST_CASE(), and VerifyPostOptimisationStructureTestImpl().

+

 {
     LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
     ProfilerManager::GetInstance().RegisterProfiler(loadedNetwork->GetProfiler().get());
 
     ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "EnqueueWorkload");
 
     static thread_local NetworkId lastId = networkId;
     if (lastId != networkId)
     {
         LoadedNetworkFuncSafe(lastId, [](LoadedNetwork* network)
             {
                 network->FreeWorkingMemory();
             });
     }
     lastId=networkId;
 
     return loadedNetwork->EnqueueWorkload(inputTensors, outputTensors);
 }

+
+
+
+
+
+
+
+
+

+

+ +

◆ GetDeviceSpec()

+ +

+

+ + + + + +

+ + + + + + + +

const IDeviceSpec& GetDeviceSpec ( ) const

+

+inline

+

+ +

Definition at line 70 of file Runtime.hpp.

+ +

References RuntimeImpl::GetProfiler(), RuntimeImpl::GetProfilingService, RuntimeImpl::RegisterDebugCallback(), RuntimeImpl::ReportStructure(), RuntimeImpl::RuntimeImpl(), RuntimeImpl::RuntimeLoadedNetworksReserve, and RuntimeImpl::~RuntimeImpl().

+ +

Referenced by BOOST_AUTO_TEST_CASE(), and VerifyPostOptimisationStructureTestImpl().

+

70 { return m_DeviceSpec; }

+

+ +

◆ GetInputTensorInfo()

+ +

+

+ + + + + + + + + + + + + + + + + + +

TensorInfo GetInputTensorInfo	(	NetworkId	networkId,
		LayerBindingId	layerId
	)		const

+

+ +

Definition at line 372 of file Runtime.cpp.

+ +

References LoadedNetwork::GetInputTensorInfo().

+ +

Referenced by BOOST_AUTO_TEST_CASE(), and VerifyPostOptimisationStructureTestImpl().

+

 {
     return GetLoadedNetworkPtr(networkId)->GetInputTensorInfo(layerId);
 }

+

+

+ +

◆ GetOutputTensorInfo()

+ +

+

+ + + + + + + + + + + + + + + + + + +

TensorInfo GetOutputTensorInfo	(	NetworkId	networkId,
		LayerBindingId	layerId
	)		const

+

+ +

Definition at line 377 of file Runtime.cpp.

+ +

References LoadedNetwork::GetOutputTensorInfo().

+ +

Referenced by BOOST_AUTO_TEST_CASE(), and VerifyPostOptimisationStructureTestImpl().

+

 {
     return GetLoadedNetworkPtr(networkId)->GetOutputTensorInfo(layerId);
 }

+

+

+ +

◆ GetProfiler()

+ +

+

+ + + + + + + + +

const std::shared_ptr< IProfiler > GetProfiler ( NetworkId networkId ) const

+

+ +

Gets the profiler corresponding to the given network id.

+

Parameters

+ + +

networkId The id of the network for which to get the profile.

+

Returns: A pointer to the requested profiler, or nullptr if not found.

+ +

Definition at line 220 of file Runtime.cpp.

+ +

Referenced by RuntimeImpl::GetDeviceSpec().

+

 {
     auto it = m_LoadedNetworks.find(networkId);
     if (it != m_LoadedNetworks.end())
     {
         auto& loadedNetwork = it->second;
         return loadedNetwork->GetProfiler();
     }
 
     return nullptr;
 }

+

+ +

◆ LoadNetwork() [1/3]

+ +

+

+ + + + + + + + + + + + + + + + + + +

Status LoadNetwork	(	NetworkId &	networkIdOut,
		IOptimizedNetworkPtr	network
	)

+

+ +

Loads a complete network into the Runtime.

+

Parameters

+ + + +

[out]	networkIdOut	- Unique identifier for the network is returned in this reference.
[in]	network	- Complete network to load into the Runtime. The runtime takes ownership of the network once passed in.

+

Returns: armnn::Status

+ +

Definition at line 109 of file Runtime.cpp.

+ +

References IRuntime::LoadNetwork().

+ +

Referenced by BOOST_AUTO_TEST_CASE(), and VerifyPostOptimisationStructureTestImpl().

+

 {
     std::string ignoredErrorMessage;
     return LoadNetwork(networkIdOut, std::move(inNetwork), ignoredErrorMessage);
 }

+

+

+ +

◆ LoadNetwork() [2/3]

+ +

+

+ + + + + + + + + + + + + + + + + + + + + + + + +

Status LoadNetwork	(	NetworkId &	networkIdOut,
		IOptimizedNetworkPtr	network,
		std::string &	errorMessage
	)

+

+ +

Load a complete network into the IRuntime.

+

Parameters

+ + + + +

[out]	networkIdOut	Unique identifier for the network is returned in this reference.
[in]	network	Complete network to load into the IRuntime.
[out]	errorMessage	Error message if there were any errors. The runtime takes ownership of the network once passed in.

+

Returns: armnn::Status

+ +

Definition at line 115 of file Runtime.cpp.

+ +

References IRuntime::LoadNetwork().

+

 {
     INetworkProperties networkProperties;
     return LoadNetwork(networkIdOut, std::move(inNetwork), errorMessage, networkProperties);
 }

+
+

+

+ +

◆ LoadNetwork() [3/3]

+ +

+

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status LoadNetwork	(	NetworkId &	networkIdOut,
		IOptimizedNetworkPtr	network,
		std::string &	errorMessage,
		const INetworkProperties &	networkProperties
	)

+

+ +

Definition at line 123 of file Runtime.cpp.

+ +

References armnn::Failure, LoadedNetwork::MakeLoadedNetwork(), and armnn::Success.

+

 {
     IOptimizedNetwork* rawNetwork = inNetwork.release();
 
     networkIdOut = GenerateNetworkId();
 
     for (auto&& context : m_BackendContexts)
     {
         context.second->BeforeLoadNetwork(networkIdOut);
     }
 
     unique_ptr<LoadedNetwork> loadedNetwork = LoadedNetwork::MakeLoadedNetwork(
         std::unique_ptr<IOptimizedNetwork>(rawNetwork),
         errorMessage,
         networkProperties,
         m_ProfilingService);
 
     if (!loadedNetwork)
     {
         return Status::Failure;
     }
 
     {
         std::lock_guard<std::mutex> lockGuard(m_Mutex);
 
         // Stores the network
         m_LoadedNetworks[networkIdOut] = std::move(loadedNetwork);
     }
 
     for (auto&& context : m_BackendContexts)
     {
         context.second->AfterLoadNetwork(networkIdOut);
     }
 
     if (m_ProfilingService.IsProfilingEnabled())
     {
         m_ProfilingService.IncrementCounterValue(armnn::profiling::NETWORK_LOADS);
     }
 
     return Status::Success;
 }

+
+
+
+
+
+

+

+ +

◆ RegisterDebugCallback()

+ +

+

+ + + + + + + + + + + + + + + + + + +

void RegisterDebugCallback	(	NetworkId	networkId,
		const DebugCallbackFunction &	func
	)

+

+ +

Registers a callback function to debug layers performing custom computations on intermediate tensors.

+

Parameters

+ + + +

networkId	The id of the network to register the callback.
func	callback function to pass to the debug layer.

+

+ +

Definition at line 405 of file Runtime.cpp.

+ +

References DeviceSpec::AddSupportedBackends(), DynamicBackendUtils::CreateDynamicBackends(), DynamicBackendUtils::GetBackendPaths(), DynamicBackendUtils::GetSharedObjects(), LoadedNetwork::RegisterDebugCallback(), and DynamicBackendUtils::RegisterDynamicBackends().

+ +

Referenced by RuntimeImpl::GetDeviceSpec().

+

 {
     LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
     loadedNetwork->RegisterDebugCallback(func);
 }

+
+

+

+ +

◆ ReportStructure()

+ +

+

+ + + + + +

+ + + + + + + +

void ReportStructure ( )

+

+virtual

+

+ +

Implements IReportStructure.

+ +

Definition at line 232 of file Runtime.cpp.

+ +

Referenced by RuntimeImpl::GetDeviceSpec().

+

 {
     // No-op for the time being, but this may be useful in future to have the profilingService available
     // if (profilingService.IsProfilingEnabled()){}
 
     LoadedNetworks::iterator it = m_LoadedNetworks.begin();
     while (it != m_LoadedNetworks.end())
     {
         auto& loadedNetwork = it->second;
         loadedNetwork->SendNetworkStructure();
         // Increment the Iterator to point to next entry
         it++;
     }
 }

+

+ +

◆ UnloadNetwork()

+ +

+

+ + + + + + + + +

Status UnloadNetwork ( NetworkId networkId )

+

+ +

Unloads a network from the Runtime.

+

At the moment this only removes the network from the m_Impl->m_Network. This might need more work in the future to be AndroidNN compliant.

Parameters

+ + +

[in] networkId Unique identifier for the network to be unloaded. Generated in LoadNetwork().

+

Returns: armnn::Status

+ +

Definition at line 168 of file Runtime.cpp.

+ +

References ARMNN_LOG, LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS, armnn::debug, armnn::Failure, TimelineUtilityMethods::GetTimelineUtils(), armnn::Success, and armnn::warning.

+ +

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

+

 {
     bool unloadOk = true;
     for (auto&& context : m_BackendContexts)
     {
         unloadOk &= context.second->BeforeUnloadNetwork(networkId);
     }
 
     if (!unloadOk)
     {
         ARMNN_LOG(warning) << "RuntimeImpl::UnloadNetwork(): failed to unload "
                               "network with ID:" << networkId << " because BeforeUnloadNetwork failed";
         return Status::Failure;
     }
 
     std::unique_ptr<profiling::TimelineUtilityMethods> timelineUtils =
             profiling::TimelineUtilityMethods::GetTimelineUtils(m_ProfilingService);
     {
         std::lock_guard<std::mutex> lockGuard(m_Mutex);
 
         // If timeline recording is on mark the Network end of life
         if (timelineUtils)
         {
             auto search = m_LoadedNetworks.find(networkId);
             if (search != m_LoadedNetworks.end())
             {
                 profiling::ProfilingGuid networkGuid = search->second->GetNetworkGuid();
                 timelineUtils->RecordEvent(networkGuid,
                                            profiling::LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS);
             }
         }
         if (m_LoadedNetworks.erase(networkId) == 0)
         {
             ARMNN_LOG(warning) << "WARNING: RuntimeImpl::UnloadNetwork(): " << networkId << " not found!";
             return Status::Failure;
         }
 
         if (m_ProfilingService.IsProfilingEnabled())
         {
             m_ProfilingService.IncrementCounterValue(armnn::profiling::NETWORK_UNLOADS);
         }
     }
 
     for (auto&& context : m_BackendContexts)
     {
         context.second->AfterUnloadNetwork(networkId);
     }
 
     ARMNN_LOG(debug) << "RuntimeImpl::UnloadNetwork(): Unloaded network with ID: " << networkId;
     return Status::Success;
 }

+
+
+
+
+
+
+
+
+
+

+

Friends And Related Function Documentation

+ +

◆ GetProfilingService

+ +

+

+ + + + + +

+ + + + + + + + +

profiling::ProfilingService& GetProfilingService ( RuntimeImpl * runtime )

+

+friend

+

+ +

Definition at line 35 of file TestUtils.cpp.

+ +

Referenced by RuntimeImpl::GetDeviceSpec().

+

 {
     return runtime->m_ProfilingService;
 }

+

+ +

◆ RuntimeLoadedNetworksReserve

+ +

+

+ + + + + +

+ + + + + + + + +

void RuntimeLoadedNetworksReserve ( RuntimeImpl * runtime )

+

+friend

+

+ +

Definition at line 30 of file RuntimeTests.cpp.

+ +

Referenced by RuntimeImpl::GetDeviceSpec().

+

 {
     runtime->m_LoadedNetworks.reserve(1);
 }

+

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

src/armnn/Runtime.hpp
src/armnn/Runtime.cpp

+

+Public Member Functions

+Friends

Detailed Description

Constructor & Destructor Documentation

◆ RuntimeImpl()

◆ ~RuntimeImpl()

Member Function Documentation

◆ EnqueueWorkload()

◆ GetDeviceSpec()

◆ GetInputTensorInfo()

◆ GetOutputTensorInfo()

◆ GetProfiler()

◆ LoadNetwork() [1/3]

◆ LoadNetwork() [2/3]

◆ LoadNetwork() [3/3]

◆ RegisterDebugCallback()

◆ ReportStructure()

◆ UnloadNetwork()

Friends And Related Function Documentation

◆ GetProfilingService

◆ RuntimeLoadedNetworksReserve