1*c217d954SCole Faust /*
2*c217d954SCole Faust * Copyright (c) 2019-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/ClGemmLowpMatrixMultiplyReshapedOnlyRhsKernel.h"
25*c217d954SCole Faust
26*c217d954SCole Faust #include "arm_compute/core/CL/CLHelpers.h"
27*c217d954SCole Faust #include "arm_compute/core/CL/CLKernelLibrary.h"
28*c217d954SCole Faust #include "arm_compute/core/CL/ICLTensor.h"
29*c217d954SCole Faust #include "arm_compute/core/CL/OpenCL.h"
30*c217d954SCole Faust #include "arm_compute/core/Helpers.h"
31*c217d954SCole Faust #include "arm_compute/core/TensorInfo.h"
32*c217d954SCole Faust #include "arm_compute/core/Utils.h"
33*c217d954SCole Faust #include "arm_compute/core/Validate.h"
34*c217d954SCole Faust #include "arm_compute/core/utils/misc/ShapeCalculator.h"
35*c217d954SCole Faust
36*c217d954SCole Faust #include "src/core/AccessWindowStatic.h"
37*c217d954SCole Faust #include "src/core/helpers/AutoConfiguration.h"
38*c217d954SCole Faust #include "src/core/helpers/WindowHelpers.h"
39*c217d954SCole Faust
40*c217d954SCole Faust #include "support/Cast.h"
41*c217d954SCole Faust #include "support/StringSupport.h"
42*c217d954SCole Faust
43*c217d954SCole Faust #include <tuple>
44*c217d954SCole Faust
45*c217d954SCole Faust namespace arm_compute
46*c217d954SCole Faust {
47*c217d954SCole Faust namespace opencl
48*c217d954SCole Faust {
49*c217d954SCole Faust namespace kernels
50*c217d954SCole Faust {
51*c217d954SCole Faust using namespace misc::shape_calculator;
52*c217d954SCole Faust
53*c217d954SCole Faust namespace
54*c217d954SCole Faust {
55*c217d954SCole Faust using ElementsProcessed = Steps;
56*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)57*c217d954SCole Faust Status validate_arguments(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
58*c217d954SCole Faust const ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, const ITensorInfo *bias,
59*c217d954SCole Faust const ITensorInfo *output_multipliers, const ITensorInfo *output_shifts)
60*c217d954SCole Faust {
61*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(src0, src1, dst);
62*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(src0, 1, DataType::QASYMM8, DataType::QASYMM8_SIGNED);
63*c217d954SCole Faust if(src0->data_type() == DataType::QASYMM8)
64*c217d954SCole Faust {
65*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(src0, src1);
66*c217d954SCole Faust }
67*c217d954SCole Faust else
68*c217d954SCole Faust {
69*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(src1, 1, DataType::QASYMM8, DataType::QSYMM8, DataType::QASYMM8_SIGNED, DataType::QSYMM8_PER_CHANNEL);
70*c217d954SCole Faust }
71*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG(src0->num_dimensions() > 4, "The number of dimensions for the LHS matrix must be <= 4");
72*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG(src1->num_dimensions() > 3, "The number of dimensions for the RHS matrix must be <= 3");
73*c217d954SCole Faust
74*c217d954SCole Faust const GEMMRHSMatrixInfo rhs_info = gemm_info.rhs_info;
75*c217d954SCole Faust const GEMMLHSMatrixInfo lhs_info = gemm_info.lhs_info;
76*c217d954SCole Faust const GEMMLowpOutputStageInfo output_stage = gemm_info.output_stage;
77*c217d954SCole Faust
78*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG((((rhs_info.k0 & (rhs_info.k0 - 1)) && rhs_info.k0 != 3) || (rhs_info.k0 > 16)), "Only 2,3,4,8,16 are supported for k0");
79*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(lhs_info.m0 < 1 || lhs_info.m0 > 8);
80*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG((((rhs_info.n0 & (rhs_info.n0 - 1)) && rhs_info.n0 != 3) || rhs_info.n0 > 16), "Only 2,3,4,8,16 are supported for n0");
81*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG(rhs_info.export_to_cl_image, "Export to CLImage not supported for quantized GEMM");
82*c217d954SCole Faust
83*c217d954SCole Faust const int m = gemm_info.m;
84*c217d954SCole Faust const int n = gemm_info.n;
85*c217d954SCole Faust const int k = gemm_info.k;
86*c217d954SCole Faust
87*c217d954SCole Faust TensorShape tensor_shape1{ src1->tensor_shape() };
88*c217d954SCole Faust tensor_shape1.set(0, n);
89*c217d954SCole Faust tensor_shape1.set(1, k);
90*c217d954SCole Faust
91*c217d954SCole Faust const TensorInfo tensor_info1 = src1->clone()->set_tensor_shape(tensor_shape1);
92*c217d954SCole Faust const TensorInfo tensor_info_reshaped1 = src1->clone()->set_tensor_shape(compute_rhs_reshaped_shape(tensor_info1, rhs_info));
93*c217d954SCole Faust
94*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(src0->dimension(0) != static_cast<unsigned int>(k));
95*c217d954SCole Faust if(gemm_info.reinterpret_input_as_3d)
96*c217d954SCole Faust {
97*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(src0->dimension(1) * src0->dimension(2) != static_cast<unsigned int>(m));
98*c217d954SCole Faust }
99*c217d954SCole Faust else
100*c217d954SCole Faust {
101*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(src0->dimension(1) != static_cast<unsigned int>(m));
102*c217d954SCole Faust }
103*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(src1, &tensor_info_reshaped1);
104*c217d954SCole Faust
105*c217d954SCole Faust const TensorShape expected_dst_shape = compute_mm_shape(*src0, *src1, gemm_info);
106*c217d954SCole Faust if(dst->total_size() != 0)
107*c217d954SCole Faust {
108*c217d954SCole Faust const TensorInfo tensor_info_dst = dst->clone()->set_tensor_shape(expected_dst_shape);
109*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(dst, &tensor_info_dst);
110*c217d954SCole Faust if(output_stage.type == GEMMLowpOutputStageType::NONE)
111*c217d954SCole Faust {
112*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(dst, 1, DataType::S32);
113*c217d954SCole Faust }
114*c217d954SCole Faust else
115*c217d954SCole Faust {
116*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(src0, dst);
117*c217d954SCole Faust }
118*c217d954SCole Faust }
119*c217d954SCole Faust
120*c217d954SCole Faust if(bias != nullptr)
121*c217d954SCole Faust {
122*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(bias, 1, DataType::S32);
123*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(bias->num_dimensions() > 1);
124*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(expected_dst_shape[0] != bias->dimension(0));
125*c217d954SCole Faust }
126*c217d954SCole Faust
127*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG((output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN) || (output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FLOAT),
128*c217d954SCole Faust "Only GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT is supported");
129*c217d954SCole Faust
130*c217d954SCole Faust // Checks performed if the dst stage needs to be fused
131*c217d954SCole Faust if(output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT)
132*c217d954SCole Faust {
133*c217d954SCole Faust // If a_offset == 0, vector_sum_col can be a nullptr
134*c217d954SCole Faust if(gemm_info.a_offset != 0)
135*c217d954SCole Faust {
136*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(vector_sum_col, 1, DataType::S32);
137*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(vector_sum_col->dimension(0) != expected_dst_shape[0]);
138*c217d954SCole Faust }
139*c217d954SCole Faust
140*c217d954SCole Faust // If b_offset == 0, vector_sum_row can be a nullptr
141*c217d954SCole Faust if(gemm_info.b_offset != 0)
142*c217d954SCole Faust {
143*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(vector_sum_row, 1, DataType::S32);
144*c217d954SCole Faust
145*c217d954SCole Faust // Check if mm result is a 3D reinterpretation
146*c217d954SCole Faust const bool reinterpret_as_3d = expected_dst_shape.num_dimensions() > 1 && expected_dst_shape.y() != vector_sum_row->tensor_shape().x();
147*c217d954SCole Faust
148*c217d954SCole Faust // Validate input
149*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(reinterpret_as_3d && vector_sum_row->dimension(0) != (expected_dst_shape[1] * expected_dst_shape[2]));
150*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(!reinterpret_as_3d && vector_sum_row->dimension(0) != expected_dst_shape[1]);
151*c217d954SCole Faust
152*c217d954SCole Faust if(expected_dst_shape.num_dimensions() > 1)
153*c217d954SCole Faust {
154*c217d954SCole Faust const unsigned int dst_batch_idx = reinterpret_as_3d ? 3 : 2;
155*c217d954SCole Faust
156*c217d954SCole Faust TensorShape vector_sum_row_shape = vector_sum_row->tensor_shape();
157*c217d954SCole Faust vector_sum_row_shape.collapse_from(1);
158*c217d954SCole Faust TensorShape collapsed_dst_shape(expected_dst_shape);
159*c217d954SCole Faust collapsed_dst_shape.collapse_from(dst_batch_idx);
160*c217d954SCole Faust
161*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG(vector_sum_row_shape[1] != collapsed_dst_shape[dst_batch_idx],
162*c217d954SCole Faust "vector_sum_row must have the same number of batches of dst tensor");
163*c217d954SCole Faust
164*c217d954SCole Faust if(gemm_info.a_offset != 0)
165*c217d954SCole Faust {
166*c217d954SCole Faust TensorShape vector_sum_col_shape = vector_sum_col->tensor_shape();
167*c217d954SCole Faust vector_sum_col_shape.collapse_from(1);
168*c217d954SCole Faust
169*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_MSG(vector_sum_col_shape[1] != 1 && vector_sum_col_shape[1] != vector_sum_row_shape[1],
170*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");
171*c217d954SCole Faust }
172*c217d954SCole Faust }
173*c217d954SCole Faust }
174*c217d954SCole Faust
175*c217d954SCole Faust if(dst->total_size() != 0)
176*c217d954SCole Faust {
177*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(output_stage.output_data_type != dst->data_type());
178*c217d954SCole Faust }
179*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(output_stage.gemmlowp_min_bound > output_stage.gemmlowp_max_bound);
180*c217d954SCole Faust
181*c217d954SCole Faust if(output_multipliers != nullptr && output_shifts != nullptr)
182*c217d954SCole Faust {
183*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(output_multipliers, 1, DataType::S32);
184*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(output_multipliers->num_dimensions() > 1);
185*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(output_shifts, 1, DataType::S32);
186*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(output_shifts->num_dimensions() > 1);
187*c217d954SCole Faust if(output_stage.is_quantized_per_channel)
188*c217d954SCole Faust {
189*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(expected_dst_shape[0] != output_shifts->dimension(0));
190*c217d954SCole Faust ARM_COMPUTE_RETURN_ERROR_ON(expected_dst_shape[0] != output_multipliers->dimension(0));
191*c217d954SCole Faust }
192*c217d954SCole Faust }
193*c217d954SCole Faust }
194*c217d954SCole Faust return Status{};
195*c217d954SCole Faust }
196*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)197*c217d954SCole Faust std::pair<Status, Window> validate_and_configure_window(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
198*c217d954SCole Faust ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, ITensorInfo *bias,
199*c217d954SCole Faust ITensorInfo *output_multipliers, ITensorInfo *output_shifts, ElementsProcessed &num_elements_processed)
200*c217d954SCole Faust {
201*c217d954SCole Faust const GEMMLowpOutputStageInfo output_stage = gemm_info.output_stage;
202*c217d954SCole Faust
203*c217d954SCole Faust unsigned int &num_elems_processed_per_iteration_x = num_elements_processed[0];
204*c217d954SCole Faust unsigned int &num_elems_processed_per_iteration_y = num_elements_processed[1];
205*c217d954SCole Faust bool reinterpret_input_as_3d = gemm_info.reinterpret_input_as_3d;
206*c217d954SCole Faust bool reinterpret_output_as_3d = (gemm_info.depth_output_gemm3d != 0);
207*c217d954SCole Faust
208*c217d954SCole Faust Window win{};
209*c217d954SCole Faust Window win_out{};
210*c217d954SCole Faust bool window_changed = false;
211*c217d954SCole Faust
212*c217d954SCole Faust // In case both input and dst have to be reinterpreted as 3D tensors,
213*c217d954SCole Faust // force reinterpret_input_as_3d and reinterpret_output_as_3d to be false.
214*c217d954SCole Faust if(reinterpret_input_as_3d == reinterpret_output_as_3d)
215*c217d954SCole Faust {
216*c217d954SCole Faust reinterpret_output_as_3d = false;
217*c217d954SCole Faust }
218*c217d954SCole Faust
219*c217d954SCole Faust // dst tensor auto initialization if not yet initialized
220*c217d954SCole Faust const TensorShape expected_dst_shape = compute_mm_shape(*src0, *src1, gemm_info);
221*c217d954SCole Faust if(output_stage.type != GEMMLowpOutputStageType::NONE)
222*c217d954SCole Faust {
223*c217d954SCole Faust auto_init_if_empty(*dst, src0->clone()->set_tensor_shape(expected_dst_shape).set_data_type(output_stage.output_data_type));
224*c217d954SCole Faust }
225*c217d954SCole Faust else
226*c217d954SCole Faust {
227*c217d954SCole Faust auto_init_if_empty(*dst, src0->clone()->set_tensor_shape(expected_dst_shape).set_data_type(DataType::S32));
228*c217d954SCole Faust }
229*c217d954SCole Faust
230*c217d954SCole Faust TensorInfo tmp_info(*dst);
231*c217d954SCole Faust
232*c217d954SCole Faust if(reinterpret_output_as_3d)
233*c217d954SCole Faust {
234*c217d954SCole Faust // Since the dst tensor has to be reinterpreted as 3D and the execute window is based on a 2D GEMM,
235*c217d954SCole Faust // the window needs to be constructed on the 2D collapsed version of the tensor
236*c217d954SCole Faust TensorShape tmp_shape(dst->tensor_shape());
237*c217d954SCole Faust tmp_shape.collapse(2U, 1U);
238*c217d954SCole Faust tmp_info.set_tensor_shape(tmp_shape);
239*c217d954SCole Faust }
240*c217d954SCole Faust
241*c217d954SCole Faust // Configure kernel window
242*c217d954SCole Faust num_elems_processed_per_iteration_x = gemm_info.rhs_info.n0;
243*c217d954SCole Faust num_elems_processed_per_iteration_y = gemm_info.lhs_info.m0;
244*c217d954SCole Faust
245*c217d954SCole Faust win = calculate_max_window(tmp_info, Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y));
246*c217d954SCole Faust win_out = calculate_max_window(*dst, Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y));
247*c217d954SCole Faust
248*c217d954SCole Faust if(output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT)
249*c217d954SCole Faust {
250*c217d954SCole Faust if(gemm_info.a_offset != 0)
251*c217d954SCole Faust {
252*c217d954SCole Faust AccessWindowHorizontal vector_sum_col_access(vector_sum_col, 0, num_elems_processed_per_iteration_x);
253*c217d954SCole Faust window_changed = window_changed || update_window_and_padding(win_out, vector_sum_col_access);
254*c217d954SCole Faust }
255*c217d954SCole Faust // No access window needed for vector_sum_row
256*c217d954SCole Faust ARM_COMPUTE_UNUSED(vector_sum_row);
257*c217d954SCole Faust
258*c217d954SCole Faust if(bias != nullptr)
259*c217d954SCole Faust {
260*c217d954SCole Faust AccessWindowHorizontal bias_access(bias, 0, num_elems_processed_per_iteration_x);
261*c217d954SCole Faust window_changed = window_changed || update_window_and_padding(win_out, bias_access);
262*c217d954SCole Faust }
263*c217d954SCole Faust
264*c217d954SCole Faust if(output_multipliers != nullptr && output_stage.is_quantized_per_channel)
265*c217d954SCole Faust {
266*c217d954SCole Faust AccessWindowHorizontal output_multipliers_access(output_multipliers, 0, num_elems_processed_per_iteration_x);
267*c217d954SCole Faust AccessWindowHorizontal output_shifts_access(output_shifts, 0, num_elems_processed_per_iteration_x);
268*c217d954SCole Faust window_changed = window_changed || update_window_and_padding(win_out, output_multipliers_access, output_shifts_access);
269*c217d954SCole Faust }
270*c217d954SCole Faust }
271*c217d954SCole Faust
272*c217d954SCole Faust // Collapse along the Z direction
273*c217d954SCole Faust // This collapse needs to be here in order to tune the Z dimension of LWS
274*c217d954SCole Faust Window collapsed = win;
275*c217d954SCole Faust const unsigned int dimension_to_collapse = std::min(static_cast<unsigned int>(dst->num_dimensions()), 2u);
276*c217d954SCole Faust collapsed = win.collapse(win, dimension_to_collapse);
277*c217d954SCole Faust
278*c217d954SCole Faust Status err = (window_changed) ? ARM_COMPUTE_CREATE_ERROR(ErrorCode::RUNTIME_ERROR, "Insufficient Padding!") : Status{};
279*c217d954SCole Faust return std::make_pair(err, collapsed);
280*c217d954SCole Faust }
281*c217d954SCole Faust } // namespace
282*c217d954SCole Faust
ClGemmLowpMatrixMultiplyReshapedOnlyRhsKernel()283*c217d954SCole Faust ClGemmLowpMatrixMultiplyReshapedOnlyRhsKernel::ClGemmLowpMatrixMultiplyReshapedOnlyRhsKernel()
284*c217d954SCole Faust {
285*c217d954SCole Faust _type = CLKernelType::GEMM;
286*c217d954SCole Faust }
287*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)288*c217d954SCole Faust void ClGemmLowpMatrixMultiplyReshapedOnlyRhsKernel::configure(const CLCompileContext &compile_context, const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst,
289*c217d954SCole Faust const GEMMKernelInfo &gemm_info,
290*c217d954SCole Faust ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, ITensorInfo *bias,
291*c217d954SCole Faust ITensorInfo *output_multipliers, ITensorInfo *output_shifts)
292*c217d954SCole Faust {
293*c217d954SCole Faust ARM_COMPUTE_ERROR_ON_NULLPTR(src0, src1, dst);
294*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));
295*c217d954SCole Faust
296*c217d954SCole Faust auto padding_info = get_padding_info({ src0, src1, dst, vector_sum_row });
297*c217d954SCole Faust const GEMMRHSMatrixInfo rhs_info = gemm_info.rhs_info;
298*c217d954SCole Faust const GEMMLHSMatrixInfo lhs_info = gemm_info.lhs_info;
299*c217d954SCole Faust const GEMMLowpOutputStageInfo output_stage = gemm_info.output_stage;
300*c217d954SCole Faust const int32_t a_offset = gemm_info.a_offset;
301*c217d954SCole Faust const int32_t b_offset = gemm_info.b_offset;
302*c217d954SCole Faust
303*c217d954SCole Faust _reinterpret_input_as_3d = gemm_info.reinterpret_input_as_3d;
304*c217d954SCole Faust _reinterpret_output_as_3d = (gemm_info.depth_output_gemm3d != 0);
305*c217d954SCole Faust _use_dummy_work_items = preferred_dummy_work_items_support(CLKernelLibrary::get().get_device());
306*c217d954SCole Faust _is_quantized_per_channel = output_stage.is_quantized_per_channel;
307*c217d954SCole Faust
308*c217d954SCole Faust // In case both input and dst have to be reinterpreted as 3D tensors,
309*c217d954SCole Faust // force reinterpret_input_as_3d and reinterpret_output_as_3d to be false.
310*c217d954SCole Faust if(_reinterpret_input_as_3d == _reinterpret_output_as_3d)
311*c217d954SCole Faust {
312*c217d954SCole Faust _reinterpret_input_as_3d = false;
313*c217d954SCole Faust _reinterpret_output_as_3d = false;
314*c217d954SCole Faust }
315*c217d954SCole Faust
316*c217d954SCole Faust // Check if we need to slide the matrix B
317*c217d954SCole Faust const unsigned int num_dimensions_src0 = src0->num_dimensions();
318*c217d954SCole Faust _slide_matrix_b = (src1->num_dimensions() >= num_dimensions_src0);
319*c217d954SCole Faust
320*c217d954SCole Faust ElementsProcessed num_elements_processed{};
321*c217d954SCole Faust
322*c217d954SCole Faust // Configure kernel window
323*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);
324*c217d954SCole Faust ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
325*c217d954SCole Faust ICLKernel::configure_internal(win_config.second);
326*c217d954SCole Faust
327*c217d954SCole Faust // If _reinterpret_input_as_3d = _reinterpret_output_as_3d = true,
328*c217d954SCole Faust // we will dispatch a batched-GEMM to reduce the complexity of the address calculation within the OpenCL kernel.
329*c217d954SCole Faust // This means that the actual m used by the kernel is given by dst->dimension(1) and not by gemm_info.m
330*c217d954SCole Faust const unsigned int internal_m = _reinterpret_output_as_3d ? gemm_info.m : dst->dimension(1);
331*c217d954SCole Faust
332*c217d954SCole Faust // Shrink M0 to be always <= M (internal_m) to prevent out-of-bounds reads.
333*c217d954SCole Faust // NOTE: This might have implications on heuristics and performance
334*c217d954SCole Faust const unsigned int internal_m0 = std::min(internal_m, lhs_info.m0);
335*c217d954SCole Faust
336*c217d954SCole Faust // Calculate partial (store instead of load) M0 and partial N0 for the partial blocks at the end of a row/column if any. This is to avoid padding.
337*c217d954SCole Faust const unsigned int partial_store_m0 = internal_m % internal_m0;
338*c217d954SCole Faust const unsigned int partial_store_n0 = gemm_info.n % rhs_info.n0;
339*c217d954SCole Faust
340*c217d954SCole Faust // Create build options
341*c217d954SCole Faust CLBuildOptions build_opts;
342*c217d954SCole Faust build_opts.add_option_if(_reinterpret_input_as_3d, "-DREINTERPRET_INPUT_AS_3D");
343*c217d954SCole Faust build_opts.add_option_if(_reinterpret_output_as_3d, "-DREINTERPRET_OUTPUT_AS_3D");
344*c217d954SCole Faust build_opts.add_option_if(_reinterpret_input_as_3d || _reinterpret_output_as_3d, "-DHEIGHT_GEMM3D=" + support::cpp11::to_string(dst->dimension(1)));
345*c217d954SCole Faust build_opts.add_option_if(_reinterpret_input_as_3d || _reinterpret_output_as_3d, "-DDEPTH_GEMM3D=" + support::cpp11::to_string(dst->dimension(2)));
346*c217d954SCole Faust build_opts.add_option_if(!_slide_matrix_b, "-DMATRIX_B_DEPTH=" + support::cpp11::to_string(src1->dimension(2)));
347*c217d954SCole Faust build_opts.add_option_if(rhs_info.interleave, "-DRHS_INTERLEAVE");
348*c217d954SCole Faust build_opts.add_option_if(_use_dummy_work_items, "-DDUMMY_WORK_ITEMS");
349*c217d954SCole Faust build_opts.add_option("-DM=" + support::cpp11::to_string(internal_m));
350*c217d954SCole Faust build_opts.add_option("-DN=" + support::cpp11::to_string(gemm_info.n));
351*c217d954SCole Faust build_opts.add_option("-DK=" + support::cpp11::to_string(gemm_info.k));
352*c217d954SCole Faust build_opts.add_option("-DM0=" + support::cpp11::to_string(internal_m0));
353*c217d954SCole Faust build_opts.add_option("-DN0=" + support::cpp11::to_string(rhs_info.n0));
354*c217d954SCole Faust build_opts.add_option("-DK0=" + support::cpp11::to_string(rhs_info.k0));
355*c217d954SCole Faust build_opts.add_option("-DH0=" + support::cpp11::to_string(rhs_info.h0));
356*c217d954SCole Faust build_opts.add_option("-DPARTIAL_STORE_M0=" + support::cpp11::to_string(partial_store_m0));
357*c217d954SCole Faust build_opts.add_option("-DPARTIAL_STORE_N0=" + support::cpp11::to_string(partial_store_n0));
358*c217d954SCole Faust build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(src0->data_type()));
359*c217d954SCole Faust build_opts.add_option("-DACC_DATA_TYPE=" + get_cl_dot8_acc_type_from_data_type(src0->data_type()));
360*c217d954SCole Faust
361*c217d954SCole Faust std::string kernel_name("gemmlowp_mm_reshaped_only_rhs_");
362*c217d954SCole Faust kernel_name += rhs_info.transpose ? "t" : "nt";
363*c217d954SCole Faust
364*c217d954SCole Faust if(output_stage.type == GEMMLowpOutputStageType::QUANTIZE_DOWN_FIXEDPOINT)
365*c217d954SCole Faust {
366*c217d954SCole Faust kernel_name += "_fused_output_stage_fixedpoint";
367*c217d954SCole Faust _fuse_output_stage = true;
368*c217d954SCole Faust // If a_offset == 0, vector_sum_col can be a nullptr
369*c217d954SCole Faust if(a_offset != 0 && vector_sum_col != nullptr)
370*c217d954SCole Faust {
371*c217d954SCole Faust build_opts.add_option("-DA_OFFSET=" + support::cpp11::to_string(a_offset));
372*c217d954SCole Faust build_opts.add_option_if(vector_sum_col->tensor_shape().num_dimensions() > 1, "-DSUM_COL_HAS_BATCHES");
373*c217d954SCole Faust }
374*c217d954SCole Faust // If b_offset == 0, vector_sum_row can be a nullptr
375*c217d954SCole Faust build_opts.add_option_if(b_offset != 0, "-DB_OFFSET=" + support::cpp11::to_string(b_offset));
376*c217d954SCole Faust build_opts.add_option("-DK_OFFSET=" + support::cpp11::to_string(a_offset * b_offset * src0->dimension(0)));
377*c217d954SCole Faust build_opts.add_option_if(bias != nullptr, "-DADD_BIAS");
378*c217d954SCole Faust build_opts.add_option("-DRESULT_OFFSET=" + support::cpp11::to_string(output_stage.gemmlowp_offset));
379*c217d954SCole Faust // In case of _is_quantized_per_channel, RESULT_MULTIPLIER and RESULT_SHIFT are not utilized, but they are passed as a part of T_QUANTIZE8 macro.
380*c217d954SCole Faust if(!_is_quantized_per_channel)
381*c217d954SCole Faust {
382*c217d954SCole Faust build_opts.add_option("-DRESULT_MULTIPLIER=" + support::cpp11::to_string(output_stage.gemmlowp_multipliers[0]));
383*c217d954SCole Faust build_opts.add_option("-DRESULT_SHIFT=" + support::cpp11::to_string(output_stage.gemmlowp_shifts[0]));
384*c217d954SCole Faust }
385*c217d954SCole Faust else
386*c217d954SCole Faust {
387*c217d954SCole Faust build_opts.add_option("-DRESULT_MULTIPLIER=0");
388*c217d954SCole Faust build_opts.add_option("-DRESULT_SHIFT=0");
389*c217d954SCole Faust }
390*c217d954SCole Faust build_opts.add_option_if(_is_quantized_per_channel, "-DPER_CHANNEL_QUANTIZATION");
391*c217d954SCole Faust
392*c217d954SCole Faust const int min = output_stage.gemmlowp_min_bound;
393*c217d954SCole Faust const int max = output_stage.gemmlowp_max_bound;
394*c217d954SCole Faust
395*c217d954SCole Faust PixelValue min_val{};
396*c217d954SCole Faust PixelValue max_val{};
397*c217d954SCole Faust std::tie(min_val, max_val) = get_min_max(dst->data_type());
398*c217d954SCole Faust build_opts.add_option_if(min != min_val.get<int32_t>(), "-DMIN_BOUND=" + support::cpp11::to_string(min));
399*c217d954SCole Faust build_opts.add_option_if(max != max_val.get<int32_t>(), "-DMAX_BOUND=" + support::cpp11::to_string(max));
400*c217d954SCole Faust }
401*c217d954SCole Faust
402*c217d954SCole Faust // A macro guard to compile ONLY the kernel of interest
403*c217d954SCole Faust build_opts.add_option("-D" + upper_string(kernel_name));
404*c217d954SCole Faust
405*c217d954SCole Faust // Create kernel
406*c217d954SCole Faust _kernel = create_kernel(compile_context, kernel_name, build_opts.options());
407*c217d954SCole Faust
408*c217d954SCole Faust // Set config_id for enabling LWS tuning
409*c217d954SCole Faust _config_id = kernel_name;
410*c217d954SCole Faust _config_id += "_";
411*c217d954SCole Faust _config_id += dot8_supported(CLKernelLibrary::get().get_device()) ? "_dot8" : "";
412*c217d954SCole Faust _config_id += "_";
413*c217d954SCole Faust _config_id += (_reinterpret_input_as_3d ? "3di_" : "");
414*c217d954SCole Faust _config_id += (_reinterpret_output_as_3d ? "3do_" : "");
415*c217d954SCole Faust _config_id += support::cpp11::to_string(dst->dimension(1));
416*c217d954SCole Faust _config_id += "_";
417*c217d954SCole Faust _config_id += support::cpp11::to_string(dst->dimension(0));
418*c217d954SCole Faust _config_id += "_";
419*c217d954SCole Faust _config_id += support::cpp11::to_string(gemm_info.k);
420*c217d954SCole Faust _config_id += "_";
421*c217d954SCole Faust _config_id += support::cpp11::to_string(dst->dimension(2));
422*c217d954SCole Faust _config_id += "_";
423*c217d954SCole Faust _config_id += support::cpp11::to_string(lhs_info.m0);
424*c217d954SCole Faust _config_id += "_";
425*c217d954SCole Faust _config_id += support::cpp11::to_string(rhs_info.n0);
426*c217d954SCole Faust _config_id += "_";
427*c217d954SCole Faust _config_id += support::cpp11::to_string(rhs_info.k0);
428*c217d954SCole Faust _config_id += "_";
429*c217d954SCole Faust _config_id += support::cpp11::to_string(rhs_info.h0);
430*c217d954SCole Faust _config_id += "_";
431*c217d954SCole Faust _config_id += support::cpp11::to_string(rhs_info.interleave);
432*c217d954SCole Faust ARM_COMPUTE_ERROR_ON(has_padding_changed(padding_info));
433*c217d954SCole Faust }
434*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)435*c217d954SCole Faust Status ClGemmLowpMatrixMultiplyReshapedOnlyRhsKernel::validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, const GEMMKernelInfo &gemm_info,
436*c217d954SCole Faust const ITensorInfo *vector_sum_col, const ITensorInfo *vector_sum_row, const ITensorInfo *bias,
437*c217d954SCole Faust const ITensorInfo *output_multipliers, const ITensorInfo *output_shifts)
438*c217d954SCole Faust {
439*c217d954SCole Faust ElementsProcessed num_elements_processed{};
440*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));
441*c217d954SCole Faust ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(src0->clone().get(),
442*c217d954SCole Faust src1->clone().get(),
443*c217d954SCole Faust dst->clone().get(),
444*c217d954SCole Faust gemm_info,
445*c217d954SCole Faust vector_sum_col != nullptr ? vector_sum_col->clone().get() : nullptr,
446*c217d954SCole Faust vector_sum_row != nullptr ? vector_sum_row->clone().get() : nullptr,
447*c217d954SCole Faust bias != nullptr ? bias->clone().get() : nullptr,
448*c217d954SCole Faust output_multipliers != nullptr ? output_multipliers->clone().get() : nullptr,
449*c217d954SCole Faust output_shifts != nullptr ? output_shifts->clone().get() : nullptr,
450*c217d954SCole Faust num_elements_processed)
451*c217d954SCole Faust .first);
452*c217d954SCole Faust
453*c217d954SCole Faust return Status{};
454*c217d954SCole Faust }
455*c217d954SCole Faust
run_op(ITensorPack & tensors,const Window & window,cl::CommandQueue & queue)456*c217d954SCole Faust void ClGemmLowpMatrixMultiplyReshapedOnlyRhsKernel::run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue)
457*c217d954SCole Faust {
458*c217d954SCole Faust ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this);
459*c217d954SCole Faust ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(ICLKernel::window(), window);
460*c217d954SCole Faust
461*c217d954SCole Faust const auto src0 = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_0));
462*c217d954SCole Faust const auto src1 = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_1));
463*c217d954SCole Faust const auto bias = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_BIAS));
464*c217d954SCole Faust const auto vector_sum_col = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_VEC_COL_SUM));
465*c217d954SCole Faust const auto vector_sum_row = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_VEC_ROW_SUM));
466*c217d954SCole Faust const auto output_shifts = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SHIFTS));
467*c217d954SCole Faust const auto output_multipliers = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_MULTIPLIERS));
468*c217d954SCole Faust auto dst = utils::cast::polymorphic_downcast<ICLTensor *>(tensors.get_tensor(TensorType::ACL_DST));
469*c217d954SCole Faust
470*c217d954SCole Faust if(src1->info()->num_dimensions() < 3)
471*c217d954SCole Faust {
472*c217d954SCole Faust // The stride_z for matrix B must be zero if we do not slice
473*c217d954SCole Faust ARM_COMPUTE_ERROR_ON(src1->info()->strides_in_bytes()[3] != 0);
474*c217d954SCole Faust }
475*c217d954SCole Faust
476*c217d954SCole Faust Window slice = window.first_slice_window_3D();
477*c217d954SCole Faust Window slice_matrix_b = slice;
478*c217d954SCole Faust
479*c217d954SCole Faust slice_matrix_b.set(Window::DimX, Window::Dimension(0, 1, 1));
480*c217d954SCole Faust slice_matrix_b.set(Window::DimY, Window::Dimension(0, 1, 1));
481*c217d954SCole Faust
482*c217d954SCole Faust if(_reinterpret_input_as_3d)
483*c217d954SCole Faust {
484*c217d954SCole Faust // Pass bottom paddings to the kernel if the input has to be reinterpreted as 3D tensor
485*c217d954SCole Faust const unsigned int idx0 = 3 * num_arguments_per_2D_tensor() + 3;
486*c217d954SCole Faust const unsigned int total_cross_plane_pad = src0->info()->padding().top + src0->info()->padding().bottom;
487*c217d954SCole Faust _kernel.setArg<cl_uint>(idx0, static_cast<unsigned int>(total_cross_plane_pad));
488*c217d954SCole Faust }
489*c217d954SCole Faust
490*c217d954SCole Faust if(_reinterpret_output_as_3d)
491*c217d954SCole Faust {
492*c217d954SCole Faust // Pass bottom paddings to the kernel if the dst has to be reinterpreted as 3D tensor
493*c217d954SCole Faust const unsigned int idx0 = 3 * num_arguments_per_2D_tensor() + 3 + (_reinterpret_input_as_3d ? 1 : 0);
494*c217d954SCole Faust const unsigned int total_cross_plane_pad = dst->info()->padding().top + dst->info()->padding().bottom;
495*c217d954SCole Faust _kernel.setArg<cl_uint>(idx0, static_cast<unsigned int>(total_cross_plane_pad));
496*c217d954SCole Faust }
497*c217d954SCole Faust
498*c217d954SCole Faust // Set window for vector_sum_col
499*c217d954SCole Faust Window win_vector_sum_col = slice;
500*c217d954SCole Faust win_vector_sum_col.set(Window::DimY, Window::Dimension(0, 0, 0));
501*c217d954SCole Faust win_vector_sum_col.set(Window::DimZ, Window::Dimension(0, 0, 0));
502*c217d954SCole Faust
503*c217d954SCole Faust // Set window for vector_sum_row
504*c217d954SCole Faust Window win_vector_sum_row = slice;
505*c217d954SCole Faust win_vector_sum_row.set(Window::DimX, Window::Dimension(0, 0, 0));
506*c217d954SCole Faust win_vector_sum_row.set(Window::DimY, Window::Dimension(0, 0, 0));
507*c217d954SCole Faust win_vector_sum_col.set(Window::DimZ, Window::Dimension(0, 0, 0));
508*c217d954SCole Faust
509*c217d954SCole Faust Window biases_slice = slice;
510*c217d954SCole Faust biases_slice.set(Window::DimY, Window::Dimension(0, 1, 1));
511*c217d954SCole Faust biases_slice.set(Window::DimZ, Window::Dimension(0, 1, 1));
512*c217d954SCole Faust
513*c217d954SCole Faust do
514*c217d954SCole Faust {
515*c217d954SCole Faust Window slice_b = slice;
516*c217d954SCole Faust // Don't slice matrix B along the z dimension if matrix B has just 2 dimensions and matrix A more than 2
517*c217d954SCole Faust // This scenario can happen when the matrix multiplication is used to perform a convolution operation
518*c217d954SCole Faust if(!_slide_matrix_b)
519*c217d954SCole Faust {
520*c217d954SCole Faust slice_b = slice_matrix_b;
521*c217d954SCole Faust }
522*c217d954SCole Faust
523*c217d954SCole Faust unsigned int idx = 0;
524*c217d954SCole Faust add_2D_tensor_argument(idx, src0, slice);
525*c217d954SCole Faust add_2D_tensor_argument(idx, src1, slice_b);
526*c217d954SCole Faust add_2D_tensor_argument(idx, dst, slice);
527*c217d954SCole Faust _kernel.setArg<cl_uint>(idx++, static_cast<unsigned int>(src0->info()->strides_in_bytes()[2]));
528*c217d954SCole Faust _kernel.setArg<cl_uint>(idx++, static_cast<unsigned int>(src1->info()->strides_in_bytes()[2]));
529*c217d954SCole Faust _kernel.setArg<cl_uint>(idx++, static_cast<unsigned int>(dst->info()->strides_in_bytes()[2]));
530*c217d954SCole Faust if(_reinterpret_input_as_3d)
531*c217d954SCole Faust {
532*c217d954SCole Faust // Pass bottom paddings to the kernel if the input has to be reinterpreted as 3D tensor
533*c217d954SCole Faust idx++;
534*c217d954SCole Faust }
535*c217d954SCole Faust
536*c217d954SCole Faust if(_reinterpret_output_as_3d)
537*c217d954SCole Faust {
538*c217d954SCole Faust // Pass bottom paddings to the kernel if the dst has to be reinterpreted as 3D tensor
539*c217d954SCole Faust idx++;
540*c217d954SCole Faust }
541*c217d954SCole Faust
542*c217d954SCole Faust if(_fuse_output_stage)
543*c217d954SCole Faust {
544*c217d954SCole Faust add_2D_tensor_argument_if((vector_sum_col != nullptr), idx, vector_sum_col, win_vector_sum_col);
545*c217d954SCole Faust add_2D_tensor_argument_if((vector_sum_row != nullptr), idx, vector_sum_row, win_vector_sum_row);
546*c217d954SCole Faust add_1D_tensor_argument_if((bias != nullptr), idx, bias, biases_slice);
547*c217d954SCole Faust add_1D_tensor_argument_if(_is_quantized_per_channel, idx, output_multipliers, biases_slice);
548*c217d954SCole Faust add_1D_tensor_argument_if(_is_quantized_per_channel, idx, output_shifts, biases_slice);
549*c217d954SCole Faust }
550*c217d954SCole Faust enqueue(queue, *this, slice, lws_hint(), _use_dummy_work_items);
551*c217d954SCole Faust }
552*c217d954SCole Faust while(window.slide_window_slice_3D(slice));
553*c217d954SCole Faust }
554*c217d954SCole Faust } // namespace kernels
555*c217d954SCole Faust } // namespace opencl
556*c217d954SCole Faust } // namespace arm_compute
557