2 * Copyright (c) 2017-2018 ARM Limited.
4 * SPDX-License-Identifier: MIT
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:
13 * The above copyright notice and this permission notice shall be included in all
14 * copies or substantial portions of the Software.
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
24 #include "arm_compute/runtime/CL/CLTuner.h"
26 #include "arm_compute/core/CL/ICLKernel.h"
27 #include "arm_compute/core/Error.h"
28 #include "arm_compute/runtime/CL/CLScheduler.h"
36 using namespace arm_compute;
40 /* Function to be used to intercept kernel enqueues and store their OpenCL Event */
44 explicit Interceptor(CLTuner &tuner);
46 /** clEnqueueNDRangeKernel interface
48 * @param[in] command_queue A valid command-queue. The kernel will be queued for execution on the device associated with command_queue.
49 * @param[in] kernel A valid kernel object. The OpenCL context associated with kernel and command_queue must be the same.
50 * @param[in] work_dim The number of dimensions used to specify the global work-items and work-items in the work-group. work_dim must be greater than zero and less than or equal to CL_DEVICE_MAX_WORK_ITEM_DIMENSIONS.
51 * @param[in] gwo Global-Workgroup-Offset. It can be used to specify an array of work_dim unsigned values that describe the offset used to calculate the global ID of a work-item. If global_work_offset is NULL, the global IDs start at offset (0, 0, ... 0).
52 * @param[in] gws Global-Workgroup-Size. Points to an array of work_dim unsigned values that describe the number of global work-items in work_dim dimensions that will execute the kernel function.
53 * @param[in] lws Local-Workgroup-Size. Points to an array of work_dim unsigned values that describe the number of work-items that make up a work-group
54 * @param[in] num_events_in_wait_list Number of events in the waiting list
55 * @param[in] event_wait_list Event waiting list
56 * @param[in] event OpenCL kernel event
58 * @return the OpenCL status
60 cl_int operator()(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,
61 const cl_event *event_wait_list, cl_event *event);
67 Interceptor::Interceptor(CLTuner &tuner)
72 cl_int Interceptor::operator()(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,
73 const cl_event *event_wait_list, cl_event *event)
75 ARM_COMPUTE_ERROR_ON_MSG(event != nullptr, "Not supported");
76 ARM_COMPUTE_UNUSED(event);
77 if(_tuner.kernel_event_is_set())
79 // 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.
83 cl_int retval = _tuner.real_clEnqueueNDRangeKernel(command_queue, kernel, work_dim, gwo, gws, lws, num_events_in_wait_list, event_wait_list, &tmp);
86 _tuner.set_cl_kernel_event(tmp);
93 CLTuner::CLTuner(bool tune_new_kernels)
94 : real_clEnqueueNDRangeKernel(nullptr), _lws_table(), _queue(), _queue_profiler(), _kernel_event(), _tune_new_kernels(tune_new_kernels)
98 bool CLTuner::kernel_event_is_set() const
100 return _kernel_event() != nullptr;
102 void CLTuner::set_cl_kernel_event(cl_event kernel_event)
104 _kernel_event = kernel_event;
107 void CLTuner::set_tune_new_kernels(bool tune_new_kernels)
109 _tune_new_kernels = tune_new_kernels;
111 bool CLTuner::tune_new_kernels() const
113 return _tune_new_kernels;
116 void CLTuner::tune_kernel(ICLKernel &kernel)
118 // Get the configuration ID from the kernel
119 const std::string &config_id = kernel.config_id();
121 // Check if we need to find the Optimal LWS. If config_id is equal to default_config_id, the kernel does not require to be tuned
122 if(config_id != arm_compute::default_config_id)
124 auto p = _lws_table.find(config_id);
126 if(p == _lws_table.end())
128 if(_tune_new_kernels)
130 // Find the optimal LWS for the kernel
131 cl::NDRange opt_lws = find_optimal_lws(kernel);
133 // Insert the optimal LWS in the table
134 add_lws_to_table(config_id, opt_lws);
136 // Set Local-Workgroup-Size
137 kernel.set_lws_hint(opt_lws);
142 // Set Local-Workgroup-Size
143 kernel.set_lws_hint(p->second);
148 void CLTuner::add_lws_to_table(const std::string &kernel_id, cl::NDRange optimal_lws)
150 _lws_table.emplace(kernel_id, optimal_lws);
153 cl::NDRange CLTuner::find_optimal_lws(ICLKernel &kernel)
155 if(real_clEnqueueNDRangeKernel == nullptr)
157 real_clEnqueueNDRangeKernel = CLSymbols::get().clEnqueueNDRangeKernel_ptr;
159 // Get the default queue
160 _queue = CLScheduler::get().queue();
162 // Check if we can use the OpenCL timer with the default queue
163 cl_command_queue_properties props = _queue.getInfo<CL_QUEUE_PROPERTIES>();
165 if((props & CL_QUEUE_PROFILING_ENABLE) == 0)
167 // Set the queue for profiling
168 _queue_profiler = cl::CommandQueue(CLScheduler::get().context(), props | CL_QUEUE_PROFILING_ENABLE);
172 _queue_profiler = _queue;
175 // Start intercepting enqueues:
176 CLSymbols::get().clEnqueueNDRangeKernel_ptr = Interceptor(*this);
178 cl_ulong min_exec_time = std::numeric_limits<cl_ulong>::max();
180 cl::NDRange opt_lws = cl::NullRange;
182 const int x_step = std::max(1, kernel.window().x().step());
183 const int y_step = std::max(1, kernel.window().y().step());
184 const int z_step = std::max(1, kernel.window().z().step());
185 const int x_end = kernel.window().x().end() - kernel.window().x().start() / x_step > 1 ? 16 : 1;
186 const int y_end = kernel.window().y().end() - kernel.window().y().start() / y_step > 1 ? 16 : 1;
187 const int z_end = kernel.window().z().end() - kernel.window().z().start() / z_step > 1 ? 8 : 1;
189 // First run using the default LWS
191 cl::NDRange lws_test = cl::NullRange;
193 kernel.set_lws_hint(lws_test);
196 kernel.run(kernel.window(), _queue_profiler);
198 _queue_profiler.finish();
200 const cl_ulong start = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_START>();
201 const cl_ulong end = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_END>();
202 const cl_ulong diff = end - start;
203 _kernel_event = nullptr;
205 min_exec_time = diff;
208 for(int z = 1; z <= z_end; ++z)
210 for(int y = 1; y <= y_end; ++y)
212 for(int x = 1; x <= x_end; ++x)
214 cl::NDRange lws_test = cl::NDRange(x, y, z);
216 const bool invalid_lws = (x * y * z > static_cast<int>(kernel.get_max_workgroup_size())) || (x == 1 && y == 1 && z == 1);
223 //Set the Local-Workgroup-Size
224 kernel.set_lws_hint(lws_test);
227 kernel.run(kernel.window(), _queue_profiler);
229 _queue_profiler.finish();
231 const cl_ulong start = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_START>();
232 const cl_ulong end = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_END>();
233 const cl_ulong diff = end - start;
234 _kernel_event = nullptr;
236 // Check the execution time
237 if(diff < min_exec_time)
239 min_exec_time = diff;
240 opt_lws = cl::NDRange(x, y, z);
246 // Restore real function
247 CLSymbols::get().clEnqueueNDRangeKernel_ptr = real_clEnqueueNDRangeKernel;
252 void CLTuner::import_lws_table(const std::unordered_map<std::string, cl::NDRange> &lws_table)
255 _lws_table = lws_table;
258 const std::unordered_map<std::string, cl::NDRange> &CLTuner::lws_table() const
263 void CLTuner::load_from_file(const std::string &filename)
266 fs.exceptions(std::ifstream::badbit);
267 fs.open(filename, std::ios::in);
270 ARM_COMPUTE_ERROR("Failed to open '%s' (%s [%d])", filename.c_str(), strerror(errno), errno);
273 while(!std::getline(fs, line).fail())
275 std::istringstream ss(line);
277 if(std::getline(ss, token, ';').fail())
279 ARM_COMPUTE_ERROR("Malformed row '%s' in %s (Should be of the form 'kernel_id;lws[0];lws[1];lws[2]')", ss.str().c_str(), filename.c_str());
281 std::string kernel_id = token;
282 cl::NDRange lws(1, 1, 1);
283 for(int i = 0; i < 3; i++)
285 if(std::getline(ss, token, ';').fail())
287 ARM_COMPUTE_ERROR("Malformed row '%s' in %s (Should be of the form 'kernel_id;lws[0];lws[1];lws[2]')", ss.str().c_str(), filename.c_str());
289 lws.get()[i] = support::cpp11::stoi(token);
292 // If all dimensions are 0: reset to NullRange (i.e nullptr)
293 if(lws[0] == 0 && lws[1] == 0 && lws[2] == 0)
297 add_lws_to_table(kernel_id, lws);
302 void CLTuner::save_to_file(const std::string &filename) const
305 fs.exceptions(std::ifstream::failbit | std::ifstream::badbit);
306 fs.open(filename, std::ios::out);
307 for(auto kernel_data : _lws_table)
309 fs << kernel_data.first << ";" << kernel_data.second[0] << ";" << kernel_data.second[1] << ";" << kernel_data.second[2] << std::endl;