Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Pablo Tello | b7c308a | 2019-01-22 12:59:26 +0000 | [diff] [blame] | 2 | * Copyright (c) 2016-2019 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CLSCHEDULER_H |
| 25 | #define ARM_COMPUTE_CLSCHEDULER_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/CL/CLHelpers.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 28 | #include "arm_compute/core/CL/CLTypes.h" |
| 29 | #include "arm_compute/core/CL/OpenCL.h" |
| 30 | #include "arm_compute/core/Error.h" |
| 31 | #include "arm_compute/core/Types.h" |
Georgios Pinitas | c0d1c86 | 2018-03-23 15:13:15 +0000 | [diff] [blame] | 32 | #include "arm_compute/runtime/CL/ICLTuner.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | |
| 34 | namespace arm_compute |
| 35 | { |
| 36 | class ICLKernel; |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 37 | class ICLTuner; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 38 | /** Provides global access to a CL context and command queue. */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 39 | class CLScheduler final |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 40 | { |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 41 | public: |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 42 | /** Constructor */ |
| 43 | CLScheduler(); |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 44 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 45 | CLScheduler(const CLScheduler &) = delete; |
| 46 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 47 | CLScheduler &operator=(const CLScheduler &) = delete; |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 48 | /** Default destructor */ |
| 49 | ~CLScheduler() = default; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 50 | /** Access the scheduler singleton. |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 51 | * This method has been deprecated and will be removed in future releases |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 52 | * @return The scheduler |
| 53 | */ |
| 54 | static CLScheduler &get(); |
| 55 | /** Initialises the context and command queue used by the scheduler to default values |
| 56 | * and sets a default device and kernel path for the @ref CLKernelLibrary. |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 57 | * |
| 58 | * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 59 | */ |
Georgios Pinitas | df473ea | 2018-05-31 18:53:52 +0100 | [diff] [blame] | 60 | void default_init(ICLTuner *cl_tuner = nullptr); |
Pablo Tello | b7c308a | 2019-01-22 12:59:26 +0000 | [diff] [blame] | 61 | /** Initialises the scheduler with context and device provided by the user |
| 62 | * |
| 63 | * @param[in] device OpenCL device to be used |
| 64 | * @param[in] ctx OpenCL ctx to be used |
| 65 | * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr) |
| 66 | */ |
| 67 | void default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner = nullptr); |
| 68 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 69 | /** Schedule the execution of the passed kernel if possible. |
| 70 | * |
| 71 | * @param[in] kernel Kernel to execute. |
| 72 | * @param[in] flush (Optional) Specifies if the command queue will be flushed after running the kernel. |
| 73 | */ |
| 74 | void enqueue(ICLKernel &kernel, bool flush = true); |
| 75 | |
| 76 | /** Initialises the context and command queue to be used by the scheduler. |
| 77 | * |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 78 | * @param[in] context A CL context. |
| 79 | * @param[in] queue A CL command queue. |
| 80 | * @param[in] device A CL device. |
| 81 | * @param[in] cl_tuner (Optional) Pointer to OpenCL tuner (default=nullptr) |
| 82 | * 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] | 83 | */ |
Pablo Tello | b7c308a | 2019-01-22 12:59:26 +0000 | [diff] [blame] | 84 | void init(cl::Context context, cl::CommandQueue queue, const cl::Device &device, ICLTuner *cl_tuner = nullptr); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 85 | |
| 86 | /** Accessor for the associated CL context. |
| 87 | * |
| 88 | * @return A CL context. |
| 89 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 90 | cl::Context &context(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 91 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 92 | /** Accessor for the associated CL command queue. |
| 93 | * |
| 94 | * @return A CL command queue. |
| 95 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 96 | cl::CommandQueue &queue(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 97 | |
| 98 | /** Get the target GPU. |
| 99 | * |
| 100 | * @return The target GPU. |
| 101 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 102 | GPUTarget target() const; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 103 | |
Georgios Pinitas | 7777b1a | 2018-07-11 18:16:20 +0100 | [diff] [blame] | 104 | /** Accessor to set the CL context to be used by the scheduler. |
| 105 | * |
| 106 | * @param[in] context A CL context. |
| 107 | */ |
Pablo Tello | b7c308a | 2019-01-22 12:59:26 +0000 | [diff] [blame] | 108 | void set_context(cl::Context context); |
Georgios Pinitas | 7777b1a | 2018-07-11 18:16:20 +0100 | [diff] [blame] | 109 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 110 | /** Accessor to set the CL command queue to be used by the scheduler. |
| 111 | * |
| 112 | * @param[in] queue A CL command queue. |
| 113 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 114 | void set_queue(cl::CommandQueue queue); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 115 | |
| 116 | /** Accessor to set target GPU to be used by the scheduler. |
| 117 | * |
| 118 | * @param[in] target The target GPU. |
| 119 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 120 | void set_target(GPUTarget target); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 121 | |
Georgios Pinitas | 7777b1a | 2018-07-11 18:16:20 +0100 | [diff] [blame] | 122 | /** Accessor to set the CL tuner to be used by the scheduler. |
| 123 | * |
| 124 | * @param[in] tuner A CL tuner |
| 125 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 126 | void set_tuner(ICLTuner *tuner); |
Georgios Pinitas | 7777b1a | 2018-07-11 18:16:20 +0100 | [diff] [blame] | 127 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 128 | /** Blocks until all commands in the associated command queue have finished. */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 129 | void sync(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 130 | |
| 131 | /** Enqueues a marker into the associated command queue and return the event. |
| 132 | * |
| 133 | * @return An event that can be waited on to block the executing thread. |
| 134 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 135 | cl::Event enqueue_sync_event(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 136 | |
Georgios Pinitas | c0d1c86 | 2018-03-23 15:13:15 +0000 | [diff] [blame] | 137 | /** Tunes OpenCL kernel |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 138 | * |
| 139 | * @param[in] kernel Kernel to tune |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 140 | */ |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 141 | void tune_kernel_static(ICLKernel &kernel); |
Gian Marco | de691f0 | 2017-09-08 16:13:11 +0100 | [diff] [blame] | 142 | |
Pablo Tello | db8485a | 2019-09-24 11:03:47 +0100 | [diff] [blame] | 143 | bool is_initialised() const; |
Anthony Barbier | 9fb0cac | 2018-04-20 15:46:21 +0100 | [diff] [blame] | 144 | |
Georgios Pinitas | c0d1c86 | 2018-03-23 15:13:15 +0000 | [diff] [blame] | 145 | private: |
Ioan-Cristian Szabo | 77eb21f | 2017-12-22 17:32:17 +0000 | [diff] [blame] | 146 | /** Flag to ensure symbols initialisation is happening before Scheduler creation */ |
| 147 | static std::once_flag _initialize_symbols; |
| 148 | |
Georgios Pinitas | 72ccc44 | 2018-08-14 12:52:53 +0100 | [diff] [blame] | 149 | cl::Context _context; |
Georgios Pinitas | 7777b1a | 2018-07-11 18:16:20 +0100 | [diff] [blame] | 150 | cl::CommandQueue _queue; |
| 151 | GPUTarget _target; |
| 152 | bool _is_initialised; |
| 153 | ICLTuner *_cl_tuner; |
| 154 | std::unique_ptr<ICLTuner> _cl_default_static_tuner; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 155 | }; |
Georgios Pinitas | 7ae80a9 | 2019-10-25 18:25:17 +0100 | [diff] [blame] | 156 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 157 | #endif /* ARM_COMPUTE_CLSCHEDULER_H */ |