giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2019 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_CLGEMMMATRIXMULTIPLYNATIVEKERNEL_H |
| 25 | #define ARM_COMPUTE_CLGEMMMATRIXMULTIPLYNATIVEKERNEL_H |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/CL/ICLKernel.h" |
| 28 | |
Gian Marco Iodice | 7026b30 | 2019-06-26 17:18:11 +0100 | [diff] [blame] | 29 | #include "arm_compute/core/KernelDescriptors.h" |
| 30 | |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 31 | namespace arm_compute |
| 32 | { |
| 33 | class ICLTensor; |
| 34 | |
| 35 | /** OpenCL kernel to multiply matrices when neither of the input matrices have been reshaped */ |
| 36 | class CLGEMMMatrixMultiplyNativeKernel : public ICLKernel |
| 37 | { |
| 38 | public: |
| 39 | /** Default Constructor */ |
| 40 | CLGEMMMatrixMultiplyNativeKernel(); |
| 41 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 42 | CLGEMMMatrixMultiplyNativeKernel(const CLGEMMMatrixMultiplyNativeKernel &) = delete; |
| 43 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 44 | CLGEMMMatrixMultiplyNativeKernel &operator=(const CLGEMMMatrixMultiplyNativeKernel &) = delete; |
| 45 | /** Allow instances of this class to be moved */ |
| 46 | CLGEMMMatrixMultiplyNativeKernel(CLGEMMMatrixMultiplyNativeKernel &&) = default; |
| 47 | /** Allow instances of this class to be moved */ |
| 48 | CLGEMMMatrixMultiplyNativeKernel &operator=(CLGEMMMatrixMultiplyNativeKernel &&) = default; |
| 49 | /** Initialise the kernel's input and output. |
| 50 | * |
Gian Marco Iodice | d820db6 | 2019-08-05 14:23:23 +0100 | [diff] [blame] | 51 | * @param[in] input0 Input tensor for the LHS matrix. Data type supported: F32. The number of dimensions for the LHS matrix must be less or equal than 4. |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 52 | * @param[in] input1 Input tensor for the RHS matrix. Data type supported: same as @p input0. The number of dimensions for the RHS matrix must be less or equal than 3. |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 53 | * @param[in] input2 Input tensor containing the bias matrix. Data type supported: same as @p input0. |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 54 | * @param[out] output Output tensor info. Data type supported: same as @p input0 |
| 55 | * @param[in] alpha Weight of the matrix product |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 56 | * @param[in] beta Weight of the matrix bias |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 57 | * @param[in] lhs_info LHS matrix information used to retrieve the number of rows and accumulations to be processed by each thread. Only the following values are supported: |
| 58 | * lhs_info.m0: 1,2,3,4,5,6,7,8 |
| 59 | * lhs_info.k0: 2,3,4,8,16 |
| 60 | * @param[in] rhs_info RHS matrix information used to retrieve the number of columns and accumulations to be processed by each thread. Only the following values are supported: |
| 61 | * rhs_info.n0: 2,3,4,8,16 |
| 62 | * rhs_info.k0: same of lhs_info.k0 |
| 63 | * @param[in] gemm_info GEMM information used to retrieve the original dimensions of the input matrices |
| 64 | */ |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 65 | void configure(const ICLTensor *input0, const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, float alpha, float beta, const GEMMLHSMatrixInfo &lhs_info, |
| 66 | const GEMMRHSMatrixInfo &rhs_info, |
Gian Marco Iodice | 7026b30 | 2019-06-26 17:18:11 +0100 | [diff] [blame] | 67 | const GEMMKernelInfo &gemm_info); |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 68 | /** Static function to check if given info will lead to a valid configuration of @ref CLGEMMMatrixMultiplyNativeKernel |
| 69 | * |
Gian Marco Iodice | d820db6 | 2019-08-05 14:23:23 +0100 | [diff] [blame] | 70 | * @param[in] input0 Input tensor info for the LHS matrix. Data type supported: F32. The number of dimensions for the LHS matrix must be less or equal than 4. |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 71 | * @param[in] input1 Input tensor info for the RHS matrix. Data type supported: same as @p input0. The number of dimensions for the RHS matrix must be less or equal than 3. |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 72 | * @param[in] input2 Input tensor info containing the bias matrix. Data type supported: same as @p input0. |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 73 | * @param[in] output Output tensor info. Data type supported: same as @p input0 |
| 74 | * @param[in] alpha Weight of the matrix product |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 75 | * @param[in] beta Weight of the matrix bias |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 76 | * @param[in] lhs_info LHS matrix information used to retrieve the number of rows and accumulations to be processed by each thread. Only the following values are supported: |
| 77 | * lhs_info.m0: 1,2,3,4,5,6,7,8 |
| 78 | * lhs_info.k0: 2,3,4,8,16 |
| 79 | * @param[in] rhs_info RHS matrix information used to retrieve the number of columns and accumulations to be processed by each thread. Only the following values are supported: |
| 80 | * rhs_info.n0: 2,3,4,8,16 |
| 81 | * rhs_info.k0: same of lhs_info.k0 |
| 82 | * @param[in] gemm_info GEMM information used to retrieve the original dimensions of the input matrices |
| 83 | * |
| 84 | * @return a status |
| 85 | */ |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 86 | static Status validate(const ITensorInfo *input0, const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, float alpha, float beta, const GEMMLHSMatrixInfo &lhs_info, |
| 87 | const GEMMRHSMatrixInfo &rhs_info, |
Gian Marco Iodice | 7026b30 | 2019-06-26 17:18:11 +0100 | [diff] [blame] | 88 | const GEMMKernelInfo &gemm_info); |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 89 | |
| 90 | // Inherited methods overridden: |
| 91 | void run(const Window &window, cl::CommandQueue &queue) override; |
| 92 | |
| 93 | private: |
| 94 | const ICLTensor *_input0; |
| 95 | const ICLTensor *_input1; |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 96 | const ICLTensor *_input2; |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 97 | ICLTensor *_output; |
| 98 | bool _slide_matrix_b; |
| 99 | bool _reinterpret_input_as_3d; |
| 100 | bool _reinterpret_output_as_3d; |
| 101 | bool _use_dummy_work_items; |
Gian Marco Iodice | 944170e | 2019-06-24 14:40:30 +0100 | [diff] [blame] | 102 | bool _add_bias; |
| 103 | bool _broadcast_bias; |
giuros01 | b3204e7 | 2019-04-01 13:50:22 +0100 | [diff] [blame] | 104 | }; |
| 105 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 106 | #endif /*ARM_COMPUTE_CLGEMMMATRIXMULTIPLYNATIVEKERNEL_H*/ |