Compute Library
 20.08
CLScheduler.cpp
Go to the documentation of this file.
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  */
25 
31 
32 namespace arm_compute
33 {
34 cl::Context &CLScheduler::context()
35 {
36  ARM_COMPUTE_ERROR_ON(!_is_initialised);
37  _context = CLKernelLibrary::get().context();
38  return _context;
39 }
40 
41 cl::CommandQueue &CLScheduler::queue()
42 {
43  ARM_COMPUTE_ERROR_ON(!_is_initialised);
44  return _queue;
45 }
46 
48 {
49  return _target;
50 }
51 
52 void CLScheduler::set_queue(cl::CommandQueue queue)
53 {
54  _queue = std::move(queue);
55 }
56 
58 {
59  _target = target;
60 }
61 
63 {
64  _cl_tuner = tuner;
65 }
66 
68 {
69  _queue.finish();
70 }
71 
73 {
74  cl::Event event;
75  _queue.enqueueMarker(&event);
76  return event;
77 }
78 
80 {
81  if(_cl_tuner != nullptr)
82  {
83  _cl_tuner->tune_kernel_static(kernel);
84  }
85 }
86 
88 {
89  return _is_initialised;
90 }
91 
92 std::once_flag CLScheduler::_initialize_symbols;
93 
95  : _context(), _queue(), _target(GPUTarget::MIDGARD), _is_initialised(false), _cl_tuner(nullptr), _cl_default_static_tuner(nullptr)
96 {
97 }
98 
100 {
101  std::call_once(_initialize_symbols, opencl_is_available);
102  static CLScheduler scheduler;
103  return scheduler;
104 }
105 
106 void CLScheduler::default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner)
107 {
108  if(!_is_initialised)
109  {
110  const std::string cl_kernels_folder("./cl_kernels/");
111  cl::CommandQueue queue = cl::CommandQueue(ctx, device);
112  CLKernelLibrary::get().init(cl_kernels_folder, ctx, device);
113  init(ctx, queue, device, cl_tuner);
114  _cl_default_static_tuner = tuners::TunerFactory::create_tuner(_target);
115  _cl_tuner = (cl_tuner == nullptr) ? _cl_default_static_tuner.get() : cl_tuner;
116  }
117 }
118 
120 {
121  if(!_is_initialised)
122  {
123  cl::Context ctx;
124  cl::Device dev;
125  cl_int err;
126  std::tie(ctx, dev, err) = create_opencl_context_and_device();
127  ARM_COMPUTE_ERROR_ON_MSG(err != CL_SUCCESS, "Failed to create OpenCL context");
128  cl::CommandQueue queue = cl::CommandQueue(ctx, dev);
129  CLKernelLibrary::get().init("./cl_kernels/", ctx, dev);
130  init(ctx, queue, dev, cl_tuner);
131  // Create a default static tuner and set if none was provided
132  _cl_default_static_tuner = tuners::TunerFactory::create_tuner(_target);
133  }
134 
135  // Set CL tuner
136  _cl_tuner = (cl_tuner == nullptr) ? _cl_default_static_tuner.get() : cl_tuner;
137 }
138 
139 void CLScheduler::set_context(cl::Context context)
140 {
141  _context = std::move(context);
142  CLKernelLibrary::get().set_context(_context);
143 }
144 
145 void CLScheduler::init(cl::Context context, cl::CommandQueue queue, const cl::Device &device, ICLTuner *cl_tuner)
146 {
147  set_context(std::move(context));
148  _queue = std::move(queue);
149  _target = get_target_from_device(device);
150  _is_initialised = true;
151  _cl_tuner = cl_tuner;
152 }
153 
154 void CLScheduler::enqueue_common(ICLKernel &kernel, ITensorPack &tensors, bool flush)
155 {
156  ARM_COMPUTE_ERROR_ON_MSG(!_is_initialised,
157  "The CLScheduler is not initialised yet! Please call the CLScheduler::get().default_init(), \
158  or CLScheduler::get()::init() and CLKernelLibrary::get()::init() function before running functions!");
159 
160  const bool inject_memory = !tensors.empty();
161 
162  // Tune the kernel if the CLTuner has been provided
163  if(_cl_tuner != nullptr)
164  {
165  inject_memory ? _cl_tuner->tune_kernel_dynamic(kernel, tensors) : _cl_tuner->tune_kernel_dynamic(kernel);
166  }
167 
168  // Run kernel
169  inject_memory ? kernel.run_op(tensors, kernel.window(), _queue) : kernel.run(kernel.window(), _queue);
170 
171  if(flush)
172  {
173  _queue.flush();
174  }
175 }
176 
177 void CLScheduler::enqueue(ICLKernel &kernel, bool flush)
178 {
179  ITensorPack pack;
180  enqueue_common(kernel, pack, flush);
181 }
182 
183 void CLScheduler::enqueue_op(ICLKernel &kernel, ITensorPack &tensors, bool flush)
184 {
185  enqueue_common(kernel, tensors, flush);
186 }
187 } // namespace arm_compute
void set_target(GPUTarget target)
Accessor to set target GPU to be used by the scheduler.
Definition: CLScheduler.cpp:57
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
virtual void run(const Window &window, cl::CommandQueue &queue)
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
Definition: ICLKernel.h:220
static CLScheduler & get()
Access the scheduler singleton.
Definition: CLScheduler.cpp:99
bool empty() const
Checks if pack is empty.
Definition: ITensorPack.cpp:61
GPUTarget target() const
Get the target GPU.
Definition: CLScheduler.cpp:47
void set_context(cl::Context context)
Accessor to set the CL context to be used by the scheduler.
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
virtual void tune_kernel_dynamic(ICLKernel &kernel)=0
Tune OpenCL kernel dynamically.
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
bool is_initialised() const
Definition: CLScheduler.cpp:87
void init(cl::Context context, cl::CommandQueue queue, const cl::Device &device, ICLTuner *cl_tuner=nullptr)
Initialises the context and command queue to be used by the scheduler.
std::tuple< cl::Context, cl::Device, cl_int > create_opencl_context_and_device()
This function creates an OpenCL context and a device.
Definition: CLHelpers.cpp:88
void set_context(cl::Context context)
Sets the CL context used to create programs.
Common interface for all the OpenCL kernels.
Definition: ICLKernel.h:44
Copyright (c) 2017-2020 Arm Limited.
cl::Context & context()
Accessor for the associated CL context.
Definition: CLScheduler.cpp:34
cl::Event enqueue_sync_event()
Enqueues a marker into the associated command queue and return the event.
Definition: CLScheduler.cpp:72
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
void enqueue_op(ICLKernel &kernel, ITensorPack &tensors, bool flush=true)
Schedule the execution of the passed kernel if possible.
GPUTarget get_target_from_device(const cl::Device &device)
Helper function to get the GPU target from CL device.
Definition: CLHelpers.cpp:221
void init(std::string kernel_path, cl::Context context, cl::Device device)
Initialises the kernel library.
void set_tuner(ICLTuner *tuner)
Accessor to set the CL tuner to be used by the scheduler.
Definition: CLScheduler.cpp:62
cl::CommandQueue & queue()
Accessor for the associated CL command queue.
Definition: CLScheduler.cpp:41
void enqueue(ICLKernel &kernel, bool flush=true)
Schedule the execution of the passed kernel if possible.
void set_queue(cl::CommandQueue queue)
Accessor to set the CL command queue to be used by the scheduler.
Definition: CLScheduler.cpp:52
CLScheduler()
Constructor.
Definition: CLScheduler.cpp:94
void sync()
Blocks until all commands in the associated command queue have finished.
Definition: CLScheduler.cpp:67
void default_init_with_context(cl::Device &device, cl::Context &ctx, ICLTuner *cl_tuner=nullptr)
Initialises the scheduler with context and device provided by the user.
GPUTarget
Available GPU Targets.
Definition: GPUTarget.h:34
virtual void tune_kernel_static(ICLKernel &kernel)=0
Tune OpenCL kernel statically.
Provides global access to a CL context and command queue.
Definition: CLScheduler.h:40
Tensor packing service.
Definition: ITensorPack.h:36
Basic interface for tuning the OpenCL kernels.
Definition: ICLTuner.h:34
static std::unique_ptr< ICLTuner > create_tuner(GPUTarget target)
Definition: Tuners.h:40
void tune_kernel_static(ICLKernel &kernel)
Tunes OpenCL kernel.
Definition: CLScheduler.cpp:79
virtual void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.
Definition: ICLKernel.h:232
void default_init(ICLTuner *cl_tuner=nullptr)
Initialises the context and command queue used by the scheduler to default values and sets a default ...
bool opencl_is_available()
Check if OpenCL is available.
Definition: OpenCL.cpp:151
cl::Context & context()
Accessor for the associated CL context.