Georgios Pinitas | 84b51ad | 2017-11-07 13:24:57 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2017 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_MEMORY_H__ |
| 25 | #define __ARM_COMPUTE_MEMORY_H__ |
| 26 | |
| 27 | #include <cstddef> |
| 28 | #include <memory> |
| 29 | |
| 30 | namespace arm_compute |
| 31 | { |
| 32 | /** CPU implementation of memory object */ |
| 33 | class Memory |
| 34 | { |
| 35 | public: |
| 36 | /** Default Constructor */ |
| 37 | Memory(); |
| 38 | /** Default Constructor |
| 39 | * |
| 40 | * @note Ownership of the memory is transferred to this object |
| 41 | * |
| 42 | * @param[in] memory Memory to be imported |
| 43 | */ |
| 44 | Memory(std::shared_ptr<uint8_t> memory); |
| 45 | /** Default Constructor |
| 46 | * |
| 47 | * @note Ownership of the memory is not transferred to this object. |
| 48 | * Thus management (allocate/free) should be done by the client. |
| 49 | * |
| 50 | * @param[in] memory Memory to be imported |
| 51 | */ |
| 52 | Memory(uint8_t *memory); |
| 53 | /** Allow instances of this class to be copied */ |
| 54 | Memory(const Memory &) = default; |
| 55 | /** Allow instances of this class to be copy assigned */ |
| 56 | Memory &operator=(const Memory &) = default; |
| 57 | /** Allow instances of this class to be moved */ |
| 58 | Memory(Memory &&) noexcept = default; |
| 59 | /** Allow instances of this class to be move assigned */ |
| 60 | Memory &operator=(Memory &&) noexcept = default; |
| 61 | |
| 62 | /** Returns the pointer to the allocated data. |
| 63 | * |
| 64 | * @return Pointer to the allocated data |
| 65 | */ |
| 66 | uint8_t *buffer(); |
| 67 | /** Returns the pointer to the allocated data. |
| 68 | * |
| 69 | * @return Pointer to the allocated data |
| 70 | */ |
| 71 | uint8_t *buffer() const; |
| 72 | /** Handle of internal memory |
| 73 | * |
| 74 | * @return Handle of memory |
| 75 | */ |
| 76 | uint8_t **handle(); |
| 77 | |
| 78 | private: |
| 79 | uint8_t *_memory; |
| 80 | std::shared_ptr<uint8_t> _memory_owned; |
| 81 | }; |
| 82 | } |
| 83 | #endif /* __ARM_COMPUTE_MEMORY_H__ */ |