Compute Library
 21.02
RunExample.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2021 Arm Limited.
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"
25 
26 #define BENCHMARK_EXAMPLES
27 #include "utils/Utils.cpp"
28 
31 #include "tests/framework/Macros.h"
35 
36 #ifdef ARM_COMPUTE_CL
40 #endif /* ARM_COMPUTE_CL */
41 #ifdef ARM_COMPUTE_GC
43 #endif /* ARM_COMPUTE_GC */
44 
45 #include <libgen.h>
46 
47 using namespace arm_compute;
48 using namespace arm_compute::test;
49 
50 namespace
51 {
52 std::string command_line(int argc, char **argv)
53 {
54  std::stringstream ss;
55  for(int i = 0; i < argc; i++)
56  {
57  ss << argv[i] << " ";
58  }
59  return ss.str();
60 }
61 } // namespace
62 namespace arm_compute
63 {
64 namespace utils
65 {
66 static std::unique_ptr<Example> g_example = nullptr;
67 static std::vector<char *> g_example_argv = {};
68 class ExampleTest : public arm_compute::test::framework::TestCase
69 {
70 public:
71  ExampleTest() = default;
72  void do_setup() override
73  {
74  ARM_COMPUTE_ERROR_ON_NULLPTR(g_example.get());
75  _is_setup = g_example->do_setup(g_example_argv.size(), &g_example_argv[0]);
76  }
77  void do_run() override
78  {
79  if(_is_setup)
80  {
81  g_example->do_run();
82  }
83  }
84  void do_teardown() override
85  {
86  if(_is_setup)
87  {
88  g_example->do_teardown();
89  }
90  g_example = nullptr;
91  }
92 
93 private:
94  bool _is_setup{ false };
95 };
96 
97 int run_example(int argc, char **argv, std::unique_ptr<Example> example)
98 {
100  framework::CommonOptions options(parser);
101  auto example_args = parser.add_option<utils::ListOption<std::string>>("example_args");
102  example_args->set_help("Arguments to pass to the example separated by commas (e.g: arg0,arg1,arg2)");
104 
105  parser.parse(argc, argv);
106 
107  if(options.help->is_set() && options.help->value())
108  {
109  parser.print_help(argv[0]);
110  return 0;
111  }
112 
113  std::vector<std::unique_ptr<framework::Printer>> printers = options.create_printers();
114  g_example = std::move(example);
115  g_example_argv.clear();
116  g_example_argv.emplace_back(argv[0]);
117  for(auto &arg : example_args->value())
118  {
119  g_example_argv.emplace_back(const_cast<char *>(arg.c_str())); // NOLINT
120  }
121 
122  if(options.log_level->value() > framework::LogLevel::NONE)
123  {
124  for(auto &p : printers)
125  {
126  p->print_global_header();
127  }
128  }
129 
130 #ifdef ARM_COMPUTE_CL
131  CLGEMMHeuristicsHandle gemm_h;
132  if(opencl_is_available())
133  {
134  auto ctx_dev_err = create_opencl_context_and_device();
135  ARM_COMPUTE_ERROR_ON_MSG(std::get<2>(ctx_dev_err) != CL_SUCCESS, "Failed to create OpenCL context");
137  .default_init_with_context(std::get<1>(ctx_dev_err), std::get<0>(ctx_dev_err), nullptr, &gemm_h);
138  }
139 #endif /* ARM_COMPUTE_CL */
140 
142  {
143  for(auto &p : printers)
144  {
145  p->print_entry("Version", build_information());
146  p->print_entry("CommandLine", command_line(argc, argv));
147 #ifdef ARM_COMPUTE_CL
148  if(opencl_is_available())
149  {
150  p->print_entry("CL_DEVICE_VERSION", CLKernelLibrary::get().get_device_version());
151  }
152  else
153  {
154  p->print_entry("CL_DEVICE_VERSION", "Unavailable");
155  }
156 #endif /* ARM_COMPUTE_CL */
157  p->print_entry("Iterations", support::cpp11::to_string(options.iterations->value()));
158  }
159  }
160 
161  // Initialize framework
163  fconfig.instruments = options.instruments->value();
164  fconfig.num_iterations = options.iterations->value();
165  fconfig.log_level = options.log_level->value();
166  framework.init(fconfig);
167 
168  for(auto &p : printers)
169  {
170  framework.add_printer(p.get());
171  }
172  framework.set_throw_errors(options.throw_errors->value());
174 
175 #ifdef BARE_METAL
177 #else /* BARE_METAL */
179 #endif /* BARE_METAL */
180  //func(argc, argv);
181  bool success = framework.run();
182  if(options.log_level->value() > framework::LogLevel::NONE)
183  {
184  for(auto &p : printers)
185  {
186  p->print_global_footer();
187  }
188  }
189 
190  return (success ? 0 : 1);
191 }
192 
193 } // namespace utils
194 } // namespace arm_compute
Framework configuration structure.
Definition: Framework.h:57
arm_compute::utils::ToggleOption * help
Show help option.
Definition: CommonOptions.h:74
int run_example(int argc, char **argv, std::unique_ptr< ValidateExample > example)
Run an example and handle the potential exceptions it throws.
Definition: RunExample.cpp:112
int num_iterations
Number of iterations per test.
Definition: Framework.h:63
static CLScheduler & get()
Access the scheduler singleton.
void default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner=nullptr, CLGEMMHeuristicsHandle *gemm_h=nullptr)
Initialises the scheduler with context and device provided by the user.
std::string to_string(T &&value)
Convert integer and float values to string.
void set_throw_errors(bool throw_errors)
Set whether errors are caught or thrown by the framework.
Definition: Framework.cpp:263
const std::vector< T > & value() const
Get the values of the option.
void add_test_case(std::string test_name, DatasetMode mode, TestCaseFactory::Status status)
Add a test case to the framework.
Definition: Framework.h:356
std::stringstream ss(mlgo_str)
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
std::tuple< cl::Context, cl::Device, cl_int > create_opencl_context_and_device()
This function creates an OpenCL context and a device.
Definition: CLHelpers.cpp:89
Class to parse command line arguments.
Copyright (c) 2017-2021 Arm Limited.
Implementation of an option that accepts any number of values.
Definition: ListOption.h:41
static Framework & get()
Access to the singleton.
Definition: Framework.cpp:124
T * add_option(const std::string &name, As &&... args)
Function to add a new option to the parser.
Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
LogLevel log_level
Verbosity of the output.
Definition: Framework.h:65
bool run()
Run all enabled test cases.
Definition: Framework.cpp:540
void parse(int argc, char **argv)
Parses the command line arguments and updates the options accordingly.
std::vector< framework::InstrumentsDescription > instruments
Instrument types that will be used for benchmarking.
Definition: Framework.h:59
std::vector< std::unique_ptr< Printer > > create_printers()
Create the printers based on parsed command line options.
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
const T & value() const
Get the option value.
Definition: SimpleOption.h:112
Abstract test case class.
Definition: TestCase.h:40
Helper class to statically begin and end a test suite.
Definition: Registrars.h:66
arm_compute::utils::SimpleOption< int > * iterations
Number of iterations option.
Definition: CommonOptions.h:76
arm_compute::utils::EnumListOption< InstrumentsDescription > * instruments
Instruments option.
Definition: CommonOptions.h:75
Handle for loading and retrieving GEMM heuristics.
arm_compute::utils::EnumOption< LogLevel > * log_level
Logging level option.
Definition: CommonOptions.h:79
std::string build_information()
Returns the arm_compute library build information.
Interface to enqueue GLES kernels and get/set the GLES CommandQueue.
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
void add_printer(Printer *printer)
Set the printer used for the output of test results.
Definition: Framework.cpp:668
bool is_set() const
Has a value been assigned to the option?
Definition: Option.h:135
void print_help(const std::string &program_name) const
Prints a help message for all configured options.
const T & value() const
Get the selected value.
Common command line options used to configure the framework.
Definition: CommonOptions.h:54
void set_help(std::string help)
Set the help message for the option.
Definition: Option.h:125
void init(const FrameworkConfig &config)
Init the framework.
Definition: Framework.cpp:130
bool opencl_is_available()
Check if OpenCL is available.
Definition: OpenCL.cpp:152
arm_compute::utils::ToggleOption * throw_errors
Throw errors option.
Definition: CommonOptions.h:80