Compute Library
 21.02
CLDerivativeKernel.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 
32 #include "support/StringSupport.h"
33 
34 #include <set>
35 #include <string>
36 
37 using namespace arm_compute;
38 
40  : _input(nullptr), _output_x(nullptr), _output_y(nullptr), _run_derivative_x(false), _run_derivative_y(false)
41 {
42 }
43 
45 {
46  return BorderSize(1);
47 }
48 
49 void CLDerivativeKernel::configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
50 {
51  configure(CLKernelLibrary::get().get_compile_context(), input, output_x, output_y, border_undefined);
52 }
53 
54 void CLDerivativeKernel::configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
55 {
57  ARM_COMPUTE_ERROR_ON((output_x == nullptr) && (output_y == nullptr));
58 
59  _run_derivative_x = output_x != nullptr;
60  _run_derivative_y = output_y != nullptr;
61 
62  if(_run_derivative_x)
63  {
65  }
66 
67  if(_run_derivative_y)
68  {
70  }
71 
72  _input = input;
73  _output_x = output_x;
74  _output_y = output_y;
75 
76  // Set build options
77  std::set<std::string> build_opts;
78 
79  if(_run_derivative_x)
80  {
81  build_opts.insert("-DGRAD_X");
82  }
83 
84  if(_run_derivative_y)
85  {
86  build_opts.insert("-DGRAD_Y");
87  }
88 
89  // Create kernel
90  const std::string kernel_name = std::string("derivative");
91  _kernel = create_kernel(compile_context, kernel_name, build_opts);
92 
93  // Configure kernel window
94  constexpr unsigned int num_elems_processed_per_iteration = 16;
95  constexpr unsigned int num_read_rows_per_iteration = 3;
96 
97  Window win = calculate_max_window(*input->info(), Steps(num_elems_processed_per_iteration), border_undefined, border_size());
98 
99  AccessWindowRectangle input_access(input->info(), 0, 0, 0, 0);
100  AccessWindowHorizontal output_x_access(output_x == nullptr ? nullptr : output_x->info(), 0, num_elems_processed_per_iteration);
101  AccessWindowHorizontal output_y_access(output_y == nullptr ? nullptr : output_y->info(), 0, num_elems_processed_per_iteration);
102  if(_run_derivative_x && _run_derivative_y)
103  {
104  // TODO(COMPMID-415) Fix x-access input bug in CL kernel instead of '+2'
105  input_access = AccessWindowRectangle(input->info(), -border_size().left, -border_size().top, num_elems_processed_per_iteration + 2, num_read_rows_per_iteration);
106  }
107  else if(_run_derivative_x)
108  {
109  // TODO(COMPMID-415) Fix x-access input bug in CL kernel instead of '+2'
110  input_access = AccessWindowHorizontal(input->info(), -border_size().left, num_elems_processed_per_iteration + 2);
111  }
112  else if(_run_derivative_y)
113  {
114  input_access = AccessWindowRectangle(input->info(), 0, -border_size().top, num_elems_processed_per_iteration, num_read_rows_per_iteration);
115  }
116 
118  input_access,
119  output_x_access,
120  output_y_access);
121 
122  output_x_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
123  output_y_access.set_valid_region(win, input->info()->valid_region(), border_undefined, border_size());
124 
125  ICLKernel::configure_internal(win);
126 
127  // Set config_id for enabling LWS tuning
128  _config_id = kernel_name;
129  _config_id += "_";
130  _config_id += lower_string(string_from_data_type(input->info()->data_type()));
131  _config_id += "_";
132  _config_id += support::cpp11::to_string(input->info()->dimension(0));
133  _config_id += "_";
134  _config_id += support::cpp11::to_string(input->info()->dimension(1));
135  _config_id += "_";
136  _config_id += support::cpp11::to_string(border_undefined);
137 }
138 
139 void CLDerivativeKernel::run(const Window &window, cl::CommandQueue &queue)
140 {
143 
145  do
146  {
147  unsigned int idx = 0;
148  add_2D_tensor_argument(idx, _input, slice);
149  add_2D_tensor_argument_if((_run_derivative_x), idx, _output_x, slice);
150  add_2D_tensor_argument_if((_run_derivative_y), idx, _output_y, slice);
151 
152  enqueue(queue, *this, slice, lws_hint());
153  }
154  while(window.slide_window_slice_2D(slice));
155 }
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:283
unsigned int top
top of the border
Definition: Types.h:375
Window calculate_max_window(const ValidRegion &valid_region, const Steps &steps, bool skip_border, BorderSize border_size)
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
CLDerivativeKernel()
Default constructor.
void add_2D_tensor_argument_if(bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 2D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx ...
Definition: ICLKernel.h:159
void enqueue(IGCKernel &kernel, const Window &window, const gles::NDRange &lws=gles::NDRange(1U, 1U, 1U))
Add the kernel to the command queue with the given window.
Definition: IGCKernel.cpp:41
virtual size_t dimension(size_t index) const =0
Return the size of the requested dimension.
Container for 2D border size.
Definition: Types.h:273
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:276
1 channel, 1 U8 per channel
std::string to_string(T &&value)
Convert integer and float values to string.
virtual DataType data_type() const =0
Data type used for each element of the tensor.
#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
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
std::string lower_string(const std::string &val)
Lower a given string.
Definition: Utils.cpp:350
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:323
Copyright (c) 2017-2021 Arm Limited.
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
BorderSize border_size() const override
The size of the border for that kernel.
Implementation of a rectangular access pattern.
cl::Kernel create_kernel(const CLCompileContext &ctx, const std::string &kernel_name, const std::set< std::string > &build_opts=std::set< std::string >())
Creates an opencl kernel using a compile context.
Definition: CLHelpers.cpp:403
const std::string & string_from_data_type(DataType dt)
Convert a data type identity into a string.
Definition: Utils.cpp:135
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: WindowHelpers.h:46
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
Implementation of a row access pattern.
std::string kernel_name
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
void run(const Window &window, cl::CommandQueue &queue) override
Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue...
void configure(const ICLTensor *input, ICLTensor *output_x, ICLTensor *output_y, bool border_undefined)
Initialise the kernel&#39;s sources, destination and border.
unsigned int left
left of the border
Definition: Types.h:378
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
1 channel, 1 S16 per channel
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
CLCompileContext class.
void add_2D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 2D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:148
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Manages all the OpenCL kernels compilation and caching, provides accessors for the OpenCL Context...
Wrapper to configure the Khronos OpenCL C++ header.
unsigned int num_elems_processed_per_iteration
Describe a multidimensional execution window.
Definition: Window.h:39
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)