xref: /aosp_15_r20/external/ComputeLibrary/src/runtime/CL/functions/CLFullyConnectedLayer.cpp (revision c217d954acce2dbc11938adb493fc0abd69584f3)
1 *c217d954SCole Faust /*
2 *c217d954SCole Faust  * Copyright (c) 2017-2021 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/CLFullyConnectedLayer.h"
25 *c217d954SCole Faust 
26 *c217d954SCole Faust #include "arm_compute/core/CL/CLKernelLibrary.h"
27 *c217d954SCole Faust #include "arm_compute/runtime/CL/CLScheduler.h"
28 *c217d954SCole Faust #include "src/core/helpers/MemoryHelpers.h"
29 *c217d954SCole Faust #include "src/gpu/cl/operators/ClFullyConnected.h"
30 *c217d954SCole Faust 
31 *c217d954SCole Faust namespace arm_compute
32 *c217d954SCole Faust {
33 *c217d954SCole Faust using namespace arm_compute::experimental;
34 *c217d954SCole Faust 
35 *c217d954SCole Faust struct CLFullyConnectedLayer::Impl
36 *c217d954SCole Faust {
37 *c217d954SCole Faust     MemoryGroup      memory_group{};
38 *c217d954SCole Faust     IWeightsManager *weights_manager{ nullptr };
39 *c217d954SCole Faust 
40 *c217d954SCole Faust     std::unique_ptr<opencl::ClFullyConnected> op{ nullptr };
41 *c217d954SCole Faust 
42 *c217d954SCole Faust     const ITensor *original_weights{ nullptr };
43 *c217d954SCole Faust 
44 *c217d954SCole Faust     ITensorPack                      run_pack{};
45 *c217d954SCole Faust     WorkspaceData<CLTensor>          workspace{};
46 *c217d954SCole Faust     experimental::MemoryRequirements aux_mem_req{};
47 *c217d954SCole Faust 
48 *c217d954SCole Faust     bool is_prepared{ false };
49 *c217d954SCole Faust };
50 *c217d954SCole Faust 
CLFullyConnectedLayer(std::shared_ptr<IMemoryManager> memory_manager,IWeightsManager * weights_manager)51 *c217d954SCole Faust CLFullyConnectedLayer::CLFullyConnectedLayer(std::shared_ptr<IMemoryManager> memory_manager, IWeightsManager *weights_manager)
52 *c217d954SCole Faust     : _impl(std::make_unique<Impl>())
53 *c217d954SCole Faust {
54 *c217d954SCole Faust     _impl->memory_group    = MemoryGroup(std::move(memory_manager));
55 *c217d954SCole Faust     _impl->weights_manager = weights_manager;
56 *c217d954SCole Faust }
57 *c217d954SCole Faust 
58 *c217d954SCole Faust CLFullyConnectedLayer::~CLFullyConnectedLayer() = default;
59 *c217d954SCole Faust 
configure(const ICLTensor * input,const ICLTensor * weights,const ICLTensor * biases,ICLTensor * output,FullyConnectedLayerInfo fc_info)60 *c217d954SCole Faust void CLFullyConnectedLayer::configure(const ICLTensor *input, const ICLTensor *weights, const ICLTensor *biases, ICLTensor *output,
61 *c217d954SCole Faust                                       FullyConnectedLayerInfo fc_info)
62 *c217d954SCole Faust {
63 *c217d954SCole Faust     configure(CLKernelLibrary::get().get_compile_context(), input, weights, biases, output, fc_info);
64 *c217d954SCole Faust }
65 *c217d954SCole Faust 
configure(const CLCompileContext & compile_context,const ICLTensor * input,const ICLTensor * weights,const ICLTensor * biases,ICLTensor * output,FullyConnectedLayerInfo fc_info)66 *c217d954SCole Faust void CLFullyConnectedLayer::configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *weights, const ICLTensor *biases, ICLTensor *output,
67 *c217d954SCole Faust                                       FullyConnectedLayerInfo fc_info)
68 *c217d954SCole Faust {
69 *c217d954SCole Faust     // Perform validate step
70 *c217d954SCole Faust     ARM_COMPUTE_ERROR_ON_NULLPTR(input, weights, output);
71 *c217d954SCole Faust     ARM_COMPUTE_ERROR_THROW_ON(CLFullyConnectedLayer::validate(input->info(),
72 *c217d954SCole Faust                                                                weights->info(),
73 *c217d954SCole Faust                                                                biases != nullptr ? biases->info() : nullptr,
74 *c217d954SCole Faust                                                                output->info(),
75 *c217d954SCole Faust                                                                fc_info));
76 *c217d954SCole Faust 
77 *c217d954SCole Faust     _impl->op               = std::make_unique<opencl::ClFullyConnected>();
78 *c217d954SCole Faust     _impl->original_weights = weights;
79 *c217d954SCole Faust     _impl->is_prepared      = fc_info.retain_internal_weights;
80 *c217d954SCole Faust 
81 *c217d954SCole Faust     _impl->op->configure(compile_context, input->info(), weights->info(), (biases != nullptr) ? biases->info() : nullptr, output->info(), fc_info);
82 *c217d954SCole Faust 
83 *c217d954SCole Faust     if(_impl->weights_manager != nullptr)
84 *c217d954SCole Faust     {
85 *c217d954SCole Faust         _impl->weights_manager->manage(_impl->original_weights);
86 *c217d954SCole Faust     }
87 *c217d954SCole Faust 
88 *c217d954SCole Faust     if(!_impl->is_prepared)
89 *c217d954SCole Faust     {
90 *c217d954SCole Faust         _impl->aux_mem_req = _impl->op->workspace();
91 *c217d954SCole Faust         _impl->run_pack    = { { ACL_SRC_0, input }, { ACL_SRC_1, weights }, { ACL_SRC_2, biases }, { ACL_DST, output } };
92 *c217d954SCole Faust         _impl->workspace   = manage_workspace<CLTensor>(_impl->aux_mem_req, _impl->memory_group, _impl->run_pack, _impl->run_pack);
93 *c217d954SCole Faust     }
94 *c217d954SCole Faust     else
95 *c217d954SCole Faust     {
96 *c217d954SCole Faust         _impl->run_pack.add_tensor(ACL_SRC_0, input);
97 *c217d954SCole Faust         _impl->run_pack.add_tensor(ACL_DST, output);
98 *c217d954SCole Faust     }
99 *c217d954SCole Faust }
100 *c217d954SCole Faust 
validate(const ITensorInfo * input,const ITensorInfo * weights,const ITensorInfo * biases,const ITensorInfo * output,FullyConnectedLayerInfo fc_info)101 *c217d954SCole Faust Status CLFullyConnectedLayer::validate(const ITensorInfo *input, const ITensorInfo *weights, const ITensorInfo *biases, const ITensorInfo *output,
102 *c217d954SCole Faust                                        FullyConnectedLayerInfo fc_info)
103 *c217d954SCole Faust {
104 *c217d954SCole Faust     return opencl::ClFullyConnected::validate(input, weights, biases, output, fc_info);
105 *c217d954SCole Faust }
106 *c217d954SCole Faust 
run()107 *c217d954SCole Faust void CLFullyConnectedLayer::run()
108 *c217d954SCole Faust {
109 *c217d954SCole Faust     prepare();
110 *c217d954SCole Faust 
111 *c217d954SCole Faust     MemoryGroupResourceScope scope_mg(_impl->memory_group);
112 *c217d954SCole Faust     _impl->op->run(_impl->run_pack);
113 *c217d954SCole Faust }
114 *c217d954SCole Faust 
prepare()115 *c217d954SCole Faust void CLFullyConnectedLayer::prepare()
116 *c217d954SCole Faust {
117 *c217d954SCole Faust     if(!_impl->is_prepared)
118 *c217d954SCole Faust     {
119 *c217d954SCole Faust         _impl->op->prepare(_impl->run_pack);
120 *c217d954SCole Faust 
121 *c217d954SCole Faust         // Release temporary tensors that are only used in prepare stage
122 *c217d954SCole Faust         release_temporaries<CLTensor>(_impl->aux_mem_req, _impl->workspace);
123 *c217d954SCole Faust         _impl->is_prepared = true;
124 *c217d954SCole Faust 
125 *c217d954SCole Faust         // Handle weights managed infrastructure
126 *c217d954SCole Faust         if(_impl->weights_manager != nullptr && _impl->weights_manager->are_weights_managed(_impl->original_weights))
127 *c217d954SCole Faust         {
128 *c217d954SCole Faust             // Ensure that b gets marked as unused (memory released) only after the last function which uses b also finishes its prepare
129 *c217d954SCole Faust             // This is for cases where multiple functions share the same b (weights)
130 *c217d954SCole Faust             // Therefore when a function marks original b as unused, we pre-mark it in weights manager, and mark it back to used so that it doesn't get released before its last reference
131 *c217d954SCole Faust             const ITensor *original_b = _impl->original_weights;
132 *c217d954SCole Faust             if(!original_b->is_used())
133 *c217d954SCole Faust             {
134 *c217d954SCole Faust                 _impl->weights_manager->pre_mark_as_unused(original_b);
135 *c217d954SCole Faust             }
136 *c217d954SCole Faust             _impl->original_weights->mark_as_used();
137 *c217d954SCole Faust             _impl->weights_manager->release(_impl->original_weights);
138 *c217d954SCole Faust         }
139 *c217d954SCole Faust     }
140 *c217d954SCole Faust }
141 *c217d954SCole Faust } // namespace arm_compute
142