Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 1 | /* |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 2 | * Copyright (c) 2017-2019 ARM Limited. |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 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 | */ |
| 24 | |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 25 | #ifndef ARM_COMPUTE_GCGEMM_H |
| 26 | #define ARM_COMPUTE_GCGEMM_H |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 27 | |
| 28 | #include "arm_compute/core/GLES_COMPUTE/kernels/GCGEMMInterleave4x4Kernel.h" |
| 29 | #include "arm_compute/core/GLES_COMPUTE/kernels/GCGEMMMatrixAdditionKernel.h" |
| 30 | #include "arm_compute/core/GLES_COMPUTE/kernels/GCGEMMMatrixMultiplyKernel.h" |
| 31 | #include "arm_compute/core/GLES_COMPUTE/kernels/GCGEMMTranspose1xWKernel.h" |
| 32 | #include "arm_compute/runtime/GLES_COMPUTE/GCTensor.h" |
| 33 | #include "arm_compute/runtime/IFunction.h" |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 34 | #include "arm_compute/runtime/MemoryGroup.h" |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 35 | |
| 36 | namespace arm_compute |
| 37 | { |
| 38 | class IGCTensor; |
| 39 | |
| 40 | /** Basic function to execute GEMM on OpenGLES Compute. This function calls the following kernels: |
| 41 | * |
| 42 | * -# @ref GCGEMMInterleave4x4Kernel (if the output tensor is a matrix) |
| 43 | * -# @ref GCGEMMTranspose1xWKernel (if the output tensor is a matrix) |
| 44 | * -# @ref GCGEMMMatrixMultiplyKernel |
| 45 | * -# @ref GCGEMMMatrixAdditionKernel (if c != nullptr and beta != 0.0) |
| 46 | * |
| 47 | */ |
| 48 | class GCGEMM : public IFunction |
| 49 | { |
| 50 | public: |
| 51 | /** Default constructor. */ |
Michalis Spyrou | 9e9cbaf | 2018-03-15 14:41:34 +0000 | [diff] [blame] | 52 | GCGEMM(std::shared_ptr<IMemoryManager> memory_manager = nullptr); |
Georgios Pinitas | 7221933 | 2018-06-05 14:56:06 +0100 | [diff] [blame] | 53 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 54 | GCGEMM(const GCGEMM &) = delete; |
| 55 | /** Default move constructor */ |
| 56 | GCGEMM(GCGEMM &&) = default; |
| 57 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 58 | GCGEMM &operator=(const GCGEMM &) = delete; |
| 59 | /** Default move assignment operator */ |
| 60 | GCGEMM &operator=(GCGEMM &&) = default; |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 61 | /** Initialise the kernel's inputs and output |
| 62 | * |
| 63 | * @note GEMM: General Matrix Multiply - [alpha * A * B + beta * C]. |
| 64 | * |
| 65 | * @note All tensors must have the same data type. |
| 66 | * |
| 67 | * @note Whilst the first input tensor can be a vector, the second input tensor must be at least a matrix |
| 68 | * |
Gian Marco | 1aede36 | 2018-02-05 15:07:36 +0000 | [diff] [blame] | 69 | * @param[in] a First input tensor (Matrix or Vector A). Data types supported: F32 |
| 70 | * @param[in] b Second input tensor (Matrix B). Data type supported: same as @p a. |
| 71 | * @param[in] c Third input tensor (Matrix C). It can be a nullptr if just the multiplication between @p a and @p b is needed. Data type supported: same as @p a. |
| 72 | * @param[out] output Output tensor. Data type supported: same as @p a |
| 73 | * @param[in] alpha Weight of the matrix product |
| 74 | * @param[in] beta Weight of matrix C |
| 75 | * @param[in] gemm_info (Optional) Specifies if the matrix A and/or matrix B have been reshaped and |
| 76 | * if the reshape of matrix B should happen only for the first run |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 77 | */ |
Gian Marco | 1aede36 | 2018-02-05 15:07:36 +0000 | [diff] [blame] | 78 | void configure(const IGCTensor *a, const IGCTensor *b, const IGCTensor *c, IGCTensor *output, float alpha, float beta, const GEMMInfo &gemm_info = GEMMInfo()); |
Michele Di Giorgio | 164b65d | 2018-04-13 14:28:08 +0100 | [diff] [blame] | 79 | /** Static function to check if given info will lead to a valid configuration of @ref GCGEMM. |
| 80 | * |
| 81 | * @param[in] a First input tensor (Matrix or Vector A). Data types supported: F16/F32 |
| 82 | * @param[in] b Second input tensor (Matrix B). Data type supported: same as @p a. |
| 83 | * @param[in] c Third input tensor (Matrix C). It can be a nullptr if just the multiplication between @p a and @p b is needed. Data type supported: same as @p a. |
| 84 | * @param[out] output Output tensor. Data type supported: same as @p a |
| 85 | * @param[in] alpha Weight of the matrix product |
| 86 | * @param[in] beta Weight of matrix C |
| 87 | * @param[in] gemm_info (Optional) Specifies if the matrix A and/or matrix B have been reshaped and |
| 88 | * if the reshape of matrix B should happen only for the first run |
| 89 | * |
| 90 | * @return a status |
| 91 | */ |
| 92 | static Status validate(const ITensorInfo *a, const ITensorInfo *b, const IGCTensor *c, const ITensorInfo *output, const float alpha, const float beta, const GEMMInfo &gemm_info = GEMMInfo()); |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 93 | |
| 94 | // Inherited methods overridden: |
| 95 | void run() override; |
Georgios Pinitas | 7221933 | 2018-06-05 14:56:06 +0100 | [diff] [blame] | 96 | void prepare() override; |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 97 | |
| 98 | private: |
Georgios Pinitas | 26014cf | 2019-09-09 19:00:57 +0100 | [diff] [blame] | 99 | MemoryGroup _memory_group; |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 100 | GCGEMMInterleave4x4Kernel _interleave_kernel; |
| 101 | GCGEMMTranspose1xWKernel _transpose_kernel; |
| 102 | GCGEMMMatrixMultiplyKernel _mm_kernel; |
| 103 | GCGEMMMatrixAdditionKernel _ma_kernel; |
| 104 | GCTensor _tmp_a; |
| 105 | GCTensor _tmp_b; |
Georgios Pinitas | 7221933 | 2018-06-05 14:56:06 +0100 | [diff] [blame] | 106 | const IGCTensor *_original_b; |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 107 | bool _is_interleaved_transposed; |
| 108 | bool _run_addition; |
Michele Di Giorgio | 164b65d | 2018-04-13 14:28:08 +0100 | [diff] [blame] | 109 | bool _reshape_b_only_on_first_run; |
Georgios Pinitas | 7221933 | 2018-06-05 14:56:06 +0100 | [diff] [blame] | 110 | bool _is_prepared; |
Anthony Barbier | 7068f99 | 2017-10-26 15:23:08 +0100 | [diff] [blame] | 111 | }; |
| 112 | } |
| 113 | |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 114 | #endif /* ARM_COMPUTE_GCGEMM_H */ |