F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
ComLoggerDp.hpp
Go to the documentation of this file.
1 // ======================================================================
2 // \title ComLoggerDp.hpp
3 // \author tcanham
4 // \brief hpp file for ComLoggerDp component implementation class
5 // ======================================================================
6 
7 #ifndef Svc_ComLoggerDp_HPP
8 #define Svc_ComLoggerDp_HPP
9 
10 #include <atomic>
11 
12 #include "Fw/Dp/DpContainer.hpp"
14 #include "config/ComLoggerDpCfg.hpp"
15 
16 namespace Svc {
17 
18 // Forward declaration for testing
19 class ComLoggerDpTester;
20 
21 class ComLoggerDp final : public ComLoggerDpComponentBase {
22  // Grant test access to private methods for unit testing
23  friend class ComLoggerDpTester;
24 
25  public:
26  // ----------------------------------------------------------------------
27  // Public interface
28  // ----------------------------------------------------------------------
29 
32 
35 
51  static constexpr FwSizeType ComLoggerDpBuffSize(FwSizeType packetsPerContainer) {
52  return DpContainer::MIN_PACKET_SIZE + packetsPerContainer * RECORD_SIZE;
53  }
54 
55  // ----------------------------------------------------------------------
56  // Component construction and destruction
57  // ----------------------------------------------------------------------
58 
60  explicit ComLoggerDp(const char* const compName
61  );
62 
64  ~ComLoggerDp();
65 
67  ComLoggerDp(const ComLoggerDp&) = delete;
68 
70  ComLoggerDp& operator=(const ComLoggerDp&) = delete;
71 
73  ComLoggerDp(ComLoggerDp&&) = delete;
74 
76  ComLoggerDp& operator=(ComLoggerDp&&) = delete;
77 
84  void configure(bool enabled, FwSizeType packetsPerContainer, FwDpPriorityType priority, U32 flushTimeout);
85 
86  private:
87  // ----------------------------------------------------------------------
88  // Handler implementations for typed input ports
89  // ----------------------------------------------------------------------
90 
94  void comIn_handler(FwIndexType portNum,
95  Fw::ComBuffer& data,
96  U32 context
97  ) override;
98 
102  void pingIn_handler(FwIndexType portNum,
103  U32 key
104  ) override;
105 
109  void schedIn_handler(FwIndexType portNum,
110  U32 context
111  ) override;
112 
114  void schedInInternal_internalInterfaceHandler() override;
115 
117  void schedInInternal_overflowHook() override;
118 
122  void startRecordingIn_handler(FwIndexType portNum,
123  FwSizeType packetsPerContainer,
124  FwDpPriorityType priority
125  ) override;
126 
130  void stopRecordingIn_handler(FwIndexType portNum
131  ) override;
132 
133  private:
134  // ----------------------------------------------------------------------
135  // Handler implementations for commands
136  // ----------------------------------------------------------------------
137 
141  void StartComDp_cmdHandler(FwOpcodeType opCode,
142  U32 cmdSeq,
143  FwSizeType packetsPerContainer,
144  FwDpPriorityType priority) override;
145 
149  void UpdatePriority_cmdHandler(FwOpcodeType opCode,
150  U32 cmdSeq,
151  FwDpPriorityType priority) override;
152 
156  void StopComDp_cmdHandler(FwOpcodeType opCode,
157  U32 cmdSeq
158  ) override;
159 
163  void CLEAR_COUNTERS_cmdHandler(FwOpcodeType opCode,
164  U32 cmdSeq
165  ) override;
166 
167  private:
168  // ----------------------------------------------------------------------
169  // Private helper functions
170  // ----------------------------------------------------------------------
171 
176  Fw::Success startRecordingInternal(FwSizeType packetsPerContainer, FwDpPriorityType priority);
177 
180  ComLoggerDp_PartialContainerStatus stopRecordingInternal();
181 
184  Fw::Success allocateAndSetupContainer();
185 
189  void serializePacket(const U8* dataPtr, FwSizeType dataSize);
190 
194  ComLoggerDp_PartialContainerStatus sendContainerIfNonEmpty();
195 
197  void finalizeContainer();
198 
201  void handleBufferDrop(U32 size);
202 
203  private:
204  // ----------------------------------------------------------------------
205  // Private member variables
206  // ----------------------------------------------------------------------
207 
209  bool m_enabled{false};
210 
212  DpContainer m_container;
213 
215  FwSizeType m_packetsPerContainer{0};
216 
218  FwSizeType m_currentPacketCount{0};
219 
221  U32 m_numBuffersLogged{0};
222 
224  U32 m_numBuffersDropped{0};
225 
227  U32 m_schedCallsSinceLastPacket{0};
228 
230  U32 m_flushTimeout{0};
231 
233  std::atomic<bool> m_schedInQueued{false};
234 
236  FwDpPriorityType m_priority{ContainerPriority::ComBuffContainer}; // Default priority from FPP
237 
239  U8 m_recordBuffer[MAX_RECORD_DATA_SIZE];
240 };
241 
242 } // namespace Svc
243 
244 #endif
static constexpr FwSizeType SIZE_OF_ComBufferRecord_RECORD(FwSizeType arraySize)
Record sizes.
FwIdType FwOpcodeType
The type of a command opcode.
PlatformSizeType FwSizeType
U32 FwDpPriorityType
The type of a data product priority.
void configure(bool enabled, FwSizeType packetsPerContainer, FwDpPriorityType priority, U32 flushTimeout)
Definition: ComLoggerDp.cpp:24
static constexpr FwSizeType MIN_PACKET_SIZE
Definition: DpContainer.hpp:65
ComLoggerDp(const char *const compName)
Construct ComLoggerDp object.
Definition: ComLoggerDp.cpp:16
Auto-generated base for ComLoggerDp component.
~ComLoggerDp()
Destroy ComLoggerDp object.
Definition: ComLoggerDp.cpp:18
static constexpr FwSizeType MAX_RECORD_DATA_SIZE
Maximum data size of one record: a sentry followed by a maximum-size ComBuffer.
Definition: ComLoggerDp.hpp:31
friend class ComLoggerDpTester
Definition: ComLoggerDp.hpp:23
static constexpr FwSizeType ComLoggerDpBuffSize(FwSizeType packetsPerContainer)
Definition: ComLoggerDp.hpp:51
uint8_t U8
8-bit unsigned integer
Definition: BasicTypes.h:54
constexpr U32 ComLoggerDpSentry
PlatformIndexType FwIndexType
RateGroupDivider component implementation.
Whether a partial container was sent when recording stopped.
Success/Failure.
ComLoggerDp & operator=(const ComLoggerDp &)=delete
Copy assignment operator (deleted)
static constexpr FwSizeType RECORD_SIZE
Serialized size of one ComBufferRecord holding MAX_RECORD_DATA_SIZE bytes.
Definition: ComLoggerDp.hpp:34