xref: /openbmc/phosphor-led-manager/manager/json-parser.hpp (revision 7217c0354245f9096adb4301945951e030d322c8)
1 #include "config.h"
2 
3 #include "json-config.hpp"
4 #include "ledlayout.hpp"
5 
6 #include <nlohmann/json.hpp>
7 #include <phosphor-logging/lg2.hpp>
8 #include <sdbusplus/bus.hpp>
9 #include <sdeventplus/event.hpp>
10 
11 #include <filesystem>
12 #include <fstream>
13 #include <iostream>
14 
15 namespace fs = std::filesystem;
16 
17 using Json = nlohmann::json;
18 using LedAction = std::set<phosphor::led::Layout::LedAction>;
19 using LedMap = std::map<std::string, LedAction>;
20 
21 // Priority for a particular LED needs to stay SAME across all groups
22 // phosphor::led::Layout::Action can only be one of `Blink` and `On`
23 using PriorityMap = std::map<std::string, phosphor::led::Layout::Action>;
24 
25 /** @brief Parse LED JSON file and output Json object
26  *
27  *  @param[in] path - path of LED JSON file
28  *
29  *  @return const Json - Json object
30  */
31 const Json readJson(const fs::path& path)
32 {
33 
34     if (!fs::exists(path) || fs::is_empty(path))
35     {
36         lg2::error("Incorrect File Path or empty file, FILE_PATH = {PATH}",
37                    "PATH", path);
38         throw std::runtime_error("Incorrect File Path or empty file");
39     }
40 
41     try
42     {
43         std::ifstream jsonFile(path);
44         return Json::parse(jsonFile);
45     }
46     catch (const std::exception& e)
47     {
48         lg2::error(
49             "Failed to parse config file, ERROR = {ERROR}, FILE_PATH = {PATH}",
50             "ERROR", e, "PATH", path);
51         throw std::runtime_error("Failed to parse config file");
52     }
53 }
54 
55 /** @brief Returns action enum based on string
56  *
57  *  @param[in] action - action string
58  *
59  *  @return Action - action enum (On/Blink)
60  */
61 phosphor::led::Layout::Action getAction(const std::string& action)
62 {
63     assert(action == "On" || action == "Blink");
64 
65     return action == "Blink" ? phosphor::led::Layout::Blink
66                              : phosphor::led::Layout::On;
67 }
68 
69 /** @brief Validate the Priority of an LED is same across ALL groups
70  *
71  *  @param[in] name - led name member of each group
72  *  @param[in] priority - member priority of each group
73  *  @param[out] priorityMap - std::map, key:name, value:priority
74  *
75  *  @return
76  */
77 void validatePriority(const std::string& name,
78                       const phosphor::led::Layout::Action& priority,
79                       PriorityMap& priorityMap)
80 {
81 
82     auto iter = priorityMap.find(name);
83     if (iter == priorityMap.end())
84     {
85         priorityMap.emplace(name, priority);
86         return;
87     }
88 
89     if (iter->second != priority)
90     {
91         lg2::error(
92             "Priority of LED is not same across all, Name = {NAME}, Old Priority = {OLD_PRIO}, New Priority = {NEW_PRIO}",
93             "NAME", name, "OLD_PRIO", int(iter->second), "NEW_PRIO",
94             int(priority));
95 
96         throw std::runtime_error(
97             "Priority of at least one LED is not same across groups");
98     }
99 }
100 
101 /** @brief Load JSON config and return led map
102  *
103  *  @return LedMap - Generated an std::map of LedAction
104  */
105 const LedMap loadJsonConfig(const fs::path& path)
106 {
107     LedMap ledMap{};
108     PriorityMap priorityMap{};
109 
110     // define the default JSON as empty
111     const Json empty{};
112     auto json = readJson(path);
113     auto leds = json.value("leds", empty);
114 
115     for (const auto& entry : leds)
116     {
117         fs::path tmpPath(std::string{OBJPATH});
118         tmpPath /= entry.value("group", "");
119         auto objpath = tmpPath.string();
120         auto members = entry.value("members", empty);
121 
122         LedAction ledActions{};
123         for (const auto& member : members)
124         {
125             auto name = member.value("Name", "");
126             auto action = getAction(member.value("Action", ""));
127             uint8_t dutyOn = member.value("DutyOn", 50);
128             uint16_t period = member.value("Period", 0);
129 
130             // Since only have Blink/On and default priority is Blink
131             auto priority = getAction(member.value("Priority", "Blink"));
132 
133             // Same LEDs can be part of multiple groups. However, their
134             // priorities across groups need to match.
135             validatePriority(name, priority, priorityMap);
136 
137             phosphor::led::Layout::LedAction ledAction{name, action, dutyOn,
138                                                        period, priority};
139             ledActions.emplace(ledAction);
140         }
141 
142         // Generated an std::map of LedGroupNames to std::set of LEDs
143         // containing the name and properties.
144         ledMap.emplace(objpath, ledActions);
145     }
146 
147     return ledMap;
148 }
149 
150 /** @brief Get led map from LED groups JSON config
151  *
152  *  @param[in] config - Path to the JSON config.
153  *  @return LedMap - Generated an std::map of LedAction
154  *
155  *  @note if config is an empty string, daemon will interrogate dbus for
156  *        compatible strings.
157  */
158 const LedMap getSystemLedMap(fs::path config)
159 {
160     if (config.empty())
161     {
162         config = phosphor::led::getJsonConfig();
163     }
164 
165     return loadJsonConfig(config);
166 }
167