blob: 089879d23e5b7c08c51d495447a4b7b4a5c41483 [file] [log] [blame]
George Liu616a0712021-02-18 10:50:24 +08001#include "utils.hpp"
George Liudef5f5a2020-04-10 11:23:52 +08002
George Liue9fb5c62021-07-01 14:05:32 +08003#include <phosphor-logging/lg2.hpp>
George Liu616a0712021-02-18 10:50:24 +08004#include <sdbusplus/exception.hpp>
5#include <sdeventplus/event.hpp>
George Liudef5f5a2020-04-10 11:23:52 +08006
7#include <filesystem>
8#include <fstream>
George Liudef5f5a2020-04-10 11:23:52 +08009
10namespace fs = std::filesystem;
11
George Liu616a0712021-02-18 10:50:24 +080012namespace phosphor
George Liudef5f5a2020-04-10 11:23:52 +080013{
George Liu616a0712021-02-18 10:50:24 +080014namespace led
15{
George Liudef5f5a2020-04-10 11:23:52 +080016
George Liu616a0712021-02-18 10:50:24 +080017static constexpr auto confFileName = "led-group-config.json";
18static constexpr auto confOverridePath = "/etc/phosphor-led-manager";
19static constexpr auto confBasePath = "/usr/share/phosphor-led-manager";
20static constexpr auto confCompatibleInterface =
Priyanga Ramasamy7d887622023-12-22 04:33:27 -060021 "xyz.openbmc_project.Inventory.Decorator.Compatible";
George Liu616a0712021-02-18 10:50:24 +080022static constexpr auto confCompatibleProperty = "Names";
23
24class JsonConfig
25{
26 public:
27 /**
28 * @brief Constructor
29 *
30 * Looks for the JSON config file. If it can't find one, then it
Priyanga Ramasamy7d887622023-12-22 04:33:27 -060031 * will watch entity-manager for the
32 * xyz.openbmc_project.Inventory.Decorator.Compatible interface to show up.
George Liu616a0712021-02-18 10:50:24 +080033 *
34 * @param[in] bus - The D-Bus object
35 * @param[in] event - sd event handler
36 */
Patrick Williams3e073ba2022-07-22 19:26:52 -050037 JsonConfig(sdbusplus::bus_t& bus, sdeventplus::Event& event) : event(event)
George Liudef5f5a2020-04-10 11:23:52 +080038 {
Patrick Williamsf178c0f2021-11-19 12:23:09 -060039 match = std::make_unique<sdbusplus::bus::match_t>(
George Liu616a0712021-02-18 10:50:24 +080040 bus,
41 sdbusplus::bus::match::rules::interfacesAdded() +
42 sdbusplus::bus::match::rules::sender(
43 "xyz.openbmc_project.EntityManager"),
George Liu226059b2024-08-22 16:01:44 +080044 [this](sdbusplus::message_t& m) { ifacesAddedCallback(m); });
George Liu616a0712021-02-18 10:50:24 +080045 getFilePath();
46
47 if (!confFile.empty())
48 {
49 match.reset();
50 }
George Liudef5f5a2020-04-10 11:23:52 +080051 }
52
George Liu616a0712021-02-18 10:50:24 +080053 /**
54 * @brief Get the configuration file
55 *
56 * @return filesystem path
57 */
58 inline const fs::path& getConfFile() const
George Liudef5f5a2020-04-10 11:23:52 +080059 {
George Liu616a0712021-02-18 10:50:24 +080060 return confFile;
George Liudef5f5a2020-04-10 11:23:52 +080061 }
George Liu616a0712021-02-18 10:50:24 +080062
63 private:
64 /** @brief Check the file path exists
65 *
66 * @param[in] names - Vector of the confCompatible Property
67 *
68 * @return - True or False
69 */
70 bool filePathExists(const std::vector<std::string>& names)
George Liudef5f5a2020-04-10 11:23:52 +080071 {
Patrick Williams543ac9f2024-08-16 15:19:59 -040072 auto it =
73 std::find_if(names.begin(), names.end(), [this](const auto& name) {
74 auto configFileName = name + ".json";
75 auto configFilePath = fs::path{confBasePath} / configFileName;
76 if (fs::exists(configFilePath))
77 {
78 confFile = configFilePath;
79 return true;
80 }
81 return false;
82 });
George Liu349d22e2024-08-23 09:09:56 +080083 return it != names.end();
George Liu616a0712021-02-18 10:50:24 +080084 }
85
86 /**
87 * @brief The interfacesAdded callback function that looks for
Priyanga Ramasamy7d887622023-12-22 04:33:27 -060088 * the xyz.openbmc_project.Inventory.Decorator.Compatible interface.
89 * If it finds it, it uses the Names property in the interface to find the
90 * JSON config file to use.
George Liu616a0712021-02-18 10:50:24 +080091 *
92 * @param[in] msg - The D-Bus message contents
93 */
Patrick Williams3e073ba2022-07-22 19:26:52 -050094 void ifacesAddedCallback(sdbusplus::message_t& msg)
George Liu616a0712021-02-18 10:50:24 +080095 {
96 sdbusplus::message::object_path path;
Patrick Williamsf2044032022-03-17 05:12:30 -050097 std::unordered_map<
98 std::string,
99 std::unordered_map<std::string,
100 std::variant<std::vector<std::string>>>>
George Liu616a0712021-02-18 10:50:24 +0800101 interfaces;
102
103 msg.read(path, interfaces);
104
George Liu7f53a032021-05-04 11:18:21 +0800105 if (!interfaces.contains(confCompatibleInterface))
George Liu616a0712021-02-18 10:50:24 +0800106 {
107 return;
108 }
109
110 // Get the "Name" property value of the
Priyanga Ramasamy7d887622023-12-22 04:33:27 -0600111 // "xyz.openbmc_project.Inventory.Decorator.Compatible" interface
George Liu616a0712021-02-18 10:50:24 +0800112 const auto& properties = interfaces.at(confCompatibleInterface);
113
George Liu7f53a032021-05-04 11:18:21 +0800114 if (!properties.contains(confCompatibleProperty))
George Liu616a0712021-02-18 10:50:24 +0800115 {
116 return;
117 }
118 auto names = std::get<std::vector<std::string>>(
119 properties.at(confCompatibleProperty));
120
121 if (filePathExists(names))
122 {
123 match.reset();
124
125 // This results in event.loop() exiting in getSystemLedMap
126 event.exit(0);
127 }
128 }
129
130 /**
131 * Get the json configuration file. The first location found to contain the
132 * json config file from the following locations in order.
133 * confOverridePath: /etc/phosphor-led-manager/led-group-config.json
134 * confBasePath: /usr/shard/phosphor-led-manager/led-group-config.json
135 * the name property of the confCompatibleInterface:
136 * /usr/shard/phosphor-led-manager/${Name}/led-group-config.json
137 *
138 * @brief Get the configuration file to be used
139 *
140 * @return
141 */
George Liu4b062012020-10-13 15:26:58 +0800142 void getFilePath()
George Liu616a0712021-02-18 10:50:24 +0800143 {
144 // Check override location
145 confFile = fs::path{confOverridePath} / confFileName;
146 if (fs::exists(confFile))
147 {
148 return;
149 }
150
151 // If the default file is there, use it
152 confFile = fs::path{confBasePath} / confFileName;
153 if (fs::exists(confFile))
154 {
155 return;
156 }
157 confFile.clear();
158
159 try
160 {
161 // Get all objects implementing the compatible interface
George Liu16181d12024-08-22 20:05:20 +0800162 auto objects = phosphor::led::utils::DBusHandler::getSubTreePaths(
163 "/", confCompatibleInterface);
George Liu616a0712021-02-18 10:50:24 +0800164 for (const auto& path : objects)
165 {
166 try
167 {
168 // Retrieve json config compatible relative path locations
George Liu16181d12024-08-22 20:05:20 +0800169 auto value = phosphor::led::utils::DBusHandler::getProperty(
George Liu616a0712021-02-18 10:50:24 +0800170 path, confCompatibleInterface, confCompatibleProperty);
171
172 auto confCompatValues =
173 std::get<std::vector<std::string>>(value);
174
175 // Look for a config file at each name relative to the base
176 // path and use the first one found
177 if (filePathExists(confCompatValues))
178 {
179 // Use the first config file found at a listed location
180 break;
181 }
182 confFile.clear();
183 }
Patrick Williams3e073ba2022-07-22 19:26:52 -0500184 catch (const sdbusplus::exception_t& e)
George Liu616a0712021-02-18 10:50:24 +0800185 {
186 // Property unavailable on object.
George Liue9fb5c62021-07-01 14:05:32 +0800187 lg2::error(
188 "Failed to get Names property, ERROR = {ERROR}, INTERFACES = {INTERFACES}, PATH = {PATH}",
189 "ERROR", e, "INTERFACE", confCompatibleInterface,
190 "PATH", path);
George Liudef5f5a2020-04-10 11:23:52 +0800191
George Liu616a0712021-02-18 10:50:24 +0800192 confFile.clear();
193 }
194 }
195 }
Patrick Williams3e073ba2022-07-22 19:26:52 -0500196 catch (const sdbusplus::exception_t& e)
George Liu616a0712021-02-18 10:50:24 +0800197 {
George Liue9fb5c62021-07-01 14:05:32 +0800198 lg2::error(
199 "Failed to call the SubTreePaths method, ERROR = {ERROR}, INTERFACE = {INTERFACE}",
200 "ERROR", e, "INTERFACE", confCompatibleInterface);
George Liu616a0712021-02-18 10:50:24 +0800201 }
George Liu17fcb4d2020-06-30 18:12:53 +0800202 return;
203 }
204
George Liu616a0712021-02-18 10:50:24 +0800205 /**
206 * @brief sd event handler.
207 */
208 sdeventplus::Event& event;
George Liu17fcb4d2020-06-30 18:12:53 +0800209
George Liu616a0712021-02-18 10:50:24 +0800210 /**
211 * @brief The JSON config file
212 */
213 fs::path confFile;
George Liu17fcb4d2020-06-30 18:12:53 +0800214
George Liu616a0712021-02-18 10:50:24 +0800215 /**
216 * @brief The interfacesAdded match that is used to wait
Priyanga Ramasamy7d887622023-12-22 04:33:27 -0600217 * for the xyz.openbmc_project.Inventory.Decorator.Compatible
218 * interface to show up.
George Liu616a0712021-02-18 10:50:24 +0800219 */
Patrick Williamsf178c0f2021-11-19 12:23:09 -0600220 std::unique_ptr<sdbusplus::bus::match_t> match;
George Liu616a0712021-02-18 10:50:24 +0800221};
Patrick Williams7217c032022-03-16 16:26:09 -0500222
223/** Blocking call to find the JSON Config from DBus. */
224auto getJsonConfig()
225{
226 // Get a new Dbus
227 auto bus = sdbusplus::bus::new_bus();
228
229 // Get a new event loop
230 auto event = sdeventplus::Event::get_new();
231
232 // Attach the bus to sd_event to service user requests
233 bus.attach_event(event.get(), SD_EVENT_PRIORITY_IMPORTANT);
234 phosphor::led::JsonConfig jsonConfig(bus, event);
235
236 // The event loop will be terminated from inside of a function in JsonConfig
237 // after finding the configuration file
238 if (jsonConfig.getConfFile().empty())
239 {
240 event.loop();
241 }
242
243 // Detach the bus from its sd_event event loop object
244 bus.detach_event();
245
246 return jsonConfig.getConfFile();
247}
248
George Liu616a0712021-02-18 10:50:24 +0800249} // namespace led
250} // namespace phosphor