Compute Library
 21.05
ILifetimeManager.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-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_ILIFETIMEMANAGER_H
25 #define ARM_COMPUTE_ILIFETIMEMANAGER_H
26 
29 
30 #include <cstddef>
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 // Forward declarations
36 class IAllocator;
37 class IMemory;
38 class IMemoryGroup;
39 
40 /** Interface for managing the lifetime of objects */
42 {
43 public:
44  /** Virtual Destructor */
45  virtual ~ILifetimeManager() = default;
46  /** Registers a group to the lifetime manager and assigns a group id
47  *
48  * @param[in] group The group id of the group
49  */
50  virtual void register_group(IMemoryGroup *group) = 0;
51  /** Unbound and release elements associated with a group
52  *
53  * @param[in] group Group to unbound its elements
54  *
55  * @return True if group was registered and released else false.
56  */
57  virtual bool release_group(IMemoryGroup *group) = 0;
58  /** Registers and starts lifetime of an object
59  *
60  * @param[in] obj Object to register
61  */
62  virtual void start_lifetime(void *obj) = 0;
63  /** Ends lifetime of an object
64  *
65  * @param[in] obj Object
66  * @param[in] obj_memory Object memory
67  * @param[in] size Size of the given object at given time
68  * @param[in] alignment Alignment requirements for the object
69  */
70  virtual void end_lifetime(void *obj, IMemory &obj_memory, size_t size, size_t alignment) = 0;
71  /** Checks if the lifetime of the registered object is complete
72  *
73  * @return True if all object lifetimes are finalized else false.
74  */
75  virtual bool are_all_finalized() const = 0;
76  /** Creates a memory pool depending on the memory requirements
77  *
78  * @param allocator Allocator to use
79  *
80  * @return A memory pool
81  */
82  virtual std::unique_ptr<IMemoryPool> create_pool(IAllocator *allocator) = 0;
83  /** Returns the type of mappings that the lifetime manager returns
84  *
85  * @return Mapping type of the lifetime manager
86  */
87  virtual MappingType mapping_type() const = 0;
88 };
89 } // namespace arm_compute
90 #endif /* ARM_COMPUTE_ILIFETIMEMANAGER_H */
Memory group interface.
Definition: IMemoryGroup.h:37
Memory interface.
Definition: IMemory.h:32
virtual bool are_all_finalized() const =0
Checks if the lifetime of the registered object is complete.
virtual void start_lifetime(void *obj)=0
Registers and starts lifetime of an object.
Copyright (c) 2017-2021 Arm Limited.
Interface for managing the lifetime of objects.
virtual MappingType mapping_type() const =0
Returns the type of mappings that the lifetime manager returns.
virtual std::unique_ptr< IMemoryPool > create_pool(IAllocator *allocator)=0
Creates a memory pool depending on the memory requirements.
MappingType
Mapping type.
Definition: Types.h:34
virtual void end_lifetime(void *obj, IMemory &obj_memory, size_t size, size_t alignment)=0
Ends lifetime of an object.
virtual void register_group(IMemoryGroup *group)=0
Registers a group to the lifetime manager and assigns a group id.
input allocator() -> allocate()
virtual ~ILifetimeManager()=default
Virtual Destructor.
Allocator interface.
Definition: IAllocator.h:35
virtual bool release_group(IMemoryGroup *group)=0
Unbound and release elements associated with a group.