Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Michalis Spyrou | 84f3ae8 | 2018-01-15 11:15:26 +0000 | [diff] [blame] | 2 | * Copyright (c) 2016-2018 ARM Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +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_CLSCHEDULER_H__ |
| 25 | #define __ARM_COMPUTE_CLSCHEDULER_H__ |
| 26 | |
| 27 | #include "arm_compute/core/CL/CLHelpers.h" |
| 28 | #include "arm_compute/core/CL/CLKernelLibrary.h" |
| 29 | #include "arm_compute/core/CL/CLTypes.h" |
| 30 | #include "arm_compute/core/CL/OpenCL.h" |
| 31 | #include "arm_compute/core/Error.h" |
| 32 | #include "arm_compute/core/Types.h" |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 33 | #include "arm_compute/runtime/CL/CLTuner.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 34 | |
steniu01 | f01f9de | 2017-09-27 17:00:11 +0100 | [diff] [blame] | 35 | #if defined(ARM_COMPUTE_DEBUG_ENABLED) |
| 36 | namespace |
| 37 | { |
| 38 | void printf_callback(const char *buffer, unsigned int len, size_t complete, void *user_data) |
| 39 | { |
| 40 | printf("%.*s", len, buffer); |
| 41 | } |
steniu01 | f01f9de | 2017-09-27 17:00:11 +0100 | [diff] [blame] | 42 | } |
| 43 | #endif /* defined(ARM_COMPUTE_DEBUG_ENABLED) */ |
| 44 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 45 | namespace arm_compute |
| 46 | { |
| 47 | class ICLKernel; |
| 48 | |
| 49 | /** Provides global access to a CL context and command queue. */ |
| 50 | class CLScheduler |
| 51 | { |
| 52 | private: |
| 53 | /** Constructor */ |
| 54 | CLScheduler(); |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 55 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 56 | CLScheduler(const CLScheduler &) = delete; |
| 57 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 58 | CLScheduler &operator=(const CLScheduler &) = delete; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 59 | |
| 60 | public: |
| 61 | /** Access the scheduler singleton. |
| 62 | * |
| 63 | * @return The scheduler |
| 64 | */ |
| 65 | static CLScheduler &get(); |
| 66 | /** Initialises the context and command queue used by the scheduler to default values |
| 67 | * and sets a default device and kernel path for the @ref CLKernelLibrary. |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 68 | * |
| 69 | * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 70 | */ |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 71 | void default_init(ICLTuner *cl_tuner = nullptr) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 72 | { |
Anthony Barbier | 6db0ff5 | 2018-01-05 10:59:12 +0000 | [diff] [blame] | 73 | if(!_is_initialised) |
Anthony Barbier | a9e1533 | 2017-12-22 16:37:30 +0000 | [diff] [blame] | 74 | { |
Anthony Barbier | 6db0ff5 | 2018-01-05 10:59:12 +0000 | [diff] [blame] | 75 | #if defined(ARM_COMPUTE_DEBUG_ENABLED) |
| 76 | // Create a cl_context with a printf_callback and user specified buffer size. |
| 77 | cl_context_properties properties[] = |
| 78 | { |
| 79 | // Enable a printf callback function for this context. |
| 80 | CL_PRINTF_CALLBACK_ARM, reinterpret_cast<cl_context_properties>(printf_callback), |
| 81 | // Request a minimum printf buffer size of 4MB for devices in the |
| 82 | // context that support this extension. |
| 83 | CL_PRINTF_BUFFERSIZE_ARM, static_cast<cl_context_properties>(0x100000), |
| 84 | CL_CONTEXT_PLATFORM, reinterpret_cast<cl_context_properties>(cl::Platform::get()()), |
| 85 | 0 |
| 86 | }; |
| 87 | cl::Context::setDefault(cl::Context(CL_DEVICE_TYPE_DEFAULT, properties)); |
steniu01 | f01f9de | 2017-09-27 17:00:11 +0100 | [diff] [blame] | 88 | #endif // defined(ARM_COMPUTE_DEBUG_ENABLED) |
| 89 | |
Anthony Barbier | 6db0ff5 | 2018-01-05 10:59:12 +0000 | [diff] [blame] | 90 | CLKernelLibrary::get().init("./cl_kernels/", cl::Context::getDefault(), cl::Device::getDefault()); |
| 91 | init(cl::Context::getDefault(), cl::CommandQueue::getDefault(), cl::Device::getDefault(), cl_tuner); |
| 92 | } |
| 93 | else |
| 94 | { |
| 95 | _cl_tuner = cl_tuner; |
| 96 | } |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 97 | } |
| 98 | /** Schedule the execution of the passed kernel if possible. |
| 99 | * |
| 100 | * @param[in] kernel Kernel to execute. |
| 101 | * @param[in] flush (Optional) Specifies if the command queue will be flushed after running the kernel. |
| 102 | */ |
| 103 | void enqueue(ICLKernel &kernel, bool flush = true); |
| 104 | |
| 105 | /** Initialises the context and command queue to be used by the scheduler. |
| 106 | * |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 107 | * @param[in] context A CL context. |
| 108 | * @param[in] queue A CL command queue. |
| 109 | * @param[in] device A CL device. |
| 110 | * @param[in] cl_tuner (Optional) Pointer to OpenCL tuner (default=nullptr) |
| 111 | * Note: It is caller's responsibility to release the allocated memory for CLTuner |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 112 | */ |
| 113 | void init(cl::Context context = cl::Context::getDefault(), cl::CommandQueue queue = cl::CommandQueue::getDefault(), |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 114 | cl::Device device = cl::Device::getDefault(), ICLTuner *cl_tuner = nullptr) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 115 | { |
steniu01 | 3470247 | 2017-07-11 09:22:58 +0100 | [diff] [blame] | 116 | _context = std::move(context); |
| 117 | _queue = std::move(queue); |
| 118 | _target = get_target_from_device(device); |
| 119 | _is_initialised = true; |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 120 | _cl_tuner = cl_tuner; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | /** Accessor for the associated CL context. |
| 124 | * |
| 125 | * @return A CL context. |
| 126 | */ |
| 127 | cl::Context &context() |
| 128 | { |
steniu01 | 3470247 | 2017-07-11 09:22:58 +0100 | [diff] [blame] | 129 | ARM_COMPUTE_ERROR_ON(!_is_initialised); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 130 | return _context; |
| 131 | } |
| 132 | |
| 133 | /** Accessor to set the CL context to be used by the scheduler. |
| 134 | * |
| 135 | * @param[in] context A CL context. |
| 136 | */ |
| 137 | void set_context(cl::Context context) |
| 138 | { |
| 139 | _context = std::move(context); |
| 140 | } |
| 141 | |
| 142 | /** Accessor for the associated CL command queue. |
| 143 | * |
| 144 | * @return A CL command queue. |
| 145 | */ |
| 146 | cl::CommandQueue &queue() |
| 147 | { |
steniu01 | 3470247 | 2017-07-11 09:22:58 +0100 | [diff] [blame] | 148 | ARM_COMPUTE_ERROR_ON(!_is_initialised); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 149 | return _queue; |
| 150 | } |
| 151 | |
| 152 | /** Get the target GPU. |
| 153 | * |
| 154 | * @return The target GPU. |
| 155 | */ |
| 156 | GPUTarget target() const |
| 157 | { |
| 158 | return _target; |
| 159 | } |
| 160 | |
| 161 | /** Accessor to set the CL command queue to be used by the scheduler. |
| 162 | * |
| 163 | * @param[in] queue A CL command queue. |
| 164 | */ |
| 165 | void set_queue(cl::CommandQueue queue) |
| 166 | { |
| 167 | _queue = std::move(queue); |
| 168 | } |
| 169 | |
| 170 | /** Accessor to set target GPU to be used by the scheduler. |
| 171 | * |
| 172 | * @param[in] target The target GPU. |
| 173 | */ |
| 174 | void set_target(GPUTarget target) |
| 175 | { |
| 176 | _target = target; |
| 177 | } |
| 178 | |
| 179 | /** Blocks until all commands in the associated command queue have finished. */ |
| 180 | void sync() |
| 181 | { |
| 182 | _queue.finish(); |
| 183 | } |
| 184 | |
| 185 | /** Enqueues a marker into the associated command queue and return the event. |
| 186 | * |
| 187 | * @return An event that can be waited on to block the executing thread. |
| 188 | */ |
| 189 | cl::Event enqueue_sync_event() |
| 190 | { |
| 191 | cl::Event event; |
| 192 | _queue.enqueueMarker(&event); |
| 193 | |
| 194 | return event; |
| 195 | } |
| 196 | |
| 197 | private: |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 198 | /** Tune OpenCL kernel |
| 199 | * |
| 200 | * @note This method uses a brute force approach to find the optimal LWS |
| 201 | * |
| 202 | * @param[in] kernel Kernel to tune |
| 203 | * |
| 204 | * @return The optimal LWS for the specified kernel |
| 205 | */ |
| 206 | cl::NDRange tune_kernel(ICLKernel &kernel); |
| 207 | |
Ioan-Cristian Szabo | 77eb21f | 2017-12-22 17:32:17 +0000 | [diff] [blame] | 208 | /** Flag to ensure symbols initialisation is happening before Scheduler creation */ |
| 209 | static std::once_flag _initialize_symbols; |
| 210 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 211 | cl::Context _context; |
| 212 | cl::CommandQueue _queue; |
| 213 | GPUTarget _target; |
steniu01 | 3470247 | 2017-07-11 09:22:58 +0100 | [diff] [blame] | 214 | bool _is_initialised; |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 215 | ICLTuner *_cl_tuner; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 216 | }; |
| 217 | } |
| 218 | #endif /* __ARM_COMPUTE_CLSCHEDULER_H__ */ |