1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
* Copyright (c) 2019-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 ARM_COMPUTE_CL_GEMM_HELPERS_H
#define ARM_COMPUTE_CL_GEMM_HELPERS_H
#include "arm_compute/core/TensorInfo.h"
#include "arm_compute/core/Types.h"
namespace arm_compute
{
namespace opencl
{
namespace kernels
{
namespace gemm
{
using GeMMConfigsMatrix = std::vector<std::vector<int32_t>>;
/** Configure @ref GEMMLHSMatrixInfo and @ref GEMMRHSMatrixInfo
*
* @param[in] m Number of rows (M) in the LHS matrix not reshaped
* @param[in] n Number of columns (N) in the RHS matrix not reshaped
* @param[in] m0 Number of rows processed by each thread/work-item
* @param[in] n0 Number of columns processed by each thread/work-item
* @param[in] k0 Number of inner accumulation performed by each thread/work-item
* @param[in] v0 Number of vertical blocks of size (m0xk0) stored on the same output row
* @param[in] h0 Number of horizontal blocks of size (k0xn0) stored on the same output row
* @param[in] lhs_interleave True if the v0 (m0xk0) blocks have to be interleaved in the output row
* @param[in] rhs_interleave True if the h0 (k0xn0) blocks have to be interleaved in the output row
* @param[in] lhs_transpose True if the (m0xk0) block has to be transposed before been stored
* @param[in] rhs_transpose True if the (k0xn0) block has to be transposed before been stored
* @param[in] export_to_cl_image (Optional) True if the RHS reshaped matrix has to be exported to cl_image
*
* @return @ref GEMMLHSMatrixInfo and @ref GEMMRHSMatrixInfo
*/
std::pair<GEMMLHSMatrixInfo, GEMMRHSMatrixInfo> configure_lhs_rhs_info(unsigned int m,
unsigned int n,
unsigned int m0,
unsigned int n0,
unsigned int k0,
unsigned int v0,
unsigned int h0,
bool lhs_interleave,
bool rhs_interleave,
bool lhs_transpose,
bool rhs_transpose,
bool export_to_cl_image = false);
/** Select @ref GEMMLHSMatrixInfo and @ref GEMMRHSMatrixInfo
*
* This function accepts two pairs of GEMMLHSMatrixInfo/GEMMRHSMatrixInfo where only the first is with cl_image2d support,
* and selects the valid one validating the GEMMRHSMatrixInfo. If the validation passes, the functions will return
* the first GEMMLHSMatrixInfo/GEMMRHSMatrixInfo pair with cl_image2d support.
*
* @param[in] info_img GEMMLHSMatrixInfo/GEMMRHSMatrixInfo with cl_image2d support
* @param[in] info_buf GEMMLHSMatrixInfo/GEMMRHSMatrixInfo to fall-back if cl_image2d cannot be used
* @param[in] n Number of columns (N) in the RHS matrix not reshaped
* @param[in] k Number of rows (K) in the RHS matrix not reshaped
* @param[in] b Batch size
* @param[in] data_type Data type
*
* @return @ref GEMMLHSMatrixInfo and @ref GEMMRHSMatrixInfo
*/
std::pair<GEMMLHSMatrixInfo, GEMMRHSMatrixInfo>
select_lhs_rhs_info(std::pair<GEMMLHSMatrixInfo, GEMMRHSMatrixInfo> info_img,
std::pair<GEMMLHSMatrixInfo, GEMMRHSMatrixInfo> info_buf,
unsigned int n,
unsigned int k,
unsigned int b,
DataType data_type);
/** Update padding required to export the OpenCL buffer to OpenCL image2d
*
* @param[in,out] tensor ITensorInfo of the tensor required to be exported to OpenCL image2d
*/
void update_padding_for_cl_image(ITensorInfo *tensor);
/** Utility function to validate the image2d OpenCL object support on the RHS reshaped matrix
*
* @param[in] tensor_reshaped_info TensorInfo for the RHS reshaped matrix
* @param[in] rhs_info @ref GEMMRHSMatrixInfo
*
* @return Status reporting if we can use the image2d OpenCL object on the RHS reshaped matrix
*/
Status validate_image2d_support_on_rhs(const ITensorInfo &tensor_reshaped_info, const GEMMRHSMatrixInfo &rhs_info);
/** Determine if the MMUL kernels should be preferred
*
* @param[in] m Number of rows of the LHS matrix
* @param[in] n Number of columns of the RHS matrix
* @param[in] k Number of columns of the LHS matrix, rows of the RHS matrix
* @param[in] b Batch size
* @param[in] data_type Data type FP32/FP16
* @param[in, out] best_m0 Suggested M0 (number of rows of the output block) for the kernel
* @param[in, out] best_n0 Suggested N0 (number of columns of the output block) for the kernel
*
* @return true if MMUL kernel is preferred over kernels w/o MMUL, false otherwise
*/
bool is_mmul_kernel_preferred(const unsigned int m,
const unsigned int n,
const unsigned int k,
const unsigned int b,
const DataType data_type,
unsigned int &best_m0,
unsigned int &best_n0);
/** Find the preferred configurations for the LHS and RHS tensor using the GeMMConfigsMatrix provided by the user
*
* @param[in] configs List of best configurations for a limited number of GeMM shapes
* @param[in] m Number of rows of the LHS matrix
* @param[in] n Number of columns of the RHS matrix
* @param[in] k Number of columns of the LHS matrix, rows of the RHS matrix
* @param[in] b Batch size
*
* @return @ref GEMMLHSMatrixInfo and @ref GEMMRHSMatrixInfo
*/
std::pair<GEMMLHSMatrixInfo, GEMMRHSMatrixInfo>
find_lhs_rhs_info(const GeMMConfigsMatrix &configs, unsigned int m, unsigned int n, unsigned int k, unsigned int b);
} // namespace gemm
} // namespace kernels
} // namespace opencl
} // namespace arm_compute
#endif /* ARM_COMPUTE_CL_GEMM_HELPERS_H */
|
