Compute Library
 21.02
CLTensor.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-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_CLTENSOR_H
25 #define ARM_COMPUTE_CLTENSOR_H
26 
30 
31 #include <cstdint>
32 
33 namespace arm_compute
34 {
35 // Forward declarations
36 class ITensorAllocator;
37 class ITensorInfo;
38 class IRuntimeContext;
39 class CLRuntimeContext;
40 /** Basic implementation of the OpenCL tensor interface */
41 class CLTensor : public ICLTensor, public IMemoryManageable
42 {
43 public:
44  /** Constructor.
45  *
46  * @param[in] ctx (Optional) Pointer to a @ref CLRuntimeContext.
47  * If nullptr is passed in, the legacy api using the singletons will be used. Otherwise the memory for the
48  * tensor will allocate on the context passed in.
49  * The singletons legacy api has been deprecated and will be removed in future releases.
50  */
51  CLTensor(IRuntimeContext *ctx = nullptr);
52 
53  /** Destructor */
54  ~CLTensor() = default;
55  /** Prevent copying by construction */
56  CLTensor(const CLTensor &) = delete;
57  /** Default move constructor */
58  CLTensor(CLTensor &&) = default;
59  /** Prevent copaingy by assignment */
60  CLTensor &operator=(const CLTensor &) = delete;
61  /** Default move assignment operator */
62  CLTensor &operator=(CLTensor &&) = default;
63 
64  /** Return a pointer to the tensor's allocator
65  *
66  * @return A pointer to the tensor's allocator
67  */
69  /** Enqueue a map operation of the allocated buffer.
70  *
71  * @param[in] blocking If true, then the mapping will be ready to use by the time
72  * this method returns, else it is the caller's responsibility
73  * to flush the queue and wait for the mapping operation to have completed.
74  */
75  void map(bool blocking = true);
76  using ICLTensor::map;
77  /** Enqueue an unmap operation of the allocated and mapped buffer.
78  *
79  * @note This method simply enqueues the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before
80  * the memory is accessed by the device.
81  */
82  void unmap();
83  using ICLTensor::unmap;
84 
85  // Inherited methods overridden:
86  TensorInfo *info() const override;
87  TensorInfo *info() override;
88  const cl::Buffer &cl_buffer() const override;
89  CLQuantization quantization() const override;
90  void associate_memory_group(IMemoryGroup *memory_group) override;
92 
93 protected:
94  // Inherited methods overridden:
95  uint8_t *do_map(cl::CommandQueue &q, bool blocking) override;
96  void do_unmap(cl::CommandQueue &q) override;
97 
98 private:
99  mutable CLTensorAllocator _allocator; /**< Instance of the OpenCL tensor allocator */
100  CLRuntimeContext *_ctx{ nullptr };
101 };
102 
103 /** OpenCL Image */
105 } // namespace arm_compute
106 #endif /*ARM_COMPUTE_CLTENSOR_H */
Memory group interface.
Definition: IMemoryGroup.h:37
void map(cl::CommandQueue &q, bool blocking=true)
Enqueue a map operation of the allocated buffer on the given queue.
Definition: ICLTensor.cpp:35
TensorInfo * info() const override
Interface to be implemented by the child class to return the tensor&#39;s metadata.
Definition: CLTensor.cpp:41
const cl::Buffer & cl_buffer() const override
Interface to be implemented by the child class to return a reference to the OpenCL buffer containing ...
Definition: CLTensor.cpp:51
void associate_memory_group(IMemoryGroup *memory_group) override
Associates a memory managable object with the memory group that manages it.
Definition: CLTensor.cpp:86
CLTensorAllocator * allocator()
Return a pointer to the tensor&#39;s allocator.
Definition: CLTensor.cpp:61
OpenCL quantization data.
Definition: CLTypes.h:62
Copyright (c) 2017-2021 Arm Limited.
Basic implementation of a CL memory tensor allocator.
void map(bool blocking=true)
Enqueue a map operation of the allocated buffer.
Definition: CLTensor.cpp:66
~CLTensor()=default
Destructor.
CLQuantization quantization() const override
Interface to be implemented by the child class to return the wrapped quantization info data...
Definition: CLTensor.cpp:56
void unmap(cl::CommandQueue &q)
Enqueue an unmap operation of the allocated and mapped buffer on the given queue. ...
Definition: ICLTensor.cpp:40
CLTensor(IRuntimeContext *ctx=nullptr)
Constructor.
Definition: CLTensor.cpp:31
CLRuntimeContext * context()
Definition: CLTensor.cpp:36
Interface for OpenCL tensor.
Definition: ICLTensor.h:42
Interface of an object than can be memory managed.
Definition: IMemoryGroup.h:69
CLTensor & operator=(const CLTensor &)=delete
Prevent copaingy by assignment.
Wrapper to configure the Khronos OpenCL C++ header.
Store the tensor&#39;s metadata.
Definition: TensorInfo.h:45
void unmap()
Enqueue an unmap operation of the allocated and mapped buffer.
Definition: CLTensor.cpp:71
Basic implementation of the OpenCL tensor interface.
Definition: CLTensor.h:41