Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 1 | /* |
Gian Marco Iodice | a74923c | 2019-01-31 17:06:54 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2019 ARM Limited. |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [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 "arm_compute/runtime/CL/CLTuner.h" |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 25 | #include "arm_compute/runtime/CL/tuners/CLLWSList.h" |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/CL/ICLKernel.h" |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 28 | #include "arm_compute/core/Error.h" |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 29 | #include "arm_compute/runtime/CL/CLScheduler.h" |
| 30 | |
Anthony Barbier | 317fa7f | 2018-03-01 10:11:22 +0000 | [diff] [blame] | 31 | #include <cerrno> |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 32 | #include <fstream> |
| 33 | #include <iostream> |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 34 | #include <limits> |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 35 | #include <memory> |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 36 | #include <string> |
| 37 | |
Gian Marco Iodice | a74923c | 2019-01-31 17:06:54 +0000 | [diff] [blame] | 38 | namespace arm_compute |
| 39 | { |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 40 | CLTuner::CLTuner(bool tune_new_kernels) |
Michalis Spyrou | 083a069 | 2019-05-13 15:35:50 +0100 | [diff] [blame] | 41 | : real_clEnqueueNDRangeKernel(nullptr), _lws_table(), _kernel_event(), _tune_new_kernels(tune_new_kernels), _tuner_mode(CLTunerMode::NORMAL) |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 42 | { |
| 43 | } |
| 44 | |
Anthony Barbier | f5dcf79 | 2018-02-28 18:04:45 +0000 | [diff] [blame] | 45 | bool CLTuner::kernel_event_is_set() const |
| 46 | { |
| 47 | return _kernel_event() != nullptr; |
| 48 | } |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 49 | void CLTuner::set_cl_kernel_event(cl_event kernel_event) |
| 50 | { |
| 51 | _kernel_event = kernel_event; |
| 52 | } |
| 53 | |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 54 | void CLTuner::set_tune_new_kernels(bool tune_new_kernels) |
| 55 | { |
| 56 | _tune_new_kernels = tune_new_kernels; |
| 57 | } |
Anthony Barbier | 8b81195 | 2018-02-28 13:47:58 +0000 | [diff] [blame] | 58 | bool CLTuner::tune_new_kernels() const |
| 59 | { |
| 60 | return _tune_new_kernels; |
| 61 | } |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 62 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 63 | void CLTuner::set_tuner_mode(CLTunerMode mode) |
| 64 | { |
| 65 | _tuner_mode = mode; |
| 66 | } |
| 67 | CLTunerMode CLTuner::get_tuner_mode() const |
| 68 | { |
| 69 | return _tuner_mode; |
| 70 | } |
| 71 | |
Georgios Pinitas | c0d1c86 | 2018-03-23 15:13:15 +0000 | [diff] [blame] | 72 | void CLTuner::tune_kernel_static(ICLKernel &kernel) |
| 73 | { |
| 74 | ARM_COMPUTE_UNUSED(kernel); |
| 75 | } |
| 76 | |
| 77 | void CLTuner::tune_kernel_dynamic(ICLKernel &kernel) |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 78 | { |
Giorgio Arena | 5d42b46 | 2019-07-26 15:54:20 +0100 | [diff] [blame] | 79 | // Get the configuration ID from the kernel and append GPU target name and number of available compute units |
| 80 | 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()); |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 81 | |
Giorgio Arena | 5d42b46 | 2019-07-26 15:54:20 +0100 | [diff] [blame] | 82 | // 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 |
| 83 | if(kernel.config_id() != arm_compute::default_config_id) |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 84 | { |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 85 | auto p = _lws_table.find(config_id); |
| 86 | |
| 87 | if(p == _lws_table.end()) |
| 88 | { |
| 89 | if(_tune_new_kernels) |
| 90 | { |
| 91 | // Find the optimal LWS for the kernel |
| 92 | cl::NDRange opt_lws = find_optimal_lws(kernel); |
| 93 | |
| 94 | // Insert the optimal LWS in the table |
| 95 | add_lws_to_table(config_id, opt_lws); |
| 96 | |
| 97 | // Set Local-Workgroup-Size |
| 98 | kernel.set_lws_hint(opt_lws); |
| 99 | } |
| 100 | } |
| 101 | else |
| 102 | { |
| 103 | // Set Local-Workgroup-Size |
| 104 | kernel.set_lws_hint(p->second); |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | |
| 109 | void CLTuner::add_lws_to_table(const std::string &kernel_id, cl::NDRange optimal_lws) |
| 110 | { |
| 111 | _lws_table.emplace(kernel_id, optimal_lws); |
| 112 | } |
| 113 | |
| 114 | cl::NDRange CLTuner::find_optimal_lws(ICLKernel &kernel) |
| 115 | { |
Georgios Pinitas | 4632e5e | 2019-02-06 14:47:59 +0000 | [diff] [blame] | 116 | // Profiling queue |
| 117 | cl::CommandQueue queue_profiler; |
| 118 | |
| 119 | // Extract real OpenCL function to intercept |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 120 | if(real_clEnqueueNDRangeKernel == nullptr) |
| 121 | { |
| 122 | real_clEnqueueNDRangeKernel = CLSymbols::get().clEnqueueNDRangeKernel_ptr; |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 123 | } |
Georgios Pinitas | 4632e5e | 2019-02-06 14:47:59 +0000 | [diff] [blame] | 124 | |
| 125 | // Get the default queue |
| 126 | cl::CommandQueue default_queue = CLScheduler::get().queue(); |
| 127 | |
| 128 | // Check if we can use the OpenCL timer with the default queue |
| 129 | cl_command_queue_properties props = default_queue.getInfo<CL_QUEUE_PROPERTIES>(); |
| 130 | |
| 131 | if((props & CL_QUEUE_PROFILING_ENABLE) == 0) |
| 132 | { |
| 133 | // Set the queue for profiling |
| 134 | queue_profiler = cl::CommandQueue(CLScheduler::get().context(), props | CL_QUEUE_PROFILING_ENABLE); |
| 135 | } |
| 136 | else |
| 137 | { |
| 138 | queue_profiler = default_queue; |
| 139 | } |
| 140 | |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 141 | // Start intercepting enqueues: |
Anthony Barbier | 48c19f1 | 2018-04-20 11:31:52 +0100 | [diff] [blame] | 142 | 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, |
| 143 | const cl_event * event_wait_list, cl_event * event) |
| 144 | { |
Anthony Barbier | 48c19f1 | 2018-04-20 11:31:52 +0100 | [diff] [blame] | 145 | if(this->kernel_event_is_set()) |
| 146 | { |
| 147 | // 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. |
| 148 | return CL_SUCCESS; |
| 149 | } |
| 150 | cl_event tmp; |
| 151 | cl_int retval = this->real_clEnqueueNDRangeKernel(command_queue, kernel, work_dim, gwo, gws, lws, num_events_in_wait_list, event_wait_list, &tmp); |
| 152 | |
| 153 | // Set OpenCL event |
| 154 | this->set_cl_kernel_event(tmp); |
| 155 | |
Vidhya Sudhan Loganathan | ca65af3 | 2019-02-07 11:14:42 +0000 | [diff] [blame] | 156 | if(event != nullptr) |
| 157 | { |
| 158 | //return cl_event from the intercepted call |
| 159 | clRetainEvent(tmp); |
| 160 | *event = tmp; |
| 161 | } |
Anthony Barbier | 48c19f1 | 2018-04-20 11:31:52 +0100 | [diff] [blame] | 162 | return retval; |
| 163 | }; |
| 164 | CLSymbols::get().clEnqueueNDRangeKernel_ptr = interceptor; |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 165 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 166 | cl::NDRange gws = ICLKernel::gws_from_window(kernel.window()); |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 167 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 168 | // Run the kernel with default lws to be used as baseline |
| 169 | kernel.run(kernel.window(), queue_profiler); |
| 170 | |
| 171 | queue_profiler.finish(); |
| 172 | |
| 173 | const cl_ulong start = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_START>(); |
| 174 | const cl_ulong end = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_END>(); |
| 175 | cl_ulong min_exec_time = end - start; |
| 176 | _kernel_event = nullptr; |
| 177 | |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 178 | cl::NDRange opt_lws = cl::NullRange; |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 179 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 180 | //Construct the list of LWS values to be tested based on the tuner mode. |
| 181 | auto lws_list = cl_tuner::CLLWSListFactory::get_lws_list(_tuner_mode, gws); |
| 182 | for(size_t i = 0; i < lws_list->size(); ++i) |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 183 | { |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 184 | cl::NDRange lws_test = (*lws_list)[i]; |
| 185 | auto x = lws_test[0]; |
| 186 | auto y = lws_test[1]; |
| 187 | auto z = lws_test[2]; |
Gian Marco Iodice | deaed2d | 2019-05-14 17:11:53 +0100 | [diff] [blame] | 188 | const bool invalid_lws = (x * y * z > kernel.get_max_workgroup_size()) || (x == 1 && y == 1 && z == 1); |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 189 | |
| 190 | if(invalid_lws) |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 191 | { |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 192 | continue; |
| 193 | } |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 194 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 195 | //Set the Local-Workgroup-Size |
| 196 | kernel.set_lws_hint(lws_test); |
Gian Marco Iodice | a74923c | 2019-01-31 17:06:54 +0000 | [diff] [blame] | 197 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 198 | // Run the kernel |
| 199 | kernel.run(kernel.window(), queue_profiler); |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 200 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 201 | queue_profiler.finish(); |
Gian Marco | c78d4bc | 2018-01-25 13:49:44 +0000 | [diff] [blame] | 202 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 203 | const cl_ulong start = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_START>(); |
| 204 | const cl_ulong end = _kernel_event.getProfilingInfo<CL_PROFILING_COMMAND_END>(); |
| 205 | const cl_ulong diff = end - start; |
| 206 | _kernel_event = nullptr; |
Gian Marco Iodice | deaed2d | 2019-05-14 17:11:53 +0100 | [diff] [blame] | 207 | |
Vidhya Sudhan Loganathan | 050471e | 2019-04-25 09:27:24 +0100 | [diff] [blame] | 208 | // Check the execution time |
| 209 | if(diff < min_exec_time) |
| 210 | { |
| 211 | min_exec_time = diff; |
| 212 | opt_lws = cl::NDRange(x, y, z); |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 213 | } |
| 214 | } |
| 215 | |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 216 | // Restore real function |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 217 | CLSymbols::get().clEnqueueNDRangeKernel_ptr = real_clEnqueueNDRangeKernel; |
| 218 | |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 219 | return opt_lws; |
| 220 | } |
| 221 | |
| 222 | void CLTuner::import_lws_table(const std::unordered_map<std::string, cl::NDRange> &lws_table) |
| 223 | { |
| 224 | _lws_table.clear(); |
| 225 | _lws_table = lws_table; |
| 226 | } |
| 227 | |
Anthony Barbier | 8b81195 | 2018-02-28 13:47:58 +0000 | [diff] [blame] | 228 | const std::unordered_map<std::string, cl::NDRange> &CLTuner::lws_table() const |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 229 | { |
| 230 | return _lws_table; |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 231 | } |
| 232 | |
Anthony Barbier | 8b81195 | 2018-02-28 13:47:58 +0000 | [diff] [blame] | 233 | void CLTuner::load_from_file(const std::string &filename) |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 234 | { |
Anthony Barbier | 8b81195 | 2018-02-28 13:47:58 +0000 | [diff] [blame] | 235 | std::ifstream fs; |
Anthony Barbier | f5dcf79 | 2018-02-28 18:04:45 +0000 | [diff] [blame] | 236 | fs.exceptions(std::ifstream::badbit); |
Anthony Barbier | 8b81195 | 2018-02-28 13:47:58 +0000 | [diff] [blame] | 237 | fs.open(filename, std::ios::in); |
Anthony Barbier | 317fa7f | 2018-03-01 10:11:22 +0000 | [diff] [blame] | 238 | if(!fs.is_open()) |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 239 | { |
Michalis Spyrou | 7c60c99 | 2019-10-10 14:33:47 +0100 | [diff] [blame] | 240 | ARM_COMPUTE_ERROR_VAR("Failed to open '%s' (%s [%d])", filename.c_str(), strerror(errno), errno); |
Anthony Barbier | 317fa7f | 2018-03-01 10:11:22 +0000 | [diff] [blame] | 241 | } |
| 242 | std::string line; |
| 243 | while(!std::getline(fs, line).fail()) |
| 244 | { |
| 245 | std::istringstream ss(line); |
| 246 | std::string token; |
| 247 | if(std::getline(ss, token, ';').fail()) |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 248 | { |
Michalis Spyrou | 7c60c99 | 2019-10-10 14:33:47 +0100 | [diff] [blame] | 249 | ARM_COMPUTE_ERROR_VAR("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()); |
Anthony Barbier | 317fa7f | 2018-03-01 10:11:22 +0000 | [diff] [blame] | 250 | } |
| 251 | std::string kernel_id = token; |
| 252 | cl::NDRange lws(1, 1, 1); |
| 253 | for(int i = 0; i < 3; i++) |
| 254 | { |
Anthony Barbier | f5dcf79 | 2018-02-28 18:04:45 +0000 | [diff] [blame] | 255 | if(std::getline(ss, token, ';').fail()) |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 256 | { |
Michalis Spyrou | 7c60c99 | 2019-10-10 14:33:47 +0100 | [diff] [blame] | 257 | ARM_COMPUTE_ERROR_VAR("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()); |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 258 | } |
Anthony Barbier | 317fa7f | 2018-03-01 10:11:22 +0000 | [diff] [blame] | 259 | lws.get()[i] = support::cpp11::stoi(token); |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 260 | } |
Anthony Barbier | 317fa7f | 2018-03-01 10:11:22 +0000 | [diff] [blame] | 261 | |
| 262 | // If all dimensions are 0: reset to NullRange (i.e nullptr) |
| 263 | if(lws[0] == 0 && lws[1] == 0 && lws[2] == 0) |
| 264 | { |
| 265 | lws = cl::NullRange; |
| 266 | } |
| 267 | add_lws_to_table(kernel_id, lws); |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 268 | } |
Anthony Barbier | 317fa7f | 2018-03-01 10:11:22 +0000 | [diff] [blame] | 269 | fs.close(); |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 270 | } |
| 271 | |
Anthony Barbier | 8b81195 | 2018-02-28 13:47:58 +0000 | [diff] [blame] | 272 | void CLTuner::save_to_file(const std::string &filename) const |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 273 | { |
Anthony Barbier | 8b81195 | 2018-02-28 13:47:58 +0000 | [diff] [blame] | 274 | std::ofstream fs; |
| 275 | fs.exceptions(std::ifstream::failbit | std::ifstream::badbit); |
| 276 | fs.open(filename, std::ios::out); |
Michalis Spyrou | bcfd09a | 2019-05-01 13:03:59 +0100 | [diff] [blame] | 277 | for(auto const &kernel_data : _lws_table) |
Anthony Barbier | 8db8318 | 2018-02-27 13:08:00 +0000 | [diff] [blame] | 278 | { |
| 279 | fs << kernel_data.first << ";" << kernel_data.second[0] << ";" << kernel_data.second[1] << ";" << kernel_data.second[2] << std::endl; |
| 280 | } |
| 281 | fs.close(); |
| 282 | } |
Gian Marco Iodice | a74923c | 2019-01-31 17:06:54 +0000 | [diff] [blame] | 283 | } // namespace arm_compute |