1 #pragma once 2 3 #include "config.h" 4 5 #include "activation.hpp" 6 #include "association_interface.hpp" 7 #include "types.hpp" 8 #include "utils.hpp" 9 #include "version.hpp" 10 11 #include <filesystem> 12 #include <phosphor-logging/log.hpp> 13 #include <sdbusplus/server.hpp> 14 #include <xyz/openbmc_project/Association/Definitions/server.hpp> 15 #include <xyz/openbmc_project/Collection/DeleteAll/server.hpp> 16 17 class TestItemUpdater; 18 19 namespace phosphor 20 { 21 namespace software 22 { 23 namespace updater 24 { 25 26 class Version; 27 28 using ItemUpdaterInherit = sdbusplus::server::object::object< 29 sdbusplus::xyz::openbmc_project::Association::server::Definitions>; 30 31 namespace MatchRules = sdbusplus::bus::match::rules; 32 33 namespace fs = std::filesystem; 34 35 /** @class ItemUpdater 36 * @brief Manages the activation of the PSU version items. 37 */ 38 class ItemUpdater : public ItemUpdaterInherit, 39 public AssociationInterface, 40 public ActivationListener 41 { 42 friend class ::TestItemUpdater; 43 44 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 { 58 processPSUImage(); 59 processStoredImage(); 60 syncToLatestImage(); 61 } 62 63 /** @brief Deletes version 64 * 65 * @param[in] versionId - Id of the version to delete 66 */ 67 void erase(const std::string& versionId); 68 69 /** @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 */ 74 void createActiveAssociation(const std::string& path) override; 75 76 /** @brief Add the functional association to the 77 * new "running" PSU images 78 * 79 * @param[in] path - The path to add the association to. 80 */ 81 void addFunctionalAssociation(const std::string& path) override; 82 83 /** @brief Removes the associations from the provided software image path 84 * 85 * @param[in] path - The path to remove the association from. 86 */ 87 void removeAssociation(const std::string& path) override; 88 89 /** @brief Notify a PSU is updated 90 * 91 * @param[in] versionId - The versionId of the activation 92 * @param[in] psuInventoryPath - The PSU inventory path that is updated 93 */ 94 void onUpdateDone(const std::string& versionId, 95 const std::string& psuInventoryPath) override; 96 97 private: 98 /** @brief Callback function for Software.Version match. 99 * @details Creates an Activation D-Bus object. 100 * 101 * @param[in] msg - Data associated with subscribed signal 102 */ 103 void createActivation(sdbusplus::message::message& msg); 104 105 using Properties = 106 std::map<std::string, utils::UtilsInterface::PropertyType>; 107 108 /** @brief Callback function for PSU inventory match. 109 * @details Update an Activation D-Bus object for PSU inventory. 110 * 111 * @param[in] msg - Data associated with subscribed signal 112 */ 113 void onPsuInventoryChangedMsg(sdbusplus::message::message& msg); 114 115 /** @brief Callback function for PSU inventory match. 116 * @details Update an Activation D-Bus object for PSU inventory. 117 * 118 * @param[in] psuPath - The PSU inventory path 119 * @param[in] properties - The updated properties 120 */ 121 void onPsuInventoryChanged(const std::string& psuPath, 122 const Properties& properties); 123 124 /** @brief Create Activation object */ 125 std::unique_ptr<Activation> createActivationObject( 126 const std::string& path, const std::string& versionId, 127 const std::string& extVersion, Activation::Status activationStatus, 128 const AssociationList& assocs, const std::string& filePath); 129 130 /** @brief Create Version object */ 131 std::unique_ptr<Version> 132 createVersionObject(const std::string& objPath, 133 const std::string& versionId, 134 const std::string& versionString, 135 sdbusplus::xyz::openbmc_project::Software::server:: 136 Version::VersionPurpose versionPurpose); 137 138 /** @brief Create Activation and Version object for PSU inventory 139 * @details If the same version exists for multiple PSUs, just add 140 * related association, instead of creating new objects. 141 * */ 142 void createPsuObject(const std::string& psuInventoryPath, 143 const std::string& psuVersion); 144 145 /** @brief Remove Activation and Version object for PSU inventory 146 * @details If the same version exists for mutliple PSUs, just remove 147 * related association. 148 * If the version has no association, the Activation and 149 * Version object will be removed 150 */ 151 void removePsuObject(const std::string& psuInventoryPath); 152 153 /** 154 * @brief Create and populate the active PSU Version. 155 */ 156 void processPSUImage(); 157 158 /** @brief Create PSU Version from stored images */ 159 void processStoredImage(); 160 161 /** @brief Scan a directory and create PSU Version from stored images */ 162 void scanDirectory(const fs::path& p); 163 164 /** @brief Get the versionId of the latest PSU version */ 165 std::optional<std::string> getLatestVersionId(); 166 167 /** @brief Update PSUs to the latest version */ 168 void syncToLatestImage(); 169 170 /** @brief Invoke the activation via DBus */ 171 void invokeActivation(const std::unique_ptr<Activation>& activation); 172 173 /** @brief Persistent sdbusplus D-Bus bus connection. */ 174 sdbusplus::bus::bus& bus; 175 176 /** @brief Persistent map of Activation D-Bus objects and their 177 * version id */ 178 std::map<std::string, std::unique_ptr<Activation>> activations; 179 180 /** @brief Persistent map of Version D-Bus objects and their 181 * version id */ 182 std::map<std::string, std::unique_ptr<Version>> versions; 183 184 /** @brief The reference map of PSU Inventory objects and the 185 * Activation*/ 186 std::map<std::string, const std::unique_ptr<Activation>&> 187 psuPathActivationMap; 188 189 /** @brief sdbusplus signal match for PSU Software*/ 190 sdbusplus::bus::match_t versionMatch; 191 192 /** @brief sdbusplus signal matches for PSU Inventory */ 193 std::vector<sdbusplus::bus::match_t> psuMatches; 194 195 /** @brief This entry's associations */ 196 AssociationList assocs; 197 198 /** @brief A collection of the version strings */ 199 std::set<std::string> versionStrings; 200 201 /** @brief A struct to hold the PSU present status and model */ 202 struct psuStatus 203 { 204 bool present; 205 std::string model; 206 }; 207 208 /** @brief The map of PSU inventory path and the psuStatus 209 * 210 * It is used to handle psu inventory changed event, that only create psu 211 * software object when a PSU is present and the model is retrieved */ 212 std::map<std::string, psuStatus> psuStatusMap; 213 }; 214 215 } // namespace updater 216 } // namespace software 217 } // namespace phosphor 218