Compute Library
 21.05
IMemoryManager.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_IMEMORYMANAGER_H
25 #define ARM_COMPUTE_IMEMORYMANAGER_H
26 
29 
30 #include <cstddef>
31 
32 namespace arm_compute
33 {
34 // Forward declarations
35 class IAllocator;
36 class IMemoryGroup;
37 
38 /** Memory manager interface to handle allocations of backing memory */
40 {
41 public:
42  /** Default virtual destructor */
43  virtual ~IMemoryManager() = default;
44  /** Returns the lifetime manager used by the memory manager
45  *
46  * @return The lifetime manager
47  */
48  virtual ILifetimeManager *lifetime_manager() = 0;
49  /** Returns the pool manager used by the memory manager
50  *
51  * @return The pool manager
52  */
53  virtual IPoolManager *pool_manager() = 0;
54  /** Populates the pool manager with the given number of pools
55  *
56  * @pre Pool manager must be empty
57  *
58  * @param[in] allocator Allocator to use for the backing allocations
59  * @param[in] num_pools Number of pools to create
60  */
61  virtual void populate(IAllocator &allocator, size_t num_pools) = 0;
62  /** Clears the pool manager
63  *
64  * @pre All pools must be unoccupied
65  */
66  virtual void clear() = 0;
67 };
68 } // arm_compute
69 #endif /*ARM_COMPUTE_IMEMORYMANAGER_H */
Memory pool manager interface.
Definition: IPoolManager.h:34
Memory manager interface to handle allocations of backing memory.
virtual ILifetimeManager * lifetime_manager()=0
Returns the lifetime manager used by the memory manager.
Copyright (c) 2017-2021 Arm Limited.
Interface for managing the lifetime of objects.
virtual void clear()=0
Clears the pool manager.
virtual IPoolManager * pool_manager()=0
Returns the pool manager used by the memory manager.
virtual void populate(IAllocator &allocator, size_t num_pools)=0
Populates the pool manager with the given number of pools.
input allocator() -> allocate()
virtual ~IMemoryManager()=default
Default virtual destructor.
Allocator interface.
Definition: IAllocator.h:35