1 /* 2 * Copyright (c) 2018-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_RUNTIME_CL_CLMEMORY_H 25 #define ARM_COMPUTE_RUNTIME_CL_CLMEMORY_H 26 27 #include "arm_compute/runtime/IMemory.h" 28 29 #include "arm_compute/core/CL/OpenCL.h" 30 #include "arm_compute/runtime/CL/CLMemoryRegion.h" 31 32 #include <cstddef> 33 #include <memory> 34 35 namespace arm_compute 36 { 37 /** OpenCL implementation of memory object */ 38 class CLMemory : public IMemory 39 { 40 public: 41 /** Default Constructor */ 42 CLMemory(); 43 /** Default Constructor 44 * 45 * @param[in] memory Memory to be imported 46 */ 47 CLMemory(const std::shared_ptr<ICLMemoryRegion> &memory); 48 /** Default Constructor 49 * 50 * @note Ownership of the memory is not transferred to this object. 51 * Thus management (allocate/free) should be done by the client. 52 * 53 * @param[in] memory Memory to be imported 54 */ 55 CLMemory(ICLMemoryRegion *memory); 56 /** Allow instances of this class to be copied */ 57 CLMemory(const CLMemory &) = default; 58 /** Allow instances of this class to be copy assigned */ 59 CLMemory &operator=(const CLMemory &) = default; 60 /** Allow instances of this class to be moved */ 61 CLMemory(CLMemory &&) noexcept = default; 62 /** Allow instances of this class to be move assigned */ 63 CLMemory &operator=(CLMemory &&) noexcept = default; 64 /** OpenCL Region accessor 65 * 66 * @return Memory region 67 */ 68 ICLMemoryRegion *cl_region(); 69 /** OpenCL Region accessor 70 * 71 * @return Memory region 72 */ 73 ICLMemoryRegion *cl_region() const; 74 75 // Inherited methods overridden: 76 IMemoryRegion *region() final; 77 IMemoryRegion *region() const final; 78 void set_region(IMemoryRegion *region) final; 79 void set_owned_region(std::unique_ptr<IMemoryRegion> region) final; 80 81 private: 82 ICLMemoryRegion *_region; 83 std::shared_ptr<ICLMemoryRegion> _region_owned; 84 }; 85 } // namespace arm_compute 86 #endif /* ARM_COMPUTE_RUNTIME_CL_CLMEMORY_H */ 87