1 /* 2 * Copyright (c) 2016-2020 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 #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/CLTypes.h" 29 #include "arm_compute/core/CL/OpenCL.h" 30 #include "arm_compute/core/Error.h" 31 #include "arm_compute/core/Types.h" 32 #include "arm_compute/core/experimental/Types.h" 33 #include "arm_compute/runtime/CL/ICLTuner.h" 34 35 namespace arm_compute 36 { 37 class ICLKernel; 38 class ICLTuner; 39 /** Provides global access to a CL context and command queue. */ 40 class CLScheduler final 41 { 42 public: 43 /** Constructor */ 44 CLScheduler(); 45 /** Prevent instances of this class from being copied (As this class contains pointers) */ 46 CLScheduler(const CLScheduler &) = delete; 47 /** Prevent instances of this class from being copied (As this class contains pointers) */ 48 CLScheduler &operator=(const CLScheduler &) = delete; 49 /** Default destructor */ 50 ~CLScheduler() = default; 51 /** Access the scheduler singleton. 52 * This method has been deprecated and will be removed in future releases 53 * @return The scheduler 54 */ 55 static CLScheduler &get(); 56 /** Initialises the context and command queue used by the scheduler to default values 57 * and sets a default device and kernel path for the @ref CLKernelLibrary. 58 * 59 * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr) 60 */ 61 void default_init(ICLTuner *cl_tuner = nullptr); 62 /** Initialises the scheduler with context and device provided by the user 63 * 64 * @param[in] device OpenCL device to be used 65 * @param[in] ctx OpenCL ctx to be used 66 * @param[in] cl_tuner (Optional) Pointer to ICLTuner (default=nullptr) 67 */ 68 void default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner = nullptr); 69 70 /** Schedule the execution of the passed kernel if possible. 71 * 72 * @param[in] kernel Kernel to execute. 73 * @param[in] flush (Optional) Specifies if the command queue will be flushed after running the kernel. 74 */ 75 void enqueue(ICLKernel &kernel, bool flush = true); 76 /** Schedule the execution of the passed kernel if possible. 77 * 78 * @param[in] kernel Kernel to execute. 79 * @param[in] tensors Vector containing the tensors to operate on. 80 * @param[in] flush (Optional) Specifies if the command queue will be flushed after running the kernel. 81 */ 82 void enqueue_op(ICLKernel &kernel, ITensorPack &tensors, bool flush = true); 83 84 /** Initialises the context and command queue to be used by the scheduler. 85 * 86 * @param[in] context A CL context. 87 * @param[in] queue A CL command queue. 88 * @param[in] device A CL device. 89 * @param[in] cl_tuner (Optional) Pointer to OpenCL tuner (default=nullptr) 90 * Note: It is caller's responsibility to release the allocated memory for CLTuner 91 */ 92 void init(cl::Context context, cl::CommandQueue queue, const cl::Device &device, ICLTuner *cl_tuner = nullptr); 93 94 /** Accessor for the associated CL context. 95 * 96 * @return A CL context. 97 */ 98 cl::Context &context(); 99 100 /** Accessor for the associated CL command queue. 101 * 102 * @return A CL command queue. 103 */ 104 cl::CommandQueue &queue(); 105 106 /** Get the target GPU. 107 * 108 * @return The target GPU. 109 */ 110 GPUTarget target() const; 111 112 /** Accessor to set the CL context to be used by the scheduler. 113 * 114 * @param[in] context A CL context. 115 */ 116 void set_context(cl::Context context); 117 118 /** Accessor to set the CL command queue to be used by the scheduler. 119 * 120 * @param[in] queue A CL command queue. 121 */ 122 void set_queue(cl::CommandQueue queue); 123 124 /** Accessor to set target GPU to be used by the scheduler. 125 * 126 * @param[in] target The target GPU. 127 */ 128 void set_target(GPUTarget target); 129 130 /** Accessor to set the CL tuner to be used by the scheduler. 131 * 132 * @param[in] tuner A CL tuner 133 */ 134 void set_tuner(ICLTuner *tuner); 135 136 /** Blocks until all commands in the associated command queue have finished. */ 137 void sync(); 138 139 /** Enqueues a marker into the associated command queue and return the event. 140 * 141 * @return An event that can be waited on to block the executing thread. 142 */ 143 cl::Event enqueue_sync_event(); 144 145 /** Tunes OpenCL kernel 146 * 147 * @param[in] kernel Kernel to tune 148 */ 149 void tune_kernel_static(ICLKernel &kernel); 150 151 bool is_initialised() const; 152 153 private: 154 void enqueue_common(ICLKernel &kernel, ITensorPack &tensors, bool flush); 155 /** Flag to ensure symbols initialisation is happening before Scheduler creation */ 156 static std::once_flag _initialize_symbols; 157 158 cl::Context _context; 159 cl::CommandQueue _queue; 160 GPUTarget _target; 161 bool _is_initialised; 162 ICLTuner *_cl_tuner; 163 std::unique_ptr<ICLTuner> _cl_default_static_tuner; 164 }; 165 } // namespace arm_compute 166 #endif /* ARM_COMPUTE_CLSCHEDULER_H */ 167