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