GCC Code Coverage Report

Directory: /home/runner/work/fprime/fprime/Svc/Health/
File: HealthComponentImpl.cpp
Date: 2026-09-03 22:13:47
Exec Total Coverage
Lines: 48 112 42.9%
Functions: 6 10 60.0%
Branches: 21 91 23.1%
Line Branch Exec Source
1 // ======================================================================
2 // \title Health.hpp
3 // \author Tim
4 // \brief hpp file for Health component implementation class
5 //
6 // \copyright
7 // Copyright 2009-2015, by the California Institute of Technology.
8 // ALL RIGHTS RESERVED. United States Government Sponsorship
9 // acknowledged.
10 //
11 // ======================================================================
12
13 #include <Fw/FPrimeBasicTypes.hpp>
14 #include <Fw/Types/Assert.hpp>
15 #include <Svc/Health/HealthComponentImpl.hpp>
16
17 namespace Svc {
18
19 // ----------------------------------------------------------------------
20 // Construction, initialization, and destruction
21 // ----------------------------------------------------------------------
22
23 1 HealthImpl::HealthImpl(const char* const compName)
24 : HealthComponentBase(compName),
25 1 m_numPingEntries(0),
26 1 m_key(0),
27 1 m_watchDogCode(0),
28 1 m_warnings(0),
29 1 m_enabled(Fw::Enabled::ENABLED),
30
4/10
✓ Branch 2 taken 25 times.
✓ Branch 4 taken 25 times.
✓ Branch 5 taken 1 times.
✓ Branch 7 taken 1 times.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✗ Branch 12 not taken.
✗ Branch 14 not taken.
✗ Branch 15 not taken.
 26 queue_depth(0) {
31 static_assert((HealthComponentBase::NUM_PINGSEND_OUTPUT_PORTS >= 0) &&
32 (HealthComponentBase::NUM_PINGSEND_OUTPUT_PORTS <= std::numeric_limits<FwIndexType>::max()),
33 "NUM_PINGSEND_OUTPUT_PORTS must fit in the positive range of FwIndexType");
34 // clear tracker by disabling pings
35
2/2
✓ Branch 1 taken 25 times.
✓ Branch 2 taken 1 times.
 26 for (FwIndexType entry = 0; entry < static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_pingTrackerEntries));
36 entry++) {
37 25 this->m_pingTrackerEntries[entry].enabled = Fw::Enabled::DISABLED;
38 }
39 1 }
40
41 1 void HealthImpl::init(const FwSizeType queueDepth, const FwEnumStoreType instance) {
42 1 HealthComponentBase::init(queueDepth, instance);
43 1 this->queue_depth = queueDepth;
44 1 }
45
46 1 void HealthImpl::setPingEntries(PingEntry* pingEntries, FwIndexType numPingEntries, U32 watchDogCode) {
47 1 FW_ASSERT(pingEntries != nullptr);
48 // make sure not asking for more pings than ports
49 1 FW_ASSERT(numPingEntries <= NUM_PINGSEND_OUTPUT_PORTS);
50
51 1 this->m_numPingEntries = numPingEntries;
52 1 this->m_watchDogCode = watchDogCode;
53
54 // copy entries to private data
55
2/2
✓ Branch 0 taken 15 times.
✓ Branch 1 taken 1 times.
 16 for (FwIndexType entry = 0; entry < numPingEntries; entry++) {
56 15 FW_ASSERT(pingEntries[entry].warnCycles <= pingEntries[entry].fatalCycles,
57 static_cast<FwAssertArgType>(pingEntries[entry].warnCycles),
58 static_cast<FwAssertArgType>(pingEntries[entry].fatalCycles));
59 15 this->m_pingTrackerEntries[entry].entry = pingEntries[entry];
60 15 this->m_pingTrackerEntries[entry].cycleCount = 0;
61 15 this->m_pingTrackerEntries[entry].enabled = Fw::Enabled::ENABLED;
62 15 this->m_pingTrackerEntries[entry].key = 0;
63 }
64 1 }
65
66
3/4
✓ Branch 1 taken 1 times.
✗ Branch 2 not taken.
✓ Branch 3 taken 25 times.
✓ Branch 4 taken 1 times.
 52 HealthImpl::~HealthImpl() {}
