1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
#pragma once
#include "activation.hpp"
#include "item_updater_helper.hpp"
#include "org/openbmc/Associations/server.hpp"
#include "version.hpp"
#include "xyz/openbmc_project/Collection/DeleteAll/server.hpp"
#include <sdbusplus/server.hpp>
#include <xyz/openbmc_project/Common/FactoryReset/server.hpp>
#include <xyz/openbmc_project/Control/FieldMode/server.hpp>
namespace phosphor
{
namespace software
{
namespace updater
{
using ItemUpdaterInherit = sdbusplus::server::object::object<
sdbusplus::xyz::openbmc_project::Common::server::FactoryReset,
sdbusplus::xyz::openbmc_project::Control::server::FieldMode,
sdbusplus::org::openbmc::server::Associations,
sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>;
namespace MatchRules = sdbusplus::bus::match::rules;
using VersionClass = phosphor::software::manager::Version;
using AssociationList =
std::vector<std::tuple<std::string, std::string, std::string>>;
/** @class ItemUpdater
* @brief Manages the activation of the BMC version items.
*/
class ItemUpdater : public ItemUpdaterInherit
{
public:
/*
* @brief Types of Activation status for image validation.
*/
enum class ActivationStatus
{
ready,
invalid,
active
};
/** @brief Constructs ItemUpdater
*
* @param[in] bus - The D-Bus bus object
*/
ItemUpdater(sdbusplus::bus::bus& bus, const std::string& path) :
ItemUpdaterInherit(bus, path.c_str(), false), bus(bus), helper(bus),
versionMatch(bus,
MatchRules::interfacesAdded() +
MatchRules::path("/xyz/openbmc_project/software"),
std::bind(std::mem_fn(&ItemUpdater::createActivation),
this, std::placeholders::_1))
{
setBMCInventoryPath();
processBMCImage();
restoreFieldModeStatus();
emit_object_added();
};
/** @brief Save priority value to persistent storage (flash and optionally
* a U-Boot environment variable)
*
* @param[in] versionId - The Id of the version
* @param[in] value - The priority value
* @return None
*/
void savePriority(const std::string& versionId, uint8_t value);
/** @brief Sets the given priority free by incrementing
* any existing priority with the same value by 1
*
* @param[in] value - The priority that needs to be set free.
* @param[in] versionId - The Id of the version for which we
* are trying to free up the priority.
* @return None
*/
void freePriority(uint8_t value, const std::string& versionId);
/**
* @brief Create and populate the active BMC Version.
*/
void processBMCImage();
/**
* @brief Erase specified entry D-Bus object
* if Action property is not set to Active
*
* @param[in] entryId - unique identifier of the entry
*/
void erase(std::string entryId);
/**
* @brief Deletes all versions except for the current one
*/
void deleteAll();
/** @brief Creates an active association to the
* newly active software image
*
* @param[in] path - The path to create the association to.
*/
void createActiveAssociation(const std::string& path);
/** @brief Removes the associations from the provided software image path
*
* @param[in] path - The path to remove the associations from.
*/
void removeAssociations(const std::string& path);
/** @brief Determine if the given priority is the lowest
*
* @param[in] value - The priority that needs to be checked.
*
* @return boolean corresponding to whether the given
* priority is lowest.
*/
bool isLowestPriority(uint8_t value);
/**
* @brief Updates the U-Boot variables to point to the requested
* versionId, so that the systems boots from this version on
* the next reboot.
*
* @param[in] versionId - The version to point the system to boot from.
*/
void updateUbootEnvVars(const std::string& versionId);
/**
* @brief Updates the uboot variables to point to BMC version with lowest
* priority, so that the system boots from this version on the
* next boot.
*/
void resetUbootEnvVars();
/** @brief Brings the total number of active BMC versions to
* ACTIVE_BMC_MAX_ALLOWED -1. This function is intended to be
* run before activating a new BMC version. If this function
* needs to delete any BMC version(s) it will delete the
* version(s) with the highest priority, skipping the
* functional BMC version.
*
* @param[in] caller - The Activation object that called this function.
*/
void freeSpace(Activation& caller);
private:
/** @brief Callback function for Software.Version match.
* @details Creates an Activation D-Bus object.
*
* @param[in] msg - Data associated with subscribed signal
*/
void createActivation(sdbusplus::message::message& msg);
/**
* @brief Validates the presence of SquashFS image in the image dir.
*
* @param[in] filePath - The path to the image dir.
* @param[out] result - ActivationStatus Enum.
* ready if validation was successful.
* invalid if validation fail.
* active if image is the current version.
*
*/
ActivationStatus validateSquashFSImage(const std::string& filePath);
/** @brief BMC factory reset - marks the read-write partition for
* recreation upon reboot. */
void reset() override;
/**
* @brief Enables field mode, if value=true.
*
* @param[in] value - If true, enables field mode.
* @param[out] result - Returns the current state of field mode.
*
*/
bool fieldModeEnabled(bool value) override;
/** @brief Sets the BMC inventory item path under
* /xyz/openbmc_project/inventory/system/chassis/. */
void setBMCInventoryPath();
/** @brief The path to the BMC inventory item. */
std::string bmcInventoryPath;
/** @brief Restores field mode status on reboot. */
void restoreFieldModeStatus();
/** @brief Creates a functional association to the
* "running" BMC software image
*
* @param[in] path - The path to create the association to.
*/
void createFunctionalAssociation(const std::string& path);
/** @brief Persistent sdbusplus D-Bus bus connection. */
sdbusplus::bus::bus& bus;
/** @brief The helper of image updater. */
Helper helper;
/** @brief Persistent map of Activation D-Bus objects and their
* version id */
std::map<std::string, std::unique_ptr<Activation>> activations;
/** @brief Persistent map of Version D-Bus objects and their
* version id */
std::map<std::string, std::unique_ptr<VersionClass>> versions;
/** @brief sdbusplus signal match for Software.Version */
sdbusplus::bus::match_t versionMatch;
/** @brief This entry's associations */
AssociationList assocs = {};
/** @brief Clears read only partition for
* given Activation D-Bus object.
*
* @param[in] versionId - The version id.
*/
void removeReadOnlyPartition(std::string versionId);
/** @brief Copies U-Boot from the currently booted BMC chip to the
* alternate chip.
*/
void mirrorUbootToAlt();
};
} // namespace updater
} // namespace software
} // namespace phosphor
|
