Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Georgios Pinitas | 4c5469b | 2019-05-21 13:32:43 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2019 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 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_ITENSORALLOCATOR_H |
| 25 | #define ARM_COMPUTE_ITENSORALLOCATOR_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/core/TensorInfo.h" |
| 28 | #include "arm_compute/core/Types.h" |
| 29 | |
| 30 | #include <cstdint> |
| 31 | |
| 32 | namespace arm_compute |
| 33 | { |
| 34 | /** Interface to allocate tensors */ |
| 35 | class ITensorAllocator |
| 36 | { |
| 37 | public: |
| 38 | /** Default constructor. */ |
| 39 | ITensorAllocator(); |
| 40 | /** Allow instances of this class to be copy constructed */ |
| 41 | ITensorAllocator(const ITensorAllocator &) = default; |
| 42 | /** Allow instances of this class to be copied */ |
| 43 | ITensorAllocator &operator=(const ITensorAllocator &) = default; |
| 44 | /** Allow instances of this class to be move constructed */ |
| 45 | ITensorAllocator(ITensorAllocator &&) = default; |
| 46 | /** Allow instances of this class to be moved */ |
| 47 | ITensorAllocator &operator=(ITensorAllocator &&) = default; |
| 48 | /** Default virtual destructor. */ |
| 49 | virtual ~ITensorAllocator() = default; |
| 50 | |
| 51 | /** Initialize a tensor based on the passed @ref TensorInfo. |
| 52 | * |
Georgios Pinitas | 17b1230 | 2018-06-18 18:13:51 +0100 | [diff] [blame] | 53 | * @param[in] input TensorInfo object containing the description of the tensor to initialize. |
| 54 | * @param[in] alignment Alignment in bytes that the underlying base pointer should comply with. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 55 | */ |
Georgios Pinitas | 17b1230 | 2018-06-18 18:13:51 +0100 | [diff] [blame] | 56 | void init(const TensorInfo &input, size_t alignment = 0); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 57 | /** Return a reference to the tensor's metadata |
| 58 | * |
| 59 | * @return Reference to the tensor's metadata. |
| 60 | */ |
| 61 | TensorInfo &info(); |
| 62 | /** Return a constant reference to the tensor's metadata |
| 63 | * |
| 64 | * @return Constant reference to the tensor's metadata. |
| 65 | */ |
| 66 | const TensorInfo &info() const; |
Georgios Pinitas | 17b1230 | 2018-06-18 18:13:51 +0100 | [diff] [blame] | 67 | /** Return underlying's tensor buffer alignment |
| 68 | * |
| 69 | * @return Tensor buffer alignment |
| 70 | */ |
| 71 | size_t alignment() const; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 72 | |
| 73 | /** Interface to be implemented by the child class to allocate the tensor. |
| 74 | * |
| 75 | * @note The child is expected to use the TensorInfo to get the size of the memory allocation. |
| 76 | * @warning The tensor must not already be allocated. Otherwise calling the function will fail. |
| 77 | */ |
| 78 | virtual void allocate() = 0; |
| 79 | |
| 80 | /** Interface to be implemented by the child class to free the allocated tensor. |
| 81 | * |
| 82 | * @warning The tensor must have been allocated previously. Otherwise calling the function will fail. |
| 83 | */ |
| 84 | virtual void free() = 0; |
| 85 | |
| 86 | protected: |
| 87 | /** Interface to be implemented by the child class to lock the memory allocation for the CPU to access. |
| 88 | * |
| 89 | * @return Pointer to a CPU mapping of the memory |
| 90 | */ |
| 91 | virtual uint8_t *lock() = 0; |
| 92 | /** Interface to be implemented by the child class to unlock the memory allocation after the CPU is done accessing it. */ |
| 93 | virtual void unlock() = 0; |
| 94 | |
| 95 | private: |
Georgios Pinitas | 17b1230 | 2018-06-18 18:13:51 +0100 | [diff] [blame] | 96 | TensorInfo _info; /**< Tensor's metadata. */ |
| 97 | size_t _alignment; /**< Tensor's alignment in bytes */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 98 | }; |
Georgios Pinitas | 4c5469b | 2019-05-21 13:32:43 +0100 | [diff] [blame] | 99 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 100 | #endif /*ARM_COMPUTE_ITENSORALLOCATOR_H */ |