Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 1 | /* |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2018 ARM Limited. |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +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_ILIFETIMEMANAGER_H__ |
| 25 | #define __ARM_COMPUTE_ILIFETIMEMANAGER_H__ |
| 26 | |
| 27 | #include "arm_compute/runtime/IMemoryPool.h" |
| 28 | #include "arm_compute/runtime/Types.h" |
| 29 | |
| 30 | #include <cstddef> |
Georgios Pinitas | 511347a | 2017-09-18 18:33:07 +0100 | [diff] [blame] | 31 | #include <memory> |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 32 | |
| 33 | namespace arm_compute |
| 34 | { |
| 35 | class IMemoryGroup; |
| 36 | class IAllocator; |
| 37 | |
| 38 | /** Interface for managing the lifetime of objects */ |
| 39 | class ILifetimeManager |
| 40 | { |
| 41 | public: |
| 42 | /** Virtual Destructor */ |
| 43 | virtual ~ILifetimeManager() = default; |
| 44 | /** Registers a group to the lifetime manager and assigns a group id |
| 45 | * |
Alex Gilday | c357c47 | 2018-03-21 13:54:09 +0000 | [diff] [blame] | 46 | * @param[in] group The group id of the group |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 47 | */ |
| 48 | virtual void register_group(IMemoryGroup *group) = 0; |
| 49 | /** Registers and starts lifetime of an object |
| 50 | * |
| 51 | * @param[in] obj Object to register |
| 52 | */ |
| 53 | virtual void start_lifetime(void *obj) = 0; |
| 54 | /** Ends lifetime of an object |
| 55 | * |
| 56 | * @param[in] obj Object |
| 57 | * @param[in] handle Memory handle of the object |
| 58 | * @param[in] size Size of the given object at given time |
| 59 | */ |
| 60 | virtual void end_lifetime(void *obj, void **handle, size_t size) = 0; |
Georgios Pinitas | 511347a | 2017-09-18 18:33:07 +0100 | [diff] [blame] | 61 | /** Checks if the lifetime of the registered object is complete |
| 62 | * |
| 63 | * @return True if all object lifetimes are finalized else false. |
| 64 | */ |
| 65 | virtual bool are_all_finalized() const = 0; |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 66 | /** Creates a memory pool depending on the memory requirements |
| 67 | * |
| 68 | * @param allocator Allocator to use |
| 69 | * |
| 70 | * @return A memory pool |
| 71 | */ |
| 72 | virtual std::unique_ptr<IMemoryPool> create_pool(IAllocator *allocator) = 0; |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 73 | /** Returns the type of mappings that the lifetime manager returns |
| 74 | * |
| 75 | * @return Mapping type of the lifetime manager |
| 76 | */ |
| 77 | virtual MappingType mapping_type() const = 0; |
| 78 | }; |
Georgios Pinitas | 511347a | 2017-09-18 18:33:07 +0100 | [diff] [blame] | 79 | } // namespace arm_compute |
Georgios Pinitas | baf174e | 2017-09-08 19:47:30 +0100 | [diff] [blame] | 80 | #endif /* __ARM_COMPUTE_ILIFETIMEMANAGER_H__ */ |