Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 1 | /* |
Manuel Bottini | ceaa0bf | 2021-02-16 15:15:19 +0000 | [diff] [blame] | 2 | * Copyright (c) 2018-2021 Arm Limited. |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
| 24 | #include "utils/Utils.h" |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 25 | |
| 26 | #define BENCHMARK_EXAMPLES |
| 27 | #include "utils/Utils.cpp" |
| 28 | |
| 29 | #include "ValidateExample.h" |
Mirko leonardo Serra laban | d828b46 | 2020-11-19 16:22:59 +0000 | [diff] [blame] | 30 | #include "arm_compute/runtime/CL/CLHelpers.h" |
Georgios Pinitas | 40f51a6 | 2020-11-21 03:04:18 +0000 | [diff] [blame] | 31 | #include "arm_compute/runtime/Scheduler.h" |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 32 | #include "tests/AssetsLibrary.h" |
| 33 | #include "tests/Globals.h" |
| 34 | #include "tests/framework/Framework.h" |
| 35 | #include "tests/framework/Macros.h" |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 36 | #include "tests/framework/command_line/CommonOptions.h" |
| 37 | #include "tests/framework/instruments/Instruments.h" |
Georgios Pinitas | 12be7ab | 2018-07-03 12:06:23 +0100 | [diff] [blame] | 38 | #include "utils/command_line/CommandLineParser.h" |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 39 | |
| 40 | #ifdef ARM_COMPUTE_CL |
| 41 | #include "arm_compute/runtime/CL/CLScheduler.h" |
| 42 | #endif /* ARM_COMPUTE_CL */ |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 43 | |
| 44 | #include <libgen.h> |
| 45 | |
| 46 | using namespace arm_compute; |
| 47 | using namespace arm_compute::test; |
| 48 | |
| 49 | namespace arm_compute |
| 50 | { |
| 51 | namespace test |
| 52 | { |
| 53 | std::unique_ptr<AssetsLibrary> library; |
Sang-Hoon Park | 06cf933 | 2020-03-31 15:59:41 +0100 | [diff] [blame] | 54 | static constexpr uint32_t fixed_seed = 1; |
| 55 | std::unique_ptr<AssetsLibrary> fixed_library; |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 56 | } // namespace test |
| 57 | namespace utils |
| 58 | { |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 59 | static std::unique_ptr<ValidateExample> g_example = nullptr; |
| 60 | static std::vector<char *> g_example_argv = {}; |
| 61 | |
Anthony Barbier | 1fa17c2 | 2018-08-23 15:44:20 +0100 | [diff] [blame] | 62 | namespace |
| 63 | { |
| 64 | std::string command_line(int argc, char **argv) |
| 65 | { |
| 66 | std::stringstream ss; |
| 67 | for(int i = 0; i < argc; i++) |
| 68 | { |
| 69 | ss << argv[i] << " "; |
| 70 | } |
| 71 | return ss.str(); |
| 72 | } |
| 73 | |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 74 | template <bool validate> |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 75 | class ExampleTest : public arm_compute::test::framework::TestCase |
| 76 | { |
| 77 | public: |
| 78 | ExampleTest() = default; |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 79 | void do_setup() override |
| 80 | { |
| 81 | ARM_COMPUTE_ERROR_ON_NULLPTR(g_example.get()); |
Anthony Barbier | e88b9bb | 2018-07-12 13:26:27 +0100 | [diff] [blame] | 82 | _is_setup = g_example->do_setup(g_example_argv.size(), &g_example_argv[0]); |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 83 | } |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 84 | void do_run() override |
| 85 | { |
Anthony Barbier | e88b9bb | 2018-07-12 13:26:27 +0100 | [diff] [blame] | 86 | if(_is_setup) |
| 87 | { |
| 88 | g_example->do_run(); |
| 89 | } |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 90 | } |
| 91 | void do_teardown() override |
| 92 | { |
Anthony Barbier | e88b9bb | 2018-07-12 13:26:27 +0100 | [diff] [blame] | 93 | if(_is_setup) |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 94 | { |
Anthony Barbier | e88b9bb | 2018-07-12 13:26:27 +0100 | [diff] [blame] | 95 | if(validate) |
| 96 | { |
| 97 | g_example->do_validate(); |
| 98 | } |
| 99 | g_example->do_teardown(); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 100 | } |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 101 | g_example = nullptr; |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 102 | } |
Anthony Barbier | e88b9bb | 2018-07-12 13:26:27 +0100 | [diff] [blame] | 103 | |
| 104 | private: |
| 105 | bool _is_setup{ false }; |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 106 | }; |
| 107 | |
Anthony Barbier | 1fa17c2 | 2018-08-23 15:44:20 +0100 | [diff] [blame] | 108 | } // namespace |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 109 | int run_example(int argc, char **argv, std::unique_ptr<ValidateExample> example) |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 110 | { |
Georgios Pinitas | 12be7ab | 2018-07-03 12:06:23 +0100 | [diff] [blame] | 111 | utils::CommandLineParser parser; |
| 112 | framework::CommonOptions options(parser); |
| 113 | auto example_args = parser.add_option<utils::ListOption<std::string>>("example_args"); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 114 | example_args->set_help("Arguments to pass to the example separated by commas (e.g: arg0,arg1,arg2)"); |
Georgios Pinitas | 12be7ab | 2018-07-03 12:06:23 +0100 | [diff] [blame] | 115 | auto seed = parser.add_option<utils::SimpleOption<std::random_device::result_type>>("seed", std::random_device()()); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 116 | seed->set_help("Global seed for random number generation"); |
Georgios Pinitas | 12be7ab | 2018-07-03 12:06:23 +0100 | [diff] [blame] | 117 | auto validate = parser.add_option<utils::SimpleOption<int>>("validate", 1); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 118 | validate->set_help("Enable / disable output validation (0/1)"); |
| 119 | |
| 120 | framework::Framework &framework = framework::Framework::get(); |
| 121 | |
| 122 | parser.parse(argc, argv); |
| 123 | |
| 124 | if(options.help->is_set() && options.help->value()) |
| 125 | { |
| 126 | parser.print_help(argv[0]); |
| 127 | return 0; |
| 128 | } |
| 129 | |
| 130 | std::vector<std::unique_ptr<framework::Printer>> printers = options.create_printers(); |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 131 | g_example = std::move(example); |
| 132 | g_example_argv.clear(); |
| 133 | g_example_argv.emplace_back(argv[0]); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 134 | for(auto &arg : example_args->value()) |
| 135 | { |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 136 | g_example_argv.emplace_back(const_cast<char *>(arg.c_str())); // NOLINT |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 137 | } |
| 138 | |
Georgios Pinitas | 40f51a6 | 2020-11-21 03:04:18 +0000 | [diff] [blame] | 139 | library = std::make_unique<AssetsLibrary>("." /* Only using random values */, seed->value()); |
| 140 | fixed_library = std::make_unique<AssetsLibrary>(".", fixed_seed); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 141 | |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 142 | if(options.log_level->value() > framework::LogLevel::NONE) |
| 143 | { |
| 144 | for(auto &p : printers) |
| 145 | { |
| 146 | p->print_global_header(); |
| 147 | } |
| 148 | } |
| 149 | |
Mirko leonardo Serra laban | d828b46 | 2020-11-19 16:22:59 +0000 | [diff] [blame] | 150 | #ifdef ARM_COMPUTE_CL |
| 151 | if(opencl_is_available()) |
| 152 | { |
Michalis Spyrou | 402740d | 2021-04-20 11:26:21 +0100 | [diff] [blame] | 153 | CLBackendType backend_type = CLBackendType::Native; |
Michalis Spyrou | 660eea4 | 2021-04-28 13:29:17 +0100 | [diff] [blame] | 154 | for(auto &arg : example_args->value()) |
Michalis Spyrou | 402740d | 2021-04-20 11:26:21 +0100 | [diff] [blame] | 155 | { |
Michalis Spyrou | 660eea4 | 2021-04-28 13:29:17 +0100 | [diff] [blame] | 156 | if(arg.find("--target=clvk") != std::string::npos) |
| 157 | { |
| 158 | backend_type = CLBackendType::Clvk; |
| 159 | break; |
| 160 | } |
Michalis Spyrou | 402740d | 2021-04-20 11:26:21 +0100 | [diff] [blame] | 161 | } |
| 162 | auto ctx_dev_err = create_opencl_context_and_device(backend_type); |
Mirko leonardo Serra laban | d828b46 | 2020-11-19 16:22:59 +0000 | [diff] [blame] | 163 | ARM_COMPUTE_ERROR_ON_MSG(std::get<2>(ctx_dev_err) != CL_SUCCESS, "Failed to create OpenCL context"); |
| 164 | CLScheduler::get().default_init_with_context(std::get<1>(ctx_dev_err), std::get<0>(ctx_dev_err), nullptr); |
| 165 | } |
| 166 | #endif /* ARM_COMPUTE_CL */ |
| 167 | |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 168 | if(options.log_level->value() >= framework::LogLevel::CONFIG) |
| 169 | { |
| 170 | for(auto &p : printers) |
| 171 | { |
| 172 | p->print_entry("Version", build_information()); |
Anthony Barbier | 1fa17c2 | 2018-08-23 15:44:20 +0100 | [diff] [blame] | 173 | p->print_entry("CommandLine", command_line(argc, argv)); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 174 | p->print_entry("Seed", support::cpp11::to_string(seed->value())); |
| 175 | #ifdef ARM_COMPUTE_CL |
| 176 | if(opencl_is_available()) |
| 177 | { |
| 178 | p->print_entry("CL_DEVICE_VERSION", CLKernelLibrary::get().get_device_version()); |
| 179 | } |
| 180 | else |
| 181 | { |
| 182 | p->print_entry("CL_DEVICE_VERSION", "Unavailable"); |
| 183 | } |
| 184 | #endif /* ARM_COMPUTE_CL */ |
| 185 | p->print_entry("Iterations", support::cpp11::to_string(options.iterations->value())); |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 186 | g_example->print_parameters(*p); |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 187 | } |
| 188 | } |
| 189 | |
Georgios Pinitas | 7f15251 | 2019-12-16 19:59:52 +0000 | [diff] [blame] | 190 | // Initialize framework |
| 191 | framework::FrameworkConfig fconfig; |
| 192 | fconfig.instruments = options.instruments->value(); |
| 193 | fconfig.num_iterations = options.iterations->value(); |
| 194 | fconfig.log_level = options.log_level->value(); |
| 195 | framework.init(fconfig); |
| 196 | |
Anthony Barbier | 979dc4f | 2018-03-07 09:27:48 +0000 | [diff] [blame] | 197 | for(auto &p : printers) |
| 198 | { |
| 199 | framework.add_printer(p.get()); |
| 200 | } |
| 201 | |
| 202 | framework.set_throw_errors(options.throw_errors->value()); |
| 203 | arm_compute::test::framework::detail::TestSuiteRegistrar suite{ "Examples" }; |
| 204 | if(validate->value() != 0) |
| 205 | { |
| 206 | framework.add_test_case<ExampleTest<true>>(basename(argv[0]), framework::DatasetMode::ALL, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE); |
| 207 | } |
| 208 | else |
| 209 | { |
| 210 | framework.add_test_case<ExampleTest<false>>(basename(argv[0]), framework::DatasetMode::ALL, arm_compute::test::framework::TestCaseFactory::Status::ACTIVE); |
| 211 | } |
| 212 | |
| 213 | //func(argc, argv); |
| 214 | bool success = framework.run(); |
| 215 | if(options.log_level->value() > framework::LogLevel::NONE) |
| 216 | { |
| 217 | for(auto &p : printers) |
| 218 | { |
| 219 | p->print_global_footer(); |
| 220 | } |
| 221 | } |
| 222 | |
| 223 | return (success ? 0 : 1); |
| 224 | } |
| 225 | |
| 226 | } // namespace utils |
| 227 | } // namespace arm_compute |