Compute Library
 21.02
CLGEMMReshapeRHSMatrixKernel Class Reference

OpenCL kernel to reshape the RHS matrix when performing the matrix multiplication In particular, this kernel splits the input matrix in blocks of size K0xN0 and stores each one in the output matrix unrolling the values. More...

#include <CLGEMMReshapeRHSMatrixKernel.h>

Collaboration diagram for CLGEMMReshapeRHSMatrixKernel:
[legend]

Public Member Functions

 CLGEMMReshapeRHSMatrixKernel ()
 Default constructor. More...
 
 CLGEMMReshapeRHSMatrixKernel (const CLGEMMReshapeRHSMatrixKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
CLGEMMReshapeRHSMatrixKerneloperator= (const CLGEMMReshapeRHSMatrixKernel &)=delete
 Prevent instances of this class from being copied (As this class contains pointers) More...
 
 CLGEMMReshapeRHSMatrixKernel (CLGEMMReshapeRHSMatrixKernel &&)=default
 Allow instances of this class to be moved. More...
 
CLGEMMReshapeRHSMatrixKerneloperator= (CLGEMMReshapeRHSMatrixKernel &&)=default
 Allow instances of this class to be moved. More...
 
 ~CLGEMMReshapeRHSMatrixKernel ()=default
 Default destructor. More...
 
void configure (const ICLTensor *input, ICLTensor *output, const GEMMRHSMatrixInfo &rhs_info)
 Initialise the kernel's input and output. More...
 
void configure (const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const GEMMRHSMatrixInfo &rhs_info)
 Initialise the kernel's input and output. More...
 
void run (const Window &window, cl::CommandQueue &queue) override
 Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue. More...
 
- Public Member Functions inherited from ICLKernel
 ICLKernel ()
 Constructor. More...
 
cl::Kernel & kernel ()
 Returns a reference to the OpenCL kernel of this object. More...
 
template<typename T >
void add_1D_array_argument (unsigned int &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed 1D array's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_1D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 1D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_2D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_2D_tensor_argument_if (bool cond, unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 2D tensor's parameters to the object's kernel's arguments starting from the index idx if the condition is true. More...
 
void add_3D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 3D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
void add_4D_tensor_argument (unsigned int &idx, const ICLTensor *tensor, const Window &window)
 Add the passed 4D tensor's parameters to the object's kernel's arguments starting from the index idx. More...
 
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. More...
 
template<typename T >
void add_argument (unsigned int &idx, T value)
 Add the passed parameters to the object's kernel's arguments starting from the index idx. More...
 
void set_lws_hint (const cl::NDRange &lws_hint)
 Set the Local-Workgroup-Size hint. More...
 
cl::NDRange lws_hint () const
 Return the Local-Workgroup-Size hint. More...
 
void set_wbsm_hint (const cl_int &wbsm_hint)
 Set the workgroup batch size modifier hint. More...
 
cl_int wbsm_hint () const
 Return the workgroup batch size modifier hint. More...
 
const std::string & config_id () const
 Get the configuration ID. More...
 
void set_target (GPUTarget target)
 Set the targeted GPU architecture. More...
 
void set_target (cl::Device &device)
 Set the targeted GPU architecture according to the CL device. More...
 
GPUTarget get_target () const
 Get the targeted GPU architecture. More...
 
size_t get_max_workgroup_size ()
 Get the maximum workgroup size for the device the CLKernelLibrary uses. More...
 
template<unsigned int dimension_size>
void add_tensor_argument (unsigned &idx, const ICLTensor *tensor, const Window &window)
 
template<typename T , unsigned int dimension_size>
void add_array_argument (unsigned &idx, const ICLArray< T > *array, const Strides &strides, unsigned int num_dimensions, const Window &window)
 Add the passed array's parameters to the object's kernel's arguments starting from the index idx. More...
 
- Public Member Functions inherited from IKernel
 IKernel ()
 Constructor. More...
 
virtual ~IKernel ()=default
 Destructor. More...
 
virtual bool is_parallelisable () const
 Indicates whether or not the kernel is parallelisable. More...
 
virtual BorderSize border_size () const
 The size of the border for that kernel. More...
 
const Windowwindow () const
 The maximum window the kernel can be executed on. More...
 

Static Public Member Functions

static Status validate (const ITensorInfo *input, const ITensorInfo *output, const GEMMRHSMatrixInfo &rhs_info)
 Static function to check if given info will lead to a valid configuration of CLGEMMReshapeRHSMatrixKernel. More...
 
- Static Public Member Functions inherited from ICLKernel
static constexpr unsigned int num_arguments_per_1D_array ()
 Returns the number of arguments enqueued per 1D array object. More...
 
static constexpr unsigned int num_arguments_per_1D_tensor ()
 Returns the number of arguments enqueued per 1D tensor object. More...
 
static constexpr unsigned int num_arguments_per_2D_tensor ()
 Returns the number of arguments enqueued per 2D tensor object. More...
 
static constexpr unsigned int num_arguments_per_3D_tensor ()
 Returns the number of arguments enqueued per 3D tensor object. More...
 
static constexpr unsigned int num_arguments_per_4D_tensor ()
 Returns the number of arguments enqueued per 4D tensor object. More...
 
static cl::NDRange gws_from_window (const Window &window)
 Get the global work size given an execution window. More...
 

Detailed Description

OpenCL kernel to reshape the RHS matrix when performing the matrix multiplication In particular, this kernel splits the input matrix in blocks of size K0xN0 and stores each one in the output matrix unrolling the values.

Definition at line 36 of file CLGEMMReshapeRHSMatrixKernel.h.

Constructor & Destructor Documentation

◆ CLGEMMReshapeRHSMatrixKernel() [1/3]

Default constructor.

Definition at line 109 of file CLGEMMReshapeRHSMatrixKernel.cpp.

110  : _input(nullptr), _output(nullptr)
111 {
112 }

◆ CLGEMMReshapeRHSMatrixKernel() [2/3]

Prevent instances of this class from being copied (As this class contains pointers)

◆ CLGEMMReshapeRHSMatrixKernel() [3/3]

Allow instances of this class to be moved.

◆ ~CLGEMMReshapeRHSMatrixKernel()

Default destructor.

Member Function Documentation

◆ configure() [1/2]

void configure ( const ICLTensor input,
ICLTensor output,
const GEMMRHSMatrixInfo rhs_info 
)

Initialise the kernel's input and output.

Note
If rhs_info.export_to_cl_image = true, this OpenCL kernel will guarantee the OpenCL pitch alignment for the output tensor, required to create a OpenCL image object from buffer in CLGEMMMatrixMultiplyReshapedKernel and in CLGEMMMatrixMultiplyReshapedOnlyRHSKernel Since the OpenCL image object is created importing the OpenCL buffer, the following conditions are required:
  1. rhs_info.n0 can only be 4, 8 and 16
  2. rhs_info.k0 can only be 4, 8 and 16
  3. Data type can only be F32, F16
  4. The platform should support the OpenCL cl_khr_image2d_from_buffer extension
  5. output width should be less or equal to (CL_DEVICE_IMAGE2D_MAX_WIDTH * 4)
  6. output (height * depth) should be less or equal to CL_DEVICE_IMAGE2D_MAX_HEIGHT
  7. The output tensor should be only consumed by CLGEMMMatrixMultiplyReshapedKernel or CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Parameters
[in]inputInput tensor. Data types supported: All
[out]outputOutput tensor. Data type supported: same as input
[in]rhs_infoRHS matrix information to be used for reshaping. This object contains all the necessary information to reshape the input tensor. Only the following values are supported: rhs_info.n0: 2,3,4,8,16 (only 4, 8 and 16 if rhs_info.export_to_cl_image == true) rhs_info.k0: 1,2,3,4,8,16 (k0 = 1 only if rhs_info.transpose = false), (only 4, 8 and 16 if rhs_info.export_to_cl_image == true) rhs_info.h0: greater than 0 rhs_info.transpose: true, false rhs_info.interleave: true, false

Definition at line 114 of file CLGEMMReshapeRHSMatrixKernel.cpp.

References CLKernelLibrary::get().

Referenced by arm_compute::test::validation::DATA_TEST_CASE().

115 {
116  configure(CLKernelLibrary::get().get_compile_context(), input, output, rhs_info);
117 }
static CLKernelLibrary & get()
Access the KernelLibrary singleton.
void configure(const ICLTensor *input, ICLTensor *output, const GEMMRHSMatrixInfo &rhs_info)
Initialise the kernel&#39;s input and output.

◆ configure() [2/2]

void configure ( const CLCompileContext compile_context,
const ICLTensor input,
ICLTensor output,
const GEMMRHSMatrixInfo rhs_info 
)

Initialise the kernel's input and output.

Note
If rhs_info.export_to_cl_image = true, this OpenCL kernel will guarantee the OpenCL pitch alignment for the output tensor, required to create a OpenCL image object from buffer in CLGEMMMatrixMultiplyReshapedKernel and in CLGEMMMatrixMultiplyReshapedOnlyRHSKernel Since the OpenCL image object is created importing the OpenCL buffer, the following conditions are required:
  1. rhs_info.n0 can only be 4, 8 and 16
  2. rhs_info.k0 can only be 4, 8 and 16
  3. Data type can only be F32, F16
  4. The platform should support the OpenCL cl_khr_image2d_from_buffer extension
  5. output width should be less or equal to (CL_DEVICE_IMAGE2D_MAX_WIDTH * 4)
  6. output (height * depth) should be less or equal to CL_DEVICE_IMAGE2D_MAX_HEIGHT
  7. The output tensor should be only consumed by CLGEMMMatrixMultiplyReshapedKernel or CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Parameters
[in]compile_contextThe compile context to be used.
[in]inputInput tensor. Data types supported: All
[out]outputOutput tensor. Data type supported: same as input
[in]rhs_infoRHS matrix information to be used for reshaping. This object contains all the necessary information to reshape the input tensor. Only the following values are supported: rhs_info.n0: 2,3,4,8,16 (only 4, 8 and 16 if rhs_info.export_to_cl_image == true) rhs_info.k0: 1,2,3,4,8,16 (k0 = 1 only if rhs_info.transpose = false), (only 4, 8 and 16 if rhs_info.export_to_cl_image == true) rhs_info.h0: greater than 0 rhs_info.transpose: true, false rhs_info.interleave: true, false

Definition at line 119 of file CLGEMMReshapeRHSMatrixKernel.cpp.

References CLBuildOptions::add_option(), CLBuildOptions::add_option_if(), ARM_COMPUTE_ERROR_ON_NULLPTR, ARM_COMPUTE_ERROR_THROW_ON, arm_compute::create_kernel(), ITensorInfo::dimension(), ITensorInfo::element_size(), arm_compute::get_cl_unsigned_type_from_element_size(), GEMMRHSMatrixInfo::h0, ITensor::info(), arm_compute::test::validation::input, GEMMRHSMatrixInfo::interleave, GEMMRHSMatrixInfo::k0, kernel_name, GEMMRHSMatrixInfo::n0, CLBuildOptions::options(), arm_compute::support::cpp11::to_string(), GEMMRHSMatrixInfo::transpose, and arm_compute::validate_arguments().

120 {
122 
123  // Perform validate step
124  ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), output->info(), rhs_info));
125 
126  _input = input;
127  _output = output;
128 
129  // Create build options
130  CLBuildOptions build_opts;
131  build_opts.add_option("-DN0=" + support::cpp11::to_string(rhs_info.n0));
132  build_opts.add_option("-DK0=" + support::cpp11::to_string(rhs_info.k0));
133  build_opts.add_option("-DH0=" + support::cpp11::to_string(rhs_info.h0));
134  build_opts.add_option_if(rhs_info.transpose, "-DTRANSPOSE");
135  build_opts.add_option_if(rhs_info.interleave, "-DINTERLEAVE");
136  build_opts.add_option("-DSRC_HEIGHT=" + support::cpp11::to_string(input->info()->dimension(1)));
137  build_opts.add_option("-DDATA_TYPE=" + get_cl_unsigned_type_from_element_size(input->info()->element_size()));
138 
139  std::string kernel_name("gemm_reshape_rhs_matrix_");
140  kernel_name += rhs_info.transpose ? "t" : "nt";
141 
142  // Create kernel
143  _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
144 
145  // Configure kernel window
146  auto win_config = validate_and_configure_window(input->info(), output->info(), rhs_info);
147  ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
148  ICLKernel::configure_internal(win_config.second);
149 }
std::string to_string(T &&value)
Convert integer and float values to string.
#define ARM_COMPUTE_ERROR_THROW_ON(status)
Definition: Error.h:455
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
std::string kernel_name
std::string get_cl_unsigned_type_from_element_size(size_t element_size)
Translates the element size to an unsigned integer data type.
Definition: CLHelpers.cpp:103
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)
#define ARM_COMPUTE_ERROR_ON_NULLPTR(...)
Definition: Validate.h:161

