telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 1 | // |
| 2 | // Copyright © 2017 Arm Ltd. All rights reserved. |
David Beck | 93e4898 | 2018-09-05 13:05:09 +0100 | [diff] [blame] | 3 | // SPDX-License-Identifier: MIT |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 4 | // |
| 5 | |
| 6 | #define LOG_TAG "ArmnnDriver" |
| 7 | |
| 8 | #include "DriverOptions.hpp" |
| 9 | #include "Utils.hpp" |
| 10 | |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 11 | #include <armnn/Version.hpp> |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 12 | #include <log/log.h> |
| 13 | #include "SystemPropertiesUtils.hpp" |
| 14 | |
| 15 | #include <OperationsUtils.h> |
| 16 | |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 17 | #include <cxxopts/cxxopts.hpp> |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 18 | |
Nattapat Chaimanowong | d5fd976 | 2019-04-04 13:33:10 +0100 | [diff] [blame] | 19 | #include <algorithm> |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 20 | #include <cassert> |
| 21 | #include <functional> |
| 22 | #include <string> |
| 23 | #include <sstream> |
| 24 | |
| 25 | using namespace android; |
| 26 | using namespace std; |
| 27 | |
| 28 | namespace armnn_driver |
| 29 | { |
| 30 | |
Nikhil Raj | 7760582 | 2018-09-03 11:25:56 +0100 | [diff] [blame] | 31 | DriverOptions::DriverOptions(armnn::Compute computeDevice, bool fp16Enabled) |
Nattapat Chaimanowong | d5fd976 | 2019-04-04 13:33:10 +0100 | [diff] [blame] | 32 | : m_Backends({computeDevice}) |
| 33 | , m_VerboseLogging(false) |
| 34 | , m_ClTunedParametersMode(armnn::IGpuAccTunedParameters::Mode::UseTunedParameters) |
Ruomei Yan | 689c6ee | 2019-04-25 17:48:41 +0100 | [diff] [blame] | 35 | , m_ClTuningLevel(armnn::IGpuAccTunedParameters::TuningLevel::Rapid) |
Nattapat Chaimanowong | d5fd976 | 2019-04-04 13:33:10 +0100 | [diff] [blame] | 36 | , m_EnableGpuProfiling(false) |
| 37 | , m_fp16Enabled(fp16Enabled) |
Mike Kelly | 7ed56dd | 2020-09-30 20:22:56 +0100 | [diff] [blame] | 38 | , m_FastMathEnabled(false) |
Sadik Armagan | f36e10b | 2021-01-11 16:34:01 +0000 | [diff] [blame] | 39 | , m_ShouldExit(false) |
| 40 | , m_SaveCachedNetwork(false) |
Matthew Sloyan | cd639c9 | 2021-02-11 16:57:38 +0000 | [diff] [blame] | 41 | , m_NumberOfThreads(0) |
Nattapat Chaimanowong | d5fd976 | 2019-04-04 13:33:10 +0100 | [diff] [blame] | 42 | { |
| 43 | } |
| 44 | |
| 45 | DriverOptions::DriverOptions(const std::vector<armnn::BackendId>& backends, bool fp16Enabled) |
| 46 | : m_Backends(backends) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 47 | , m_VerboseLogging(false) |
| 48 | , m_ClTunedParametersMode(armnn::IGpuAccTunedParameters::Mode::UseTunedParameters) |
Ruomei Yan | 689c6ee | 2019-04-25 17:48:41 +0100 | [diff] [blame] | 49 | , m_ClTuningLevel(armnn::IGpuAccTunedParameters::TuningLevel::Rapid) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 50 | , m_EnableGpuProfiling(false) |
Nikhil Raj | 7760582 | 2018-09-03 11:25:56 +0100 | [diff] [blame] | 51 | , m_fp16Enabled(fp16Enabled) |
Mike Kelly | 7ed56dd | 2020-09-30 20:22:56 +0100 | [diff] [blame] | 52 | , m_FastMathEnabled(false) |
Sadik Armagan | f36e10b | 2021-01-11 16:34:01 +0000 | [diff] [blame] | 53 | , m_ShouldExit(false) |
| 54 | , m_SaveCachedNetwork(false) |
Matthew Sloyan | cd639c9 | 2021-02-11 16:57:38 +0000 | [diff] [blame] | 55 | , m_NumberOfThreads(0) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 56 | { |
| 57 | } |
| 58 | |
| 59 | DriverOptions::DriverOptions(int argc, char** argv) |
Nattapat Chaimanowong | d5fd976 | 2019-04-04 13:33:10 +0100 | [diff] [blame] | 60 | : m_VerboseLogging(false) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 61 | , m_ClTunedParametersMode(armnn::IGpuAccTunedParameters::Mode::UseTunedParameters) |
Ruomei Yan | 689c6ee | 2019-04-25 17:48:41 +0100 | [diff] [blame] | 62 | , m_ClTuningLevel(armnn::IGpuAccTunedParameters::TuningLevel::Rapid) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 63 | , m_EnableGpuProfiling(false) |
| 64 | , m_fp16Enabled(false) |
Mike Kelly | 7ed56dd | 2020-09-30 20:22:56 +0100 | [diff] [blame] | 65 | , m_FastMathEnabled(false) |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 66 | , m_ShouldExit(false) |
Sadik Armagan | f36e10b | 2021-01-11 16:34:01 +0000 | [diff] [blame] | 67 | , m_SaveCachedNetwork(false) |
Matthew Sloyan | cd639c9 | 2021-02-11 16:57:38 +0000 | [diff] [blame] | 68 | , m_NumberOfThreads(0) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 69 | { |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 70 | std::string unsupportedOperationsAsString; |
| 71 | std::string clTunedParametersModeAsString; |
Ruomei Yan | 689c6ee | 2019-04-25 17:48:41 +0100 | [diff] [blame] | 72 | std::string clTuningLevelAsString; |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 73 | std::vector<std::string> backends; |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 74 | bool showHelp; |
| 75 | bool showVersion; |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 76 | |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 77 | cxxopts::Options optionsDesc(argv[0], "ArmNN Android NN driver for the Android Neural Networks API. The Android NN " |
| 78 | "driver will convert Android NNAPI requests and delegate them to available " |
| 79 | "ArmNN backends."); |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 80 | try |
| 81 | { |
| 82 | optionsDesc.add_options() |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 83 | |
| 84 | ("a,enable-fast-math", "Enables fast_math options in backends that support it. Using the fast_math flag can " |
| 85 | "lead to performance improvements but may result in reduced or different precision.", |
| 86 | cxxopts::value<bool>(m_FastMathEnabled)->default_value("false")) |
| 87 | |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 88 | ("c,compute", |
| 89 | "Comma separated list of backends to run layers on. Examples of possible values are: CpuRef, CpuAcc, GpuAcc", |
| 90 | cxxopts::value<std::vector<std::string>>(backends)) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 91 | |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 92 | ("d,request-inputs-and-outputs-dump-dir", |
| 93 | "If non-empty, the directory where request inputs and outputs should be dumped", |
| 94 | cxxopts::value<std::string>(m_RequestInputsAndOutputsDumpDir)->default_value("")) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 95 | |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 96 | ("f,fp16-enabled", "Enables support for relaxed computation from Float32 to Float16", |
| 97 | cxxopts::value<bool>(m_fp16Enabled)->default_value("false")) |
Kevin May | abc95d0 | 2020-05-15 15:34:03 +0100 | [diff] [blame] | 98 | |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 99 | ("h,help", "Show this help", |
| 100 | cxxopts::value<bool>(showHelp)->default_value("false")) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 101 | |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 102 | ("m,cl-tuned-parameters-mode", |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 103 | "If 'UseTunedParameters' (the default), will read CL tuned parameters from the file specified by " |
| 104 | "--cl-tuned-parameters-file. " |
| 105 | "If 'UpdateTunedParameters', will also find the optimum parameters when preparing new networks and update " |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 106 | "the file accordingly.", |
| 107 | cxxopts::value<std::string>(clTunedParametersModeAsString)->default_value("UseTunedParameters")) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 108 | |
Finn Williams | f5ca16c | 2021-02-12 14:26:23 +0000 | [diff] [blame] | 109 | ("g,mlgo-cl-tuned-parameters-file", |
| 110 | "If non-empty, the given file will be used to load/save MLGO CL tuned parameters. ", |
| 111 | cxxopts::value<std::string>(m_ClMLGOTunedParametersFile)->default_value("")) |
| 112 | |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 113 | ("n,service-name", |
| 114 | "If non-empty, the driver service name to be registered", |
| 115 | cxxopts::value<std::string>(m_ServiceName)->default_value("armnn")) |
| 116 | |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 117 | ("o,cl-tuning-level", |
Ruomei Yan | 689c6ee | 2019-04-25 17:48:41 +0100 | [diff] [blame] | 118 | "exhaustive: all lws values are tested " |
| 119 | "normal: reduced number of lws values but enough to still have the performance really close to the " |
| 120 | "exhaustive approach " |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 121 | "rapid: only 3 lws values should be tested for each kernel ", |
| 122 | cxxopts::value<std::string>(clTuningLevelAsString)->default_value("rapid")) |
Ruomei Yan | 689c6ee | 2019-04-25 17:48:41 +0100 | [diff] [blame] | 123 | |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 124 | ("p,gpu-profiling", "Turns GPU profiling on", |
| 125 | cxxopts::value<bool>(m_EnableGpuProfiling)->default_value("false")) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 126 | |
Sadik Armagan | f36e10b | 2021-01-11 16:34:01 +0000 | [diff] [blame] | 127 | ("q,cached-network-file", "If non-empty, the given file will be used to load/save cached network. " |
| 128 | "If save-cached-network option is given will save the cached network to given file." |
| 129 | "If save-cached-network option is not given will load the cached network from given " |
| 130 | "file.", |
| 131 | cxxopts::value<std::string>(m_CachedNetworkFilePath)->default_value("")) |
| 132 | |
| 133 | ("s,save-cached-network", "Enables saving the cached network to the file given with cached-network-file option." |
| 134 | " See also --cached-network-file", |
| 135 | cxxopts::value<bool>(m_SaveCachedNetwork)->default_value("false")) |
| 136 | |
Matthew Sloyan | cd639c9 | 2021-02-11 16:57:38 +0000 | [diff] [blame] | 137 | ("number-of-threads", |
| 138 | "Assign the number of threads used by the CpuAcc backend. " |
| 139 | "Input value must be between 1 and 64. " |
| 140 | "Default is set to 0 (Backend will decide number of threads to use).", |
| 141 | cxxopts::value<unsigned int>(m_NumberOfThreads)->default_value("0")) |
| 142 | |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 143 | ("t,cl-tuned-parameters-file", |
| 144 | "If non-empty, the given file will be used to load/save CL tuned parameters. " |
| 145 | "See also --cl-tuned-parameters-mode", |
| 146 | cxxopts::value<std::string>(m_ClTunedParametersFile)->default_value("")) |
| 147 | |
| 148 | ("u,unsupported-operations", |
| 149 | "If non-empty, a comma-separated list of operation indices which the driver will forcibly " |
| 150 | "consider unsupported", |
| 151 | cxxopts::value<std::string>(unsupportedOperationsAsString)->default_value("")) |
| 152 | |
| 153 | ("v,verbose-logging", "Turns verbose logging on", |
| 154 | cxxopts::value<bool>(m_VerboseLogging)->default_value("false")) |
| 155 | |
| 156 | ("V,version", "Show version information", |
| 157 | cxxopts::value<bool>(showVersion)->default_value("false")); |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 158 | } |
| 159 | catch (const std::exception& e) |
| 160 | { |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 161 | ALOGE("An error occurred attempting to construct options: %s", e.what()); |
| 162 | std::cout << "An error occurred attempting to construct options: %s" << std::endl; |
| 163 | m_ExitCode = EXIT_FAILURE; |
| 164 | return; |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 165 | } |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 166 | |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 167 | try |
| 168 | { |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 169 | cxxopts::ParseResult result = optionsDesc.parse(argc, argv); |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 170 | } |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 171 | catch (const cxxopts::OptionException& e) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 172 | { |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 173 | ALOGW("An exception occurred attempting to parse program options: %s", e.what()); |
| 174 | std::cout << optionsDesc.help() << std::endl |
| 175 | << "An exception occurred while parsing program options: " << std::endl |
| 176 | << e.what() << std::endl; |
Mike Kelly | c24bb03 | 2020-10-20 15:29:19 +0100 | [diff] [blame] | 177 | m_ShouldExit = true; |
| 178 | m_ExitCode = EXIT_FAILURE; |
| 179 | return; |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 180 | } |
| 181 | if (showHelp) |
| 182 | { |
| 183 | ALOGW("Showing help and exiting"); |
| 184 | std::cout << optionsDesc.help() << std::endl; |
| 185 | m_ShouldExit = true; |
| 186 | m_ExitCode = EXIT_SUCCESS; |
| 187 | return; |
| 188 | } |
| 189 | if (showVersion) |
| 190 | { |
| 191 | ALOGW("Showing version and exiting"); |
| 192 | std::cout << "ArmNN Android NN driver for the Android Neural Networks API.\n" |
| 193 | "ArmNN v" << ARMNN_VERSION << std::endl; |
| 194 | m_ShouldExit = true; |
| 195 | m_ExitCode = EXIT_SUCCESS; |
| 196 | return; |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 197 | } |
| 198 | |
Colm Donelan | 0cc6178 | 2020-10-06 21:02:21 +0100 | [diff] [blame] | 199 | // Convert the string backend names into backendId's. |
Nattapat Chaimanowong | d5fd976 | 2019-04-04 13:33:10 +0100 | [diff] [blame] | 200 | m_Backends.reserve(backends.size()); |
Nattapat Chaimanowong | d5fd976 | 2019-04-04 13:33:10 +0100 | [diff] [blame] | 201 | for (auto&& backend : backends) |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 202 | { |
Mike Kelly | 6df71fd | 2020-10-13 17:50:05 +0100 | [diff] [blame] | 203 | m_Backends.emplace_back(backend); |
| 204 | } |
| 205 | |
| 206 | // If no backends have been specified then the default value is GpuAcc. |
| 207 | if (backends.empty()) |
| 208 | { |
| 209 | ALOGE("No backends have been specified:"); |
| 210 | std::cout << optionsDesc.help() << std::endl |
| 211 | << "Unable to start:" << std::endl |
| 212 | << "No backends have been specified" << std::endl; |
| 213 | m_ShouldExit = true; |
| 214 | m_ExitCode = EXIT_FAILURE; |
| 215 | return; |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 216 | } |
| 217 | |
| 218 | if (!unsupportedOperationsAsString.empty()) |
| 219 | { |
| 220 | std::istringstream argStream(unsupportedOperationsAsString); |
| 221 | |
| 222 | std::string s; |
| 223 | while (!argStream.eof()) |
| 224 | { |
| 225 | std::getline(argStream, s, ','); |
| 226 | try |
| 227 | { |
| 228 | unsigned int operationIdx = std::stoi(s); |
| 229 | m_ForcedUnsupportedOperations.insert(operationIdx); |
| 230 | } |
| 231 | catch (const std::invalid_argument&) |
| 232 | { |
| 233 | ALOGW("Ignoring invalid integer argument in -u/--unsupported-operations value: %s", s.c_str()); |
| 234 | } |
| 235 | } |
| 236 | } |
| 237 | |
| 238 | if (!m_ClTunedParametersFile.empty()) |
| 239 | { |
| 240 | // The mode is only relevant if the file path has been provided |
| 241 | if (clTunedParametersModeAsString == "UseTunedParameters") |
| 242 | { |
| 243 | m_ClTunedParametersMode = armnn::IGpuAccTunedParameters::Mode::UseTunedParameters; |
| 244 | } |
| 245 | else if (clTunedParametersModeAsString == "UpdateTunedParameters") |
| 246 | { |
| 247 | m_ClTunedParametersMode = armnn::IGpuAccTunedParameters::Mode::UpdateTunedParameters; |
| 248 | } |
| 249 | else |
| 250 | { |
| 251 | ALOGW("Requested unknown cl-tuned-parameters-mode '%s'. Defaulting to UseTunedParameters", |
| 252 | clTunedParametersModeAsString.c_str()); |
| 253 | } |
Ruomei Yan | 689c6ee | 2019-04-25 17:48:41 +0100 | [diff] [blame] | 254 | |
| 255 | if (clTuningLevelAsString == "exhaustive") |
| 256 | { |
| 257 | m_ClTuningLevel = armnn::IGpuAccTunedParameters::TuningLevel::Exhaustive; |
| 258 | } |
| 259 | else if (clTuningLevelAsString == "normal") |
| 260 | { |
| 261 | m_ClTuningLevel = armnn::IGpuAccTunedParameters::TuningLevel::Normal; |
| 262 | } |
| 263 | else if (clTuningLevelAsString == "rapid") |
| 264 | { |
| 265 | m_ClTuningLevel = armnn::IGpuAccTunedParameters::TuningLevel::Rapid; |
| 266 | } |
| 267 | else |
| 268 | { |
| 269 | ALOGW("Requested unknown cl-tuner-mode '%s'. Defaulting to rapid", |
| 270 | clTuningLevelAsString.c_str()); |
| 271 | } |
telsoa01 | ce3e84a | 2018-08-31 09:31:35 +0100 | [diff] [blame] | 272 | } |
| 273 | } |
| 274 | |
| 275 | } // namespace armnn_driver |