blob: a27cf97dd15187e6a20215e7cded8c7f4433643f [file] [log] [blame]
Vishwanatha Subbanna15b1dc12017-05-23 15:16:13 +05301/**
2 * Copyright © 2017 IBM Corporation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Vishwanatha Subbannad7a3f132017-05-29 19:39:08 +053017#include "watchdog.hpp"
Vishwanatha Subbanna15b1dc12017-05-23 15:16:13 +053018
William A. Kennington III1eb97d92018-09-13 00:36:12 -070019#include <CLI/CLI.hpp>
Patrick Venture8f6c5152018-09-11 17:45:33 -070020#include <phosphor-logging/elog-errors.hpp>
21#include <phosphor-logging/elog.hpp>
22#include <phosphor-logging/log.hpp>
William A. Kennington III8d8bc462019-01-16 14:59:07 -080023#include <sdbusplus/bus.hpp>
24#include <sdbusplus/exception.hpp>
25#include <sdbusplus/server/manager.hpp>
26#include <sdeventplus/event.hpp>
William A. Kennington III658527b2021-12-19 20:43:22 -080027#include <sdeventplus/source/signal.hpp>
William A. Kennington IIId1b1e792022-11-21 18:29:11 -080028#include <sdeventplus/utility/sdbus.hpp>
William A. Kennington III658527b2021-12-19 20:43:22 -080029#include <stdplus/signal.hpp>
Patrick Venture8f6c5152018-09-11 17:45:33 -070030#include <xyz/openbmc_project/Common/error.hpp>
31
Patrick Williams6ac6a342023-05-10 07:51:12 -050032#include <functional>
33#include <iostream>
34#include <optional>
35#include <string>
36
William A. Kennington III1232a152018-02-02 15:57:34 -080037using phosphor::watchdog::Watchdog;
William A. Kennington III93975262018-02-02 16:00:50 -080038using sdbusplus::xyz::openbmc_project::State::server::convertForMessage;
William A. Kennington III1232a152018-02-02 15:57:34 -080039
William A. Kennington III3bb2f402018-09-13 00:35:47 -070040void printActionTargetMap(const Watchdog::ActionTargetMap& actionTargetMap)
William A. Kennington III93975262018-02-02 16:00:50 -080041{
42 std::cerr << "Action Targets:\n";
William A. Kennington III3bb2f402018-09-13 00:35:47 -070043 for (const auto& [action, target] : actionTargetMap)
William A. Kennington III93975262018-02-02 16:00:50 -080044 {
William A. Kennington III3bb2f402018-09-13 00:35:47 -070045 std::cerr << " " << convertForMessage(action) << " -> " << target
46 << "\n";
William A. Kennington III93975262018-02-02 16:00:50 -080047 }
48 std::cerr << std::flush;
49}
50
William A. Kennington III1eb97d92018-09-13 00:36:12 -070051void printFallback(const Watchdog::Fallback& fallback)
52{
53 std::cerr << "Fallback Options:\n";
54 std::cerr << " Action: " << convertForMessage(fallback.action) << "\n";
55 std::cerr << " Interval(ms): " << std::dec << fallback.interval << "\n";
56 std::cerr << " Always re-execute: " << std::boolalpha << fallback.always
57 << "\n";
58 std::cerr << std::flush;
59}
60
William A. Kennington III3bb2f402018-09-13 00:35:47 -070061int main(int argc, char* argv[])
Vishwanatha Subbanna15b1dc12017-05-23 15:16:13 +053062{
Vishwanatha Subbanna7e146552017-05-29 17:03:33 +053063 using namespace phosphor::logging;
Patrick Venture8f6c5152018-09-11 17:45:33 -070064 using InternalFailure =
65 sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
Vishwanatha Subbanna15b1dc12017-05-23 15:16:13 +053066
William A. Kennington III1eb97d92018-09-13 00:36:12 -070067 CLI::App app{"Canonical openbmc host watchdog daemon"};
Patrick Venture09eebe32017-08-11 15:23:17 -070068
William A. Kennington III1eb97d92018-09-13 00:36:12 -070069 // Service related options
70 const std::string serviceGroup = "Service Options";
71 std::string path;
72 app.add_option("-p,--path", path,
73 "DBus Object Path. "
74 "Ex: /xyz/openbmc_project/state/watchdog/host0")
75 ->required()
76 ->group(serviceGroup);
77 std::string service;
78 app.add_option("-s,--service", service,
79 "DBus Service Name. "
80 "Ex: xyz.openbmc_project.State.Watchdog.Host")
81 ->required()
82 ->group(serviceGroup);
Jae Hyun Yoo61bc6cd2021-07-01 14:48:41 -070083 bool continueAfterTimeout{false};
William A. Kennington III1eb97d92018-09-13 00:36:12 -070084 app.add_flag("-c,--continue", continueAfterTimeout,
85 "Continue daemon after watchdog timeout")
86 ->group(serviceGroup);
Vishwanatha Subbanna15b1dc12017-05-23 15:16:13 +053087
William A. Kennington III1eb97d92018-09-13 00:36:12 -070088 // Target related options
89 const std::string targetGroup = "Target Options";
90 std::optional<std::string> target;
91 app.add_option("-t,--target", target,
92 "Systemd unit to be called on "
93 "timeout for all actions but NONE. "
94 "Deprecated, use --action_target instead.")
95 ->group(targetGroup);
96 std::vector<std::string> actionTargets;
97 app.add_option("-a,--action_target", actionTargets,
98 "Map of action to "
99 "systemd unit to be called on timeout if that action is "
100 "set for ExpireAction when the timer expires.")
101 ->group(targetGroup);
Vishwanatha Subbanna15b1dc12017-05-23 15:16:13 +0530102
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700103 // Fallback related options
104 const std::string fallbackGroup = "Fallback Options";
105 std::optional<std::string> fallbackAction;
106 auto fallbackActionOpt =
107 app.add_option("-f,--fallback_action", fallbackAction,
108 "Enables the "
109 "watchdog even when disabled via the dbus interface. "
110 "Perform this action when the fallback expires.")
111 ->group(fallbackGroup);
112 std::optional<unsigned> fallbackIntervalMs;
113 auto fallbackIntervalOpt =
114 app.add_option("-i,--fallback_interval", fallbackIntervalMs,
115 "Enables the "
116 "watchdog even when disabled via the dbus interface. "
117 "Waits for this interval before performing the fallback "
118 "action.")
119 ->group(fallbackGroup);
120 fallbackIntervalOpt->needs(fallbackActionOpt);
121 fallbackActionOpt->needs(fallbackIntervalOpt);
Jae Hyun Yoo61bc6cd2021-07-01 14:48:41 -0700122 bool fallbackAlways{false};
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700123 app.add_flag("-e,--fallback_always", fallbackAlways,
124 "Enables the "
125 "watchdog even when disabled by the dbus interface. "
126 "This option is only valid with a fallback specified")
127 ->group(fallbackGroup)
128 ->needs(fallbackActionOpt)
129 ->needs(fallbackIntervalOpt);
130
William A. Kennington III26eef262019-04-04 15:30:30 -0700131 // Should we watch for postcodes
Jae Hyun Yoo61bc6cd2021-07-01 14:48:41 -0700132 bool watchPostcodes{false};
William A. Kennington III26eef262019-04-04 15:30:30 -0700133 app.add_flag("-w,--watch_postcodes", watchPostcodes,
134 "Should we reset the time remaining any time a postcode "
135 "is signaled.");
136
Andrew Geisslerafc369a2021-06-03 14:17:16 -0500137 // Interval related options
Ofer Yehiellic35135d2019-06-14 11:30:25 -0700138 uint64_t minInterval = phosphor::watchdog::DEFAULT_MIN_INTERVAL_MS;
Kun Yi08683752019-12-05 10:34:45 -0800139 app.add_option("-m,--min_interval", minInterval,
140 "Set minimum interval for watchdog in milliseconds");
Ofer Yehiellic35135d2019-06-14 11:30:25 -0700141
Andrew Geisslerafc369a2021-06-03 14:17:16 -0500142 // 0 to indicate to use default from PDI if not passed in
143 uint64_t defaultInterval = 0;
144 app.add_option("-d,--default_interval", defaultInterval,
145 "Set default interval for watchdog in milliseconds");
146
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700147 CLI11_PARSE(app, argc, argv);
148
149 // Put together a list of actions and associated systemd targets
150 // The new --action_target options take precedence over the legacy
151 // --target
William A. Kennington III3bb2f402018-09-13 00:35:47 -0700152 Watchdog::ActionTargetMap actionTargetMap;
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700153 if (target)
Patrick Venture8f6c5152018-09-11 17:45:33 -0700154 {
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700155 actionTargetMap[Watchdog::Action::HardReset] = *target;
156 actionTargetMap[Watchdog::Action::PowerOff] = *target;
157 actionTargetMap[Watchdog::Action::PowerCycle] = *target;
William A. Kennington III1232a152018-02-02 15:57:34 -0800158 }
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700159 for (const auto& actionTarget : actionTargets)
William A. Kennington III27df4b52018-02-02 16:02:05 -0800160 {
161 size_t keyValueSplit = actionTarget.find("=");
162 if (keyValueSplit == std::string::npos)
163 {
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700164 std::cerr << "Invalid action_target format, "
165 "expect <action>=<target>."
166 << std::endl;
167 return 1;
William A. Kennington III27df4b52018-02-02 16:02:05 -0800168 }
169
170 std::string key = actionTarget.substr(0, keyValueSplit);
Patrick Venture8f6c5152018-09-11 17:45:33 -0700171 std::string value = actionTarget.substr(keyValueSplit + 1);
William A. Kennington III27df4b52018-02-02 16:02:05 -0800172
173 // Convert an action from a fully namespaced value
174 Watchdog::Action action;
175 try
176 {
177 action = Watchdog::convertActionFromString(key);
178 }
Patrick Venture8f6c5152018-09-11 17:45:33 -0700179 catch (const sdbusplus::exception::InvalidEnumString&)
William A. Kennington III27df4b52018-02-02 16:02:05 -0800180 {
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700181 std::cerr << "Bad action specified: " << key << std::endl;
182 return 1;
William A. Kennington III27df4b52018-02-02 16:02:05 -0800183 }
184
William A. Kennington IIIc2c26ce2018-09-13 18:35:56 -0700185 // Detect duplicate action target arguments
186 if (actionTargetMap.find(action) != actionTargetMap.end())
187 {
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700188 std::cerr << "Got duplicate action: " << key << std::endl;
189 return 1;
William A. Kennington IIIc2c26ce2018-09-13 18:35:56 -0700190 }
191
William A. Kennington III3bb2f402018-09-13 00:35:47 -0700192 actionTargetMap[action] = std::move(value);
William A. Kennington III27df4b52018-02-02 16:02:05 -0800193 }
William A. Kennington III3bb2f402018-09-13 00:35:47 -0700194 printActionTargetMap(actionTargetMap);
William A. Kennington III93975262018-02-02 16:00:50 -0800195
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700196 // Build the fallback option used for the Watchdog
197 std::optional<Watchdog::Fallback> maybeFallback;
198 if (fallbackAction)
William A. Kennington IIId1331082018-02-27 18:47:05 -0800199 {
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700200 Watchdog::Fallback fallback;
William A. Kennington IIId1331082018-02-27 18:47:05 -0800201 try
202 {
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700203 fallback.action =
204 Watchdog::convertActionFromString(*fallbackAction);
William A. Kennington IIId1331082018-02-27 18:47:05 -0800205 }
Patrick Venture8f6c5152018-09-11 17:45:33 -0700206 catch (const sdbusplus::exception::InvalidEnumString&)
William A. Kennington IIId1331082018-02-27 18:47:05 -0800207 {
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700208 std::cerr << "Bad fallback action specified: " << *fallbackAction
209 << std::endl;
210 return 1;
William A. Kennington IIId1331082018-02-27 18:47:05 -0800211 }
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700212 fallback.interval = *fallbackIntervalMs;
213 fallback.always = fallbackAlways;
William A. Kennington IIId1331082018-02-27 18:47:05 -0800214
William A. Kennington III1eb97d92018-09-13 00:36:12 -0700215 printFallback(fallback);
Willy Tucf4ce3c2021-12-09 20:39:37 -0800216 maybeFallback = fallback;
William A. Kennington III22352192018-02-27 18:51:44 -0800217 }
218
Vishwanatha Subbanna4d5ef3f2017-05-31 18:54:22 +0530219 try
Vishwanatha Subbanna7e146552017-05-29 17:03:33 +0530220 {
William A. Kennington IIIf505fc02018-09-12 18:30:09 -0700221 // Get a default event loop
222 auto event = sdeventplus::Event::get_default();
223
224 // Get a handle to system dbus.
225 auto bus = sdbusplus::bus::new_default();
226
227 // Add systemd object manager.
Patrick Williams73bd5272022-07-22 19:26:57 -0500228 sdbusplus::server::manager_t watchdogManager(bus, path.c_str());
William A. Kennington IIIf505fc02018-09-12 18:30:09 -0700229
Vishwanatha Subbanna4d5ef3f2017-05-31 18:54:22 +0530230 // Create a watchdog object
William A. Kennington IIIf505fc02018-09-12 18:30:09 -0700231 Watchdog watchdog(bus, path.c_str(), event, std::move(actionTargetMap),
Andrew Geisslerafc369a2021-06-03 14:17:16 -0500232 std::move(maybeFallback), minInterval,
William A. Kennington IIId1b1e792022-11-21 18:29:11 -0800233 defaultInterval,
234 /*exitAfterTimeout=*/!continueAfterTimeout);
William A. Kennington IIId1331082018-02-27 18:47:05 -0800235
Patrick Williams73bd5272022-07-22 19:26:57 -0500236 std::optional<sdbusplus::bus::match_t> watchPostcodeMatch;
William A. Kennington III26eef262019-04-04 15:30:30 -0700237 if (watchPostcodes)
238 {
239 watchPostcodeMatch.emplace(
240 bus,
241 sdbusplus::bus::match::rules::propertiesChanged(
William A. Kennington III459b6c72021-05-12 12:02:48 -0700242 "/xyz/openbmc_project/state/boot/raw0",
William A. Kennington III26eef262019-04-04 15:30:30 -0700243 "xyz.openbmc_project.State.Boot.Raw"),
244 std::bind(&Watchdog::resetTimeRemaining, std::ref(watchdog),
245 false));
246 }
247
Vishwanatha Subbanna4d5ef3f2017-05-31 18:54:22 +0530248 // Claim the bus
249 bus.request_name(service.c_str());
250
Patrick Williams6ac6a342023-05-10 07:51:12 -0500251 auto intCb =
252 [](sdeventplus::source::Signal& s, const struct signalfd_siginfo*) {
William A. Kennington IIId1b1e792022-11-21 18:29:11 -0800253 s.get_event().exit(0);
254 };
William A. Kennington III658527b2021-12-19 20:43:22 -0800255 stdplus::signal::block(SIGINT);
256 sdeventplus::source::Signal sigint(event, SIGINT, intCb);
257 stdplus::signal::block(SIGTERM);
258 sdeventplus::source::Signal sigterm(event, SIGTERM, std::move(intCb));
William A. Kennington IIId1b1e792022-11-21 18:29:11 -0800259 return sdeventplus::utility::loopWithBus(event, bus);
Vishwanatha Subbanna7e146552017-05-29 17:03:33 +0530260 }
Patrick Williams120bc4c2021-10-06 14:41:25 -0500261 catch (const InternalFailure& e)
Vishwanatha Subbanna4d5ef3f2017-05-31 18:54:22 +0530262 {
263 phosphor::logging::commit<InternalFailure>();
264
265 // Need a coredump in the error cases.
266 std::terminate();
267 }
William A. Kennington IIId1b1e792022-11-21 18:29:11 -0800268 return 1;
Vishwanatha Subbanna15b1dc12017-05-23 15:16:13 +0530269}