PoolManager Class Reference

Memory pool manager. More...

#include <PoolManager.h>

Collaboration diagram for PoolManager:

Public Member Functions
	PoolManager ()
	Default Constructor. More...
	PoolManager (const PoolManager &)=delete
	Prevent instances of this class to be copy constructed. More...
PoolManager &	operator= (const PoolManager &)=delete
	Prevent instances of this class to be copied. More...
	PoolManager (PoolManager &&)=delete
	Prevent instances of this class from being moved (As this class contains non movable objects) More...
PoolManager &	operator= (PoolManager &&)=delete
	Prevent instances of this class from being moved (As this class contains non movable objects) More...
IMemoryPool *	lock_pool () override
	Locks a pool for execution. More...
void	unlock_pool (IMemoryPool *pool) override
	Releases memory pool. More...
void	register_pool (std::unique_ptr< IMemoryPool > pool) override
	Register pool to be managed by the pool. More...
std::unique_ptr< IMemoryPool >	release_pool () override
	Releases a free pool from the managed pools. More...
void	clear_pools () override
	Clears all pools managed by the pool manager. More...
size_t	num_pools () const override
	Returns the total number of pools managed by the pool manager. More...
Public Member Functions inherited from IPoolManager
virtual	~IPoolManager ()=default
	Default virtual destructor. More...

Detailed Description

Memory pool manager.

Definition at line 41 of file PoolManager.h.

Constructor & Destructor Documentation

PoolManager() [1/3]

PoolManager

(

)

Default Constructor.

Definition at line 34 of file PoolManager.cpp.

    : _free_pools(), _occupied_pools(), _sem(), _mtx()
{
}

PoolManager() [2/3]

PoolManager ( const PoolManager &  )

delete

Prevent instances of this class to be copy constructed.

PoolManager() [3/3]

PoolManager ( PoolManager &&  )

delete

Prevent instances of this class from being moved (As this class contains non movable objects)

Member Function Documentation

clear_pools()

void clear_pools ( )

overridevirtual

Clears all pools managed by the pool manager.

Precondition

All pools must be unoccupied

Implements IPoolManager.

Definition at line 96 of file PoolManager.cpp.

{
    arm_compute::lock_guard<arm_compute::Mutex> lock(_mtx);
    ARM_COMPUTE_ERROR_ON_MSG(!_occupied_pools.empty(), "All pools should be free in order to clear the PoolManager!");
    _free_pools.clear();
 
    // Update semaphore
    _sem = nullptr;
}

References ARM_COMPUTE_ERROR_ON_MSG.

lock_pool()

IMemoryPool * lock_pool ( )

overridevirtual

Locks a pool for execution.

Returns

Locked pool that workload will be mapped on

Implements IPoolManager.

Definition at line 39 of file PoolManager.cpp.

{
    ARM_COMPUTE_ERROR_ON_MSG(_free_pools.empty() && _occupied_pools.empty(), "Haven't setup any pools!");
 
    _sem->wait();
    arm_compute::lock_guard<arm_compute::Mutex> lock(_mtx);
    ARM_COMPUTE_ERROR_ON_MSG(_free_pools.empty(), "Empty pool must exist as semaphore has been signalled");
    _occupied_pools.splice(std::begin(_occupied_pools), _free_pools, std::begin(_free_pools));
    return _occupied_pools.front().get();
}

References ARM_COMPUTE_ERROR_ON_MSG.

num_pools()

size_t num_pools ( ) const

overridevirtual

Returns the total number of pools managed by the pool manager.

Returns

Number of managed pools

Implements IPoolManager.

Definition at line 106 of file PoolManager.cpp.

{
    arm_compute::lock_guard<arm_compute::Mutex> lock(_mtx);
 
    return _free_pools.size() + _occupied_pools.size();
}

operator=() [1/2]

PoolManager& operator= ( const PoolManager &  )

delete

Prevent instances of this class to be copied.

operator=() [2/2]

PoolManager& operator= ( PoolManager &&  )

delete

Prevent instances of this class from being moved (As this class contains non movable objects)

register_pool()

void register_pool ( std::unique_ptr< IMemoryPool >  pool )

overridevirtual

Register pool to be managed by the pool.

Note

Ownership of the pools is being transferred to the pool manager

Parameters

[in]

pool

Pool to be managed

Implements IPoolManager.

Definition at line 64 of file PoolManager.cpp.

{
    arm_compute::lock_guard<arm_compute::Mutex> lock(_mtx);
    ARM_COMPUTE_ERROR_ON_MSG(!_occupied_pools.empty(), "All pools should be free in order to register a new one!");
 
    // Set pool
    _free_pools.push_front(std::move(pool));
 
    // Update semaphore
    _sem = std::make_unique<arm_compute::Semaphore>(_free_pools.size());
}

References ARM_COMPUTE_ERROR_ON_MSG.

release_pool()

std::unique_ptr< IMemoryPool > release_pool ( )

overridevirtual

Releases a free pool from the managed pools.

Returns

The released pool in case a free pool existed else nullptr

Implements IPoolManager.

Definition at line 76 of file PoolManager.cpp.

{
    arm_compute::lock_guard<arm_compute::Mutex> lock(_mtx);
    ARM_COMPUTE_ERROR_ON_MSG(!_occupied_pools.empty(), "All pools should be free in order to release one!");
 
    if(!_free_pools.empty())
    {
        std::unique_ptr<IMemoryPool> pool = std::move(_free_pools.front());
        ARM_COMPUTE_ERROR_ON(_free_pools.front() != nullptr);
        _free_pools.pop_front();
 
        // Update semaphore
        _sem = std::make_unique<arm_compute::Semaphore>(_free_pools.size());
 
        return pool;
    }
 
    return nullptr;
}

References ARM_COMPUTE_ERROR_ON, and ARM_COMPUTE_ERROR_ON_MSG.

unlock_pool()

void unlock_pool ( IMemoryPool *  pool )

overridevirtual

Releases memory pool.

Parameters

[in]

pool

Memory pool to release

Implements IPoolManager.

Definition at line 50 of file PoolManager.cpp.

{
    ARM_COMPUTE_ERROR_ON_MSG(_free_pools.empty() && _occupied_pools.empty(), "Haven't setup any pools!");
 
    arm_compute::lock_guard<arm_compute::Mutex> lock(_mtx);
    auto it = std::find_if(std::begin(_occupied_pools), std::end(_occupied_pools), [pool](const std::unique_ptr<IMemoryPool> &pool_it)
    {
        return pool_it.get() == pool;
    });
    ARM_COMPUTE_ERROR_ON_MSG(it == std::end(_occupied_pools), "Pool to be unlocked couldn't be found!");
    _free_pools.splice(std::begin(_free_pools), _occupied_pools, it);
    _sem->signal();
}

References ARM_COMPUTE_ERROR_ON_MSG, and arm_compute::mlgo::parser::end().

---

The documentation for this class was generated from the following files:

• arm_compute/runtime/PoolManager.h
• src/runtime/PoolManager.cpp