Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 1 | /* |
SiCong Li | a359ee9 | 2023-04-18 13:49:56 +0100 | [diff] [blame] | 2 | * Copyright (c) 2018-2021, 2023 Arm Limited. |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_RUNTIME_CL_CL_MEMORY_REGION_H |
| 25 | #define ARM_COMPUTE_RUNTIME_CL_CL_MEMORY_REGION_H |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/CL/OpenCL.h" |
| 28 | #include "arm_compute/runtime/IMemoryRegion.h" |
| 29 | |
| 30 | #include <cstddef> |
| 31 | |
| 32 | namespace arm_compute |
| 33 | { |
| 34 | /** OpenCL memory region interface */ |
| 35 | class ICLMemoryRegion : public IMemoryRegion |
| 36 | { |
| 37 | public: |
| 38 | /** Constructor |
| 39 | * |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 40 | * @param[in] size Region size |
| 41 | */ |
Georgios Pinitas | 2cd5b31 | 2021-05-04 21:39:57 +0100 | [diff] [blame] | 42 | ICLMemoryRegion(size_t size); |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 43 | /** Default Destructor */ |
| 44 | virtual ~ICLMemoryRegion() = default; |
| 45 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 46 | ICLMemoryRegion(const ICLMemoryRegion &) = delete; |
| 47 | /** Default move constructor */ |
| 48 | ICLMemoryRegion(ICLMemoryRegion &&) = default; |
| 49 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 50 | ICLMemoryRegion &operator=(const ICLMemoryRegion &) = delete; |
| 51 | /** Default move assignment operator */ |
| 52 | ICLMemoryRegion &operator=(ICLMemoryRegion &&) = default; |
| 53 | /** Returns the underlying CL buffer |
| 54 | * |
| 55 | * @return CL memory buffer object |
| 56 | */ |
| 57 | const cl::Buffer &cl_data() const; |
| 58 | /** Host/SVM pointer accessor |
| 59 | * |
| 60 | * @return Host/SVM pointer base |
| 61 | */ |
| 62 | virtual void *ptr() = 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 | virtual void *map(cl::CommandQueue &q, bool blocking) = 0; |
| 73 | /** Enqueue an unmap operation of the allocated buffer on the given queue. |
| 74 | * |
| 75 | * @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 |
| 76 | * the memory is accessed by the device. |
| 77 | * |
| 78 | * @param[in,out] q The CL command queue to use for the mapping operation. |
| 79 | */ |
| 80 | virtual void unmap(cl::CommandQueue &q) = 0; |
| 81 | |
| 82 | // Inherited methods overridden : |
Georgios Pinitas | df31036 | 2018-11-14 13:16:56 +0000 | [diff] [blame] | 83 | void *buffer() override; |
Georgios Pinitas | 74ef1db | 2020-01-20 17:01:15 +0000 | [diff] [blame] | 84 | const void *buffer() const override; |
Georgios Pinitas | df31036 | 2018-11-14 13:16:56 +0000 | [diff] [blame] | 85 | std::unique_ptr<IMemoryRegion> extract_subregion(size_t offset, size_t size) override; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 86 | |
| 87 | protected: |
SiCong Li | a359ee9 | 2023-04-18 13:49:56 +0100 | [diff] [blame] | 88 | cl::Context _ctx; |
| 89 | void *_mapping; |
| 90 | cl::Buffer _mem; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 91 | }; |
| 92 | |
| 93 | /** OpenCL buffer memory region implementation */ |
| 94 | class CLBufferMemoryRegion final : public ICLMemoryRegion |
| 95 | { |
| 96 | public: |
| 97 | /** Constructor |
| 98 | * |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 99 | * @param[in] flags Memory flags |
| 100 | * @param[in] size Region size |
| 101 | */ |
Georgios Pinitas | 2cd5b31 | 2021-05-04 21:39:57 +0100 | [diff] [blame] | 102 | CLBufferMemoryRegion(cl_mem_flags flags, size_t size); |
Georgios Pinitas | df31036 | 2018-11-14 13:16:56 +0000 | [diff] [blame] | 103 | /** Constructor |
| 104 | * |
| 105 | * @param[in] buffer Buffer to be used as a memory region |
| 106 | */ |
Georgios Pinitas | 2cd5b31 | 2021-05-04 21:39:57 +0100 | [diff] [blame] | 107 | CLBufferMemoryRegion(const cl::Buffer &buffer); |
SiCong Li | 7d91c61 | 2023-08-11 17:58:56 +0100 | [diff] [blame] | 108 | virtual ~CLBufferMemoryRegion() override; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 109 | |
| 110 | // Inherited methods overridden : |
Georgios Pinitas | df31036 | 2018-11-14 13:16:56 +0000 | [diff] [blame] | 111 | void *ptr() final; |
| 112 | void *map(cl::CommandQueue &q, bool blocking) final; |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 113 | void unmap(cl::CommandQueue &q) final; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 114 | }; |
| 115 | |
| 116 | /** OpenCL SVM memory region interface */ |
| 117 | class ICLSVMMemoryRegion : public ICLMemoryRegion |
| 118 | { |
| 119 | protected: |
| 120 | /** Constructor |
| 121 | * |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 122 | * @param[in] flags Memory flags |
| 123 | * @param[in] size Region size |
| 124 | * @param[in] alignment Alignment |
| 125 | */ |
Georgios Pinitas | 2cd5b31 | 2021-05-04 21:39:57 +0100 | [diff] [blame] | 126 | ICLSVMMemoryRegion(cl_mem_flags flags, size_t size, size_t alignment); |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 127 | /** Destructor */ |
| 128 | virtual ~ICLSVMMemoryRegion(); |
| 129 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 130 | ICLSVMMemoryRegion(const ICLSVMMemoryRegion &) = delete; |
| 131 | /** Default move constructor */ |
| 132 | ICLSVMMemoryRegion(ICLSVMMemoryRegion &&) = default; |
| 133 | /** Prevent instances of this class from being copied (As this class contains pointers) */ |
| 134 | ICLSVMMemoryRegion &operator=(const ICLSVMMemoryRegion &) = delete; |
| 135 | /** Default move assignment operator */ |
| 136 | ICLSVMMemoryRegion &operator=(ICLSVMMemoryRegion &&) = default; |
| 137 | |
| 138 | // Inherited methods overridden : |
| 139 | void *ptr() override; |
| 140 | |
| 141 | protected: |
| 142 | void *_ptr; |
| 143 | }; |
| 144 | |
| 145 | /** OpenCL coarse-grain SVM memory region implementation */ |
| 146 | class CLCoarseSVMMemoryRegion final : public ICLSVMMemoryRegion |
| 147 | { |
| 148 | public: |
| 149 | /** Constructor |
| 150 | * |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 151 | * @param[in] flags Memory flags |
| 152 | * @param[in] size Region size |
| 153 | * @param[in] alignment Alignment |
| 154 | */ |
Georgios Pinitas | 2cd5b31 | 2021-05-04 21:39:57 +0100 | [diff] [blame] | 155 | CLCoarseSVMMemoryRegion(cl_mem_flags flags, size_t size, size_t alignment); |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 156 | |
| 157 | // Inherited methods overridden : |
Georgios Pinitas | df31036 | 2018-11-14 13:16:56 +0000 | [diff] [blame] | 158 | void *map(cl::CommandQueue &q, bool blocking) final; |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 159 | void unmap(cl::CommandQueue &q) final; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 160 | }; |
| 161 | |
| 162 | /** OpenCL fine-grain SVM memory region implementation */ |
| 163 | class CLFineSVMMemoryRegion final : public ICLSVMMemoryRegion |
| 164 | { |
| 165 | public: |
| 166 | /** Constructor |
| 167 | * |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 168 | * @param[in] flags Memory flags |
| 169 | * @param[in] size Region size |
| 170 | * @param[in] alignment Alignment |
| 171 | */ |
Georgios Pinitas | 2cd5b31 | 2021-05-04 21:39:57 +0100 | [diff] [blame] | 172 | CLFineSVMMemoryRegion(cl_mem_flags flags, size_t size, size_t alignment); |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 173 | |
| 174 | // Inherited methods overridden : |
Georgios Pinitas | df31036 | 2018-11-14 13:16:56 +0000 | [diff] [blame] | 175 | void *map(cl::CommandQueue &q, bool blocking) final; |
Felix Thomasmathibalan | afd38f0 | 2023-09-27 17:46:17 +0100 | [diff] [blame] | 176 | void unmap(cl::CommandQueue &q) final; |
Georgios Pinitas | 99d4095 | 2018-04-23 16:26:46 +0100 | [diff] [blame] | 177 | }; |
| 178 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 179 | #endif /* ARM_COMPUTE_RUNTIME_CL_CL_MEMORY_REGION_H */ |