Memory.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/Memory.hpp
// \brief common function definitions for Os::Memory
// ======================================================================
#include "Os/Os.hpp"
 
#ifndef OS_MEMORY_HPP_
#define OS_MEMORY_HPP_
 
namespace Os {
 
class MemoryHandle {};
 
class MemoryInterface {
  public:
    using Status = Os::Generic::Status;
    using Usage = Os::Generic::UsedTotal;
 
    MemoryInterface() = default;
    virtual ~MemoryInterface() = default;
 
    MemoryInterface(const MemoryInterface& other) = delete;
 
    virtual MemoryInterface& operator=(const MemoryInterface& other) = delete;
 
    virtual Status _getUsage(Usage& memory_usage) = 0;
 
    virtual MemoryHandle* getHandle() = 0;
 
    static MemoryInterface* getDelegate(MemoryHandleStorage& aligned_new_memory);
};
 
class Memory final : public MemoryInterface {
  public:
    Memory();
 
    ~Memory() final;
 
    Memory(const MemoryInterface& other) = delete;
 
    Memory(const MemoryInterface* other) = delete;
 
    MemoryInterface& operator=(const MemoryInterface& other) override = delete;
 
    //-----------------------------------------------------------------------------
    // Interface methods
    //-----------------------------------------------------------------------------
  public:
 
    static void init();
 
    static Memory& getSingleton();
 
    //-----------------------------------------------------------------------------
    // Delegating methods
    //-----------------------------------------------------------------------------
 
    Status _getUsage(Usage& memory_usage) override;
 
 
    MemoryHandle* getHandle() override;
 
    //-----------------------------------------------------------------------------
    // Static interface (singleton) methods
    //-----------------------------------------------------------------------------
 
    static Status getUsage(Usage& memory);
 
  private:
 
    // This section is used to store the implementation-defined file handle. To Os::File and fprime, this type is
    // opaque and thus normal allocation cannot be done. Instead, we allow the implementor to store then handle in
    // the byte-array here and set `handle` to that address for storage.
    alignas(FW_HANDLE_ALIGNMENT) MemoryHandleStorage m_handle_storage; 
    MemoryInterface& m_delegate;                                       
};
}
#endif //OS_CONDITION_HPP_