| /* |
| * 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. |
| */ |
| #include "src/gpu/cl/kernels/ClGemmLowpMatrixMultiplyReshapedKernel.h" |
| |
| #include "arm_compute/core/CL/CLHelpers.h" |
| #include "arm_compute/core/CL/CLKernelLibrary.h" |
| #include "arm_compute/core/CL/ICLTensor.h" |
| #include "arm_compute/core/CL/OpenCL.h" |
| #include "arm_compute/core/Helpers.h" |
| #include "arm_compute/core/TensorInfo.h" |
| #include "arm_compute/core/Validate.h" |
| #include "arm_compute/core/utils/misc/ShapeCalculator.h" |
| #include "arm_compute/core/utils/StringUtils.h" |
| |
| #include "src/core/helpers/AutoConfiguration.h" |
| #include "src/core/helpers/WindowHelpers.h" |
| |
| #include "support/Cast.h" |
| #include "support/StringSupport.h" |
| |
| namespace arm_compute |
| { |
| namespace opencl |
| { |
| namespace kernels |
| { |
| using namespace misc::shape_calculator; |
| |
| namespace |
| { |
| using ElementsProcessed = Steps; |
| |
| Status validate_arguments(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, |
| const GEMMLHSMatrixInfo &lhs_info, const GEMMRHSMatrixInfo &rhs_info, const GEMMReshapeInfo &gemm_info) |
| { |
| ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(src0, src1, dst); |
| ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(src0, 1, DataType::QASYMM8, DataType::QASYMM8_SIGNED); |
| ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(src0, src1); |
| ARM_COMPUTE_RETURN_ERROR_ON_MSG(src0->num_dimensions() > 4, "The number of dimensions for the LHS matrix must be <= 4"); |
| ARM_COMPUTE_RETURN_ERROR_ON_MSG(src1->num_dimensions() > 3, "The number of dimensions for the RHS matrix must be <= 3"); |
| ARM_COMPUTE_RETURN_ERROR_ON(lhs_info.transpose); |
| ARM_COMPUTE_RETURN_ERROR_ON(!rhs_info.transpose); |
| ARM_COMPUTE_RETURN_ERROR_ON(lhs_info.k0 != rhs_info.k0); |
| ARM_COMPUTE_RETURN_ERROR_ON_MSG(((lhs_info.k0 & (lhs_info.k0 - 1)) && lhs_info.k0 != 3), "Only 2,3,4,8,16 are supported for k0"); |
| ARM_COMPUTE_RETURN_ERROR_ON(lhs_info.k0 > 16); |
| ARM_COMPUTE_RETURN_ERROR_ON(lhs_info.m0 < 2 || lhs_info.m0 > 8); |
| ARM_COMPUTE_RETURN_ERROR_ON_MSG(((rhs_info.n0 & (rhs_info.n0 - 1)) && rhs_info.n0 != 3), "Only 2,3,4,8,16 are supported for n0"); |
| ARM_COMPUTE_RETURN_ERROR_ON_MSG(rhs_info.export_to_cl_image, "Export to CLImage not supported for quantized GEMM"); |
| |
| const int m = gemm_info.m(); |
| const int n = gemm_info.n(); |
| const int k = gemm_info.k(); |
| |
| TensorShape tensor_shape0{ src0->tensor_shape() }; |
| tensor_shape0.set(0, k); |
| tensor_shape0.set(1, m); |
| |
| TensorShape tensor_shape1{ src1->tensor_shape() }; |
| tensor_shape1.set(0, n); |
| tensor_shape1.set(1, k); |
| |
| const TensorInfo tensor_info0 = src0->clone()->set_tensor_shape(tensor_shape0); |
| const TensorInfo tensor_info1 = src1->clone()->set_tensor_shape(tensor_shape1); |
| |
| const TensorInfo tensor_info_reshaped0 = src0->clone()->set_tensor_shape(compute_lhs_reshaped_shape(tensor_info0, lhs_info)); |
| const TensorInfo tensor_info_reshaped1 = src1->clone()->set_tensor_shape(compute_rhs_reshaped_shape(tensor_info1, rhs_info)); |
| |
| ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(src0, &tensor_info_reshaped0); |
| ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(src1, &tensor_info_reshaped1); |
| |
| if(dst->total_size() != 0) |
| { |
| const TensorInfo tensor_info_dst = dst->clone()->set_tensor_shape(compute_mm_shape(*src0, *src1, gemm_info)); |
| ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(dst, &tensor_info_dst); |
| ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(dst, 1, DataType::S32); |
| } |
| |
| return Status{}; |
| } |
| |
| std::pair<Status, Window> validate_and_configure_window(const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, |
| const GEMMLHSMatrixInfo &lhs_info, const GEMMRHSMatrixInfo &rhs_info, const GEMMReshapeInfo &gemm_info, |
| ElementsProcessed &num_elements_processed) |
| { |
| unsigned int &num_elems_processed_per_iteration_x = num_elements_processed[0]; |
| unsigned int &num_elems_processed_per_iteration_y = num_elements_processed[1]; |
| bool reinterpret_output_as_3d = (gemm_info.depth_output_gemm3d() != 0); |
| |
| // dst tensor auto initialization if not yet initialized |
| auto_init_if_empty(*dst, src0->clone()->set_tensor_shape(compute_mm_shape(*src0, *src1, gemm_info)).set_data_type(DataType::S32)); |
| |
| TensorInfo tmp_info(*dst); |
| if(reinterpret_output_as_3d) |
| { |
| // Since the dst tensor has to be reinterpreted as 3D and the execute window is based on a 2D GEMM, |
| // the window needs to be constructed on the 2D collapsed version of the tensor |
| TensorShape tmp_shape(dst->tensor_shape()); |
| tmp_shape.collapse(2U, 1U); |
| tmp_info.set_tensor_shape(tmp_shape); |
| } |
| |
| // Configure kernel window |
| num_elems_processed_per_iteration_x = rhs_info.n0; |
| num_elems_processed_per_iteration_y = lhs_info.m0; |
| Window win = calculate_max_window(tmp_info, Steps(num_elems_processed_per_iteration_x, num_elems_processed_per_iteration_y)); |
| |
| // Collapse along the Z direction |
| // This collapse needs to be here in order to tune the Z dimension of LWS |
| Window collapsed = win; |
| const unsigned int dimension_to_collapse = std::min(static_cast<unsigned int>(dst->num_dimensions()), 2u); |
| collapsed = win.collapse(win, dimension_to_collapse); |
| |
| return std::make_pair(Status{}, collapsed); |
| } |
| } // namespace |
| |
| ClGemmLowpMatrixMultiplyReshapedKernel::ClGemmLowpMatrixMultiplyReshapedKernel() |
| { |
| _type = CLKernelType::GEMM; |
| } |
| |
| void ClGemmLowpMatrixMultiplyReshapedKernel::configure(const CLCompileContext &compile_context, const ITensorInfo *src0, const ITensorInfo *src1, ITensorInfo *dst, |
| const GEMMLHSMatrixInfo &lhs_info, const GEMMRHSMatrixInfo &rhs_info, const GEMMReshapeInfo &gemm_info) |
| { |
| ARM_COMPUTE_ERROR_ON_NULLPTR(src0, src1, dst); |
| ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(src0, src1, dst, lhs_info, rhs_info, gemm_info)); |
| |
| _reinterpret_output_as_3d = (gemm_info.depth_output_gemm3d() != 0); |
| _k = gemm_info.k(); |
| _use_dummy_work_items = preferred_dummy_work_items_support(CLKernelLibrary::get().get_device()); |
| |
| // Check if we need to slide the matrix B |
| const unsigned int num_dimensionssrc0 = src0->num_dimensions(); |
| _slide_matrix_b = (src1->num_dimensions() >= num_dimensionssrc0); |
| |
| auto padding_info = get_padding_info({ src0, src1, dst }); |
| ElementsProcessed num_elements_processed{}; |
| |
| // Configure kernel window |
| auto win_config = validate_and_configure_window(src0, src1, dst, lhs_info, rhs_info, gemm_info, num_elements_processed); |
| ARM_COMPUTE_ERROR_THROW_ON(win_config.first); |
| ICLKernel::configure_internal(win_config.second); |
| |
| // 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. |
| const unsigned int internal_m = _reinterpret_output_as_3d ? gemm_info.m() : dst->dimension(1); |
| |
| const unsigned int partial_store_m0 = internal_m % lhs_info.m0; |
| const unsigned int partial_store_n0 = gemm_info.n() % rhs_info.n0; |
| |
| // Create build options |
| CLBuildOptions build_opts; |
| build_opts.add_option_if(_reinterpret_output_as_3d, "-DREINTERPRET_OUTPUT_AS_3D"); |
| build_opts.add_option_if(_reinterpret_output_as_3d, "-DHEIGHT_GEMM3D=" + support::cpp11::to_string(dst->dimension(1))); |
| build_opts.add_option_if(_reinterpret_output_as_3d, "-DDEPTH_GEMM3D=" + support::cpp11::to_string(dst->dimension(2))); |
| build_opts.add_option_if(!_slide_matrix_b, "-DMATRIX_B_DEPTH=" + support::cpp11::to_string(src1->dimension(2))); |
| build_opts.add_option_if(lhs_info.interleave, "-DLHS_INTERLEAVE"); |
| build_opts.add_option_if(rhs_info.interleave, "-DRHS_INTERLEAVE"); |
| build_opts.add_option_if(_use_dummy_work_items, "-DDUMMY_WORK_ITEMS"); |
| build_opts.add_option("-DM=" + support::cpp11::to_string(gemm_info.m())); |
| build_opts.add_option("-DN=" + support::cpp11::to_string(gemm_info.n())); |
| build_opts.add_option("-DM0=" + support::cpp11::to_string(lhs_info.m0)); |
| build_opts.add_option("-DN0=" + support::cpp11::to_string(rhs_info.n0)); |
| build_opts.add_option("-DK0=" + support::cpp11::to_string(lhs_info.k0)); |
| build_opts.add_option("-DV0=" + support::cpp11::to_string(lhs_info.v0)); |
| build_opts.add_option("-DH0=" + support::cpp11::to_string(rhs_info.h0)); |
| build_opts.add_option("-DDATA_TYPE=" + get_cl_type_from_data_type(src0->data_type())); |
| build_opts.add_option("-DACC_DATA_TYPE=" + get_cl_dot8_acc_type_from_data_type(src0->data_type())); |
| build_opts.add_option("-DPARTIAL_STORE_M0=" + support::cpp11::to_string(partial_store_m0)); |
| build_opts.add_option("-DPARTIAL_STORE_N0=" + support::cpp11::to_string(partial_store_n0)); |
| |
| std::string kernel_name("gemmlowp_mm_reshaped_"); |
| kernel_name += lhs_info.transpose ? "lhs_t_" : "lhs_nt_"; |
| kernel_name += rhs_info.transpose ? "rhs_t" : "rhs_nt"; |
| |
| // A macro guard to compile ONLY the kernel of interest |
| build_opts.add_option("-D" + upper_string(kernel_name)); |
| |
| // Create kernel |
| _kernel = create_kernel(compile_context, kernel_name, build_opts.options()); |
| |
| // Set config_id for enabling LWS tuning |
| _config_id = kernel_name; |
| _config_id += "_"; |
| _config_id += dot8_supported(CLKernelLibrary::get().get_device()) ? "_dot8" : ""; |
| _config_id += "_"; |
| _config_id += (_reinterpret_output_as_3d ? "3do_" : ""); |
| _config_id += support::cpp11::to_string(dst->dimension(1)); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(dst->dimension(0)); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(gemm_info.k()); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(dst->dimension(2)); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(lhs_info.m0); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(rhs_info.n0); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(lhs_info.k0); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(lhs_info.v0); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(rhs_info.h0); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(lhs_info.interleave); |
| _config_id += "_"; |
| _config_id += support::cpp11::to_string(rhs_info.interleave); |
| |
| ARM_COMPUTE_ERROR_ON(has_padding_changed(padding_info)); |
| } |
| |
| Status ClGemmLowpMatrixMultiplyReshapedKernel::validate(const ITensorInfo *src0, const ITensorInfo *src1, const ITensorInfo *dst, const GEMMLHSMatrixInfo &lhs_info, |
| const GEMMRHSMatrixInfo &rhs_info, const GEMMReshapeInfo &gemm_info) |
| { |
| ElementsProcessed num_elements_processed{}; |
| ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(src0, src1, dst, lhs_info, rhs_info, gemm_info)); |
| ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(src0->clone().get(), |
| src1->clone().get(), |
| dst->clone().get(), |
| lhs_info, |
| rhs_info, |
| gemm_info, |
| num_elements_processed) |
| .first); |
| |
| return Status{}; |
| } |
| |
| void ClGemmLowpMatrixMultiplyReshapedKernel::run_op(ITensorPack &tensors, const Window &window, cl::CommandQueue &queue) |
| { |
| ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this); |
| ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(ICLKernel::window(), window); |
| |
| const auto src0 = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_0)); |
| const auto src1 = utils::cast::polymorphic_downcast<const ICLTensor *>(tensors.get_const_tensor(TensorType::ACL_SRC_1)); |
| auto dst = utils::cast::polymorphic_downcast<ICLTensor *>(tensors.get_tensor(TensorType::ACL_DST)); |
| |
| if(src1->info()->num_dimensions() < 3) |
| { |
| // The stride_z for matrix B must be zero if we do not slice |
| ARM_COMPUTE_ERROR_ON(src1->info()->strides_in_bytes()[3] != 0); |
| } |
| |
| Window slice = window.first_slice_window_3D(); |
| Window slice_matrix_b = slice; |
| |
| slice_matrix_b.set(Window::DimX, Window::Dimension(0, 1, 1)); |
| slice_matrix_b.set(Window::DimY, Window::Dimension(0, 1, 1)); |
| |
| if(_reinterpret_output_as_3d) |
| { |
| // Pass bottom paddings to the kernel if the dst has to be reinterpreted as 3D tensor |
| const unsigned int idx0 = 3 * num_arguments_per_2D_tensor() + 4; |
| const unsigned int total_cross_plane_pad = dst->info()->padding().top + dst->info()->padding().bottom; |
| _kernel.setArg<cl_uint>(idx0, static_cast<unsigned int>(total_cross_plane_pad)); |
| } |
| |
| do |
| { |
| Window slice_b = slice; |
| // Don't slice matrix B along the z dimension if matrix B has just 2 dimensions and matrix A more than 2 |
| // This scenario can happen when the matrix multiplication is used to perform a convolution operation |
| if(!_slide_matrix_b) |
| { |
| slice_b = slice_matrix_b; |
| } |
| |
| unsigned int idx = 0; |
| add_2D_tensor_argument(idx, src0, slice); |
| add_2D_tensor_argument(idx, src1, slice_b); |
| add_2D_tensor_argument(idx, dst, slice); |
| _kernel.setArg<cl_uint>(idx++, static_cast<unsigned int>(_k)); |
| _kernel.setArg<cl_uint>(idx++, static_cast<unsigned int>(src0->info()->strides_in_bytes()[2])); |
| _kernel.setArg<cl_uint>(idx++, static_cast<unsigned int>(src1->info()->strides_in_bytes()[2])); |
| _kernel.setArg<cl_uint>(idx++, static_cast<unsigned int>(dst->info()->strides_in_bytes()[2])); |
| enqueue(queue, *this, slice, lws_hint(), _use_dummy_work_items); |
| } |
| while(window.slide_window_slice_3D(slice)); |
| } |
| } // namespace kernels |
| } // namespace opencl |
| } // namespace arm_compute |