BufferManagerComponentAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  BufferManagerComponentAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for BufferManager component base class
// ======================================================================

#ifndef Svc_BufferManagerComponentAc_HPP
#define Svc_BufferManagerComponentAc_HPP

#include <atomic>

#include "Fw/Buffer/BufferGetPortAc.hpp"
#include "Fw/Buffer/BufferSendPortAc.hpp"
#include "Fw/Comp/ActiveComponentBase.hpp"
#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Log/LogPortAc.hpp"
#include "Fw/Log/LogString.hpp"
#if FW_ENABLE_TEXT_LOGGING == 1
#include "Fw/Log/LogTextPortAc.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/InputSerializePort.hpp"
#endif
#if !FW_DIRECT_PORT_CALLS
#include "Fw/Port/OutputSerializePort.hpp"
#endif
#include "Fw/Time/TimePortAc.hpp"
#include "Fw/Tlm/TlmPortAc.hpp"
#include "Fw/Tlm/TlmString.hpp"
#include "Os/Mutex.hpp"
#include "Svc/Sched/SchedPortAc.hpp"
#include "default/config/FwSizeTypeAliasAc.hpp"

namespace Svc {

  class BufferManagerComponentBase :
    public Fw::PassiveComponentBase
  {

      // ----------------------------------------------------------------------
      // Friend classes
      // ----------------------------------------------------------------------

      friend class BufferManagerTesterBase;
      friend class BufferManagerTester;

    protected:

      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------

      enum {
        NUM_BUFFERGETCALLEE_INPUT_PORTS = 1,
        NUM_BUFFERSENDIN_INPUT_PORTS = 1,
        NUM_SCHEDIN_INPUT_PORTS = 1,
      };

      enum {
        NUM_EVENTOUT_OUTPUT_PORTS = 1,
        NUM_TEXTEVENTOUT_OUTPUT_PORTS = 1,
        NUM_TIMECALLER_OUTPUT_PORTS = 1,
        NUM_TLMOUT_OUTPUT_PORTS = 1,
      };

      enum {
        EVENTID_NOBUFFSAVAILABLE = 0x0, 
        EVENTID_NULLEMPTYBUFFER = 0x1, 
      };

      enum {
        EVENTID_NOBUFFSAVAILABLE_THROTTLE = 10, 
        EVENTID_NULLEMPTYBUFFER_THROTTLE = 10, 
      };

      enum {
        CHANNELID_TOTALBUFFS = 0x0, 
        CHANNELID_CURRBUFFS = 0x1, 
        CHANNELID_HIBUFFS = 0x2, 
        CHANNELID_NOBUFFS = 0x3, 
        CHANNELID_EMPTYBUFFS = 0x4, 
      };

    public:

      // ----------------------------------------------------------------------
      // Component initialization
      // ----------------------------------------------------------------------

      void init(
          FwEnumStoreType instance = 0 
      );

#if !FW_DIRECT_PORT_CALLS

    public:

      // ----------------------------------------------------------------------
      // Getters for typed input ports
      // ----------------------------------------------------------------------

      Fw::InputBufferGetPort* get_bufferGetCallee_InputPort(
          FwIndexType portNum 
      );

      Fw::InputBufferSendPort* get_bufferSendIn_InputPort(
          FwIndexType portNum 
      );

      Svc::InputSchedPort* get_schedIn_InputPort(
          FwIndexType portNum 
      );

#endif

#if !FW_DIRECT_PORT_CALLS

    public:

      // ----------------------------------------------------------------------
      // Connect input ports to special output ports
      // ----------------------------------------------------------------------

      void set_eventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogPort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_textEventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputLogTextPort* port 
      );

#endif

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputTimePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputTlmPort* port 
      );

#endif

#if !FW_DIRECT_PORT_CALLS && FW_PORT_SERIALIZATION

    public:

      // ----------------------------------------------------------------------
      // Connect serial input ports to special output ports
      // ----------------------------------------------------------------------

      void set_eventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#if FW_ENABLE_TEXT_LOGGING == 1

      void set_textEventOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

      void set_timeCaller_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

      void set_tlmOut_OutputPort(
          FwIndexType portNum, 
          Fw::InputSerializePort* port 
      );

