MemAllocator.hpp

Go to the documentation of this file.

#ifndef TYPES_MEMALLOCATOR_HPP_
#define TYPES_MEMALLOCATOR_HPP_

#include <Fw/FPrimeBasicTypes.hpp>
#include <config/MemoryAllocatorTypeEnumAc.hpp>
#include <cstddef>

namespace Fw {

class MemAllocator {
  public:
    virtual void* allocate(const FwEnumStoreType identifier,
                           FwSizeType& size,
                           bool& recoverable,
                           FwSizeType alignment = alignof(std::max_align_t)) = 0;

    virtual void deallocate(const FwEnumStoreType identifier, void* ptr) = 0;

    void* allocate(const FwEnumStoreType identifier,
                   FwSizeType& size,
                   FwSizeType alignment = alignof(std::max_align_t));

    void* checkedAllocate(const FwEnumStoreType identifier,
                          FwSizeType& size,
                          bool& recoverable,
                          FwSizeType alignment = alignof(std::max_align_t));

    void* checkedAllocate(const FwEnumStoreType identifier,
                          FwSizeType& size,
                          FwSizeType alignment = alignof(std::max_align_t));

  protected:
    MemAllocator();
    virtual ~MemAllocator();

  private:
    MemAllocator(MemAllocator&);  
    MemAllocator(MemAllocator*);  
};

class MemAllocatorRegistry {
  public:
    // Constructor which will register itself as the singleton
    MemAllocatorRegistry();
    ~MemAllocatorRegistry() = default;

    static MemAllocatorRegistry& getInstance();

    void registerAllocator(const MemoryAllocation::MemoryAllocatorType type, MemAllocator& allocator);

    MemAllocator& getAllocator(const MemoryAllocation::MemoryAllocatorType type);

    MemAllocator& getAnAllocator(const MemoryAllocation::MemoryAllocatorType type);

  private:
    MemAllocator* m_allocators[MemoryAllocation::MemoryAllocatorType::NUM_CONSTANTS] = {nullptr};

    static MemAllocatorRegistry* s_registry;  
};
} /* namespace Fw */

#endif /* TYPES_MEMALLOCATOR_HPP_ */