Compute Library
 20.08
ICLArray.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016-2019 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_ICLARRAY_H
25 #define ARM_COMPUTE_ICLARRAY_H
26 
30 
31 namespace arm_compute
32 {
33 /** Interface for OpenCL Array */
34 template <class T>
35 class ICLArray : public IArray<T>
36 {
37 public:
38  /** Constructor
39  *
40  * @param[in] max_num_values Maximum size of the array.
41  *
42  */
43  explicit ICLArray(size_t max_num_values)
44  : IArray<T>(max_num_values), _mapping(nullptr)
45  {
46  }
47 
48  /** Prevent instances of this class from being copy constructed */
49  ICLArray(const ICLArray &) = delete;
50  /** Prevent instances of this class from being copied */
51  ICLArray &operator=(const ICLArray &) = delete;
52  /** Allow instances of this class to be move constructed */
53  ICLArray(ICLArray &&) = default;
54  /** Allow instances of this class to be moved */
55  ICLArray &operator=(ICLArray &&) = default;
56  /** Default virtual destructor. */
57  virtual ~ICLArray() = default;
58  /** Interface to be implemented by the child class to return a reference to the OpenCL buffer containing the array's data.
59  *
60  * @return A reference to an OpenCL buffer containing the array's data.
61  */
62  virtual const cl::Buffer &cl_buffer() const = 0;
63  /** Enqueue a map operation of the allocated buffer on the given queue.
64  *
65  * @param[in,out] q The CL command queue to use for the mapping operation.
66  * @param[in] blocking If true, then the mapping will be ready to use by the time
67  * this method returns, else it is the caller's responsibility
68  * to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer.
69  *
70  * @return The mapping address.
71  */
72  void map(cl::CommandQueue &q, bool blocking = true)
73  {
74  _mapping = do_map(q, blocking);
75  }
76  /** Enqueue an unmap operation of the allocated and mapped buffer on the given queue.
77  *
78  * @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
79  * the memory is accessed by the device.
80  *
81  * @param[in,out] q The CL command queue to use for the mapping operation.
82  */
83  void unmap(cl::CommandQueue &q)
84  {
85  do_unmap(q, _mapping);
86  _mapping = nullptr;
87  }
88 
89  // Inherited methods overridden:
90  T *buffer() const override
91  {
92  return reinterpret_cast<T *>(_mapping);
93  }
94 
95 protected:
96  /** Method to be implemented by the child class to map the OpenCL buffer
97  *
98  * @param[in,out] q The CL command queue to use for the mapping operation.
99  * @param[in] blocking If true, then the mapping will be ready to use by the time
100  * this method returns, else it is the caller's responsibility
101  * to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer.
102  */
103  virtual uint8_t *do_map(cl::CommandQueue &q, bool blocking) = 0;
104  /** Method to be implemented by the child class to unmap the OpenCL buffer
105  *
106  * @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
107  * the memory is accessed by the device.
108  *
109  * @param[in,out] q The CL command queue to use for the mapping operation.
110  * @param[in] mapping Pointer to the buffer to be unmapped.
111  */
112  virtual void do_unmap(cl::CommandQueue &q, uint8_t *mapping) = 0;
113 
114 private:
115  uint8_t *_mapping;
116 };
117 
118 /** Interface for OpenCL Array of Key Points. */
120 /** Interface for OpenCL Array of 2D Coordinates. */
122 /** Interface for OpenCL Array of Detection Windows. */
124 /** Interface for OpenCL Array of 2D Sizes. */
126 /** Interface for OpenCL Array of uint8s. */
128 /** Interface for OpenCL Array of uint16s. */
130 /** Interface for OpenCL Array of uint32s. */
132 /** Interface for OpenCL Array of int16s. */
134 /** Interface for OpenCL Array of int32s. */
136 /** Interface for OpenCL Array of floats. */
138 }
139 #endif /*ARM_COMPUTE_ICLARRAY_H*/
ICLArray(size_t max_num_values)
Constructor.
Definition: ICLArray.h:43
Array of type T.
Definition: IArray.h:40
void map(cl::CommandQueue &q, bool blocking=true)
Enqueue a map operation of the allocated buffer on the given queue.
Definition: ICLArray.h:72
Copyright (c) 2017-2020 Arm Limited.
Interface for OpenCL Array.
Definition: ICLArray.h:35
virtual ~ICLArray()=default
Default virtual destructor.
ICLArray & operator=(const ICLArray &)=delete
Prevent instances of this class from being copied.
void unmap(cl::CommandQueue &q)
Enqueue an unmap operation of the allocated and mapped buffer on the given queue.
Definition: ICLArray.h:83
size_t max_num_values() const
Maximum number of values which can be stored in this array.
Definition: IArray.h:58
T * buffer() const override
Pointer to the first element of the array.
Definition: ICLArray.h:90
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 ...