blob: be85494a49e5f5fef9202ff9760765beb60f7a85 [file] [log] [blame]
Lei YU5e0dcb32019-08-02 18:04:34 +08001#pragma once
2
Lei YU4b9ac392019-10-12 11:02:26 +08003#include "types.hpp"
4
Lei YU5e0dcb32019-08-02 18:04:34 +08005#include <sdbusplus/bus.hpp>
Patrick Williams5670b182023-05-10 07:50:50 -05006
7#include <any>
Lei YU65207482019-10-11 16:39:36 +08008#include <set>
Lei YU5e0dcb32019-08-02 18:04:34 +08009#include <string>
10#include <vector>
11
12namespace utils
13{
14
Lei YUf77189f2019-08-07 14:26:30 +080015class UtilsInterface;
16
Lei YU4b9ac392019-10-12 11:02:26 +080017using AssociationList = phosphor::software::updater::AssociationList;
Patrick Williamsb5f9b822022-06-16 17:26:17 -050018using std::any;
19using std::any_cast;
Lei YUf77189f2019-08-07 14:26:30 +080020
21/**
22 * @brief Get the implementation of UtilsInterface
23 */
24const UtilsInterface& getUtils();
Lei YUad90ad52019-08-06 11:19:28 +080025
Lei YU5e0dcb32019-08-02 18:04:34 +080026/**
27 * @brief Get PSU inventory object path from DBus
28 */
Patrick Williams374fae52022-07-22 19:26:55 -050029std::vector<std::string> getPSUInventoryPath(sdbusplus::bus_t& bus);
Lei YU5e0dcb32019-08-02 18:04:34 +080030
Lei YUad90ad52019-08-06 11:19:28 +080031/** @brief Get service name from object path and interface
32 *
33 * @param[in] bus - The Dbus bus object
34 * @param[in] path - The Dbus object path
35 * @param[in] interface - The Dbus interface
36 *
37 * @return The name of the service
38 */
Patrick Williams374fae52022-07-22 19:26:55 -050039std::string getService(sdbusplus::bus_t& bus, const char* path,
Lei YUad90ad52019-08-06 11:19:28 +080040 const char* interface);
41
Lei YUd0bbfa92019-09-11 16:10:54 +080042/** @brief Get all the service names from object path and interface
43 *
44 * @param[in] bus - The Dbus bus object
45 * @param[in] path - The Dbus object path
46 * @param[in] interface - The Dbus interface
47 *
48 * @return The name of the services
49 */
Patrick Williams374fae52022-07-22 19:26:55 -050050std::vector<std::string> getServices(sdbusplus::bus_t& bus, const char* path,
Lei YUd0bbfa92019-09-11 16:10:54 +080051 const char* interface);
52
Lei YUad90ad52019-08-06 11:19:28 +080053/** @brief The template function to get property from the requested dbus path
54 *
55 * @param[in] bus - The Dbus bus object
56 * @param[in] service - The Dbus service name
57 * @param[in] path - The Dbus object path
58 * @param[in] interface - The Dbus interface
59 * @param[in] propertyName - The property name to get
60 *
61 * @return The value of the property
62 */
63template <typename T>
Patrick Williams374fae52022-07-22 19:26:55 -050064T getProperty(sdbusplus::bus_t& bus, const char* service, const char* path,
Lei YUf77189f2019-08-07 14:26:30 +080065 const char* interface, const char* propertyName);
Lei YUad90ad52019-08-06 11:19:28 +080066
67/**
68 * @brief Calculate the version id from the version string.
69 *
70 * @details The version id is a unique 8 hexadecimal digit id
71 * calculated from the version string.
72 *
73 * @param[in] version - The image version string (e.g. v1.99.10-19).
74 *
75 * @return The id.
76 */
77std::string getVersionId(const std::string& version);
78
Lei YU5f3584d2019-08-27 16:28:53 +080079/** @brief Get version of PSU specified by the inventory path
80 *
81 * @param[in] inventoryPath - The PSU inventory object path
82 *
83 * @return The version string, or empry string if it fails to get the version
84 */
85std::string getVersion(const std::string& inventoryPath);
86
Lei YU65207482019-10-11 16:39:36 +080087/** @brief Get latest version from the PSU versions
88 *
89 * @param[in] versions - The list of the versions
90 *
91 * @return The latest version string
92 */
93std::string getLatestVersion(const std::set<std::string>& versions);
94
Lei YU4b9ac392019-10-12 11:02:26 +080095/** @brief Check if the PSU is associated
96 *
97 * @param[in] psuInventoryPath - The PSU inventory path
98 * @param[in] assocs - The list of associations
99 *
100 * @return true if the psu is in the association list
101 */
102bool isAssociated(const std::string& psuInventoryPath,
103 const AssociationList& assocs);
104
Lei YUf77189f2019-08-07 14:26:30 +0800105/**
106 * @brief The interface for utils
107 */
108class UtilsInterface
109{
110 public:
George Liu66a54ad2024-08-23 13:53:39 +0800111 UtilsInterface() = default;
112 UtilsInterface(const UtilsInterface&) = delete;
113 UtilsInterface& operator=(const UtilsInterface&) = delete;
114 UtilsInterface(UtilsInterface&&) = delete;
115 UtilsInterface& operator=(UtilsInterface&&) = delete;
116
Lei YUf77189f2019-08-07 14:26:30 +0800117 // For now the code needs to get property for Present and Version
Patrick Williamsbfa8d162020-05-13 18:00:02 -0500118 using PropertyType = std::variant<std::string, bool>;
Lei YUf77189f2019-08-07 14:26:30 +0800119
120 virtual ~UtilsInterface() = default;
121
122 virtual std::vector<std::string>
Patrick Williams374fae52022-07-22 19:26:55 -0500123 getPSUInventoryPath(sdbusplus::bus_t& bus) const = 0;
Lei YUf77189f2019-08-07 14:26:30 +0800124
Patrick Williams374fae52022-07-22 19:26:55 -0500125 virtual std::string getService(sdbusplus::bus_t& bus, const char* path,
Lei YUf77189f2019-08-07 14:26:30 +0800126 const char* interface) const = 0;
127
Lei YUd0bbfa92019-09-11 16:10:54 +0800128 virtual std::vector<std::string>
Patrick Williams374fae52022-07-22 19:26:55 -0500129 getServices(sdbusplus::bus_t& bus, const char* path,
Lei YUd0bbfa92019-09-11 16:10:54 +0800130 const char* interface) const = 0;
131
Lei YUf77189f2019-08-07 14:26:30 +0800132 virtual std::string getVersionId(const std::string& version) const = 0;
133
Lei YU5f3584d2019-08-27 16:28:53 +0800134 virtual std::string getVersion(const std::string& inventoryPath) const = 0;
135
Lei YU65207482019-10-11 16:39:36 +0800136 virtual std::string
137 getLatestVersion(const std::set<std::string>& versions) const = 0;
138
Lei YU4b9ac392019-10-12 11:02:26 +0800139 virtual bool isAssociated(const std::string& psuInventoryPath,
140 const AssociationList& assocs) const = 0;
141
Patrick Williams374fae52022-07-22 19:26:55 -0500142 virtual any getPropertyImpl(sdbusplus::bus_t& bus, const char* service,
Lei YUf77189f2019-08-07 14:26:30 +0800143 const char* path, const char* interface,
144 const char* propertyName) const = 0;
145
146 template <typename T>
Patrick Williams374fae52022-07-22 19:26:55 -0500147 T getProperty(sdbusplus::bus_t& bus, const char* service, const char* path,
148 const char* interface, const char* propertyName) const
Lei YUf77189f2019-08-07 14:26:30 +0800149 {
Patrick Williamsbab5ed92024-08-16 15:20:54 -0400150 any result =
151 getPropertyImpl(bus, service, path, interface, propertyName);
Lei YUf77189f2019-08-07 14:26:30 +0800152 auto value = any_cast<PropertyType>(result);
Patrick Williams2e9a3b22020-05-13 12:23:54 -0500153 return std::get<T>(value);
Lei YUf77189f2019-08-07 14:26:30 +0800154 }
155};
156
157class Utils : public UtilsInterface
158{
159 public:
160 std::vector<std::string>
Patrick Williams374fae52022-07-22 19:26:55 -0500161 getPSUInventoryPath(sdbusplus::bus_t& bus) const override;
Lei YUf77189f2019-08-07 14:26:30 +0800162
Patrick Williams374fae52022-07-22 19:26:55 -0500163 std::string getService(sdbusplus::bus_t& bus, const char* path,
Lei YUf77189f2019-08-07 14:26:30 +0800164 const char* interface) const override;
165
Patrick Williams374fae52022-07-22 19:26:55 -0500166 std::vector<std::string> getServices(sdbusplus::bus_t& bus,
Lei YUd0bbfa92019-09-11 16:10:54 +0800167 const char* path,
168 const char* interface) const override;
169
Lei YUf77189f2019-08-07 14:26:30 +0800170 std::string getVersionId(const std::string& version) const override;
171
Lei YU5f3584d2019-08-27 16:28:53 +0800172 std::string getVersion(const std::string& inventoryPath) const override;
173
Lei YU65207482019-10-11 16:39:36 +0800174 std::string
175 getLatestVersion(const std::set<std::string>& versions) const override;
176
Lei YU4b9ac392019-10-12 11:02:26 +0800177 bool isAssociated(const std::string& psuInventoryPath,
178 const AssociationList& assocs) const override;
179
Patrick Williams374fae52022-07-22 19:26:55 -0500180 any getPropertyImpl(sdbusplus::bus_t& bus, const char* service,
Lei YUf77189f2019-08-07 14:26:30 +0800181 const char* path, const char* interface,
182 const char* propertyName) const override;
183};
184
Patrick Williams374fae52022-07-22 19:26:55 -0500185inline std::string getService(sdbusplus::bus_t& bus, const char* path,
Lei YUf77189f2019-08-07 14:26:30 +0800186 const char* interface)
187{
188 return getUtils().getService(bus, path, interface);
189}
190
Patrick Williams374fae52022-07-22 19:26:55 -0500191inline std::vector<std::string>
192 getServices(sdbusplus::bus_t& bus, const char* path, const char* interface)
Lei YUd0bbfa92019-09-11 16:10:54 +0800193{
194 return getUtils().getServices(bus, path, interface);
195}
196
Patrick Williams374fae52022-07-22 19:26:55 -0500197inline std::vector<std::string> getPSUInventoryPath(sdbusplus::bus_t& bus)
Lei YUf77189f2019-08-07 14:26:30 +0800198{
199 return getUtils().getPSUInventoryPath(bus);
200}
201
202inline std::string getVersionId(const std::string& version)
203{
204 return getUtils().getVersionId(version);
205}
206
Lei YU5f3584d2019-08-27 16:28:53 +0800207inline std::string getVersion(const std::string& inventoryPath)
208{
209 return getUtils().getVersion(inventoryPath);
210}
211
Lei YU65207482019-10-11 16:39:36 +0800212inline std::string getLatestVersion(const std::set<std::string>& versions)
213{
214 return getUtils().getLatestVersion(versions);
215}
216
Lei YU4b9ac392019-10-12 11:02:26 +0800217inline bool isAssociated(const std::string& psuInventoryPath,
218 const AssociationList& assocs)
219{
220 return getUtils().isAssociated(psuInventoryPath, assocs);
221}
222
Lei YUf77189f2019-08-07 14:26:30 +0800223template <typename T>
Patrick Williams374fae52022-07-22 19:26:55 -0500224T getProperty(sdbusplus::bus_t& bus, const char* service, const char* path,
Lei YUf77189f2019-08-07 14:26:30 +0800225 const char* interface, const char* propertyName)
226{
227 return getUtils().getProperty<T>(bus, service, path, interface,
228 propertyName);
229}
230
Lei YU5e0dcb32019-08-02 18:04:34 +0800231} // namespace utils