1 #include "watchdog.hpp"
2 
3 #include "watchdog_service.hpp"
4 
5 #include <endian.h>
6 
7 #include <bitset>
8 #include <cstdint>
9 #include <ipmid/api.hpp>
10 #include <phosphor-logging/elog-errors.hpp>
11 #include <phosphor-logging/elog.hpp>
12 #include <phosphor-logging/log.hpp>
13 #include <string>
14 #include <xyz/openbmc_project/Common/error.hpp>
15 
16 using phosphor::logging::commit;
17 using phosphor::logging::level;
18 using phosphor::logging::log;
19 using sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
20 
21 static bool lastCallSuccessful = false;
22 
23 void reportError()
24 {
25     // We don't want to fill the SEL with errors if the daemon dies and doesn't
26     // come back but the watchdog keeps on ticking. Instead, we only report the
27     // error if we haven't reported one since the last successful call
28     if (!lastCallSuccessful)
29     {
30         return;
31     }
32     lastCallSuccessful = false;
33 
34     // TODO: This slow down the end of the IPMI transaction waiting
35     // for the commit to finish. commit<>() can take at least 5 seconds
36     // to complete. 5s is very slow for an IPMI command and ends up
37     // congesting the IPMI channel needlessly, especially if the watchdog
38     // is ticking fairly quickly and we have some transient issues.
39     commit<InternalFailure>();
40 }
41 
42 ipmi::RspType<> ipmiAppResetWatchdogTimer()
43 {
44     try
45     {
46         WatchdogService wd_service;
47 
48         // Notify the caller if we haven't initialized our timer yet
49         // so it can configure actions and timeouts
50         if (!wd_service.getInitialized())
51         {
52             lastCallSuccessful = true;
53 
54             constexpr uint8_t ccWatchdogNotInit = 0x80;
55             return ipmi::response(ccWatchdogNotInit);
56         }
57 
58         // The ipmi standard dictates we enable the watchdog during reset
59         wd_service.resetTimeRemaining(true);
60         lastCallSuccessful = true;
61         return ipmi::responseSuccess();
62     }
63     catch (const InternalFailure& e)
64     {
65         reportError();
66         return ipmi::responseUnspecifiedError();
67     }
68     catch (const std::exception& e)
69     {
70         const std::string e_str = std::string("wd_reset: ") + e.what();
71         log<level::ERR>(e_str.c_str());
72         return ipmi::responseUnspecifiedError();
73     }
74     catch (...)
75     {
76         log<level::ERR>("wd_reset: Unknown Error");
77         return ipmi::responseUnspecifiedError();
78     }
79 }
80 
81 static constexpr uint8_t wd_dont_stop = 0x1 << 6;
82 static constexpr uint8_t wd_timeout_action_mask = 0x3;
83 
84 static constexpr uint8_t wdTimerUseResTimer1 = 0x0;
85 static constexpr uint8_t wdTimerUseResTimer2 = 0x6;
86 static constexpr uint8_t wdTimerUseResTimer3 = 0x7;
87 
88 static constexpr uint8_t wdTimeoutActionMax = 3;
89 static constexpr uint8_t wdTimeoutInterruptTimer = 0x04;
90 
91 enum class IpmiAction : uint8_t
92 {
93     None = 0x0,
94     HardReset = 0x1,
95     PowerOff = 0x2,
96     PowerCycle = 0x3,
97 };
98 
99 /** @brief Converts an IPMI Watchdog Action to DBUS defined action
100  *  @param[in] ipmi_action The IPMI Watchdog Action
101  *  @return The Watchdog Action that the ipmi_action maps to
102  */
103 WatchdogService::Action ipmiActionToWdAction(IpmiAction ipmi_action)
104 {
105     switch (ipmi_action)
106     {
107         case IpmiAction::None:
108         {
109             return WatchdogService::Action::None;
110         }
111         case IpmiAction::HardReset:
112         {
113             return WatchdogService::Action::HardReset;
114         }
115         case IpmiAction::PowerOff:
116         {
117             return WatchdogService::Action::PowerOff;
118         }
119         case IpmiAction::PowerCycle:
120         {
121             return WatchdogService::Action::PowerCycle;
122         }
123         default:
124         {
125             throw std::domain_error("IPMI Action is invalid");
126         }
127     }
128 }
129 
130 enum class IpmiTimerUse : uint8_t
131 {
132     Reserved = 0x0,
133     BIOSFRB2 = 0x1,
134     BIOSPOST = 0x2,
135     OSLoad = 0x3,
136     SMSOS = 0x4,
137     OEM = 0x5,
138 };
139 
140 WatchdogService::TimerUse ipmiTimerUseToWdTimerUse(IpmiTimerUse ipmiTimerUse)
141 {
142     switch (ipmiTimerUse)
143     {
144         case IpmiTimerUse::Reserved:
145         {
146             return WatchdogService::TimerUse::Reserved;
147         }
148         case IpmiTimerUse::BIOSFRB2:
149         {
150             return WatchdogService::TimerUse::BIOSFRB2;
151         }
152         case IpmiTimerUse::BIOSPOST:
153         {
154             return WatchdogService::TimerUse::BIOSPOST;
155         }
156         case IpmiTimerUse::OSLoad:
157         {
158             return WatchdogService::TimerUse::OSLoad;
159         }
160         case IpmiTimerUse::SMSOS:
161         {
162             return WatchdogService::TimerUse::SMSOS;
163         }
164         case IpmiTimerUse::OEM:
165         {
166             return WatchdogService::TimerUse::OEM;
167         }
168         default:
169         {
170             return WatchdogService::TimerUse::Reserved;
171         }
172     }
173 }
174 
175 static bool timerNotLogFlags = false;
176 static std::bitset<8> timerUseExpirationFlags = 0;
177 static uint3_t timerPreTimeoutInterrupt = 0;
178 static constexpr uint8_t wdExpirationFlagReservedBit0 = 0x0;
179 static constexpr uint8_t wdExpirationFlagReservedBit6 = 0x6;
180 static constexpr uint8_t wdExpirationFlagReservedBit7 = 0x7;
181 
182 /**@brief The Set Watchdog Timer ipmi command.
183  *
184  * @param
185  * - timerUse
186  * - dontStopTimer
187  * - dontLog
188  * - timerAction
189  * - pretimeout
190  * - expireFlags
191  * - initialCountdown
192  *
193  * @return completion code on success.
194  **/
195 ipmi::RspType<>
196     ipmiSetWatchdogTimer(uint3_t timerUse, uint3_t reserved, bool dontStopTimer,
197                          bool dontLog, uint3_t timeoutAction, uint1_t reserved1,
198                          uint3_t preTimeoutInterrupt, uint1_t reserved2,
199                          uint8_t preTimeoutInterval,
200                          std::bitset<8> expFlagValue, uint16_t initialCountdown)
201 {
202     if ((timerUse == wdTimerUseResTimer1) ||
203         (timerUse == wdTimerUseResTimer2) ||
204         (timerUse == wdTimerUseResTimer3) ||
205         (timeoutAction > wdTimeoutActionMax) ||
206         (preTimeoutInterrupt == wdTimeoutInterruptTimer) ||
207         (reserved | reserved1 | reserved2 |
208          expFlagValue.test(wdExpirationFlagReservedBit0) |
209          expFlagValue.test(wdExpirationFlagReservedBit6) |
210          expFlagValue.test(wdExpirationFlagReservedBit7)))
211     {
212         return ipmi::responseInvalidFieldRequest();
213     }
214 
215     if (preTimeoutInterval > (initialCountdown / 10))
216     {
217         return ipmi::responseInvalidFieldRequest();
218     }
219 
220     timerNotLogFlags = dontLog;
221     timerPreTimeoutInterrupt = preTimeoutInterrupt;
222 
223     try
224     {
225         WatchdogService wd_service;
226         // Stop the timer if the don't stop bit is not set
227         if (!(dontStopTimer))
228         {
229             wd_service.setEnabled(false);
230         }
231 
232         // Set the action based on the request
233         const auto ipmi_action = static_cast<IpmiAction>(
234             static_cast<uint8_t>(timeoutAction) & wd_timeout_action_mask);
235         wd_service.setExpireAction(ipmiActionToWdAction(ipmi_action));
236 
237         const auto ipmiTimerUse =
238             static_cast<IpmiTimerUse>(static_cast<uint8_t>(timerUse));
239         wd_service.setTimerUse(ipmiTimerUseToWdTimerUse(ipmiTimerUse));
240 
241         wd_service.setExpiredTimerUse(WatchdogService::TimerUse::Reserved);
242 
243         timerUseExpirationFlags &= ~expFlagValue;
244 
245         // Set the new interval and the time remaining deci -> mill seconds
246         const uint64_t interval = initialCountdown * 100;
247         wd_service.setInterval(interval);
248         wd_service.resetTimeRemaining(false);
249 
250         // Mark as initialized so that future resets behave correctly
251         wd_service.setInitialized(true);
252 
253         lastCallSuccessful = true;
254         return ipmi::responseSuccess();
255     }
256     catch (const std::domain_error&)
257     {
258         return ipmi::responseInvalidFieldRequest();
259     }
260     catch (const InternalFailure& e)
261     {
262         reportError();
263         return ipmi::responseUnspecifiedError();
264     }
265     catch (const std::exception& e)
266     {
267         const std::string e_str = std::string("wd_set: ") + e.what();
268         log<level::ERR>(e_str.c_str());
269         return ipmi::responseUnspecifiedError();
270     }
271     catch (...)
272     {
273         log<level::ERR>("wd_set: Unknown Error");
274         return ipmi::responseUnspecifiedError();
275     }
276 }
277 
278 /** @brief Converts a DBUS Watchdog Action to IPMI defined action
279  *  @param[in] wd_action The DBUS Watchdog Action
280  *  @return The IpmiAction that the wd_action maps to
281  */
282 IpmiAction wdActionToIpmiAction(WatchdogService::Action wd_action)
283 {
284     switch (wd_action)
285     {
286         case WatchdogService::Action::None:
287         {
288             return IpmiAction::None;
289         }
290         case WatchdogService::Action::HardReset:
291         {
292             return IpmiAction::HardReset;
293         }
294         case WatchdogService::Action::PowerOff:
295         {
296             return IpmiAction::PowerOff;
297         }
298         case WatchdogService::Action::PowerCycle:
299         {
300             return IpmiAction::PowerCycle;
301         }
302         default:
303         {
304             // We have no method via IPMI to signal that the action is unknown
305             // or unmappable in some way.
306             // Just ignore the error and return NONE so the host can reconcile.
307             return IpmiAction::None;
308         }
309     }
310 }
311 
312 IpmiTimerUse wdTimerUseToIpmiTimerUse(WatchdogService::TimerUse wdTimerUse)
313 {
314     switch (wdTimerUse)
315     {
316         case WatchdogService::TimerUse::Reserved:
317         {
318             return IpmiTimerUse::Reserved;
319         }
320         case WatchdogService::TimerUse::BIOSFRB2:
321         {
322             return IpmiTimerUse::BIOSFRB2;
323         }
324         case WatchdogService::TimerUse::BIOSPOST:
325         {
326             return IpmiTimerUse::BIOSPOST;
327         }
328         case WatchdogService::TimerUse::OSLoad:
329         {
330             return IpmiTimerUse::OSLoad;
331         }
332 
333         case WatchdogService::TimerUse::SMSOS:
334         {
335             return IpmiTimerUse::SMSOS;
336         }
337         case WatchdogService::TimerUse::OEM:
338         {
339             return IpmiTimerUse::OEM;
340         }
341         default:
342         {
343             return IpmiTimerUse::Reserved;
344         }
345     }
346 }
347 
348 static constexpr uint8_t wd_running = 0x1 << 6;
349 
350 /**@brief The getWatchdogTimer ipmi command.
351  *
352  * @return Completion code plus timer details.
353  * - timerUse
354  * - timerAction
355  * - pretimeout
356  * - expireFlags
357  * - initialCountdown
358  * - presentCountdown
359  **/
360 ipmi::RspType<uint3_t, // timerUse - timer use
361               uint3_t, // timerUse - reserved
362               bool,    // timerUse - timer is started
363               bool,    // timerUse - don't log
364 
365               uint3_t, // timerAction - timeout action
366               uint1_t, // timerAction - reserved
367               uint3_t, // timerAction - pre-timeout interrupt
368               uint1_t, // timerAction - reserved
369 
370               uint8_t,        // pretimeout
371               std::bitset<8>, // expireFlags
372               uint16_t,       // initial Countdown - Little Endian (deciseconds)
373               uint16_t        // present Countdown - Little Endian (deciseconds)
374               >
375     ipmiGetWatchdogTimer()
376 {
377     uint16_t presentCountdown = 0;
378     uint8_t pretimeout = 0;
379 
380     try
381     {
382         WatchdogService wd_service;
383         WatchdogService::Properties wd_prop = wd_service.getProperties();
384 
385         // Build and return the response
386         // Interval and timeRemaining need converted from milli -> deci seconds
387         uint16_t initialCountdown = htole16(wd_prop.interval / 100);
388 
389         if (wd_prop.expiredTimerUse != WatchdogService::TimerUse::Reserved)
390         {
391             timerUseExpirationFlags.set(static_cast<uint8_t>(
392                 wdTimerUseToIpmiTimerUse(wd_prop.expiredTimerUse)));
393         }
394 
395         if (wd_prop.enabled)
396         {
397             presentCountdown = htole16(wd_prop.timeRemaining / 100);
398         }
399         else
400         {
401             if (wd_prop.expiredTimerUse == WatchdogService::TimerUse::Reserved)
402             {
403                 presentCountdown = initialCountdown;
404             }
405             else
406             {
407                 presentCountdown = 0;
408                 // Automatically clear it whenever a timer expiration occurs.
409                 timerNotLogFlags = false;
410             }
411         }
412 
413         // TODO: Do something about having pretimeout support
414         pretimeout = 0;
415 
416         lastCallSuccessful = true;
417         return ipmi::responseSuccess(
418             static_cast<uint3_t>(wdTimerUseToIpmiTimerUse(wd_prop.timerUse)), 0,
419             wd_prop.enabled, timerNotLogFlags,
420             static_cast<uint3_t>(wdActionToIpmiAction(wd_prop.expireAction)), 0,
421             timerPreTimeoutInterrupt, 0, pretimeout, timerUseExpirationFlags,
422             initialCountdown, presentCountdown);
423     }
424     catch (const InternalFailure& e)
425     {
426         reportError();
427         return ipmi::responseUnspecifiedError();
428     }
429     catch (const std::exception& e)
430     {
431         const std::string e_str = std::string("wd_get: ") + e.what();
432         log<level::ERR>(e_str.c_str());
433         return ipmi::responseUnspecifiedError();
434     }
435     catch (...)
436     {
437         log<level::ERR>("wd_get: Unknown Error");
438         return ipmi::responseUnspecifiedError();
439     }
440 }
441