xref: /aosp_15_r20/external/ComputeLibrary/src/runtime/CL/functions/CLGEMM.cpp (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1*c217d954SCole Faust /*
2*c217d954SCole Faust  * Copyright (c) 2017-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 "arm_compute/runtime/CL/functions/CLGEMM.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/Helpers.h"
29*c217d954SCole Faust #include "arm_compute/core/KernelDescriptors.h"
30*c217d954SCole Faust #include "arm_compute/core/TensorInfo.h"
31*c217d954SCole Faust #include "arm_compute/core/Types.h"
32*c217d954SCole Faust #include "arm_compute/core/Utils.h"
33*c217d954SCole Faust #include "src/core/helpers/MemoryHelpers.h"
34*c217d954SCole Faust #include "src/gpu/cl/operators/ClGemm.h"
35*c217d954SCole Faust 
36*c217d954SCole Faust namespace arm_compute
37*c217d954SCole Faust {
38*c217d954SCole Faust using namespace arm_compute::experimental;
39*c217d954SCole Faust using OperatorType = opencl::ClGemm;
40*c217d954SCole Faust 
41*c217d954SCole Faust struct CLGEMM::Impl
42*c217d954SCole Faust {
43*c217d954SCole Faust     const ICLTensor              *b{ nullptr };
44*c217d954SCole Faust     std::unique_ptr<OperatorType> op{ nullptr };
45*c217d954SCole Faust     MemoryGroup                   memory_group{};
46*c217d954SCole Faust     IWeightsManager              *weights_manager{ nullptr };
47*c217d954SCole Faust     ITensorPack                   run_pack{};
48*c217d954SCole Faust     ITensorPack                   prep_pack{};
49*c217d954SCole Faust     MemoryRequirements            aux_mem_req{};
50*c217d954SCole Faust     WorkspaceData<CLTensor>       workspace_tensors{};
51*c217d954SCole Faust     bool                          is_prepared{ false };
52*c217d954SCole Faust };
53*c217d954SCole Faust 
CLGEMM(std::shared_ptr<IMemoryManager> memory_manager,IWeightsManager * weights_manager)54*c217d954SCole Faust CLGEMM::CLGEMM(std::shared_ptr<IMemoryManager> memory_manager, IWeightsManager *weights_manager)
55*c217d954SCole Faust     : _impl(std::make_unique<Impl>())
56*c217d954SCole Faust {
57*c217d954SCole Faust     _impl->memory_group    = MemoryGroup(memory_manager);
58*c217d954SCole Faust     _impl->weights_manager = weights_manager;
59*c217d954SCole Faust }
60*c217d954SCole Faust 
61*c217d954SCole Faust CLGEMM::~CLGEMM() = default;
62*c217d954SCole Faust 
configure(const ICLTensor * a,const ICLTensor * b,const ICLTensor * c,ICLTensor * output,float alpha,float beta,const GEMMInfo & gemm_info)63*c217d954SCole Faust void CLGEMM::configure(const ICLTensor *a, const ICLTensor *b, const ICLTensor *c, ICLTensor *output, float alpha, float beta, const GEMMInfo &gemm_info)
64*c217d954SCole Faust {
65*c217d954SCole Faust     configure(CLKernelLibrary::get().get_compile_context(), a, b, c, output, alpha, beta, gemm_info);
66*c217d954SCole Faust }
67*c217d954SCole Faust 
configure(const CLCompileContext & compile_context,const ICLTensor * a,const ICLTensor * b,const ICLTensor * c,ICLTensor * output,float alpha,float beta,const GEMMInfo & gemm_info)68*c217d954SCole Faust void CLGEMM::configure(const CLCompileContext &compile_context, const ICLTensor *a, const ICLTensor *b, const ICLTensor *c, ICLTensor *output, float alpha, float beta, const GEMMInfo &gemm_info)
69*c217d954SCole Faust {
70*c217d954SCole Faust     ARM_COMPUTE_ERROR_ON_NULLPTR(a, b, output);
71*c217d954SCole Faust 
72*c217d954SCole Faust     _impl->b           = b;
73*c217d954SCole Faust     _impl->op          = std::make_unique<OperatorType>();
74*c217d954SCole Faust     _impl->is_prepared = gemm_info.retain_internal_weights();
75*c217d954SCole Faust 
76*c217d954SCole Faust     _impl->op->configure(compile_context, a->info(), b->info(), c != nullptr ? c->info() : nullptr, output->info(), alpha, beta, gemm_info);
77*c217d954SCole Faust     _impl->aux_mem_req = _impl->op->workspace();
78*c217d954SCole Faust 
79*c217d954SCole Faust     // Manage/allocate auxilairy tensors
80*c217d954SCole Faust     if(_impl->is_prepared)
81*c217d954SCole Faust     {
82*c217d954SCole Faust         _impl->run_pack.add_const_tensor(ACL_SRC_0, a);
83*c217d954SCole Faust         _impl->run_pack.add_tensor(ACL_DST, output);
84*c217d954SCole Faust     }
85*c217d954SCole Faust     else
86*c217d954SCole Faust     {
87*c217d954SCole Faust         _impl->run_pack  = { { ACL_SRC_0, a }, { ACL_SRC_2, c }, { ACL_DST, output } };
88*c217d954SCole Faust         _impl->prep_pack = { { ACL_SRC_1, _impl->b } };
89*c217d954SCole Faust 
90*c217d954SCole Faust         _impl->workspace_tensors = manage_workspace<CLTensor>(_impl->op->workspace(), _impl->memory_group, _impl->run_pack, _impl->prep_pack);
91*c217d954SCole Faust     }
92*c217d954SCole Faust }
93*c217d954SCole Faust 
validate(const ITensorInfo * a,const ITensorInfo * b,const ITensorInfo * c,const ITensorInfo * output,float alpha,float beta,const GEMMInfo & gemm_info)94*c217d954SCole Faust Status CLGEMM::validate(const ITensorInfo *a, const ITensorInfo *b, const ITensorInfo *c, const ITensorInfo *output, float alpha, float beta, const GEMMInfo &gemm_info)
95*c217d954SCole Faust {
96*c217d954SCole Faust     return OperatorType::validate(a, b, c, output, alpha, beta, gemm_info);
97*c217d954SCole Faust }
98*c217d954SCole Faust 
run()99*c217d954SCole Faust void CLGEMM::run()
100*c217d954SCole Faust {
101*c217d954SCole Faust     prepare();
102*c217d954SCole Faust 
103*c217d954SCole Faust     MemoryGroupResourceScope scope_mg(_impl->memory_group);
104*c217d954SCole Faust 
105*c217d954SCole Faust     _impl->op->run(_impl->run_pack);
106*c217d954SCole Faust }
107*c217d954SCole Faust 
prepare()108*c217d954SCole Faust void CLGEMM::prepare()
109*c217d954SCole Faust {
110*c217d954SCole Faust     if(!_impl->is_prepared)
111*c217d954SCole Faust     {
112*c217d954SCole Faust         _impl->op->prepare(_impl->prep_pack);
113*c217d954SCole Faust 
114*c217d954SCole Faust         auto has_reshape = std::find_if(_impl->aux_mem_req.begin(),
115*c217d954SCole Faust                                         _impl->aux_mem_req.end(),
116*c217d954SCole Faust                                         [](const MemoryInfo & m) -> bool { return m.lifetime == MemoryLifetime::Persistent; });
117*c217d954SCole Faust 
118*c217d954SCole Faust         if(has_reshape != std::end(_impl->aux_mem_req))
119*c217d954SCole Faust         {
120*c217d954SCole Faust             _impl->b->mark_as_unused();
121*c217d954SCole Faust         }
122*c217d954SCole Faust         else
123*c217d954SCole Faust         {
124*c217d954SCole Faust             // Pack the B matrix to be used as the underlying GEMM performs no reshapes
125*c217d954SCole Faust             _impl->run_pack.add_const_tensor(ACL_SRC_1, _impl->b);
126*c217d954SCole Faust         }
127*c217d954SCole Faust         _impl->is_prepared = true;
128*c217d954SCole Faust     }
129*c217d954SCole Faust }
130*c217d954SCole Faust } // namespace arm_compute
131