Cpu.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/Cpu.hpp
// \brief common function definitions for Os::Cpu
// ======================================================================
#include "Os/Os.hpp"

#ifndef OS_CPU_HPP_
#define OS_CPU_HPP_

namespace Os {

class CpuHandle {};

class CpuInterface {
  public:
    using Status = Os::Generic::Status;
    using Ticks = Os::Generic::UsedTotal;

    CpuInterface() = default;
    virtual ~CpuInterface() = default;

    CpuInterface(const CpuInterface& other) = delete;

    virtual CpuInterface& operator=(const CpuInterface& other) = delete;

    virtual Status _getCount(FwSizeType & cpu_count) = 0;

    virtual Status _getTicks(Ticks& ticks, FwSizeType cpu_index) = 0;

    virtual CpuHandle* getHandle() = 0;

    static CpuInterface* getDelegate(CpuHandleStorage& aligned_new_memory);
};

class Cpu final : public CpuInterface {
  public:
    Cpu();

    ~Cpu() final;

    Cpu(const CpuInterface& other) = delete;

    Cpu(const CpuInterface* other) = delete;

    CpuInterface& operator=(const CpuInterface& other) override = delete;

    //-----------------------------------------------------------------------------
    // Interface methods
    //-----------------------------------------------------------------------------

    static void init();

    static Cpu& getSingleton();

    //-----------------------------------------------------------------------------
    // Delegating methods
    //-----------------------------------------------------------------------------

    Status _getCount(FwSizeType& cpu_count) override;

    Status _getTicks(Ticks& ticks, FwSizeType cpu_index) override;

    CpuHandle* getHandle() override;

    //-----------------------------------------------------------------------------
    // Static interface (singleton) methods
    //-----------------------------------------------------------------------------

    static  Status getCount(FwSizeType& cpu_count);

    static Status getTicks(Ticks& ticks, FwSizeType cpu_index);

  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) CpuHandleStorage m_handle_storage; 
    CpuInterface& m_delegate;                                       
};
}
#endif //OS_CONDITION_HPP_