1 #pragma once 2 3 #include "activation.hpp" 4 #include "version.hpp" 5 #include "xyz/openbmc_project/Collection/DeleteAll/server.hpp" 6 7 #include <sdbusplus/server.hpp> 8 #include <xyz/openbmc_project/Association/Definitions/server.hpp> 9 #include <xyz/openbmc_project/Common/FactoryReset/server.hpp> 10 #include <xyz/openbmc_project/Object/Enable/server.hpp> 11 12 #include <string> 13 14 namespace openpower 15 { 16 namespace software 17 { 18 namespace updater 19 { 20 21 using ItemUpdaterInherit = sdbusplus::server::object::object< 22 sdbusplus::xyz::openbmc_project::Common::server::FactoryReset, 23 sdbusplus::xyz::openbmc_project::Association::server::Definitions, 24 sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>; 25 using GardResetInherit = sdbusplus::server::object::object< 26 sdbusplus::xyz::openbmc_project::Common::server::FactoryReset>; 27 using ObjectEnable = sdbusplus::server::object::object< 28 sdbusplus::xyz::openbmc_project::Object::server::Enable>; 29 namespace MatchRules = sdbusplus::bus::match::rules; 30 31 using AssociationList = 32 std::vector<std::tuple<std::string, std::string, std::string>>; 33 34 constexpr auto GARD_PATH = "/org/open_power/control/gard"; 35 constexpr static auto volatilePath = "/org/open_power/control/volatile"; 36 37 /** @class GardReset 38 * @brief OpenBMC GARD factory reset implementation. 39 * @details An implementation of xyz.openbmc_project.Common.FactoryReset under 40 * /org/openpower/control/gard. 41 */ 42 class GardReset : public GardResetInherit 43 { 44 public: 45 /** @brief Constructs GardReset. 46 * 47 * @param[in] bus - The Dbus bus object 48 * @param[in] path - The Dbus object path 49 */ 50 GardReset(sdbusplus::bus::bus& bus, const std::string& path) : 51 GardResetInherit(bus, path.c_str(), true), bus(bus), path(path) 52 { 53 std::vector<std::string> interfaces({interface}); 54 bus.emit_interfaces_added(path.c_str(), interfaces); 55 } 56 57 virtual ~GardReset() 58 { 59 std::vector<std::string> interfaces({interface}); 60 bus.emit_interfaces_removed(path.c_str(), interfaces); 61 } 62 63 protected: 64 // TODO Remove once openbmc/openbmc#1975 is resolved 65 static constexpr auto interface = "xyz.openbmc_project.Common.FactoryReset"; 66 sdbusplus::bus::bus& bus; 67 std::string path; 68 69 /** 70 * @brief GARD factory reset - clears the PNOR GARD partition. 71 */ 72 virtual void reset() = 0; 73 }; 74 75 /** @class ItemUpdater 76 * @brief Manages the activation of the host version items. 77 */ 78 class ItemUpdater : public ItemUpdaterInherit 79 { 80 public: 81 /** @brief Constructs ItemUpdater 82 * 83 * @param[in] bus - The D-Bus bus object 84 * @param[in] path - The D-Bus path 85 */ 86 ItemUpdater(sdbusplus::bus::bus& bus, const std::string& path) : 87 ItemUpdaterInherit(bus, path.c_str()), bus(bus), 88 versionMatch(bus, 89 MatchRules::interfacesAdded() + 90 MatchRules::path("/xyz/openbmc_project/software"), 91 std::bind(std::mem_fn(&ItemUpdater::createActivation), 92 this, std::placeholders::_1)) 93 {} 94 95 virtual ~ItemUpdater() = default; 96 97 /** @brief Sets the given priority free by incrementing 98 * any existing priority with the same value by 1. It will then continue 99 * to resolve duplicate priorities caused by this increase, by increasing 100 * the priority by 1 until there are no more duplicate values. 101 * 102 * @param[in] value - The priority that needs to be set free. 103 * @param[in] versionId - The Id of the version for which we 104 * are trying to free up the priority. 105 * @return None 106 */ 107 virtual void freePriority(uint8_t value, const std::string& versionId) = 0; 108 109 /** 110 * @brief Create and populate the active PNOR Version. 111 */ 112 virtual void processPNORImage() = 0; 113 114 /** @brief Deletes version 115 * 116 * @param[in] entryId - Id of the version to delete 117 * 118 * @return - Returns true if the version is deleted. 119 */ 120 virtual bool erase(std::string entryId); 121 122 /** 123 * @brief Erases any non-active pnor versions. 124 */ 125 virtual void deleteAll() = 0; 126 127 /** @brief Brings the total number of active PNOR versions to 128 * ACTIVE_PNOR_MAX_ALLOWED -1. This function is intended to be 129 * run before activating a new PNOR version. If this function 130 * needs to delete any PNOR version(s) it will delete the 131 * version(s) with the highest priority, skipping the 132 * functional PNOR version. 133 * 134 * @return - Return if space is freed or not 135 */ 136 virtual bool freeSpace() = 0; 137 138 /** @brief Creates an active association to the 139 * newly active software image 140 * 141 * @param[in] path - The path to create the association to. 142 */ 143 virtual void createActiveAssociation(const std::string& path); 144 145 /** @brief Creates a updateable association to the 146 * "running" BMC software image 147 * 148 * @param[in] path - The path to create the association. 149 */ 150 virtual void createUpdateableAssociation(const std::string& path); 151 152 /** @brief Updates the functional association to the 153 * new "running" PNOR image 154 * 155 * @param[in] versionId - The id of the image to update the association to. 156 */ 157 virtual void updateFunctionalAssociation(const std::string& versionId); 158 159 /** @brief Removes the associations from the provided software image path 160 * 161 * @param[in] path - The path to remove the association from. 162 */ 163 virtual void removeAssociation(const std::string& path); 164 165 /** @brief Persistent GardReset dbus object */ 166 std::unique_ptr<GardReset> gardReset; 167 168 /** @brief Check whether the provided image id is the functional one 169 * 170 * @param[in] - versionId - The id of the image to check. 171 * 172 * @return - Returns true if this version is currently functional. 173 */ 174 virtual bool isVersionFunctional(const std::string& versionId) = 0; 175 176 /** @brief Persistent ObjectEnable D-Bus object */ 177 std::unique_ptr<ObjectEnable> volatileEnable; 178 179 protected: 180 /** @brief Callback function for Software.Version match. 181 * @details Creates an Activation D-Bus object. 182 * 183 * @param[in] msg - Data associated with subscribed signal 184 */ 185 virtual void createActivation(sdbusplus::message::message& msg); 186 187 /** @brief Create Activation object */ 188 virtual std::unique_ptr<Activation> createActivationObject( 189 const std::string& path, const std::string& versionId, 190 const std::string& extVersion, 191 sdbusplus::xyz::openbmc_project::Software::server::Activation:: 192 Activations activationStatus, 193 AssociationList& assocs) = 0; 194 195 /** @brief Create Version object */ 196 virtual std::unique_ptr<Version> 197 createVersionObject(const std::string& objPath, 198 const std::string& versionId, 199 const std::string& versionString, 200 sdbusplus::xyz::openbmc_project::Software::server:: 201 Version::VersionPurpose versionPurpose, 202 const std::string& filePath) = 0; 203 204 /** @brief Validate if image is valid or not */ 205 virtual bool validateImage(const std::string& path) = 0; 206 207 /** @brief Persistent sdbusplus D-Bus bus connection. */ 208 sdbusplus::bus::bus& bus; 209 210 /** @brief Persistent map of Activation D-Bus objects and their 211 * version id */ 212 std::map<std::string, std::unique_ptr<Activation>> activations; 213 214 /** @brief Persistent map of Version D-Bus objects and their 215 * version id */ 216 std::map<std::string, std::unique_ptr<Version>> versions; 217 218 /** @brief sdbusplus signal match for Software.Version */ 219 sdbusplus::bus::match_t versionMatch; 220 221 /** @brief This entry's associations */ 222 AssociationList assocs = {}; 223 224 /** @brief Host factory reset - clears PNOR partitions for each 225 * Activation D-Bus object */ 226 void reset() override = 0; 227 228 /** @brief Check whether the host is running 229 * 230 * @return - Returns true if the Chassis is powered on. 231 */ 232 bool isChassisOn(); 233 }; 234 235 } // namespace updater 236 } // namespace software 237 } // namespace openpower 238