David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2017 Arm Ltd. All rights reserved. |
| 3 | // SPDX-License-Identifier: MIT |
| 4 | // |
| 5 | |
| 6 | #include "ClBackendContext.hpp" |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 7 | #include "ClContextControl.hpp" |
Derek Lamberti | 0844697 | 2019-11-26 16:38:31 +0000 | [diff] [blame] | 8 | |
| 9 | #include <armnn/Logging.hpp> |
Narumol Prangnawarat | ac2770a | 2020-04-01 16:51:23 +0100 | [diff] [blame] | 10 | #include <armnn/utility/Assert.hpp> |
Jan Eilers | bb446e5 | 2020-04-02 13:56:54 +0100 | [diff] [blame] | 11 | #include <armnn/utility/PolymorphicDowncast.hpp> |
Derek Lamberti | 0844697 | 2019-11-26 16:38:31 +0000 | [diff] [blame] | 12 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 13 | #include <arm_compute/core/CL/OpenCL.h> |
| 14 | #include <arm_compute/core/CL/CLKernelLibrary.h> |
| 15 | #include <arm_compute/runtime/CL/CLScheduler.h> |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 16 | #include <arm_compute/runtime/CL/CLTunerTypes.h> |
| 17 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 18 | namespace armnn |
| 19 | { |
| 20 | |
| 21 | struct ClBackendContext::ClContextControlWrapper |
| 22 | { |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 23 | ClContextControlWrapper(arm_compute::CLTuner* tuner, |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 24 | arm_compute::CLGEMMHeuristicsHandle* heuristicsHandle, |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 25 | bool profilingEnabled) |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 26 | : m_ClContextControl(tuner, heuristicsHandle, profilingEnabled) |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 27 | {} |
| 28 | |
| 29 | bool Sync() |
| 30 | { |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 31 | if (arm_compute::CLScheduler::get().context()() != NULL) |
| 32 | { |
| 33 | // Waits for all queued CL requests to finish before unloading the network they may be using. |
| 34 | try |
| 35 | { |
| 36 | // Coverity fix: arm_compute::CLScheduler::sync() may throw an exception of type cl::Error. |
| 37 | arm_compute::CLScheduler::get().sync(); |
| 38 | } |
| 39 | catch (const cl::Error&) |
| 40 | { |
Derek Lamberti | 0844697 | 2019-11-26 16:38:31 +0000 | [diff] [blame] | 41 | ARMNN_LOG(warning) << "Runtime::UnloadNetwork(): an error occurred while waiting for " |
| 42 | "the queued CL requests to finish"; |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 43 | return false; |
| 44 | } |
| 45 | } |
Aron Virginas-Tar | d46e647 | 2018-11-16 10:26:23 +0000 | [diff] [blame] | 46 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 47 | return true; |
| 48 | } |
| 49 | |
| 50 | void ClearClCache() |
| 51 | { |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 52 | if (arm_compute::CLScheduler::get().context()() != NULL) |
| 53 | { |
| 54 | // There are no loaded networks left, so clear the CL cache to free up memory |
| 55 | m_ClContextControl.ClearClCache(); |
| 56 | } |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 57 | } |
| 58 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 59 | ClContextControl m_ClContextControl; |
| 60 | }; |
| 61 | |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 62 | std::string LowerString(std::string value) |
| 63 | { |
| 64 | std::transform(value.begin(), value.end(), value.begin(), |
| 65 | [](unsigned char c){ return std::tolower(c); }); |
| 66 | |
| 67 | return value; |
| 68 | } |
| 69 | |
| 70 | enum class TuningLevel |
| 71 | { |
| 72 | None, |
| 73 | Rapid, |
| 74 | Normal, |
| 75 | Exhaustive |
| 76 | }; |
| 77 | |
| 78 | |
| 79 | TuningLevel ParseTuningLevel(const BackendOptions::Var& value, TuningLevel defaultValue) |
| 80 | { |
| 81 | if (value.IsInt()) |
| 82 | { |
alered01 | a7227ac | 2020-05-07 14:58:29 +0100 | [diff] [blame] | 83 | int v = value.AsInt(); |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 84 | if (v > static_cast<int>(TuningLevel::Exhaustive) || |
| 85 | v < static_cast<int>(TuningLevel::None)) |
| 86 | { |
| 87 | ARMNN_LOG(warning) << "Invalid GpuAcc tuning level ("<< v << ") selected. " |
| 88 | "Using default(" << static_cast<int>(defaultValue) << ")"; |
| 89 | } else |
| 90 | { |
| 91 | return static_cast<TuningLevel>(v); |
| 92 | } |
| 93 | } |
| 94 | return defaultValue; |
| 95 | } |
| 96 | |
| 97 | bool ParseBoolean(const BackendOptions::Var& value, bool defaultValue) |
| 98 | { |
| 99 | if (value.IsBool()) |
| 100 | { |
| 101 | return value.AsBool(); |
| 102 | } |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 103 | return defaultValue; |
| 104 | } |
| 105 | |
| 106 | std::string ParseFile(const BackendOptions::Var& value, std::string defaultValue) |
| 107 | { |
| 108 | if (value.IsString()) |
| 109 | { |
| 110 | return value.AsString(); |
| 111 | } |
| 112 | return defaultValue; |
| 113 | } |
| 114 | |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 115 | void ConfigureTuner(arm_compute::CLTuner &tuner, TuningLevel level) |
| 116 | { |
| 117 | tuner.set_tune_new_kernels(true); // Turn on tuning initially. |
| 118 | |
| 119 | switch (level) |
| 120 | { |
| 121 | case TuningLevel::Rapid: |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 122 | ARMNN_LOG(info) << "Gpu tuning is activated. TuningLevel: Rapid (1)"; |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 123 | tuner.set_tuner_mode(arm_compute::CLTunerMode::RAPID); |
| 124 | break; |
| 125 | case TuningLevel::Normal: |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 126 | ARMNN_LOG(info) << "Gpu tuning is activated. TuningLevel: Normal (2)"; |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 127 | tuner.set_tuner_mode(arm_compute::CLTunerMode::NORMAL); |
| 128 | break; |
| 129 | case TuningLevel::Exhaustive: |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 130 | ARMNN_LOG(info) << "Gpu tuning is activated. TuningLevel: Exhaustive (3)"; |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 131 | tuner.set_tuner_mode(arm_compute::CLTunerMode::EXHAUSTIVE); |
| 132 | break; |
| 133 | case TuningLevel::None: |
| 134 | default: |
| 135 | tuner.set_tune_new_kernels(false); // Turn off tuning. Set to "use" only mode. |
| 136 | break; |
| 137 | } |
| 138 | } |
| 139 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 140 | ClBackendContext::ClBackendContext(const IRuntime::CreationOptions& options) |
| 141 | : IBackendContext(options) |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 142 | , m_TuningFile() |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 143 | { |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 144 | bool kernelProfiling = options.m_EnableGpuProfiling; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 145 | |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 146 | arm_compute::CLTuner* tuner = nullptr; |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 147 | arm_compute::CLGEMMHeuristicsHandle* mlgoTuner = nullptr; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 148 | bool useLegacyTunerAPI = options.m_GpuAccTunedParameters.get() != nullptr; |
| 149 | if (useLegacyTunerAPI) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 150 | { |
Jan Eilers | bb446e5 | 2020-04-02 13:56:54 +0100 | [diff] [blame] | 151 | auto clTunerParams = PolymorphicDowncast<ClTunedParameters*>( |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 152 | options.m_GpuAccTunedParameters.get()); |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 153 | tuner = &clTunerParams->m_Tuner; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 154 | |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 155 | if (tuner) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 156 | { |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 157 | auto ConvertTuningLevel = [](IGpuAccTunedParameters::TuningLevel level, |
| 158 | armnn::IGpuAccTunedParameters::Mode mode) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 159 | { |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 160 | if (mode == armnn::IGpuAccTunedParameters::Mode::UseTunedParameters) |
| 161 | { |
| 162 | return TuningLevel::None; |
| 163 | } |
| 164 | |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 165 | switch(level) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 166 | { |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 167 | case IGpuAccTunedParameters::TuningLevel::Rapid: |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 168 | return TuningLevel::Rapid; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 169 | case IGpuAccTunedParameters::TuningLevel::Normal: |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 170 | return TuningLevel::Normal; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 171 | case IGpuAccTunedParameters::TuningLevel::Exhaustive: |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 172 | return TuningLevel::Exhaustive; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 173 | default: |
| 174 | { |
Narumol Prangnawarat | ac2770a | 2020-04-01 16:51:23 +0100 | [diff] [blame] | 175 | ARMNN_ASSERT_MSG(false, "Tuning level not recognised."); |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 176 | return TuningLevel::None; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 177 | } |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 178 | } |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 179 | }; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 180 | |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 181 | TuningLevel tuningLevel = ConvertTuningLevel(clTunerParams->m_TuningLevel, clTunerParams->m_Mode); |
| 182 | ConfigureTuner(*tuner, tuningLevel); |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 183 | } |
| 184 | } |
| 185 | else //New backend options API |
| 186 | { |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 187 | const TuningLevel defaultTuningLevel = TuningLevel::None; |
| 188 | auto tuningLevel = defaultTuningLevel; |
| 189 | |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 190 | ParseOptions(options.m_BackendOptions, "GpuAcc", [&](std::string name, const BackendOptions::Var& value) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 191 | { |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 192 | if (name == "KernelProfilingEnabled") |
| 193 | { |
| 194 | kernelProfiling |= ParseBoolean(value, false); |
| 195 | } else if (name == "TuningFile") |
| 196 | { |
| 197 | m_TuningFile = ParseFile(value, ""); |
| 198 | } else if (name == "TuningLevel") |
| 199 | { |
| 200 | tuningLevel = ParseTuningLevel(value, defaultTuningLevel); |
| 201 | } |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 202 | else if (name == "MLGOTuningFilePath") |
| 203 | { |
| 204 | m_MLGOTuningFile = ParseFile(value, ""); |
| 205 | } |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 206 | }); |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 207 | |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 208 | // Create the tuner, in tuning mode initially. |
| 209 | m_Tuner = std::make_unique<arm_compute::CLTuner>(true); |
| 210 | |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 211 | ConfigureTuner(*(m_Tuner.get()), tuningLevel); |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 212 | |
alered01 | a7227ac | 2020-05-07 14:58:29 +0100 | [diff] [blame] | 213 | if (!m_TuningFile.empty() && tuningLevel == TuningLevel::None) |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 214 | { |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 215 | try |
| 216 | { |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 217 | ARMNN_LOG(info) << "Loading Gpu tuning data from file: " << m_TuningFile; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 218 | m_Tuner->load_from_file(m_TuningFile.c_str()); |
alered01 | a7227ac | 2020-05-07 14:58:29 +0100 | [diff] [blame] | 219 | } |
| 220 | catch (const std::exception& e) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 221 | { |
| 222 | ARMNN_LOG(warning) << "Could not load GpuAcc tuner data file."; |
| 223 | } |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 224 | } |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 225 | |
| 226 | if (!m_MLGOTuningFile.empty()) |
| 227 | { |
| 228 | try |
| 229 | { |
| 230 | ARMNN_LOG(info) << "Loading Gpu MLGO tuning data from file: " << m_TuningFile; |
| 231 | if(m_MLGOTuner.reload_from_file(m_MLGOTuningFile.c_str())) |
| 232 | { |
| 233 | mlgoTuner = &m_MLGOTuner; |
| 234 | } |
| 235 | } |
| 236 | catch (const std::exception& e) |
| 237 | { |
| 238 | ARMNN_LOG(warning) << "Could not load GpuAcc MLGO tuner data file."; |
| 239 | } |
| 240 | } |
| 241 | |
alered01 | a7227ac | 2020-05-07 14:58:29 +0100 | [diff] [blame] | 242 | tuner = m_Tuner.get(); |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 243 | } |
| 244 | |
| 245 | m_ClContextControlWrapper = std::make_unique<ClContextControlWrapper>( |
| 246 | tuner, |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 247 | mlgoTuner, |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 248 | kernelProfiling |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 249 | ); |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 250 | } |
| 251 | |
| 252 | bool ClBackendContext::BeforeLoadNetwork(NetworkId) |
| 253 | { |
| 254 | return true; |
| 255 | } |
| 256 | |
| 257 | bool ClBackendContext::AfterLoadNetwork(NetworkId networkId) |
| 258 | { |
| 259 | { |
| 260 | std::lock_guard<std::mutex> lockGuard(m_Mutex); |
| 261 | m_NetworkIds.insert(networkId); |
| 262 | } |
| 263 | return true; |
| 264 | } |
| 265 | |
| 266 | bool ClBackendContext::BeforeUnloadNetwork(NetworkId) |
| 267 | { |
| 268 | return m_ClContextControlWrapper->Sync(); |
| 269 | } |
| 270 | |
| 271 | bool ClBackendContext::AfterUnloadNetwork(NetworkId networkId) |
| 272 | { |
| 273 | bool clearCache = false; |
| 274 | { |
| 275 | std::lock_guard<std::mutex> lockGuard(m_Mutex); |
| 276 | m_NetworkIds.erase(networkId); |
| 277 | clearCache = m_NetworkIds.empty(); |
| 278 | } |
| 279 | |
| 280 | if (clearCache) |
| 281 | { |
| 282 | m_ClContextControlWrapper->ClearClCache(); |
| 283 | } |
| 284 | |
| 285 | return true; |
| 286 | } |
| 287 | |
| 288 | ClBackendContext::~ClBackendContext() |
| 289 | { |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 290 | if (m_Tuner && !m_TuningFile.empty()) |
| 291 | { |
| 292 | try |
| 293 | { |
| 294 | m_Tuner->save_to_file(m_TuningFile.c_str()); |
| 295 | } |
| 296 | catch(const std::exception& e) |
| 297 | { |
| 298 | ARMNN_LOG(warning) << "Could not save GpuAcc tuner data to file " << m_TuningFile; |
| 299 | } |
| 300 | } |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 301 | } |
| 302 | |
| 303 | } // namespace armnn |