xref: /openbmc/phosphor-psu-code-mgmt/src/item_updater.hpp (revision f77189f7e4eb5fe6d489cde6539f07346539254f)
1 #pragma once
2 
3 #include "config.h"
4 
5 #include "activation.hpp"
6 #include "types.hpp"
7 #include "utils.hpp"
8 #include "version.hpp"
9 
10 #include <phosphor-logging/log.hpp>
11 #include <sdbusplus/server.hpp>
12 #include <xyz/openbmc_project/Association/Definitions/server.hpp>
13 #include <xyz/openbmc_project/Collection/DeleteAll/server.hpp>
14 
15 class TestItemUpdater;
16 
17 namespace phosphor
18 {
19 namespace software
20 {
21 namespace updater
22 {
23 
24 class Version;
25 
26 using ItemUpdaterInherit = sdbusplus::server::object::object<
27     sdbusplus::xyz::openbmc_project::Association::server::Definitions,
28     sdbusplus::xyz::openbmc_project::Collection::server::DeleteAll>;
29 namespace MatchRules = sdbusplus::bus::match::rules;
30 
31 /** @class ItemUpdater
32  *  @brief Manages the activation of the PSU version items.
33  */
34 class ItemUpdater : public ItemUpdaterInherit
35 {
36     friend class ::TestItemUpdater;
37 
38   public:
39     /** @brief Constructs ItemUpdater
40      *
41      * @param[in] bus    - The D-Bus bus object
42      * @param[in] path   - The D-Bus path
43      */
44     ItemUpdater(sdbusplus::bus::bus& bus, const std::string& path) :
45         ItemUpdaterInherit(bus, path.c_str()), bus(bus),
46         versionMatch(bus,
47                      MatchRules::interfacesAdded() +
48                          MatchRules::path(SOFTWARE_OBJPATH),
49                      std::bind(std::mem_fn(&ItemUpdater::createActivation),
50                                this, std::placeholders::_1))
51     {
52         processPSUImage();
53     }
54 
55     /** @brief Deletes version
56      *
57      *  @param[in] versionId - Id of the version to delete
58      */
59     void erase(std::string versionId);
60 
61     /**
62      * @brief Erases any non-active versions.
63      */
64     void deleteAll();
65 
66   private:
67     /** @brief Creates an active association to the
68      *  newly active software image
69      *
70      * @param[in]  path - The path to create the association to.
71      */
72     void createActiveAssociation(const std::string& path);
73 
74     /** @brief Add the functional association to the
75      *  new "running" PSU images
76      *
77      * @param[in]  path - The path to add the association to.
78      */
79     void addFunctionalAssociation(const std::string& path);
80 
81     /** @brief Removes the associations from the provided software image path
82      *
83      * @param[in]  path - The path to remove the association from.
84      */
85     void removeAssociation(const std::string& path);
86 
87     /** @brief Callback function for Software.Version match.
88      *  @details Creates an Activation D-Bus object.
89      *
90      * @param[in]  msg       - Data associated with subscribed signal
91      */
92     void createActivation(sdbusplus::message::message& msg);
93 
94     /** @brief Callback function for PSU inventory match.
95      *  @details Update an Activation D-Bus object for PSU inventory.
96      *
97      * @param[in]  msg       - Data associated with subscribed signal
98      */
99     void onPsuInventoryChanged(sdbusplus::message::message& msg);
100 
101     /** @brief Create Activation object */
102     std::unique_ptr<Activation> createActivationObject(
103         const std::string& path, const std::string& versionId,
104         const std::string& extVersion,
105         sdbusplus::xyz::openbmc_project::Software::server::Activation::
106             Activations activationStatus,
107         const AssociationList& assocs);
108 
109     /** @brief Create Version object */
110     std::unique_ptr<Version>
111         createVersionObject(const std::string& objPath,
112                             const std::string& versionId,
113                             const std::string& versionString,
114                             sdbusplus::xyz::openbmc_project::Software::server::
115                                 Version::VersionPurpose versionPurpose,
116                             const std::string& filePath);
117 
118     /** @brief Create Activation and Version object for PSU inventory
119      *  @details If the same version exists for multiple PSUs, just add
120      *           related association, instead of creating new objects.
121      * */
122     void createPsuObject(const std::string& psuInventoryPath,
123                          const std::string& psuVersion);
124 
125     /** @brief Remove Activation and Version object for PSU inventory
126      *  @details If the same version exists for mutliple PSUs, just remove
127      *           related association.
128      *           If the version has no association, the Activation and
129      *           Version object will be removed
130      */
131     void removePsuObject(const std::string& psuInventoryPath);
132 
133     /**
134      * @brief Create and populate the active PSU Version.
135      */
136     void processPSUImage();
137 
138     /** @brief Persistent sdbusplus D-Bus bus connection. */
139     sdbusplus::bus::bus& bus;
140 
141     /** @brief Persistent map of Activation D-Bus objects and their
142      * version id */
143     std::map<std::string, std::unique_ptr<Activation>> activations;
144 
145     /** @brief Persistent map of Version D-Bus objects and their
146      * version id */
147     std::map<std::string, std::unique_ptr<Version>> versions;
148 
149     /** @brief The reference map of PSU Inventory objects and the
150      * Activation*/
151     std::map<std::string, const std::unique_ptr<Activation>&>
152         psuPathActivationMap;
153 
154     /** @brief A struct to hold the PSU present status and version */
155     struct psuStatus
156     {
157         bool present;
158         std::string version;
159     };
160 
161     /** @brief The map of PSU inventory path and the psuStatus */
162     std::map<std::string, psuStatus> psuStatusMap;
163 
164     /** @brief sdbusplus signal match for PSU Software*/
165     sdbusplus::bus::match_t versionMatch;
166 
167     /** @brief sdbusplus signal matches for PSU Inventory */
168     std::vector<sdbusplus::bus::match_t> psuMatches;
169 
170     /** @brief This entry's associations */
171     AssociationList assocs;
172 };
173 
174 } // namespace updater
175 } // namespace software
176 } // namespace phosphor
177