Compute Library
 21.11
ClAuxTensorHandler.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021 Arm Limited.
3  *
4  * SPDX-License-Identifier: MIT
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in all
14  * copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22  * SOFTWARE.
23  */
24 #ifndef ARM_COMPUTE_CL_UTILS_CL_AUX_TENSOR_HANDLER_H
25 #define ARM_COMPUTE_CL_UTILS_CL_AUX_TENSOR_HANDLER_H
26 
30 
31 #include "src/common/utils/Log.h"
32 #include "support/Cast.h"
33 
34 namespace arm_compute
35 {
36 namespace opencl
37 {
38 /* Tensor handler to wrap and handle tensor allocations on workspace buffers */
40 {
41 public:
42  CLAuxTensorHandler(int slot_id, TensorInfo &info, ITensorPack &pack, bool pack_inject = false, bool bypass_alloc = false)
43  : _tensor()
44  {
45  if(info.total_size() == 0)
46  {
47  return;
48  }
49  _tensor.allocator()->soft_init(info);
50 
51  ICLTensor *packed_tensor = utils::cast::polymorphic_downcast<ICLTensor *>(pack.get_tensor(slot_id));
52  if((packed_tensor == nullptr) || (info.total_size() > packed_tensor->info()->total_size()))
53  {
54  if(!bypass_alloc)
55  {
56  _tensor.allocator()->allocate();
57  ARM_COMPUTE_LOG_INFO_WITH_FUNCNAME_ACL("Allocating auxiliary tensor");
58  }
59 
60  if(pack_inject)
61  {
62  pack.add_tensor(slot_id, &_tensor);
63  _injected_tensor_pack = &pack;
64  _injected_slot_id = slot_id;
65  }
66  }
67  else
68  {
69  _tensor.allocator()->import_memory(packed_tensor->cl_buffer());
70  }
71  }
72 
74  : _tensor()
75  {
76  _tensor.allocator()->soft_init(info);
77  if(info.total_size() <= tensor.info()->total_size())
78  {
79  _tensor.allocator()->import_memory(tensor.cl_buffer());
80  }
81  }
82 
83  CLAuxTensorHandler(const CLAuxTensorHandler &) = delete;
85 
87  {
88  if(_injected_tensor_pack)
89  {
90  _injected_tensor_pack->remove_tensor(_injected_slot_id);
91  }
92  }
93 
94  ICLTensor *get()
95  {
96  return &_tensor;
97  }
98 
100  {
101  return &_tensor;
102  }
103 
104 private:
105  CLTensor _tensor{};
106  ITensorPack *_injected_tensor_pack{ nullptr };
107  int _injected_slot_id{ TensorType::ACL_UNKNOWN };
108 };
109 } // namespace opencl
110 } // namespace arm_compute
111 #endif /* ARM_COMPUTE_CL_UTILS_CL_AUX_TENSOR_HANDLER_H */
void soft_init(TensorInfo &input, size_t alignment=0)
Initialize a tensor based with a reference TensorInfo.
#define ARM_COMPUTE_LOG_INFO_WITH_FUNCNAME_ACL(msg)
Log an information message to the logger with function name before the message.
Definition: Log.h:99
CLTensorAllocator * allocator()
Return a pointer to the tensor&#39;s allocator.
Definition: CLTensor.cpp:61
Copyright (c) 2017-2021 Arm Limited.
Status import_memory(cl::Buffer buffer)
Import an existing memory as a tensor&#39;s backing memory.
void remove_tensor(int id)
Remove the tensor stored with the given id.
Definition: ITensorPack.cpp:70
size_t total_size() const override
Returns the total size of the tensor in bytes.
Definition: TensorInfo.h:250
virtual ITensorInfo * info() const =0
Interface to be implemented by the child class to return the tensor&#39;s metadata.
CLAuxTensorHandler & operator=(const CLAuxTensorHandler)=delete
void allocate() override
Allocate size specified by TensorInfo of OpenCL memory.
ScaleKernelInfo info(interpolation_policy, default_border_mode, PixelValue(), sampling_policy, false)
ITensor * get_tensor(int id)
Get tensor of a given id from the pac.
Definition: ITensorPack.cpp:64
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
CLAuxTensorHandler(int slot_id, TensorInfo &info, ITensorPack &pack, bool pack_inject=false, bool bypass_alloc=false)
virtual size_t total_size() const =0
Returns the total size of the tensor in bytes.
Tensor packing service.
Definition: ITensorPack.h:39
virtual const cl::Buffer & cl_buffer() const =0
Interface to be implemented by the child class to return a reference to the OpenCL buffer containing ...
Store the tensor&#39;s metadata.
Definition: TensorInfo.h:43
CLAuxTensorHandler(TensorInfo &info, ICLTensor &tensor)
void add_tensor(int id, ITensor *tensor)
Add tensor to the pack.
Definition: ITensorPack.cpp:39
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41