| /* |
| * Copyright (c) 2018-2020 Arm Limited. |
| * |
| * SPDX-License-Identifier: MIT |
| * |
| * Permission is hereby granted, free of charge, to any person obtaining a copy |
| * of this software and associated documentation files (the "Software"), to |
| * deal in the Software without restriction, including without limitation the |
| * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| * sell copies of the Software, and to permit persons to whom the Software is |
| * furnished to do so, subject to the following conditions: |
| * |
| * The above copyright notice and this permission notice shall be included in all |
| * copies or substantial portions of the Software. |
| * |
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| * SOFTWARE. |
| */ |
| #ifndef ARM_COMPUTE_CLGEMMRESHAPERHSMATRIXKERNEL_H |
| #define ARM_COMPUTE_CLGEMMRESHAPERHSMATRIXKERNEL_H |
| |
| #include "src/core/CL/ICLKernel.h" |
| |
| namespace arm_compute |
| { |
| class ICLTensor; |
| |
| /** 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 */ |
| class CLGEMMReshapeRHSMatrixKernel : public ICLKernel |
| { |
| public: |
| /** Default constructor */ |
| CLGEMMReshapeRHSMatrixKernel(); |
| /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| CLGEMMReshapeRHSMatrixKernel(const CLGEMMReshapeRHSMatrixKernel &) = delete; |
| /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| CLGEMMReshapeRHSMatrixKernel &operator=(const CLGEMMReshapeRHSMatrixKernel &) = delete; |
| /** Allow instances of this class to be moved */ |
| CLGEMMReshapeRHSMatrixKernel(CLGEMMReshapeRHSMatrixKernel &&) = default; |
| /** Allow instances of this class to be moved */ |
| CLGEMMReshapeRHSMatrixKernel &operator=(CLGEMMReshapeRHSMatrixKernel &&) = default; |
| /** Default destructor */ |
| ~CLGEMMReshapeRHSMatrixKernel() = default; |
| /** 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 @ref CLGEMMMatrixMultiplyReshapedKernel and in @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel |
| * Since the OpenCL image object is created importing the OpenCL buffer, the following conditions are required: |
| * -# rhs_info.n0 can only be 4, 8 and 16 |
| * -# rhs_info.k0 can only be 4, 8 and 16 |
| * -# Data type can only be F32, F16 |
| * -# The platform should support the OpenCL cl_khr_image2d_from_buffer extension |
| * -# output width should be less or equal to (CL_DEVICE_IMAGE2D_MAX_WIDTH * 4) |
| * -# output (height * depth) should be less or equal to CL_DEVICE_IMAGE2D_MAX_HEIGHT |
| * -# The output tensor should be only consumed by @ref CLGEMMMatrixMultiplyReshapedKernel or @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel |
| * |
| * @param[in] input Input tensor. Data types supported: All |
| * @param[out] output Output tensor. Data type supported: same as @p input |
| * @param[in] rhs_info RHS 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 |
| */ |
| 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 @ref CLGEMMMatrixMultiplyReshapedKernel and in @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel |
| * Since the OpenCL image object is created importing the OpenCL buffer, the following conditions are required: |
| * -# rhs_info.n0 can only be 4, 8 and 16 |
| * -# rhs_info.k0 can only be 4, 8 and 16 |
| * -# Data type can only be F32, F16 |
| * -# The platform should support the OpenCL cl_khr_image2d_from_buffer extension |
| * -# output width should be less or equal to (CL_DEVICE_IMAGE2D_MAX_WIDTH * 4) |
| * -# output (height * depth) should be less or equal to CL_DEVICE_IMAGE2D_MAX_HEIGHT |
| * -# The output tensor should be only consumed by @ref CLGEMMMatrixMultiplyReshapedKernel or @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel |
| * |
| * @param[in] compile_context The compile context to be used. |
| * @param[in] input Input tensor. Data types supported: All |
| * @param[out] output Output tensor. Data type supported: same as @p input |
| * @param[in] rhs_info RHS 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 |
| */ |
| void configure(const CLCompileContext &compile_context, const ICLTensor *input, ICLTensor *output, const GEMMRHSMatrixInfo &rhs_info); |
| /** Static function to check if given info will lead to a valid configuration of @ref 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 @ref CLGEMMMatrixMultiplyReshapedKernel and in @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel |
| * Since the OpenCL image object is created importing the OpenCL buffer, the following conditions are required: |
| * -# rhs_info.n0 can only be 4, 8 and 16 |
| * -# rhs_info.k0 can only be 4, 8 and 16 |
| * -# Data type can only be F32, F16 |
| * -# The platform should support the OpenCL cl_khr_image2d_from_buffer extension |
| * -# output width should be less or equal to (CL_DEVICE_IMAGE2D_MAX_WIDTH * 4) |
| * -# output (height * depth) should be less or equal to CL_DEVICE_IMAGE2D_MAX_HEIGHT |
| * -# The output tensor should be only consumed by @ref CLGEMMMatrixMultiplyReshapedKernel or @ref CLGEMMMatrixMultiplyReshapedOnlyRHSKernel |
| * |
| * @param[in] input Input tensor info. Data types supported: All |
| * @param[in] output Output tensor info which stores the interleaved matrix. Data type supported: same as @p input. |
| * @param[in] rhs_info RHS 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 |
| * |
| * @return a status |
| */ |
| static Status validate(const ITensorInfo *input, const ITensorInfo *output, const GEMMRHSMatrixInfo &rhs_info); |
| |
| // Inherited methods overridden |
| void run(const Window &window, cl::CommandQueue &queue) override; |
| |
| private: |
| const ICLTensor *_input; |
| ICLTensor *_output; |
| }; |
| } // namespace arm_compute |
| #endif /* ARM_COMPUTE_CLGEMMRESHAPERHSMATRIXKERNEL_H */ |