David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 1 | // |
Colm Donelan | b4ef163 | 2024-02-01 15:00:43 +0000 | [diff] [blame] | 2 | // Copyright © 2017, 2024 Arm Ltd and Contributors. All rights reserved. |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 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> |
Jan Eilers | bb446e5 | 2020-04-02 13:56:54 +0100 | [diff] [blame] | 10 | #include <armnn/utility/PolymorphicDowncast.hpp> |
Derek Lamberti | 0844697 | 2019-11-26 16:38:31 +0000 | [diff] [blame] | 11 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 12 | #include <arm_compute/core/CL/OpenCL.h> |
| 13 | #include <arm_compute/core/CL/CLKernelLibrary.h> |
| 14 | #include <arm_compute/runtime/CL/CLScheduler.h> |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 15 | #include <arm_compute/runtime/CL/CLTunerTypes.h> |
| 16 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 17 | namespace armnn |
| 18 | { |
| 19 | |
| 20 | struct ClBackendContext::ClContextControlWrapper |
| 21 | { |
TeresaARM | 8b4a483 | 2022-12-20 16:28:22 +0000 | [diff] [blame] | 22 | ClContextControlWrapper(arm_compute::CLTuner* tuner, |
| 23 | arm_compute::CLGEMMHeuristicsHandle* heuristicsHandle, |
| 24 | bool profilingEnabled) |
| 25 | : m_ClContextControl(tuner, heuristicsHandle, profilingEnabled) |
| 26 | {} |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 27 | |
| 28 | bool Sync() |
| 29 | { |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 30 | if (arm_compute::CLScheduler::get().context()() != NULL) |
| 31 | { |
| 32 | // Waits for all queued CL requests to finish before unloading the network they may be using. |
| 33 | try |
| 34 | { |
| 35 | // Coverity fix: arm_compute::CLScheduler::sync() may throw an exception of type cl::Error. |
| 36 | arm_compute::CLScheduler::get().sync(); |
| 37 | } |
| 38 | catch (const cl::Error&) |
| 39 | { |
Derek Lamberti | 0844697 | 2019-11-26 16:38:31 +0000 | [diff] [blame] | 40 | ARMNN_LOG(warning) << "Runtime::UnloadNetwork(): an error occurred while waiting for " |
| 41 | "the queued CL requests to finish"; |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 42 | return false; |
| 43 | } |
| 44 | } |
Aron Virginas-Tar | d46e647 | 2018-11-16 10:26:23 +0000 | [diff] [blame] | 45 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 46 | return true; |
| 47 | } |
| 48 | |
| 49 | void ClearClCache() |
| 50 | { |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 51 | if (arm_compute::CLScheduler::get().context()() != NULL) |
| 52 | { |
| 53 | // There are no loaded networks left, so clear the CL cache to free up memory |
| 54 | m_ClContextControl.ClearClCache(); |
| 55 | } |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 56 | } |
| 57 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 58 | ClContextControl m_ClContextControl; |
| 59 | }; |
| 60 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 61 | ClBackendContext::ClBackendContext(const IRuntime::CreationOptions& options) |
| 62 | : IBackendContext(options) |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 63 | , m_TuningFile() |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 64 | { |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 65 | bool kernelProfiling = options.m_EnableGpuProfiling; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 66 | |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 67 | arm_compute::CLTuner* tuner = nullptr; |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 68 | arm_compute::CLGEMMHeuristicsHandle* mlgoTuner = nullptr; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 69 | bool useLegacyTunerAPI = options.m_GpuAccTunedParameters.get() != nullptr; |
| 70 | if (useLegacyTunerAPI) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 71 | { |
Jan Eilers | bb446e5 | 2020-04-02 13:56:54 +0100 | [diff] [blame] | 72 | auto clTunerParams = PolymorphicDowncast<ClTunedParameters*>( |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 73 | options.m_GpuAccTunedParameters.get()); |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 74 | tuner = &clTunerParams->m_Tuner; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 75 | |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 76 | if (tuner) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 77 | { |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 78 | auto ConvertTuningLevel = [](IGpuAccTunedParameters::TuningLevel level, |
| 79 | armnn::IGpuAccTunedParameters::Mode mode) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 80 | { |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 81 | if (mode == armnn::IGpuAccTunedParameters::Mode::UseTunedParameters) |
| 82 | { |
| 83 | return TuningLevel::None; |
| 84 | } |
| 85 | |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 86 | switch(level) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 87 | { |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 88 | case IGpuAccTunedParameters::TuningLevel::Rapid: |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 89 | return TuningLevel::Rapid; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 90 | case IGpuAccTunedParameters::TuningLevel::Normal: |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 91 | return TuningLevel::Normal; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 92 | case IGpuAccTunedParameters::TuningLevel::Exhaustive: |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 93 | return TuningLevel::Exhaustive; |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 94 | default: |
| 95 | { |
Colm Donelan | b4ef163 | 2024-02-01 15:00:43 +0000 | [diff] [blame] | 96 | throw InvalidArgumentException("Invalid value of tuning level specified."); |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 97 | } |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 98 | } |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 99 | }; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 100 | |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 101 | TuningLevel tuningLevel = ConvertTuningLevel(clTunerParams->m_TuningLevel, clTunerParams->m_Mode); |
| 102 | ConfigureTuner(*tuner, tuningLevel); |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 103 | } |
| 104 | } |
| 105 | else //New backend options API |
| 106 | { |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 107 | const TuningLevel defaultTuningLevel = TuningLevel::None; |
| 108 | auto tuningLevel = defaultTuningLevel; |
| 109 | |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 110 | ParseOptions(options.m_BackendOptions, "GpuAcc", [&](std::string name, const BackendOptions::Var& value) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 111 | { |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 112 | if (name == "KernelProfilingEnabled") |
| 113 | { |
Cathal Corbett | d9e55f0 | 2023-01-11 13:03:21 +0000 | [diff] [blame] | 114 | kernelProfiling |= ParseBooleanBackendOption(value, false); |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 115 | } else if (name == "TuningFile") |
| 116 | { |
Cathal Corbett | d9e55f0 | 2023-01-11 13:03:21 +0000 | [diff] [blame] | 117 | m_TuningFile = ParseStringBackendOption(value, ""); |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 118 | } else if (name == "TuningLevel") |
| 119 | { |
| 120 | tuningLevel = ParseTuningLevel(value, defaultTuningLevel); |
| 121 | } |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 122 | else if (name == "MLGOTuningFilePath") |
| 123 | { |
Cathal Corbett | d9e55f0 | 2023-01-11 13:03:21 +0000 | [diff] [blame] | 124 | m_MLGOTuningFile = ParseStringBackendOption(value, ""); |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 125 | } |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 126 | }); |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 127 | |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 128 | // Create the tuner, in tuning mode initially. |
| 129 | m_Tuner = std::make_unique<arm_compute::CLTuner>(true); |
| 130 | |
Derek Lamberti | 5c510f8 | 2020-02-11 12:56:52 +0000 | [diff] [blame] | 131 | ConfigureTuner(*(m_Tuner.get()), tuningLevel); |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 132 | |
Stuart Taylor | 06ccd71 | 2022-03-15 17:03:58 +0000 | [diff] [blame] | 133 | if (!m_TuningFile.empty()) |
Derek Lamberti | ef7e6b6 | 2020-02-04 14:49:16 +0000 | [diff] [blame] | 134 | { |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 135 | try |
| 136 | { |
Jan Eilers | 2cd1847 | 2020-12-15 10:42:38 +0000 | [diff] [blame] | 137 | ARMNN_LOG(info) << "Loading Gpu tuning data from file: " << m_TuningFile; |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 138 | m_Tuner->load_from_file(m_TuningFile.c_str()); |
alered01 | a7227ac | 2020-05-07 14:58:29 +0100 | [diff] [blame] | 139 | } |
| 140 | catch (const std::exception& e) |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 141 | { |
Stuart Taylor | 06ccd71 | 2022-03-15 17:03:58 +0000 | [diff] [blame] | 142 | // Warn if not tuning, otherwise tuning will generate new params |
| 143 | if (tuningLevel == TuningLevel::None) |
| 144 | { |
| 145 | ARMNN_LOG(warning) << "Could not load GpuAcc tuner data file."; |
| 146 | } |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 147 | } |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 148 | } |
Finn Williams | 4064632 | 2021-02-11 16:16:42 +0000 | [diff] [blame] | 149 | |
| 150 | if (!m_MLGOTuningFile.empty()) |
| 151 | { |
| 152 | try |
| 153 | { |
| 154 | ARMNN_LOG(info) << "Loading Gpu MLGO tuning data from file: " << m_TuningFile; |
| 155 | if(m_MLGOTuner.reload_from_file(m_MLGOTuningFile.c_str())) |
| 156 | { |
| 157 | mlgoTuner = &m_MLGOTuner; |
| 158 | } |
| 159 | } |
| 160 | catch (const std::exception& e) |
| 161 | { |
| 162 | ARMNN_LOG(warning) << "Could not load GpuAcc MLGO tuner data file."; |
| 163 | } |
| 164 | } |
| 165 | |
alered01 | a7227ac | 2020-05-07 14:58:29 +0100 | [diff] [blame] | 166 | tuner = m_Tuner.get(); |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 167 | } |
| 168 | |
TeresaARM | 8b4a483 | 2022-12-20 16:28:22 +0000 | [diff] [blame] | 169 | m_ClContextControlWrapper = std::make_unique<ClContextControlWrapper>( |
| 170 | tuner, |
| 171 | mlgoTuner, |
| 172 | kernelProfiling |
| 173 | ); |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 174 | } |
| 175 | |
| 176 | bool ClBackendContext::BeforeLoadNetwork(NetworkId) |
| 177 | { |
| 178 | return true; |
| 179 | } |
| 180 | |
| 181 | bool ClBackendContext::AfterLoadNetwork(NetworkId networkId) |
| 182 | { |
| 183 | { |
| 184 | std::lock_guard<std::mutex> lockGuard(m_Mutex); |
| 185 | m_NetworkIds.insert(networkId); |
| 186 | } |
| 187 | return true; |
| 188 | } |
| 189 | |
| 190 | bool ClBackendContext::BeforeUnloadNetwork(NetworkId) |
| 191 | { |
| 192 | return m_ClContextControlWrapper->Sync(); |
| 193 | } |
| 194 | |
| 195 | bool ClBackendContext::AfterUnloadNetwork(NetworkId networkId) |
| 196 | { |
| 197 | bool clearCache = false; |
| 198 | { |
| 199 | std::lock_guard<std::mutex> lockGuard(m_Mutex); |
| 200 | m_NetworkIds.erase(networkId); |
| 201 | clearCache = m_NetworkIds.empty(); |
| 202 | } |
| 203 | |
| 204 | if (clearCache) |
| 205 | { |
| 206 | m_ClContextControlWrapper->ClearClCache(); |
| 207 | } |
| 208 | |
| 209 | return true; |
| 210 | } |
| 211 | |
Narumol Prangnawarat | ec5463d | 2022-02-04 17:50:20 +0000 | [diff] [blame] | 212 | bool ClBackendContext::AfterEnqueueWorkload(NetworkId) |
| 213 | { |
| 214 | return m_ClContextControlWrapper->Sync(); |
| 215 | } |
| 216 | |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 217 | ClBackendContext::~ClBackendContext() |
| 218 | { |
Derek Lamberti | 836b27b | 2019-11-20 10:51:57 +0000 | [diff] [blame] | 219 | if (m_Tuner && !m_TuningFile.empty()) |
| 220 | { |
| 221 | try |
| 222 | { |
| 223 | m_Tuner->save_to_file(m_TuningFile.c_str()); |
| 224 | } |
| 225 | catch(const std::exception& e) |
| 226 | { |
| 227 | ARMNN_LOG(warning) << "Could not save GpuAcc tuner data to file " << m_TuningFile; |
| 228 | } |
| 229 | } |
David Beck | 1b61be5 | 2018-11-08 09:19:14 +0000 | [diff] [blame] | 230 | } |
| 231 | |
| 232 | } // namespace armnn |