◆ operator=() [1/2]

Prevent instances of this class from being copied (As this class contains pointers)

◆ operator=() [2/2]

Allow instances of this class to be moved.

◆ run()

void run ( const Window window,
cl::CommandQueue &  queue 
)
overridevirtual

Enqueue the OpenCL kernel to process the given window on the passed OpenCL command queue.

Note
The queue is not flushed by this method, and therefore the kernel will not have been executed by the time this method returns.
Parameters
[in]windowRegion on which to execute the kernel. (Must be a valid region of the window returned by window()).
[in,out]queueCommand queue on which to enqueue the kernel.

Reimplemented from ICLKernel.

Definition at line 159 of file CLGEMMReshapeRHSMatrixKernel.cpp.

References ICLKernel::add_3D_tensor_argument(), ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW, ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL, arm_compute::enqueue(), Window::first_slice_window_3D(), ICLKernel::lws_hint(), arm_compute::test::validation::reference::slice(), Window::slide_window_slice_3D(), and IKernel::window().

160 {
163 
165 
166  do
167  {
168  unsigned int idx = 0;
169  add_3D_tensor_argument(idx, _input, slice);
170  add_3D_tensor_argument(idx, _output, slice);
171  enqueue(queue, *this, slice, lws_hint());
172  }
173  while(window.slide_window_slice_3D(slice));
174 }
const Window & window() const
The maximum window the kernel can be executed on.
Definition: IKernel.cpp:28
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
cl::NDRange lws_hint() const
Return the Local-Workgroup-Size hint.
Definition: ICLKernel.h:276
void add_3D_tensor_argument(unsigned int &idx, const ICLTensor *tensor, const Window &window)
Add the passed 3D tensor&#39;s parameters to the object&#39;s kernel&#39;s arguments starting from the index idx...
Definition: ICLKernel.h:172
bool slide_window_slice_3D(Window &slice) const
Slide the passed 3D window slice.
Definition: Window.h:335
#define ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(k)
Definition: Validate.h:941
Window first_slice_window_3D() const
First 3D slice of the window.
Definition: Window.h:291
#define ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(f, s)
Definition: Validate.h:205
SimpleTensor< T > slice(const SimpleTensor< T > &src, Coordinates starts, Coordinates ends)

