blob: a54b71225d761cb33ba4d9ce5c60586f3926ee26 [file] [log] [blame]
Laurent Carlier749294b2020-06-01 09:03:17 +01001//
Jim Flynn6398a982020-05-27 17:05:21 +01002// Copyright © 2017 Arm Ltd and Contributors. All rights reserved.
David Beckecb56cd2018-09-05 12:52:57 +01003// SPDX-License-Identifier: MIT
telsoa014fcda012018-03-09 14:13:49 +00004//
5#include "Runtime.hpp"
6
David Beck056be3c2018-10-22 13:16:00 +01007#include <armnn/Version.hpp>
Matteo Martincighc601aa62019-10-29 15:03:22 +00008#include <armnn/BackendRegistry.hpp>
Jan Eilers15fcc7e2021-07-14 13:50:15 +01009#include <armnn/BackendHelper.hpp>
Matthew Benthamf48afc62020-01-15 17:55:08 +000010#include <armnn/Logging.hpp>
alered01a7227ac2020-05-07 14:58:29 +010011#include <armnn/utility/Timer.hpp>
Matteo Martincighe54aa062019-08-05 14:12:11 +010012
Matteo Martincighe5b8eb92019-11-28 15:45:42 +000013#include <armnn/backends/IBackendContext.hpp>
Matteo Martincighe54aa062019-08-05 14:12:11 +010014#include <backendsCommon/DynamicBackendUtils.hpp>
Sadik Armaganb8a26d82021-10-04 15:13:11 +010015#include <backendsCommon/MemoryOptimizerStrategyLibrary.hpp>
Jan Eilersbb446e52020-04-02 13:56:54 +010016#include <armnn/utility/PolymorphicDowncast.hpp>
telsoa014fcda012018-03-09 14:13:49 +000017
Nikhil Raj77fe76b2021-06-09 14:55:32 +010018#include <common/include/LabelsAndEventClasses.hpp>
19
surmeh013537c2c2018-05-18 16:31:43 +010020#include <iostream>
21
Colm Donelan1aff3932020-02-05 17:48:59 +000022#include <backends/BackendProfiling.hpp>
telsoa014fcda012018-03-09 14:13:49 +000023
24using namespace armnn;
25using namespace std;
26
27namespace armnn
28{
Kevin Mayd92a6e42021-02-04 10:27:41 +000029IRuntime::IRuntime() : pRuntimeImpl( new RuntimeImpl(armnn::IRuntime::CreationOptions())) {}
30
31IRuntime::IRuntime(const IRuntime::CreationOptions& options) : pRuntimeImpl(new RuntimeImpl(options)) {}
32
33IRuntime::~IRuntime() = default;
telsoa014fcda012018-03-09 14:13:49 +000034
35IRuntime* IRuntime::CreateRaw(const CreationOptions& options)
36{
Kevin Mayd92a6e42021-02-04 10:27:41 +000037 return new IRuntime(options);
telsoa014fcda012018-03-09 14:13:49 +000038}
39
40IRuntimePtr IRuntime::Create(const CreationOptions& options)
41{
42 return IRuntimePtr(CreateRaw(options), &IRuntime::Destroy);
43}
44
45void IRuntime::Destroy(IRuntime* runtime)
46{
Kevin Mayd92a6e42021-02-04 10:27:41 +000047 delete runtime;
telsoa014fcda012018-03-09 14:13:49 +000048}
49
Kevin Mayd92a6e42021-02-04 10:27:41 +000050Status IRuntime::LoadNetwork(NetworkId& networkIdOut, IOptimizedNetworkPtr network)
51{
52 return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network));
53}
54
55Status IRuntime::LoadNetwork(NetworkId& networkIdOut,
56 IOptimizedNetworkPtr network,
57 std::string& errorMessage)
58{
59 return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network), errorMessage);
60}
61
62Status IRuntime::LoadNetwork(NetworkId& networkIdOut,
63 IOptimizedNetworkPtr network,
64 std::string& errorMessage,
65 const INetworkProperties& networkProperties)
66{
67 return pRuntimeImpl->LoadNetwork(networkIdOut, std::move(network), errorMessage, networkProperties);
68}
69
70TensorInfo IRuntime::GetInputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
71{
72 return pRuntimeImpl->GetInputTensorInfo(networkId, layerId);
73}
74
75TensorInfo IRuntime::GetOutputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
76{
77 return pRuntimeImpl->GetOutputTensorInfo(networkId, layerId);
78}
79
Finn Williamsf37b9702021-09-01 18:06:04 +010080std::vector<ImportedInputId> IRuntime::ImportInputs(NetworkId networkId, const InputTensors& inputTensors)
81{
82 return pRuntimeImpl->ImportInputs(networkId, inputTensors);
83}
84
Finn Williams8636bc72021-10-02 15:06:39 +010085std::vector<ImportedOutputId> IRuntime::ImportOutputs(NetworkId networkId, const OutputTensors& outputTensors)
86{
87 return pRuntimeImpl->ImportOutputs(networkId, outputTensors);
88}
89
90void IRuntime::ClearImportedInputs(NetworkId networkId, const std::vector<ImportedInputId> inputIds)
91{
92 return pRuntimeImpl->ClearImportedInputs(networkId, inputIds);
93}
94void IRuntime::ClearImportedOutputs(NetworkId networkId, const std::vector<ImportedOutputId> outputIds)
95{
96 return pRuntimeImpl->ClearImportedOutputs(networkId, outputIds);
97}
Finn Williamsf37b9702021-09-01 18:06:04 +010098
Kevin Mayd92a6e42021-02-04 10:27:41 +000099Status IRuntime::EnqueueWorkload(NetworkId networkId,
100 const InputTensors& inputTensors,
101 const OutputTensors& outputTensors)
102{
103 return pRuntimeImpl->EnqueueWorkload(networkId, inputTensors, outputTensors);
104}
105
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100106Status IRuntime::Execute(IWorkingMemHandle& workingMemHandle,
107 const InputTensors& inputTensors,
Finn Williamsf37b9702021-09-01 18:06:04 +0100108 const OutputTensors& outputTensors,
Finn Williams8636bc72021-10-02 15:06:39 +0100109 std::vector<ImportedInputId> preImportedInputs,
110 std::vector<ImportedOutputId> preImportedOutputs)
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100111{
Finn Williams8636bc72021-10-02 15:06:39 +0100112 return pRuntimeImpl->Execute(workingMemHandle, inputTensors, outputTensors, preImportedInputs, preImportedOutputs);
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100113}
114
Kevin Mayd92a6e42021-02-04 10:27:41 +0000115Status IRuntime::UnloadNetwork(NetworkId networkId)
116{
117 return pRuntimeImpl->UnloadNetwork(networkId);
118}
119
120const IDeviceSpec& IRuntime::GetDeviceSpec() const
121{
122 return pRuntimeImpl->GetDeviceSpec();
123}
124
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100125std::unique_ptr<IWorkingMemHandle> IRuntime::CreateWorkingMemHandle(NetworkId networkId)
126{
127 return pRuntimeImpl->CreateWorkingMemHandle(networkId);
128}
129
Kevin Mayd92a6e42021-02-04 10:27:41 +0000130const std::shared_ptr<IProfiler> IRuntime::GetProfiler(NetworkId networkId) const
131{
132 return pRuntimeImpl->GetProfiler(networkId);
133}
134
135void IRuntime::RegisterDebugCallback(NetworkId networkId, const DebugCallbackFunction& func)
136{
137 return pRuntimeImpl->RegisterDebugCallback(networkId, func);
138}
139
140int RuntimeImpl::GenerateNetworkId()
telsoa014fcda012018-03-09 14:13:49 +0000141{
142 return m_NetworkIdCounter++;
143}
144
Kevin Mayd92a6e42021-02-04 10:27:41 +0000145Status RuntimeImpl::LoadNetwork(NetworkId& networkIdOut, IOptimizedNetworkPtr inNetwork)
telsoa014fcda012018-03-09 14:13:49 +0000146{
telsoa01c577f2c2018-08-31 09:22:23 +0100147 std::string ignoredErrorMessage;
148 return LoadNetwork(networkIdOut, std::move(inNetwork), ignoredErrorMessage);
149}
150
Kevin Mayd92a6e42021-02-04 10:27:41 +0000151Status RuntimeImpl::LoadNetwork(NetworkId& networkIdOut,
152 IOptimizedNetworkPtr inNetwork,
153 std::string& errorMessage)
David Monahan4f1e8e42019-09-04 09:22:10 +0100154{
Jan Eilersc1c872f2021-07-22 13:17:04 +0100155 INetworkProperties networkProperties(
156 false, MemorySource::Undefined, MemorySource::Undefined);
David Monahan4f1e8e42019-09-04 09:22:10 +0100157 return LoadNetwork(networkIdOut, std::move(inNetwork), errorMessage, networkProperties);
158}
159
Kevin Mayd92a6e42021-02-04 10:27:41 +0000160Status RuntimeImpl::LoadNetwork(NetworkId& networkIdOut,
161 IOptimizedNetworkPtr inNetwork,
162 std::string& errorMessage,
163 const INetworkProperties& networkProperties)
telsoa01c577f2c2018-08-31 09:22:23 +0100164{
telsoa014fcda012018-03-09 14:13:49 +0000165 IOptimizedNetwork* rawNetwork = inNetwork.release();
David Beck1b61be52018-11-08 09:19:14 +0000166
167 networkIdOut = GenerateNetworkId();
168
169 for (auto&& context : m_BackendContexts)
170 {
171 context.second->BeforeLoadNetwork(networkIdOut);
172 }
173
telsoa014fcda012018-03-09 14:13:49 +0000174 unique_ptr<LoadedNetwork> loadedNetwork = LoadedNetwork::MakeLoadedNetwork(
Francis Murtagh3d2b4b22021-02-15 18:23:17 +0000175 std::unique_ptr<IOptimizedNetwork>(rawNetwork),
David Monahan4f1e8e42019-09-04 09:22:10 +0100176 errorMessage,
Sadik Armagan3184c902020-03-18 10:57:30 +0000177 networkProperties,
Finn Williamsf364d532021-06-09 17:07:33 +0100178 m_ProfilingService);
telsoa014fcda012018-03-09 14:13:49 +0000179
180 if (!loadedNetwork)
181 {
182 return Status::Failure;
183 }
184
telsoa01c577f2c2018-08-31 09:22:23 +0100185 {
186 std::lock_guard<std::mutex> lockGuard(m_Mutex);
187
188 // Stores the network
189 m_LoadedNetworks[networkIdOut] = std::move(loadedNetwork);
190 }
telsoa014fcda012018-03-09 14:13:49 +0000191
David Beck1b61be52018-11-08 09:19:14 +0000192 for (auto&& context : m_BackendContexts)
193 {
194 context.second->AfterLoadNetwork(networkIdOut);
195 }
196
Sadik Armagan3184c902020-03-18 10:57:30 +0000197 if (m_ProfilingService.IsProfilingEnabled())
Keith Davise394bd92019-12-02 15:12:19 +0000198 {
Sadik Armagan3184c902020-03-18 10:57:30 +0000199 m_ProfilingService.IncrementCounterValue(armnn::profiling::NETWORK_LOADS);
Keith Davise394bd92019-12-02 15:12:19 +0000200 }
201
telsoa014fcda012018-03-09 14:13:49 +0000202 return Status::Success;
telsoa014fcda012018-03-09 14:13:49 +0000203}
204
Kevin Mayd92a6e42021-02-04 10:27:41 +0000205Status RuntimeImpl::UnloadNetwork(NetworkId networkId)
telsoa014fcda012018-03-09 14:13:49 +0000206{
David Beck1b61be52018-11-08 09:19:14 +0000207 bool unloadOk = true;
208 for (auto&& context : m_BackendContexts)
David Beck9efb57d2018-11-05 13:40:33 +0000209 {
David Beck1b61be52018-11-08 09:19:14 +0000210 unloadOk &= context.second->BeforeUnloadNetwork(networkId);
David Beck9efb57d2018-11-05 13:40:33 +0000211 }
David Beck1b61be52018-11-08 09:19:14 +0000212
213 if (!unloadOk)
214 {
Kevin Mayd92a6e42021-02-04 10:27:41 +0000215 ARMNN_LOG(warning) << "RuntimeImpl::UnloadNetwork(): failed to unload "
Derek Lamberti08446972019-11-26 16:38:31 +0000216 "network with ID:" << networkId << " because BeforeUnloadNetwork failed";
David Beck1b61be52018-11-08 09:19:14 +0000217 return Status::Failure;
218 }
David Beck9efb57d2018-11-05 13:40:33 +0000219
Jim Flynnf7713212020-07-14 09:50:59 +0100220 std::unique_ptr<profiling::TimelineUtilityMethods> timelineUtils =
221 profiling::TimelineUtilityMethods::GetTimelineUtils(m_ProfilingService);
telsoa014fcda012018-03-09 14:13:49 +0000222 {
telsoa01c577f2c2018-08-31 09:22:23 +0100223 std::lock_guard<std::mutex> lockGuard(m_Mutex);
224
Jim Flynnf7713212020-07-14 09:50:59 +0100225 // If timeline recording is on mark the Network end of life
226 if (timelineUtils)
227 {
228 auto search = m_LoadedNetworks.find(networkId);
229 if (search != m_LoadedNetworks.end())
230 {
231 profiling::ProfilingGuid networkGuid = search->second->GetNetworkGuid();
232 timelineUtils->RecordEvent(networkGuid,
233 profiling::LabelsAndEventClasses::ARMNN_PROFILING_EOL_EVENT_CLASS);
234 }
235 }
telsoa01c577f2c2018-08-31 09:22:23 +0100236 if (m_LoadedNetworks.erase(networkId) == 0)
237 {
Kevin Mayd92a6e42021-02-04 10:27:41 +0000238 ARMNN_LOG(warning) << "WARNING: RuntimeImpl::UnloadNetwork(): " << networkId << " not found!";
telsoa01c577f2c2018-08-31 09:22:23 +0100239 return Status::Failure;
240 }
Sadik Armagan3184c902020-03-18 10:57:30 +0000241
242 if (m_ProfilingService.IsProfilingEnabled())
Keith Davise394bd92019-12-02 15:12:19 +0000243 {
Sadik Armagan3184c902020-03-18 10:57:30 +0000244 m_ProfilingService.IncrementCounterValue(armnn::profiling::NETWORK_UNLOADS);
Keith Davise394bd92019-12-02 15:12:19 +0000245 }
David Beck1b61be52018-11-08 09:19:14 +0000246 }
David Beck9efb57d2018-11-05 13:40:33 +0000247
David Beck1b61be52018-11-08 09:19:14 +0000248 for (auto&& context : m_BackendContexts)
249 {
250 context.second->AfterUnloadNetwork(networkId);
telsoa01c577f2c2018-08-31 09:22:23 +0100251 }
252
Kevin Mayd92a6e42021-02-04 10:27:41 +0000253 ARMNN_LOG(debug) << "RuntimeImpl::UnloadNetwork(): Unloaded network with ID: " << networkId;
telsoa014fcda012018-03-09 14:13:49 +0000254 return Status::Success;
255}
256
Kevin Mayd92a6e42021-02-04 10:27:41 +0000257const std::shared_ptr<IProfiler> RuntimeImpl::GetProfiler(NetworkId networkId) const
telsoa01c577f2c2018-08-31 09:22:23 +0100258{
259 auto it = m_LoadedNetworks.find(networkId);
260 if (it != m_LoadedNetworks.end())
261 {
262 auto& loadedNetwork = it->second;
263 return loadedNetwork->GetProfiler();
264 }
265
266 return nullptr;
267}
268
Kevin Mayd92a6e42021-02-04 10:27:41 +0000269void RuntimeImpl::ReportStructure() // armnn::profiling::IProfilingService& profilingService as param
Keith Davis33ed2212020-03-30 10:43:41 +0100270{
271 // No-op for the time being, but this may be useful in future to have the profilingService available
272 // if (profilingService.IsProfilingEnabled()){}
273
274 LoadedNetworks::iterator it = m_LoadedNetworks.begin();
275 while (it != m_LoadedNetworks.end())
276 {
277 auto& loadedNetwork = it->second;
278 loadedNetwork->SendNetworkStructure();
279 // Increment the Iterator to point to next entry
280 it++;
281 }
282}
283
Kevin Mayd92a6e42021-02-04 10:27:41 +0000284RuntimeImpl::RuntimeImpl(const IRuntime::CreationOptions& options)
Keith Davis33ed2212020-03-30 10:43:41 +0100285 : m_NetworkIdCounter(0),
286 m_ProfilingService(*this)
telsoa014fcda012018-03-09 14:13:49 +0000287{
alered01a7227ac2020-05-07 14:58:29 +0100288 const auto start_time = armnn::GetTimeNow();
Derek Lamberti08446972019-11-26 16:38:31 +0000289 ARMNN_LOG(info) << "ArmNN v" << ARMNN_VERSION << "\n";
Keith Davis33ed2212020-03-30 10:43:41 +0100290 if ( options.m_ProfilingOptions.m_TimelineEnabled && !options.m_ProfilingOptions.m_EnableProfiling )
291 {
Jan Eilersc1c872f2021-07-22 13:17:04 +0100292 throw RuntimeException(
293 "It is not possible to enable timeline reporting without profiling being enabled");
Keith Davis33ed2212020-03-30 10:43:41 +0100294 }
295
Matteo Martincighe54aa062019-08-05 14:12:11 +0100296 // Load any available/compatible dynamic backend before the runtime
297 // goes through the backend registry
298 LoadDynamicBackends(options.m_DynamicBackendsPath);
299
Matthew Bentham9a61fa62020-02-04 10:03:55 +0000300 BackendIdSet supportedBackends;
David Beck1b61be52018-11-08 09:19:14 +0000301 for (const auto& id : BackendRegistryInstance().GetBackendIds())
302 {
303 // Store backend contexts for the supported ones
Matthew Bentham9a61fa62020-02-04 10:03:55 +0000304 try {
David Beck1b61be52018-11-08 09:19:14 +0000305 auto factoryFun = BackendRegistryInstance().GetFactory(id);
Colm Donelan380c1a02021-08-17 00:52:23 +0100306 ARMNN_ASSERT(factoryFun != nullptr);
David Beck1b61be52018-11-08 09:19:14 +0000307 auto backend = factoryFun();
Colm Donelan380c1a02021-08-17 00:52:23 +0100308 ARMNN_ASSERT(backend != nullptr);
Narumol Prangnawaratac2770a2020-04-01 16:51:23 +0100309 ARMNN_ASSERT(backend.get() != nullptr);
David Beck1b61be52018-11-08 09:19:14 +0000310
Jan Eilersc1c872f2021-07-22 13:17:04 +0100311 auto customAllocatorMapIterator = options.m_CustomAllocatorMap.find(id);
Francis Murtagh62573b62021-08-12 11:55:21 +0100312 if (customAllocatorMapIterator != options.m_CustomAllocatorMap.end() &&
313 customAllocatorMapIterator->second == nullptr)
314 {
Colm Donelan380c1a02021-08-17 00:52:23 +0100315 // We need to manually clean up the dynamic backends before throwing an exception.
316 DynamicBackendUtils::DeregisterDynamicBackends(m_DeviceSpec.GetDynamicBackends());
317 m_DeviceSpec.ClearDynamicBackends();
Francis Murtagh62573b62021-08-12 11:55:21 +0100318 throw armnn::Exception("Allocator associated with id " + id.Get() + " is null");
319 }
Jan Eilersc1c872f2021-07-22 13:17:04 +0100320
Jan Eilers15fcc7e2021-07-14 13:50:15 +0100321 // If the runtime is created in protected mode only add backends that support this mode
322 if (options.m_ProtectedMode)
323 {
324 // check if backend supports ProtectedMode
325 using BackendCapability = BackendOptions::BackendOption;
326 BackendCapability protectedContentCapability {"ProtectedContentAllocation", true};
327 if (!HasCapability(protectedContentCapability, id))
328 {
329 // Protected Content Allocation is not supported by the backend
330 // backend should not be registered
331 ARMNN_LOG(warning) << "Backend "
332 << id
333 << " is not registered as does not support protected content allocation \n";
334 continue;
335 }
Jan Eilersc1c872f2021-07-22 13:17:04 +0100336 // The user is responsible to provide a custom memory allocator which allows to allocate
337 // protected memory
338 if (customAllocatorMapIterator != options.m_CustomAllocatorMap.end())
Jan Eilers15fcc7e2021-07-14 13:50:15 +0100339 {
Jan Eilersc1c872f2021-07-22 13:17:04 +0100340 std::string err;
341 if (customAllocatorMapIterator->second->GetMemorySourceType()
342 == armnn::MemorySource::DmaBufProtected)
343 {
344 if (!backend->UseCustomMemoryAllocator(customAllocatorMapIterator->second, err))
345 {
346 ARMNN_LOG(error) << "The backend "
347 << id
348 << " reported an error when entering protected mode. Backend won't be"
349 << " used. ErrorMsg: " << err;
350 continue;
351 }
352 // No errors so register the Custom Allocator with the BackendRegistry
353 BackendRegistryInstance().RegisterAllocator(id, customAllocatorMapIterator->second);
354 }
355 else
356 {
357 ARMNN_LOG(error) << "The CustomAllocator provided with the runtime options doesn't support "
358 "protected memory. Protected mode can't be activated. The backend "
Jan Eilers15fcc7e2021-07-14 13:50:15 +0100359 << id
Jan Eilersc1c872f2021-07-22 13:17:04 +0100360 << " is not going to be used. MemorySource must be MemorySource::DmaBufProtected";
361 continue;
362 }
363 }
364 else
365 {
366 ARMNN_LOG(error) << "Protected mode can't be activated for backend: "
367 << id
368 << " no custom allocator was provided to the runtime options.";
Jan Eilers15fcc7e2021-07-14 13:50:15 +0100369 continue;
370 }
371 }
Jan Eilersc1c872f2021-07-22 13:17:04 +0100372 else
373 {
374 // If a custom memory allocator is provided make the backend use that instead of the default
375 if (customAllocatorMapIterator != options.m_CustomAllocatorMap.end())
376 {
377 std::string err;
378 if (!backend->UseCustomMemoryAllocator(customAllocatorMapIterator->second, err))
379 {
380 ARMNN_LOG(error) << "The backend "
381 << id
382 << " reported an error when trying to use the provided custom allocator."
383 " Backend won't be used."
384 << " ErrorMsg: " << err;
385 continue;
386 }
387 // No errors so register the Custom Allocator with the BackendRegistry
388 BackendRegistryInstance().RegisterAllocator(id, customAllocatorMapIterator->second);
389 }
390 }
Sadik Armaganb8a26d82021-10-04 15:13:11 +0100391
392 // check if custom memory optimizer strategy map is set
393 if (!options.m_MemoryOptimizerStrategyMap.empty())
394 {
395 auto customMemoryOptimizerStrategyMapIterator = options.m_MemoryOptimizerStrategyMap.find(id);
396 // if a memory optimizer strategy is provided make the backend use that instead of the default
397 if (customMemoryOptimizerStrategyMapIterator != options.m_MemoryOptimizerStrategyMap.end())
398 {
399 // no errors.. register the memory optimizer strategy with the BackendRegistry
400 BackendRegistryInstance().RegisterMemoryOptimizerStrategy(
401 id, customMemoryOptimizerStrategyMapIterator->second);
402
403 ARMNN_LOG(info) << "MemoryOptimizerStrategy "
404 << customMemoryOptimizerStrategyMapIterator->second->GetName()
405 << " set for the backend " << id << ".";
406 }
407 }
408 else
409 {
410 // check if to use one of the existing memory optimizer strategies is set
411 std::string memoryOptimizerStrategyName = "";
412 ParseOptions(options.m_BackendOptions, id, [&](std::string name, const BackendOptions::Var& value)
413 {
414 if (name == "MemoryOptimizerStrategy")
415 {
416 memoryOptimizerStrategyName = ParseStringBackendOption(value, "");
417 }
418 });
419 if (memoryOptimizerStrategyName != "")
420 {
421 MemoryOptimizerStrategyLibrary memoryOptimizerStrategyLibrary;
422 if (memoryOptimizerStrategyLibrary.SetMemoryOptimizerStrategy(id, memoryOptimizerStrategyName))
423 {
424 ARMNN_LOG(info) << "MemoryOptimizerStrategy "
425 << memoryOptimizerStrategyName << " set for the backend " << id << ".";
426 }
427 }
428 }
429
David Beck1b61be52018-11-08 09:19:14 +0000430 auto context = backend->CreateBackendContext(options);
431
432 // backends are allowed to return nullptrs if they
433 // don't wish to create a backend specific context
434 if (context)
435 {
436 m_BackendContexts.emplace(std::make_pair(id, std::move(context)));
437 }
Matthew Bentham9a61fa62020-02-04 10:03:55 +0000438 supportedBackends.emplace(id);
Colm Donelan1aff3932020-02-05 17:48:59 +0000439
440 unique_ptr<armnn::profiling::IBackendProfiling> profilingIface =
441 std::make_unique<armnn::profiling::BackendProfiling>(armnn::profiling::BackendProfiling(
Sadik Armagan3184c902020-03-18 10:57:30 +0000442 options, m_ProfilingService, id));
Colm Donelan1aff3932020-02-05 17:48:59 +0000443
444 // Backends may also provide a profiling context. Ask for it now.
445 auto profilingContext = backend->CreateBackendProfilingContext(options, profilingIface);
446 // Backends that don't support profiling will return a null profiling context.
447 if (profilingContext)
448 {
Finn Williamsfe5a24b2020-04-09 16:05:28 +0100449 // Pass the context onto the profiling service.
450 m_ProfilingService.AddBackendProfilingContext(id, profilingContext);
Colm Donelan1aff3932020-02-05 17:48:59 +0000451 }
David Beck1b61be52018-11-08 09:19:14 +0000452 }
Matthew Bentham9a61fa62020-02-04 10:03:55 +0000453 catch (const BackendUnavailableException&)
454 {
455 // Ignore backends which are unavailable
456 }
David Beck1b61be52018-11-08 09:19:14 +0000457 }
Finn Williamsfe5a24b2020-04-09 16:05:28 +0100458
Finn Williams45a73622020-05-15 18:41:05 +0100459 BackendRegistryInstance().SetProfilingService(m_ProfilingService);
Finn Williamsfe5a24b2020-04-09 16:05:28 +0100460 // pass configuration info to the profiling service
461 m_ProfilingService.ConfigureProfilingService(options.m_ProfilingOptions);
Jim Flynn6398a982020-05-27 17:05:21 +0100462 if (options.m_ProfilingOptions.m_EnableProfiling)
463 {
464 // try to wait for the profiling service to initialise
465 m_ProfilingService.WaitForProfilingServiceActivation(3000);
466 }
Finn Williamsfe5a24b2020-04-09 16:05:28 +0100467
Matthew Bentham9a61fa62020-02-04 10:03:55 +0000468 m_DeviceSpec.AddSupportedBackends(supportedBackends);
alered01a7227ac2020-05-07 14:58:29 +0100469
470 ARMNN_LOG(info) << "Initialization time: " << std::setprecision(2)
471 << std::fixed << armnn::GetTimeDuration(start_time).count() << " ms\n";
surmeh01bceff2f2018-03-29 16:29:27 +0100472}
473
Kevin Mayd92a6e42021-02-04 10:27:41 +0000474RuntimeImpl::~RuntimeImpl()
surmeh01bceff2f2018-03-29 16:29:27 +0100475{
alered01a7227ac2020-05-07 14:58:29 +0100476 const auto start_time = armnn::GetTimeNow();
surmeh01bceff2f2018-03-29 16:29:27 +0100477 std::vector<int> networkIDs;
surmeh013537c2c2018-05-18 16:31:43 +0100478 try
479 {
480 // Coverity fix: The following code may throw an exception of type std::length_error.
481 std::transform(m_LoadedNetworks.begin(), m_LoadedNetworks.end(),
482 std::back_inserter(networkIDs),
483 [](const auto &pair) { return pair.first; });
484 }
485 catch (const std::exception& e)
486 {
487 // Coverity fix: BOOST_LOG_TRIVIAL (typically used to report errors) may throw an
488 // exception of type std::length_error.
489 // Using stderr instead in this context as there is no point in nesting try-catch blocks here.
490 std::cerr << "WARNING: An error has occurred when getting the IDs of the networks to unload: " << e.what()
491 << "\nSome of the loaded networks may not be unloaded" << std::endl;
492 }
493 // We then proceed to unload all the networks which IDs have been appended to the list
494 // up to the point the exception was thrown (if any).
surmeh01bceff2f2018-03-29 16:29:27 +0100495
496 for (auto networkID : networkIDs)
497 {
surmeh013537c2c2018-05-18 16:31:43 +0100498 try
499 {
500 // Coverity fix: UnloadNetwork() may throw an exception of type std::length_error,
501 // boost::log::v2s_mt_posix::odr_violation or boost::log::v2s_mt_posix::system_error
502 UnloadNetwork(networkID);
503 }
504 catch (const std::exception& e)
505 {
506 // Coverity fix: BOOST_LOG_TRIVIAL (typically used to report errors) may throw an
507 // exception of type std::length_error.
508 // Using stderr instead in this context as there is no point in nesting try-catch blocks here.
509 std::cerr << "WARNING: An error has occurred when unloading network " << networkID << ": " << e.what()
510 << std::endl;
511 }
telsoa014fcda012018-03-09 14:13:49 +0000512 }
Narumol Prangnawarat60a20fb2019-12-09 17:24:41 +0000513
514 // Clear all dynamic backends.
515 DynamicBackendUtils::DeregisterDynamicBackends(m_DeviceSpec.GetDynamicBackends());
516 m_DeviceSpec.ClearDynamicBackends();
Colm Donelan1aff3932020-02-05 17:48:59 +0000517 m_BackendContexts.clear();
Finn Williams45a73622020-05-15 18:41:05 +0100518
519 BackendRegistryInstance().SetProfilingService(armnn::EmptyOptional());
alered01a7227ac2020-05-07 14:58:29 +0100520 ARMNN_LOG(info) << "Shutdown time: " << std::setprecision(2)
521 << std::fixed << armnn::GetTimeDuration(start_time).count() << " ms\n";
telsoa014fcda012018-03-09 14:13:49 +0000522}
523
Kevin Mayd92a6e42021-02-04 10:27:41 +0000524LoadedNetwork* RuntimeImpl::GetLoadedNetworkPtr(NetworkId networkId) const
surmeh013537c2c2018-05-18 16:31:43 +0100525{
526 std::lock_guard<std::mutex> lockGuard(m_Mutex);
527 return m_LoadedNetworks.at(networkId).get();
528}
529
Kevin Mayd92a6e42021-02-04 10:27:41 +0000530TensorInfo RuntimeImpl::GetInputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
telsoa014fcda012018-03-09 14:13:49 +0000531{
surmeh013537c2c2018-05-18 16:31:43 +0100532 return GetLoadedNetworkPtr(networkId)->GetInputTensorInfo(layerId);
telsoa014fcda012018-03-09 14:13:49 +0000533}
534
Kevin Mayd92a6e42021-02-04 10:27:41 +0000535TensorInfo RuntimeImpl::GetOutputTensorInfo(NetworkId networkId, LayerBindingId layerId) const
telsoa014fcda012018-03-09 14:13:49 +0000536{
surmeh013537c2c2018-05-18 16:31:43 +0100537 return GetLoadedNetworkPtr(networkId)->GetOutputTensorInfo(layerId);
telsoa014fcda012018-03-09 14:13:49 +0000538}
539
Finn Williamsf37b9702021-09-01 18:06:04 +0100540std::vector<ImportedInputId> RuntimeImpl::ImportInputs(NetworkId networkId, const InputTensors& inputTensors)
541{
542 return GetLoadedNetworkPtr(networkId)->ImportInputs(inputTensors);
543}
544
Finn Williams8636bc72021-10-02 15:06:39 +0100545std::vector<ImportedOutputId> RuntimeImpl::ImportOutputs(NetworkId networkId, const OutputTensors& outputTensors)
546{
547 return GetLoadedNetworkPtr(networkId)->ImportOutputs(outputTensors);
548}
Finn Williamsf37b9702021-09-01 18:06:04 +0100549
Finn Williams8636bc72021-10-02 15:06:39 +0100550void RuntimeImpl::ClearImportedInputs(NetworkId networkId, const std::vector<ImportedInputId> inputIds)
551{
552 return GetLoadedNetworkPtr(networkId)->ClearImportedInputs(inputIds);
553}
554void RuntimeImpl::ClearImportedOutputs(NetworkId networkId, const std::vector<ImportedOutputId> outputIds)
555{
556 return GetLoadedNetworkPtr(networkId)->ClearImportedOutputs(outputIds);
557}
Derek Lamberti03614f62018-10-02 15:52:46 +0100558
Kevin Mayd92a6e42021-02-04 10:27:41 +0000559Status RuntimeImpl::EnqueueWorkload(NetworkId networkId,
telsoa01c577f2c2018-08-31 09:22:23 +0100560 const InputTensors& inputTensors,
561 const OutputTensors& outputTensors)
telsoa014fcda012018-03-09 14:13:49 +0000562{
surmeh013537c2c2018-05-18 16:31:43 +0100563 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100564
565 if (!loadedNetwork)
566 {
567 ARMNN_LOG(error) << "A Network with an id of " << networkId << " does not exist.\n";
568 return Status::Failure;
569 }
570 if (loadedNetwork->IsAsyncEnabled())
571 {
572 ARMNN_LOG(error) << "Network " << networkId << " is async enabled.\n";
573 return Status::Failure;
574 }
Narumol Prangnawarat5b4d0d52020-06-23 11:45:56 +0100575 ProfilerManager::GetInstance().RegisterProfiler(loadedNetwork->GetProfiler().get());
576
577 ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "EnqueueWorkload");
Derek Lamberti03614f62018-10-02 15:52:46 +0100578
579 static thread_local NetworkId lastId = networkId;
580 if (lastId != networkId)
581 {
582 LoadedNetworkFuncSafe(lastId, [](LoadedNetwork* network)
583 {
584 network->FreeWorkingMemory();
585 });
586 }
587 lastId=networkId;
588
surmeh013537c2c2018-05-18 16:31:43 +0100589 return loadedNetwork->EnqueueWorkload(inputTensors, outputTensors);
telsoa014fcda012018-03-09 14:13:49 +0000590}
591
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100592Status RuntimeImpl::Execute(IWorkingMemHandle& iWorkingMemHandle,
593 const InputTensors& inputTensors,
Finn Williamsf37b9702021-09-01 18:06:04 +0100594 const OutputTensors& outputTensors,
Finn Williams8636bc72021-10-02 15:06:39 +0100595 std::vector<ImportedInputId> preImportedInputs,
596 std::vector<ImportedOutputId> preImportedOutputs)
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100597{
598 NetworkId networkId = iWorkingMemHandle.GetNetworkId();
599 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
600
601 if (!loadedNetwork)
602 {
603 ARMNN_LOG(error) << "A Network with an id of " << networkId << " does not exist.\n";
604 return Status::Failure;
605 }
606 if (!loadedNetwork->IsAsyncEnabled())
607 {
Keith Davise813d672021-04-22 10:10:34 +0100608 ARMNN_LOG(error) << "Attempting execute " << networkId << " when it is not async enabled.\n";
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100609 return Status::Failure;
610 }
611 ProfilerManager::GetInstance().RegisterProfiler(loadedNetwork->GetProfiler().get());
612
613 ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "Execute");
614
Finn Williams8636bc72021-10-02 15:06:39 +0100615 return loadedNetwork->Execute(inputTensors,
616 outputTensors,
617 iWorkingMemHandle,
618 preImportedInputs,
619 preImportedOutputs);
Mike Kelly55a8ffd2021-04-07 20:10:49 +0100620}
621
622/// Create a new unique WorkingMemHandle object. Create multiple handles if you wish to have
623/// overlapped Execution by calling this function from different threads.
624std::unique_ptr<IWorkingMemHandle> RuntimeImpl::CreateWorkingMemHandle(NetworkId networkId)
625{
626 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
627
628 if (!loadedNetwork)
629 {
630 ARMNN_LOG(error) << "A Network with an id of " << networkId << " does not exist.\n";
631 return nullptr;
632 }
633 if (!loadedNetwork->IsAsyncEnabled())
634 {
635 ARMNN_LOG(error) << "Network " << networkId << " is not async enabled.\n";
636 return nullptr;
637 }
638 ProfilerManager::GetInstance().RegisterProfiler(loadedNetwork->GetProfiler().get());
639
640 ARMNN_SCOPED_PROFILING_EVENT(Compute::Undefined, "CreateWorkingMemHandle");
641
642 static thread_local NetworkId lastId = networkId;
643 if (lastId != networkId)
644 {
645 LoadedNetworkFuncSafe(lastId, [](LoadedNetwork* network)
646 {
647 network->FreeWorkingMemory();
648 });
649 }
650 lastId=networkId;
651
652 return loadedNetwork->CreateWorkingMemHandle(networkId);
653}
654
Kevin Mayd92a6e42021-02-04 10:27:41 +0000655void RuntimeImpl::RegisterDebugCallback(NetworkId networkId, const DebugCallbackFunction& func)
Nattapat Chaimanowong6e948202019-03-22 14:01:46 +0000656{
657 LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId);
658 loadedNetwork->RegisterDebugCallback(func);
659}
660
Kevin Mayd92a6e42021-02-04 10:27:41 +0000661void RuntimeImpl::LoadDynamicBackends(const std::string& overrideBackendPath)
Matteo Martincighe54aa062019-08-05 14:12:11 +0100662{
663 // Get the paths where to load the dynamic backends from
664 std::vector<std::string> backendPaths = DynamicBackendUtils::GetBackendPaths(overrideBackendPath);
665
666 // Get the shared objects to try to load as dynamic backends
667 std::vector<std::string> sharedObjects = DynamicBackendUtils::GetSharedObjects(backendPaths);
668
669 // Create a list of dynamic backends
Matteo Martincigh0c2b2892019-08-05 14:12:11 +0100670 m_DynamicBackends = DynamicBackendUtils::CreateDynamicBackends(sharedObjects);
671
672 // Register the dynamic backends in the backend registry
Matteo Martincigh89533902019-08-15 12:08:06 +0100673 BackendIdSet registeredBackendIds = DynamicBackendUtils::RegisterDynamicBackends(m_DynamicBackends);
674
675 // Add the registered dynamic backend ids to the list of supported backends
Narumol Prangnawarat60a20fb2019-12-09 17:24:41 +0000676 m_DeviceSpec.AddSupportedBackends(registeredBackendIds, true);
telsoa014fcda012018-03-09 14:13:49 +0000677}
Matteo Martincighe54aa062019-08-05 14:12:11 +0100678
679} // namespace armnn