src/runtime/CL/CLTuner.cpp

   1 /*
   2  * Copyright (c) 2017-2018 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 "arm_compute/runtime/CL/CLTuner.h"
  25
  26 #include "arm_compute/core/CL/ICLKernel.h"
  27 #include "arm_compute/core/Error.h"
  28 #include "arm_compute/runtime/CL/CLScheduler.h"
  29
  30 #include <cerrno>
  31 #include <fstream>
  32 #include <iostream>
  33 #include <limits>
  34 #include <string>
  35
  36 using namespace arm_compute;
  37
  38 namespace
  39 {
  40 /* Function to be used to intercept kernel enqueues and store their OpenCL Event */
  41 class Interceptor
  42 {
  43 public:
  44     explicit Interceptor(CLTuner &tuner);
  45
  46     /** clEnqueueNDRangeKernel interface
  47      *
  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
  57      *
  58      * @return the OpenCL status
  59      */
  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);
  62
  63 private:
  64     CLTuner &_tuner;
  65 };
  66
  67 Interceptor::Interceptor(CLTuner &tuner)
  68     : _tuner(tuner)
  69 {
  70 }
  71
  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)
  74 {
  75     ARM_COMPUTE_ERROR_ON_MSG(event != nullptr, "Not supported");
  76     ARM_COMPUTE_UNUSED(event);
  77     if(_tuner.kernel_event_is_set())
  78     {
  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.
  80         return CL_SUCCESS;
  81     }
  82     cl_event tmp;
  83     cl_int   retval = _tuner.real_clEnqueueNDRangeKernel(command_queue, kernel, work_dim, gwo, gws, lws, num_events_in_wait_list, event_wait_list, &tmp);
  84
  85     // Set OpenCL event
  86     _tuner.set_cl_kernel_event(tmp);
  87
  88     return retval;
  89 }
  90
  91 } // namespace
  92
  93 CLTuner::CLTuner(bool tune_new_kernels)
  94     : real_clEnqueueNDRangeKernel(nullptr), _lws_table(), _queue(), _queue_profiler(), _kernel_event(), _tune_new_kernels(tune_new_kernels)
  95 {
  96 }
  97
  98 bool CLTuner::kernel_event_is_set() const
  99 {
 100     return _kernel_event() != nullptr;
 101 }
 102 void CLTuner::set_cl_kernel_event(cl_event kernel_event)
 103 {
 104     _kernel_event = kernel_event;
 105 }
 106
 107 void CLTuner::set_tune_new_kernels(bool tune_new_kernels)
 108 {
 109     _tune_new_kernels = tune_new_kernels;
 110 }
 111 bool CLTuner::tune_new_kernels() const
 112 {
 113     return _tune_new_kernels;
 114 }
 115
 116 void CLTuner::tune_kernel(ICLKernel &kernel)
 117 {
 118     // Get the configuration ID from the kernel
 119     const std::string &config_id = kernel.config_id();
 120
 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)
 123     {
 124         auto p = _lws_table.find(config_id);
 125
 126         if(p == _lws_table.end())
 127         {
 128             if(_tune_new_kernels)
 129             {
 130                 // Find the optimal LWS for the kernel
 131                 cl::NDRange opt_lws = find_optimal_lws(kernel);
 132
 133                 // Insert the optimal LWS in the table
 134                 add_lws_to_table(config_id, opt_lws);
 135
 136                 // Set Local-Workgroup-Size
 137                 kernel.set_lws_hint(opt_lws);
 138             }
 139         }
 140         else
 141         {
 142             // Set Local-Workgroup-Size
 143             kernel.set_lws_hint(p->second);
 144         }
 145     }
 146 }
 147
 148 void CLTuner::add_lws_to_table(const std::string &kernel_id, cl::NDRange optimal_lws)
 149 {
 150     _lws_table.emplace(kernel_id, optimal_lws);
 151 }
 152
 153 cl::NDRange CLTuner::find_optimal_lws(ICLKernel &kernel)
 154 {
 155     if(real_clEnqueueNDRangeKernel == nullptr)
 156     {
 157         real_clEnqueueNDRangeKernel = CLSymbols::get().clEnqueueNDRangeKernel_ptr;
 158
 159         // Get the default queue
 160         _queue = CLScheduler::get().queue();
 161
 162         // Check if we can use the OpenCL timer with the default queue
 163         cl_command_queue_properties props = _queue.getInfo<CL_QUEUE_PROPERTIES>();
 164
 165         if((props & CL_QUEUE_PROFILING_ENABLE) == 0)
 166         {
 167             // Set the queue for profiling
 168             _queue_profiler = cl::CommandQueue(CLScheduler::get().context(), props | CL_QUEUE_PROFILING_ENABLE);
 169         }
 170         else
 171         {
 172             _queue_profiler = _queue;
 173         }
 174     }
 175     // Start intercepting enqueues:
 176     CLSymbols::get().clEnqueueNDRangeKernel_ptr = Interceptor(*this);
 177
 178     cl_ulong min_exec_time = std::numeric_limits<cl_ulong>::max();
 179
 180     cl::NDRange opt_lws = cl::NullRange;
 181
 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;
 188
 189     // First run using the default LWS
 190     {
 191         cl::NDRange lws_test = cl::NullRange;
 192
 193         kernel.set_lws_hint(lws_test);
 194
 195         // Run the kernel
 196         kernel.run(kernel.window(), _queue_profiler);
 197
 198         _queue_profiler.finish();
 199
 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;
 204
 205         min_exec_time = diff;
 206     }
 207
 208     for(int z = 1; z <= z_end; ++z)
 209     {
 210         for(int y = 1; y <= y_end; ++y)
 211         {
 212             for(int x = 1; x <= x_end; ++x)
 213             {
 214                 cl::NDRange lws_test = cl::NDRange(x, y, z);
 215
 216                 const bool invalid_lws = (x * y * z > static_cast<int>(kernel.get_max_workgroup_size())) || (x == 1 && y == 1 && z == 1);
 217
 218                 if(invalid_lws)
 219                 {
 220                     continue;
 221                 }
 222
 223                 //Set the Local-Workgroup-Size
 224                 kernel.set_lws_hint(lws_test);
 225
 226                 // Run the kernel
 227                 kernel.run(kernel.window(), _queue_profiler);
 228
 229                 _queue_profiler.finish();
 230
 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;
 235
 236                 // Check the execution time
 237                 if(diff < min_exec_time)
 238                 {
 239                     min_exec_time = diff;
 240                     opt_lws       = cl::NDRange(x, y, z);
 241                 }
 242             }
 243         }
 244     }
 245
 246     // Restore real function
 247     CLSymbols::get().clEnqueueNDRangeKernel_ptr = real_clEnqueueNDRangeKernel;
 248
 249     return opt_lws;
 250 }
 251
 252 void CLTuner::import_lws_table(const std::unordered_map<std::string, cl::NDRange> &lws_table)
 253 {
 254     _lws_table.clear();
 255     _lws_table = lws_table;
 256 }
 257
 258 const std::unordered_map<std::string, cl::NDRange> &CLTuner::lws_table() const
 259 {
 260     return _lws_table;
 261 }
 262
 263 void CLTuner::load_from_file(const std::string &filename)
 264 {
 265     std::ifstream fs;
 266     fs.exceptions(std::ifstream::badbit);
 267     fs.open(filename, std::ios::in);
 268     if(!fs.is_open())
 269     {
 270         ARM_COMPUTE_ERROR("Failed to open '%s' (%s [%d])", filename.c_str(), strerror(errno), errno);
 271     }
 272     std::string line;
 273     while(!std::getline(fs, line).fail())
 274     {
 275         std::istringstream ss(line);
 276         std::string        token;
 277         if(std::getline(ss, token, ';').fail())
 278         {
 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());
 280         }
 281         std::string kernel_id = token;
 282         cl::NDRange lws(1, 1, 1);
 283         for(int i = 0; i < 3; i++)
 284         {
 285             if(std::getline(ss, token, ';').fail())
 286             {
 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());
 288             }
 289             lws.get()[i] = support::cpp11::stoi(token);
 290         }
 291
 292         // If all dimensions are 0: reset to NullRange (i.e nullptr)
 293         if(lws[0] == 0 && lws[1] == 0 && lws[2] == 0)
 294         {
 295             lws = cl::NullRange;
 296         }
 297         add_lws_to_table(kernel_id, lws);
 298     }
 299     fs.close();
 300 }
 301
 302 void CLTuner::save_to_file(const std::string &filename) const
 303 {
 304     std::ofstream fs;
 305     fs.exceptions(std::ifstream::failbit | std::ifstream::badbit);
 306     fs.open(filename, std::ios::out);
 307     for(auto kernel_data : _lws_table)
 308     {
 309         fs << kernel_data.first << ";" << kernel_data.second[0] << ";" << kernel_data.second[1] << ";" << kernel_data.second[2] << std::endl;
 310     }
 311     fs.close();
 312 }