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