blob: ed083c23d3972b747da29f789787814c34df6a0a [file] [log] [blame]
Andrew Geisslere426b582020-05-28 12:40:55 -05001#include "config.h"
2
3#include "host_state_manager.hpp"
4
5#include <systemd/sd-bus.h>
6
7#include <cereal/archives/json.hpp>
8#include <cereal/cereal.hpp>
9#include <cereal/types/string.hpp>
10#include <cereal/types/tuple.hpp>
11#include <cereal/types/vector.hpp>
12#include <phosphor-logging/elog-errors.hpp>
13#include <phosphor-logging/log.hpp>
14#include <sdbusplus/exception.hpp>
15#include <sdbusplus/server.hpp>
16#include <xyz/openbmc_project/Common/error.hpp>
17#include <xyz/openbmc_project/Control/Power/RestorePolicy/server.hpp>
18
19#include <fstream>
Andrew Geissler36529022016-11-29 15:23:54 -060020#include <iostream>
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -060021#include <map>
22#include <string>
Dhruvaraj Subhashchandran3f475242017-07-12 00:44:27 -050023
Vishwanatha Subbanna0a838732017-10-05 12:43:19 +053024// Register class version with Cereal
Andrew Geissler769a62f2019-12-06 13:36:08 -060025CEREAL_CLASS_VERSION(phosphor::state::manager::Host, CLASS_VERSION)
Andrew Geissler36529022016-11-29 15:23:54 -060026
27namespace phosphor
28{
29namespace state
30{
31namespace manager
32{
33
Andrew Geissler7b90a622017-08-08 11:41:08 -050034// When you see server:: or reboot:: you know we're referencing our base class
Andrew Geissler3e3b84b2016-12-02 15:46:17 -060035namespace server = sdbusplus::xyz::openbmc_project::State::server;
Andrew Geissler7b90a622017-08-08 11:41:08 -050036namespace reboot = sdbusplus::xyz::openbmc_project::Control::Boot::server;
Dhruvaraj Subhashchandrana3b8d7e2017-08-10 05:40:04 -050037namespace bootprogress = sdbusplus::xyz::openbmc_project::State::Boot::server;
38namespace osstatus =
39 sdbusplus::xyz::openbmc_project::State::OperatingSystem::server;
Andrew Geissler1e3bf942016-12-13 15:32:22 -060040using namespace phosphor::logging;
Dhruvaraj Subhashchandran3f475242017-07-12 00:44:27 -050041namespace fs = std::experimental::filesystem;
Anthony Wilson32c532e2018-10-25 21:56:07 -050042using sdbusplus::exception::SdBusError;
Andrew Geissler2f60aae2019-09-12 13:25:21 -050043using sdbusplus::xyz::openbmc_project::Common::Error::InternalFailure;
Andrew Geissler1e3bf942016-12-13 15:32:22 -060044
Andrew Geissler4f309e82017-05-24 15:18:01 -050045// host-shutdown notifies host of shutdown and that leads to host-stop being
46// called so initiate a host shutdown with the -shutdown target and consider the
47// host shut down when the -stop target is complete
48constexpr auto HOST_STATE_SOFT_POWEROFF_TGT = "obmc-host-shutdown@0.target";
Josh D. Kingca357922017-04-11 13:44:09 -050049constexpr auto HOST_STATE_POWEROFF_TGT = "obmc-host-stop@0.target";
50constexpr auto HOST_STATE_POWERON_TGT = "obmc-host-start@0.target";
Andrew Geissler969b2612018-03-29 10:16:51 -070051constexpr auto HOST_STATE_POWERON_MIN_TGT = "obmc-host-startmin@0.target";
Andrew Geisslera27a6e82017-07-27 16:44:43 -050052constexpr auto HOST_STATE_REBOOT_TGT = "obmc-host-reboot@0.target";
Andrew Geissler40dd6e72020-02-07 14:31:12 -060053constexpr auto HOST_STATE_WARM_REBOOT = "obmc-host-warm-reboot@0.target";
54constexpr auto HOST_STATE_FORCE_WARM_REBOOT =
55 "obmc-host-force-warm-reboot@0.target";
Andrew Geissler47b96122020-02-11 16:13:13 -060056constexpr auto HOST_STATE_DIAGNOSTIC_MODE =
57 "obmc-host-diagnostic-mode@0.target";
Andrew Geissler40dd6e72020-02-07 14:31:12 -060058
Josh D. Kingcc3fb5d2017-04-19 15:45:10 -050059constexpr auto HOST_STATE_QUIESCE_TGT = "obmc-host-quiesce@0.target";
Andrew Geissler4da7e002017-01-24 15:21:40 -060060
Josh D. King929ef702017-03-02 10:58:11 -060061constexpr auto ACTIVE_STATE = "active";
62constexpr auto ACTIVATING_STATE = "activating";
63
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -060064/* Map a transition to it's systemd target */
Andrew Geissler58a18012018-01-19 19:36:05 -080065const std::map<server::Host::Transition, std::string> SYSTEMD_TARGET_TABLE = {
66 {server::Host::Transition::Off, HOST_STATE_SOFT_POWEROFF_TGT},
67 {server::Host::Transition::On, HOST_STATE_POWERON_TGT},
Andrew Geissler40dd6e72020-02-07 14:31:12 -060068 {server::Host::Transition::Reboot, HOST_STATE_REBOOT_TGT},
69 {server::Host::Transition::GracefulWarmReboot, HOST_STATE_WARM_REBOOT},
70 {server::Host::Transition::ForceWarmReboot, HOST_STATE_FORCE_WARM_REBOOT}};
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -060071
Andrew Geissler58a18012018-01-19 19:36:05 -080072constexpr auto SYSTEMD_SERVICE = "org.freedesktop.systemd1";
73constexpr auto SYSTEMD_OBJ_PATH = "/org/freedesktop/systemd1";
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -060074constexpr auto SYSTEMD_INTERFACE = "org.freedesktop.systemd1.Manager";
75
Josh D. King929ef702017-03-02 10:58:11 -060076constexpr auto SYSTEMD_PROPERTY_IFACE = "org.freedesktop.DBus.Properties";
77constexpr auto SYSTEMD_INTERFACE_UNIT = "org.freedesktop.systemd1.Unit";
78
Andrew Geissler4da7e002017-01-24 15:21:40 -060079void Host::subscribeToSystemdSignals()
80{
Andrew Geissler58a18012018-01-19 19:36:05 -080081 auto method = this->bus.new_method_call(SYSTEMD_SERVICE, SYSTEMD_OBJ_PATH,
82 SYSTEMD_INTERFACE, "Subscribe");
Andrew Geissler2f60aae2019-09-12 13:25:21 -050083 try
84 {
85 this->bus.call_noreply(method);
86 }
87 catch (const SdBusError& e)
88 {
89 log<level::ERR>("Failed to subscribe to systemd signals",
90 entry("ERR=%s", e.what()));
91 elog<InternalFailure>();
92 }
Andrew Geissler4da7e002017-01-24 15:21:40 -060093 return;
94}
95
Andrew Geissleref3c1842016-12-01 12:33:09 -060096void Host::determineInitialState()
97{
Andrew Geissleref3c1842016-12-01 12:33:09 -060098
Andrew Geissler969b2612018-03-29 10:16:51 -070099 if (stateActive(HOST_STATE_POWERON_MIN_TGT))
Andrew Geissleref3c1842016-12-01 12:33:09 -0600100 {
Andrew Geissler1e3bf942016-12-13 15:32:22 -0600101 log<level::INFO>("Initial Host State will be Running",
102 entry("CURRENT_HOST_STATE=%s",
103 convertForMessage(HostState::Running).c_str()));
Andrew Geissler97924142017-01-24 16:10:18 -0600104 server::Host::currentHostState(HostState::Running);
105 server::Host::requestedHostTransition(Transition::On);
Andrew Geissleref3c1842016-12-01 12:33:09 -0600106 }
107 else
108 {
Andrew Geissler1e3bf942016-12-13 15:32:22 -0600109 log<level::INFO>("Initial Host State will be Off",
110 entry("CURRENT_HOST_STATE=%s",
111 convertForMessage(HostState::Off).c_str()));
Andrew Geissler97924142017-01-24 16:10:18 -0600112 server::Host::currentHostState(HostState::Off);
113 server::Host::requestedHostTransition(Transition::Off);
Andrew Geissleref3c1842016-12-01 12:33:09 -0600114 }
115
Andrew Geissler033fc3b2017-08-30 15:11:44 -0500116 if (!deserialize(HOST_STATE_PERSIST_PATH))
Dhruvaraj Subhashchandran3f475242017-07-12 00:44:27 -0500117 {
Andrew Geissler58a18012018-01-19 19:36:05 -0800118 // set to default value.
Dhruvaraj Subhashchandran3f475242017-07-12 00:44:27 -0500119 server::Host::requestedHostTransition(Transition::Off);
120 }
Andrew Geissleref3c1842016-12-01 12:33:09 -0600121
122 return;
123}
124
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -0600125void Host::executeTransition(Transition tranReq)
126{
127 auto sysdUnit = SYSTEMD_TARGET_TABLE.find(tranReq)->second;
128
Andrew Geissler58a18012018-01-19 19:36:05 -0800129 auto method = this->bus.new_method_call(SYSTEMD_SERVICE, SYSTEMD_OBJ_PATH,
130 SYSTEMD_INTERFACE, "StartUnit");
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -0600131
132 method.append(sysdUnit);
133 method.append("replace");
134
Andrew Geissler4da7e002017-01-24 15:21:40 -0600135 this->bus.call_noreply(method);
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -0600136
137 return;
138}
139
Josh D. King929ef702017-03-02 10:58:11 -0600140bool Host::stateActive(const std::string& target)
141{
Patrick Williams2975e262020-05-13 18:01:09 -0500142 std::variant<std::string> currentState;
Josh D. King929ef702017-03-02 10:58:11 -0600143 sdbusplus::message::object_path unitTargetPath;
144
Andrew Geissler58a18012018-01-19 19:36:05 -0800145 auto method = this->bus.new_method_call(SYSTEMD_SERVICE, SYSTEMD_OBJ_PATH,
146 SYSTEMD_INTERFACE, "GetUnit");
Josh D. King929ef702017-03-02 10:58:11 -0600147
148 method.append(target);
Josh D. King929ef702017-03-02 10:58:11 -0600149
Anthony Wilson32c532e2018-10-25 21:56:07 -0500150 try
Josh D. King929ef702017-03-02 10:58:11 -0600151 {
Anthony Wilson32c532e2018-10-25 21:56:07 -0500152 auto result = this->bus.call(method);
153 result.read(unitTargetPath);
154 }
155 catch (const SdBusError& e)
156 {
157 log<level::ERR>("Error in GetUnit call", entry("ERROR=%s", e.what()));
Josh D. King929ef702017-03-02 10:58:11 -0600158 return false;
159 }
160
Andrew Geissler58a18012018-01-19 19:36:05 -0800161 method = this->bus.new_method_call(
162 SYSTEMD_SERVICE,
163 static_cast<const std::string&>(unitTargetPath).c_str(),
164 SYSTEMD_PROPERTY_IFACE, "Get");
Josh D. King929ef702017-03-02 10:58:11 -0600165
166 method.append(SYSTEMD_INTERFACE_UNIT, "ActiveState");
Josh D. King929ef702017-03-02 10:58:11 -0600167
Anthony Wilson32c532e2018-10-25 21:56:07 -0500168 try
Josh D. King929ef702017-03-02 10:58:11 -0600169 {
Anthony Wilson32c532e2018-10-25 21:56:07 -0500170 auto result = this->bus.call(method);
171 result.read(currentState);
172 }
173 catch (const SdBusError& e)
174 {
175 log<level::ERR>("Error in ActiveState Get",
176 entry("ERROR=%s", e.what()));
Josh D. King929ef702017-03-02 10:58:11 -0600177 return false;
178 }
179
Patrick Williams37413dc2020-05-13 11:29:54 -0500180 const auto& currentStateStr = std::get<std::string>(currentState);
William A. Kennington III7a0689a2018-11-12 17:19:33 -0800181 return currentStateStr == ACTIVE_STATE ||
182 currentStateStr == ACTIVATING_STATE;
Josh D. King929ef702017-03-02 10:58:11 -0600183}
184
Michael Tritz206a8332017-02-06 16:01:23 -0600185bool Host::isAutoReboot()
186{
Deepak Kodihalli3dd08a52017-07-25 07:34:44 -0500187 using namespace settings;
Michael Tritz206a8332017-02-06 16:01:23 -0600188
Andrew Geissler58a18012018-01-19 19:36:05 -0800189 auto method = bus.new_method_call(
190 settings.service(settings.autoReboot, autoRebootIntf).c_str(),
191 settings.autoReboot.c_str(), "org.freedesktop.DBus.Properties", "Get");
Deepak Kodihalli3dd08a52017-07-25 07:34:44 -0500192 method.append(autoRebootIntf, "AutoReboot");
Michael Tritz206a8332017-02-06 16:01:23 -0600193
Anthony Wilson32c532e2018-10-25 21:56:07 -0500194 try
Michael Tritz206a8332017-02-06 16:01:23 -0600195 {
Anthony Wilson32c532e2018-10-25 21:56:07 -0500196 auto reply = bus.call(method);
197
Patrick Williams2975e262020-05-13 18:01:09 -0500198 std::variant<bool> result;
Anthony Wilson32c532e2018-10-25 21:56:07 -0500199 reply.read(result);
Patrick Williams37413dc2020-05-13 11:29:54 -0500200 auto autoReboot = std::get<bool>(result);
Anthony Wilson32c532e2018-10-25 21:56:07 -0500201 auto rebootCounterParam = reboot::RebootAttempts::attemptsLeft();
202
203 if (autoReboot)
Saqib Khancbe08d12017-03-10 01:29:20 -0600204 {
Anthony Wilson32c532e2018-10-25 21:56:07 -0500205 if (rebootCounterParam > 0)
206 {
207 // Reduce BOOTCOUNT by 1
208 log<level::INFO>("Auto reboot enabled, rebooting");
209 return true;
210 }
211 else if (rebootCounterParam == 0)
212 {
213 // Reset reboot counter and go to quiesce state
214 log<level::INFO>("Auto reboot enabled. "
215 "HOST BOOTCOUNT already set to 0.");
216 attemptsLeft(BOOT_COUNT_MAX_ALLOWED);
217 return false;
218 }
219 else
220 {
221 log<level::INFO>("Auto reboot enabled. "
222 "HOST BOOTCOUNT has an invalid value.");
223 return false;
224 }
Saqib Khand5ac6352017-04-04 09:53:59 -0500225 }
226 else
227 {
Anthony Wilson32c532e2018-10-25 21:56:07 -0500228 log<level::INFO>("Auto reboot disabled.");
Saqib Khancbe08d12017-03-10 01:29:20 -0600229 return false;
230 }
Michael Tritz206a8332017-02-06 16:01:23 -0600231 }
Anthony Wilson32c532e2018-10-25 21:56:07 -0500232 catch (const SdBusError& e)
Saqib Khand5ac6352017-04-04 09:53:59 -0500233 {
Anthony Wilson32c532e2018-10-25 21:56:07 -0500234 log<level::ERR>("Error in AutoReboot Get", entry("ERROR=%s", e.what()));
Saqib Khand5ac6352017-04-04 09:53:59 -0500235 return false;
236 }
Michael Tritz206a8332017-02-06 16:01:23 -0600237}
238
Andrew Geisslere4039a82020-02-11 15:51:59 -0600239void Host::sysStateChangeJobRemoved(sdbusplus::message::message& msg)
Andrew Geissler4da7e002017-01-24 15:21:40 -0600240{
Andrew Geissler58a18012018-01-19 19:36:05 -0800241 uint32_t newStateID{};
Andrew Geissler4da7e002017-01-24 15:21:40 -0600242 sdbusplus::message::object_path newStateObjPath;
243 std::string newStateUnit{};
244 std::string newStateResult{};
245
Andrew Geissler58a18012018-01-19 19:36:05 -0800246 // Read the msg and populate each variable
Patrick Williamsd22706f2017-05-04 05:42:49 -0500247 msg.read(newStateID, newStateObjPath, newStateUnit, newStateResult);
Andrew Geissler4da7e002017-01-24 15:21:40 -0600248
Andrew Geissler58a18012018-01-19 19:36:05 -0800249 if ((newStateUnit == HOST_STATE_POWEROFF_TGT) &&
Andrew Geissler969b2612018-03-29 10:16:51 -0700250 (newStateResult == "done") &&
251 (!stateActive(HOST_STATE_POWERON_MIN_TGT)))
Andrew Geissleref621162016-12-08 12:56:21 -0600252 {
Andrew Jeffery55b983e2017-04-19 11:11:26 +0930253 log<level::INFO>("Received signal that host is off");
Andrew Geissler4da7e002017-01-24 15:21:40 -0600254 this->currentHostState(server::Host::HostState::Off);
Dhruvaraj Subhashchandrana3b8d7e2017-08-10 05:40:04 -0500255 this->bootProgress(bootprogress::Progress::ProgressStages::Unspecified);
256 this->operatingSystemState(osstatus::Status::OSStatus::Inactive);
Andrew Geissleref621162016-12-08 12:56:21 -0600257 }
Andrew Geissler969b2612018-03-29 10:16:51 -0700258 else if ((newStateUnit == HOST_STATE_POWERON_MIN_TGT) &&
Andrew Geissler58a18012018-01-19 19:36:05 -0800259 (newStateResult == "done") &&
Andrew Geissler969b2612018-03-29 10:16:51 -0700260 (stateActive(HOST_STATE_POWERON_MIN_TGT)))
Andrew Geissler58a18012018-01-19 19:36:05 -0800261 {
262 log<level::INFO>("Received signal that host is running");
263 this->currentHostState(server::Host::HostState::Running);
264 }
265 else if ((newStateUnit == HOST_STATE_QUIESCE_TGT) &&
Josh D. King29d025d2017-04-27 12:40:22 -0500266 (newStateResult == "done") &&
267 (stateActive(HOST_STATE_QUIESCE_TGT)))
Andrew Geissler58a18012018-01-19 19:36:05 -0800268 {
269 if (Host::isAutoReboot())
270 {
271 log<level::INFO>("Beginning reboot...");
272 Host::requestedHostTransition(server::Host::Transition::Reboot);
273 }
274 else
275 {
276 log<level::INFO>("Maintaining quiesce");
277 this->currentHostState(server::Host::HostState::Quiesced);
278 }
279 }
Andrew Geissleref621162016-12-08 12:56:21 -0600280}
281
Andrew Geissler47b96122020-02-11 16:13:13 -0600282void Host::sysStateChangeJobNew(sdbusplus::message::message& msg)
283{
284 uint32_t newStateID{};
285 sdbusplus::message::object_path newStateObjPath;
286 std::string newStateUnit{};
287
288 // Read the msg and populate each variable
289 msg.read(newStateID, newStateObjPath, newStateUnit);
290
291 if (newStateUnit == HOST_STATE_DIAGNOSTIC_MODE)
292 {
293 log<level::INFO>("Received signal that host is in diagnostice mode");
294 this->currentHostState(server::Host::HostState::DiagnosticMode);
295 }
296}
297
Andrew Geissler7b90a622017-08-08 11:41:08 -0500298uint32_t Host::decrementRebootCount()
299{
300 auto rebootCount = reboot::RebootAttempts::attemptsLeft();
Andrew Geissler58a18012018-01-19 19:36:05 -0800301 if (rebootCount > 0)
Andrew Geissler7b90a622017-08-08 11:41:08 -0500302 {
Andrew Geissler58a18012018-01-19 19:36:05 -0800303 return (reboot::RebootAttempts::attemptsLeft(rebootCount - 1));
Andrew Geissler7b90a622017-08-08 11:41:08 -0500304 }
305 return rebootCount;
306}
307
Andrew Geissler033fc3b2017-08-30 15:11:44 -0500308fs::path Host::serialize(const fs::path& dir)
309{
310 std::ofstream os(dir.c_str(), std::ios::binary);
311 cereal::JSONOutputArchive oarchive(os);
312 oarchive(*this);
313 return dir;
314}
315
316bool Host::deserialize(const fs::path& path)
317{
Jayanth Othayothe39f3792017-09-19 23:53:31 -0500318 try
Andrew Geissler033fc3b2017-08-30 15:11:44 -0500319 {
Jayanth Othayothe39f3792017-09-19 23:53:31 -0500320 if (fs::exists(path))
321 {
322 std::ifstream is(path.c_str(), std::ios::in | std::ios::binary);
323 cereal::JSONInputArchive iarchive(is);
324 iarchive(*this);
325 return true;
326 }
327 return false;
Andrew Geissler033fc3b2017-08-30 15:11:44 -0500328 }
Andrew Geissler58a18012018-01-19 19:36:05 -0800329 catch (cereal::Exception& e)
Jayanth Othayothe39f3792017-09-19 23:53:31 -0500330 {
331 log<level::ERR>(e.what());
332 fs::remove(path);
333 return false;
334 }
Andrew Geissler033fc3b2017-08-30 15:11:44 -0500335}
336
Andrew Geissleref3c1842016-12-01 12:33:09 -0600337Host::Transition Host::requestedHostTransition(Transition value)
338{
Andrew Geissler58a18012018-01-19 19:36:05 -0800339 log<level::INFO>("Host State transaction request",
340 entry("REQUESTED_HOST_TRANSITION=%s",
341 convertForMessage(value).c_str()));
Andrew Geissler0cd2eaf2016-12-07 10:50:13 -0600342
Andrew Geissler7b90a622017-08-08 11:41:08 -0500343 // If this is not a power off request then we need to
344 // decrement the reboot counter. This code should
345 // never prevent a power on, it should just decrement
346 // the count to 0. The quiesce handling is where the
347 // check of this count will occur
Andrew Geissler58a18012018-01-19 19:36:05 -0800348 if (value != server::Host::Transition::Off)
Andrew Geissler7b90a622017-08-08 11:41:08 -0500349 {
350 decrementRebootCount();
351 }
352
Andrew Geisslera27a6e82017-07-27 16:44:43 -0500353 executeTransition(value);
Andrew Geissler7b90a622017-08-08 11:41:08 -0500354
Andrew Geissler58a18012018-01-19 19:36:05 -0800355 auto retVal = server::Host::requestedHostTransition(value);
Andrew Geissler033fc3b2017-08-30 15:11:44 -0500356 serialize();
Dhruvaraj Subhashchandran3f475242017-07-12 00:44:27 -0500357 return retVal;
Andrew Geissleref3c1842016-12-01 12:33:09 -0600358}
359
Dhruvaraj Subhashchandran4e6534f2017-09-19 06:13:20 -0500360Host::ProgressStages Host::bootProgress(ProgressStages value)
361{
362 auto retVal = bootprogress::Progress::bootProgress(value);
363 serialize();
364 return retVal;
365}
366
367Host::OSStatus Host::operatingSystemState(OSStatus value)
368{
369 auto retVal = osstatus::Status::operatingSystemState(value);
370 serialize();
371 return retVal;
372}
373
Andrew Geissleref3c1842016-12-01 12:33:09 -0600374Host::HostState Host::currentHostState(HostState value)
375{
Andrew Geissler58a18012018-01-19 19:36:05 -0800376 log<level::INFO>(
377 "Change to Host State",
378 entry("CURRENT_HOST_STATE=%s", convertForMessage(value).c_str()));
Andrew Geissleref621162016-12-08 12:56:21 -0600379 return server::Host::currentHostState(value);
Andrew Geissleref3c1842016-12-01 12:33:09 -0600380}
381
Andrew Geissler36529022016-11-29 15:23:54 -0600382} // namespace manager
383} // namespace state
Andrew Geisslera965cf02018-08-31 08:37:05 -0700384} // namespace phosphor