#endif

    protected:

      // ----------------------------------------------------------------------
      // Component construction and destruction
      // ----------------------------------------------------------------------

      BufferManagerComponentBase(
          const char* compName = "" 
      );

      virtual ~BufferManagerComponentBase();

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of typed input ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_bufferGetCallee_InputPorts() {
        return NUM_BUFFERGETCALLEE_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_bufferSendIn_InputPorts() {
        return NUM_BUFFERSENDIN_INPUT_PORTS;
      }

      static constexpr FwIndexType getNum_schedIn_InputPorts() {
        return NUM_SCHEDIN_INPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Getters for numbers of special output ports
      // ----------------------------------------------------------------------

      static constexpr FwIndexType getNum_eventOut_OutputPorts() {
        return NUM_EVENTOUT_OUTPUT_PORTS;
      }

#if FW_ENABLE_TEXT_LOGGING == 1

      static constexpr FwIndexType getNum_textEventOut_OutputPorts() {
        return NUM_TEXTEVENTOUT_OUTPUT_PORTS;
      }

#endif

      static constexpr FwIndexType getNum_timeCaller_OutputPorts() {
        return NUM_TIMECALLER_OUTPUT_PORTS;
      }

      static constexpr FwIndexType getNum_tlmOut_OutputPorts() {
        return NUM_TLMOUT_OUTPUT_PORTS;
      }

    protected:

      // ----------------------------------------------------------------------
      // Connection status queries for special output ports
      // ----------------------------------------------------------------------

      bool isConnected_eventOut_OutputPort(
          FwIndexType portNum 
      ) const;

#if FW_ENABLE_TEXT_LOGGING == 1

      bool isConnected_textEventOut_OutputPort(
          FwIndexType portNum 
      ) const;

#endif

      bool isConnected_timeCaller_OutputPort(
          FwIndexType portNum 
      ) const;

      bool isConnected_tlmOut_OutputPort(
          FwIndexType portNum 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Handlers to implement for typed input ports
      // ----------------------------------------------------------------------

      virtual Fw::Buffer bufferGetCallee_handler(
          FwIndexType portNum, 
          FwSizeType size 
      ) = 0;

      virtual void bufferSendIn_handler(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      ) = 0;

      virtual void schedIn_handler(
          FwIndexType portNum, 
          U32 context 
      ) = 0;

#if FW_DIRECT_PORT_CALLS
    public:
#else
    protected:
#endif

      // ----------------------------------------------------------------------
      // Port handler base-class functions for typed input ports
      //
      // Call these functions directly to bypass the corresponding ports
      // ----------------------------------------------------------------------

      Fw::Buffer bufferGetCallee_handlerBase(
          FwIndexType portNum, 
          FwSizeType size 
      );

      void bufferSendIn_handlerBase(
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      void schedIn_handlerBase(
          FwIndexType portNum, 
          U32 context 
      );

    protected:

      // ----------------------------------------------------------------------
      // Event logging functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_NoBuffsAvailable(
          FwSizeType size 
      );

      void log_WARNING_HI_NullEmptyBuffer();

    protected:

      // ----------------------------------------------------------------------
      // Event throttle reset functions
      // ----------------------------------------------------------------------

      void log_WARNING_HI_NoBuffsAvailable_ThrottleClear();

      void log_WARNING_HI_NullEmptyBuffer_ThrottleClear();

    protected:

      // ----------------------------------------------------------------------
      // Telemetry serialized write
      // ----------------------------------------------------------------------

      void tlmWrite(
          FwChanIdType id, 
          Fw::TlmBuffer& _tlmBuff, 
          Fw::Time _tlmTime = Fw::Time() 
      ) const;

    protected:

      // ----------------------------------------------------------------------
      // Telemetry write functions
      // ----------------------------------------------------------------------

      void tlmWrite_TotalBuffs(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

      void tlmWrite_CurrBuffs(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

      void tlmWrite_HiBuffs(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

      void tlmWrite_NoBuffs(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

      void tlmWrite_EmptyBuffs(
          U32 arg, 
          Fw::Time _tlmTime = Fw::Time() 
      );

    protected:

      // ----------------------------------------------------------------------
      // Time
      // ----------------------------------------------------------------------

      Fw::Time getTime() const;

    protected:

      // ----------------------------------------------------------------------
      // Mutex operations for guarded ports
      //
      // You can override these operations to provide more sophisticated
      // synchronization
      // ----------------------------------------------------------------------

      virtual void lock();

      virtual void unLock();

    private:

      // ----------------------------------------------------------------------
      // Calls for messages received on typed input ports
      // ----------------------------------------------------------------------

      static Fw::Buffer m_p_bufferGetCallee_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          FwSizeType size 
      );

      static void m_p_bufferSendIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          Fw::Buffer& fwBuffer 
      );

      static void m_p_schedIn_in(
          Fw::PassiveComponentBase* callComp, 
          FwIndexType portNum, 
          U32 context 
      );

    private:

      // ----------------------------------------------------------------------
      // Invocation functions for special output ports
      // ----------------------------------------------------------------------

      void eventOut_out(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::LogBuffer& args 
      ) const;

#if FW_ENABLE_TEXT_LOGGING

      void textEventOut_out(
          FwIndexType portNum, 
          FwEventIdType id, 
          Fw::Time& timeTag, 
          const Fw::LogSeverity& severity, 
          Fw::TextLogString& text 
      ) const;

#endif

      void timeCaller_out(
          FwIndexType portNum, 
          Fw::Time& time 
      ) const;

      void tlmOut_out(
          FwIndexType portNum, 
          FwChanIdType id, 
          Fw::Time& timeTag, 
          Fw::TlmBuffer& val 
      ) const;

#if !FW_DIRECT_PORT_CALLS

    private:

      // ----------------------------------------------------------------------
      // Typed input ports
      // ----------------------------------------------------------------------

      Fw::InputBufferGetPort m_bufferGetCallee_InputPort[NUM_BUFFERGETCALLEE_INPUT_PORTS];

      Fw::InputBufferSendPort m_bufferSendIn_InputPort[NUM_BUFFERSENDIN_INPUT_PORTS];

      Svc::InputSchedPort m_schedIn_InputPort[NUM_SCHEDIN_INPUT_PORTS];

#endif

#if !FW_DIRECT_PORT_CALLS

    private:

      // ----------------------------------------------------------------------
      // Special output ports
      // ----------------------------------------------------------------------

      Fw::OutputLogPort m_eventOut_OutputPort[NUM_EVENTOUT_OUTPUT_PORTS];

#if FW_ENABLE_TEXT_LOGGING == 1

      Fw::OutputLogTextPort m_textEventOut_OutputPort[NUM_TEXTEVENTOUT_OUTPUT_PORTS];

#endif

      Fw::OutputTimePort m_timeCaller_OutputPort[NUM_TIMECALLER_OUTPUT_PORTS];

      Fw::OutputTlmPort m_tlmOut_OutputPort[NUM_TLMOUT_OUTPUT_PORTS];

#endif

    private:

      // ----------------------------------------------------------------------
      // Counter values for event throttling
      // ----------------------------------------------------------------------

      std::atomic<FwIndexType> m_NoBuffsAvailableThrottle;

      std::atomic<FwIndexType> m_NullEmptyBufferThrottle;

    private:

      // ----------------------------------------------------------------------
      // First update flags for telemetry channels
      // ----------------------------------------------------------------------

      bool m_first_update_TotalBuffs = true;

      bool m_first_update_CurrBuffs = true;

      bool m_first_update_HiBuffs = true;

      bool m_first_update_NoBuffs = true;

      bool m_first_update_EmptyBuffs = true;

    private:

      // ----------------------------------------------------------------------
      // Last value storage for telemetry channels
      // ----------------------------------------------------------------------

      U32 m_last_TotalBuffs = {};

      U32 m_last_CurrBuffs = {};

      U32 m_last_HiBuffs = {};

      U32 m_last_NoBuffs = {};

      U32 m_last_EmptyBuffs = {};

    private:

      // ----------------------------------------------------------------------
      // Mutexes
      // ----------------------------------------------------------------------

      Os::Mutex m_guardedPortMutex;

  };

}

#endif