◆ validate()

Status validate ( const ITensorInfo input,
const ITensorInfo output,
const GEMMRHSMatrixInfo rhs_info 
)
static

Static function to check if given info will lead to a valid configuration of CLGEMMReshapeRHSMatrixKernel.

Note
If rhs_info.export_to_cl_image = true, this OpenCL kernel will guarantee the OpenCL pitch alignment for the output tensor, required to create a OpenCL image object from buffer in CLGEMMMatrixMultiplyReshapedKernel and in CLGEMMMatrixMultiplyReshapedOnlyRHSKernel Since the OpenCL image object is created importing the OpenCL buffer, the following conditions are required:
  1. rhs_info.n0 can only be 4, 8 and 16
  2. rhs_info.k0 can only be 4, 8 and 16
  3. Data type can only be F32, F16
  4. The platform should support the OpenCL cl_khr_image2d_from_buffer extension
  5. output width should be less or equal to (CL_DEVICE_IMAGE2D_MAX_WIDTH * 4)
  6. output (height * depth) should be less or equal to CL_DEVICE_IMAGE2D_MAX_HEIGHT
  7. The output tensor should be only consumed by CLGEMMMatrixMultiplyReshapedKernel or CLGEMMMatrixMultiplyReshapedOnlyRHSKernel
