#include <dynamic_memory.hpp>
Classes | |
| union | Node |
Public Member Functions | |
| void * | allocate (std::size_t size) |
| virtual void * | allocate (std::size_t size) |
| void | deallocate (const void *ptr) |
| virtual void | deallocate (const void *ptr) |
| virtual uint16_t | getBlockCapacity () const |
| uint16_t | getNumFreeBlocks () const |
| uint16_t | getNumUsedBlocks () const |
| uint16_t | getPeakNumUsedBlocks () const |
| PoolAllocator () | |
 Public Member Functions inherited from uavcan::IPoolAllocator | |
| virtual | ~IPoolAllocator () |
Static Public Attributes | |
| static const uint16_t | NumBlocks = PoolSize / BlockSize |
Private Attributes | |
| Node * | free_list_ |
| uint16_t | max_used_ |
| union { | |
| long double _aligner1 | |
| long long _aligner2 | |
| Node _aligner3 | |
| uint8_t bytes [PoolSize] | |
| } | pool_ |
| uint16_t | used_ |
Additional Inherited Members | |
| Private Member Functions inherited from uavcan::Noncopyable | |
| Noncopyable () | |
| ~Noncopyable () | |
Detailed Description
template<std::size_t PoolSize, uint8_t BlockSize, typename RaiiSynchronizer = char>
class uavcan::PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer >
Classic implementation of a pool allocator (Meyers).
The allocator can be made thread-safe (optional) by means of providing a RAII-lock type via the second template argument. The allocator uses the lock only to access the shared state, therefore critical sections are only a few cycles long, which implies that it should be acceptable to use hardware IRQ disabling instead of a mutex for performance reasons. For example, an IRQ-based RAII-lock type can be implemented as follows: struct RaiiSynchronizer { RaiiSynchronizer() { __disable_irq(); } ~RaiiSynchronizer() { __enable_irq(); } };
Definition at line 51 of file dynamic_memory.hpp.
Constructor & Destructor Documentation
◆ PoolAllocator()
| uavcan::PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer >::PoolAllocator | ( | ) |
Definition at line 142 of file dynamic_memory.hpp.
Member Function Documentation
◆ allocate() [1/2]
|
inlinevirtual |
Implements uavcan::IPoolAllocator.
Definition at line 34 of file coverity_scan_model.cpp.
◆ allocate() [2/2]
|
virtual |
Implements uavcan::IPoolAllocator.
Definition at line 160 of file dynamic_memory.hpp.
◆ deallocate() [1/2]
|
inlinevirtual |
Implements uavcan::IPoolAllocator.
Definition at line 39 of file coverity_scan_model.cpp.
◆ deallocate() [2/2]
|
virtual |
Implements uavcan::IPoolAllocator.
Definition at line 185 of file dynamic_memory.hpp.
◆ getBlockCapacity()
|
inlinevirtual |
Returns the maximum number of blocks this allocator can allocate.
Implements uavcan::IPoolAllocator.
Definition at line 80 of file dynamic_memory.hpp.
◆ getNumFreeBlocks()
|
inline |
Definition at line 91 of file dynamic_memory.hpp.
◆ getNumUsedBlocks()
|
inline |
Return the number of blocks that are currently allocated/unallocated.
Definition at line 85 of file dynamic_memory.hpp.
◆ getPeakNumUsedBlocks()
|
inline |
Returns the maximum number of blocks that were ever allocated at the same time.
Definition at line 101 of file dynamic_memory.hpp.
Member Data Documentation
◆ _aligner1
| long double uavcan::PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer >::_aligner1 |
Definition at line 64 of file dynamic_memory.hpp.
◆ _aligner2
| long long uavcan::PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer >::_aligner2 |
Definition at line 65 of file dynamic_memory.hpp.
◆ _aligner3
| Node uavcan::PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer >::_aligner3 |
Definition at line 66 of file dynamic_memory.hpp.
◆ bytes
| uint8_t uavcan::PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer >::bytes[PoolSize] |
Definition at line 63 of file dynamic_memory.hpp.
◆ free_list_
|
private |
Definition at line 60 of file dynamic_memory.hpp.
◆ max_used_
|
private |
Definition at line 70 of file dynamic_memory.hpp.
◆ NumBlocks
|
static |
Definition at line 73 of file dynamic_memory.hpp.
◆ pool_
| union { ... } uavcan::PoolAllocator< PoolSize, BlockSize, RaiiSynchronizer >::pool_ |
◆ used_
|
private |
Definition at line 69 of file dynamic_memory.hpp.
The documentation for this class was generated from the following files: