xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/runtime/PoolManager.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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  */
24 #ifndef ARM_COMPUTE_POOLMANAGER_H
25 #define ARM_COMPUTE_POOLMANAGER_H
26 
27 #include "arm_compute/runtime/IPoolManager.h"
28 
29 #include "arm_compute/core/Error.h"
30 #include "arm_compute/runtime/IMemoryPool.h"
31 #include "support/Mutex.h"
32 #include "support/Semaphore.h"
33 
34 #include <cstddef>
35 #include <list>
36 #include <memory>
37 
38 namespace arm_compute
39 {
40 /** Memory pool manager */
41 class PoolManager : public IPoolManager
42 {
43 public:
44     /** Default Constructor */
45     PoolManager();
46     /** Prevent instances of this class to be copy constructed */
47     PoolManager(const PoolManager &) = delete;
48     /** Prevent instances of this class to be copied */
49     PoolManager &operator=(const PoolManager &) = delete;
50     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
51     PoolManager(PoolManager &&) = delete;
52     /** Prevent instances of this class from being moved (As this class contains non movable objects) */
53     PoolManager &operator=(PoolManager &&) = delete;
54 
55     // Inherited methods overridden:
56     IMemoryPool *lock_pool() override;
57     void unlock_pool(IMemoryPool *pool) override;
58     void register_pool(std::unique_ptr<IMemoryPool> pool) override;
59     std::unique_ptr<IMemoryPool> release_pool() override;
60     void                         clear_pools() override;
61     size_t                       num_pools() const override;
62 
63 private:
64     std::list<std::unique_ptr<IMemoryPool>> _free_pools;     /**< List of free pools */
65     std::list<std::unique_ptr<IMemoryPool>> _occupied_pools; /**< List of occupied pools */
66     std::unique_ptr<arm_compute::Semaphore> _sem;            /**< Semaphore to control the queues */
67     mutable arm_compute::Mutex              _mtx;            /**< Mutex to control access to the queues */
68 };
69 } // arm_compute
70 #endif /*ARM_COMPUTE_POOLMANAGER_H */
71