Compute Library
 21.02
PoolManager.cpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2020 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  */
25 
26 #include "arm_compute/core/Error.h"
28 
29 #include <algorithm>
30 #include <list>
31 
32 using namespace arm_compute;
33 
35  : _free_pools(), _occupied_pools(), _sem(), _mtx()
36 {
37 }
38 
40 {
41  ARM_COMPUTE_ERROR_ON_MSG(_free_pools.empty() && _occupied_pools.empty(), "Haven't setup any pools!");
42 
43  _sem->wait();
45  ARM_COMPUTE_ERROR_ON_MSG(_free_pools.empty(), "Empty pool must exist as semaphore has been signalled");
46  _occupied_pools.splice(std::begin(_occupied_pools), _free_pools, std::begin(_free_pools));
47  return _occupied_pools.front().get();
48 }
49 
51 {
52  ARM_COMPUTE_ERROR_ON_MSG(_free_pools.empty() && _occupied_pools.empty(), "Haven't setup any pools!");
53 
55  auto it = std::find_if(std::begin(_occupied_pools), std::end(_occupied_pools), [pool](const std::unique_ptr<IMemoryPool> &pool_it)
56  {
57  return pool_it.get() == pool;
58  });
59  ARM_COMPUTE_ERROR_ON_MSG(it == std::end(_occupied_pools), "Pool to be unlocked couldn't be found!");
60  _free_pools.splice(std::begin(_free_pools), _occupied_pools, it);
61  _sem->signal();
62 }
63 
64 void PoolManager::register_pool(std::unique_ptr<IMemoryPool> pool)
65 {
67  ARM_COMPUTE_ERROR_ON_MSG(!_occupied_pools.empty(), "All pools should be free in order to register a new one!");
68 
69  // Set pool
70  _free_pools.push_front(std::move(pool));
71 
72  // Update semaphore
73  _sem = std::make_unique<arm_compute::Semaphore>(_free_pools.size());
74 }
75 
76 std::unique_ptr<IMemoryPool> PoolManager::release_pool()
77 {
79  ARM_COMPUTE_ERROR_ON_MSG(!_occupied_pools.empty(), "All pools should be free in order to release one!");
80 
81  if(!_free_pools.empty())
82  {
83  std::unique_ptr<IMemoryPool> pool = std::move(_free_pools.front());
84  ARM_COMPUTE_ERROR_ON(_free_pools.front() != nullptr);
85  _free_pools.pop_front();
86 
87  // Update semaphore
88  _sem = std::make_unique<arm_compute::Semaphore>(_free_pools.size());
89 
90  return pool;
91  }
92 
93  return nullptr;
94 }
95 
97 {
99  ARM_COMPUTE_ERROR_ON_MSG(!_occupied_pools.empty(), "All pools should be free in order to clear the PoolManager!");
100  _free_pools.clear();
101 
102  // Update semaphore
103  _sem = nullptr;
104 }
105 
107 {
109 
110  return _free_pools.size() + _occupied_pools.size();
111 }
std::unique_ptr< IMemoryPool > release_pool() override
Releases a free pool from the managed pools.
Definition: PoolManager.cpp:76
#define ARM_COMPUTE_ERROR_ON(cond)
If the condition is true then an error message is printed and an exception thrown.
Definition: Error.h:466
Memory Pool Inteface.
Definition: IMemoryPool.h:37
Copyright (c) 2017-2021 Arm Limited.
void register_pool(std::unique_ptr< IMemoryPool > pool) override
Register pool to be managed by the pool.
Definition: PoolManager.cpp:64
void clear_pools() override
Clears all pools managed by the pool manager.
Definition: PoolManager.cpp:96
#define ARM_COMPUTE_ERROR_ON_MSG(cond, msg)
Definition: Error.h:456
void end(TokenStream &in, bool &valid)
Definition: MLGOParser.cpp:290
void unlock_pool(IMemoryPool *pool) override
Releases memory pool.
Definition: PoolManager.cpp:50
PoolManager()
Default Constructor.
Definition: PoolManager.cpp:34
std::lock_guard< Mutex > lock_guard
Wrapper of lock_guard data-object.
Definition: Mutex.h:37
IMemoryPool * lock_pool() override
Locks a pool for execution.
Definition: PoolManager.cpp:39
size_t num_pools() const override
Returns the total number of pools managed by the pool manager.