Parameters
[in]inputInput tensor info. Data types supported: All
[in]outputOutput tensor info which stores the interleaved matrix. Data type supported: same as input.
[in]rhs_infoRHS matrix information to be used for reshaping. This object contains all the necessary information to reshape the input tensor. Only the following values are supported: rhs_info.n0: 2,3,4,8,16 (only 4, 8 and 16 if rhs_info.export_to_cl_image == true) rhs_info.k0: 1,2,3,4,8,16 (k0 = 1 only if rhs_info.transpose = false),(only 4, 8 and 16 if rhs_info.export_to_cl_image == true) rhs_info.h0: greater than 0 rhs_info.transpose: true, false rhs_info.interleave: true, false
Returns
a status

Definition at line 151 of file CLGEMMReshapeRHSMatrixKernel.cpp.

References ARM_COMPUTE_RETURN_ON_ERROR, ICloneable< T >::clone(), and arm_compute::validate_arguments().

Referenced by CLGEMMReshapeRHSMatrixKernelManaged::configure(), arm_compute::test::validation::DATA_TEST_CASE(), and CLGEMMLowpMatrixMultiplyCore::validate().

152 {
154  ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), output->clone().get(), rhs_info).first);
155 
156  return Status{};
157 }
#define ARM_COMPUTE_RETURN_ON_ERROR(status)
Checks if a status contains an error and returns it.
Definition: Error.h:204
Status validate_arguments(const ITensorInfo *input, const ITensorInfo *bias, const ITensorInfo *output, const GEMMLowpOutputStageInfo *output_stage)

The documentation for this class was generated from the following files: