Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 1 | /* |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2018 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 | #ifndef __ARM_COMPUTE_CLTUNER_H__ |
| 25 | #define __ARM_COMPUTE_CLTUNER_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/OpenCL.h" |
| 28 | #include "arm_compute/runtime/CL/ICLTuner.h" |
| 29 | |
| 30 | #include <unordered_map> |
| 31 | |
| 32 | namespace arm_compute |
| 33 | { |
| 34 | class ICLKernel; |
| 35 | |
| 36 | /** Basic implementation of the OpenCL tuner interface */ |
| 37 | class CLTuner : public ICLTuner |
| 38 | { |
| 39 | public: |
| 40 | /** Constructor */ |
| 41 | CLTuner(); |
| 42 | |
| 43 | /** Destructor */ |
| 44 | ~CLTuner() = default; |
| 45 | |
| 46 | /** Import LWS table |
| 47 | * |
| 48 | * @param[in] lws_table The unordered_map container to import |
| 49 | */ |
| 50 | void import_lws_table(const std::unordered_map<std::string, cl::NDRange> &lws_table); |
| 51 | |
| 52 | /** Export LWS table |
| 53 | * |
| 54 | * return The lws table as unordered_map container |
| 55 | */ |
| 56 | const std::unordered_map<std::string, cl::NDRange> &export_lws_table(); |
| 57 | |
| 58 | // Inherited methods overridden: |
| 59 | void tune_kernel(ICLKernel &kernel) override; |
| 60 | |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 61 | /** Set the OpenCL kernel event |
| 62 | * |
| 63 | * @note The interceptor can use this function to store the event associated to the OpenCL kernel |
| 64 | * |
| 65 | * @param[in] kernel_event The OpenCL kernel event |
| 66 | */ |
| 67 | void set_cl_kernel_event(cl_event kernel_event); |
| 68 | |
| 69 | std::function<decltype(clEnqueueNDRangeKernel)> real_function; |
| 70 | |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 71 | private: |
| 72 | /** Find optimal LWS using brute-force approach |
| 73 | * |
| 74 | * @param[in] kernel OpenCL kernel to be tuned with LWS |
| 75 | * |
| 76 | * @return The optimal LWS to use |
| 77 | */ |
| 78 | cl::NDRange find_optimal_lws(ICLKernel &kernel); |
| 79 | |
| 80 | std::unordered_map<std::string, cl::NDRange> _lws_table; |
Gian Marco | 85e6f51 | 2018-02-01 16:57:48 +0000 | [diff] [blame] | 81 | cl::CommandQueue _queue; |
| 82 | cl::CommandQueue _queue_profiler; |
| 83 | cl::Event _kernel_event; |
| 84 | }; |
| 85 | |
| 86 | /* Function to be used to intercept kernel enqueues and store their OpenCL Event */ |
| 87 | class Interceptor |
| 88 | { |
| 89 | public: |
| 90 | explicit Interceptor(CLTuner &tuner); |
| 91 | |
| 92 | /** clEnqueueNDRangeKernel interface |
| 93 | * |
| 94 | * @param[in] command_queue A valid command-queue. The kernel will be queued for execution on the device associated with command_queue. |
| 95 | * @param[in] kernel A valid kernel object. The OpenCL context associated with kernel and command_queue must be the same. |
| 96 | * @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. |
| 97 | * @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). |
| 98 | * @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. |
| 99 | * @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 |
| 100 | * @param[in] num_events_in_wait_list Number of events in the waiting list |
| 101 | * @param[in] event_wait_list Event waiting list |
| 102 | * @param[in] event OpenCL kernel event |
| 103 | * |
| 104 | * @return the OpenCL status |
| 105 | */ |
| 106 | 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, |
| 107 | const cl_event *event_wait_list, cl_event *event); |
| 108 | |
| 109 | private: |
| 110 | CLTuner &_tuner; |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 111 | }; |
| 112 | } |
| 113 | #endif /*__ARM_COMPUTE_CLTUNER_H__ */ |