Compute Library
 21.08
CLCompileContext.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020-2021 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  */
26 
28 #include "arm_compute/core/Error.h"
29 #include "arm_compute/core/Utils.h"
30 #include "support/StringSupport.h"
31 
32 #include <regex>
33 
34 namespace arm_compute
35 {
37  : _build_opts()
38 {
39 }
40 
41 void CLBuildOptions::add_option(std::string option)
42 {
43  _build_opts.emplace(std::move(option));
44 }
45 
46 void CLBuildOptions::add_option_if(bool cond, std::string option)
47 {
48  if(cond)
49  {
50  add_option(std::move(option));
51  }
52 }
53 
54 void CLBuildOptions::add_option_if_else(bool cond, std::string option_true, std::string option_false)
55 {
56  (cond) ? add_option(std::move(option_true)) : add_option(std::move(option_false));
57 }
58 
59 void CLBuildOptions::add_options(const StringSet &options)
60 {
61  _build_opts.insert(options.begin(), options.end());
62 }
63 
64 void CLBuildOptions::add_options_if(bool cond, const StringSet &options)
65 {
66  if(cond)
67  {
68  add_options(options);
69  }
70 }
71 
72 const CLBuildOptions::StringSet &CLBuildOptions::options() const
73 {
74  return _build_opts;
75 }
76 
78  : _context(), _device(), _is_binary(false), _name(), _source(), _binary()
79 {
80 }
81 
82 Program::Program(cl::Context context, std::string name, std::string source)
83  : _context(std::move(context)), _device(), _is_binary(false), _name(std::move(name)), _source(std::move(source)), _binary()
84 {
85 }
86 
87 Program::Program(cl::Context context, cl::Device device, std::string name, std::vector<unsigned char> binary)
88  : _context(std::move(context)), _device(std::move(device)), _is_binary(true), _name(std::move(name)), _source(), _binary(std::move(binary))
89 {
90 }
91 
92 Program::operator cl::Program() const
93 {
94  if(_is_binary)
95  {
96  return cl::Program(_context, { _device }, { _binary });
97  }
98  else
99  {
100  return cl::Program(_context, _source, false);
101  }
102 }
103 
104 bool Program::build(const cl::Program &program, const std::string &build_options)
105 {
106  try
107  {
108  return program.build(build_options.c_str()) == CL_SUCCESS;
109  }
110  catch(const cl::Error &e)
111  {
112  cl_int err = CL_SUCCESS;
113  const auto build_info = program.getBuildInfo<CL_PROGRAM_BUILD_LOG>(&err);
114 
115  for(auto &pair : build_info)
116  {
117  std::cerr << pair.second << std::endl;
118  }
119 
120  return false;
121  }
122 }
123 
124 cl::Program Program::build(const std::string &build_options) const
125 {
126  cl::Program cl_program = static_cast<cl::Program>(*this);
127  build(cl_program, build_options);
128  return cl_program;
129 }
130 
132  : _name(), _kernel()
133 {
134 }
135 
136 Kernel::Kernel(std::string name, const cl::Program &program)
137  : _name(std::move(name)),
138  _kernel(cl::Kernel(program, _name.c_str()))
139 {
140 }
142  : _context(), _device(), _programs_map(), _built_programs_map(), _is_wbsm_supported()
143 {
144 }
145 
146 CLCompileContext::CLCompileContext(cl::Context context, const cl::Device &device)
147  : _context(), _device(), _programs_map(), _built_programs_map(), _is_wbsm_supported()
148 {
149  _context = std::move(context);
150  _device = CLDevice(device);
151  _is_wbsm_supported = get_wbsm_support_info(device);
152 }
153 
154 Kernel CLCompileContext::create_kernel(const std::string &kernel_name, const std::string &program_name, const std::string &program_source,
155  const std::string &kernel_path, const StringSet &build_options_set, bool is_binary) const
156 {
157  const std::string build_options = generate_build_options(build_options_set, kernel_path);
158  const std::string built_program_name = program_name + "_" + build_options;
159  auto built_program_it = _built_programs_map.find(built_program_name);
160  cl::Program cl_program;
161 
162  if(_built_programs_map.end() != built_program_it)
163  {
164  // If program has been built, retrieve to create kernel from it
165  cl_program = built_program_it->second;
166  }
167  else
168  {
169  Program program = load_program(program_name, program_source, is_binary);
170 
171  // Build program
172  cl_program = program.build(build_options);
173 
174  // Add built program to internal map
175  _built_programs_map.emplace(built_program_name, cl_program);
176  }
177 
178  // Create and return kernel
179  return Kernel(kernel_name, cl_program);
180 }
181 
182 const Program &CLCompileContext::load_program(const std::string &program_name, const std::string &program_source, bool is_binary) const
183 {
184  const auto program_it = _programs_map.find(program_name);
185 
186  if(program_it != _programs_map.end())
187  {
188  return program_it->second;
189  }
190 
191  Program program;
192 
193 #ifdef EMBEDDED_KERNELS
194  ARM_COMPUTE_UNUSED(is_binary);
195  program = Program(_context, program_name, program_source);
196 #else /* EMBEDDED_KERNELS */
197  if(is_binary)
198  {
199  program = Program(_context, _device.cl_device(), program_name, std::vector<unsigned char>(program_source.begin(), program_source.end()));
200  }
201  else
202  {
203  program = Program(_context, program_name, program_source);
204  }
205 #endif /* EMBEDDED_KERNELS */
206 
207  // Insert program to program map
208  const auto new_program = _programs_map.emplace(program_name, std::move(program));
209 
210  return new_program.first->second;
211 }
212 
214 {
215  _context = std::move(context);
216  if(_context.get() != nullptr)
217  {
218  const auto cl_devices = _context.getInfo<CL_CONTEXT_DEVICES>();
219 
220  if(!cl_devices.empty())
221  {
222  _device = CLDevice(cl_devices[0]);
223  }
224  }
225 }
226 
227 std::string CLCompileContext::generate_build_options(const StringSet &build_options_set, const std::string &kernel_path) const
228 {
229  std::string concat_str;
230 
231 #if defined(ARM_COMPUTE_DEBUG_ENABLED)
232  // Enable debug properties in CL kernels
233  concat_str += " -DARM_COMPUTE_DEBUG_ENABLED";
234 #endif // defined(ARM_COMPUTE_DEBUG_ENABLED)
235 
236  GPUTarget gpu_arch = get_arch_from_target(_device.target());
237  concat_str += " -DGPU_ARCH=" + support::cpp11::to_string(
238  static_cast<std::underlying_type<GPUTarget>::type>(gpu_arch));
239 
240  if(_device.supported("cl_khr_fp16"))
241  {
242  concat_str += " -DARM_COMPUTE_OPENCL_FP16_ENABLED=1 ";
243  }
244 
245  if(_device.supported("cl_arm_integer_dot_product_int8"))
246  {
247  concat_str += " -DARM_COMPUTE_OPENCL_DOT8_ENABLED=1 ";
248  }
249 
250  if(_device.supported("cl_arm_integer_dot_product_accumulate_int8"))
251  {
252  concat_str += " -DARM_COMPUTE_OPENCL_DOT8_ACC_ENABLED=1 ";
253  }
254 
255  if(_device.version() == CLVersion::CL20)
256  {
257  concat_str += " -cl-std=CL2.0 ";
258  }
259  else if(_device.supported("cl_arm_non_uniform_work_group_size"))
260  {
261  concat_str += " -cl-arm-non-uniform-work-group-size ";
262  }
263  else
264  {
265  ARM_COMPUTE_ERROR("Non uniform workgroup size is not supported!!");
266  }
267 
268  if(gpu_arch != GPUTarget::UNKNOWN && gpu_arch != GPUTarget::MIDGARD)
269  {
270  const std::string device_vers = _device.device_version();
271  const std::regex ddk_regex("r([0-9]*)p[0-9]");
272  std::smatch ddk_match;
273 
274  if(std::regex_search(device_vers, ddk_match, ddk_regex) && std::stoi(ddk_match[1]) >= 11)
275  {
276  concat_str += " -DUNROLL_WITH_PRAGMA ";
277  }
278  }
279 
280  std::string build_options = stringify_set(build_options_set, kernel_path) + concat_str;
281 
282  return build_options;
283 }
284 
286 {
287  return _device.supported("cl_khr_fp16");
288 }
289 
290 std::string CLCompileContext::stringify_set(const StringSet &s, const std::string &kernel_path) const
291 {
292  std::string concat_set;
293 #ifndef EMBEDDED_KERNELS
294  concat_set += "-I" + kernel_path + " ";
295 #else /* EMBEDDED_KERNELS */
296  ARM_COMPUTE_UNUSED(kernel_path);
297 #endif /* EMBEDDED_KERNELS */
298 
299  // Concatenate set
300  for(const auto &el : s)
301  {
302  concat_set += " " + el;
303  }
304 
305  return concat_set;
306 }
307 
308 void CLCompileContext::add_built_program(const std::string &built_program_name, const cl::Program &program) const
309 {
310  _built_programs_map.emplace(built_program_name, program);
311 }
312 
314 {
315  _programs_map.clear();
316  _built_programs_map.clear();
317 }
318 
319 const std::map<std::string, cl::Program> &CLCompileContext::get_built_programs() const
320 {
321  return _built_programs_map;
322 }
323 
325 {
326  return _context;
327 }
328 
329 const cl::Device &CLCompileContext::get_device() const
330 {
331  return _device.cl_device();
332 }
333 
334 void CLCompileContext::set_device(cl::Device device)
335 {
336  _device = std::move(device);
337  _is_wbsm_supported = get_wbsm_support_info(device);
338 }
339 
341 {
342  GPUTarget _target = get_target_from_device(_device.cl_device());
343  cl::NDRange default_range;
344 
345  switch(_target)
346  {
347  case GPUTarget::MIDGARD:
348  case GPUTarget::T600:
349  case GPUTarget::T700:
350  case GPUTarget::T800:
351  default_range = cl::NDRange(128u, 1);
352  break;
353  default:
354  default_range = cl::NullRange;
355  }
356 
357  return default_range;
358 }
359 
361 {
362  return _device.supported("cl_khr_int64_base_atomics");
363 }
364 
366 {
367  return _is_wbsm_supported;
368 }
369 
370 size_t CLCompileContext::max_local_workgroup_size(const cl::Kernel &kernel) const
371 {
372  size_t result;
373 
374  size_t err = kernel.getWorkGroupInfo(_device.cl_device(), CL_KERNEL_WORK_GROUP_SIZE, &result);
375  ARM_COMPUTE_ERROR_ON_MSG(err != 0, "clGetKernelWorkGroupInfo failed to return the maximum workgroup size for the kernel");
376  ARM_COMPUTE_UNUSED(err);
377 
378  return result;
379 }
380 
382 {
383  return _device.device_version();
384 }
385 
387 {
388  return _device.compute_units();
389 }
390 } // namespace arm_compute
Definition: ICLTensor.h:33
std::string device_version() const
Returns the device version as a string.
Definition: CLDevice.h:130
void set_device(cl::Device device)
Sets the CL device for which the programs are created.
const cl::Device & get_device() const
Gets the CL device for which the programs are created.
cl::Context & context()
Accessor for the associated CL context.
Kernel()
Default Constructor.
const StringSet & options() const
Gets the current options list set.
#define ARM_COMPUTE_ERROR(msg)
Print the given message then throw an std::runtime_error.
Definition: Error.h:352
std::string to_string(T &&value)
Convert integer and float values to string.
bool get_wbsm_support_info(const cl::Device &device)
Definition: CLHelpers.cpp:410
const std::vector< unsigned char > & binary() const
Returns program binary data.
CLBuildOptions()
Default constructor.
GPUTarget get_arch_from_target(GPUTarget target)
Helper function to get the GPU arch.
Definition: GPUTarget.cpp:193
decltype(strategy::transforms) typedef type
std::set< std::string > build_options
std::string get_device_version() const
Return the device version.
Copyright (c) 2017-2021 Arm Limited.
void add_option(std::string option)
Adds option to the existing build option list.
std::string name() const
Returns program name.
void add_options(const StringSet &options)
Appends given build options to the current&#39;s objects options.
CLVersion version() const
Returns the device&#39;s CL version.
Definition: CLDevice.h:121
#define ARM_COMPUTE_UNUSED(...)
To avoid unused variables warnings.
Definition: Error.h:152
cl_uint get_num_compute_units() const
Return the maximum number of compute units in the device.
const GPUTarget & target() const
Returns the GPU target of the cl device.
Definition: CLDevice.h:94
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
OpenCL device type class.
Definition: CLDevice.h:43
static bool build(const cl::Program &program, const std::string &build_options="")
Build the given CL program.
bool supported(const std::string &extension) const override
Check if extensions on a device are supported.
Definition: CLDevice.h:141
cl::NDRange default_ndrange() const
Return the default NDRange for the device.
void add_option_if(bool cond, std::string option)
Adds option if a given condition is true;.
GPUTarget get_target_from_device(const cl::Device &device)
Helper function to get the GPU target from CL device.
Definition: CLHelpers.cpp:223
Kernel create_kernel(const std::string &kernel_name, const std::string &program_name, const std::string &program_source, const std::string &kernel_path, const StringSet &build_options_set, bool is_binary) const
Creates an OpenCL kernel.
int stoi(const std::string &str, std::size_t *pos=0, NumericBase base=NumericBase::BASE_10)
Convert string values to integer.
Definition: StringSupport.h:55
void clear_programs_cache()
Clear the library&#39;s cache of binary programs.
Program()
Default constructor.
bool int64_base_atomics_supported() const
Returns true if int64_base_atomics extension is supported by the CL device.
bool fp16_supported() const
Returns true if FP16 is supported by the CL device.
size_t compute_units() const
Returns the number of compute units available.
Definition: CLDevice.h:103
const std::map< std::string, cl::Program > & get_built_programs() const
Access the cache of built OpenCL programs.
GPUTarget
Available GPU Targets.
Definition: GPUTarget.h:34
size_t max_local_workgroup_size(const cl::Kernel &kernel) const
Find the maximum number of local work items in a workgroup can be supported for the kernel...
Wrapper to configure the Khronos OpenCL C++ header.
const cl::Device & cl_device() const
Returns the underlying cl device object.
Definition: CLDevice.h:112
void add_built_program(const std::string &built_program_name, const cl::Program &program) const
Add a new built program to the cache.
void set_context(cl::Context context)
Sets the CL context used to create programs.
std::string name() const
Returns kernel name.
std::string kernel_name
void add_options_if(bool cond, const StringSet &options)
Appends given build options to the current&#39;s objects options if a given condition is true...
void add_option_if_else(bool cond, std::string option_true, std::string option_false)
Adds first option if condition is true else the second one.