src/gpu/cl/kernels/ClMatMulNativeMMULKernel.h

/*
 * Copyright (c) 2023 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 ACL_SRC_GPU_CL_KERNELS_CLMATMULNATIVEMMULKERNEL
#define ACL_SRC_GPU_CL_KERNELS_CLMATMULNATIVEMMULKERNEL

#include "src/core/common/Macros.h"
#include "src/gpu/cl/ClCompileContext.h"
#include "src/gpu/cl/IClKernel.h"

namespace arm_compute
{
struct MatMulKernelInfo;
namespace opencl
{
namespace kernels
{
class ClMatMulNativeMMULKernel : public IClKernel
{
public:
    ClMatMulNativeMMULKernel();
    ARM_COMPUTE_DISALLOW_COPY_ALLOW_MOVE(ClMatMulNativeMMULKernel);
    /** Initialize the kernel's input and output.
     *
     * This kernel performs matrix multiplication of lhs and rhs:
     *
     *  dst = matmul(lhs, rhs)
     *
     * Valid data layouts:
     * - All
     *
     * Valid data type configurations:
     * |lhs            |rhs            |dst            |
     * |:--------------|:--------------|:--------------|
     * |F32            |F32            |F32            |
     * |F16            |F16            |F16            |
     *
     * Shape definitions:
     *       Dim0, Dim1,       Dim2...
     * lhs: [   K,    M, Batch dims...]
     * rhs: [   N,    K, Batch dims...]
     * dst: [   N,    M, Batch dims...]
     *
     * Valid shape configurations:
     * - K must be a multiple of 4 (MMUL_K0).
     * - No broadcasting in batch dimensions. I.e. batch dims must be the same across lhs, rhs and dst
     *
     * @param[in]  compile_context The compile context to be used.
     * @param[in]  lhs             Input tensor info for the LHS matrix.
     * @param[in]  rhs             Input tensor info for the RHS matrix.
     * @param[in]  bias            Bias tensor info. Can be nullptr. Data type supported: Same as @p lhs.
     * @param[out] dst             Output tensor info.
     * @param[in]  matmul_info     Attributes for Batch MatMul Kernel
     */
    void configure(const ClCompileContext &compile_context,
                   ITensorInfo            *lhs,
                   ITensorInfo            *rhs,
                   ITensorInfo            *bias,
                   ITensorInfo            *dst,
                   const MatMulKernelInfo &matmul_info);
    /** Static function to check if given info will lead to a valid configuration
     *
     * Similar to @ref ClMatMulNativeMMULKernel::configure()
     *
     * @return a status
     */
    static Status validate(const ITensorInfo      *lhs,
                           const ITensorInfo      *rhs,
                           const ITensorInfo      *bias,
                           const ITensorInfo      *dst,
                           const MatMulKernelInfo &matmul_info);

    // Inherited methods overridden:
    void run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) override;

private:
    int _m{1};
    int _n{1};
    int _k{1};
};
} // namespace kernels
} // namespace opencl
} // namespace arm_compute
#endif /* ACL_SRC_GPU_CL_KERNELS_CLMATMULNATIVEMMULKERNEL */