Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2016-2018 ARM Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 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_CLTENSORALLOCATOR_H__ |
| 25 | #define __ARM_COMPUTE_CLTENSORALLOCATOR_H__ |
| 26 | |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 27 | #include "arm_compute/runtime/CL/CLMemory.h" |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 28 | #include "arm_compute/runtime/ITensorAllocator.h" |
| 29 | |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 30 | #include "arm_compute/core/CL/OpenCL.h" |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 31 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 32 | #include <cstdint> |
| 33 | |
| 34 | namespace arm_compute |
| 35 | { |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 36 | class CLTensor; |
| 37 | template <typename> |
| 38 | class MemoryGroupBase; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 39 | /** Memory Group in OpenCL */ |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 40 | using CLMemoryGroup = MemoryGroupBase<CLTensor>; |
| 41 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 42 | /** Basic implementation of a CL memory tensor allocator. */ |
| 43 | class CLTensorAllocator : public ITensorAllocator |
| 44 | { |
| 45 | public: |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 46 | /** Default constructor. |
| 47 | * |
| 48 | * @param[in] owner (Optional) Owner of the allocator. |
| 49 | */ |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 50 | CLTensorAllocator(CLTensor *owner = nullptr); |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 51 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 52 | CLTensorAllocator(const CLTensorAllocator &) = delete; |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 53 | /** Prevent instances of this class from being copy assigned (As this class contains pointers) */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 54 | CLTensorAllocator &operator=(const CLTensorAllocator &) = delete; |
| 55 | /** Allow instances of this class to be moved */ |
| 56 | CLTensorAllocator(CLTensorAllocator &&) = default; |
| 57 | /** Allow instances of this class to be moved */ |
| 58 | CLTensorAllocator &operator=(CLTensorAllocator &&) = default; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 59 | |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 60 | /** Interface to be implemented by the child class to return the pointer to the mapped data. |
| 61 | * |
| 62 | * @return pointer to the mapped data. |
| 63 | */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 64 | uint8_t *data(); |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 65 | /** Interface to be implemented by the child class to return the pointer to the CL data. |
| 66 | * |
| 67 | * @return pointer to the CL data. |
| 68 | */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 69 | const cl::Buffer &cl_data() const; |
Pablo Tello | e86a09f | 2018-01-11 15:44:48 +0000 | [diff] [blame] | 70 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 71 | /** Enqueue a map operation of the allocated buffer on the given queue. |
| 72 | * |
| 73 | * @param[in,out] q The CL command queue to use for the mapping operation. |
| 74 | * @param[in] blocking If true, then the mapping will be ready to use by the time |
| 75 | * this method returns, else it is the caller's responsibility |
| 76 | * to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer. |
| 77 | * |
| 78 | * @return The mapping address. |
| 79 | */ |
| 80 | uint8_t *map(cl::CommandQueue &q, bool blocking); |
| 81 | /** Enqueue an unmap operation of the allocated buffer on the given queue. |
| 82 | * |
| 83 | * @note This method simply enqueue the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before |
| 84 | * the memory is accessed by the device. |
| 85 | * |
| 86 | * @param[in,out] q The CL command queue to use for the mapping operation. |
| 87 | * @param[in] mapping The cpu mapping to unmap. |
| 88 | */ |
| 89 | void unmap(cl::CommandQueue &q, uint8_t *mapping); |
| 90 | |
| 91 | /** Allocate size specified by TensorInfo of OpenCL memory. |
| 92 | * |
| 93 | * @note: The tensor must not already be allocated when calling this function. |
| 94 | * |
| 95 | */ |
| 96 | void allocate() override; |
| 97 | |
| 98 | /** Free allocated OpenCL memory. |
| 99 | * |
| 100 | * @note The tensor must have been allocated when calling this function. |
| 101 | * |
| 102 | */ |
| 103 | void free() override; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 104 | /** Import an existing memory as a tensor's backing memory |
| 105 | * |
| 106 | * @warning If the tensor is flagged to be managed by a memory manager, |
| 107 | * this call will lead to an error. |
| 108 | * @warning Ownership of memory depends on the way the @ref CLMemory object was constructed |
| 109 | * @note Calling free on a tensor with imported memory will just clear |
| 110 | * the internal pointer value. |
| 111 | * |
| 112 | * @param[in] memory Memory to import |
| 113 | * |
| 114 | * @return error status |
| 115 | */ |
| 116 | arm_compute::Status import_memory(CLMemory memory); |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 117 | /** Associates the tensor with a memory group |
| 118 | * |
| 119 | * @param[in] associated_memory_group Memory group to associate the tensor with |
| 120 | */ |
| 121 | void set_associated_memory_group(CLMemoryGroup *associated_memory_group); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 122 | |
| 123 | protected: |
| 124 | /** Call map() on the OpenCL buffer. |
| 125 | * |
| 126 | * @return A pointer to the beginning of the tensor's allocation. |
| 127 | */ |
| 128 | uint8_t *lock() override; |
| 129 | /** Call unmap() on the OpenCL buffer. */ |
| 130 | void unlock() override; |
| 131 | |
| 132 | private: |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 133 | CLMemoryGroup *_associated_memory_group; /**< Registered memory manager */ |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 134 | CLMemory _memory; /**< OpenCL memory */ |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 135 | CLTensor *_owner; /**< Owner of the allocator */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 136 | }; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 137 | } // namespace arm_compute |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 138 | #endif /* __ARM_COMPUTE_CLTENSORALLOCATOR_H__ */ |