1*c217d954SCole Faust /*
2*c217d954SCole Faust  * Copyright (c) 2022 Arm Limited.
3*c217d954SCole Faust  *
4*c217d954SCole Faust  * SPDX-License-Identifier: MIT
5*c217d954SCole Faust  *
6*c217d954SCole Faust  * Permission is hereby granted, free of charge, to any person obtaining a copy
7*c217d954SCole Faust  * of this software and associated documentation files (the "Software"), to
8*c217d954SCole Faust  * deal in the Software without restriction, including without limitation the
9*c217d954SCole Faust  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10*c217d954SCole Faust  * sell copies of the Software, and to permit persons to whom the Software is
11*c217d954SCole Faust  * furnished to do so, subject to the following conditions:
12*c217d954SCole Faust  *
13*c217d954SCole Faust  * The above copyright notice and this permission notice shall be included in all
14*c217d954SCole Faust  * copies or substantial portions of the Software.
15*c217d954SCole Faust  *
16*c217d954SCole Faust  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17*c217d954SCole Faust  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18*c217d954SCole Faust  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19*c217d954SCole Faust  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20*c217d954SCole Faust  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21*c217d954SCole Faust  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22*c217d954SCole Faust  * SOFTWARE.
23*c217d954SCole Faust  */
24*c217d954SCole Faust #include "src/gpu/cl/kernels/ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel.h"
25*c217d954SCole Faust 
26*c217d954SCole Faust #include "arm_compute/core/CL/CLHelpers.h"
27*c217d954SCole Faust #include "arm_compute/core/CL/ICLTensor.h"
28*c217d954SCole Faust #include "arm_compute/core/TensorInfo.h"
29*c217d954SCole Faust #include "arm_compute/core/utils/misc/ShapeCalculator.h"
30*c217d954SCole Faust 
31*c217d954SCole Faust #include "src/core/helpers/AutoConfiguration.h"
32*c217d954SCole Faust #include "src/core/helpers/WindowHelpers.h"
33*c217d954SCole Faust 
34*c217d954SCole Faust #include "support/Cast.h"
35*c217d954SCole Faust 
36*c217d954SCole Faust namespace arm_compute
37*c217d954SCole Faust {
38*c217d954SCole Faust namespace opencl
39*c217d954SCole Faust {
40*c217d954SCole Faust namespace kernels
41*c217d954SCole Faust {
42*c217d954SCole Faust using namespace misc::shape_calculator;
43*c217d954SCole Faust 
44*c217d954SCole Faust namespace
45*c217d954SCole Faust {
46*c217d954SCole Faust using ElementsProcessed = Steps;
47*c217d954SCole Faust 
validate_arguments(const ITensorInfo * src0,const ITensorInfo * src1,const ITensorInfo * dst,const GEMMKernelInfo & gemm_info,const ITensorInfo * vector_sum_col,const ITensorInfo * vector_sum_row,const ITensorInfo * bias,const ITensorInfo * output_multipliers,const ITensorInfo * output_shifts)48*c217d954SCole Faust Status validate_arguments(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
49*c217d954SCole Faust                           const ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, const ITensorInfo *bias,
50*c217d954SCole Faust                           const ITensorInfo *output_multipliers, const ITensorInfo *output_shifts)
51*c217d954SCole Faust {
52*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(src0, src1, dst);
53*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG(!arm_matrix_multiply_supported(CLKernelLibrary::get().get_device()), "The extension cl_arm_matrix_multiply is not supported on the target platform");
54*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(src0, 1, DataType::QASYMM8, DataType::QASYMM8_SIGNED);
55*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(src0, src1);
56*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG(src0->num_dimensions() > 4, "The number of dimensions for the LHS matrix must be <= 4");
57*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG(src1->num_dimensions() > 3, "The number of dimensions for the RHS matrix must be <= 3");
58*c217d954SCole Faust 
59*c217d954SCole Faust     const GEMMRHSMatrixInfo       rhs_info     = gemm_info.rhs_info;
60*c217d954SCole Faust     const GEMMLHSMatrixInfo       lhs_info     = gemm_info.lhs_info;
61*c217d954SCole Faust     const GEMMLowpOutputStageInfo output_stage = gemm_info.output_stage;
62*c217d954SCole Faust 
63*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG(rhs_info.k0 != 4 || lhs_info.k0 != 4, "Only 4 is supported as value for k0");
64*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG(!(lhs_info.m0 == 1 || lhs_info.m0 == 2 || lhs_info.m0 == 4), "Only 1,2,4 are supported for m0");
65*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG(!(rhs_info.n0 == 1 || rhs_info.n0 == 4 || rhs_info.n0 == 8), "Only 1,4,8 are supported for n0");
66*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG(rhs_info.export_to_cl_image, "Export to CLImage not supported for quantized GEMM");
67*c217d954SCole Faust 
68*c217d954SCole Faust     const int m = gemm_info.m;
69*c217d954SCole Faust     const int n = gemm_info.n;
70*c217d954SCole Faust     const int k = gemm_info.k;
71*c217d954SCole Faust 
72*c217d954SCole Faust     TensorShape tensor_shape1{ src1->tensor_shape() };
73*c217d954SCole Faust     tensor_shape1.set(0, n);
74*c217d954SCole Faust     tensor_shape1.set(1, k);
75*c217d954SCole Faust 
76*c217d954SCole Faust     const TensorInfo tensor_info1          = src1->clone()->set_tensor_shape(tensor_shape1);
77*c217d954SCole Faust     const TensorInfo tensor_info_reshaped1 = src1->clone()->set_tensor_shape(compute_rhs_reshaped_shape(tensor_info1, rhs_info));
78*c217d954SCole Faust 
79*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON(src0->dimension(0) != static_cast<unsigned int>(k));
80*c217d954SCole Faust     if(gemm_info.reinterpret_input_as_3d)
81*c217d954SCole Faust     {
82*c217d954SCole Faust         ARM_COMPUTE_RETURN_ERROR_ON(src0->dimension(1) * src0->dimension(2) != static_cast<unsigned int>(m));
83*c217d954SCole Faust     }
84*c217d954SCole Faust     else
85*c217d954SCole Faust     {
86*c217d954SCole Faust         ARM_COMPUTE_RETURN_ERROR_ON(src0->dimension(1) != static_cast<unsigned int>(m));
87*c217d954SCole Faust     }
88*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(src1, &tensor_info_reshaped1);
89*c217d954SCole Faust 
90*c217d954SCole Faust     const TensorShape expected_dst_shape = compute_mm_shape(*src0, *src1, gemm_info);
91*c217d954SCole Faust     if(dst->total_size() != 0)
92*c217d954SCole Faust     {
93*c217d954SCole Faust         const TensorInfo tensor_info_dst = dst->clone()->set_tensor_shape(expected_dst_shape);
94*c217d954SCole Faust         ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(dst, &tensor_info_dst);
95*c217d954SCole Faust         if(output_stage.type == GEMMLowpOutputStageType::NONE)
96*c217d954SCole Faust         {
97*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(dst, 1, DataType::S32);
98*c217d954SCole Faust         }
99*c217d954SCole Faust         else
100*c217d954SCole Faust         {
101*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(src0, dst);
102*c217d954SCole Faust         }
103*c217d954SCole Faust     }
104*c217d954SCole Faust 
105*c217d954SCole Faust     if(bias != nullptr)
106*c217d954SCole Faust     {
107*c217d954SCole Faust         ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(bias, 1, DataType::S32);
108*c217d954SCole Faust         ARM_COMPUTE_RETURN_ERROR_ON(expected_dst_shape[0] != bias->dimension(0));
109*c217d954SCole Faust     }
110*c217d954SCole Faust 
111*c217d954SCole Faust     ARM_COMPUTE_RETURN_ERROR_ON_MSG((output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN) || (output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FLOAT),
112*c217d954SCole Faust                                     "Only GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT is supported");
113*c217d954SCole Faust 
114*c217d954SCole Faust     // Checks performed if the dst stage needs to be fused
115*c217d954SCole Faust     if(output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT)
116*c217d954SCole Faust     {
117*c217d954SCole Faust         // If a_offset == 0, vector_sum_col can be a nullptr
118*c217d954SCole Faust         if(gemm_info.a_offset != 0)
119*c217d954SCole Faust         {
120*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(vector_sum_col, 1, DataType::S32);
121*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON(vector_sum_col->dimension(0) != expected_dst_shape[0]);
122*c217d954SCole Faust         }
123*c217d954SCole Faust 
124*c217d954SCole Faust         // If b_offset == 0, vector_sum_row can be a nullptr
125*c217d954SCole Faust         if(gemm_info.b_offset != 0)
126*c217d954SCole Faust         {
127*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(vector_sum_row, 1, DataType::S32);
128*c217d954SCole Faust 
129*c217d954SCole Faust             // Check if mm result is a 3D reinterpretation
130*c217d954SCole Faust             const bool reinterpret_as_3d = expected_dst_shape.num_dimensions() > 1 && expected_dst_shape.y() != vector_sum_row->tensor_shape().x();
131*c217d954SCole Faust 
132*c217d954SCole Faust             // Validate input
133*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON(reinterpret_as_3d && vector_sum_row->dimension(0) != (expected_dst_shape[1] * expected_dst_shape[2]));
134*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON(!reinterpret_as_3d && vector_sum_row->dimension(0) != expected_dst_shape[1]);
135*c217d954SCole Faust 
136*c217d954SCole Faust             if(expected_dst_shape.num_dimensions() > 1)
137*c217d954SCole Faust             {
138*c217d954SCole Faust                 const unsigned int dst_batch_idx = reinterpret_as_3d ? 3 : 2;
139*c217d954SCole Faust 
140*c217d954SCole Faust                 TensorShape vector_sum_row_shape = vector_sum_row->tensor_shape();
141*c217d954SCole Faust                 vector_sum_row_shape.collapse_from(1);
142*c217d954SCole Faust                 TensorShape collapsed_dst_shape(expected_dst_shape);
143*c217d954SCole Faust                 collapsed_dst_shape.collapse_from(dst_batch_idx);
144*c217d954SCole Faust 
145*c217d954SCole Faust                 ARM_COMPUTE_RETURN_ERROR_ON_MSG(vector_sum_row_shape[1] != collapsed_dst_shape[dst_batch_idx],
146*c217d954SCole Faust                                                 "vector_sum_row must have the same number of batches of dst tensor");
147*c217d954SCole Faust 
148*c217d954SCole Faust                 if(gemm_info.a_offset != 0)
149*c217d954SCole Faust                 {
150*c217d954SCole Faust                     TensorShape vector_sum_col_shape = vector_sum_col->tensor_shape();
151*c217d954SCole Faust                     vector_sum_col_shape.collapse_from(1);
152*c217d954SCole Faust 
153*c217d954SCole Faust                     ARM_COMPUTE_RETURN_ERROR_ON_MSG(vector_sum_col_shape[1] != 1 && vector_sum_col_shape[1] != vector_sum_row_shape[1],
154*c217d954SCole Faust                                                     "vector_sum_col tensor must have the same number of batches of vector_sum_row_shape or the number of batches must be set to 1");
155*c217d954SCole Faust                 }
156*c217d954SCole Faust             }
157*c217d954SCole Faust         }
158*c217d954SCole Faust 
159*c217d954SCole Faust         if(dst->total_size() != 0)
160*c217d954SCole Faust         {
161*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON(output_stage.output_data_type != dst->data_type());
162*c217d954SCole Faust         }
163*c217d954SCole Faust         ARM_COMPUTE_RETURN_ERROR_ON(output_stage.gemmlowp_min_bound > output_stage.gemmlowp_max_bound);
164*c217d954SCole Faust 
165*c217d954SCole Faust         if(output_multipliers != nullptr && output_shifts != nullptr)
166*c217d954SCole Faust         {
167*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(output_multipliers, 1, DataType::S32);
168*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON(output_multipliers->num_dimensions() > 1);
169*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(output_shifts, 1, DataType::S32);
170*c217d954SCole Faust             ARM_COMPUTE_RETURN_ERROR_ON(output_shifts->num_dimensions() > 1);
171*c217d954SCole Faust             if(output_stage.is_quantized_per_channel)
172*c217d954SCole Faust             {
173*c217d954SCole Faust                 ARM_COMPUTE_RETURN_ERROR_ON(expected_dst_shape[0] != output_shifts->dimension(0));
174*c217d954SCole Faust                 ARM_COMPUTE_RETURN_ERROR_ON(expected_dst_shape[0] != output_multipliers->dimension(0));
175*c217d954SCole Faust             }
176*c217d954SCole Faust         }
177*c217d954SCole Faust     }
178*c217d954SCole Faust     return Status{};
179*c217d954SCole Faust }
180*c217d954SCole Faust 
validate_and_configure_window(const ITensorInfo * src0,const ITensorInfo * src1,ITensorInfo * dst,const GEMMKernelInfo & gemm_info,ITensorInfo * vector_sum_col,const ITensorInfo * vector_sum_row,ITensorInfo * bias,ITensorInfo * output_multipliers,ITensorInfo * output_shifts,ElementsProcessed & num_elements_processed)181*c217d954SCole Faust std::pair<Status, Window> validate_and_configure_window(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
182*c217d954SCole Faust                                                         ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, ITensorInfo *bias,
183*c217d954SCole Faust                                                         ITensorInfo *output_multipliers, ITensorInfo *output_shifts, ElementsProcessed &num_elements_processed)
184*c217d954SCole Faust {
185*c217d954SCole Faust     const GEMMLowpOutputStageInfo output_stage = gemm_info.output_stage;
186*c217d954SCole Faust 
187*c217d954SCole Faust     unsigned int &num_elems_processed_per_iteration_x = num_elements_processed[0];
188*c217d954SCole Faust     unsigned int &num_elems_processed_per_iteration_y = num_elements_processed[1];
189*c217d954SCole Faust     bool          reinterpret_output_as_3d            = (gemm_info.depth_output_gemm3d != 0);
190*c217d954SCole Faust 
191*c217d954SCole Faust     Window win{};
192*c217d954SCole Faust     bool   window_changed = false;
193*c217d954SCole Faust 
194*c217d954SCole Faust     constexpr unsigned int mmul_n0 = 4;
195*c217d954SCole Faust     constexpr unsigned int mmul_m0 = 4;
196*c217d954SCole Faust     constexpr unsigned int mmul_k0 = 16;
197*c217d954SCole Faust 
198*c217d954SCole Faust     reinterpret_output_as_3d = false;
199*c217d954SCole Faust     // dst tensor auto initialization if not yet initialized
200*c217d954SCole Faust     const TensorShape expected_dst_shape = compute_mm_shape(*src0, *src1, gemm_info);
201*c217d954SCole Faust     if(output_stage.type != GEMMLowpOutputStageType::NONE)
202*c217d954SCole Faust     {
203*c217d954SCole Faust         auto_init_if_empty(*dst, src0->clone()->set_tensor_shape(expected_dst_shape).set_data_type(output_stage.output_data_type));
204*c217d954SCole Faust     }
205*c217d954SCole Faust     else
206*c217d954SCole Faust     {
207*c217d954SCole Faust         auto_init_if_empty(*dst, src0->clone()->set_tensor_shape(expected_dst_shape).set_data_type(DataType::S32));
208*c217d954SCole Faust     }
209*c217d954SCole Faust 
210*c217d954SCole Faust     TensorInfo tmp_info(*dst);
211*c217d954SCole Faust 
212*c217d954SCole Faust     if(reinterpret_output_as_3d)
213*c217d954SCole Faust     {
214*c217d954SCole Faust         // Since the dst tensor has to be reinterpreted as 3D and the execute window is based on a 2D GEMM,
215*c217d954SCole Faust         // the window needs to be constructed on the 2D collapsed version of the tensor
216*c217d954SCole Faust         TensorShape tmp_shape(dst->tensor_shape());
217*c217d954SCole Faust         tmp_shape.collapse(2U, 1U);
218*c217d954SCole Faust         tmp_info.set_tensor_shape(tmp_shape);
219*c217d954SCole Faust     }
220*c217d954SCole Faust 
221*c217d954SCole Faust     // Configure kernel window
222*c217d954SCole Faust     num_elems_processed_per_iteration_x = 1;
223*c217d954SCole Faust     num_elems_processed_per_iteration_y = 1;
224*c217d954SCole Faust 
225*c217d954SCole Faust     win = calculate_max_window(tmp_info, Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y));
226*c217d954SCole Faust 
227*c217d954SCole Faust     if(output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT)
228*c217d954SCole Faust     {
229*c217d954SCole Faust         if(gemm_info.a_offset != 0)
230*c217d954SCole Faust         {
231*c217d954SCole Faust             AccessWindowHorizontal vector_sum_col_access(vector_sum_col, 0, num_elems_processed_per_iteration_x);
232*c217d954SCole Faust             window_changed = window_changed || update_window_and_padding(win, vector_sum_col_access);
233*c217d954SCole Faust         }
234*c217d954SCole Faust         // No access window needed for vector_sum_row
235*c217d954SCole Faust         ARM_COMPUTE_UNUSED(vector_sum_row);
236*c217d954SCole Faust 
237*c217d954SCole Faust         if(bias != nullptr)
238*c217d954SCole Faust         {
239*c217d954SCole Faust             AccessWindowHorizontal bias_access(bias, 0, num_elems_processed_per_iteration_x);
240*c217d954SCole Faust             window_changed = window_changed || update_window_and_padding(win, bias_access);
241*c217d954SCole Faust         }
242*c217d954SCole Faust 
243*c217d954SCole Faust         if(output_multipliers != nullptr && output_stage.is_quantized_per_channel)
244*c217d954SCole Faust         {
245*c217d954SCole Faust             AccessWindowHorizontal output_multipliers_access(output_multipliers, 0, num_elems_processed_per_iteration_x);
246*c217d954SCole Faust             AccessWindowHorizontal output_shifts_access(output_shifts, 0, num_elems_processed_per_iteration_x);
247*c217d954SCole Faust             window_changed = window_changed || update_window_and_padding(win, output_multipliers_access, output_shifts_access);
248*c217d954SCole Faust         }
249*c217d954SCole Faust     }
250*c217d954SCole Faust 
251*c217d954SCole Faust     // Collapse along the Z direction
252*c217d954SCole Faust     // This collapse needs to be here in order to tune the Z dimension of LWS
253*c217d954SCole Faust     const unsigned int dimension_to_collapse = std::min(static_cast<unsigned int>(dst->num_dimensions()), 2u);
254*c217d954SCole Faust     Window             collapsed             = win.collapse(win, dimension_to_collapse);
255*c217d954SCole Faust 
256*c217d954SCole Faust     // Reconfigure window size, one arm_matrix_multiply kernel needs 16 threads to finish.
257*c217d954SCole Faust     Window::Dimension x_dimension = collapsed.x();
258*c217d954SCole Faust     Window::Dimension y_dimension = collapsed.y();
259*c217d954SCole Faust 
260*c217d954SCole Faust     // Make M and N multiple of M0 and N0 respectively
261*c217d954SCole Faust     const unsigned int ceil_to_multiple_n_n0 = ceil_to_multiple(x_dimension.end(), gemm_info.rhs_info.n0);
262*c217d954SCole Faust     const unsigned int ceil_to_multiple_m_m0 = ceil_to_multiple(y_dimension.end(), gemm_info.lhs_info.m0);
263*c217d954SCole Faust 
264*c217d954SCole Faust     // Divide M and N by M0 and N0 respectively
265*c217d954SCole Faust     const unsigned int n_div_n0 = ceil_to_multiple_n_n0 / gemm_info.rhs_info.n0;
266*c217d954SCole Faust     const unsigned int m_div_m0 = ceil_to_multiple_m_m0 / gemm_info.lhs_info.m0;
267*c217d954SCole Faust 
268*c217d954SCole Faust     // Make n_div_n0 and m_div_m0 multiple of mmul_n0 and mmul_k0 respectively
269*c217d954SCole Faust     const unsigned int ceil_to_multiple_n_div_n0_mmul_n0 = ceil_to_multiple(n_div_n0, mmul_n0);
270*c217d954SCole Faust     const unsigned int ceil_to_multiple_m_div_m0_mmul_m0 = ceil_to_multiple(m_div_m0, mmul_k0);
271*c217d954SCole Faust 
272*c217d954SCole Faust     // Ensure x_dimension is multiple of MMUL block size (mmul_n0 * mmul_m0)
273*c217d954SCole Faust     x_dimension.set_end(ceil_to_multiple_n_div_n0_mmul_n0 * mmul_n0);
274*c217d954SCole Faust     y_dimension.set_end(ceil_to_multiple_m_div_m0_mmul_m0 / mmul_m0);
275*c217d954SCole Faust 
276*c217d954SCole Faust     collapsed.set(Window::DimX, x_dimension);
277*c217d954SCole Faust     collapsed.set(Window::DimY, y_dimension);
278*c217d954SCole Faust 
279*c217d954SCole Faust     Status err = (window_changed) ? ARM_COMPUTE_CREATE_ERROR(ErrorCode::RUNTIME_ERROR, "Insufficient Padding!") : Status{};
280*c217d954SCole Faust     return std::make_pair(err, collapsed);
281*c217d954SCole Faust }
282*c217d954SCole Faust } // namespace
283*c217d954SCole Faust 
ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel()284*c217d954SCole Faust ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel::ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel()
285*c217d954SCole Faust {
286*c217d954SCole Faust     _type = CLKernelType::GEMM;
287*c217d954SCole Faust }
288*c217d954SCole Faust 
configure(const CLCompileContext & compile_context,const ITensorInfo * src0,const ITensorInfo * src1,ITensorInfo * dst,const GEMMKernelInfo & gemm_info,ITensorInfo * vector_sum_col,const ITensorInfo * vector_sum_row,ITensorInfo * bias,ITensorInfo * output_multipliers,ITensorInfo * output_shifts)289*c217d954SCole Faust void ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel::configure(const CLCompileContext &compile_context, const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst,
290*c217d954SCole Faust                                                                   const GEMMKernelInfo &gemm_info,
291*c217d954SCole Faust                                                                   ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, ITensorInfo *bias,
292*c217d954SCole Faust                                                                   ITensorInfo *output_multipliers, ITensorInfo *output_shifts)
293*c217d954SCole Faust {
294*c217d954SCole Faust     ARM_COMPUTE_ERROR_ON_NULLPTR(src0, src1, dst);
295*c217d954SCole Faust     ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(src0, src1, dst, gemm_info, vector_sum_col, vector_sum_row, bias, output_multipliers, output_shifts));
296*c217d954SCole Faust 
297*c217d954SCole Faust     auto                          padding_info = get_padding_info({ src0, src1, dst, vector_sum_row });
298*c217d954SCole Faust     const GEMMRHSMatrixInfo       rhs_info     = gemm_info.rhs_info;
299*c217d954SCole Faust     const GEMMLHSMatrixInfo       lhs_info     = gemm_info.lhs_info;
300*c217d954SCole Faust     const GEMMLowpOutputStageInfo output_stage = gemm_info.output_stage;
301*c217d954SCole Faust     const int32_t                 a_offset     = gemm_info.a_offset;
302*c217d954SCole Faust     const int32_t                 b_offset     = gemm_info.b_offset;
303*c217d954SCole Faust     constexpr int                 mmul_m0      = 4;
304*c217d954SCole Faust     constexpr int                 mmul_n0      = 4;
305*c217d954SCole Faust     constexpr int                 mmul_k0      = 16;
306*c217d954SCole Faust 
307*c217d954SCole Faust     _m = gemm_info.m;
308*c217d954SCole Faust     _n = gemm_info.n;
309*c217d954SCole Faust     _k = gemm_info.k;
310*c217d954SCole Faust 
311*c217d954SCole Faust     ElementsProcessed num_elements_processed{};
312*c217d954SCole Faust 
313*c217d954SCole Faust     // Configure kernel window
314*c217d954SCole Faust     auto win_config = validate_and_configure_window(src0, src1, dst, gemm_info, vector_sum_col, vector_sum_row, bias, output_multipliers, output_shifts, num_elements_processed);
315*c217d954SCole Faust     ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
316*c217d954SCole Faust     ICLKernel::configure_internal(win_config.second);
317*c217d954SCole Faust 
318*c217d954SCole Faust     const unsigned int m0_leftover = _m % lhs_info.m0;
319*c217d954SCole Faust     const unsigned int n0_leftover = _n % rhs_info.n0;
320*c217d954SCole Faust 
321*c217d954SCole Faust     // Create build options
322*c217d954SCole Faust     CLBuildOptions build_opts;
323*c217d954SCole Faust     build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(src0->data_type()));
324*c217d954SCole Faust     build_opts.add_option("-DVEC_TYPE=" + get_cl_type_from_data_type(src0->data_type()) + "4");
325*c217d954SCole Faust     build_opts.add_option("-DACC_DATA_TYPE=int");
326*c217d954SCole Faust     build_opts.add_option("-DOUT_DATA_TYPE=" + get_cl_type_from_data_type(dst->data_type()));
327*c217d954SCole Faust     build_opts.add_option("-DM0=" + support::cpp11::to_string(lhs_info.m0));
328*c217d954SCole Faust     build_opts.add_option("-DN0=" + support::cpp11::to_string(rhs_info.n0));
329*c217d954SCole Faust     build_opts.add_option("-DK0=" + support::cpp11::to_string(rhs_info.k0));
330*c217d954SCole Faust     build_opts.add_option("-DM0_LEFTOVER=" + support::cpp11::to_string(m0_leftover));
331*c217d954SCole Faust     build_opts.add_option("-DN0_LEFTOVER=" + support::cpp11::to_string(n0_leftover));
332*c217d954SCole Faust     build_opts.add_option("-DMMUL_M0=" + support::cpp11::to_string(mmul_m0));
333*c217d954SCole Faust     build_opts.add_option("-DMMUL_N0=" + support::cpp11::to_string(mmul_n0));
334*c217d954SCole Faust     build_opts.add_option("-DMMUL_K0=" + support::cpp11::to_string(mmul_k0));
335*c217d954SCole Faust     build_opts.add_option("-DACTIVATION_TYPE=" + lower_string(string_from_activation_func(gemm_info.activation_info.activation())));
336*c217d954SCole Faust     build_opts.add_option("-DA_VAL=" + float_to_string_with_full_precision(gemm_info.activation_info.a()));
337*c217d954SCole Faust     build_opts.add_option("-DB_VAL=" + float_to_string_with_full_precision(gemm_info.activation_info.b()));
338*c217d954SCole Faust 
339*c217d954SCole Faust     std::string kernel_name("gemmlowp_mm_reshaped_only_rhs_mmul");
340*c217d954SCole Faust 
341*c217d954SCole Faust     if(output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT)
342*c217d954SCole Faust     {
343*c217d954SCole Faust         build_opts.add_option("-DFUSED_OUTPUT_STAGE_FIXED_POINT");
344*c217d954SCole Faust         _fuse_output_stage = true;
345*c217d954SCole Faust         // If a_offset == 0, vector_sum_col can be a nullptr
346*c217d954SCole Faust         if(a_offset != 0 && vector_sum_col != nullptr)
347*c217d954SCole Faust         {
348*c217d954SCole Faust             build_opts.add_option("-DA_OFFSET=" + support::cpp11::to_string(a_offset));
349*c217d954SCole Faust             build_opts.add_option_if(vector_sum_col->tensor_shape().num_dimensions() > 1, "-DSUM_COL_HAS_BATCHES");
350*c217d954SCole Faust         }
351*c217d954SCole Faust         // If b_offset == 0, vector_sum_row can be a nullptr
352*c217d954SCole Faust         build_opts.add_option_if(b_offset != 0, "-DB_OFFSET=" + support::cpp11::to_string(b_offset));
353*c217d954SCole Faust         build_opts.add_option("-DK_OFFSET=" + support::cpp11::to_string(a_offset * b_offset * src0->dimension(0)));
354*c217d954SCole Faust         build_opts.add_option_if(bias != nullptr, "-DADD_BIAS");
355*c217d954SCole Faust         build_opts.add_option_if(gemm_info.broadcast_bias == true, "-DBROADCAST_BIAS");
356*c217d954SCole Faust         build_opts.add_option("-DRESULT_OFFSET=" + support::cpp11::to_string(output_stage.gemmlowp_offset));
357*c217d954SCole Faust         build_opts.add_option("-DRESULT_MULTIPLIER=" + support::cpp11::to_string(output_stage.gemmlowp_multipliers[0]));
358*c217d954SCole Faust         build_opts.add_option("-DRESULT_SHIFT=" + support::cpp11::to_string(output_stage.gemmlowp_shifts[0]));
359*c217d954SCole Faust 
360*c217d954SCole Faust         const int min = output_stage.gemmlowp_min_bound;
361*c217d954SCole Faust         const int max = output_stage.gemmlowp_max_bound;
362*c217d954SCole Faust 
363*c217d954SCole Faust         PixelValue min_val{};
364*c217d954SCole Faust         PixelValue max_val{};
365*c217d954SCole Faust         std::tie(min_val, max_val) = get_min_max(dst->data_type());
366*c217d954SCole Faust         build_opts.add_option_if(min != min_val.get<int32_t>(), "-DMIN_BOUND=" + support::cpp11::to_string(min));
367*c217d954SCole Faust         build_opts.add_option_if(max != max_val.get<int32_t>(), "-DMAX_BOUND=" + support::cpp11::to_string(max));
368*c217d954SCole Faust     }
369*c217d954SCole Faust 
370*c217d954SCole Faust     // A macro guard to compile ONLY the kernel of interest
371*c217d954SCole Faust     build_opts.add_option("-D" + upper_string(kernel_name));
372*c217d954SCole Faust 
373*c217d954SCole Faust     // Create kernel
374*c217d954SCole Faust     _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
375*c217d954SCole Faust 
376*c217d954SCole Faust     // Set config_id for enabling LWS tuning
377*c217d954SCole Faust     _config_id = kernel_name;
378*c217d954SCole Faust     _config_id += "_";
379*c217d954SCole Faust     _config_id += (bias != nullptr ? "add_bias_" : "");
380*c217d954SCole Faust     _config_id += (gemm_info.broadcast_bias ? "broadcast_bias_" : "");
381*c217d954SCole Faust     _config_id += (gemm_info.activation_info.enabled() ? "fused_activation_" : "");
382*c217d954SCole Faust     _config_id += lower_string(string_from_data_type(src0->data_type()));
383*c217d954SCole Faust     _config_id += "_";
384*c217d954SCole Faust     _config_id += support::cpp11::to_string(_m);
385*c217d954SCole Faust     _config_id += "_";
386*c217d954SCole Faust     _config_id += support::cpp11::to_string(_n);
387*c217d954SCole Faust     _config_id += "_";
388*c217d954SCole Faust     _config_id += support::cpp11::to_string(_k);
389*c217d954SCole Faust     _config_id += "_";
390*c217d954SCole Faust     _config_id += support::cpp11::to_string(lhs_info.m0);
391*c217d954SCole Faust     _config_id += "_";
392*c217d954SCole Faust     _config_id += support::cpp11::to_string(rhs_info.n0);
393*c217d954SCole Faust 
394*c217d954SCole Faust     ARM_COMPUTE_ERROR_ON(has_padding_changed(padding_info));
395*c217d954SCole Faust }
396*c217d954SCole Faust 
validate(const ITensorInfo * src0,const ITensorInfo * src1,const ITensorInfo * dst,const GEMMKernelInfo & gemm_info,const ITensorInfo * vector_sum_col,const ITensorInfo * vector_sum_row,const ITensorInfo * bias,const ITensorInfo * output_multipliers,const ITensorInfo * output_shifts)397*c217d954SCole Faust Status ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel::validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
398*c217d954SCole Faust                                                                    const ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, const ITensorInfo *bias,
399*c217d954SCole Faust                                                                    const ITensorInfo *output_multipliers, const ITensorInfo *output_shifts)
400*c217d954SCole Faust {
401*c217d954SCole Faust     ElementsProcessed num_elements_processed{};
402*c217d954SCole Faust     ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(src0, src1, dst, gemm_info, vector_sum_col, vector_sum_row, bias, output_multipliers, output_shifts));
403*c217d954SCole Faust     ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(src0->clone().get(),
404*c217d954SCole Faust                                                               src1->clone().get(),
405*c217d954SCole Faust                                                               dst->clone().get(),
406*c217d954SCole Faust                                                               gemm_info,
407*c217d954SCole Faust                                                               vector_sum_col != nullptr ? vector_sum_col->clone().get() : nullptr,
408*c217d954SCole Faust                                                               vector_sum_row != nullptr ? vector_sum_row->clone().get() : nullptr,
409*c217d954SCole Faust                                                               bias != nullptr ? bias->clone().get() : nullptr,
410*c217d954SCole Faust                                                               output_multipliers != nullptr ? output_multipliers->clone().get() : nullptr,
411*c217d954SCole Faust                                                               output_shifts != nullptr ? output_shifts->clone().get() : nullptr,
412*c217d954SCole Faust                                                               num_elements_processed)
413*c217d954SCole Faust                                 .first);
414*c217d954SCole Faust 
415*c217d954SCole Faust     return Status{};
416*c217d954SCole Faust }
417*c217d954SCole Faust 
run_op(ITensorPack & tensors,const Window & window,cl::CommandQueue & queue)418*c217d954SCole Faust void ClGemmLowpMatrixMultiplyReshapedOnlyRhsMMULKernel::run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
419*c217d954SCole Faust {
420*c217d954SCole Faust     ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this);
421*c217d954SCole Faust     ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(ICLKernel::window(), window);
422*c217d954SCole Faust 
423*c217d954SCole Faust     const auto src0           = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_0));
424*c217d954SCole Faust     const auto src1           = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_1));
425*c217d954SCole Faust     const auto src2           = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_2));
426*c217d954SCole Faust     const auto vector_sum_col = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_VEC_COL_SUM));
427*c217d954SCole Faust     const auto vector_sum_row = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_VEC_ROW_SUM));
428*c217d954SCole Faust     auto       dst            = utils::cast::polymorphic_downcast<ICLTensor *>(tensors.get_tensor(TensorType::ACL_DST));
429*c217d954SCole Faust 
430*c217d954SCole Faust     ARM_COMPUTE_ERROR_ON_NULLPTR(src0, src1, dst);
431*c217d954SCole Faust 
432*c217d954SCole Faust     if(src1->info()->num_dimensions() < 3)
433*c217d954SCole Faust     {
434*c217d954SCole Faust         // The stride_z for matrix B must be zero if we do not slice
435*c217d954SCole Faust         ARM_COMPUTE_ERROR_ON(src1->info()->strides_in_bytes()[3] != 0);
436*c217d954SCole Faust     }
437*c217d954SCole Faust 
438*c217d954SCole Faust     cl::Image2D src1_image2d;
439*c217d954SCole Faust 
440*c217d954SCole Faust     Window slice = window.first_slice_window_3D();
441*c217d954SCole Faust 
442*c217d954SCole Faust     do
443*c217d954SCole Faust     {
444*c217d954SCole Faust         unsigned int idx = 0;
445*c217d954SCole Faust 
446*c217d954SCole Faust         add_3d_tensor_nhw_argument(idx, src0);
447*c217d954SCole Faust         add_3d_tensor_nhw_argument(idx, src1);
448*c217d954SCole Faust 
449*c217d954SCole Faust         // Bias buffer (_add_bias == true)
450*c217d954SCole Faust         if(src2 != nullptr)
451*c217d954SCole Faust         {
452*c217d954SCole Faust             add_3d_tensor_nhw_argument(idx, src2);
453*c217d954SCole Faust         }
454*c217d954SCole Faust         // dst buffer
455*c217d954SCole Faust         add_3d_tensor_nhw_argument(idx, dst);
456*c217d954SCole Faust 
457*c217d954SCole Faust         // Pass m, n and k at runtime as signed ints, to ensure results of any subtraction they could be operand in, would still be signed.
458*c217d954SCole Faust         _kernel.setArg<cl_int>(idx++, _m);
459*c217d954SCole Faust         _kernel.setArg<cl_int>(idx++, _n);
460*c217d954SCole Faust         _kernel.setArg<cl_int>(idx++, _k);
461*c217d954SCole Faust 
462*c217d954SCole Faust         if(_fuse_output_stage)
463*c217d954SCole Faust         {
464*c217d954SCole Faust             if(vector_sum_col != nullptr)
465*c217d954SCole Faust             {
466*c217d954SCole Faust                 add_3d_tensor_nhw_argument(idx, vector_sum_col);
467*c217d954SCole Faust             }
468*c217d954SCole Faust             if(vector_sum_row != nullptr)
469*c217d954SCole Faust             {
470*c217d954SCole Faust                 add_3d_tensor_nhw_argument(idx, vector_sum_row);
471*c217d954SCole Faust             }
472*c217d954SCole Faust         }
473*c217d954SCole Faust 
474*c217d954SCole Faust         enqueue(queue, *this, slice, cl::NDRange(32, 2), false);
475*c217d954SCole Faust     }
476*c217d954SCole Faust     while(window.slide_window_slice_3D(slice));
477*c217d954SCole Faust }
478*c217d954SCole Faust } // namespace kernels
479*c217d954SCole Faust } // namespace opencl
480*c217d954SCole Faust } // namespace arm_compute
481