ComLoggerDp.hpp

Go to the documentation of this file.

// ======================================================================
// \title  ComLoggerDp.hpp
// \author tcanham
// \brief  hpp file for ComLoggerDp component implementation class
// ======================================================================

#ifndef Svc_ComLoggerDp_HPP
#define Svc_ComLoggerDp_HPP

#include "Fw/Dp/DpContainer.hpp"
#include "Svc/ComLoggerDp/ComLoggerDpComponentAc.hpp"
#include "config/ComLoggerDpCfg.hpp"

namespace Svc {

// Forward declaration for testing
class ComLoggerDpTester;

class ComLoggerDp final : public ComLoggerDpComponentBase {
    // Grant test access to private methods for unit testing
    friend class ComLoggerDpTester;

  public:
    // ----------------------------------------------------------------------
    // Public interface
    // ----------------------------------------------------------------------

    static constexpr FwSizeType MAX_RECORD_DATA_SIZE = FW_COM_BUFFER_MAX_SIZE + sizeof(ComLoggerDpSentry);

    static constexpr FwSizeType RECORD_SIZE = SIZE_OF_ComBufferRecord_RECORD(MAX_RECORD_DATA_SIZE);

    static constexpr FwSizeType ComLoggerDpBuffSize(FwSizeType packetsPerContainer) {
        return DpContainer::MIN_PACKET_SIZE + packetsPerContainer * RECORD_SIZE;
    }

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

    explicit ComLoggerDp(const char* const compName  
    );

    ~ComLoggerDp();

    ComLoggerDp(const ComLoggerDp&) = delete;

    ComLoggerDp& operator=(const ComLoggerDp&) = delete;

    ComLoggerDp(ComLoggerDp&&) = delete;

    ComLoggerDp& operator=(ComLoggerDp&&) = delete;

    void configure(bool enabled, FwSizeType packetsPerContainer, FwDpPriorityType priority, U32 flushTimeout);

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for typed input ports
    // ----------------------------------------------------------------------

    void comIn_handler(FwIndexType portNum,  
                       Fw::ComBuffer& data,  
                       U32 context           
                       ) override;

    void pingIn_handler(FwIndexType portNum,  
                        U32 key               
                        ) override;

    void schedIn_handler(FwIndexType portNum,  
                         U32 context           
                         ) override;

    void startRecordingIn_handler(FwIndexType portNum,             
                                  FwSizeType packetsPerContainer,  
                                  FwDpPriorityType priority        
                                  ) override;

    void stopRecordingIn_handler(FwIndexType portNum  
                                 ) override;

  private:
    // ----------------------------------------------------------------------
    // Handler implementations for commands
    // ----------------------------------------------------------------------

    void StartComDp_cmdHandler(FwOpcodeType opCode,  
                               U32 cmdSeq,           
                               FwSizeType packetsPerContainer,
                               FwDpPriorityType priority) override;

    void UpdatePriority_cmdHandler(FwOpcodeType opCode,  
                                   U32 cmdSeq,           
                                   FwDpPriorityType priority) override;

    void StopComDp_cmdHandler(FwOpcodeType opCode,  
                              U32 cmdSeq            
                              ) override;

    void CLEAR_COUNTERS_cmdHandler(FwOpcodeType opCode,  
                                   U32 cmdSeq            
                                   ) override;

  private:
    // ----------------------------------------------------------------------
    // Private helper functions
    // ----------------------------------------------------------------------

    Fw::Success startRecordingInternal(FwSizeType packetsPerContainer, FwDpPriorityType priority);

    ComLoggerDp_PartialContainerStatus stopRecordingInternal();

    Fw::Success allocateAndSetupContainer();

    void serializePacket(const U8* dataPtr, FwSizeType dataSize);

    ComLoggerDp_PartialContainerStatus sendContainerIfNonEmpty();

    void finalizeContainer();

    void handleBufferDrop(U32 size);

  private:
    // ----------------------------------------------------------------------
    // Private member variables
    // ----------------------------------------------------------------------

    bool m_enabled{false};

    DpContainer m_container;

    FwSizeType m_packetsPerContainer{0};

    FwSizeType m_currentPacketCount{0};

    U32 m_numBuffersLogged{0};

    U32 m_numBuffersDropped{0};

    U32 m_schedCallsSinceLastPacket{0};

    U32 m_flushTimeout{0};

    FwDpPriorityType m_priority{ContainerPriority::ComBuffContainer};  // Default priority from FPP

    U8 m_recordBuffer[MAX_RECORD_DATA_SIZE];
};

}  // namespace Svc

#endif