xref: /openbmc/phosphor-ipmi-flash/bmc/general_systemd.cpp (revision 93f3c55028a08af25f19bca0fc381f44b7f8ce3a)
1cf066aceSPatrick Venture /*
2cf066aceSPatrick Venture  * Copyright 2019 Google Inc.
3cf066aceSPatrick Venture  *
4cf066aceSPatrick Venture  * Licensed under the Apache License, Version 2.0 (the "License");
5cf066aceSPatrick Venture  * you may not use this file except in compliance with the License.
6cf066aceSPatrick Venture  * You may obtain a copy of the License at
7cf066aceSPatrick Venture  *
8cf066aceSPatrick Venture  *     http://www.apache.org/licenses/LICENSE-2.0
9cf066aceSPatrick Venture  *
10cf066aceSPatrick Venture  * Unless required by applicable law or agreed to in writing, software
11cf066aceSPatrick Venture  * distributed under the License is distributed on an "AS IS" BASIS,
12cf066aceSPatrick Venture  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13cf066aceSPatrick Venture  * See the License for the specific language governing permissions and
14cf066aceSPatrick Venture  * limitations under the License.
15cf066aceSPatrick Venture  */
16cf066aceSPatrick Venture 
17cf066aceSPatrick Venture #include "general_systemd.hpp"
18cf066aceSPatrick Venture 
19cf066aceSPatrick Venture #include "status.hpp"
20cf066aceSPatrick Venture 
21cf066aceSPatrick Venture #include <fstream>
22cf066aceSPatrick Venture #include <memory>
23cf066aceSPatrick Venture #include <sdbusplus/bus.hpp>
24cf066aceSPatrick Venture #include <string>
25cf066aceSPatrick Venture #include <vector>
26cf066aceSPatrick Venture 
27cf066aceSPatrick Venture namespace ipmi_flash
28cf066aceSPatrick Venture {
29cf066aceSPatrick Venture 
30b22ebbf3SWilliam A. Kennington III static constexpr auto systemdService = "org.freedesktop.systemd1";
31b22ebbf3SWilliam A. Kennington III static constexpr auto systemdRoot = "/org/freedesktop/systemd1";
32b22ebbf3SWilliam A. Kennington III static constexpr auto systemdInterface = "org.freedesktop.systemd1.Manager";
33b22ebbf3SWilliam A. Kennington III 
34b22ebbf3SWilliam A. Kennington III bool SystemdNoFile::trigger()
35b22ebbf3SWilliam A. Kennington III {
36b22ebbf3SWilliam A. Kennington III     if (job)
37b22ebbf3SWilliam A. Kennington III     {
38b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "Job alreading running %s: %s\n",
39b22ebbf3SWilliam A. Kennington III                      triggerService.c_str(), job->c_str());
40b22ebbf3SWilliam A. Kennington III         return false;
41b22ebbf3SWilliam A. Kennington III     }
42b22ebbf3SWilliam A. Kennington III 
43b22ebbf3SWilliam A. Kennington III     try
44b22ebbf3SWilliam A. Kennington III     {
45b22ebbf3SWilliam A. Kennington III         jobMonitor.emplace(
46b22ebbf3SWilliam A. Kennington III             bus,
47b22ebbf3SWilliam A. Kennington III             "type='signal',"
48b22ebbf3SWilliam A. Kennington III             "sender='org.freedesktop.systemd1',"
49b22ebbf3SWilliam A. Kennington III             "path='/org/freedesktop/systemd1',"
50b22ebbf3SWilliam A. Kennington III             "interface='org.freedesktop.systemd1.Manager',"
51b22ebbf3SWilliam A. Kennington III             "member='JobRemoved',",
52b22ebbf3SWilliam A. Kennington III             [&](sdbusplus::message::message& m) { this->match(m); });
53b22ebbf3SWilliam A. Kennington III 
54b22ebbf3SWilliam A. Kennington III         auto method = bus.new_method_call(systemdService, systemdRoot,
55b22ebbf3SWilliam A. Kennington III                                           systemdInterface, "StartUnit");
56b22ebbf3SWilliam A. Kennington III         method.append(triggerService);
57b22ebbf3SWilliam A. Kennington III         method.append(mode);
58b22ebbf3SWilliam A. Kennington III 
59b22ebbf3SWilliam A. Kennington III         sdbusplus::message::object_path obj_path;
60b22ebbf3SWilliam A. Kennington III         bus.call(method).read(obj_path);
61b22ebbf3SWilliam A. Kennington III         job = std::move(obj_path);
62b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "Triggered %s mode %s: %s\n",
63b22ebbf3SWilliam A. Kennington III                      triggerService.c_str(), mode.c_str(), job->c_str());
64b22ebbf3SWilliam A. Kennington III         currentStatus = ActionStatus::running;
65b22ebbf3SWilliam A. Kennington III         return true;
66b22ebbf3SWilliam A. Kennington III     }
67b22ebbf3SWilliam A. Kennington III     catch (const std::exception& e)
68b22ebbf3SWilliam A. Kennington III     {
69b22ebbf3SWilliam A. Kennington III         job = std::nullopt;
70b22ebbf3SWilliam A. Kennington III         jobMonitor = std::nullopt;
71b22ebbf3SWilliam A. Kennington III         currentStatus = ActionStatus::failed;
72b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "Failed to trigger %s mode %s: %s\n",
73b22ebbf3SWilliam A. Kennington III                      triggerService.c_str(), mode.c_str(), e.what());
74b22ebbf3SWilliam A. Kennington III         return false;
75b22ebbf3SWilliam A. Kennington III     }
76b22ebbf3SWilliam A. Kennington III }
77b22ebbf3SWilliam A. Kennington III 
78b22ebbf3SWilliam A. Kennington III void SystemdNoFile::abort()
79b22ebbf3SWilliam A. Kennington III {
80b22ebbf3SWilliam A. Kennington III     if (!job)
81b22ebbf3SWilliam A. Kennington III     {
82b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "No running job %s\n", triggerService.c_str());
83b22ebbf3SWilliam A. Kennington III         return;
84b22ebbf3SWilliam A. Kennington III     }
85b22ebbf3SWilliam A. Kennington III 
86b22ebbf3SWilliam A. Kennington III     // Cancel the job
87b22ebbf3SWilliam A. Kennington III     auto cancel_req = bus.new_method_call(systemdService, job->c_str(),
88b22ebbf3SWilliam A. Kennington III                                           systemdInterface, "Cancel");
89b22ebbf3SWilliam A. Kennington III     try
90b22ebbf3SWilliam A. Kennington III     {
91b22ebbf3SWilliam A. Kennington III         bus.call_noreply(cancel_req);
92b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "Canceled %s: %s\n", triggerService.c_str(),
93b22ebbf3SWilliam A. Kennington III                      job->c_str());
94b22ebbf3SWilliam A. Kennington III     }
95b22ebbf3SWilliam A. Kennington III     catch (const sdbusplus::exception::SdBusError& ex)
96b22ebbf3SWilliam A. Kennington III     {
97b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "Failed to cancel job %s %s: %s\n",
98b22ebbf3SWilliam A. Kennington III                      triggerService.c_str(), job->c_str(), ex.what());
99b22ebbf3SWilliam A. Kennington III     }
100b22ebbf3SWilliam A. Kennington III }
101b22ebbf3SWilliam A. Kennington III 
102b22ebbf3SWilliam A. Kennington III ActionStatus SystemdNoFile::status()
103b22ebbf3SWilliam A. Kennington III {
104b22ebbf3SWilliam A. Kennington III     return currentStatus;
105b22ebbf3SWilliam A. Kennington III }
106b22ebbf3SWilliam A. Kennington III 
107b22ebbf3SWilliam A. Kennington III const std::string& SystemdNoFile::getMode() const
108b22ebbf3SWilliam A. Kennington III {
109b22ebbf3SWilliam A. Kennington III     return mode;
110b22ebbf3SWilliam A. Kennington III }
111b22ebbf3SWilliam A. Kennington III 
112b22ebbf3SWilliam A. Kennington III void SystemdNoFile::match(sdbusplus::message::message& m)
113b22ebbf3SWilliam A. Kennington III {
114b22ebbf3SWilliam A. Kennington III     if (!job)
115b22ebbf3SWilliam A. Kennington III     {
116b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "No running job %s\n", triggerService.c_str());
117b22ebbf3SWilliam A. Kennington III         return;
118b22ebbf3SWilliam A. Kennington III     }
119b22ebbf3SWilliam A. Kennington III 
120b22ebbf3SWilliam A. Kennington III     uint32_t job_id;
121b22ebbf3SWilliam A. Kennington III     sdbusplus::message::object_path job_path;
122b22ebbf3SWilliam A. Kennington III     std::string unit;
123b22ebbf3SWilliam A. Kennington III     std::string result;
124b22ebbf3SWilliam A. Kennington III     try
125b22ebbf3SWilliam A. Kennington III     {
126b22ebbf3SWilliam A. Kennington III         m.read(job_id, job_path, unit, result);
127b22ebbf3SWilliam A. Kennington III     }
128b22ebbf3SWilliam A. Kennington III     catch (const sdbusplus::exception::SdBusError& e)
129b22ebbf3SWilliam A. Kennington III     {
130b22ebbf3SWilliam A. Kennington III         std::fprintf(stderr, "Bad JobRemoved signal %s: %s\n",
131b22ebbf3SWilliam A. Kennington III                      triggerService.c_str(), e.what());
132b22ebbf3SWilliam A. Kennington III         return;
133b22ebbf3SWilliam A. Kennington III     }
134b22ebbf3SWilliam A. Kennington III 
135b22ebbf3SWilliam A. Kennington III     if (*job != job_path.str)
136b22ebbf3SWilliam A. Kennington III     {
137b22ebbf3SWilliam A. Kennington III         return;
138b22ebbf3SWilliam A. Kennington III     }
139b22ebbf3SWilliam A. Kennington III 
140b22ebbf3SWilliam A. Kennington III     std::fprintf(stderr, "Job Finished %s %s: %s\n", triggerService.c_str(),
141b22ebbf3SWilliam A. Kennington III                  job->c_str(), result.c_str());
142b22ebbf3SWilliam A. Kennington III     jobMonitor = std::nullopt;
143b22ebbf3SWilliam A. Kennington III     job = std::nullopt;
144b22ebbf3SWilliam A. Kennington III     currentStatus =
145b22ebbf3SWilliam A. Kennington III         result == "done" ? ActionStatus::success : ActionStatus::failed;
146b22ebbf3SWilliam A. Kennington III }
147b22ebbf3SWilliam A. Kennington III 
148b22ebbf3SWilliam A. Kennington III std::unique_ptr<TriggerableActionInterface>
149b22ebbf3SWilliam A. Kennington III     SystemdNoFile::CreateSystemdNoFile(sdbusplus::bus::bus&& bus,
150b22ebbf3SWilliam A. Kennington III                                        const std::string& service,
151b22ebbf3SWilliam A. Kennington III                                        const std::string& mode)
152b22ebbf3SWilliam A. Kennington III {
153b22ebbf3SWilliam A. Kennington III     return std::make_unique<SystemdNoFile>(std::move(bus), service, mode);
154b22ebbf3SWilliam A. Kennington III }
155b22ebbf3SWilliam A. Kennington III 
156cf066aceSPatrick Venture std::unique_ptr<TriggerableActionInterface>
157cf066aceSPatrick Venture     SystemdWithStatusFile::CreateSystemdWithStatusFile(
158cf066aceSPatrick Venture         sdbusplus::bus::bus&& bus, const std::string& path,
159cf066aceSPatrick Venture         const std::string& service, const std::string& mode)
160cf066aceSPatrick Venture {
161cf066aceSPatrick Venture     return std::make_unique<SystemdWithStatusFile>(std::move(bus), path,
162cf066aceSPatrick Venture                                                    service, mode);
163cf066aceSPatrick Venture }
164cf066aceSPatrick Venture 
165*93f3c550SWilliam A. Kennington III bool SystemdWithStatusFile::trigger()
166*93f3c550SWilliam A. Kennington III {
167*93f3c550SWilliam A. Kennington III     if (SystemdNoFile::status() != ActionStatus::running)
168*93f3c550SWilliam A. Kennington III     {
169*93f3c550SWilliam A. Kennington III         try
170*93f3c550SWilliam A. Kennington III         {
171*93f3c550SWilliam A. Kennington III             std::ofstream ofs;
172*93f3c550SWilliam A. Kennington III             ofs.open(checkPath);
173*93f3c550SWilliam A. Kennington III             ofs << "unknown";
174*93f3c550SWilliam A. Kennington III         }
175*93f3c550SWilliam A. Kennington III         catch (const std::exception& e)
176*93f3c550SWilliam A. Kennington III         {
177*93f3c550SWilliam A. Kennington III             return false;
178*93f3c550SWilliam A. Kennington III         }
179*93f3c550SWilliam A. Kennington III     }
180*93f3c550SWilliam A. Kennington III     return SystemdNoFile::trigger();
181*93f3c550SWilliam A. Kennington III }
182*93f3c550SWilliam A. Kennington III 
183cf066aceSPatrick Venture ActionStatus SystemdWithStatusFile::status()
184cf066aceSPatrick Venture {
185b22ebbf3SWilliam A. Kennington III     // Assume a status based on job execution if there is no file
186b22ebbf3SWilliam A. Kennington III     ActionStatus result = SystemdNoFile::status() == ActionStatus::running
187b22ebbf3SWilliam A. Kennington III                               ? ActionStatus::running
188b22ebbf3SWilliam A. Kennington III                               : ActionStatus::failed;
189cf066aceSPatrick Venture 
190cf066aceSPatrick Venture     std::ifstream ifs;
191cf066aceSPatrick Venture     ifs.open(checkPath);
192cf066aceSPatrick Venture     if (ifs.good())
193cf066aceSPatrick Venture     {
194cf066aceSPatrick Venture         /*
195cf066aceSPatrick Venture          * Check for the contents of the file, accepting:
196cf066aceSPatrick Venture          * running, success, or failed.
197cf066aceSPatrick Venture          */
198cf066aceSPatrick Venture         std::string status;
199cf066aceSPatrick Venture         ifs >> status;
200cf066aceSPatrick Venture         if (status == "running")
201cf066aceSPatrick Venture         {
202cf066aceSPatrick Venture             result = ActionStatus::running;
203cf066aceSPatrick Venture         }
204cf066aceSPatrick Venture         else if (status == "success")
205cf066aceSPatrick Venture         {
206cf066aceSPatrick Venture             result = ActionStatus::success;
207cf066aceSPatrick Venture         }
208cf066aceSPatrick Venture         else if (status == "failed")
209cf066aceSPatrick Venture         {
210cf066aceSPatrick Venture             result = ActionStatus::failed;
211cf066aceSPatrick Venture         }
212*93f3c550SWilliam A. Kennington III         else
213*93f3c550SWilliam A. Kennington III         {
214*93f3c550SWilliam A. Kennington III             result = ActionStatus::unknown;
215*93f3c550SWilliam A. Kennington III         }
216cf066aceSPatrick Venture     }
217cf066aceSPatrick Venture 
218cf066aceSPatrick Venture     return result;
219cf066aceSPatrick Venture }
220cf066aceSPatrick Venture 
221cf066aceSPatrick Venture } // namespace ipmi_flash
222