Compute Library
 23.05
CLTuner.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2023 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  */
26 
27 #include "arm_compute/core/Error.h"
29 #include "src/common/utils/Log.h"
30 #include "src/core/CL/ICLKernel.h"
31 #include "support/StringSupport.h"
32 
33 #include <cerrno>
34 #include <fstream>
35 #include <limits>
36 
37 namespace arm_compute
38 {
39 CLTuner::CLTuner(bool tune_new_kernels, CLTuningInfo tuning_info)
40  : real_clEnqueueNDRangeKernel(nullptr), _tuning_params_table(), _lws_table(), _kernel_event(), _tune_new_kernels(tune_new_kernels), _tuning_info(tuning_info)
41 {
42 }
43 
44 struct CLTuner::IKernelData
45 {
46  virtual ~IKernelData() = default;
47  virtual void do_run(ICLKernel &kernel, cl::CommandQueue &queue) = 0;
48 };
49 struct DefaultKernelData : public CLTuner::IKernelData
50 {
51  DefaultKernelData(ITensorPack &tensors)
52  : _tensors{ tensors }
53  {
54  }
55  ~DefaultKernelData() override = default;
56  void do_run(ICLKernel &kernel, cl::CommandQueue &queue) override
57  {
58  const bool inject_memory = !_tensors.empty();
59  inject_memory ? kernel.run_op(_tensors, kernel.window(), queue) : kernel.run(kernel.window(), queue);
60  }
61 
62 private:
63  ITensorPack &_tensors;
64 };
65 
67 {
68  return _kernel_event() != nullptr;
69 }
70 void CLTuner::set_cl_kernel_event(cl_event kernel_event)
71 {
72  _kernel_event = kernel_event;
73 }
74 
76 {
77  _tune_new_kernels = tune_new_kernels;
78 }
80 {
81  return _tune_new_kernels;
82 }
83 
85 {
86  _tuning_info.tuner_mode = mode;
87 }
88 
90 {
91  ARM_COMPUTE_UNUSED(kernel);
92 }
93 
95 {
97  tune_kernel_dynamic(kernel, pack);
98 }
99 
100 void CLTuner::do_tune_kernel_dynamic(ICLKernel &kernel, IKernelData *data)
101 {
102  // Get the configuration ID from the kernel and append GPU target name and number of available compute units
103  const std::string config_id = kernel.config_id() + "_" + string_from_target(kernel.get_target()) + "_MP" + support::cpp11::to_string(CLKernelLibrary::get().get_num_compute_units());
104 
105  // Check if we need to find the Optimal LWS. If the kernel's config_id is equal to default_config_id, the kernel does not require to be tuned
106  if(kernel.config_id() != arm_compute::default_config_id)
107  {
108  auto p = _tuning_params_table.find(config_id);
109 
110  if(p == _tuning_params_table.end())
111  {
112  if(_tune_new_kernels)
113  {
114  // Find the optimal LWS for the kernel
115  CLTuningParams opt_tuning_params = find_optimal_tuning_params(kernel, data);
116 
117  // Insert the optimal LWS in the table
118  add_tuning_params(config_id, opt_tuning_params);
119 
120  // Set Local-Workgroup-Size
121  kernel.set_lws_hint(opt_tuning_params.get_lws());
122  if(_tuning_info.tune_wbsm)
123  {
124  kernel.set_wbsm_hint(opt_tuning_params.get_wbsm());
125  }
126  }
127  }
128  else
129  {
130  // Set Local-Workgroup-Size
131  kernel.set_lws_hint(p->second.get_lws());
132  if(_tuning_info.tune_wbsm)
133  {
134  kernel.set_wbsm_hint(p->second.get_wbsm());
135  }
136  }
137  }
138 }
140 {
141  DefaultKernelData data{ tensors };
142 
143  do_tune_kernel_dynamic(kernel, &data);
144 }
145 
146 void CLTuner::add_tuning_params(const std::string &kernel_id, CLTuningParams optimal_tuning_params)
147 {
148  _tuning_params_table.emplace(kernel_id, optimal_tuning_params);
149 }
150 
151 CLTuningParams CLTuner::find_optimal_tuning_params(ICLKernel &kernel, IKernelData *data)
152 {
153  // Profiling queue
154  cl::CommandQueue queue_profiler;
155 
156  // Extract real OpenCL function to intercept
157  if(real_clEnqueueNDRangeKernel == nullptr)
158  {
160  }
161 
162  // Get the default queue
163  cl::CommandQueue default_queue = CLScheduler::get().queue();
164 
165  // Check if we can use the OpenCL timer with the default queue
166  cl_command_queue_properties props = default_queue.getInfo<CL_QUEUE_PROPERTIES>();
167 
168  if((props & CL_QUEUE_PROFILING_ENABLE) == 0)
169  {
170  // Set the queue for profiling
171  queue_profiler = cl::CommandQueue(CLScheduler::get().context(), props | CL_QUEUE_PROFILING_ENABLE);
172  }
173  else
174  {
175  queue_profiler = default_queue;
176  }
177 
178  // Start intercepting enqueues:
179  auto interceptor = [this](cl_command_queue command_queue, cl_kernel kernel, cl_uint work_dim, const size_t *gwo, const size_t *gws, const size_t *lws, cl_uint num_events_in_wait_list,
180  const cl_event * event_wait_list, cl_event * event)
181  {
182  if(this->kernel_event_is_set())
183  {
184  // If the event is already set it means the kernel enqueue is sliced: given that we only time the first slice we can save time by skipping the other enqueues.
185  return CL_SUCCESS;
186  }
187  cl_event tmp;
188  cl_int retval = this->real_clEnqueueNDRangeKernel(command_queue, kernel, work_dim, gwo, gws, lws, num_events_in_wait_list, event_wait_list, &tmp);
189 
190  // Set OpenCL event
191  this->set_cl_kernel_event(tmp);
192 
193  if(event != nullptr)
194  {
195  //return cl_event from the intercepted call
196  clRetainEvent(tmp);
197  *event = tmp;
198  }
199  return retval;
200  };
202 
203  // Run the kernel with default lws to be used as baseline
204  data->do_run(kernel, queue_profiler);
205 
206  /// Get the cached gws used by the kernel
207  /// NOTE: The window configured inside configure() is usually changed in run(). Thus we should not calculate gws
208  /// from this static window. Instead we get the real gws used (and cached) by run() in the previous step.
209  /// This is only a temporary workaround. An ideal solution involves decoupling the execution window from run() / run_op()
210  /// Please see COMPMID-5934
211  cl::NDRange gws = kernel.get_cached_gws();
213  "[CLTuner] Kernel with config_id '%s' uses %s as the upper-bound for lws search",
214  kernel.config_id().c_str(), to_string(gws).c_str());
215 
216  queue_profiler.finish();
217 
218  const cl_ulong start = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_START>();
219  const cl_ulong end = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_END>();
220  cl_ulong min_exec_time = end - start;
221  _kernel_event = nullptr;
222 
223  CLTuningParams opt_tuning_params(cl::NullRange, 0);
224 
225  // Construct the list of tuning parameters values to be tested based on the tuner mode.
226  auto tuning_list = cl_tuner::get_tuning_parameters_list(_tuning_info, gws);
227  for(size_t i = 0; i < tuning_list->size(); ++i)
228  {
229  CLTuningParams tuning_test = (*tuning_list)[i];
230  // Setting the lws
231  cl::NDRange lws_test = tuning_test.get_lws();
232  auto x = lws_test[0];
233  auto y = lws_test[1];
234  auto z = lws_test[2];
235  const bool invalid_lws = (x * y * z > kernel.get_max_workgroup_size()) || (x == 1 && y == 1 && z == 1);
236 
237  if(invalid_lws)
238  {
239  continue;
240  }
241 
242  kernel.set_lws_hint(lws_test);
243  if(_tuning_info.tune_wbsm && CLKernelLibrary::get().is_wbsm_supported())
244  {
245  cl_int wbsm_test = tuning_test.get_wbsm();
246  kernel.set_wbsm_hint(wbsm_test);
247  }
249  "[CLTuner] Trying LWS: %s, WBSM: %d",
250  to_string(kernel.lws_hint()).c_str(), kernel.wbsm_hint());
251 
252  // Run the kernel
253  data->do_run(kernel, queue_profiler);
254 
255  queue_profiler.finish();
256 
257  const cl_ulong start = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_START>();
258  const cl_ulong end = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_END>();
259  const cl_ulong diff = end - start;
260  _kernel_event = nullptr;
261 
262  // Check the execution time
263  if(diff < min_exec_time)
264  {
265  min_exec_time = diff;
266  opt_tuning_params.set_lws(tuning_test.get_lws());
267  if(_tuning_info.tune_wbsm)
268  {
269  opt_tuning_params.set_wbsm(tuning_test.get_wbsm());
270  }
271  }
272  }
273 
274  // Restore real function
276  return opt_tuning_params;
277 }
278 
279 const std::unordered_map<std::string, CLTuningParams> &CLTuner::tuning_params_table() const
280 {
281  return _tuning_params_table;
282 }
283 
284 void CLTuner::import_tuning_params(const std::unordered_map<std::string, CLTuningParams> &tuning_params_table)
285 {
286  _tuning_params_table.clear();
287  _tuning_params_table = tuning_params_table;
288 }
289 
290 void CLTuner::load_from_file(const std::string &filename)
291 {
292  std::ifstream fs;
293  fs.exceptions(std::ifstream::badbit);
294  fs.open(filename, std::ios::in);
295  if(!fs.is_open())
296  {
297  ARM_COMPUTE_ERROR_VAR("Failed to open '%s' (%s [%d])", filename.c_str(), strerror(errno), errno);
298  }
299  std::string line;
300  bool header_line = true;
301  while(!std::getline(fs, line).fail())
302  {
303  if(header_line)
304  {
305  header_line = false;
306  size_t pos_lws = line.find("lws");
307  size_t pos_wbsm = line.find("wbsm");
308  _tuning_info.tune_wbsm = false;
309  if(pos_lws != std::string::npos || pos_wbsm != std::string::npos)
310  {
311  // The file has in the first line the parameters it has been tuned on
312  if(pos_wbsm != std::string::npos)
313  {
314  _tuning_info.tune_wbsm = true;
315  }
316  // Once the line with the tuning parameter is read we can
317  // read the next one to start collecting the values
318  if(std::getline(fs, line).fail())
319  {
320  break;
321  }
322  }
323  }
324 
325  CLTuningParams tuning_params;
326  size_t pos = line.find(";");
327  if(pos == std::string::npos)
328  {
329  ARM_COMPUTE_ERROR_VAR("Malformed row '%s' in %s", line.c_str(), filename.c_str());
330  }
331  std::string kernel_id = line.substr(0, pos);
332  line.erase(0, pos + 1);
333  if(!tuning_params.from_string(_tuning_info, line))
334  {
335  ARM_COMPUTE_ERROR_VAR("Malformed row '%s' in %s", line.c_str(), filename.c_str());
336  }
337  add_tuning_params(kernel_id, tuning_params);
338  }
339  fs.close();
340 }
341 
342 bool CLTuner::save_to_file(const std::string &filename) const
343 {
344  if(!_tune_new_kernels || _tuning_params_table.empty() || filename.empty())
345  {
346  return false;
347  }
348  std::ofstream fs;
349  fs.exceptions(std::ifstream::failbit | std::ifstream::badbit);
350  fs.open(filename, std::ios::out);
351  std::string header_string = "";
352  header_string += "lws";
353  if(_tuning_info.tune_wbsm)
354  {
355  if(!header_string.empty())
356  {
357  header_string += " ";
358  }
359  header_string += "wbsm";
360  }
361  fs << header_string << std::endl;
362  for(auto const &kernel_data : _tuning_params_table)
363  {
364  CLTuningParams tun_pams(kernel_data.second);
365  fs << kernel_data.first << tun_pams.to_string(_tuning_info) << std::endl;
366  }
367  fs.close();
368  return true;
369 }
370 } // namespace arm_compute
void set_tuner_mode(CLTunerMode mode)
Set OpenCL tuner mode.
Definition: CLTuner.cpp:84
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
void set_cl_kernel_event(cl_event kernel_event)
Set the OpenCL kernel event.
Definition: CLTuner.cpp:70
cl::NDRange get_lws() const
virtual void run(const Window &window, cl::CommandQueue &queue)
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Definition: ICLKernel.h:328
const std::unordered_map< std::string, CLTuningParams > & tuning_params_table() const
Give read access to the tuning params table.
Definition: CLTuner.cpp:279
static CLScheduler & get()
Access the scheduler singleton.
void import_tuning_params(const std::unordered_map< std::string, CLTuningParams > &tuning_params_table)
Import tuning parameters table.
Definition: CLTuner.cpp:284
void tune_kernel_static(ICLKernel &kernel) override
Tune OpenCL kernel statically.
Definition: CLTuner.cpp:89
void tune_kernel_dynamic(ICLKernel &kernel) override
Tune OpenCL kernel dynamically.
Definition: CLTuner.cpp:94
void set_lws_hint(const cl::NDRange &lws_hint)
Set the Local-Workgroup-Size hint.
Definition: ICLKernel.h:361
std::string to_string(T &&value)
Convert integer and float values to string.
void load_from_file(const std::string &filename)
Load the tuning parameters table from file.
Definition: CLTuner.cpp:290
#define ARM_COMPUTE_LOG_MSG_WITH_FORMAT_ACL(log_level, fmt,...)
Log a message with format to the logger.
Definition: Log.h:66
#define ARM_COMPUTE_ERROR_VAR(msg,...)
Print the given message then throw an std::runtime_error.
Definition: Error.h:346
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
< OpenCL tuner parameters
const std::string & string_from_target(GPUTarget target)
Translates a given gpu device target to string.
Definition: GPUTarget.cpp:151
cl_int clRetainEvent(cl_event event)
Definition: OpenCL.cpp:922
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:67
Copyright (c) 2017-2023 Arm Limited.
CLTuner(bool tune_new_kernels=true, CLTuningInfo tuning_info=CLTuningInfo())
Constructor.
Definition: CLTuner.cpp:39
std::function< decltype(clEnqueueNDRangeKernel)> real_clEnqueueNDRangeKernel
clEnqueueNDRangeKernel symbol
Definition: CLTuner.h:106
cl_uint get_num_compute_units()
Return the maximum number of compute units in the device.
void set_lws(cl::NDRange lws)
const std::string & config_id() const
Get the configuration ID.
Definition: ICLKernel.h:407
bool kernel_event_is_set() const
Is the kernel_event set ?
Definition: CLTuner.cpp:66
Interface to enqueue OpenCL kernels and get/set the OpenCL CommandQueue and ICLTuner.
std::function< decltype(clEnqueueNDRangeKernel)> clEnqueueNDRangeKernel_ptr
Definition: OpenCL.h:100
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
bool save_to_file(const std::string &filename) const
Save the content of the tuning parameters table to file.
Definition: CLTuner.cpp:342
void add_tuning_params(const std::string &kernel_id, CLTuningParams optimal_tuning_params)
Manually add tuning parameters for a kernel.
Definition: CLTuner.cpp:146
void set_tune_new_kernels(bool tune_new_kernels)
Setter for tune_new_kernels option.
Definition: CLTuner.cpp:75
GPUTarget get_target() const
Get the targeted GPU architecture.
Definition: ICLKernel.h:431
void set_wbsm(cl_int wbsm)
void end(TokenStream &in, bool &valid)
Definition: MLGOParser.cpp:290
std::string to_string(const T &val)
Fallback method: try to use std::to_string:
Definition: TypePrinter.h:88
cl::CommandQueue & queue()
Accessor for the associated CL command queue.
Definition: CLScheduler.cpp:39
std::string to_string(CLTuningInfo tuning_info)
CLTunerMode
< OpenCL tuner modes
Definition: CLTunerTypes.h:35
Tensor packing service.
Definition: ITensorPack.h:39
std::unique_ptr< ICLTuningParametersList > get_tuning_parameters_list(CLTuningInfo tuning_info, const cl::NDRange &gws)
Construct an ICLTuningParametersList object for the given tuner mode and gws configuration.
void set_wbsm_hint(const cl_int &wbsm_hint)
Set the workgroup batch size modifier hint.
Definition: ICLKernel.h:382
bool tune_new_kernels() const
Tune kernels that are not in the tuning parameters table.
Definition: CLTuner.cpp:79
bool from_string(CLTuningInfo tuning_info, std::string tuning_params_string)
static CLSymbols & get()
Get the static instance of CLSymbols.
Definition: OpenCL.cpp:47
virtual void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
Definition: ICLKernel.h:340