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     /**
107      * @brief Create and populate the active PNOR Version.
108      */
109     virtual void processPNORImage() = 0;
110 
111     /** @brief Deletes version
112      *
113      *  @param[in] entryId - Id of the version to delete
114      *
115      *  @return - Returns true if the version is deleted.
116      */
117     virtual bool erase(std::string entryId);
118 
119     /**
120      * @brief Erases any non-active pnor versions.
121      */
122     virtual void deleteAll() = 0;
123 
124     /** @brief Brings the total number of active PNOR versions to
125      *         ACTIVE_PNOR_MAX_ALLOWED -1. This function is intended to be
126      *         run before activating a new PNOR version. If this function
127      *         needs to delete any PNOR version(s) it will delete the
128      *         version(s) with the highest priority, skipping the
129      *         functional PNOR version.
130      */
131     virtual void freeSpace() = 0;
132 
133     /** @brief Creates an active association to the
134      *  newly active software image
135      *
136      * @param[in]  path - The path to create the association to.
137      */
138     virtual void createActiveAssociation(const std::string& path);
139 
140     /** @brief Updates the functional association to the
141      *  new "running" PNOR image
142      *
143      * @param[in]  versionId - The id of the image to update the association to.
144      */
145     virtual void updateFunctionalAssociation(const std::string& versionId);
146 
147     /** @brief Removes the associations from the provided software image path
148      *
149      * @param[in]  path - The path to remove the association from.
150      */
151     virtual void removeAssociation(const std::string& path);
152 
153     /** @brief Persistent GardReset dbus object */
154     std::unique_ptr<GardReset> gardReset;
155 
156     /** @brief Check whether the provided image id is the functional one
157      *
158      * @param[in] - versionId - The id of the image to check.
159      *
160      * @return - Returns true if this version is currently functional.
161      */
162     virtual bool isVersionFunctional(const std::string& versionId) = 0;
163 
164     /** @brief Persistent ObjectEnable D-Bus object */
165     std::unique_ptr<ObjectEnable> volatileEnable;
166 
167   protected:
168     /** @brief Callback function for Software.Version match.
169      *  @details Creates an Activation D-Bus object.
170      *
171      * @param[in]  msg       - Data associated with subscribed signal
172      */
173     virtual void createActivation(sdbusplus::message::message& msg);
174 
175     /** @brief Create Activation object */
176     virtual std::unique_ptr<Activation> createActivationObject(
177         const std::string& path, const std::string& versionId,
178         const std::string& extVersion,
179         sdbusplus::xyz::openbmc_project::Software::server::Activation::
180             Activations activationStatus,
181         AssociationList& assocs) = 0;
182 
183     /** @brief Create Version object */
184     virtual std::unique_ptr<Version>
185         createVersionObject(const std::string& objPath,
186                             const std::string& versionId,
187                             const std::string& versionString,
188                             sdbusplus::xyz::openbmc_project::Software::server::
189                                 Version::VersionPurpose versionPurpose,
190                             const std::string& filePath) = 0;
191 
192     /** @brief Validate if image is valid or not */
193     virtual bool validateImage(const std::string& path) = 0;
194 
195     /** @brief Persistent sdbusplus D-Bus bus connection. */
196     sdbusplus::bus::bus& bus;
197 
198     /** @brief Persistent map of Activation D-Bus objects and their
199      * version id */
200     std::map<std::string, std::unique_ptr<Activation>> activations;
201 
202     /** @brief Persistent map of Version D-Bus objects and their
203      * version id */
204     std::map<std::string, std::unique_ptr<Version>> versions;
205 
206     /** @brief sdbusplus signal match for Software.Version */
207     sdbusplus::bus::match_t versionMatch;
208 
209     /** @brief This entry's associations */
210     AssociationList assocs = {};
211 
212     /** @brief Host factory reset - clears PNOR partitions for each
213      * Activation D-Bus object */
214     void reset() override = 0;
215 
216     /** @brief Check whether the host is running
217      *
218      * @return - Returns true if the Chassis is powered on.
219      */
220     bool isChassisOn();
221 };
222 
223 } // namespace updater
224 } // namespace software
225 } // namespace openpower
226