67
68 // ----------------------------------------------------------------------
69 // Handler implementations for user-defined typed input ports
70 // ----------------------------------------------------------------------
71
72 870 void HealthImpl::PingReturn_handler(const FwIndexType portNum, U32 key) {
73 // verify the key value
74
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 870 times.
 870 if (key != this->m_pingTrackerEntries[portNum].key) {
75 ✗ Fw::LogStringArg _arg = this->m_pingTrackerEntries[portNum].entry.entryName;
76 ✗ this->log_FATAL_HLTH_PING_WRONG_KEY(_arg, key);
77 ✗ } else {
78 // reset the counter and clear the key
79 870 this->m_pingTrackerEntries[portNum].cycleCount = 0;
80 870 this->m_pingTrackerEntries[portNum].key = 0;
81 }
82 870 }
83
84 59 void HealthImpl::Run_handler(const FwIndexType portNum, U32 context) {
85 // dispatch messages
86
1/2
✓ Branch 0 taken 929 times.
✗ Branch 1 not taken.
 929 for (FwSizeType i = 0; i < this->queue_depth; i++) {
87 929 MsgDispatchStatus stat = this->doDispatch();
88
2/2
✓ Branch 0 taken 59 times.
✓ Branch 1 taken 870 times.
 929 if (MSG_DISPATCH_EMPTY == stat) {
89 59 break;
90 }
91 870 FW_ASSERT(MSG_DISPATCH_OK == stat);
92 }
93
94
1/2
✓ Branch 1 taken 59 times.
✗ Branch 2 not taken.
 59 if (this->m_enabled == Fw::Enabled::ENABLED) {
95 // cycle through ping table, pinging ports that are not awaiting a reply
96 // for ports that are awaiting a reply, decrement their counters
97 // and check for violations
98
99
2/2
✓ Branch 0 taken 885 times.
✓ Branch 1 taken 59 times.
 944 for (FwIndexType entry = 0; entry < this->m_numPingEntries; entry++) {
100
1/2
✓ Branch 0 taken 885 times.
✗ Branch 1 not taken.
 885 if (Fw::Enabled::ENABLED == this->m_pingTrackerEntries[entry].enabled) {
101 // If clear entry
102
1/2
✓ Branch 0 taken 885 times.
✗ Branch 1 not taken.
 885 if (0 == this->m_pingTrackerEntries[entry].cycleCount) {
103 // start a ping
104 885 this->m_pingTrackerEntries[entry].key = this->m_key;
105 // send ping
106 885 this->PingSend_out(static_cast<FwIndexType>(entry), this->m_pingTrackerEntries[entry].key);
107 // increment key
108 885 this->m_key++;
109 // increment cycles for the entry
110 885 this->m_pingTrackerEntries[entry].cycleCount++;
111 } else {
112 // check for FATAL timeout value first: warnCycles == fatalCycles is a legal
113 // configuration, and the FATAL takes precedence over the warning
114 ✗ if (this->m_pingTrackerEntries[entry].entry.fatalCycles ==
115 ✗ this->m_pingTrackerEntries[entry].cycleCount) {
116 ✗ Fw::LogStringArg _arg = this->m_pingTrackerEntries[entry].entry.entryName;
117 ✗ this->log_FATAL_HLTH_PING_LATE(_arg);
118 ✗ } else if (this->m_pingTrackerEntries[entry].cycleCount ==
119 ✗ this->m_pingTrackerEntries[entry].entry.warnCycles) {
120 ✗ Fw::LogStringArg _arg = this->m_pingTrackerEntries[entry].entry.entryName;
121 ✗ this->log_WARNING_HI_HLTH_PING_WARN(_arg);
122 ✗ this->tlmWrite_PingLateWarnings(++this->m_warnings);
123 ✗ } // if at warning or fatal threshold
124
125 ✗ this->m_pingTrackerEntries[entry].cycleCount++;
126 } // if clear entry
127 } // if entry has ping enabled
128 } // for each entry
129 } // If health checking is enabled
130
131 // stroke watchdog.
132
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 59 times.
 59 if (this->isConnected_WdogStroke_OutputPort(0)) {
133 ✗ this->WdogStroke_out(0, this->m_watchDogCode);
134 }
135 59 }
136
137 // ----------------------------------------------------------------------
138 // Command handler implementations
139 // ----------------------------------------------------------------------
140
141 ✗ void HealthImpl::HLTH_ENABLE_cmdHandler(const FwOpcodeType opCode, U32 cmdSeq, const Fw::Enabled& enable) {
142 ✗ this->m_enabled = enable;
143 ✗ Fw::Enabled isEnabled = Fw::Enabled::DISABLED;
144 ✗ if (enable == Fw::Enabled::ENABLED) {
145 ✗ isEnabled = Fw::Enabled::ENABLED;
146 }
147 ✗ this->log_ACTIVITY_HI_HLTH_CHECK_ENABLE(isEnabled);
148 ✗ this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
149 ✗ }
150
151 ✗ void HealthImpl::HLTH_PING_ENABLE_cmdHandler(const FwOpcodeType opCode,
152 U32 cmdSeq,
153 const Fw::CmdStringArg& entry,
154 const Fw::Enabled& enable) {
155 // check to see if entry is in range
156 ✗ FwIndexType entryIndex = this->findEntry(entry);
157
158 ✗ if (-1 == entryIndex) {
159 ✗ this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::VALIDATION_ERROR);
160 ✗ return;
161 }
162 ✗ FW_ASSERT(
163 entryIndex >= 0 && entryIndex < static_cast<FwIndexType>(FW_NUM_ARRAY_ELEMENTS(this->m_pingTrackerEntries)),
164 static_cast<FwAssertArgType>(entryIndex));
165
166 ✗ this->m_pingTrackerEntries[entryIndex].enabled = enable.e;
167 ✗ Fw::Enabled isEnabled(Fw::Enabled::DISABLED);
168 ✗ if (enable == Fw::Enabled::ENABLED) {
169 ✗ isEnabled = Fw::Enabled::ENABLED;
170 }
171 ✗ Fw::LogStringArg arg;
172 ✗ arg = entry;
173 ✗ this->log_ACTIVITY_HI_HLTH_CHECK_PING(isEnabled, arg);
174 ✗ this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
175 ✗ }
176
177 ✗ void HealthImpl::HLTH_CHNG_PING_cmdHandler(const FwOpcodeType opCode,
178 U32 cmdSeq,
179 const Fw::CmdStringArg& entry,
180 U32 warningValue,
181 U32 fatalValue) {
182 // check to see if entry is in range
183 ✗ FwIndexType entryIndex = this->findEntry(entry);
184 ✗ if (-1 == entryIndex) {
185 ✗ this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::VALIDATION_ERROR);
186 ✗ return;
187 }
188
189 // check to see if warningValue less than or equal to fatalValue
190 ✗ if (warningValue > fatalValue) {
191 ✗ Fw::LogStringArg arg;
192 ✗ arg = entry;
193 ✗ this->log_WARNING_HI_HLTH_PING_INVALID_VALUES(arg, warningValue, fatalValue);
194 ✗ this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::VALIDATION_ERROR);
195 ✗ return;
196 ✗ }
197
198 ✗ this->m_pingTrackerEntries[entryIndex].entry.warnCycles = warningValue;
199 ✗ this->m_pingTrackerEntries[entryIndex].entry.fatalCycles = fatalValue;
200 ✗ Fw::LogStringArg arg = entry;
201 ✗ this->log_ACTIVITY_HI_HLTH_PING_UPDATED(arg, warningValue, fatalValue);
202 ✗ this->cmdResponse_out(opCode, cmdSeq, Fw::CmdResponse::OK);
203 ✗ }
204
205 ✗ FwIndexType HealthImpl::findEntry(const Fw::CmdStringArg& entry) {
206 static_assert(std::numeric_limits<FwIndexType>::is_signed, "FwIndexType must be signed to return -1 for error");
207 // walk through entries
208 ✗ for (FwIndexType tableEntry = 0; tableEntry < this->m_numPingEntries; tableEntry++) {
209 ✗ if (entry == this->m_pingTrackerEntries[tableEntry].entry.entryName) {
210 ✗ return static_cast<FwIndexType>(tableEntry);
211 }
212 }
213 ✗ Fw::LogStringArg arg = entry;
214 ✗ this->log_WARNING_LO_HLTH_CHECK_LOOKUP_ERROR(arg);
215
216 ✗ return -1;
217 ✗ }
218
219 } // end namespace Svc
220