telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2017 Arm Ltd. All rights reserved. |
David Beck | ecb56cd | 2018-09-05 12:52:57 +0100 | [diff] [blame] | 3 | // SPDX-License-Identifier: MIT |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 4 | // |
| 5 | #include "Runtime.hpp" |
| 6 | |
David Beck | 056be3c | 2018-10-22 13:16:00 +0100 | [diff] [blame] | 7 | #include <armnn/Version.hpp> |
Matteo Martincigh | e54aa06 | 2019-08-05 14:12:11 +0100 | [diff] [blame] | 8 | |
Aron Virginas-Tar | c9cc804 | 2018-11-01 16:15:57 +0000 | [diff] [blame] | 9 | #include <backendsCommon/BackendRegistry.hpp> |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 10 | #include <backendsCommon/IBackendContext.hpp> |
Matteo Martincigh | e54aa06 | 2019-08-05 14:12:11 +0100 | [diff] [blame] | 11 | #include <backendsCommon/DynamicBackendUtils.hpp> |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 12 | |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 13 | #include <iostream> |
| 14 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 15 | #include <boost/log/trivial.hpp> |
| 16 | #include <boost/polymorphic_cast.hpp> |
| 17 | |
| 18 | using namespace armnn; |
| 19 | using namespace std; |
| 20 | |
| 21 | namespace armnn |
| 22 | { |
| 23 | |
| 24 | IRuntime* IRuntime::CreateRaw(const CreationOptions& options) |
| 25 | { |
| 26 | return new Runtime(options); |
| 27 | } |
| 28 | |
| 29 | IRuntimePtr IRuntime::Create(const CreationOptions& options) |
| 30 | { |
| 31 | return IRuntimePtr(CreateRaw(options), &IRuntime::Destroy); |
| 32 | } |
| 33 | |
| 34 | void IRuntime::Destroy(IRuntime* runtime) |
| 35 | { |
| 36 | delete boost::polymorphic_downcast<Runtime*>(runtime); |
| 37 | } |
| 38 | |
| 39 | int Runtime::GenerateNetworkId() |
| 40 | { |
| 41 | return m_NetworkIdCounter++; |
| 42 | } |
| 43 | |
| 44 | Status Runtime::LoadNetwork(NetworkId& networkIdOut, IOptimizedNetworkPtr inNetwork) |
| 45 | { |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame] | 46 | std::string ignoredErrorMessage; |
| 47 | return LoadNetwork(networkIdOut, std::move(inNetwork), ignoredErrorMessage); |
| 48 | } |
| 49 | |
| 50 | Status Runtime::LoadNetwork(NetworkId& networkIdOut, |
| 51 | IOptimizedNetworkPtr inNetwork, |
David Monahan | 4f1e8e4 | 2019-09-04 09:22:10 +0100 | [diff] [blame^] | 52 | std::string& errorMessage) |
| 53 | { |
| 54 | INetworkProperties networkProperties; |
| 55 | return LoadNetwork(networkIdOut, std::move(inNetwork), errorMessage, networkProperties); |
| 56 | } |
| 57 | |
| 58 | Status Runtime::LoadNetwork(NetworkId& networkIdOut, |
| 59 | IOptimizedNetworkPtr inNetwork, |
| 60 | std::string& errorMessage, |
| 61 | const INetworkProperties& networkProperties) |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame] | 62 | { |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 63 | IOptimizedNetwork* rawNetwork = inNetwork.release(); |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 64 | |
| 65 | networkIdOut = GenerateNetworkId(); |
| 66 | |
| 67 | for (auto&& context : m_BackendContexts) |
| 68 | { |
| 69 | context.second->BeforeLoadNetwork(networkIdOut); |
| 70 | } |
| 71 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 72 | unique_ptr<LoadedNetwork> loadedNetwork = LoadedNetwork::MakeLoadedNetwork( |
| 73 | std::unique_ptr<OptimizedNetwork>(boost::polymorphic_downcast<OptimizedNetwork*>(rawNetwork)), |
David Monahan | 4f1e8e4 | 2019-09-04 09:22:10 +0100 | [diff] [blame^] | 74 | errorMessage, |
| 75 | networkProperties); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 76 | |
| 77 | if (!loadedNetwork) |
| 78 | { |
| 79 | return Status::Failure; |
| 80 | } |
| 81 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame] | 82 | { |
| 83 | std::lock_guard<std::mutex> lockGuard(m_Mutex); |
| 84 | |
| 85 | // Stores the network |
| 86 | m_LoadedNetworks[networkIdOut] = std::move(loadedNetwork); |
| 87 | } |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 88 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 89 | for (auto&& context : m_BackendContexts) |
| 90 | { |
| 91 | context.second->AfterLoadNetwork(networkIdOut); |
| 92 | } |
| 93 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 94 | return Status::Success; |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 95 | } |
| 96 | |
| 97 | Status Runtime::UnloadNetwork(NetworkId networkId) |
| 98 | { |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 99 | bool unloadOk = true; |
| 100 | for (auto&& context : m_BackendContexts) |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 101 | { |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 102 | unloadOk &= context.second->BeforeUnloadNetwork(networkId); |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 103 | } |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 104 | |
| 105 | if (!unloadOk) |
| 106 | { |
| 107 | BOOST_LOG_TRIVIAL(warning) << "Runtime::UnloadNetwork(): failed to unload " |
| 108 | "network with ID:" << networkId << " because BeforeUnloadNetwork failed"; |
| 109 | return Status::Failure; |
| 110 | } |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 111 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 112 | { |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame] | 113 | std::lock_guard<std::mutex> lockGuard(m_Mutex); |
| 114 | |
| 115 | if (m_LoadedNetworks.erase(networkId) == 0) |
| 116 | { |
| 117 | BOOST_LOG_TRIVIAL(warning) << "WARNING: Runtime::UnloadNetwork(): " << networkId << " not found!"; |
| 118 | return Status::Failure; |
| 119 | } |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 120 | } |
David Beck | 9efb57d | 2018-11-05 13:40:33 +0000 | [diff] [blame] | 121 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 122 | for (auto&& context : m_BackendContexts) |
| 123 | { |
| 124 | context.second->AfterUnloadNetwork(networkId); |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame] | 125 | } |
| 126 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 127 | BOOST_LOG_TRIVIAL(debug) << "Runtime::UnloadNetwork(): Unloaded network with ID: " << networkId; |
| 128 | return Status::Success; |
| 129 | } |
| 130 | |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame] | 131 | const std::shared_ptr<IProfiler> Runtime::GetProfiler(NetworkId networkId) const |
| 132 | { |
| 133 | auto it = m_LoadedNetworks.find(networkId); |
| 134 | if (it != m_LoadedNetworks.end()) |
| 135 | { |
| 136 | auto& loadedNetwork = it->second; |
| 137 | return loadedNetwork->GetProfiler(); |
| 138 | } |
| 139 | |
| 140 | return nullptr; |
| 141 | } |
| 142 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 143 | Runtime::Runtime(const CreationOptions& options) |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 144 | : m_NetworkIdCounter(0) |
David Beck | 056be3c | 2018-10-22 13:16:00 +0100 | [diff] [blame] | 145 | , m_DeviceSpec{BackendRegistryInstance().GetBackendIds()} |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 146 | { |
| 147 | BOOST_LOG_TRIVIAL(info) << "ArmNN v" << ARMNN_VERSION << "\n"; |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 148 | |
Matteo Martincigh | e54aa06 | 2019-08-05 14:12:11 +0100 | [diff] [blame] | 149 | // Load any available/compatible dynamic backend before the runtime |
| 150 | // goes through the backend registry |
| 151 | LoadDynamicBackends(options.m_DynamicBackendsPath); |
| 152 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 153 | for (const auto& id : BackendRegistryInstance().GetBackendIds()) |
| 154 | { |
| 155 | // Store backend contexts for the supported ones |
Matteo Martincigh | 3d8a9ed | 2019-08-08 10:49:03 +0100 | [diff] [blame] | 156 | const BackendIdSet& supportedBackends = m_DeviceSpec.GetSupportedBackends(); |
Matteo Martincigh | 8953390 | 2019-08-15 12:08:06 +0100 | [diff] [blame] | 157 | if (supportedBackends.find(id) != supportedBackends.end()) |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 158 | { |
| 159 | auto factoryFun = BackendRegistryInstance().GetFactory(id); |
| 160 | auto backend = factoryFun(); |
| 161 | BOOST_ASSERT(backend.get() != nullptr); |
| 162 | |
| 163 | auto context = backend->CreateBackendContext(options); |
| 164 | |
| 165 | // backends are allowed to return nullptrs if they |
| 166 | // don't wish to create a backend specific context |
| 167 | if (context) |
| 168 | { |
| 169 | m_BackendContexts.emplace(std::make_pair(id, std::move(context))); |
| 170 | } |
| 171 | } |
| 172 | } |
surmeh01 | bceff2f | 2018-03-29 16:29:27 +0100 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | Runtime::~Runtime() |
| 176 | { |
| 177 | std::vector<int> networkIDs; |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 178 | try |
| 179 | { |
| 180 | // Coverity fix: The following code may throw an exception of type std::length_error. |
| 181 | std::transform(m_LoadedNetworks.begin(), m_LoadedNetworks.end(), |
| 182 | std::back_inserter(networkIDs), |
| 183 | [](const auto &pair) { return pair.first; }); |
| 184 | } |
| 185 | catch (const std::exception& e) |
| 186 | { |
| 187 | // Coverity fix: BOOST_LOG_TRIVIAL (typically used to report errors) may throw an |
| 188 | // exception of type std::length_error. |
| 189 | // Using stderr instead in this context as there is no point in nesting try-catch blocks here. |
| 190 | std::cerr << "WARNING: An error has occurred when getting the IDs of the networks to unload: " << e.what() |
| 191 | << "\nSome of the loaded networks may not be unloaded" << std::endl; |
| 192 | } |
| 193 | // We then proceed to unload all the networks which IDs have been appended to the list |
| 194 | // up to the point the exception was thrown (if any). |
surmeh01 | bceff2f | 2018-03-29 16:29:27 +0100 | [diff] [blame] | 195 | |
| 196 | for (auto networkID : networkIDs) |
| 197 | { |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 198 | try |
| 199 | { |
| 200 | // Coverity fix: UnloadNetwork() may throw an exception of type std::length_error, |
| 201 | // boost::log::v2s_mt_posix::odr_violation or boost::log::v2s_mt_posix::system_error |
| 202 | UnloadNetwork(networkID); |
| 203 | } |
| 204 | catch (const std::exception& e) |
| 205 | { |
| 206 | // Coverity fix: BOOST_LOG_TRIVIAL (typically used to report errors) may throw an |
| 207 | // exception of type std::length_error. |
| 208 | // Using stderr instead in this context as there is no point in nesting try-catch blocks here. |
| 209 | std::cerr << "WARNING: An error has occurred when unloading network " << networkID << ": " << e.what() |
| 210 | << std::endl; |
| 211 | } |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 212 | } |
| 213 | } |
| 214 | |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 215 | LoadedNetwork* Runtime::GetLoadedNetworkPtr(NetworkId networkId) const |
| 216 | { |
| 217 | std::lock_guard<std::mutex> lockGuard(m_Mutex); |
| 218 | return m_LoadedNetworks.at(networkId).get(); |
| 219 | } |
| 220 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 221 | TensorInfo Runtime::GetInputTensorInfo(NetworkId networkId, LayerBindingId layerId) const |
| 222 | { |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 223 | return GetLoadedNetworkPtr(networkId)->GetInputTensorInfo(layerId); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 224 | } |
| 225 | |
| 226 | TensorInfo Runtime::GetOutputTensorInfo(NetworkId networkId, LayerBindingId layerId) const |
| 227 | { |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 228 | return GetLoadedNetworkPtr(networkId)->GetOutputTensorInfo(layerId); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 229 | } |
| 230 | |
Derek Lamberti | 03614f6 | 2018-10-02 15:52:46 +0100 | [diff] [blame] | 231 | |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 232 | Status Runtime::EnqueueWorkload(NetworkId networkId, |
telsoa01 | c577f2c | 2018-08-31 09:22:23 +0100 | [diff] [blame] | 233 | const InputTensors& inputTensors, |
| 234 | const OutputTensors& outputTensors) |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 235 | { |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 236 | LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId); |
Derek Lamberti | 03614f6 | 2018-10-02 15:52:46 +0100 | [diff] [blame] | 237 | |
| 238 | static thread_local NetworkId lastId = networkId; |
| 239 | if (lastId != networkId) |
| 240 | { |
| 241 | LoadedNetworkFuncSafe(lastId, [](LoadedNetwork* network) |
| 242 | { |
| 243 | network->FreeWorkingMemory(); |
| 244 | }); |
| 245 | } |
| 246 | lastId=networkId; |
| 247 | |
surmeh01 | 3537c2c | 2018-05-18 16:31:43 +0100 | [diff] [blame] | 248 | return loadedNetwork->EnqueueWorkload(inputTensors, outputTensors); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 249 | } |
| 250 | |
Nattapat Chaimanowong | 6e94820 | 2019-03-22 14:01:46 +0000 | [diff] [blame] | 251 | void Runtime::RegisterDebugCallback(NetworkId networkId, const DebugCallbackFunction& func) |
| 252 | { |
| 253 | LoadedNetwork* loadedNetwork = GetLoadedNetworkPtr(networkId); |
| 254 | loadedNetwork->RegisterDebugCallback(func); |
| 255 | } |
| 256 | |
Matteo Martincigh | e54aa06 | 2019-08-05 14:12:11 +0100 | [diff] [blame] | 257 | void Runtime::LoadDynamicBackends(const std::string& overrideBackendPath) |
| 258 | { |
| 259 | // Get the paths where to load the dynamic backends from |
| 260 | std::vector<std::string> backendPaths = DynamicBackendUtils::GetBackendPaths(overrideBackendPath); |
| 261 | |
| 262 | // Get the shared objects to try to load as dynamic backends |
| 263 | std::vector<std::string> sharedObjects = DynamicBackendUtils::GetSharedObjects(backendPaths); |
| 264 | |
| 265 | // Create a list of dynamic backends |
Matteo Martincigh | 0c2b289 | 2019-08-05 14:12:11 +0100 | [diff] [blame] | 266 | m_DynamicBackends = DynamicBackendUtils::CreateDynamicBackends(sharedObjects); |
| 267 | |
| 268 | // Register the dynamic backends in the backend registry |
Matteo Martincigh | 8953390 | 2019-08-15 12:08:06 +0100 | [diff] [blame] | 269 | BackendIdSet registeredBackendIds = DynamicBackendUtils::RegisterDynamicBackends(m_DynamicBackends); |
| 270 | |
| 271 | // Add the registered dynamic backend ids to the list of supported backends |
| 272 | m_DeviceSpec.AddSupportedBackends(registeredBackendIds); |
telsoa01 | 4fcda01 | 2018-03-09 14:13:49 +0000 | [diff] [blame] | 273 | } |
Matteo Martincigh | e54aa06 | 2019-08-05 14:12:11 +0100 | [diff] [blame] | 274 | |
| 275 | } // namespace armnn |