blob: 94d97f51be84cc42d4dc0767a9de02b387e23be9 [file] [log] [blame]
Lei YU01539e72019-07-31 10:57:38 +08001#pragma once
2
3#include "config.h"
4
5#include "activation.hpp"
Lei YU7f2a2152019-09-16 16:50:18 +08006#include "association_interface.hpp"
Lei YU91029442019-08-01 15:57:31 +08007#include "types.hpp"
Lei YU5e0dcb32019-08-02 18:04:34 +08008#include "utils.hpp"
Lei YU01539e72019-07-31 10:57:38 +08009#include "version.hpp"
10
Lei YU58c26e32019-09-27 17:52:06 +080011#include <filesystem>
Lei YU5e0dcb32019-08-02 18:04:34 +080012#include <phosphor-logging/log.hpp>
Lei YU01539e72019-07-31 10:57:38 +080013#include <sdbusplus/server.hpp>
Lei YU91029442019-08-01 15:57:31 +080014#include <xyz/openbmc_project/Association/Definitions/server.hpp>
Lei YU01539e72019-07-31 10:57:38 +080015#include <xyz/openbmc_project/Collection/DeleteAll/server.hpp>
16
Lei YUf77189f2019-08-07 14:26:30 +080017class TestItemUpdater;
18
Lei YU01539e72019-07-31 10:57:38 +080019namespace phosphor
20{
21namespace software
22{
23namespace updater
24{
25
26class Version;
27
28using ItemUpdaterInherit = sdbusplus::server::object::object<
Lei YUa5c47bb2019-09-29 11:28:53 +080029 sdbusplus::xyz::openbmc_project::Association::server::Definitions>;
30
Lei YU01539e72019-07-31 10:57:38 +080031namespace MatchRules = sdbusplus::bus::match::rules;
32
Lei YU58c26e32019-09-27 17:52:06 +080033namespace fs = std::filesystem;
34
Lei YU01539e72019-07-31 10:57:38 +080035/** @class ItemUpdater
36 * @brief Manages the activation of the PSU version items.
37 */
Lei YUffb36532019-10-15 13:55:24 +080038class ItemUpdater : public ItemUpdaterInherit,
39 public AssociationInterface,
40 public ActivationListener
Lei YU01539e72019-07-31 10:57:38 +080041{
Lei YUf77189f2019-08-07 14:26:30 +080042 friend class ::TestItemUpdater;
43
Lei YU01539e72019-07-31 10:57:38 +080044 public:
45 /** @brief Constructs ItemUpdater
46 *
47 * @param[in] bus - The D-Bus bus object
48 * @param[in] path - The D-Bus path
49 */
50 ItemUpdater(sdbusplus::bus::bus& bus, const std::string& path) :
51 ItemUpdaterInherit(bus, path.c_str()), bus(bus),
52 versionMatch(bus,
53 MatchRules::interfacesAdded() +
54 MatchRules::path(SOFTWARE_OBJPATH),
55 std::bind(std::mem_fn(&ItemUpdater::createActivation),
56 this, std::placeholders::_1))
57 {
Lei YUad90ad52019-08-06 11:19:28 +080058 processPSUImage();
Lei YU58c26e32019-09-27 17:52:06 +080059 processStoredImage();
Lei YU63f9e712019-10-12 15:16:55 +080060 syncToLatestImage();
Lei YU01539e72019-07-31 10:57:38 +080061 }
62
63 /** @brief Deletes version
64 *
65 * @param[in] versionId - Id of the version to delete
66 */
Lei YUa5c47bb2019-09-29 11:28:53 +080067 void erase(const std::string& versionId);
Lei YU01539e72019-07-31 10:57:38 +080068
Lei YU91029442019-08-01 15:57:31 +080069 /** @brief Creates an active association to the
70 * newly active software image
71 *
72 * @param[in] path - The path to create the association to.
73 */
Lei YU7f2a2152019-09-16 16:50:18 +080074 void createActiveAssociation(const std::string& path) override;
Lei YU91029442019-08-01 15:57:31 +080075
Lei YUad90ad52019-08-06 11:19:28 +080076 /** @brief Add the functional association to the
Lei YU91029442019-08-01 15:57:31 +080077 * new "running" PSU images
78 *
Lei YUad90ad52019-08-06 11:19:28 +080079 * @param[in] path - The path to add the association to.
Lei YU91029442019-08-01 15:57:31 +080080 */
Lei YU7f2a2152019-09-16 16:50:18 +080081 void addFunctionalAssociation(const std::string& path) override;
Lei YU91029442019-08-01 15:57:31 +080082
Lei YUa8b966f2020-03-18 10:32:24 +080083 /** @brief Add the updateable association to the
84 * "running" PSU software image
85 *
86 * @param[in] path - The path to create the association.
87 */
88 void addUpdateableAssociation(const std::string& path) override;
89
Lei YU91029442019-08-01 15:57:31 +080090 /** @brief Removes the associations from the provided software image path
91 *
92 * @param[in] path - The path to remove the association from.
93 */
Lei YU7f2a2152019-09-16 16:50:18 +080094 void removeAssociation(const std::string& path) override;
Lei YU91029442019-08-01 15:57:31 +080095
Lei YUffb36532019-10-15 13:55:24 +080096 /** @brief Notify a PSU is updated
97 *
98 * @param[in] versionId - The versionId of the activation
99 * @param[in] psuInventoryPath - The PSU inventory path that is updated
100 */
101 void onUpdateDone(const std::string& versionId,
102 const std::string& psuInventoryPath) override;
103
Lei YU7f2a2152019-09-16 16:50:18 +0800104 private:
Lei YU01539e72019-07-31 10:57:38 +0800105 /** @brief Callback function for Software.Version match.
106 * @details Creates an Activation D-Bus object.
107 *
108 * @param[in] msg - Data associated with subscribed signal
109 */
110 void createActivation(sdbusplus::message::message& msg);
111
Lei YUa2c2cd72019-08-09 15:54:10 +0800112 using Properties =
113 std::map<std::string, utils::UtilsInterface::PropertyType>;
114
Lei YUad90ad52019-08-06 11:19:28 +0800115 /** @brief Callback function for PSU inventory match.
116 * @details Update an Activation D-Bus object for PSU inventory.
117 *
118 * @param[in] msg - Data associated with subscribed signal
119 */
Lei YUa2c2cd72019-08-09 15:54:10 +0800120 void onPsuInventoryChangedMsg(sdbusplus::message::message& msg);
121
122 /** @brief Callback function for PSU inventory match.
123 * @details Update an Activation D-Bus object for PSU inventory.
124 *
125 * @param[in] psuPath - The PSU inventory path
126 * @param[in] properties - The updated properties
127 */
128 void onPsuInventoryChanged(const std::string& psuPath,
129 const Properties& properties);
Lei YUad90ad52019-08-06 11:19:28 +0800130
Lei YU01539e72019-07-31 10:57:38 +0800131 /** @brief Create Activation object */
132 std::unique_ptr<Activation> createActivationObject(
133 const std::string& path, const std::string& versionId,
Lei YU58c26e32019-09-27 17:52:06 +0800134 const std::string& extVersion, Activation::Status activationStatus,
Lei YU99301372019-09-29 16:27:12 +0800135 const AssociationList& assocs, const std::string& filePath);
Lei YU01539e72019-07-31 10:57:38 +0800136
137 /** @brief Create Version object */
138 std::unique_ptr<Version>
139 createVersionObject(const std::string& objPath,
140 const std::string& versionId,
141 const std::string& versionString,
142 sdbusplus::xyz::openbmc_project::Software::server::
Lei YU99301372019-09-29 16:27:12 +0800143 Version::VersionPurpose versionPurpose);
Lei YU01539e72019-07-31 10:57:38 +0800144
Lei YUbd3b0072019-08-08 13:09:50 +0800145 /** @brief Create Activation and Version object for PSU inventory
146 * @details If the same version exists for multiple PSUs, just add
147 * related association, instead of creating new objects.
148 * */
Lei YUad90ad52019-08-06 11:19:28 +0800149 void createPsuObject(const std::string& psuInventoryPath,
150 const std::string& psuVersion);
151
Lei YUbd3b0072019-08-08 13:09:50 +0800152 /** @brief Remove Activation and Version object for PSU inventory
153 * @details If the same version exists for mutliple PSUs, just remove
154 * related association.
155 * If the version has no association, the Activation and
156 * Version object will be removed
157 */
158 void removePsuObject(const std::string& psuInventoryPath);
159
Lei YUad90ad52019-08-06 11:19:28 +0800160 /**
161 * @brief Create and populate the active PSU Version.
162 */
163 void processPSUImage();
164
Lei YU58c26e32019-09-27 17:52:06 +0800165 /** @brief Create PSU Version from stored images */
166 void processStoredImage();
167
168 /** @brief Scan a directory and create PSU Version from stored images */
169 void scanDirectory(const fs::path& p);
170
Lei YU65207482019-10-11 16:39:36 +0800171 /** @brief Get the versionId of the latest PSU version */
172 std::optional<std::string> getLatestVersionId();
173
Lei YU63f9e712019-10-12 15:16:55 +0800174 /** @brief Update PSUs to the latest version */
175 void syncToLatestImage();
176
177 /** @brief Invoke the activation via DBus */
178 void invokeActivation(const std::unique_ptr<Activation>& activation);
179
Lei YU01539e72019-07-31 10:57:38 +0800180 /** @brief Persistent sdbusplus D-Bus bus connection. */
181 sdbusplus::bus::bus& bus;
182
183 /** @brief Persistent map of Activation D-Bus objects and their
184 * version id */
185 std::map<std::string, std::unique_ptr<Activation>> activations;
186
187 /** @brief Persistent map of Version D-Bus objects and their
188 * version id */
189 std::map<std::string, std::unique_ptr<Version>> versions;
190
Lei YUbd3b0072019-08-08 13:09:50 +0800191 /** @brief The reference map of PSU Inventory objects and the
192 * Activation*/
193 std::map<std::string, const std::unique_ptr<Activation>&>
194 psuPathActivationMap;
195
Lei YUad90ad52019-08-06 11:19:28 +0800196 /** @brief sdbusplus signal match for PSU Software*/
Lei YU01539e72019-07-31 10:57:38 +0800197 sdbusplus::bus::match_t versionMatch;
Lei YU91029442019-08-01 15:57:31 +0800198
Lei YUad90ad52019-08-06 11:19:28 +0800199 /** @brief sdbusplus signal matches for PSU Inventory */
200 std::vector<sdbusplus::bus::match_t> psuMatches;
201
Lei YU91029442019-08-01 15:57:31 +0800202 /** @brief This entry's associations */
203 AssociationList assocs;
Lei YU65207482019-10-11 16:39:36 +0800204
205 /** @brief A collection of the version strings */
206 std::set<std::string> versionStrings;
Lei YU1517f5f2019-10-14 16:44:42 +0800207
208 /** @brief A struct to hold the PSU present status and model */
209 struct psuStatus
210 {
211 bool present;
212 std::string model;
213 };
214
215 /** @brief The map of PSU inventory path and the psuStatus
216 *
217 * It is used to handle psu inventory changed event, that only create psu
218 * software object when a PSU is present and the model is retrieved */
219 std::map<std::string, psuStatus> psuStatusMap;
Lei YU01539e72019-07-31 10:57:38 +0800220};
221
222} // namespace updater
223} // namespace software
224} // namespace phosphor