blob: f69ea5fdd0063e6a9c863ccb7bb0c447c97afc40 [file] [log] [blame]
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01001/*
2// Copyright (c) 2018 Intel Corporation
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15*/
16#pragma once
17
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080018#include "app.hpp"
19#include "dbus_singleton.hpp"
George Liu7a1dbc42022-12-07 16:03:22 +080020#include "dbus_utility.hpp"
Ed Tanous0ec8b832022-03-14 14:56:47 -070021#include "generated/enums/sensor.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080022#include "query.hpp"
23#include "registries/privilege_registry.hpp"
Ed Tanous50ebd4a2023-01-19 19:03:17 -080024#include "str_utility.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080025#include "utils/dbus_utils.hpp"
26#include "utils/json_utils.hpp"
27#include "utils/query_param.hpp"
Ed Tanous0ec8b832022-03-14 14:56:47 -070028
Ed Tanous11ba3972022-07-11 09:50:41 -070029#include <boost/algorithm/string/classification.hpp>
Ed Tanous1d7c0052022-08-09 12:32:26 -070030#include <boost/algorithm/string/find.hpp>
31#include <boost/algorithm/string/predicate.hpp>
Ed Tanousc71d6122022-11-29 14:10:32 -080032#include <boost/algorithm/string/replace.hpp>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010033#include <boost/range/algorithm/replace_copy_if.hpp>
George Liue99073f2022-12-09 11:06:16 +080034#include <boost/system/error_code.hpp>
Ed Tanousef4c65b2023-04-24 15:28:50 -070035#include <boost/url/format.hpp>
Jonathan Doman1e1e5982021-06-11 09:36:17 -070036#include <sdbusplus/asio/property.hpp>
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +020037#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050038
George Liu7a1dbc42022-12-07 16:03:22 +080039#include <array>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050040#include <cmath>
Nan Zhoufe04d492022-06-22 17:10:41 +000041#include <iterator>
Ed Tanous283860f2022-08-29 14:08:50 -070042#include <limits>
Nan Zhoufe04d492022-06-22 17:10:41 +000043#include <map>
44#include <set>
George Liu7a1dbc42022-12-07 16:03:22 +080045#include <string_view>
Ed Tanousb5a76932020-09-29 16:16:58 -070046#include <utility>
Ed Tanousabf2add2019-01-22 16:40:12 -080047#include <variant>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010048
Ed Tanous1abe55e2018-09-05 08:30:59 -070049namespace redfish
50{
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010051
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020052namespace sensors
53{
54namespace node
55{
56static constexpr std::string_view power = "Power";
57static constexpr std::string_view sensors = "Sensors";
58static constexpr std::string_view thermal = "Thermal";
59} // namespace node
60
Ed Tanous02da7c52022-02-27 00:09:02 -080061// clang-format off
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020062namespace dbus
63{
Ed Tanouscf9e4172022-12-21 09:30:16 -080064constexpr auto powerPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080065 "/xyz/openbmc_project/sensors/voltage",
66 "/xyz/openbmc_project/sensors/power"
67});
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000068
Ed Tanouscf9e4172022-12-21 09:30:16 -080069constexpr auto sensorPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080070 "/xyz/openbmc_project/sensors/power",
71 "/xyz/openbmc_project/sensors/current",
72 "/xyz/openbmc_project/sensors/airflow",
Ed Tanous4e777662022-08-06 09:39:13 -070073 "/xyz/openbmc_project/sensors/humidity",
George Liue8204932021-02-01 14:42:49 +080074#ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
Ed Tanous02da7c52022-02-27 00:09:02 -080075 "/xyz/openbmc_project/sensors/voltage",
76 "/xyz/openbmc_project/sensors/fan_tach",
77 "/xyz/openbmc_project/sensors/temperature",
78 "/xyz/openbmc_project/sensors/fan_pwm",
79 "/xyz/openbmc_project/sensors/altitude",
80 "/xyz/openbmc_project/sensors/energy",
George Liue8204932021-02-01 14:42:49 +080081#endif
Ed Tanous02da7c52022-02-27 00:09:02 -080082 "/xyz/openbmc_project/sensors/utilization"
83});
84
Ed Tanouscf9e4172022-12-21 09:30:16 -080085constexpr auto thermalPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080086 "/xyz/openbmc_project/sensors/fan_tach",
87 "/xyz/openbmc_project/sensors/temperature",
88 "/xyz/openbmc_project/sensors/fan_pwm"
89});
90
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000091} // namespace dbus
Ed Tanous02da7c52022-02-27 00:09:02 -080092// clang-format on
93
Ed Tanouscf9e4172022-12-21 09:30:16 -080094using sensorPair =
95 std::pair<std::string_view, std::span<const std::string_view>>;
Ed Tanous02da7c52022-02-27 00:09:02 -080096static constexpr std::array<sensorPair, 3> paths = {
Ed Tanouscf9e4172022-12-21 09:30:16 -080097 {{node::power, dbus::powerPaths},
98 {node::sensors, dbus::sensorPaths},
99 {node::thermal, dbus::thermalPaths}}};
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000100
Ed Tanous0ec8b832022-03-14 14:56:47 -0700101inline sensor::ReadingType toReadingType(std::string_view sensorType)
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000102{
103 if (sensorType == "voltage")
104 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700105 return sensor::ReadingType::Voltage;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000106 }
107 if (sensorType == "power")
108 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700109 return sensor::ReadingType::Power;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000110 }
111 if (sensorType == "current")
112 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700113 return sensor::ReadingType::Current;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000114 }
115 if (sensorType == "fan_tach")
116 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700117 return sensor::ReadingType::Rotational;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000118 }
119 if (sensorType == "temperature")
120 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700121 return sensor::ReadingType::Temperature;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000122 }
123 if (sensorType == "fan_pwm" || sensorType == "utilization")
124 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700125 return sensor::ReadingType::Percent;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000126 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600127 if (sensorType == "humidity")
128 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700129 return sensor::ReadingType::Humidity;
Gunnar Mills5deabed2022-04-20 13:43:45 -0600130 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000131 if (sensorType == "altitude")
132 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700133 return sensor::ReadingType::Altitude;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000134 }
135 if (sensorType == "airflow")
136 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700137 return sensor::ReadingType::AirFlow;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000138 }
139 if (sensorType == "energy")
140 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700141 return sensor::ReadingType::EnergyJoules;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000142 }
Ed Tanous0ec8b832022-03-14 14:56:47 -0700143 return sensor::ReadingType::Invalid;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000144}
145
Ed Tanous1d7c0052022-08-09 12:32:26 -0700146inline std::string_view toReadingUnits(std::string_view sensorType)
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000147{
148 if (sensorType == "voltage")
149 {
150 return "V";
151 }
152 if (sensorType == "power")
153 {
154 return "W";
155 }
156 if (sensorType == "current")
157 {
158 return "A";
159 }
160 if (sensorType == "fan_tach")
161 {
162 return "RPM";
163 }
164 if (sensorType == "temperature")
165 {
166 return "Cel";
167 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600168 if (sensorType == "fan_pwm" || sensorType == "utilization" ||
169 sensorType == "humidity")
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000170 {
171 return "%";
172 }
173 if (sensorType == "altitude")
174 {
175 return "m";
176 }
177 if (sensorType == "airflow")
178 {
179 return "cft_i/min";
180 }
181 if (sensorType == "energy")
182 {
183 return "J";
184 }
185 return "";
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200186}
187} // namespace sensors
188
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100189/**
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200190 * SensorsAsyncResp
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100191 * Gathers data needed for response processing after async calls are done
192 */
Ed Tanous1abe55e2018-09-05 08:30:59 -0700193class SensorsAsyncResp
194{
195 public:
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200196 using DataCompleteCb = std::function<void(
197 const boost::beast::http::status status,
Nan Zhoufe04d492022-06-22 17:10:41 +0000198 const std::map<std::string, std::string>& uriToDbus)>;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200199
200 struct SensorData
201 {
202 const std::string name;
203 std::string uri;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200204 const std::string dbusPath;
205 };
206
Ed Tanous8a592812022-06-04 09:06:59 -0700207 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
zhanghch058d1b46d2021-04-01 11:18:24 +0800208 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800209 std::span<const std::string_view> typesIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800210 std::string_view subNode) :
Ed Tanous8a592812022-06-04 09:06:59 -0700211 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700212 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
213 efficientExpand(false)
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500214 {}
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200215
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200216 // Store extra data about sensor mapping and return it in callback
Ed Tanous8a592812022-06-04 09:06:59 -0700217 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
zhanghch058d1b46d2021-04-01 11:18:24 +0800218 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800219 std::span<const std::string_view> typesIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800220 std::string_view subNode,
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200221 DataCompleteCb&& creationComplete) :
Ed Tanous8a592812022-06-04 09:06:59 -0700222 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700223 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
224 efficientExpand(false), metadata{std::vector<SensorData>()},
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200225 dataComplete{std::move(creationComplete)}
226 {}
227
Nan Zhou928fefb2022-03-28 08:45:00 -0700228 // sensor collections expand
Ed Tanous8a592812022-06-04 09:06:59 -0700229 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
Nan Zhou928fefb2022-03-28 08:45:00 -0700230 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800231 std::span<const std::string_view> typesIn,
Ed Tanous8a592812022-06-04 09:06:59 -0700232 const std::string_view& subNode, bool efficientExpandIn) :
233 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700234 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
Ed Tanous8a592812022-06-04 09:06:59 -0700235 efficientExpand(efficientExpandIn)
Nan Zhou928fefb2022-03-28 08:45:00 -0700236 {}
237
Ed Tanous1abe55e2018-09-05 08:30:59 -0700238 ~SensorsAsyncResp()
239 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800240 if (asyncResp->res.result() ==
241 boost::beast::http::status::internal_server_error)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700242 {
243 // Reset the json object to clear out any data that made it in
244 // before the error happened todo(ed) handle error condition with
245 // proper code
zhanghch058d1b46d2021-04-01 11:18:24 +0800246 asyncResp->res.jsonValue = nlohmann::json::object();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700247 }
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200248
249 if (dataComplete && metadata)
250 {
Nan Zhoufe04d492022-06-22 17:10:41 +0000251 std::map<std::string, std::string> map;
zhanghch058d1b46d2021-04-01 11:18:24 +0800252 if (asyncResp->res.result() == boost::beast::http::status::ok)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200253 {
254 for (auto& sensor : *metadata)
255 {
Ed Tanousc1d019a2022-08-06 09:36:06 -0700256 map.emplace(sensor.uri, sensor.dbusPath);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200257 }
258 }
zhanghch058d1b46d2021-04-01 11:18:24 +0800259 dataComplete(asyncResp->res.result(), map);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200260 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700261 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100262
Ed Tanousecd6a3a2022-01-07 09:18:40 -0800263 SensorsAsyncResp(const SensorsAsyncResp&) = delete;
264 SensorsAsyncResp(SensorsAsyncResp&&) = delete;
265 SensorsAsyncResp& operator=(const SensorsAsyncResp&) = delete;
266 SensorsAsyncResp& operator=(SensorsAsyncResp&&) = delete;
267
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200268 void addMetadata(const nlohmann::json& sensorObject,
Ed Tanousc1d019a2022-08-06 09:36:06 -0700269 const std::string& dbusPath)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200270 {
271 if (metadata)
272 {
Ed Tanousc1d019a2022-08-06 09:36:06 -0700273 metadata->emplace_back(SensorData{
274 sensorObject["Name"], sensorObject["@odata.id"], dbusPath});
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200275 }
276 }
277
278 void updateUri(const std::string& name, const std::string& uri)
279 {
280 if (metadata)
281 {
282 for (auto& sensor : *metadata)
283 {
284 if (sensor.name == name)
285 {
286 sensor.uri = uri;
287 }
288 }
289 }
290 }
291
zhanghch058d1b46d2021-04-01 11:18:24 +0800292 const std::shared_ptr<bmcweb::AsyncResp> asyncResp;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200293 const std::string chassisId;
Ed Tanouscf9e4172022-12-21 09:30:16 -0800294 const std::span<const std::string_view> types;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200295 const std::string chassisSubNode;
Nan Zhou928fefb2022-03-28 08:45:00 -0700296 const bool efficientExpand;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200297
298 private:
299 std::optional<std::vector<SensorData>> metadata;
300 DataCompleteCb dataComplete;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100301};
302
303/**
Anthony Wilsond5005492019-07-31 16:34:17 -0500304 * Possible states for physical inventory leds
305 */
306enum class LedState
307{
308 OFF,
309 ON,
310 BLINK,
311 UNKNOWN
312};
313
314/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500315 * D-Bus inventory item associated with one or more sensors.
316 */
317class InventoryItem
318{
319 public:
Ed Tanous4e23a442022-06-06 09:57:26 -0700320 explicit InventoryItem(const std::string& objPath) : objectPath(objPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500321 {
322 // Set inventory item name to last node of object path
George Liu28aa8de2021-02-01 15:13:30 +0800323 sdbusplus::message::object_path path(objectPath);
324 name = path.filename();
325 if (name.empty())
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500326 {
George Liu28aa8de2021-02-01 15:13:30 +0800327 BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500328 }
329 }
330
331 std::string objectPath;
332 std::string name;
Ed Tanouse05aec52022-01-25 10:28:56 -0800333 bool isPresent = true;
334 bool isFunctional = true;
335 bool isPowerSupply = false;
336 int powerSupplyEfficiencyPercent = -1;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500337 std::string manufacturer;
338 std::string model;
339 std::string partNumber;
340 std::string serialNumber;
341 std::set<std::string> sensors;
Anthony Wilsond5005492019-07-31 16:34:17 -0500342 std::string ledObjectPath;
Ed Tanouse05aec52022-01-25 10:28:56 -0800343 LedState ledState = LedState::UNKNOWN;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500344};
345
346/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530347 * @brief Get objects with connection necessary for sensors
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200348 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100349 * @param sensorNames Sensors retrieved from chassis
350 * @param callback Callback for processing gathered connections
351 */
352template <typename Callback>
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530353void getObjectsWithConnection(
Ed Tanous81ce6092020-12-17 16:54:55 +0000354 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +0000355 const std::shared_ptr<std::set<std::string>>& sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530356 Callback&& callback)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700357{
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530358 BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700359 const std::string path = "/xyz/openbmc_project/sensors";
George Liue99073f2022-12-09 11:06:16 +0800360 constexpr std::array<std::string_view, 1> interfaces = {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700361 "xyz.openbmc_project.Sensor.Value"};
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100362
George Liue99073f2022-12-09 11:06:16 +0800363 // Make call to ObjectMapper to find all sensors objects
364 dbus::utility::getSubTree(
365 path, 2, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -0700366 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
George Liue99073f2022-12-09 11:06:16 +0800367 sensorNames](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -0700368 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +0800369 // Response handler for parsing objects subtree
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530370 BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700371 if (ec)
372 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800373 messages::internalError(sensorsAsyncResp->asyncResp->res);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530374 BMCWEB_LOG_ERROR
375 << "getObjectsWithConnection resp_handler: Dbus error " << ec;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700376 return;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100377 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100378
Ed Tanous1abe55e2018-09-05 08:30:59 -0700379 BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees";
380
381 // Make unique list of connections only for requested sensor types and
382 // found in the chassis
Nan Zhoufe04d492022-06-22 17:10:41 +0000383 std::set<std::string> connections;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530384 std::set<std::pair<std::string, std::string>> objectsWithConnection;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700385
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700386 BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size();
387 for (const std::string& tsensor : *sensorNames)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700388 {
389 BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor;
390 }
391
392 for (const std::pair<
393 std::string,
394 std::vector<std::pair<std::string, std::vector<std::string>>>>&
395 object : subtree)
396 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700397 if (sensorNames->find(object.first) != sensorNames->end())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700398 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700399 for (const std::pair<std::string, std::vector<std::string>>&
400 objData : object.second)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700401 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700402 BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first;
403 connections.insert(objData.first);
404 objectsWithConnection.insert(
405 std::make_pair(object.first, objData.first));
Ed Tanous1abe55e2018-09-05 08:30:59 -0700406 }
407 }
408 }
409 BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections";
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530410 callback(std::move(connections), std::move(objectsWithConnection));
411 BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit";
George Liue99073f2022-12-09 11:06:16 +0800412 });
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530413 BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit";
414}
415
416/**
417 * @brief Create connections necessary for sensors
418 * @param SensorsAsyncResp Pointer to object holding response data
419 * @param sensorNames Sensors retrieved from chassis
420 * @param callback Callback for processing gathered connections
421 */
422template <typename Callback>
Nan Zhoufe04d492022-06-22 17:10:41 +0000423void getConnections(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
424 const std::shared_ptr<std::set<std::string>> sensorNames,
425 Callback&& callback)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530426{
427 auto objectsWithConnectionCb =
Nan Zhoufe04d492022-06-22 17:10:41 +0000428 [callback](const std::set<std::string>& connections,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530429 const std::set<std::pair<std::string, std::string>>&
Ed Tanous3174e4d2020-10-07 11:41:22 -0700430 /*objectsWithConnection*/) { callback(connections); };
Ed Tanous81ce6092020-12-17 16:54:55 +0000431 getObjectsWithConnection(sensorsAsyncResp, sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530432 std::move(objectsWithConnectionCb));
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100433}
434
435/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700436 * @brief Shrinks the list of sensors for processing
437 * @param SensorsAysncResp The class holding the Redfish response
438 * @param allSensors A list of all the sensors associated to the
439 * chassis element (i.e. baseboard, front panel, etc...)
440 * @param activeSensors A list that is a reduction of the incoming
441 * allSensors list. Eliminate Thermal sensors when a Power request is
442 * made, and eliminate Power sensors when a Thermal request is made.
443 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000444inline void reduceSensorList(
Ed Tanous7f1cc262022-08-09 13:33:57 -0700445 crow::Response& res, std::string_view chassisSubNode,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800446 std::span<const std::string_view> sensorTypes,
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700447 const std::vector<std::string>* allSensors,
Nan Zhoufe04d492022-06-22 17:10:41 +0000448 const std::shared_ptr<std::set<std::string>>& activeSensors)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700449{
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700450 if ((allSensors == nullptr) || (activeSensors == nullptr))
451 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700452 messages::resourceNotFound(res, chassisSubNode,
453 chassisSubNode == sensors::node::thermal
454 ? "Temperatures"
455 : "Voltages");
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700456
457 return;
458 }
459 if (allSensors->empty())
460 {
461 // Nothing to do, the activeSensors object is also empty
462 return;
463 }
464
Ed Tanous7f1cc262022-08-09 13:33:57 -0700465 for (std::string_view type : sensorTypes)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700466 {
467 for (const std::string& sensor : *allSensors)
468 {
Ed Tanous11ba3972022-07-11 09:50:41 -0700469 if (sensor.starts_with(type))
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700470 {
471 activeSensors->emplace(sensor);
472 }
473 }
474 }
475}
476
Ed Tanous7f1cc262022-08-09 13:33:57 -0700477/*
478 *Populates the top level collection for a given subnode. Populates
479 *SensorCollection, Power, or Thermal schemas.
480 *
481 * */
482inline void populateChassisNode(nlohmann::json& jsonValue,
483 std::string_view chassisSubNode)
484{
485 if (chassisSubNode == sensors::node::power)
486 {
487 jsonValue["@odata.type"] = "#Power.v1_5_2.Power";
488 }
489 else if (chassisSubNode == sensors::node::thermal)
490 {
491 jsonValue["@odata.type"] = "#Thermal.v1_4_0.Thermal";
492 jsonValue["Fans"] = nlohmann::json::array();
493 jsonValue["Temperatures"] = nlohmann::json::array();
494 }
495 else if (chassisSubNode == sensors::node::sensors)
496 {
497 jsonValue["@odata.type"] = "#SensorCollection.SensorCollection";
498 jsonValue["Description"] = "Collection of Sensors for this Chassis";
499 jsonValue["Members"] = nlohmann::json::array();
500 jsonValue["Members@odata.count"] = 0;
501 }
502
503 if (chassisSubNode != sensors::node::sensors)
504 {
505 jsonValue["Id"] = chassisSubNode;
506 }
507 jsonValue["Name"] = chassisSubNode;
508}
509
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700510/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100511 * @brief Retrieves requested chassis sensors and redundancy data from DBus .
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200512 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100513 * @param callback Callback for next step in gathered sensor processing
514 */
515template <typename Callback>
Ed Tanous7f1cc262022-08-09 13:33:57 -0700516void getChassis(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
517 std::string_view chassisId, std::string_view chassisSubNode,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800518 std::span<const std::string_view> sensorTypes,
519 Callback&& callback)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700520{
521 BMCWEB_LOG_DEBUG << "getChassis enter";
George Liu7a1dbc42022-12-07 16:03:22 +0800522 constexpr std::array<std::string_view, 2> interfaces = {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700523 "xyz.openbmc_project.Inventory.Item.Board",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500524 "xyz.openbmc_project.Inventory.Item.Chassis"};
George Liu7a1dbc42022-12-07 16:03:22 +0800525
526 // Get the Chassis Collection
527 dbus::utility::getSubTreePaths(
528 "/xyz/openbmc_project/inventory", 0, interfaces,
Ed Tanous7f1cc262022-08-09 13:33:57 -0700529 [callback{std::forward<Callback>(callback)}, asyncResp,
530 chassisIdStr{std::string(chassisId)},
531 chassisSubNode{std::string(chassisSubNode)}, sensorTypes](
George Liu7a1dbc42022-12-07 16:03:22 +0800532 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -0700533 const dbus::utility::MapperGetSubTreePathsResponse& chassisPaths) {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700534 BMCWEB_LOG_DEBUG << "getChassis respHandler enter";
535 if (ec)
536 {
537 BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec;
Ed Tanous7f1cc262022-08-09 13:33:57 -0700538 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700539 return;
540 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700541 const std::string* chassisPath = nullptr;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700542 for (const std::string& chassis : chassisPaths)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700543 {
George Liu28aa8de2021-02-01 15:13:30 +0800544 sdbusplus::message::object_path path(chassis);
Ed Tanousf8fe53e2022-06-30 15:55:45 -0700545 std::string chassisName = path.filename();
George Liu28aa8de2021-02-01 15:13:30 +0800546 if (chassisName.empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700547 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700548 BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700549 continue;
550 }
Ed Tanous7f1cc262022-08-09 13:33:57 -0700551 if (chassisName == chassisIdStr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700552 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700553 chassisPath = &chassis;
554 break;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700555 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700556 }
557 if (chassisPath == nullptr)
558 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700559 messages::resourceNotFound(asyncResp->res, "Chassis", chassisIdStr);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700560 return;
561 }
Ed Tanous7f1cc262022-08-09 13:33:57 -0700562 populateChassisNode(asyncResp->res.jsonValue, chassisSubNode);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700563
Ed Tanousef4c65b2023-04-24 15:28:50 -0700564 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
565 "/redfish/v1/Chassis/{}/{}", chassisIdStr, chassisSubNode);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500566
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500567 // Get the list of all sensors for this Chassis element
568 std::string sensorPath = *chassisPath + "/all_sensors";
George Liu6c3e9452023-03-03 13:55:29 +0800569 dbus::utility::getAssociationEndPoints(
570 sensorPath,
Ed Tanous7f1cc262022-08-09 13:33:57 -0700571 [asyncResp, chassisSubNode, sensorTypes,
Ed Tanousf94c4ec2022-01-06 12:44:41 -0800572 callback{std::forward<const Callback>(callback)}](
Ed Tanous271584a2019-07-09 16:24:22 -0700573 const boost::system::error_code& e,
George Liu6c3e9452023-03-03 13:55:29 +0800574 const dbus::utility::MapperEndPoints& nodeSensorList) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700575 if (e)
576 {
577 if (e.value() != EBADR)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700578 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700579 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -0700580 return;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700581 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700582 }
Nan Zhoufe04d492022-06-22 17:10:41 +0000583 const std::shared_ptr<std::set<std::string>> culledSensorList =
584 std::make_shared<std::set<std::string>>();
Ed Tanous7f1cc262022-08-09 13:33:57 -0700585 reduceSensorList(asyncResp->res, chassisSubNode, sensorTypes,
586 &nodeSensorList, culledSensorList);
587 BMCWEB_LOG_DEBUG << "Finishing with " << culledSensorList->size();
Ed Tanous002d39b2022-05-31 08:59:27 -0700588 callback(culledSensorList);
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700589 });
George Liu7a1dbc42022-12-07 16:03:22 +0800590 });
Ed Tanous1abe55e2018-09-05 08:30:59 -0700591 BMCWEB_LOG_DEBUG << "getChassis exit";
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100592}
593
594/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500595 * @brief Returns the Redfish State value for the specified inventory item.
596 * @param inventoryItem D-Bus inventory item associated with a sensor.
597 * @return State value for inventory item.
James Feist34dd1792019-05-17 14:10:54 -0700598 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000599inline std::string getState(const InventoryItem* inventoryItem)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500600{
601 if ((inventoryItem != nullptr) && !(inventoryItem->isPresent))
602 {
603 return "Absent";
604 }
James Feist34dd1792019-05-17 14:10:54 -0700605
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500606 return "Enabled";
607}
608
609/**
610 * @brief Returns the Redfish Health value for the specified sensor.
611 * @param sensorJson Sensor JSON object.
Ed Tanous1d7c0052022-08-09 12:32:26 -0700612 * @param valuesDict Map of all sensor DBus values.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500613 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
614 * be nullptr if no associated inventory item was found.
615 * @return Health value for sensor.
616 */
Ed Tanous1d7c0052022-08-09 12:32:26 -0700617inline std::string getHealth(nlohmann::json& sensorJson,
618 const dbus::utility::DBusPropertiesMap& valuesDict,
619 const InventoryItem* inventoryItem)
James Feist34dd1792019-05-17 14:10:54 -0700620{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500621 // Get current health value (if any) in the sensor JSON object. Some JSON
622 // objects contain multiple sensors (such as PowerSupplies). We want to set
623 // the overall health to be the most severe of any of the sensors.
624 std::string currentHealth;
625 auto statusIt = sensorJson.find("Status");
626 if (statusIt != sensorJson.end())
627 {
628 auto healthIt = statusIt->find("Health");
629 if (healthIt != statusIt->end())
630 {
631 std::string* health = healthIt->get_ptr<std::string*>();
632 if (health != nullptr)
633 {
634 currentHealth = *health;
635 }
636 }
637 }
638
639 // If current health in JSON object is already Critical, return that. This
640 // should override the sensor health, which might be less severe.
641 if (currentHealth == "Critical")
642 {
643 return "Critical";
644 }
645
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200646 const bool* criticalAlarmHigh = nullptr;
647 const bool* criticalAlarmLow = nullptr;
648 const bool* warningAlarmHigh = nullptr;
649 const bool* warningAlarmLow = nullptr;
Ed Tanous711ac7a2021-12-20 09:34:41 -0800650
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200651 const bool success = sdbusplus::unpackPropertiesNoThrow(
652 dbus_utils::UnpackErrorPrinter(), valuesDict, "CriticalAlarmHigh",
653 criticalAlarmHigh, "CriticalAlarmLow", criticalAlarmLow,
654 "WarningAlarmHigh", warningAlarmHigh, "WarningAlarmLow",
655 warningAlarmLow);
656
657 if (success)
James Feist34dd1792019-05-17 14:10:54 -0700658 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200659 // Check if sensor has critical threshold alarm
660 if ((criticalAlarmHigh != nullptr && *criticalAlarmHigh) ||
661 (criticalAlarmLow != nullptr && *criticalAlarmLow))
James Feist34dd1792019-05-17 14:10:54 -0700662 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200663 return "Critical";
James Feist34dd1792019-05-17 14:10:54 -0700664 }
665 }
666
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500667 // Check if associated inventory item is not functional
668 if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional))
669 {
670 return "Critical";
671 }
672
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200673 // If current health in JSON object is already Warning, return that. This
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500674 // should override the sensor status, which might be less severe.
675 if (currentHealth == "Warning")
676 {
677 return "Warning";
678 }
679
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200680 if (success)
James Feist34dd1792019-05-17 14:10:54 -0700681 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200682 // Check if sensor has warning threshold alarm
683 if ((warningAlarmHigh != nullptr && *warningAlarmHigh) ||
684 (warningAlarmLow != nullptr && *warningAlarmLow))
James Feist34dd1792019-05-17 14:10:54 -0700685 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200686 return "Warning";
James Feist34dd1792019-05-17 14:10:54 -0700687 }
688 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500689
James Feist34dd1792019-05-17 14:10:54 -0700690 return "OK";
691}
692
Ed Tanous23a21a12020-07-25 04:45:05 +0000693inline void setLedState(nlohmann::json& sensorJson,
Anthony Wilsond5005492019-07-31 16:34:17 -0500694 const InventoryItem* inventoryItem)
695{
696 if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty())
697 {
698 switch (inventoryItem->ledState)
699 {
700 case LedState::OFF:
701 sensorJson["IndicatorLED"] = "Off";
702 break;
703 case LedState::ON:
704 sensorJson["IndicatorLED"] = "Lit";
705 break;
706 case LedState::BLINK:
707 sensorJson["IndicatorLED"] = "Blinking";
708 break;
Ed Tanous23a21a12020-07-25 04:45:05 +0000709 case LedState::UNKNOWN:
Anthony Wilsond5005492019-07-31 16:34:17 -0500710 break;
711 }
712 }
713}
714
James Feist34dd1792019-05-17 14:10:54 -0700715/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100716 * @brief Builds a json sensor representation of a sensor.
717 * @param sensorName The name of the sensor to be built
Gunnar Mills274fad52018-06-13 15:45:36 -0500718 * @param sensorType The type (temperature, fan_tach, etc) of the sensor to
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100719 * build
Ed Tanous1d7c0052022-08-09 12:32:26 -0700720 * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor
721 * @param propertiesDict A dictionary of the properties to build the sensor
722 * from.
723 * @param sensorJson The json object to fill
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500724 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
725 * be nullptr if no associated inventory item was found.
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100726 */
Ed Tanous1d7c0052022-08-09 12:32:26 -0700727inline void objectPropertiesToJson(
728 std::string_view sensorName, std::string_view sensorType,
729 std::string_view chassisSubNode,
730 const dbus::utility::DBusPropertiesMap& propertiesDict,
Ed Tanous81ce6092020-12-17 16:54:55 +0000731 nlohmann::json& sensorJson, InventoryItem* inventoryItem)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700732{
Ed Tanous1d7c0052022-08-09 12:32:26 -0700733 if (chassisSubNode == sensors::node::sensors)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500734 {
Ed Tanousc71d6122022-11-29 14:10:32 -0800735 std::string subNodeEscaped(sensorType);
Ed Tanousc1d019a2022-08-06 09:36:06 -0700736 subNodeEscaped.erase(
737 std::remove(subNodeEscaped.begin(), subNodeEscaped.end(), '_'),
738 subNodeEscaped.end());
739
740 // For sensors in SensorCollection we set Id instead of MemberId,
741 // including power sensors.
742 subNodeEscaped += '_';
743 subNodeEscaped += sensorName;
744 sensorJson["Id"] = std::move(subNodeEscaped);
745
Ed Tanous1d7c0052022-08-09 12:32:26 -0700746 std::string sensorNameEs(sensorName);
747 std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
748 sensorJson["Name"] = std::move(sensorNameEs);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500749 }
750 else if (sensorType != "power")
751 {
752 // Set MemberId and Name for non-power sensors. For PowerSupplies and
753 // PowerControl, those properties have more general values because
754 // multiple sensors can be stored in the same JSON object.
Ed Tanous1d7c0052022-08-09 12:32:26 -0700755 std::string sensorNameEs(sensorName);
756 std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
757 sensorJson["Name"] = std::move(sensorNameEs);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500758 }
Ed Tanouse742b6c2019-05-03 15:06:53 -0700759
Ed Tanous81ce6092020-12-17 16:54:55 +0000760 sensorJson["Status"]["State"] = getState(inventoryItem);
Patrick Williams89492a12023-05-10 07:51:34 -0500761 sensorJson["Status"]["Health"] = getHealth(sensorJson, propertiesDict,
762 inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700763
764 // Parameter to set to override the type we get from dbus, and force it to
765 // int, regardless of what is available. This is used for schemas like fan,
766 // that require integers, not floats.
767 bool forceToInt = false;
768
Anthony Wilson3929aca2019-07-19 15:42:33 -0500769 nlohmann::json::json_pointer unit("/Reading");
Ed Tanous1d7c0052022-08-09 12:32:26 -0700770 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500771 {
Shounak Mitra2a4ba192022-06-01 23:34:12 +0000772 sensorJson["@odata.type"] = "#Sensor.v1_2_0.Sensor";
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000773
Ed Tanous0ec8b832022-03-14 14:56:47 -0700774 sensor::ReadingType readingType = sensors::toReadingType(sensorType);
775 if (readingType == sensor::ReadingType::Invalid)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500776 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000777 BMCWEB_LOG_ERROR << "Redfish cannot map reading type for "
778 << sensorType;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500779 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000780 else
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500781 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000782 sensorJson["ReadingType"] = readingType;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500783 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000784
Ed Tanous1d7c0052022-08-09 12:32:26 -0700785 std::string_view readingUnits = sensors::toReadingUnits(sensorType);
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000786 if (readingUnits.empty())
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200787 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000788 BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for "
789 << sensorType;
790 }
791 else
792 {
793 sensorJson["ReadingUnits"] = readingUnits;
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200794 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500795 }
796 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700797 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500798 unit = "/ReadingCelsius"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000799 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700800 // TODO(ed) Documentation says that path should be type fan_tach,
801 // implementation seems to implement fan
802 }
803 else if (sensorType == "fan" || sensorType == "fan_tach")
804 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500805 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000806 sensorJson["ReadingUnits"] = "RPM";
807 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
808 setLedState(sensorJson, inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700809 forceToInt = true;
810 }
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700811 else if (sensorType == "fan_pwm")
812 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500813 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000814 sensorJson["ReadingUnits"] = "Percent";
815 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
816 setLedState(sensorJson, inventoryItem);
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700817 forceToInt = true;
818 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700819 else if (sensorType == "voltage")
820 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500821 unit = "/ReadingVolts"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000822 sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700823 }
Ed Tanous2474adf2018-09-05 16:31:16 -0700824 else if (sensorType == "power")
825 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700826 if (boost::iequals(sensorName, "total_power"))
Eddie James028f7eb2019-05-17 21:24:36 +0000827 {
Ed Tanous81ce6092020-12-17 16:54:55 +0000828 sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl";
Gunnar Mills7ab06f42019-07-02 13:07:16 -0500829 // Put multiple "sensors" into a single PowerControl, so have
830 // generic names for MemberId and Name. Follows Redfish mockup.
Ed Tanous81ce6092020-12-17 16:54:55 +0000831 sensorJson["MemberId"] = "0";
832 sensorJson["Name"] = "Chassis Power Control";
Anthony Wilson3929aca2019-07-19 15:42:33 -0500833 unit = "/PowerConsumedWatts"_json_pointer;
Eddie James028f7eb2019-05-17 21:24:36 +0000834 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700835 else if (boost::ifind_first(sensorName, "input").empty())
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700836 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500837 unit = "/PowerInputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700838 }
839 else
840 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500841 unit = "/PowerOutputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700842 }
Ed Tanous2474adf2018-09-05 16:31:16 -0700843 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700844 else
845 {
846 BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName;
847 return;
848 }
849 // Map of dbus interface name, dbus property name and redfish property_name
Anthony Wilson3929aca2019-07-19 15:42:33 -0500850 std::vector<
851 std::tuple<const char*, const char*, nlohmann::json::json_pointer>>
852 properties;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700853 properties.reserve(7);
854
855 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600856
Ed Tanous1d7c0052022-08-09 12:32:26 -0700857 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson3929aca2019-07-19 15:42:33 -0500858 {
859 properties.emplace_back(
860 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh",
861 "/Thresholds/UpperCaution/Reading"_json_pointer);
862 properties.emplace_back(
863 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow",
864 "/Thresholds/LowerCaution/Reading"_json_pointer);
865 properties.emplace_back(
866 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh",
867 "/Thresholds/UpperCritical/Reading"_json_pointer);
868 properties.emplace_back(
869 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow",
870 "/Thresholds/LowerCritical/Reading"_json_pointer);
871 }
872 else if (sensorType != "power")
Shawn McCarneyde629b62019-03-08 10:42:51 -0600873 {
874 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500875 "WarningHigh",
876 "/UpperThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600877 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500878 "WarningLow",
879 "/LowerThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600880 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500881 "CriticalHigh",
882 "/UpperThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600883 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500884 "CriticalLow",
885 "/LowerThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600886 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700887
Ed Tanous2474adf2018-09-05 16:31:16 -0700888 // TODO Need to get UpperThresholdFatal and LowerThresholdFatal
889
Ed Tanous1d7c0052022-08-09 12:32:26 -0700890 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500891 {
892 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500893 "/ReadingRangeMin"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500894 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500895 "/ReadingRangeMax"_json_pointer);
George Liu51c35a82022-10-13 20:22:14 +0800896 properties.emplace_back("xyz.openbmc_project.Sensor.Accuracy",
897 "Accuracy", "/Accuracy"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500898 }
899 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700900 {
901 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500902 "/MinReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700903 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500904 "/MaxReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700905 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500906 else if (sensorType != "power")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700907 {
908 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500909 "/MinReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700910 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500911 "/MaxReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700912 }
913
Anthony Wilson3929aca2019-07-19 15:42:33 -0500914 for (const std::tuple<const char*, const char*,
915 nlohmann::json::json_pointer>& p : properties)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700916 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700917 for (const auto& [valueName, valueVariant] : propertiesDict)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700918 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700919 if (valueName != std::get<1>(p))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700920 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800921 continue;
922 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700923
924 // The property we want to set may be nested json, so use
925 // a json_pointer for easy indexing into the json structure.
926 const nlohmann::json::json_pointer& key = std::get<2>(p);
927
Ed Tanous1d7c0052022-08-09 12:32:26 -0700928 const double* doubleValue = std::get_if<double>(&valueVariant);
Ed Tanous40e4f382022-08-09 18:42:51 -0700929 if (doubleValue == nullptr)
Ed Tanous711ac7a2021-12-20 09:34:41 -0800930 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700931 BMCWEB_LOG_ERROR << "Got value interface that wasn't double";
Ed Tanous1d7c0052022-08-09 12:32:26 -0700932 continue;
933 }
Ed Tanous283860f2022-08-29 14:08:50 -0700934 if (!std::isfinite(*doubleValue))
935 {
936 if (valueName == "Value")
937 {
938 // Readings are allowed to be NAN for unavailable; coerce
939 // them to null in the json response.
940 sensorJson[key] = nullptr;
941 continue;
942 }
943 BMCWEB_LOG_WARNING << "Sensor value for " << valueName
944 << " was unexpectedly " << *doubleValue;
945 continue;
946 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700947 if (forceToInt)
948 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700949 sensorJson[key] = static_cast<int64_t>(*doubleValue);
Ed Tanous1d7c0052022-08-09 12:32:26 -0700950 }
951 else
952 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700953 sensorJson[key] = *doubleValue;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700954 }
955 }
956 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100957}
958
Ed Tanous1d7c0052022-08-09 12:32:26 -0700959/**
960 * @brief Builds a json sensor representation of a sensor.
961 * @param sensorName The name of the sensor to be built
962 * @param sensorType The type (temperature, fan_tach, etc) of the sensor to
963 * build
964 * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor
965 * @param interfacesDict A dictionary of the interfaces and properties of said
966 * interfaces to be built from
967 * @param sensorJson The json object to fill
968 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
969 * be nullptr if no associated inventory item was found.
970 */
971inline void objectInterfacesToJson(
972 const std::string& sensorName, const std::string& sensorType,
973 const std::string& chassisSubNode,
974 const dbus::utility::DBusInteracesMap& interfacesDict,
975 nlohmann::json& sensorJson, InventoryItem* inventoryItem)
976{
Ed Tanous1d7c0052022-08-09 12:32:26 -0700977 for (const auto& [interface, valuesDict] : interfacesDict)
978 {
979 objectPropertiesToJson(sensorName, sensorType, chassisSubNode,
980 valuesDict, sensorJson, inventoryItem);
981 }
Ed Tanousc1d019a2022-08-06 09:36:06 -0700982 BMCWEB_LOG_DEBUG << "Added sensor " << sensorName;
Ed Tanous1d7c0052022-08-09 12:32:26 -0700983}
984
Ed Tanousb5a76932020-09-29 16:16:58 -0700985inline void populateFanRedundancy(
986 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
James Feist8bd25cc2019-03-15 15:14:00 -0700987{
George Liue99073f2022-12-09 11:06:16 +0800988 constexpr std::array<std::string_view, 1> interfaces = {
989 "xyz.openbmc_project.Control.FanRedundancy"};
990 dbus::utility::getSubTree(
991 "/xyz/openbmc_project/control", 2, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800992 [sensorsAsyncResp](
George Liue99073f2022-12-09 11:06:16 +0800993 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800994 const dbus::utility::MapperGetSubTreeResponse& resp) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700995 if (ec)
996 {
997 return; // don't have to have this interface
998 }
George Liu6c3e9452023-03-03 13:55:29 +0800999 for (const std::pair<std::string, dbus::utility::MapperServiceMap>&
Ed Tanous002d39b2022-05-31 08:59:27 -07001000 pathPair : resp)
1001 {
1002 const std::string& path = pathPair.first;
George Liu6c3e9452023-03-03 13:55:29 +08001003 const dbus::utility::MapperServiceMap& objDict = pathPair.second;
Ed Tanous002d39b2022-05-31 08:59:27 -07001004 if (objDict.empty())
James Feist8bd25cc2019-03-15 15:14:00 -07001005 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001006 continue; // this should be impossible
James Feist8bd25cc2019-03-15 15:14:00 -07001007 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001008
1009 const std::string& owner = objDict.begin()->first;
George Liu6c3e9452023-03-03 13:55:29 +08001010 dbus::utility::getAssociationEndPoints(
1011 path + "/chassis",
1012 [path, owner, sensorsAsyncResp](
1013 const boost::system::error_code& e,
1014 const dbus::utility::MapperEndPoints& endpoints) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001015 if (e)
James Feist8bd25cc2019-03-15 15:14:00 -07001016 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001017 return; // if they don't have an association we
1018 // can't tell what chassis is
James Feist8bd25cc2019-03-15 15:14:00 -07001019 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001020 auto found =
1021 std::find_if(endpoints.begin(), endpoints.end(),
1022 [sensorsAsyncResp](const std::string& entry) {
1023 return entry.find(sensorsAsyncResp->chassisId) !=
1024 std::string::npos;
1025 });
James Feist8bd25cc2019-03-15 15:14:00 -07001026
Ed Tanous002d39b2022-05-31 08:59:27 -07001027 if (found == endpoints.end())
1028 {
1029 return;
1030 }
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001031 sdbusplus::asio::getAllProperties(
1032 *crow::connections::systemBus, owner, path,
1033 "xyz.openbmc_project.Control.FanRedundancy",
Ed Tanous002d39b2022-05-31 08:59:27 -07001034 [path, sensorsAsyncResp](
1035 const boost::system::error_code& err,
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001036 const dbus::utility::DBusPropertiesMap& ret) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001037 if (err)
1038 {
1039 return; // don't have to have this
1040 // interface
1041 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001042
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001043 const uint8_t* allowedFailures = nullptr;
1044 const std::vector<std::string>* collection = nullptr;
1045 const std::string* status = nullptr;
1046
1047 const bool success = sdbusplus::unpackPropertiesNoThrow(
1048 dbus_utils::UnpackErrorPrinter(), ret,
1049 "AllowedFailures", allowedFailures, "Collection",
1050 collection, "Status", status);
1051
1052 if (!success)
1053 {
1054 messages::internalError(
1055 sensorsAsyncResp->asyncResp->res);
1056 return;
1057 }
1058
1059 if (allowedFailures == nullptr || collection == nullptr ||
1060 status == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -07001061 {
1062 BMCWEB_LOG_ERROR << "Invalid redundancy interface";
1063 messages::internalError(
1064 sensorsAsyncResp->asyncResp->res);
1065 return;
1066 }
1067
Ed Tanous002d39b2022-05-31 08:59:27 -07001068 sdbusplus::message::object_path objectPath(path);
1069 std::string name = objectPath.filename();
1070 if (name.empty())
1071 {
1072 // this should be impossible
1073 messages::internalError(
1074 sensorsAsyncResp->asyncResp->res);
1075 return;
1076 }
1077 std::replace(name.begin(), name.end(), '_', ' ');
1078
1079 std::string health;
1080
Ed Tanous11ba3972022-07-11 09:50:41 -07001081 if (status->ends_with("Full"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001082 {
1083 health = "OK";
1084 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001085 else if (status->ends_with("Degraded"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001086 {
1087 health = "Warning";
1088 }
1089 else
1090 {
1091 health = "Critical";
1092 }
1093 nlohmann::json::array_t redfishCollection;
1094 const auto& fanRedfish =
1095 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"];
1096 for (const std::string& item : *collection)
1097 {
Ed Tanous8a592812022-06-04 09:06:59 -07001098 sdbusplus::message::object_path itemPath(item);
1099 std::string itemName = itemPath.filename();
Ed Tanous002d39b2022-05-31 08:59:27 -07001100 if (itemName.empty())
James Feist8bd25cc2019-03-15 15:14:00 -07001101 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001102 continue;
James Feist8bd25cc2019-03-15 15:14:00 -07001103 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001104 /*
1105 todo(ed): merge patch that fixes the names
1106 std::replace(itemName.begin(),
1107 itemName.end(), '_', ' ');*/
1108 auto schemaItem =
1109 std::find_if(fanRedfish.begin(), fanRedfish.end(),
1110 [itemName](const nlohmann::json& fan) {
George Liu3e35c762023-03-08 16:56:38 +08001111 return fan["Name"] == itemName;
James Feist8bd25cc2019-03-15 15:14:00 -07001112 });
Ed Tanous002d39b2022-05-31 08:59:27 -07001113 if (schemaItem != fanRedfish.end())
James Feist8bd25cc2019-03-15 15:14:00 -07001114 {
Ed Tanous8a592812022-06-04 09:06:59 -07001115 nlohmann::json::object_t collectionId;
1116 collectionId["@odata.id"] =
Ed Tanous002d39b2022-05-31 08:59:27 -07001117 (*schemaItem)["@odata.id"];
1118 redfishCollection.emplace_back(
Ed Tanous8a592812022-06-04 09:06:59 -07001119 std::move(collectionId));
Ed Tanous002d39b2022-05-31 08:59:27 -07001120 }
1121 else
1122 {
1123 BMCWEB_LOG_ERROR << "failed to find fan in schema";
1124 messages::internalError(
1125 sensorsAsyncResp->asyncResp->res);
James Feist8bd25cc2019-03-15 15:14:00 -07001126 return;
1127 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001128 }
James Feist8bd25cc2019-03-15 15:14:00 -07001129
Patrick Williams89492a12023-05-10 07:51:34 -05001130 size_t minNumNeeded = collection->empty()
1131 ? 0
1132 : collection->size() -
1133 *allowedFailures;
Ed Tanous002d39b2022-05-31 08:59:27 -07001134 nlohmann::json& jResp = sensorsAsyncResp->asyncResp->res
1135 .jsonValue["Redundancy"];
James Feist8bd25cc2019-03-15 15:14:00 -07001136
Ed Tanous002d39b2022-05-31 08:59:27 -07001137 nlohmann::json::object_t redundancy;
Ed Tanousef4c65b2023-04-24 15:28:50 -07001138 boost::urls::url url =
1139 boost::urls::format("/redfish/v1/Chassis/{}/{}",
1140 sensorsAsyncResp->chassisId,
1141 sensorsAsyncResp->chassisSubNode);
Willy Tueddfc432022-09-26 16:46:38 +00001142 url.set_fragment(("/Redundancy"_json_pointer / jResp.size())
1143 .to_string());
1144 redundancy["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -07001145 redundancy["@odata.type"] = "#Redundancy.v1_3_2.Redundancy";
1146 redundancy["MinNumNeeded"] = minNumNeeded;
Ed Tanous002d39b2022-05-31 08:59:27 -07001147 redundancy["Mode"] = "N+m";
1148 redundancy["Name"] = name;
1149 redundancy["RedundancySet"] = redfishCollection;
1150 redundancy["Status"]["Health"] = health;
1151 redundancy["Status"]["State"] = "Enabled";
James Feist8bd25cc2019-03-15 15:14:00 -07001152
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001153 jResp.emplace_back(std::move(redundancy));
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001154 });
Ed Tanous002d39b2022-05-31 08:59:27 -07001155 });
1156 }
George Liue99073f2022-12-09 11:06:16 +08001157 });
James Feist8bd25cc2019-03-15 15:14:00 -07001158}
1159
Ed Tanousb5a76932020-09-29 16:16:58 -07001160inline void
Ed Tanous81ce6092020-12-17 16:54:55 +00001161 sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001162{
zhanghch058d1b46d2021-04-01 11:18:24 +08001163 nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001164 std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"};
Ed Tanous81ce6092020-12-17 16:54:55 +00001165 if (sensorsAsyncResp->chassisSubNode == sensors::node::power)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001166 {
1167 sensorHeaders = {"Voltages", "PowerSupplies"};
1168 }
1169 for (const std::string& sensorGroup : sensorHeaders)
1170 {
1171 nlohmann::json::iterator entry = response.find(sensorGroup);
1172 if (entry != response.end())
1173 {
1174 std::sort(entry->begin(), entry->end(),
Ed Tanous02cad962022-06-30 16:50:15 -07001175 [](const nlohmann::json& c1, const nlohmann::json& c2) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001176 return c1["Name"] < c2["Name"];
1177 });
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001178
1179 // add the index counts to the end of each entry
1180 size_t count = 0;
1181 for (nlohmann::json& sensorJson : *entry)
1182 {
1183 nlohmann::json::iterator odata = sensorJson.find("@odata.id");
1184 if (odata == sensorJson.end())
1185 {
1186 continue;
1187 }
1188 std::string* value = odata->get_ptr<std::string*>();
1189 if (value != nullptr)
1190 {
Willy Tueddfc432022-09-26 16:46:38 +00001191 *value += "/" + std::to_string(count);
George Liu3e35c762023-03-08 16:56:38 +08001192 sensorJson["MemberId"] = std::to_string(count);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001193 count++;
Ed Tanous81ce6092020-12-17 16:54:55 +00001194 sensorsAsyncResp->updateUri(sensorJson["Name"], *value);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001195 }
1196 }
1197 }
1198 }
1199}
1200
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01001201/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001202 * @brief Finds the inventory item with the specified object path.
1203 * @param inventoryItems D-Bus inventory items associated with sensors.
1204 * @param invItemObjPath D-Bus object path of inventory item.
1205 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001206 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001207inline InventoryItem* findInventoryItem(
Ed Tanousb5a76932020-09-29 16:16:58 -07001208 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001209 const std::string& invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001210{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001211 for (InventoryItem& inventoryItem : *inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001212 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001213 if (inventoryItem.objectPath == invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001214 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001215 return &inventoryItem;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001216 }
1217 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001218 return nullptr;
1219}
1220
1221/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001222 * @brief Finds the inventory item associated with the specified sensor.
1223 * @param inventoryItems D-Bus inventory items associated with sensors.
1224 * @param sensorObjPath D-Bus object path of sensor.
1225 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001226 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001227inline InventoryItem* findInventoryItemForSensor(
Ed Tanousb5a76932020-09-29 16:16:58 -07001228 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001229 const std::string& sensorObjPath)
1230{
1231 for (InventoryItem& inventoryItem : *inventoryItems)
1232 {
1233 if (inventoryItem.sensors.count(sensorObjPath) > 0)
1234 {
1235 return &inventoryItem;
1236 }
1237 }
1238 return nullptr;
1239}
1240
1241/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001242 * @brief Finds the inventory item associated with the specified led path.
1243 * @param inventoryItems D-Bus inventory items associated with sensors.
1244 * @param ledObjPath D-Bus object path of led.
1245 * @return Inventory item within vector, or nullptr if no match found.
1246 */
1247inline InventoryItem*
1248 findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems,
1249 const std::string& ledObjPath)
1250{
1251 for (InventoryItem& inventoryItem : inventoryItems)
1252 {
1253 if (inventoryItem.ledObjectPath == ledObjPath)
1254 {
1255 return &inventoryItem;
1256 }
1257 }
1258 return nullptr;
1259}
1260
1261/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001262 * @brief Adds inventory item and associated sensor to specified vector.
1263 *
1264 * Adds a new InventoryItem to the vector if necessary. Searches for an
1265 * existing InventoryItem with the specified object path. If not found, one is
1266 * added to the vector.
1267 *
1268 * Next, the specified sensor is added to the set of sensors associated with the
1269 * InventoryItem.
1270 *
1271 * @param inventoryItems D-Bus inventory items associated with sensors.
1272 * @param invItemObjPath D-Bus object path of inventory item.
1273 * @param sensorObjPath D-Bus object path of sensor
1274 */
Ed Tanousb5a76932020-09-29 16:16:58 -07001275inline void addInventoryItem(
1276 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
1277 const std::string& invItemObjPath, const std::string& sensorObjPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001278{
1279 // Look for inventory item in vector
Patrick Williams89492a12023-05-10 07:51:34 -05001280 InventoryItem* inventoryItem = findInventoryItem(inventoryItems,
1281 invItemObjPath);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001282
1283 // If inventory item doesn't exist in vector, add it
1284 if (inventoryItem == nullptr)
1285 {
1286 inventoryItems->emplace_back(invItemObjPath);
1287 inventoryItem = &(inventoryItems->back());
1288 }
1289
1290 // Add sensor to set of sensors associated with inventory item
1291 inventoryItem->sensors.emplace(sensorObjPath);
1292}
1293
1294/**
1295 * @brief Stores D-Bus data in the specified inventory item.
1296 *
1297 * Finds D-Bus data in the specified map of interfaces. Stores the data in the
1298 * specified InventoryItem.
1299 *
1300 * This data is later used to provide sensor property values in the JSON
1301 * response.
1302 *
1303 * @param inventoryItem Inventory item where data will be stored.
1304 * @param interfacesDict Map containing D-Bus interfaces and their properties
1305 * for the specified inventory item.
1306 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001307inline void storeInventoryItemData(
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001308 InventoryItem& inventoryItem,
Ed Tanous711ac7a2021-12-20 09:34:41 -08001309 const dbus::utility::DBusInteracesMap& interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001310{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001311 // Get properties from Inventory.Item interface
Ed Tanous711ac7a2021-12-20 09:34:41 -08001312
Ed Tanous9eb808c2022-01-25 10:19:23 -08001313 for (const auto& [interface, values] : interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001314 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001315 if (interface == "xyz.openbmc_project.Inventory.Item")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001316 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001317 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001318 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001319 if (name == "Present")
1320 {
1321 const bool* value = std::get_if<bool>(&dbusValue);
1322 if (value != nullptr)
1323 {
1324 inventoryItem.isPresent = *value;
1325 }
1326 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001327 }
1328 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001329 // Check if Inventory.Item.PowerSupply interface is present
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001330
Ed Tanous711ac7a2021-12-20 09:34:41 -08001331 if (interface == "xyz.openbmc_project.Inventory.Item.PowerSupply")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001332 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001333 inventoryItem.isPowerSupply = true;
1334 }
1335
1336 // Get properties from Inventory.Decorator.Asset interface
1337 if (interface == "xyz.openbmc_project.Inventory.Decorator.Asset")
1338 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001339 for (const auto& [name, dbusValue] : values)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001340 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001341 if (name == "Manufacturer")
1342 {
1343 const std::string* value =
1344 std::get_if<std::string>(&dbusValue);
1345 if (value != nullptr)
1346 {
1347 inventoryItem.manufacturer = *value;
1348 }
1349 }
1350 if (name == "Model")
1351 {
1352 const std::string* value =
1353 std::get_if<std::string>(&dbusValue);
1354 if (value != nullptr)
1355 {
1356 inventoryItem.model = *value;
1357 }
1358 }
1359 if (name == "SerialNumber")
1360 {
1361 const std::string* value =
1362 std::get_if<std::string>(&dbusValue);
1363 if (value != nullptr)
1364 {
1365 inventoryItem.serialNumber = *value;
1366 }
1367 }
1368 if (name == "PartNumber")
1369 {
1370 const std::string* value =
1371 std::get_if<std::string>(&dbusValue);
1372 if (value != nullptr)
1373 {
1374 inventoryItem.partNumber = *value;
1375 }
1376 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001377 }
1378 }
1379
Ed Tanous711ac7a2021-12-20 09:34:41 -08001380 if (interface ==
1381 "xyz.openbmc_project.State.Decorator.OperationalStatus")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001382 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001383 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001384 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001385 if (name == "Functional")
1386 {
1387 const bool* value = std::get_if<bool>(&dbusValue);
1388 if (value != nullptr)
1389 {
1390 inventoryItem.isFunctional = *value;
1391 }
1392 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001393 }
1394 }
1395 }
1396}
1397
1398/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001399 * @brief Gets D-Bus data for inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001400 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001401 * Uses the specified connections (services) to obtain D-Bus data for inventory
1402 * items associated with sensors. Stores the resulting data in the
1403 * inventoryItems vector.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001404 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001405 * This data is later used to provide sensor property values in the JSON
1406 * response.
1407 *
1408 * Finds the inventory item data asynchronously. Invokes callback when data has
1409 * been obtained.
1410 *
1411 * The callback must have the following signature:
1412 * @code
Anthony Wilsond5005492019-07-31 16:34:17 -05001413 * callback(void)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001414 * @endcode
1415 *
1416 * This function is called recursively, obtaining data asynchronously from one
1417 * connection in each call. This ensures the callback is not invoked until the
1418 * last asynchronous function has completed.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001419 *
1420 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001421 * @param inventoryItems D-Bus inventory items associated with sensors.
1422 * @param invConnections Connections that provide data for the inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001423 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001424 * @param callback Callback to invoke when inventory data has been obtained.
1425 * @param invConnectionsIndex Current index in invConnections. Only specified
1426 * in recursive calls to this function.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001427 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001428template <typename Callback>
1429static void getInventoryItemsData(
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001430 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001431 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07001432 std::shared_ptr<std::set<std::string>> invConnections, Callback&& callback,
1433 size_t invConnectionsIndex = 0)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001434{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001435 BMCWEB_LOG_DEBUG << "getInventoryItemsData enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001436
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001437 // If no more connections left, call callback
1438 if (invConnectionsIndex >= invConnections->size())
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001439 {
Anthony Wilsond5005492019-07-31 16:34:17 -05001440 callback();
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001441 BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
1442 return;
1443 }
1444
1445 // Get inventory item data from current connection
Nan Zhoufe04d492022-06-22 17:10:41 +00001446 auto it = invConnections->begin();
1447 std::advance(it, invConnectionsIndex);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001448 if (it != invConnections->end())
1449 {
1450 const std::string& invConnection = *it;
1451
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001452 // Response handler for GetManagedObjects
Ed Tanousd0090732022-10-04 17:22:56 -07001453 auto respHandler = [sensorsAsyncResp, inventoryItems, invConnections,
1454 callback{std::forward<Callback>(callback)},
1455 invConnectionsIndex](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001456 const boost::system::error_code& ec,
Ed Tanousd0090732022-10-04 17:22:56 -07001457 const dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001458 BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001459 if (ec)
1460 {
1461 BMCWEB_LOG_ERROR
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001462 << "getInventoryItemsData respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001463 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001464 return;
1465 }
1466
1467 // Loop through returned object paths
1468 for (const auto& objDictEntry : resp)
1469 {
1470 const std::string& objPath =
1471 static_cast<const std::string&>(objDictEntry.first);
1472
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001473 // If this object path is one of the specified inventory items
Patrick Williams89492a12023-05-10 07:51:34 -05001474 InventoryItem* inventoryItem = findInventoryItem(inventoryItems,
1475 objPath);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001476 if (inventoryItem != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001477 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001478 // Store inventory data in InventoryItem
1479 storeInventoryItemData(*inventoryItem, objDictEntry.second);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001480 }
1481 }
1482
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001483 // Recurse to get inventory item data from next connection
1484 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07001485 invConnections, std::move(callback),
1486 invConnectionsIndex + 1);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001487
1488 BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001489 };
1490
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001491 // Get all object paths and their interfaces for current connection
1492 crow::connections::systemBus->async_method_call(
Ed Tanousd0090732022-10-04 17:22:56 -07001493 std::move(respHandler), invConnection,
Ed Tanousf8bb0ff2022-12-09 11:08:45 -08001494 "/xyz/openbmc_project/inventory",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001495 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1496 }
1497
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001498 BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001499}
1500
1501/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001502 * @brief Gets connections that provide D-Bus data for inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001503 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001504 * Gets the D-Bus connections (services) that provide data for the inventory
1505 * items that are associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001506 *
1507 * Finds the connections asynchronously. Invokes callback when information has
1508 * been obtained.
1509 *
1510 * The callback must have the following signature:
1511 * @code
Nan Zhoufe04d492022-06-22 17:10:41 +00001512 * callback(std::shared_ptr<std::set<std::string>> invConnections)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001513 * @endcode
1514 *
1515 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001516 * @param inventoryItems D-Bus inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001517 * @param callback Callback to invoke when connections have been obtained.
1518 */
1519template <typename Callback>
1520static void getInventoryItemsConnections(
Ed Tanousb5a76932020-09-29 16:16:58 -07001521 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
1522 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001523 Callback&& callback)
1524{
1525 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter";
1526
1527 const std::string path = "/xyz/openbmc_project/inventory";
George Liue99073f2022-12-09 11:06:16 +08001528 constexpr std::array<std::string_view, 4> interfaces = {
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001529 "xyz.openbmc_project.Inventory.Item",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001530 "xyz.openbmc_project.Inventory.Item.PowerSupply",
1531 "xyz.openbmc_project.Inventory.Decorator.Asset",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001532 "xyz.openbmc_project.State.Decorator.OperationalStatus"};
1533
George Liue99073f2022-12-09 11:06:16 +08001534 // Make call to ObjectMapper to find all inventory items
1535 dbus::utility::getSubTree(
1536 path, 0, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -07001537 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1538 inventoryItems](
George Liue99073f2022-12-09 11:06:16 +08001539 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001540 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +08001541 // Response handler for parsing output from GetSubTree
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001542 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter";
1543 if (ec)
1544 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001545 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001546 BMCWEB_LOG_ERROR
1547 << "getInventoryItemsConnections respHandler DBus error " << ec;
1548 return;
1549 }
1550
1551 // Make unique list of connections for desired inventory items
Nan Zhoufe04d492022-06-22 17:10:41 +00001552 std::shared_ptr<std::set<std::string>> invConnections =
1553 std::make_shared<std::set<std::string>>();
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001554
1555 // Loop through objects from GetSubTree
1556 for (const std::pair<
1557 std::string,
1558 std::vector<std::pair<std::string, std::vector<std::string>>>>&
1559 object : subtree)
1560 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001561 // Check if object path is one of the specified inventory items
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001562 const std::string& objPath = object.first;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001563 if (findInventoryItem(inventoryItems, objPath) != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001564 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001565 // Store all connections to inventory item
1566 for (const std::pair<std::string, std::vector<std::string>>&
1567 objData : object.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001568 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001569 const std::string& invConnection = objData.first;
1570 invConnections->insert(invConnection);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001571 }
1572 }
1573 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001574
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001575 callback(invConnections);
1576 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit";
George Liue99073f2022-12-09 11:06:16 +08001577 });
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001578 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit";
1579}
1580
1581/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001582 * @brief Gets associations from sensors to inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001583 *
1584 * Looks for ObjectMapper associations from the specified sensors to related
Anthony Wilsond5005492019-07-31 16:34:17 -05001585 * inventory items. Then finds the associations from those inventory items to
1586 * their LEDs, if any.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001587 *
1588 * Finds the inventory items asynchronously. Invokes callback when information
1589 * has been obtained.
1590 *
1591 * The callback must have the following signature:
1592 * @code
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001593 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001594 * @endcode
1595 *
1596 * @param sensorsAsyncResp Pointer to object holding response data.
1597 * @param sensorNames All sensors within the current chassis.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001598 * implements ObjectManager.
1599 * @param callback Callback to invoke when inventory items have been obtained.
1600 */
1601template <typename Callback>
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001602static void getInventoryItemAssociations(
Ed Tanousb5a76932020-09-29 16:16:58 -07001603 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +00001604 const std::shared_ptr<std::set<std::string>>& sensorNames,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001605 Callback&& callback)
1606{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001607 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001608
1609 // Response handler for GetManagedObjects
Ed Tanous02cad962022-06-30 16:50:15 -07001610 auto respHandler =
1611 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001612 sensorNames](const boost::system::error_code& ec,
Ed Tanous02cad962022-06-30 16:50:15 -07001613 const dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001614 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001615 if (ec)
1616 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001617 BMCWEB_LOG_ERROR
1618 << "getInventoryItemAssociations respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001619 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001620 return;
1621 }
1622
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001623 // Create vector to hold list of inventory items
1624 std::shared_ptr<std::vector<InventoryItem>> inventoryItems =
1625 std::make_shared<std::vector<InventoryItem>>();
1626
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001627 // Loop through returned object paths
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001628 std::string sensorAssocPath;
1629 sensorAssocPath.reserve(128); // avoid memory allocations
1630 for (const auto& objDictEntry : resp)
1631 {
1632 const std::string& objPath =
1633 static_cast<const std::string&>(objDictEntry.first);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001634
1635 // If path is inventory association for one of the specified sensors
1636 for (const std::string& sensorName : *sensorNames)
1637 {
1638 sensorAssocPath = sensorName;
1639 sensorAssocPath += "/inventory";
1640 if (objPath == sensorAssocPath)
1641 {
1642 // Get Association interface for object path
Ed Tanous711ac7a2021-12-20 09:34:41 -08001643 for (const auto& [interface, values] : objDictEntry.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001644 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001645 if (interface == "xyz.openbmc_project.Association")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001646 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001647 for (const auto& [valueName, value] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001648 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001649 if (valueName == "endpoints")
1650 {
1651 const std::vector<std::string>* endpoints =
1652 std::get_if<std::vector<std::string>>(
1653 &value);
1654 if ((endpoints != nullptr) &&
1655 !endpoints->empty())
1656 {
1657 // Add inventory item to vector
1658 const std::string& invItemPath =
1659 endpoints->front();
1660 addInventoryItem(inventoryItems,
1661 invItemPath,
1662 sensorName);
1663 }
1664 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001665 }
1666 }
1667 }
1668 break;
1669 }
1670 }
1671 }
1672
Anthony Wilsond5005492019-07-31 16:34:17 -05001673 // Now loop through the returned object paths again, this time to
1674 // find the leds associated with the inventory items we just found
1675 std::string inventoryAssocPath;
1676 inventoryAssocPath.reserve(128); // avoid memory allocations
1677 for (const auto& objDictEntry : resp)
1678 {
1679 const std::string& objPath =
1680 static_cast<const std::string&>(objDictEntry.first);
Anthony Wilsond5005492019-07-31 16:34:17 -05001681
1682 for (InventoryItem& inventoryItem : *inventoryItems)
1683 {
1684 inventoryAssocPath = inventoryItem.objectPath;
1685 inventoryAssocPath += "/leds";
1686 if (objPath == inventoryAssocPath)
1687 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001688 for (const auto& [interface, values] : objDictEntry.second)
Anthony Wilsond5005492019-07-31 16:34:17 -05001689 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001690 if (interface == "xyz.openbmc_project.Association")
Anthony Wilsond5005492019-07-31 16:34:17 -05001691 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001692 for (const auto& [valueName, value] : values)
Anthony Wilsond5005492019-07-31 16:34:17 -05001693 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001694 if (valueName == "endpoints")
1695 {
1696 const std::vector<std::string>* endpoints =
1697 std::get_if<std::vector<std::string>>(
1698 &value);
1699 if ((endpoints != nullptr) &&
1700 !endpoints->empty())
1701 {
1702 // Add inventory item to vector
1703 // Store LED path in inventory item
1704 const std::string& ledPath =
1705 endpoints->front();
1706 inventoryItem.ledObjectPath = ledPath;
1707 }
1708 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001709 }
1710 }
1711 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001712
Anthony Wilsond5005492019-07-31 16:34:17 -05001713 break;
1714 }
1715 }
1716 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001717 callback(inventoryItems);
1718 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001719 };
1720
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001721 // Call GetManagedObjects on the ObjectMapper to get all associations
1722 crow::connections::systemBus->async_method_call(
Ed Tanousd0090732022-10-04 17:22:56 -07001723 std::move(respHandler), "xyz.openbmc_project.ObjectMapper", "/",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001724 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1725
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001726 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001727}
1728
1729/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001730 * @brief Gets D-Bus data for inventory item leds associated with sensors.
1731 *
1732 * Uses the specified connections (services) to obtain D-Bus data for inventory
1733 * item leds associated with sensors. Stores the resulting data in the
1734 * inventoryItems vector.
1735 *
1736 * This data is later used to provide sensor property values in the JSON
1737 * response.
1738 *
1739 * Finds the inventory item led data asynchronously. Invokes callback when data
1740 * has been obtained.
1741 *
1742 * The callback must have the following signature:
1743 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05001744 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05001745 * @endcode
1746 *
1747 * This function is called recursively, obtaining data asynchronously from one
1748 * connection in each call. This ensures the callback is not invoked until the
1749 * last asynchronous function has completed.
1750 *
1751 * @param sensorsAsyncResp Pointer to object holding response data.
1752 * @param inventoryItems D-Bus inventory items associated with sensors.
1753 * @param ledConnections Connections that provide data for the inventory leds.
1754 * @param callback Callback to invoke when inventory data has been obtained.
1755 * @param ledConnectionsIndex Current index in ledConnections. Only specified
1756 * in recursive calls to this function.
1757 */
1758template <typename Callback>
1759void getInventoryLedData(
1760 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1761 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Nan Zhoufe04d492022-06-22 17:10:41 +00001762 std::shared_ptr<std::map<std::string, std::string>> ledConnections,
Anthony Wilsond5005492019-07-31 16:34:17 -05001763 Callback&& callback, size_t ledConnectionsIndex = 0)
1764{
1765 BMCWEB_LOG_DEBUG << "getInventoryLedData enter";
1766
1767 // If no more connections left, call callback
1768 if (ledConnectionsIndex >= ledConnections->size())
1769 {
Gunnar Mills42cbe532019-08-15 15:26:54 -05001770 callback();
Anthony Wilsond5005492019-07-31 16:34:17 -05001771 BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
1772 return;
1773 }
1774
1775 // Get inventory item data from current connection
Nan Zhoufe04d492022-06-22 17:10:41 +00001776 auto it = ledConnections->begin();
1777 std::advance(it, ledConnectionsIndex);
Anthony Wilsond5005492019-07-31 16:34:17 -05001778 if (it != ledConnections->end())
1779 {
1780 const std::string& ledPath = (*it).first;
1781 const std::string& ledConnection = (*it).second;
1782 // Response handler for Get State property
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001783 auto respHandler =
1784 [sensorsAsyncResp, inventoryItems, ledConnections, ledPath,
Ed Tanousf94c4ec2022-01-06 12:44:41 -08001785 callback{std::forward<Callback>(callback)}, ledConnectionsIndex](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001786 const boost::system::error_code& ec, const std::string& state) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001787 BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter";
1788 if (ec)
1789 {
1790 BMCWEB_LOG_ERROR
1791 << "getInventoryLedData respHandler DBus error " << ec;
1792 messages::internalError(sensorsAsyncResp->asyncResp->res);
1793 return;
1794 }
1795
1796 BMCWEB_LOG_DEBUG << "Led state: " << state;
1797 // Find inventory item with this LED object path
1798 InventoryItem* inventoryItem =
1799 findInventoryItemForLed(*inventoryItems, ledPath);
1800 if (inventoryItem != nullptr)
1801 {
1802 // Store LED state in InventoryItem
Ed Tanous11ba3972022-07-11 09:50:41 -07001803 if (state.ends_with("On"))
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001804 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001805 inventoryItem->ledState = LedState::ON;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001806 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001807 else if (state.ends_with("Blink"))
Anthony Wilsond5005492019-07-31 16:34:17 -05001808 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001809 inventoryItem->ledState = LedState::BLINK;
Anthony Wilsond5005492019-07-31 16:34:17 -05001810 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001811 else if (state.ends_with("Off"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001812 {
1813 inventoryItem->ledState = LedState::OFF;
1814 }
1815 else
1816 {
1817 inventoryItem->ledState = LedState::UNKNOWN;
1818 }
1819 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001820
Ed Tanous002d39b2022-05-31 08:59:27 -07001821 // Recurse to get LED data from next connection
1822 getInventoryLedData(sensorsAsyncResp, inventoryItems,
1823 ledConnections, std::move(callback),
1824 ledConnectionsIndex + 1);
Anthony Wilsond5005492019-07-31 16:34:17 -05001825
Ed Tanous002d39b2022-05-31 08:59:27 -07001826 BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit";
1827 };
Anthony Wilsond5005492019-07-31 16:34:17 -05001828
1829 // Get the State property for the current LED
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001830 sdbusplus::asio::getProperty<std::string>(
1831 *crow::connections::systemBus, ledConnection, ledPath,
1832 "xyz.openbmc_project.Led.Physical", "State",
1833 std::move(respHandler));
Anthony Wilsond5005492019-07-31 16:34:17 -05001834 }
1835
1836 BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
1837}
1838
1839/**
1840 * @brief Gets LED data for LEDs associated with given inventory items.
1841 *
1842 * Gets the D-Bus connections (services) that provide LED data for the LEDs
1843 * associated with the specified inventory items. Then gets the LED data from
1844 * each connection and stores it in the inventory item.
1845 *
1846 * This data is later used to provide sensor property values in the JSON
1847 * response.
1848 *
1849 * Finds the LED data asynchronously. Invokes callback when information has
1850 * been obtained.
1851 *
1852 * The callback must have the following signature:
1853 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05001854 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05001855 * @endcode
1856 *
1857 * @param sensorsAsyncResp Pointer to object holding response data.
1858 * @param inventoryItems D-Bus inventory items associated with sensors.
1859 * @param callback Callback to invoke when inventory items have been obtained.
1860 */
1861template <typename Callback>
1862void getInventoryLeds(
1863 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1864 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1865 Callback&& callback)
1866{
1867 BMCWEB_LOG_DEBUG << "getInventoryLeds enter";
1868
1869 const std::string path = "/xyz/openbmc_project";
George Liue99073f2022-12-09 11:06:16 +08001870 constexpr std::array<std::string_view, 1> interfaces = {
Anthony Wilsond5005492019-07-31 16:34:17 -05001871 "xyz.openbmc_project.Led.Physical"};
1872
George Liue99073f2022-12-09 11:06:16 +08001873 // Make call to ObjectMapper to find all inventory items
1874 dbus::utility::getSubTree(
1875 path, 0, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -07001876 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1877 inventoryItems](
George Liue99073f2022-12-09 11:06:16 +08001878 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001879 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +08001880 // Response handler for parsing output from GetSubTree
Anthony Wilsond5005492019-07-31 16:34:17 -05001881 BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter";
1882 if (ec)
1883 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001884 messages::internalError(sensorsAsyncResp->asyncResp->res);
Anthony Wilsond5005492019-07-31 16:34:17 -05001885 BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error "
1886 << ec;
1887 return;
1888 }
1889
1890 // Build map of LED object paths to connections
Nan Zhoufe04d492022-06-22 17:10:41 +00001891 std::shared_ptr<std::map<std::string, std::string>> ledConnections =
1892 std::make_shared<std::map<std::string, std::string>>();
Anthony Wilsond5005492019-07-31 16:34:17 -05001893
1894 // Loop through objects from GetSubTree
1895 for (const std::pair<
1896 std::string,
1897 std::vector<std::pair<std::string, std::vector<std::string>>>>&
1898 object : subtree)
1899 {
1900 // Check if object path is LED for one of the specified inventory
1901 // items
1902 const std::string& ledPath = object.first;
1903 if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr)
1904 {
1905 // Add mapping from ledPath to connection
1906 const std::string& connection = object.second.begin()->first;
1907 (*ledConnections)[ledPath] = connection;
1908 BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> "
1909 << connection;
1910 }
1911 }
1912
1913 getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections,
1914 std::move(callback));
1915 BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit";
George Liue99073f2022-12-09 11:06:16 +08001916 });
Anthony Wilsond5005492019-07-31 16:34:17 -05001917 BMCWEB_LOG_DEBUG << "getInventoryLeds exit";
1918}
1919
1920/**
Gunnar Mills42cbe532019-08-15 15:26:54 -05001921 * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent
1922 *
1923 * Uses the specified connections (services) (currently assumes just one) to
1924 * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in
1925 * the inventoryItems vector. Only stores data in Power Supply inventoryItems.
1926 *
1927 * This data is later used to provide sensor property values in the JSON
1928 * response.
1929 *
1930 * Finds the Power Supply Attributes data asynchronously. Invokes callback
1931 * when data has been obtained.
1932 *
1933 * The callback must have the following signature:
1934 * @code
1935 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
1936 * @endcode
1937 *
1938 * @param sensorsAsyncResp Pointer to object holding response data.
1939 * @param inventoryItems D-Bus inventory items associated with sensors.
1940 * @param psAttributesConnections Connections that provide data for the Power
1941 * Supply Attributes
1942 * @param callback Callback to invoke when data has been obtained.
1943 */
1944template <typename Callback>
1945void getPowerSupplyAttributesData(
Ed Tanousb5a76932020-09-29 16:16:58 -07001946 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Gunnar Mills42cbe532019-08-15 15:26:54 -05001947 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Nan Zhoufe04d492022-06-22 17:10:41 +00001948 const std::map<std::string, std::string>& psAttributesConnections,
Gunnar Mills42cbe532019-08-15 15:26:54 -05001949 Callback&& callback)
1950{
1951 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter";
1952
1953 if (psAttributesConnections.empty())
1954 {
1955 BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!";
1956 callback(inventoryItems);
1957 return;
1958 }
1959
1960 // Assuming just one connection (service) for now
Nan Zhoufe04d492022-06-22 17:10:41 +00001961 auto it = psAttributesConnections.begin();
Gunnar Mills42cbe532019-08-15 15:26:54 -05001962
1963 const std::string& psAttributesPath = (*it).first;
1964 const std::string& psAttributesConnection = (*it).second;
1965
1966 // Response handler for Get DeratingFactor property
Ed Tanous002d39b2022-05-31 08:59:27 -07001967 auto respHandler =
1968 [sensorsAsyncResp, inventoryItems,
1969 callback{std::forward<Callback>(callback)}](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001970 const boost::system::error_code& ec, const uint32_t value) {
Gunnar Mills42cbe532019-08-15 15:26:54 -05001971 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter";
1972 if (ec)
1973 {
1974 BMCWEB_LOG_ERROR
1975 << "getPowerSupplyAttributesData respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001976 messages::internalError(sensorsAsyncResp->asyncResp->res);
Gunnar Mills42cbe532019-08-15 15:26:54 -05001977 return;
1978 }
1979
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001980 BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << value;
1981 // Store value in Power Supply Inventory Items
1982 for (InventoryItem& inventoryItem : *inventoryItems)
Gunnar Mills42cbe532019-08-15 15:26:54 -05001983 {
Ed Tanous55f79e62022-01-25 11:26:16 -08001984 if (inventoryItem.isPowerSupply)
Gunnar Mills42cbe532019-08-15 15:26:54 -05001985 {
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001986 inventoryItem.powerSupplyEfficiencyPercent =
1987 static_cast<int>(value);
Gunnar Mills42cbe532019-08-15 15:26:54 -05001988 }
1989 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05001990
1991 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit";
1992 callback(inventoryItems);
1993 };
1994
1995 // Get the DeratingFactor property for the PowerSupplyAttributes
1996 // Currently only property on the interface/only one we care about
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001997 sdbusplus::asio::getProperty<uint32_t>(
1998 *crow::connections::systemBus, psAttributesConnection, psAttributesPath,
1999 "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor",
2000 std::move(respHandler));
Gunnar Mills42cbe532019-08-15 15:26:54 -05002001
2002 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit";
2003}
2004
2005/**
2006 * @brief Gets the Power Supply Attributes such as EfficiencyPercent
2007 *
2008 * Gets the D-Bus connection (service) that provides Power Supply Attributes
2009 * data. Then gets the Power Supply Attributes data from the connection
2010 * (currently just assumes 1 connection) and stores the data in the inventory
2011 * item.
2012 *
2013 * This data is later used to provide sensor property values in the JSON
2014 * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish.
2015 *
2016 * Finds the Power Supply Attributes data asynchronously. Invokes callback
2017 * when information has been obtained.
2018 *
2019 * The callback must have the following signature:
2020 * @code
2021 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2022 * @endcode
2023 *
2024 * @param sensorsAsyncResp Pointer to object holding response data.
2025 * @param inventoryItems D-Bus inventory items associated with sensors.
2026 * @param callback Callback to invoke when data has been obtained.
2027 */
2028template <typename Callback>
2029void getPowerSupplyAttributes(
2030 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2031 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
2032 Callback&& callback)
2033{
2034 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter";
2035
2036 // Only need the power supply attributes when the Power Schema
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002037 if (sensorsAsyncResp->chassisSubNode != sensors::node::power)
Gunnar Mills42cbe532019-08-15 15:26:54 -05002038 {
2039 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power";
2040 callback(inventoryItems);
2041 return;
2042 }
2043
George Liue99073f2022-12-09 11:06:16 +08002044 constexpr std::array<std::string_view, 1> interfaces = {
Gunnar Mills42cbe532019-08-15 15:26:54 -05002045 "xyz.openbmc_project.Control.PowerSupplyAttributes"};
2046
George Liue99073f2022-12-09 11:06:16 +08002047 // Make call to ObjectMapper to find the PowerSupplyAttributes service
2048 dbus::utility::getSubTree(
2049 "/xyz/openbmc_project", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -08002050 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
2051 inventoryItems](
George Liue99073f2022-12-09 11:06:16 +08002052 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08002053 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +08002054 // Response handler for parsing output from GetSubTree
Ed Tanous002d39b2022-05-31 08:59:27 -07002055 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter";
2056 if (ec)
2057 {
2058 messages::internalError(sensorsAsyncResp->asyncResp->res);
2059 BMCWEB_LOG_ERROR
2060 << "getPowerSupplyAttributes respHandler DBus error " << ec;
2061 return;
2062 }
2063 if (subtree.empty())
2064 {
2065 BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!";
2066 callback(inventoryItems);
2067 return;
2068 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002069
Ed Tanous002d39b2022-05-31 08:59:27 -07002070 // Currently we only support 1 power supply attribute, use this for
2071 // all the power supplies. Build map of object path to connection.
2072 // Assume just 1 connection and 1 path for now.
Nan Zhoufe04d492022-06-22 17:10:41 +00002073 std::map<std::string, std::string> psAttributesConnections;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002074
Ed Tanous002d39b2022-05-31 08:59:27 -07002075 if (subtree[0].first.empty() || subtree[0].second.empty())
2076 {
2077 BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
2078 callback(inventoryItems);
2079 return;
2080 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002081
Ed Tanous002d39b2022-05-31 08:59:27 -07002082 const std::string& psAttributesPath = subtree[0].first;
2083 const std::string& connection = subtree[0].second.begin()->first;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002084
Ed Tanous002d39b2022-05-31 08:59:27 -07002085 if (connection.empty())
2086 {
2087 BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
2088 callback(inventoryItems);
2089 return;
2090 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002091
Ed Tanous002d39b2022-05-31 08:59:27 -07002092 psAttributesConnections[psAttributesPath] = connection;
2093 BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> "
2094 << connection;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002095
Ed Tanous002d39b2022-05-31 08:59:27 -07002096 getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems,
2097 psAttributesConnections,
2098 std::move(callback));
2099 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit";
George Liue99073f2022-12-09 11:06:16 +08002100 });
Gunnar Mills42cbe532019-08-15 15:26:54 -05002101 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit";
2102}
2103
2104/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002105 * @brief Gets inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002106 *
2107 * Finds the inventory items that are associated with the specified sensors.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002108 * Then gets D-Bus data for the inventory items, such as presence and VPD.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002109 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002110 * This data is later used to provide sensor property values in the JSON
2111 * response.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002112 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002113 * Finds the inventory items asynchronously. Invokes callback when the
2114 * inventory items have been obtained.
2115 *
2116 * The callback must have the following signature:
2117 * @code
2118 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2119 * @endcode
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002120 *
2121 * @param sensorsAsyncResp Pointer to object holding response data.
2122 * @param sensorNames All sensors within the current chassis.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002123 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002124 * @param callback Callback to invoke when inventory items have been obtained.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002125 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002126template <typename Callback>
Ed Tanousd0090732022-10-04 17:22:56 -07002127static void
2128 getInventoryItems(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2129 const std::shared_ptr<std::set<std::string>> sensorNames,
2130 Callback&& callback)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002131{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002132 BMCWEB_LOG_DEBUG << "getInventoryItems enter";
2133 auto getInventoryItemAssociationsCb =
Ed Tanousd0090732022-10-04 17:22:56 -07002134 [sensorsAsyncResp, callback{std::forward<Callback>(callback)}](
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002135 std::shared_ptr<std::vector<InventoryItem>> inventoryItems) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002136 BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter";
2137 auto getInventoryItemsConnectionsCb =
Ed Tanousd0090732022-10-04 17:22:56 -07002138 [sensorsAsyncResp, inventoryItems,
Ed Tanous002d39b2022-05-31 08:59:27 -07002139 callback{std::forward<const Callback>(callback)}](
Nan Zhoufe04d492022-06-22 17:10:41 +00002140 std::shared_ptr<std::set<std::string>> invConnections) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002141 BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter";
2142 auto getInventoryItemsDataCb = [sensorsAsyncResp, inventoryItems,
2143 callback{std::move(callback)}]() {
2144 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter";
Gunnar Mills42cbe532019-08-15 15:26:54 -05002145
Ed Tanous002d39b2022-05-31 08:59:27 -07002146 auto getInventoryLedsCb = [sensorsAsyncResp, inventoryItems,
2147 callback{std::move(callback)}]() {
2148 BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter";
2149 // Find Power Supply Attributes and get the data
2150 getPowerSupplyAttributes(sensorsAsyncResp, inventoryItems,
2151 std::move(callback));
2152 BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002153 };
2154
Ed Tanous002d39b2022-05-31 08:59:27 -07002155 // Find led connections and get the data
2156 getInventoryLeds(sensorsAsyncResp, inventoryItems,
2157 std::move(getInventoryLedsCb));
2158 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit";
2159 };
2160
2161 // Get inventory item data from connections
2162 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07002163 invConnections,
Ed Tanous002d39b2022-05-31 08:59:27 -07002164 std::move(getInventoryItemsDataCb));
2165 BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002166 };
2167
Ed Tanous002d39b2022-05-31 08:59:27 -07002168 // Get connections that provide inventory item data
2169 getInventoryItemsConnections(sensorsAsyncResp, inventoryItems,
2170 std::move(getInventoryItemsConnectionsCb));
2171 BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit";
2172 };
2173
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002174 // Get associations from sensors to inventory items
Ed Tanousd0090732022-10-04 17:22:56 -07002175 getInventoryItemAssociations(sensorsAsyncResp, sensorNames,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002176 std::move(getInventoryItemAssociationsCb));
2177 BMCWEB_LOG_DEBUG << "getInventoryItems exit";
2178}
2179
2180/**
2181 * @brief Returns JSON PowerSupply object for the specified inventory item.
2182 *
2183 * Searches for a JSON PowerSupply object that matches the specified inventory
2184 * item. If one is not found, a new PowerSupply object is added to the JSON
2185 * array.
2186 *
2187 * Multiple sensors are often associated with one power supply inventory item.
2188 * As a result, multiple sensor values are stored in one JSON PowerSupply
2189 * object.
2190 *
2191 * @param powerSupplyArray JSON array containing Redfish PowerSupply objects.
2192 * @param inventoryItem Inventory item for the power supply.
2193 * @param chassisId Chassis that contains the power supply.
2194 * @return JSON PowerSupply object for the specified inventory item.
2195 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002196inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002197 const InventoryItem& inventoryItem,
2198 const std::string& chassisId)
2199{
2200 // Check if matching PowerSupply object already exists in JSON array
2201 for (nlohmann::json& powerSupply : powerSupplyArray)
2202 {
Alexander Hansenf7afb172023-04-27 14:34:08 +02002203 if (powerSupply["Name"] ==
2204 boost::replace_all_copy(inventoryItem.name, "_", " "))
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002205 {
2206 return powerSupply;
2207 }
2208 }
2209
2210 // Add new PowerSupply object to JSON array
2211 powerSupplyArray.push_back({});
2212 nlohmann::json& powerSupply = powerSupplyArray.back();
Ed Tanousef4c65b2023-04-24 15:28:50 -07002213 boost::urls::url url = boost::urls::format("/redfish/v1/Chassis/{}/Power",
2214 chassisId);
Willy Tueddfc432022-09-26 16:46:38 +00002215 url.set_fragment(("/PowerSupplies"_json_pointer).to_string());
2216 powerSupply["@odata.id"] = std::move(url);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002217 powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " ");
2218 powerSupply["Manufacturer"] = inventoryItem.manufacturer;
2219 powerSupply["Model"] = inventoryItem.model;
2220 powerSupply["PartNumber"] = inventoryItem.partNumber;
2221 powerSupply["SerialNumber"] = inventoryItem.serialNumber;
Anthony Wilsond5005492019-07-31 16:34:17 -05002222 setLedState(powerSupply, &inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002223
Gunnar Mills42cbe532019-08-15 15:26:54 -05002224 if (inventoryItem.powerSupplyEfficiencyPercent >= 0)
2225 {
2226 powerSupply["EfficiencyPercent"] =
2227 inventoryItem.powerSupplyEfficiencyPercent;
2228 }
2229
2230 powerSupply["Status"]["State"] = getState(&inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002231 const char* health = inventoryItem.isFunctional ? "OK" : "Critical";
2232 powerSupply["Status"]["Health"] = health;
2233
2234 return powerSupply;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002235}
2236
2237/**
Shawn McCarneyde629b62019-03-08 10:42:51 -06002238 * @brief Gets the values of the specified sensors.
2239 *
2240 * Stores the results as JSON in the SensorsAsyncResp.
2241 *
2242 * Gets the sensor values asynchronously. Stores the results later when the
2243 * information has been obtained.
2244 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002245 * The sensorNames set contains all requested sensors for the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002246 *
2247 * To minimize the number of DBus calls, the DBus method
2248 * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the
2249 * values of all sensors provided by a connection (service).
2250 *
2251 * The connections set contains all the connections that provide sensor values.
2252 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002253 * The InventoryItem vector contains D-Bus inventory items associated with the
2254 * sensors. Inventory item data is needed for some Redfish sensor properties.
2255 *
Shawn McCarneyde629b62019-03-08 10:42:51 -06002256 * @param SensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002257 * @param sensorNames All requested sensors within the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002258 * @param connections Connections that provide sensor values.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002259 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002260 * @param inventoryItems Inventory items associated with the sensors.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002261 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002262inline void getSensorData(
Ed Tanous81ce6092020-12-17 16:54:55 +00002263 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +00002264 const std::shared_ptr<std::set<std::string>>& sensorNames,
2265 const std::set<std::string>& connections,
Ed Tanousb5a76932020-09-29 16:16:58 -07002266 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002267{
2268 BMCWEB_LOG_DEBUG << "getSensorData enter";
2269 // Get managed objects from all services exposing sensors
2270 for (const std::string& connection : connections)
2271 {
2272 // Response handler to process managed objects
Ed Tanous002d39b2022-05-31 08:59:27 -07002273 auto getManagedObjectsCb =
2274 [sensorsAsyncResp, sensorNames,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002275 inventoryItems](const boost::system::error_code& ec,
Ed Tanous02cad962022-06-30 16:50:15 -07002276 const dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyde629b62019-03-08 10:42:51 -06002277 BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter";
2278 if (ec)
2279 {
2280 BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08002281 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002282 return;
2283 }
2284 // Go through all objects and update response with sensor data
2285 for (const auto& objDictEntry : resp)
2286 {
2287 const std::string& objPath =
2288 static_cast<const std::string&>(objDictEntry.first);
2289 BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object "
2290 << objPath;
2291
Shawn McCarneyde629b62019-03-08 10:42:51 -06002292 std::vector<std::string> split;
2293 // Reserve space for
2294 // /xyz/openbmc_project/sensors/<name>/<subname>
2295 split.reserve(6);
Ed Tanous50ebd4a2023-01-19 19:03:17 -08002296 // NOLINTNEXTLINE
2297 bmcweb::split(split, objPath, '/');
Shawn McCarneyde629b62019-03-08 10:42:51 -06002298 if (split.size() < 6)
2299 {
2300 BMCWEB_LOG_ERROR << "Got path that isn't long enough "
2301 << objPath;
2302 continue;
2303 }
Ed Tanous50ebd4a2023-01-19 19:03:17 -08002304 // These indexes aren't intuitive, as split puts an empty
Shawn McCarneyde629b62019-03-08 10:42:51 -06002305 // string at the beginning
2306 const std::string& sensorType = split[4];
2307 const std::string& sensorName = split[5];
2308 BMCWEB_LOG_DEBUG << "sensorName " << sensorName
2309 << " sensorType " << sensorType;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002310 if (sensorNames->find(objPath) == sensorNames->end())
Shawn McCarneyde629b62019-03-08 10:42:51 -06002311 {
Andrew Geissleraccdbb22021-11-09 15:24:45 -06002312 BMCWEB_LOG_DEBUG << sensorName << " not in sensor list ";
Shawn McCarneyde629b62019-03-08 10:42:51 -06002313 continue;
2314 }
2315
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002316 // Find inventory item (if any) associated with sensor
2317 InventoryItem* inventoryItem =
2318 findInventoryItemForSensor(inventoryItems, objPath);
2319
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002320 const std::string& sensorSchema =
Ed Tanous81ce6092020-12-17 16:54:55 +00002321 sensorsAsyncResp->chassisSubNode;
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002322
2323 nlohmann::json* sensorJson = nullptr;
2324
Nan Zhou928fefb2022-03-28 08:45:00 -07002325 if (sensorSchema == sensors::node::sensors &&
2326 !sensorsAsyncResp->efficientExpand)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002327 {
Ed Tanousc1d019a2022-08-06 09:36:06 -07002328 std::string sensorTypeEscaped(sensorType);
2329 sensorTypeEscaped.erase(
2330 std::remove(sensorTypeEscaped.begin(),
2331 sensorTypeEscaped.end(), '_'),
2332 sensorTypeEscaped.end());
2333 std::string sensorId(sensorTypeEscaped);
2334 sensorId += "_";
2335 sensorId += sensorName;
2336
zhanghch058d1b46d2021-04-01 11:18:24 +08002337 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] =
Ed Tanousef4c65b2023-04-24 15:28:50 -07002338 boost::urls::format("/redfish/v1/Chassis/{}/{}/{}",
2339 sensorsAsyncResp->chassisId,
2340 sensorsAsyncResp->chassisSubNode,
2341 sensorId);
zhanghch058d1b46d2021-04-01 11:18:24 +08002342 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002343 }
2344 else
2345 {
Ed Tanous271584a2019-07-09 16:24:22 -07002346 std::string fieldName;
Nan Zhou928fefb2022-03-28 08:45:00 -07002347 if (sensorsAsyncResp->efficientExpand)
2348 {
2349 fieldName = "Members";
2350 }
2351 else if (sensorType == "temperature")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002352 {
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002353 fieldName = "Temperatures";
2354 }
2355 else if (sensorType == "fan" || sensorType == "fan_tach" ||
2356 sensorType == "fan_pwm")
2357 {
2358 fieldName = "Fans";
2359 }
2360 else if (sensorType == "voltage")
2361 {
2362 fieldName = "Voltages";
2363 }
2364 else if (sensorType == "power")
2365 {
Ed Tanous55f79e62022-01-25 11:26:16 -08002366 if (sensorName == "total_power")
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002367 {
2368 fieldName = "PowerControl";
2369 }
2370 else if ((inventoryItem != nullptr) &&
2371 (inventoryItem->isPowerSupply))
2372 {
2373 fieldName = "PowerSupplies";
2374 }
2375 else
2376 {
2377 // Other power sensors are in SensorCollection
2378 continue;
2379 }
2380 }
2381 else
2382 {
2383 BMCWEB_LOG_ERROR << "Unsure how to handle sensorType "
2384 << sensorType;
2385 continue;
2386 }
2387
2388 nlohmann::json& tempArray =
zhanghch058d1b46d2021-04-01 11:18:24 +08002389 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName];
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002390 if (fieldName == "PowerControl")
2391 {
2392 if (tempArray.empty())
2393 {
2394 // Put multiple "sensors" into a single
2395 // PowerControl. Follows MemberId naming and
2396 // naming in power.hpp.
Ed Tanous14766872022-03-15 10:44:42 -07002397 nlohmann::json::object_t power;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002398 boost::urls::url url = boost::urls::format(
2399 "/redfish/v1/Chassis/{}/{}",
Willy Tueddfc432022-09-26 16:46:38 +00002400 sensorsAsyncResp->chassisId,
2401 sensorsAsyncResp->chassisSubNode);
2402 url.set_fragment((""_json_pointer / fieldName / "0")
2403 .to_string());
2404 power["@odata.id"] = std::move(url);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002405 tempArray.emplace_back(std::move(power));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002406 }
2407 sensorJson = &(tempArray.back());
2408 }
2409 else if (fieldName == "PowerSupplies")
2410 {
2411 if (inventoryItem != nullptr)
2412 {
2413 sensorJson =
2414 &(getPowerSupply(tempArray, *inventoryItem,
Ed Tanous81ce6092020-12-17 16:54:55 +00002415 sensorsAsyncResp->chassisId));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002416 }
2417 }
Nan Zhou928fefb2022-03-28 08:45:00 -07002418 else if (fieldName == "Members")
2419 {
Ed Tanous677bb752022-09-15 10:52:19 -07002420 std::string sensorTypeEscaped(sensorType);
2421 sensorTypeEscaped.erase(
2422 std::remove(sensorTypeEscaped.begin(),
2423 sensorTypeEscaped.end(), '_'),
2424 sensorTypeEscaped.end());
2425 std::string sensorId(sensorTypeEscaped);
2426 sensorId += "_";
2427 sensorId += sensorName;
2428
Ed Tanous14766872022-03-15 10:44:42 -07002429 nlohmann::json::object_t member;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002430 member["@odata.id"] = boost::urls::format(
2431 "/redfish/v1/Chassis/{}/{}/{}",
Ed Tanous677bb752022-09-15 10:52:19 -07002432 sensorsAsyncResp->chassisId,
2433 sensorsAsyncResp->chassisSubNode, sensorId);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002434 tempArray.emplace_back(std::move(member));
Nan Zhou928fefb2022-03-28 08:45:00 -07002435 sensorJson = &(tempArray.back());
2436 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002437 else
2438 {
Ed Tanous14766872022-03-15 10:44:42 -07002439 nlohmann::json::object_t member;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002440 boost::urls::url url = boost::urls::format(
2441 "/redfish/v1/Chassis/{}/{}",
Willy Tueddfc432022-09-26 16:46:38 +00002442 sensorsAsyncResp->chassisId,
2443 sensorsAsyncResp->chassisSubNode);
2444 url.set_fragment(
2445 (""_json_pointer / fieldName).to_string());
2446 member["@odata.id"] = std::move(url);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002447 tempArray.emplace_back(std::move(member));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002448 sensorJson = &(tempArray.back());
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002449 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002450 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002451
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002452 if (sensorJson != nullptr)
2453 {
Ed Tanous1d7c0052022-08-09 12:32:26 -07002454 objectInterfacesToJson(sensorName, sensorType,
2455 sensorsAsyncResp->chassisSubNode,
2456 objDictEntry.second, *sensorJson,
2457 inventoryItem);
2458
2459 std::string path = "/xyz/openbmc_project/sensors/";
2460 path += sensorType;
2461 path += "/";
2462 path += sensorName;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002463 sensorsAsyncResp->addMetadata(*sensorJson, path);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002464 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002465 }
Ed Tanous81ce6092020-12-17 16:54:55 +00002466 if (sensorsAsyncResp.use_count() == 1)
James Feist8bd25cc2019-03-15 15:14:00 -07002467 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002468 sortJSONResponse(sensorsAsyncResp);
Nan Zhou928fefb2022-03-28 08:45:00 -07002469 if (sensorsAsyncResp->chassisSubNode ==
2470 sensors::node::sensors &&
2471 sensorsAsyncResp->efficientExpand)
2472 {
2473 sensorsAsyncResp->asyncResp->res
2474 .jsonValue["Members@odata.count"] =
2475 sensorsAsyncResp->asyncResp->res.jsonValue["Members"]
2476 .size();
2477 }
2478 else if (sensorsAsyncResp->chassisSubNode ==
2479 sensors::node::thermal)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002480 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002481 populateFanRedundancy(sensorsAsyncResp);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002482 }
James Feist8bd25cc2019-03-15 15:14:00 -07002483 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002484 BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit";
2485 };
2486
Shawn McCarneyde629b62019-03-08 10:42:51 -06002487 crow::connections::systemBus->async_method_call(
Ed Tanousd0090732022-10-04 17:22:56 -07002488 getManagedObjectsCb, connection, "/xyz/openbmc_project/sensors",
Shawn McCarneyde629b62019-03-08 10:42:51 -06002489 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
Ed Tanous23a21a12020-07-25 04:45:05 +00002490 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002491 BMCWEB_LOG_DEBUG << "getSensorData exit";
2492}
2493
Nan Zhoufe04d492022-06-22 17:10:41 +00002494inline void
2495 processSensorList(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
2496 const std::shared_ptr<std::set<std::string>>& sensorNames)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002497{
Nan Zhoufe04d492022-06-22 17:10:41 +00002498 auto getConnectionCb = [sensorsAsyncResp, sensorNames](
2499 const std::set<std::string>& connections) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002500 BMCWEB_LOG_DEBUG << "getConnectionCb enter";
Ed Tanousd0090732022-10-04 17:22:56 -07002501 auto getInventoryItemsCb =
2502 [sensorsAsyncResp, sensorNames,
2503 connections](const std::shared_ptr<std::vector<InventoryItem>>&
2504 inventoryItems) {
2505 BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter";
2506 // Get sensor data and store results in JSON
2507 getSensorData(sensorsAsyncResp, sensorNames, connections,
2508 inventoryItems);
2509 BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit";
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002510 };
2511
Ed Tanousd0090732022-10-04 17:22:56 -07002512 // Get inventory items associated with sensors
2513 getInventoryItems(sensorsAsyncResp, sensorNames,
2514 std::move(getInventoryItemsCb));
2515
Ed Tanous002d39b2022-05-31 08:59:27 -07002516 BMCWEB_LOG_DEBUG << "getConnectionCb exit";
2517 };
2518
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002519 // Get set of connections that provide sensor values
Ed Tanous81ce6092020-12-17 16:54:55 +00002520 getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002521}
2522
Shawn McCarneyde629b62019-03-08 10:42:51 -06002523/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002524 * @brief Entry point for retrieving sensors data related to requested
2525 * chassis.
Kowalski, Kamil588c3f02018-04-03 14:55:27 +02002526 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002527 */
Ed Tanousb5a76932020-09-29 16:16:58 -07002528inline void
Ed Tanous81ce6092020-12-17 16:54:55 +00002529 getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
Ed Tanous1abe55e2018-09-05 08:30:59 -07002530{
2531 BMCWEB_LOG_DEBUG << "getChassisData enter";
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002532 auto getChassisCb =
Ed Tanous81ce6092020-12-17 16:54:55 +00002533 [sensorsAsyncResp](
Nan Zhoufe04d492022-06-22 17:10:41 +00002534 const std::shared_ptr<std::set<std::string>>& sensorNames) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002535 BMCWEB_LOG_DEBUG << "getChassisCb enter";
2536 processSensorList(sensorsAsyncResp, sensorNames);
2537 BMCWEB_LOG_DEBUG << "getChassisCb exit";
2538 };
Nan Zhou928fefb2022-03-28 08:45:00 -07002539 // SensorCollection doesn't contain the Redundancy property
2540 if (sensorsAsyncResp->chassisSubNode != sensors::node::sensors)
2541 {
2542 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] =
2543 nlohmann::json::array();
2544 }
Shawn McCarney26f03892019-05-03 13:20:24 -05002545 // Get set of sensors in chassis
Ed Tanous7f1cc262022-08-09 13:33:57 -07002546 getChassis(sensorsAsyncResp->asyncResp, sensorsAsyncResp->chassisId,
2547 sensorsAsyncResp->chassisSubNode, sensorsAsyncResp->types,
2548 std::move(getChassisCb));
Ed Tanous1abe55e2018-09-05 08:30:59 -07002549 BMCWEB_LOG_DEBUG << "getChassisData exit";
Ed Tanous271584a2019-07-09 16:24:22 -07002550}
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002551
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302552/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002553 * @brief Find the requested sensorName in the list of all sensors supplied by
2554 * the chassis node
2555 *
2556 * @param sensorName The sensor name supplied in the PATCH request
2557 * @param sensorsList The list of sensors managed by the chassis node
2558 * @param sensorsModified The list of sensors that were found as a result of
2559 * repeated calls to this function
2560 */
Nan Zhoufe04d492022-06-22 17:10:41 +00002561inline bool
2562 findSensorNameUsingSensorPath(std::string_view sensorName,
Ed Tanous02cad962022-06-30 16:50:15 -07002563 const std::set<std::string>& sensorsList,
Nan Zhoufe04d492022-06-22 17:10:41 +00002564 std::set<std::string>& sensorsModified)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002565{
Nan Zhoufe04d492022-06-22 17:10:41 +00002566 for (const auto& chassisSensor : sensorsList)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002567 {
George Liu28aa8de2021-02-01 15:13:30 +08002568 sdbusplus::message::object_path path(chassisSensor);
Ed Tanousb00dcc22021-02-23 12:52:50 -08002569 std::string thisSensorName = path.filename();
George Liu28aa8de2021-02-01 15:13:30 +08002570 if (thisSensorName.empty())
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002571 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002572 continue;
2573 }
2574 if (thisSensorName == sensorName)
2575 {
2576 sensorsModified.emplace(chassisSensor);
2577 return true;
2578 }
2579 }
2580 return false;
2581}
2582
Ed Tanousc71d6122022-11-29 14:10:32 -08002583inline std::pair<std::string, std::string>
2584 splitSensorNameAndType(std::string_view sensorId)
2585{
2586 size_t index = sensorId.find('_');
2587 if (index == std::string::npos)
2588 {
2589 return std::make_pair<std::string, std::string>("", "");
2590 }
2591 std::string sensorType{sensorId.substr(0, index)};
2592 std::string sensorName{sensorId.substr(index + 1)};
2593 // fan_pwm and fan_tach need special handling
2594 if (sensorType == "fantach" || sensorType == "fanpwm")
2595 {
2596 sensorType.insert(3, 1, '_');
2597 }
2598 return std::make_pair(sensorType, sensorName);
2599}
2600
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002601/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302602 * @brief Entry point for overriding sensor values of given sensor
2603 *
zhanghch058d1b46d2021-04-01 11:18:24 +08002604 * @param sensorAsyncResp response object
Carol Wang4bb3dc32019-10-17 18:15:02 +08002605 * @param allCollections Collections extract from sensors' request patch info
jayaprakash Mutyala91e130a2020-03-04 22:26:38 +00002606 * @param chassisSubNode Chassis Node for which the query has to happen
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302607 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002608inline void setSensorsOverride(
Ed Tanousb5a76932020-09-29 16:16:58 -07002609 const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp,
Carol Wang4bb3dc32019-10-17 18:15:02 +08002610 std::unordered_map<std::string, std::vector<nlohmann::json>>&
jayaprakash Mutyala397fd612020-02-06 23:33:34 +00002611 allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302612{
jayaprakash Mutyala70d1d0a2020-01-21 23:41:36 +00002613 BMCWEB_LOG_INFO << "setSensorsOverride for subNode"
Carol Wang4bb3dc32019-10-17 18:15:02 +08002614 << sensorAsyncResp->chassisSubNode << "\n";
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302615
Ed Tanous543f4402022-01-06 13:12:53 -08002616 const char* propertyValueName = nullptr;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302617 std::unordered_map<std::string, std::pair<double, std::string>> overrideMap;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302618 std::string memberId;
Ed Tanous543f4402022-01-06 13:12:53 -08002619 double value = 0.0;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302620 for (auto& collectionItems : allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302621 {
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302622 if (collectionItems.first == "Temperatures")
2623 {
2624 propertyValueName = "ReadingCelsius";
2625 }
2626 else if (collectionItems.first == "Fans")
2627 {
2628 propertyValueName = "Reading";
2629 }
2630 else
2631 {
2632 propertyValueName = "ReadingVolts";
2633 }
2634 for (auto& item : collectionItems.second)
2635 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002636 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res,
2637 "MemberId", memberId, propertyValueName,
2638 value))
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302639 {
2640 return;
2641 }
2642 overrideMap.emplace(memberId,
2643 std::make_pair(value, collectionItems.first));
2644 }
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302645 }
Carol Wang4bb3dc32019-10-17 18:15:02 +08002646
Ed Tanous002d39b2022-05-31 08:59:27 -07002647 auto getChassisSensorListCb =
2648 [sensorAsyncResp, overrideMap](
Nan Zhoufe04d492022-06-22 17:10:41 +00002649 const std::shared_ptr<std::set<std::string>>& sensorsList) {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002650 // Match sensor names in the PATCH request to those managed by the
2651 // chassis node
Nan Zhoufe04d492022-06-22 17:10:41 +00002652 const std::shared_ptr<std::set<std::string>> sensorNames =
2653 std::make_shared<std::set<std::string>>();
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302654 for (const auto& item : overrideMap)
2655 {
2656 const auto& sensor = item.first;
Ed Tanousc71d6122022-11-29 14:10:32 -08002657 std::pair<std::string, std::string> sensorNameType =
2658 splitSensorNameAndType(sensor);
2659 if (!findSensorNameUsingSensorPath(sensorNameType.second,
2660 *sensorsList, *sensorNames))
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302661 {
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302662 BMCWEB_LOG_INFO << "Unable to find memberId " << item.first;
zhanghch058d1b46d2021-04-01 11:18:24 +08002663 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302664 item.second.second, item.first);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302665 return;
2666 }
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302667 }
2668 // Get the connection to which the memberId belongs
Ed Tanous002d39b2022-05-31 08:59:27 -07002669 auto getObjectsWithConnectionCb =
Nan Zhoufe04d492022-06-22 17:10:41 +00002670 [sensorAsyncResp,
2671 overrideMap](const std::set<std::string>& /*connections*/,
2672 const std::set<std::pair<std::string, std::string>>&
2673 objectsWithConnection) {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002674 if (objectsWithConnection.size() != overrideMap.size())
2675 {
2676 BMCWEB_LOG_INFO
2677 << "Unable to find all objects with proper connection "
2678 << objectsWithConnection.size() << " requested "
2679 << overrideMap.size() << "\n";
2680 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
2681 sensorAsyncResp->chassisSubNode ==
2682 sensors::node::thermal
2683 ? "Temperatures"
2684 : "Voltages",
2685 "Count");
2686 return;
2687 }
2688 for (const auto& item : objectsWithConnection)
2689 {
2690 sdbusplus::message::object_path path(item.first);
2691 std::string sensorName = path.filename();
2692 if (sensorName.empty())
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302693 {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002694 messages::internalError(sensorAsyncResp->asyncResp->res);
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302695 return;
2696 }
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302697
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002698 const auto& iterator = overrideMap.find(sensorName);
2699 if (iterator == overrideMap.end())
2700 {
2701 BMCWEB_LOG_INFO << "Unable to find sensor object"
2702 << item.first << "\n";
2703 messages::internalError(sensorAsyncResp->asyncResp->res);
2704 return;
2705 }
2706 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002707 [sensorAsyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002708 if (ec)
2709 {
2710 if (ec.value() ==
2711 boost::system::errc::permission_denied)
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002712 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002713 BMCWEB_LOG_WARNING
2714 << "Manufacturing mode is not Enabled...can't "
2715 "Override the sensor value. ";
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002716
Ed Tanous002d39b2022-05-31 08:59:27 -07002717 messages::insufficientPrivilege(
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002718 sensorAsyncResp->asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07002719 return;
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002720 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002721 BMCWEB_LOG_DEBUG
2722 << "setOverrideValueStatus DBUS error: " << ec;
2723 messages::internalError(
2724 sensorAsyncResp->asyncResp->res);
2725 }
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002726 },
2727 item.second, item.first, "org.freedesktop.DBus.Properties",
2728 "Set", "xyz.openbmc_project.Sensor.Value", "Value",
Ed Tanous168e20c2021-12-13 14:39:53 -08002729 dbus::utility::DbusVariantType(iterator->second.first));
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002730 }
2731 };
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302732 // Get object with connection for the given sensor name
2733 getObjectsWithConnection(sensorAsyncResp, sensorNames,
2734 std::move(getObjectsWithConnectionCb));
2735 };
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302736 // get full sensor list for the given chassisId and cross verify the sensor.
Ed Tanous7f1cc262022-08-09 13:33:57 -07002737 getChassis(sensorAsyncResp->asyncResp, sensorAsyncResp->chassisId,
2738 sensorAsyncResp->chassisSubNode, sensorAsyncResp->types,
2739 std::move(getChassisSensorListCb));
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302740}
2741
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002742/**
2743 * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus
2744 * path of the sensor.
2745 *
2746 * Function builds valid Redfish response for sensor query of given chassis and
2747 * node. It then builds metadata about Redfish<->D-Bus correlations and provides
2748 * it to caller in a callback.
2749 *
2750 * @param chassis Chassis for which retrieval should be performed
2751 * @param node Node (group) of sensors. See sensors::node for supported values
2752 * @param mapComplete Callback to be called with retrieval result
2753 */
Krzysztof Grobelny021d32c2021-10-29 16:00:07 +02002754inline void retrieveUriToDbusMap(const std::string& chassis,
2755 const std::string& node,
2756 SensorsAsyncResp::DataCompleteCb&& mapComplete)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002757{
Ed Tanous02da7c52022-02-27 00:09:02 -08002758 decltype(sensors::paths)::const_iterator pathIt =
2759 std::find_if(sensors::paths.cbegin(), sensors::paths.cend(),
2760 [&node](auto&& val) { return val.first == node; });
2761 if (pathIt == sensors::paths.cend())
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002762 {
2763 BMCWEB_LOG_ERROR << "Wrong node provided : " << node;
2764 mapComplete(boost::beast::http::status::bad_request, {});
2765 return;
2766 }
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002767
Nan Zhou72374eb2022-01-27 17:06:51 -08002768 auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
Nan Zhoufe04d492022-06-22 17:10:41 +00002769 auto callback = [asyncResp, mapCompleteCb{std::move(mapComplete)}](
2770 const boost::beast::http::status status,
2771 const std::map<std::string, std::string>& uriToDbus) {
2772 mapCompleteCb(status, uriToDbus);
2773 };
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002774
2775 auto resp = std::make_shared<SensorsAsyncResp>(
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002776 asyncResp, chassis, pathIt->second, node, std::move(callback));
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002777 getChassisData(resp);
2778}
2779
Nan Zhoubacb2162022-04-06 11:28:32 -07002780namespace sensors
2781{
Nan Zhou928fefb2022-03-28 08:45:00 -07002782
Nan Zhoubacb2162022-04-06 11:28:32 -07002783inline void getChassisCallback(
Ed Tanousc1d019a2022-08-06 09:36:06 -07002784 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2785 std::string_view chassisId, std::string_view chassisSubNode,
Nan Zhoufe04d492022-06-22 17:10:41 +00002786 const std::shared_ptr<std::set<std::string>>& sensorNames)
Nan Zhoubacb2162022-04-06 11:28:32 -07002787{
Ed Tanousc1d019a2022-08-06 09:36:06 -07002788 BMCWEB_LOG_DEBUG << "getChassisCallback enter ";
Nan Zhoubacb2162022-04-06 11:28:32 -07002789
Ed Tanousc1d019a2022-08-06 09:36:06 -07002790 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
2791 for (const std::string& sensor : *sensorNames)
Nan Zhoubacb2162022-04-06 11:28:32 -07002792 {
2793 BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor;
2794
2795 sdbusplus::message::object_path path(sensor);
2796 std::string sensorName = path.filename();
2797 if (sensorName.empty())
2798 {
2799 BMCWEB_LOG_ERROR << "Invalid sensor path: " << sensor;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002800 messages::internalError(asyncResp->res);
Nan Zhoubacb2162022-04-06 11:28:32 -07002801 return;
2802 }
Ed Tanousc1d019a2022-08-06 09:36:06 -07002803 std::string type = path.parent_path().filename();
2804 // fan_tach has an underscore in it, so remove it to "normalize" the
2805 // type in the URI
2806 type.erase(std::remove(type.begin(), type.end(), '_'), type.end());
2807
Ed Tanous14766872022-03-15 10:44:42 -07002808 nlohmann::json::object_t member;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002809 std::string id = type;
2810 id += "_";
2811 id += sensorName;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002812 member["@odata.id"] = boost::urls::format(
2813 "/redfish/v1/Chassis/{}/{}/{}", chassisId, chassisSubNode, id);
Ed Tanousc1d019a2022-08-06 09:36:06 -07002814
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002815 entriesArray.emplace_back(std::move(member));
Nan Zhoubacb2162022-04-06 11:28:32 -07002816 }
2817
Ed Tanousc1d019a2022-08-06 09:36:06 -07002818 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
Nan Zhoubacb2162022-04-06 11:28:32 -07002819 BMCWEB_LOG_DEBUG << "getChassisCallback exit";
2820}
Nan Zhoue6bd8462022-06-01 04:35:35 +00002821
Ed Tanousac106bf2023-06-07 09:24:59 -07002822inline void handleSensorCollectionGet(
2823 App& app, const crow::Request& req,
2824 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2825 const std::string& chassisId)
Nan Zhoude167a62022-06-01 04:47:45 +00002826{
2827 query_param::QueryCapabilities capabilities = {
2828 .canDelegateExpandLevel = 1,
2829 };
2830 query_param::Query delegatedQuery;
Ed Tanousac106bf2023-06-07 09:24:59 -07002831 if (!redfish::setUpRedfishRouteWithDelegation(app, req, asyncResp,
Nan Zhoude167a62022-06-01 04:47:45 +00002832 delegatedQuery, capabilities))
2833 {
2834 return;
2835 }
2836
2837 if (delegatedQuery.expandType != query_param::ExpandType::None)
2838 {
2839 // we perform efficient expand.
Ed Tanousac106bf2023-06-07 09:24:59 -07002840 auto sensorsAsyncResp = std::make_shared<SensorsAsyncResp>(
2841 asyncResp, chassisId, sensors::dbus::sensorPaths,
Nan Zhoude167a62022-06-01 04:47:45 +00002842 sensors::node::sensors,
2843 /*efficientExpand=*/true);
Ed Tanousac106bf2023-06-07 09:24:59 -07002844 getChassisData(sensorsAsyncResp);
Nan Zhoude167a62022-06-01 04:47:45 +00002845
2846 BMCWEB_LOG_DEBUG
2847 << "SensorCollection doGet exit via efficient expand handler";
2848 return;
Ed Tanous0bad3202022-06-02 13:53:59 -07002849 }
Nan Zhoude167a62022-06-01 04:47:45 +00002850
Nan Zhoude167a62022-06-01 04:47:45 +00002851 // We get all sensors as hyperlinkes in the chassis (this
2852 // implies we reply on the default query parameters handler)
Ed Tanousac106bf2023-06-07 09:24:59 -07002853 getChassis(asyncResp, chassisId, sensors::node::sensors, dbus::sensorPaths,
2854 std::bind_front(sensors::getChassisCallback, asyncResp,
2855 chassisId, sensors::node::sensors));
Ed Tanousc1d019a2022-08-06 09:36:06 -07002856}
Ed Tanous7f1cc262022-08-09 13:33:57 -07002857
Ed Tanousc1d019a2022-08-06 09:36:06 -07002858inline void
2859 getSensorFromDbus(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2860 const std::string& sensorPath,
2861 const ::dbus::utility::MapperGetObject& mapperResponse)
2862{
2863 if (mapperResponse.size() != 1)
2864 {
2865 messages::internalError(asyncResp->res);
2866 return;
2867 }
2868 const auto& valueIface = *mapperResponse.begin();
2869 const std::string& connectionName = valueIface.first;
2870 BMCWEB_LOG_DEBUG << "Looking up " << connectionName;
2871 BMCWEB_LOG_DEBUG << "Path " << sensorPath;
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +02002872
2873 sdbusplus::asio::getAllProperties(
2874 *crow::connections::systemBus, connectionName, sensorPath, "",
Ed Tanousc1d019a2022-08-06 09:36:06 -07002875 [asyncResp,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002876 sensorPath](const boost::system::error_code& ec,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002877 const ::dbus::utility::DBusPropertiesMap& valuesDict) {
2878 if (ec)
2879 {
2880 messages::internalError(asyncResp->res);
2881 return;
2882 }
2883 sdbusplus::message::object_path path(sensorPath);
2884 std::string name = path.filename();
2885 path = path.parent_path();
2886 std::string type = path.filename();
2887 objectPropertiesToJson(name, type, sensors::node::sensors, valuesDict,
2888 asyncResp->res.jsonValue, nullptr);
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +02002889 });
Nan Zhoude167a62022-06-01 04:47:45 +00002890}
2891
Nan Zhoue6bd8462022-06-01 04:35:35 +00002892inline void handleSensorGet(App& app, const crow::Request& req,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002893 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous677bb752022-09-15 10:52:19 -07002894 const std::string& chassisId,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002895 const std::string& sensorId)
Nan Zhoue6bd8462022-06-01 04:35:35 +00002896{
Ed Tanousc1d019a2022-08-06 09:36:06 -07002897 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Nan Zhoue6bd8462022-06-01 04:35:35 +00002898 {
2899 return;
2900 }
Ed Tanousc71d6122022-11-29 14:10:32 -08002901 std::pair<std::string, std::string> nameType =
2902 splitSensorNameAndType(sensorId);
2903 if (nameType.first.empty() || nameType.second.empty())
Ed Tanousc1d019a2022-08-06 09:36:06 -07002904 {
2905 messages::resourceNotFound(asyncResp->res, sensorId, "Sensor");
2906 return;
2907 }
Ed Tanousc71d6122022-11-29 14:10:32 -08002908
Ed Tanousef4c65b2023-04-24 15:28:50 -07002909 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
2910 "/redfish/v1/Chassis/{}/Sensors/{}", chassisId, sensorId);
Ed Tanousc1d019a2022-08-06 09:36:06 -07002911
Nan Zhoue6bd8462022-06-01 04:35:35 +00002912 BMCWEB_LOG_DEBUG << "Sensor doGet enter";
Nan Zhoue6bd8462022-06-01 04:35:35 +00002913
George Liu2b731192023-01-11 16:27:13 +08002914 constexpr std::array<std::string_view, 1> interfaces = {
Nan Zhoue6bd8462022-06-01 04:35:35 +00002915 "xyz.openbmc_project.Sensor.Value"};
Ed Tanousc71d6122022-11-29 14:10:32 -08002916 std::string sensorPath = "/xyz/openbmc_project/sensors/" + nameType.first +
2917 '/' + nameType.second;
Nan Zhoue6bd8462022-06-01 04:35:35 +00002918 // Get a list of all of the sensors that implement Sensor.Value
2919 // and get the path and service name associated with the sensor
George Liu2b731192023-01-11 16:27:13 +08002920 ::dbus::utility::getDbusObject(
2921 sensorPath, interfaces,
Myung Baeaec0ec32023-05-31 15:10:01 -05002922 [asyncResp, sensorId,
George Liu2b731192023-01-11 16:27:13 +08002923 sensorPath](const boost::system::error_code& ec,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002924 const ::dbus::utility::MapperGetObject& subtree) {
Nan Zhoue6bd8462022-06-01 04:35:35 +00002925 BMCWEB_LOG_DEBUG << "respHandler1 enter";
Myung Baeaec0ec32023-05-31 15:10:01 -05002926 if (ec == boost::system::errc::io_error)
2927 {
2928 BMCWEB_LOG_WARNING << "Sensor not found from getSensorPaths";
2929 messages::resourceNotFound(asyncResp->res, sensorId, "Sensor");
2930 return;
2931 }
Nan Zhoue6bd8462022-06-01 04:35:35 +00002932 if (ec)
2933 {
Ed Tanousc1d019a2022-08-06 09:36:06 -07002934 messages::internalError(asyncResp->res);
Myung Baeb90d14f2023-05-31 14:40:39 -05002935 BMCWEB_LOG_ERROR << "Sensor getSensorPaths resp_handler: "
Nan Zhoue6bd8462022-06-01 04:35:35 +00002936 << "Dbus error " << ec;
2937 return;
2938 }
Ed Tanousc1d019a2022-08-06 09:36:06 -07002939 getSensorFromDbus(asyncResp, sensorPath, subtree);
Nan Zhoue6bd8462022-06-01 04:35:35 +00002940 BMCWEB_LOG_DEBUG << "respHandler1 exit";
George Liu2b731192023-01-11 16:27:13 +08002941 });
Nan Zhoue6bd8462022-06-01 04:35:35 +00002942}
2943
Nan Zhoubacb2162022-04-06 11:28:32 -07002944} // namespace sensors
2945
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002946inline void requestRoutesSensorCollection(App& app)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002947{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002948 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/")
Ed Tanoused398212021-06-09 17:05:54 -07002949 .privileges(redfish::privileges::getSensorCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07002950 .methods(boost::beast::http::verb::get)(
Nan Zhoude167a62022-06-01 04:47:45 +00002951 std::bind_front(sensors::handleSensorCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002952}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002953
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002954inline void requestRoutesSensor(App& app)
2955{
2956 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002957 .privileges(redfish::privileges::getSensor)
Ed Tanous002d39b2022-05-31 08:59:27 -07002958 .methods(boost::beast::http::verb::get)(
Nan Zhoue6bd8462022-06-01 04:35:35 +00002959 std::bind_front(sensors::handleSensorGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002960}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002961
Ed Tanous1abe55e2018-09-05 08:30:59 -07002962} // namespace redfish