blob: 794aa4d7ef9c1a712ebd3207c0408a2ae572a2e1 [file] [log] [blame]
Gunnar Millsec1b41c2017-05-02 12:20:36 -05001#pragma once
2
Gunnar Millsec1b41c2017-05-02 12:20:36 -05003#include "activation.hpp"
Lei YU56aaf452018-06-21 16:09:44 +08004#include "item_updater_helper.hpp"
Saqib Khan705f1bf2017-06-09 23:58:38 -05005#include "version.hpp"
Gunnar Millsb0ce9962018-09-07 13:39:10 -05006#include "xyz/openbmc_project/Collection/DeleteAll/server.hpp"
7
8#include <sdbusplus/server.hpp>
John Wang85c356f2019-09-11 16:20:13 +08009#include <xyz/openbmc_project/Association/Definitions/server.hpp>
Michael Tritz37a59042017-07-12 13:44:53 -050010#include <xyz/openbmc_project/Common/FactoryReset/server.hpp>
Michael Tritz0129d922017-08-10 19:33:46 -050011#include <xyz/openbmc_project/Control/FieldMode/server.hpp>
Gunnar Millsec1b41c2017-05-02 12:20:36 -050012
Adriana Kobylak58aa7502020-06-08 11:12:11 -050013#include <string>
Bright Cheng8e9ccfe2019-11-18 16:18:44 +080014#include <vector>
Adriana Kobylak58aa7502020-06-08 11:12:11 -050015
Gunnar Millsec1b41c2017-05-02 12:20:36 -050016namespace phosphor
17{
18namespace software
19{
20namespace updater
21{
22
Michael Tritz37a59042017-07-12 13:44:53 -050023using ItemUpdaterInherit = sdbusplus::server::object::object<
Adriana Kobylak2285fe02018-02-27 15:36:59 -060024 sdbusplus::xyz::openbmc_project::Common::server::FactoryReset,
25 sdbusplus::xyz::openbmc_project::Control::server::FieldMode,
John Wang85c356f2019-09-11 16:20:13 +080026 sdbusplus::xyz::openbmc_project::Association::server::Definitions,
Adriana Kobylak2285fe02018-02-27 15:36:59 -060027 sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>;
Michael Tritz37a59042017-07-12 13:44:53 -050028
Patrick Williamse75d10f2017-05-30 16:56:32 -050029namespace MatchRules = sdbusplus::bus::match::rules;
Gunnar Mills48442912017-10-06 13:34:07 -050030using VersionClass = phosphor::software::manager::Version;
Gunnar Millsded875d2017-08-28 16:44:52 -050031using AssociationList =
Adriana Kobylak2285fe02018-02-27 15:36:59 -060032 std::vector<std::tuple<std::string, std::string, std::string>>;
Gunnar Millsded875d2017-08-28 16:44:52 -050033
Gunnar Millsec1b41c2017-05-02 12:20:36 -050034/** @class ItemUpdater
35 * @brief Manages the activation of the BMC version items.
36 */
Michael Tritz37a59042017-07-12 13:44:53 -050037class ItemUpdater : public ItemUpdaterInherit
Gunnar Millsec1b41c2017-05-02 12:20:36 -050038{
Adriana Kobylak2285fe02018-02-27 15:36:59 -060039 public:
40 /*
41 * @brief Types of Activation status for image validation.
42 */
43 enum class ActivationStatus
44 {
45 ready,
46 invalid,
47 active
48 };
Saqib Khan35e83f32017-05-22 11:37:32 -050049
Adriana Kobylak2285fe02018-02-27 15:36:59 -060050 /** @brief Constructs ItemUpdater
51 *
52 * @param[in] bus - The D-Bus bus object
53 */
54 ItemUpdater(sdbusplus::bus::bus& bus, const std::string& path) :
Lei YU56aaf452018-06-21 16:09:44 +080055 ItemUpdaterInherit(bus, path.c_str(), false), bus(bus), helper(bus),
Adriana Kobylak2285fe02018-02-27 15:36:59 -060056 versionMatch(bus,
57 MatchRules::interfacesAdded() +
58 MatchRules::path("/xyz/openbmc_project/software"),
59 std::bind(std::mem_fn(&ItemUpdater::createActivation),
60 this, std::placeholders::_1))
61 {
62 setBMCInventoryPath();
63 processBMCImage();
64 restoreFieldModeStatus();
Lei YU6e9fb1d2021-02-19 18:01:40 +080065#ifdef HOST_BIOS_UPGRADE
66 createBIOSObject();
67#endif
Adriana Kobylak2285fe02018-02-27 15:36:59 -060068 emit_object_added();
69 };
Gunnar Millsec1b41c2017-05-02 12:20:36 -050070
Adriana Kobylakbbcb7be2018-07-17 15:47:34 -050071 /** @brief Save priority value to persistent storage (flash and optionally
72 * a U-Boot environment variable)
73 *
74 * @param[in] versionId - The Id of the version
75 * @param[in] value - The priority value
76 * @return None
77 */
78 void savePriority(const std::string& versionId, uint8_t value);
79
Adriana Kobylak2285fe02018-02-27 15:36:59 -060080 /** @brief Sets the given priority free by incrementing
81 * any existing priority with the same value by 1
82 *
83 * @param[in] value - The priority that needs to be set free.
84 * @param[in] versionId - The Id of the version for which we
85 * are trying to free up the priority.
86 * @return None
87 */
88 void freePriority(uint8_t value, const std::string& versionId);
Saqib Khan4c1aec02017-07-06 11:46:13 -050089
Adriana Kobylak2285fe02018-02-27 15:36:59 -060090 /**
91 * @brief Create and populate the active BMC Version.
92 */
93 void processBMCImage();
Saqib Khanba239882017-05-26 08:41:54 -050094
Adriana Kobylak2285fe02018-02-27 15:36:59 -060095 /**
96 * @brief Erase specified entry D-Bus object
97 * if Action property is not set to Active
98 *
99 * @param[in] entryId - unique identifier of the entry
100 */
101 void erase(std::string entryId);
Leonel Gonzalez3526ef72017-07-07 14:38:25 -0500102
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600103 /**
104 * @brief Deletes all versions except for the current one
105 */
106 void deleteAll();
Gunnar Millsded875d2017-08-28 16:44:52 -0500107
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600108 /** @brief Creates an active association to the
109 * newly active software image
110 *
111 * @param[in] path - The path to create the association to.
112 */
113 void createActiveAssociation(const std::string& path);
Gunnar Millsded875d2017-08-28 16:44:52 -0500114
Adriana Kobylak991af7e2018-12-10 13:08:38 -0600115 /** @brief Removes the associations from the provided software image path
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600116 *
Adriana Kobylak991af7e2018-12-10 13:08:38 -0600117 * @param[in] path - The path to remove the associations from.
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600118 */
Adriana Kobylak991af7e2018-12-10 13:08:38 -0600119 void removeAssociations(const std::string& path);
Gunnar Millsded875d2017-08-28 16:44:52 -0500120
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600121 /** @brief Determine if the given priority is the lowest
122 *
123 * @param[in] value - The priority that needs to be checked.
124 *
125 * @return boolean corresponding to whether the given
126 * priority is lowest.
127 */
128 bool isLowestPriority(uint8_t value);
Saqib Khanb9da6632017-09-13 09:48:37 -0500129
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600130 /**
131 * @brief Updates the U-Boot variables to point to the requested
132 * versionId, so that the systems boots from this version on
133 * the next reboot.
134 *
135 * @param[in] versionId - The version to point the system to boot from.
136 */
137 void updateUbootEnvVars(const std::string& versionId);
Adriana Kobylakb77551c2017-10-27 12:46:23 -0500138
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600139 /**
140 * @brief Updates the uboot variables to point to BMC version with lowest
141 * priority, so that the system boots from this version on the
142 * next boot.
143 */
144 void resetUbootEnvVars();
Saqib Khan49446ae2017-10-02 10:54:20 -0500145
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600146 /** @brief Brings the total number of active BMC versions to
147 * ACTIVE_BMC_MAX_ALLOWED -1. This function is intended to be
148 * run before activating a new BMC version. If this function
149 * needs to delete any BMC version(s) it will delete the
150 * version(s) with the highest priority, skipping the
151 * functional BMC version.
Adriana Kobylaka6963592018-09-07 14:13:29 -0500152 *
153 * @param[in] caller - The Activation object that called this function.
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600154 */
Lei YU0cd6d842021-12-27 11:56:02 +0800155 void freeSpace(const Activation& caller);
Adriana Kobylak204e1e72018-01-24 16:00:05 -0600156
AppaRao Puli1bb6dcb2020-03-27 20:51:57 +0530157 /** @brief Creates a updateable association to the
158 * "running" BMC software image
159 *
160 * @param[in] path - The path to create the association.
161 */
162 void createUpdateableAssociation(const std::string& path);
163
Adriana Kobylakec4eec32019-11-13 14:28:35 -0600164 /** @brief Persistent map of Version D-Bus objects and their
165 * version id */
166 std::map<std::string, std::unique_ptr<VersionClass>> versions;
167
Bright Cheng8e9ccfe2019-11-18 16:18:44 +0800168 /** @brief Vector of needed BMC images in the tarball*/
169 std::vector<std::string> imageUpdateList;
170
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600171 private:
172 /** @brief Callback function for Software.Version match.
173 * @details Creates an Activation D-Bus object.
174 *
175 * @param[in] msg - Data associated with subscribed signal
176 */
177 void createActivation(sdbusplus::message::message& msg);
Gunnar Millsec1b41c2017-05-02 12:20:36 -0500178
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600179 /**
180 * @brief Validates the presence of SquashFS image in the image dir.
181 *
182 * @param[in] filePath - The path to the image dir.
183 * @param[out] result - ActivationStatus Enum.
184 * ready if validation was successful.
185 * invalid if validation fail.
186 * active if image is the current version.
187 *
188 */
189 ActivationStatus validateSquashFSImage(const std::string& filePath);
Saqib Khan35e83f32017-05-22 11:37:32 -0500190
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600191 /** @brief BMC factory reset - marks the read-write partition for
192 * recreation upon reboot. */
193 void reset() override;
Michael Tritz37a59042017-07-12 13:44:53 -0500194
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600195 /**
196 * @brief Enables field mode, if value=true.
197 *
198 * @param[in] value - If true, enables field mode.
199 * @param[out] result - Returns the current state of field mode.
200 *
201 */
202 bool fieldModeEnabled(bool value) override;
Michael Tritz0129d922017-08-10 19:33:46 -0500203
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600204 /** @brief Sets the BMC inventory item path under
205 * /xyz/openbmc_project/inventory/system/chassis/. */
206 void setBMCInventoryPath();
Gunnar Millsb60add12017-08-24 16:41:42 -0500207
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600208 /** @brief The path to the BMC inventory item. */
209 std::string bmcInventoryPath;
Gunnar Millsb60add12017-08-24 16:41:42 -0500210
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600211 /** @brief Restores field mode status on reboot. */
212 void restoreFieldModeStatus();
Michael Tritz0129d922017-08-10 19:33:46 -0500213
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600214 /** @brief Creates a functional association to the
215 * "running" BMC software image
216 *
217 * @param[in] path - The path to create the association to.
218 */
219 void createFunctionalAssociation(const std::string& path);
Gunnar Mills88e8a322017-09-13 11:09:28 -0500220
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600221 /** @brief Persistent sdbusplus D-Bus bus connection. */
222 sdbusplus::bus::bus& bus;
Gunnar Millsec1b41c2017-05-02 12:20:36 -0500223
Lei YU56aaf452018-06-21 16:09:44 +0800224 /** @brief The helper of image updater. */
225 Helper helper;
226
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600227 /** @brief Persistent map of Activation D-Bus objects and their
228 * version id */
229 std::map<std::string, std::unique_ptr<Activation>> activations;
Gunnar Millsec1b41c2017-05-02 12:20:36 -0500230
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600231 /** @brief sdbusplus signal match for Software.Version */
232 sdbusplus::bus::match_t versionMatch;
Gunnar Millsec1b41c2017-05-02 12:20:36 -0500233
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600234 /** @brief This entry's associations */
235 AssociationList assocs = {};
Gunnar Millsded875d2017-08-28 16:44:52 -0500236
Adriana Kobylak2285fe02018-02-27 15:36:59 -0600237 /** @brief Clears read only partition for
238 * given Activation D-Bus object.
239 *
240 * @param[in] versionId - The version id.
241 */
242 void removeReadOnlyPartition(std::string versionId);
Eddie Jameseaa1ee02018-03-01 10:09:10 -0600243
244 /** @brief Copies U-Boot from the currently booted BMC chip to the
245 * alternate chip.
246 */
247 void mirrorUbootToAlt();
Bright Cheng8e9ccfe2019-11-18 16:18:44 +0800248
249 /** @brief Check the required image files
250 *
251 * @param[in] filePath - BMC tarball file path
252 * @param[in] imageList - Image filenames included in the BMC tarball
253 * @param[out] result - Boolean
254 * true if all image files are found in BMC tarball
255 * false if one of image files is missing
256 */
257 bool checkImage(const std::string& filePath,
258 const std::vector<std::string>& imageList);
Lei YU6e9fb1d2021-02-19 18:01:40 +0800259
260#ifdef HOST_BIOS_UPGRADE
261 /** @brief Create the BIOS object without knowing the version.
262 *
263 * The object is created only to provide the DBus access so that an
264 * external service could set the correct BIOS version.
265 * On BIOS code update, the version is updated accordingly.
266 */
267 void createBIOSObject();
268
269 /** @brief Persistent Activation D-Bus object for BIOS */
270 std::unique_ptr<Activation> biosActivation;
271
Lei YU16aa28a2021-05-07 10:17:30 +0800272 public:
Lei YU6e9fb1d2021-02-19 18:01:40 +0800273 /** @brief Persistent Version D-Bus object for BIOS */
274 std::unique_ptr<VersionClass> biosVersion;
275#endif
Gunnar Millsec1b41c2017-05-02 12:20:36 -0500276};
277
Gunnar Millsec1b41c2017-05-02 12:20:36 -0500278} // namespace updater
279} // namespace software
280} // namespace phosphor