Compute Library
 21.05
IPoolManager.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_IPOOLMANAGER_H
25 #define ARM_COMPUTE_IPOOLMANAGER_H
26 
27 #include <memory>
28 
29 namespace arm_compute
30 {
31 class IMemoryPool;
32 
33 /** Memory pool manager interface */
35 {
36 public:
37  /** Default virtual destructor */
38  virtual ~IPoolManager() = default;
39  /** Locks a pool for execution
40  *
41  * @return Locked pool that workload will be mapped on
42  */
43  virtual IMemoryPool *lock_pool() = 0;
44  /** Releases memory pool
45  *
46  * @param[in] pool Memory pool to release
47  */
48  virtual void unlock_pool(IMemoryPool *pool) = 0;
49  /** Register pool to be managed by the pool
50  *
51  * @note Ownership of the pools is being transferred to the pool manager
52  *
53  * @param[in] pool Pool to be managed
54  */
55  virtual void register_pool(std::unique_ptr<IMemoryPool> pool) = 0;
56  /** Releases a free pool from the managed pools
57  *
58  * @return The released pool in case a free pool existed else nullptr
59  */
60  virtual std::unique_ptr<IMemoryPool> release_pool() = 0;
61  /** Clears all pools managed by the pool manager
62  *
63  * @pre All pools must be unoccupied
64  */
65  virtual void clear_pools() = 0;
66  /** Returns the total number of pools managed by the pool manager
67  *
68  * @return Number of managed pools
69  */
70  virtual size_t num_pools() const = 0;
71 };
72 } // arm_compute
73 #endif /*ARM_COMPUTE_IPOOLMANAGER_H */
virtual IMemoryPool * lock_pool()=0
Locks a pool for execution.
Memory pool manager interface.
Definition: IPoolManager.h:34
Memory Pool Inteface.
Definition: IMemoryPool.h:37
Copyright (c) 2017-2021 Arm Limited.
virtual void unlock_pool(IMemoryPool *pool)=0
Releases memory pool.
virtual std::unique_ptr< IMemoryPool > release_pool()=0
Releases a free pool from the managed pools.
virtual void register_pool(std::unique_ptr< IMemoryPool > pool)=0
Register pool to be managed by the pool.
virtual void clear_pools()=0
Clears all pools managed by the pool manager.
virtual ~IPoolManager()=default
Default virtual destructor.
virtual size_t num_pools() const =0
Returns the total number of pools managed by the pool manager.