Compute Library
 21.02
GCTransposeKernel.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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 
26 #include "arm_compute/core/Error.h"
32 #include "arm_compute/core/Types.h"
36 #include "support/StringSupport.h"
37 
38 #include <set>
39 #include <string>
40 
41 using namespace arm_compute;
42 
44 {
47 
49  const size_t w_out = input->info()->dimension(1);
50  const size_t h_out = input->info()->dimension(0);
51  output_shape.set(0, w_out);
52  output_shape.set(1, h_out);
53 
54  // Output tensor auto inizialitation if not yet initialized
55  auto_init_if_empty(*output->info(), output_shape, 1, input->info()->data_type());
56 
59 
60  _input = input;
61  _output = output;
62 
63  // for better performance
64  if(w_out < 512 && h_out < 512)
65  {
66  _lws_hint = gles::NDRange(8U, 1U, 1U);
67  }
68  else
69  {
70  _lws_hint = gles::NDRange(1U, 8U, 1U);
71  }
72 
73  std::set<std::string> build_opts;
74  std::string dt_name = (input->info()->data_type() == DataType::F32) ? "DATA_TYPE_FP32" : "DATA_TYPE_FP16";
75  build_opts.emplace(("#define " + dt_name));
76  build_opts.emplace("#define LOCAL_SIZE_X " + support::cpp11::to_string(_lws_hint[0]));
77  build_opts.emplace("#define LOCAL_SIZE_Y " + support::cpp11::to_string(_lws_hint[1]));
78  build_opts.emplace("#define LOCAL_SIZE_Z " + support::cpp11::to_string(_lws_hint[2]));
79 
80  // Configure kernel window
81  unsigned int num_elems_processed_per_iteration = 4;
82 
83  if(input->info()->data_type() == DataType::F16)
84  {
85 #define TRANSPOSE_8X8
86 
87 #if defined(TRANSPOSE_4X4)
88  build_opts.emplace(("#define TRANSPOSE_4X4"));
89  num_elems_processed_per_iteration = 4;
90 #elif defined(TRANSPOSE_8X8) /* TRANSPOSE_4X4 */
91  if(w_out != h_out)
92  {
93  build_opts.emplace("#define TRANSPOSE_8X8");
94  num_elems_processed_per_iteration = 8;
95  }
96  else
97  {
98  build_opts.emplace("#define TRANSPOSE_8X8_SQUARE");
99  num_elems_processed_per_iteration = 8;
100  }
101 #endif /* TRANSPOSE_4X4 */
102  }
103 
104  // Create kernel
105  _kernel = static_cast<GCKernel>(GCKernelLibrary::get().create_kernel("transpose", build_opts));
106 
107  const unsigned int width_aligned = num_elems_processed_per_iteration * static_cast<unsigned int>(_lws_hint[0]);
108  const unsigned int height_aligned = num_elems_processed_per_iteration * static_cast<unsigned int>(_lws_hint[1]);
109 
110  AccessWindowStatic input_access(input->info(), 0, 0,
111  ceil_to_multiple(input->info()->dimension(0), width_aligned),
112  ceil_to_multiple(input->info()->dimension(1), height_aligned));
113  AccessWindowStatic output_access(output->info(), 0, 0,
114  ceil_to_multiple(output->info()->dimension(0), height_aligned),
115  ceil_to_multiple(output->info()->dimension(1), width_aligned));
116 
117  Window win = calculate_max_window(*input->info(), Steps(width_aligned, height_aligned));
118  win.set_dimension_step(Window::DimX, num_elems_processed_per_iteration);
119  win.set_dimension_step(Window::DimY, num_elems_processed_per_iteration);
120  update_window_and_padding(win, input_access, output_access);
121  output_access.set_valid_region(win, output->info()->valid_region());
122 
123  IGCKernel::configure(win);
124 }
125 
127 {
130 
131  _kernel.use();
132 
134 
135  do
136  {
137  unsigned int idx = 0;
138 
139  add_2D_tensor_argument(idx, _input, 1, slice);
140  add_2D_tensor_argument(idx, _output, 2, slice);
141  _kernel.update_shader_params();
142  enqueue(*this, slice, _lws_hint);
143  }
144  while(window.slide_window_slice_2D(slice));
145 }
Window first_slice_window_2D() const
First 2D slice of the window.
Definition: Window.h:283
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
Shape of a tensor.
Definition: TensorShape.h:39
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.
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.
1 channel, 1 F32 per channel
Interface for GLES Compute tensor.
Definition: IGCTensor.h:35
GCKernel class.
bool slide_window_slice_2D(Window &slice) const
Slide the passed 2D window slice.
Definition: Window.h:323
Copyright (c) 2017-2021 Arm Limited.
1 channel, 1 F16 per channel
virtual ValidRegion valid_region() const =0
Valid region of the tensor.
Implementation of a static rectangular access pattern.
static constexpr size_t DimX
Alias for dimension 0 also known as X dimension.
Definition: Window.h:43
bool update_window_and_padding(Window &win, Ts &&... patterns)
Update window and padding size for each of the access patterns.
Definition: WindowHelpers.h:46
virtual const TensorShape & tensor_shape() const =0
Size for each dimension of the tensor.
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_DATA_TYPES(...)
Definition: Validate.h:543
auto ceil_to_multiple(S value, T divisor) -> decltype(((value+divisor - 1)/divisor) *divisor)
Computes the smallest number larger or equal to value that is a multiple of divisor.
Definition: Utils.h:71
Manages all the GLES kernels compilation and caching, provides accessors for the GLES Context...
Class to describe a number of elements in each dimension.
Definition: Steps.h:40
bool auto_init_if_empty(ITensorInfo &info, const TensorShape &shape, int num_channels, DataType data_type, QuantizationInfo quantization_info=QuantizationInfo())
Auto initialize the tensor info (shape, number of channels and data type) if the current assignment i...
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
void add_2D_tensor_argument(unsigned int &idx, const IGCTensor *tensor, const unsigned int binding_point, 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: IGCKernel.cpp:127
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
#define ARM_COMPUTE_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(t, c,...)
Definition: Validate.h:790
static constexpr size_t DimY
Alias for dimension 1 also known as Y dimension.
Definition: Window.h:45
Wrapper to configure the Khronos EGL and OpenGL ES C header.
static GCKernelLibrary & get()
Get the static instance of GCKernelLibrary.
void set_dimension_step(size_t dimension, int step)
Set the step of a given dimension.
Definition: Window.inl:167
#define ARM_COMPUTE_ERROR_ON_MISMATCHING_DIMENSIONS(...)
Definition: Validate.h:286
void run(const Window &window) override
Enqueue the OpenGL ES shader to process the given window.
Class interface for specifying NDRange values.
Definition: OpenGLES.h:53
GCKernel create_kernel(const std::string &shader_name, const StringSet &build_options_set={}) const
Creates a kernel from the kernel library.
unsigned int num_elems_processed_per_iteration
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161
void configure(const IGCTensor *input, IGCTensor *output)
Initialise the kernel&#39;s input and output.
Describe a multidimensional execution window.
Definition: Window.h:39
TensorShape & set(size_t dimension, size_t value, bool apply_dim_correction=true, bool increase_dim_unit=true)
Accessor to set the value of one of the dimensions.
Definition: TensorShape.h:79
void set_valid_region(const Window &window, const ValidRegion &input_valid_region)
Set the valid region based on the static access pattern and valid region of the inputs.
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)