1 #include "config.h"
2 
3 #include "activation.hpp"
4 
5 #include "utils.hpp"
6 
7 #include <cassert>
8 #include <filesystem>
9 #include <phosphor-logging/elog-errors.hpp>
10 #include <phosphor-logging/log.hpp>
11 
12 namespace phosphor
13 {
14 namespace software
15 {
16 namespace updater
17 {
18 
19 constexpr auto SYSTEMD_BUSNAME = "org.freedesktop.systemd1";
20 constexpr auto SYSTEMD_PATH = "/org/freedesktop/systemd1";
21 constexpr auto SYSTEMD_INTERFACE = "org.freedesktop.systemd1.Manager";
22 
23 namespace fs = std::filesystem;
24 namespace softwareServer = sdbusplus::xyz::openbmc_project::Software::server;
25 
26 using namespace phosphor::logging;
27 using sdbusplus::exception::SdBusError;
28 using SoftwareActivation = softwareServer::Activation;
29 
30 auto Activation::activation(Activations value) -> Activations
31 {
32     if (value == Status::Activating)
33     {
34         value = startActivation();
35     }
36     else
37     {
38         activationBlocksTransition.reset();
39         activationProgress.reset();
40     }
41 
42     return SoftwareActivation::activation(value);
43 }
44 
45 auto Activation::requestedActivation(RequestedActivations value)
46     -> RequestedActivations
47 {
48     if ((value == SoftwareActivation::RequestedActivations::Active) &&
49         (SoftwareActivation::requestedActivation() !=
50          SoftwareActivation::RequestedActivations::Active))
51     {
52         // PSU image could be activated even when it's in active,
53         // e.g. in case a PSU is replaced and has a older image, it will be
54         // updated with the running PSU image that is stored in BMC.
55         if ((activation() == Status::Ready) ||
56             (activation() == Status::Failed) || activation() == Status::Active)
57         {
58             activation(Status::Activating);
59         }
60     }
61     return SoftwareActivation::requestedActivation(value);
62 }
63 
64 void Activation::unitStateChange(sdbusplus::message::message& msg)
65 {
66     uint32_t newStateID{};
67     sdbusplus::message::object_path newStateObjPath;
68     std::string newStateUnit{};
69     std::string newStateResult{};
70 
71     // Read the msg and populate each variable
72     msg.read(newStateID, newStateObjPath, newStateUnit, newStateResult);
73 
74     if (newStateUnit == psuUpdateUnit)
75     {
76         if (newStateResult == "done")
77         {
78             onUpdateDone();
79         }
80         if (newStateResult == "failed" || newStateResult == "dependency")
81         {
82             onUpdateFailed();
83         }
84     }
85 }
86 
87 bool Activation::doUpdate(const std::string& psuInventoryPath)
88 {
89     currentUpdatingPsu = psuInventoryPath;
90     psuUpdateUnit = getUpdateService(currentUpdatingPsu);
91     try
92     {
93         auto method = bus.new_method_call(SYSTEMD_BUSNAME, SYSTEMD_PATH,
94                                           SYSTEMD_INTERFACE, "StartUnit");
95         method.append(psuUpdateUnit, "replace");
96         bus.call_noreply(method);
97         return true;
98     }
99     catch (const SdBusError& e)
100     {
101         log<level::ERR>("Error staring service", entry("ERROR=%s", e.what()));
102         onUpdateFailed();
103         return false;
104     }
105 }
106 
107 bool Activation::doUpdate()
108 {
109     // When the queue is empty, all updates are done
110     if (psuQueue.empty())
111     {
112         finishActivation();
113         return true;
114     }
115 
116     // Do the update on a PSU
117     const auto& psu = psuQueue.front();
118     return doUpdate(psu);
119 }
120 
121 void Activation::onUpdateDone()
122 {
123     auto progress = activationProgress->progress() + progressStep;
124     activationProgress->progress(progress);
125 
126     // Update the activation association
127     auto assocs = associations();
128     assocs.emplace_back(ACTIVATION_FWD_ASSOCIATION, ACTIVATION_REV_ASSOCIATION,
129                         currentUpdatingPsu);
130     associations(assocs);
131 
132     activationListener->onUpdateDone(versionId, currentUpdatingPsu);
133     currentUpdatingPsu.clear();
134 
135     psuQueue.pop();
136     doUpdate(); // Update the next psu
137 }
138 
139 void Activation::onUpdateFailed()
140 {
141     // TODO: report an event
142     log<level::ERR>("Failed to udpate PSU",
143                     entry("PSU=%s", psuQueue.front().c_str()));
144     std::queue<std::string>().swap(psuQueue); // Clear the queue
145     activation(Status::Failed);
146 }
147 
148 Activation::Status Activation::startActivation()
149 {
150     // Check if the activation has file path
151     if (path().empty())
152     {
153         log<level::WARNING>("No image for the activation, skipped",
154                             entry("VERSION_ID=%s", versionId.c_str()));
155         return activation(); // Return the previous activation status
156     }
157     if (!activationProgress)
158     {
159         activationProgress = std::make_unique<ActivationProgress>(bus, objPath);
160     }
161     if (!activationBlocksTransition)
162     {
163         activationBlocksTransition =
164             std::make_unique<ActivationBlocksTransition>(bus, objPath);
165     }
166 
167     auto psuPaths = utils::getPSUInventoryPath(bus);
168     if (psuPaths.empty())
169     {
170         log<level::WARNING>("No PSU inventory found");
171         return Status::Failed;
172     }
173 
174     for (const auto& p : psuPaths)
175     {
176         if (isCompatible(p))
177         {
178             if (utils::isAssociated(p, associations()))
179             {
180                 log<level::NOTICE>("PSU already running the image, skipping",
181                                    entry("PSU=%s", p.c_str()));
182                 continue;
183             }
184             psuQueue.push(p);
185         }
186         else
187         {
188             log<level::NOTICE>("PSU not compatible",
189                                entry("PSU=%s", p.c_str()));
190         }
191     }
192 
193     if (psuQueue.empty())
194     {
195         log<level::WARNING>("No PSU compatible with the software");
196         return activation(); // Return the previous activation status
197     }
198 
199     // The progress to be increased for each successful update of PSU
200     // E.g. in case we have 4 PSUs:
201     //   1. Initial progrss is 10
202     //   2. Add 20 after each update is done, so we will see progress to be 30,
203     //      50, 70, 90
204     //   3. When all PSUs are updated, it will be 100 and the interface is
205     //   removed.
206     progressStep = 80 / psuQueue.size();
207     if (doUpdate())
208     {
209         activationProgress->progress(10);
210         return Status::Activating;
211     }
212     else
213     {
214         return Status::Failed;
215     }
216 }
217 
218 void Activation::finishActivation()
219 {
220     storeImage();
221     activationProgress->progress(100);
222 
223     deleteImageManagerObject();
224 
225     associationInterface->createActiveAssociation(objPath);
226     associationInterface->addFunctionalAssociation(objPath);
227 
228     // Reset RequestedActivations to none so that it could be activated in
229     // future
230     requestedActivation(SoftwareActivation::RequestedActivations::None);
231     activation(Status::Active);
232 }
233 
234 void Activation::deleteImageManagerObject()
235 {
236     // Get the Delete object for <versionID> inside image_manager
237     constexpr auto versionServiceStr = "xyz.openbmc_project.Software.Version";
238     constexpr auto deleteInterface = "xyz.openbmc_project.Object.Delete";
239     std::string versionService;
240     auto services = utils::getServices(bus, objPath.c_str(), deleteInterface);
241 
242     // We need to find the phosphor-version-software-manager's version service
243     // to invoke the delete interface
244     for (const auto& service : services)
245     {
246         if (service.find(versionServiceStr) != std::string::npos)
247         {
248             versionService = service;
249             break;
250         }
251     }
252     if (versionService.empty())
253     {
254         // When updating a stored image, there is no version object created by
255         // "xyz.openbmc_project.Software.Version" service, so skip it.
256         return;
257     }
258 
259     // Call the Delete object for <versionID> inside image_manager
260     auto method = bus.new_method_call(versionService.c_str(), objPath.c_str(),
261                                       deleteInterface, "Delete");
262     try
263     {
264         bus.call(method);
265     }
266     catch (const SdBusError& e)
267     {
268         log<level::ERR>("Error performing call to Delete object path",
269                         entry("ERROR=%s", e.what()),
270                         entry("PATH=%s", objPath.c_str()));
271     }
272 }
273 
274 bool Activation::isCompatible(const std::string& psuInventoryPath)
275 {
276     auto service =
277         utils::getService(bus, psuInventoryPath.c_str(), ASSET_IFACE);
278     auto psuManufacturer = utils::getProperty<std::string>(
279         bus, service.c_str(), psuInventoryPath.c_str(), ASSET_IFACE,
280         MANUFACTURER);
281     auto psuModel = utils::getProperty<std::string>(
282         bus, service.c_str(), psuInventoryPath.c_str(), ASSET_IFACE, MODEL);
283     if (psuModel != model)
284     {
285         // The model shall match
286         return false;
287     }
288     if (!psuManufacturer.empty())
289     {
290         // If PSU inventory has manufacturer property, it shall match
291         return psuManufacturer == manufacturer;
292     }
293     return true;
294 }
295 
296 void Activation::storeImage()
297 {
298     // Store image in persistent dir separated by model
299     // and only store the latest one by removing old ones
300     auto src = path();
301     auto dst = fs::path(IMG_DIR_PERSIST) / model;
302     if (src == dst)
303     {
304         // This happens when updating an stored image, no need to store it again
305         return;
306     }
307     try
308     {
309         fs::remove_all(dst);
310         fs::create_directories(dst);
311         fs::copy(src, dst);
312         path(dst.string()); // Update the FilePath interface
313     }
314     catch (const fs::filesystem_error& e)
315     {
316         log<level::ERR>("Error storing PSU image", entry("ERROR=%s", e.what()),
317                         entry("SRC=%s", src.c_str()),
318                         entry("DST=%s", dst.c_str()));
319     }
320 }
321 
322 std::string Activation::getUpdateService(const std::string& psuInventoryPath)
323 {
324     fs::path imagePath(path());
325 
326     // The systemd unit shall be escaped
327     std::string args = psuInventoryPath;
328     args += "\\x20";
329     args += imagePath;
330     std::replace(args.begin(), args.end(), '/', '-');
331 
332     std::string service = PSU_UPDATE_SERVICE;
333     auto p = service.find('@');
334     assert(p != std::string::npos);
335     service.insert(p + 1, args);
336     return service;
337 }
338 
339 } // namespace updater
340 } // namespace software
341 } // namespace phosphor
342