Lei YU | 5e0dcb3 | 2019-08-02 18:04:34 +0800 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Lei YU | 4b9ac39 | 2019-10-12 11:02:26 +0800 | [diff] [blame] | 3 | #include "types.hpp" |
| 4 | |
Lei YU | 5e0dcb3 | 2019-08-02 18:04:34 +0800 | [diff] [blame] | 5 | #include <sdbusplus/bus.hpp> |
Patrick Williams | 5670b18 | 2023-05-10 07:50:50 -0500 | [diff] [blame] | 6 | |
| 7 | #include <any> |
Lei YU | 6520748 | 2019-10-11 16:39:36 +0800 | [diff] [blame] | 8 | #include <set> |
Lei YU | 5e0dcb3 | 2019-08-02 18:04:34 +0800 | [diff] [blame] | 9 | #include <string> |
| 10 | #include <vector> |
| 11 | |
| 12 | namespace utils |
| 13 | { |
| 14 | |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 15 | class UtilsInterface; |
| 16 | |
Lei YU | 4b9ac39 | 2019-10-12 11:02:26 +0800 | [diff] [blame] | 17 | using AssociationList = phosphor::software::updater::AssociationList; |
Patrick Williams | b5f9b82 | 2022-06-16 17:26:17 -0500 | [diff] [blame] | 18 | using std::any; |
| 19 | using std::any_cast; |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 20 | |
| 21 | /** |
| 22 | * @brief Get the implementation of UtilsInterface |
| 23 | */ |
| 24 | const UtilsInterface& getUtils(); |
Lei YU | ad90ad5 | 2019-08-06 11:19:28 +0800 | [diff] [blame] | 25 | |
Lei YU | 5e0dcb3 | 2019-08-02 18:04:34 +0800 | [diff] [blame] | 26 | /** |
| 27 | * @brief Get PSU inventory object path from DBus |
| 28 | */ |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 29 | std::vector<std::string> getPSUInventoryPath(sdbusplus::bus_t& bus); |
Lei YU | 5e0dcb3 | 2019-08-02 18:04:34 +0800 | [diff] [blame] | 30 | |
Lei YU | ad90ad5 | 2019-08-06 11:19:28 +0800 | [diff] [blame] | 31 | /** @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 Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 39 | std::string getService(sdbusplus::bus_t& bus, const char* path, |
Lei YU | ad90ad5 | 2019-08-06 11:19:28 +0800 | [diff] [blame] | 40 | const char* interface); |
| 41 | |
Lei YU | d0bbfa9 | 2019-09-11 16:10:54 +0800 | [diff] [blame] | 42 | /** @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 Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 50 | std::vector<std::string> getServices(sdbusplus::bus_t& bus, const char* path, |
Lei YU | d0bbfa9 | 2019-09-11 16:10:54 +0800 | [diff] [blame] | 51 | const char* interface); |
| 52 | |
Lei YU | ad90ad5 | 2019-08-06 11:19:28 +0800 | [diff] [blame] | 53 | /** @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 | */ |
| 63 | template <typename T> |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 64 | T getProperty(sdbusplus::bus_t& bus, const char* service, const char* path, |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 65 | const char* interface, const char* propertyName); |
Lei YU | ad90ad5 | 2019-08-06 11:19:28 +0800 | [diff] [blame] | 66 | |
| 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 | */ |
| 77 | std::string getVersionId(const std::string& version); |
| 78 | |
Lei YU | 5f3584d | 2019-08-27 16:28:53 +0800 | [diff] [blame] | 79 | /** @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 | */ |
| 85 | std::string getVersion(const std::string& inventoryPath); |
| 86 | |
Lei YU | 6520748 | 2019-10-11 16:39:36 +0800 | [diff] [blame] | 87 | /** @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 | */ |
| 93 | std::string getLatestVersion(const std::set<std::string>& versions); |
| 94 | |
Lei YU | 4b9ac39 | 2019-10-12 11:02:26 +0800 | [diff] [blame] | 95 | /** @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 | */ |
| 102 | bool isAssociated(const std::string& psuInventoryPath, |
| 103 | const AssociationList& assocs); |
| 104 | |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 105 | /** |
| 106 | * @brief The interface for utils |
| 107 | */ |
| 108 | class UtilsInterface |
| 109 | { |
| 110 | public: |
George Liu | 66a54ad | 2024-08-23 13:53:39 +0800 | [diff] [blame^] | 111 | UtilsInterface() = default; |
| 112 | UtilsInterface(const UtilsInterface&) = delete; |
| 113 | UtilsInterface& operator=(const UtilsInterface&) = delete; |
| 114 | UtilsInterface(UtilsInterface&&) = delete; |
| 115 | UtilsInterface& operator=(UtilsInterface&&) = delete; |
| 116 | |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 117 | // For now the code needs to get property for Present and Version |
Patrick Williams | bfa8d16 | 2020-05-13 18:00:02 -0500 | [diff] [blame] | 118 | using PropertyType = std::variant<std::string, bool>; |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 119 | |
| 120 | virtual ~UtilsInterface() = default; |
| 121 | |
| 122 | virtual std::vector<std::string> |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 123 | getPSUInventoryPath(sdbusplus::bus_t& bus) const = 0; |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 124 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 125 | virtual std::string getService(sdbusplus::bus_t& bus, const char* path, |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 126 | const char* interface) const = 0; |
| 127 | |
Lei YU | d0bbfa9 | 2019-09-11 16:10:54 +0800 | [diff] [blame] | 128 | virtual std::vector<std::string> |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 129 | getServices(sdbusplus::bus_t& bus, const char* path, |
Lei YU | d0bbfa9 | 2019-09-11 16:10:54 +0800 | [diff] [blame] | 130 | const char* interface) const = 0; |
| 131 | |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 132 | virtual std::string getVersionId(const std::string& version) const = 0; |
| 133 | |
Lei YU | 5f3584d | 2019-08-27 16:28:53 +0800 | [diff] [blame] | 134 | virtual std::string getVersion(const std::string& inventoryPath) const = 0; |
| 135 | |
Lei YU | 6520748 | 2019-10-11 16:39:36 +0800 | [diff] [blame] | 136 | virtual std::string |
| 137 | getLatestVersion(const std::set<std::string>& versions) const = 0; |
| 138 | |
Lei YU | 4b9ac39 | 2019-10-12 11:02:26 +0800 | [diff] [blame] | 139 | virtual bool isAssociated(const std::string& psuInventoryPath, |
| 140 | const AssociationList& assocs) const = 0; |
| 141 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 142 | virtual any getPropertyImpl(sdbusplus::bus_t& bus, const char* service, |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 143 | const char* path, const char* interface, |
| 144 | const char* propertyName) const = 0; |
| 145 | |
| 146 | template <typename T> |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 147 | T getProperty(sdbusplus::bus_t& bus, const char* service, const char* path, |
| 148 | const char* interface, const char* propertyName) const |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 149 | { |
Patrick Williams | bab5ed9 | 2024-08-16 15:20:54 -0400 | [diff] [blame] | 150 | any result = |
| 151 | getPropertyImpl(bus, service, path, interface, propertyName); |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 152 | auto value = any_cast<PropertyType>(result); |
Patrick Williams | 2e9a3b2 | 2020-05-13 12:23:54 -0500 | [diff] [blame] | 153 | return std::get<T>(value); |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 154 | } |
| 155 | }; |
| 156 | |
| 157 | class Utils : public UtilsInterface |
| 158 | { |
| 159 | public: |
| 160 | std::vector<std::string> |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 161 | getPSUInventoryPath(sdbusplus::bus_t& bus) const override; |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 162 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 163 | std::string getService(sdbusplus::bus_t& bus, const char* path, |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 164 | const char* interface) const override; |
| 165 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 166 | std::vector<std::string> getServices(sdbusplus::bus_t& bus, |
Lei YU | d0bbfa9 | 2019-09-11 16:10:54 +0800 | [diff] [blame] | 167 | const char* path, |
| 168 | const char* interface) const override; |
| 169 | |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 170 | std::string getVersionId(const std::string& version) const override; |
| 171 | |
Lei YU | 5f3584d | 2019-08-27 16:28:53 +0800 | [diff] [blame] | 172 | std::string getVersion(const std::string& inventoryPath) const override; |
| 173 | |
Lei YU | 6520748 | 2019-10-11 16:39:36 +0800 | [diff] [blame] | 174 | std::string |
| 175 | getLatestVersion(const std::set<std::string>& versions) const override; |
| 176 | |
Lei YU | 4b9ac39 | 2019-10-12 11:02:26 +0800 | [diff] [blame] | 177 | bool isAssociated(const std::string& psuInventoryPath, |
| 178 | const AssociationList& assocs) const override; |
| 179 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 180 | any getPropertyImpl(sdbusplus::bus_t& bus, const char* service, |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 181 | const char* path, const char* interface, |
| 182 | const char* propertyName) const override; |
| 183 | }; |
| 184 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 185 | inline std::string getService(sdbusplus::bus_t& bus, const char* path, |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 186 | const char* interface) |
| 187 | { |
| 188 | return getUtils().getService(bus, path, interface); |
| 189 | } |
| 190 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 191 | inline std::vector<std::string> |
| 192 | getServices(sdbusplus::bus_t& bus, const char* path, const char* interface) |
Lei YU | d0bbfa9 | 2019-09-11 16:10:54 +0800 | [diff] [blame] | 193 | { |
| 194 | return getUtils().getServices(bus, path, interface); |
| 195 | } |
| 196 | |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 197 | inline std::vector<std::string> getPSUInventoryPath(sdbusplus::bus_t& bus) |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 198 | { |
| 199 | return getUtils().getPSUInventoryPath(bus); |
| 200 | } |
| 201 | |
| 202 | inline std::string getVersionId(const std::string& version) |
| 203 | { |
| 204 | return getUtils().getVersionId(version); |
| 205 | } |
| 206 | |
Lei YU | 5f3584d | 2019-08-27 16:28:53 +0800 | [diff] [blame] | 207 | inline std::string getVersion(const std::string& inventoryPath) |
| 208 | { |
| 209 | return getUtils().getVersion(inventoryPath); |
| 210 | } |
| 211 | |
Lei YU | 6520748 | 2019-10-11 16:39:36 +0800 | [diff] [blame] | 212 | inline std::string getLatestVersion(const std::set<std::string>& versions) |
| 213 | { |
| 214 | return getUtils().getLatestVersion(versions); |
| 215 | } |
| 216 | |
Lei YU | 4b9ac39 | 2019-10-12 11:02:26 +0800 | [diff] [blame] | 217 | inline bool isAssociated(const std::string& psuInventoryPath, |
| 218 | const AssociationList& assocs) |
| 219 | { |
| 220 | return getUtils().isAssociated(psuInventoryPath, assocs); |
| 221 | } |
| 222 | |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 223 | template <typename T> |
Patrick Williams | 374fae5 | 2022-07-22 19:26:55 -0500 | [diff] [blame] | 224 | T getProperty(sdbusplus::bus_t& bus, const char* service, const char* path, |
Lei YU | f77189f | 2019-08-07 14:26:30 +0800 | [diff] [blame] | 225 | const char* interface, const char* propertyName) |
| 226 | { |
| 227 | return getUtils().getProperty<T>(bus, service, path, interface, |
| 228 | propertyName); |
| 229 | } |
| 230 | |
Lei YU | 5e0dcb3 | 2019-08-02 18:04:34 +0800 | [diff] [blame] | 231 | } // namespace utils |