blob: 1935adc13691503e520905f2b33f423d53f3797c [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
George Liue99073f2022-12-09 11:06:16 +080029#include <boost/system/error_code.hpp>
Ed Tanousef4c65b2023-04-24 15:28:50 -070030#include <boost/url/format.hpp>
Jonathan Doman1e1e5982021-06-11 09:36:17 -070031#include <sdbusplus/asio/property.hpp>
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +020032#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050033
George Liu7a1dbc42022-12-07 16:03:22 +080034#include <array>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050035#include <cmath>
Nan Zhoufe04d492022-06-22 17:10:41 +000036#include <iterator>
Ed Tanous283860f2022-08-29 14:08:50 -070037#include <limits>
Nan Zhoufe04d492022-06-22 17:10:41 +000038#include <map>
Ed Tanous3544d2a2023-08-06 18:12:20 -070039#include <ranges>
Nan Zhoufe04d492022-06-22 17:10:41 +000040#include <set>
Ed Tanous18f8f602023-07-18 10:07:23 -070041#include <string>
George Liu7a1dbc42022-12-07 16:03:22 +080042#include <string_view>
Ed Tanousb5a76932020-09-29 16:16:58 -070043#include <utility>
Ed Tanousabf2add2019-01-22 16:40:12 -080044#include <variant>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010045
Ed Tanous1abe55e2018-09-05 08:30:59 -070046namespace redfish
47{
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010048
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020049namespace sensors
50{
51namespace node
52{
53static constexpr std::string_view power = "Power";
54static constexpr std::string_view sensors = "Sensors";
55static constexpr std::string_view thermal = "Thermal";
56} // namespace node
57
Ed Tanous02da7c52022-02-27 00:09:02 -080058// clang-format off
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020059namespace dbus
60{
Ed Tanouscf9e4172022-12-21 09:30:16 -080061constexpr auto powerPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080062 "/xyz/openbmc_project/sensors/voltage",
63 "/xyz/openbmc_project/sensors/power"
64});
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000065
Ed Tanouscf9e4172022-12-21 09:30:16 -080066constexpr auto sensorPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080067 "/xyz/openbmc_project/sensors/power",
68 "/xyz/openbmc_project/sensors/current",
69 "/xyz/openbmc_project/sensors/airflow",
Ed Tanous4e777662022-08-06 09:39:13 -070070 "/xyz/openbmc_project/sensors/humidity",
George Liue8204932021-02-01 14:42:49 +080071#ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
Ed Tanous02da7c52022-02-27 00:09:02 -080072 "/xyz/openbmc_project/sensors/voltage",
73 "/xyz/openbmc_project/sensors/fan_tach",
74 "/xyz/openbmc_project/sensors/temperature",
75 "/xyz/openbmc_project/sensors/fan_pwm",
76 "/xyz/openbmc_project/sensors/altitude",
77 "/xyz/openbmc_project/sensors/energy",
George Liue8204932021-02-01 14:42:49 +080078#endif
Ed Tanous02da7c52022-02-27 00:09:02 -080079 "/xyz/openbmc_project/sensors/utilization"
80});
81
Ed Tanouscf9e4172022-12-21 09:30:16 -080082constexpr auto thermalPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080083 "/xyz/openbmc_project/sensors/fan_tach",
84 "/xyz/openbmc_project/sensors/temperature",
85 "/xyz/openbmc_project/sensors/fan_pwm"
86});
87
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000088} // namespace dbus
Ed Tanous02da7c52022-02-27 00:09:02 -080089// clang-format on
90
Ed Tanouscf9e4172022-12-21 09:30:16 -080091using sensorPair =
92 std::pair<std::string_view, std::span<const std::string_view>>;
Ed Tanous02da7c52022-02-27 00:09:02 -080093static constexpr std::array<sensorPair, 3> paths = {
Ed Tanouscf9e4172022-12-21 09:30:16 -080094 {{node::power, dbus::powerPaths},
95 {node::sensors, dbus::sensorPaths},
96 {node::thermal, dbus::thermalPaths}}};
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000097
Ed Tanous0ec8b832022-03-14 14:56:47 -070098inline sensor::ReadingType toReadingType(std::string_view sensorType)
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000099{
100 if (sensorType == "voltage")
101 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700102 return sensor::ReadingType::Voltage;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000103 }
104 if (sensorType == "power")
105 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700106 return sensor::ReadingType::Power;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000107 }
108 if (sensorType == "current")
109 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700110 return sensor::ReadingType::Current;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000111 }
112 if (sensorType == "fan_tach")
113 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700114 return sensor::ReadingType::Rotational;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000115 }
116 if (sensorType == "temperature")
117 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700118 return sensor::ReadingType::Temperature;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000119 }
120 if (sensorType == "fan_pwm" || sensorType == "utilization")
121 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700122 return sensor::ReadingType::Percent;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000123 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600124 if (sensorType == "humidity")
125 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700126 return sensor::ReadingType::Humidity;
Gunnar Mills5deabed2022-04-20 13:43:45 -0600127 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000128 if (sensorType == "altitude")
129 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700130 return sensor::ReadingType::Altitude;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000131 }
132 if (sensorType == "airflow")
133 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700134 return sensor::ReadingType::AirFlow;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000135 }
136 if (sensorType == "energy")
137 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700138 return sensor::ReadingType::EnergyJoules;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000139 }
Ed Tanous0ec8b832022-03-14 14:56:47 -0700140 return sensor::ReadingType::Invalid;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000141}
142
Ed Tanous1d7c0052022-08-09 12:32:26 -0700143inline std::string_view toReadingUnits(std::string_view sensorType)
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000144{
145 if (sensorType == "voltage")
146 {
147 return "V";
148 }
149 if (sensorType == "power")
150 {
151 return "W";
152 }
153 if (sensorType == "current")
154 {
155 return "A";
156 }
157 if (sensorType == "fan_tach")
158 {
159 return "RPM";
160 }
161 if (sensorType == "temperature")
162 {
163 return "Cel";
164 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600165 if (sensorType == "fan_pwm" || sensorType == "utilization" ||
166 sensorType == "humidity")
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000167 {
168 return "%";
169 }
170 if (sensorType == "altitude")
171 {
172 return "m";
173 }
174 if (sensorType == "airflow")
175 {
176 return "cft_i/min";
177 }
178 if (sensorType == "energy")
179 {
180 return "J";
181 }
182 return "";
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200183}
184} // namespace sensors
185
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100186/**
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200187 * SensorsAsyncResp
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100188 * Gathers data needed for response processing after async calls are done
189 */
Ed Tanous1abe55e2018-09-05 08:30:59 -0700190class SensorsAsyncResp
191{
192 public:
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200193 using DataCompleteCb = std::function<void(
194 const boost::beast::http::status status,
Nan Zhoufe04d492022-06-22 17:10:41 +0000195 const std::map<std::string, std::string>& uriToDbus)>;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200196
197 struct SensorData
198 {
199 const std::string name;
200 std::string uri;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200201 const std::string dbusPath;
202 };
203
Ed Tanous8a592812022-06-04 09:06:59 -0700204 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
zhanghch058d1b46d2021-04-01 11:18:24 +0800205 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800206 std::span<const std::string_view> typesIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800207 std::string_view subNode) :
Ed Tanous8a592812022-06-04 09:06:59 -0700208 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700209 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
210 efficientExpand(false)
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500211 {}
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200212
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200213 // Store extra data about sensor mapping and return it in callback
Ed Tanous8a592812022-06-04 09:06:59 -0700214 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
zhanghch058d1b46d2021-04-01 11:18:24 +0800215 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800216 std::span<const std::string_view> typesIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800217 std::string_view subNode,
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200218 DataCompleteCb&& creationComplete) :
Ed Tanous8a592812022-06-04 09:06:59 -0700219 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700220 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
221 efficientExpand(false), metadata{std::vector<SensorData>()},
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200222 dataComplete{std::move(creationComplete)}
223 {}
224
Nan Zhou928fefb2022-03-28 08:45:00 -0700225 // sensor collections expand
Ed Tanous8a592812022-06-04 09:06:59 -0700226 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
Nan Zhou928fefb2022-03-28 08:45:00 -0700227 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800228 std::span<const std::string_view> typesIn,
Ed Tanous8a592812022-06-04 09:06:59 -0700229 const std::string_view& subNode, bool efficientExpandIn) :
230 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700231 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
Ed Tanous8a592812022-06-04 09:06:59 -0700232 efficientExpand(efficientExpandIn)
Nan Zhou928fefb2022-03-28 08:45:00 -0700233 {}
234
Ed Tanous1abe55e2018-09-05 08:30:59 -0700235 ~SensorsAsyncResp()
236 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800237 if (asyncResp->res.result() ==
238 boost::beast::http::status::internal_server_error)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700239 {
240 // Reset the json object to clear out any data that made it in
241 // before the error happened todo(ed) handle error condition with
242 // proper code
zhanghch058d1b46d2021-04-01 11:18:24 +0800243 asyncResp->res.jsonValue = nlohmann::json::object();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700244 }
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200245
246 if (dataComplete && metadata)
247 {
Nan Zhoufe04d492022-06-22 17:10:41 +0000248 std::map<std::string, std::string> map;
zhanghch058d1b46d2021-04-01 11:18:24 +0800249 if (asyncResp->res.result() == boost::beast::http::status::ok)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200250 {
251 for (auto& sensor : *metadata)
252 {
Ed Tanousc1d019a2022-08-06 09:36:06 -0700253 map.emplace(sensor.uri, sensor.dbusPath);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200254 }
255 }
zhanghch058d1b46d2021-04-01 11:18:24 +0800256 dataComplete(asyncResp->res.result(), map);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200257 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700258 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100259
Ed Tanousecd6a3a2022-01-07 09:18:40 -0800260 SensorsAsyncResp(const SensorsAsyncResp&) = delete;
261 SensorsAsyncResp(SensorsAsyncResp&&) = delete;
262 SensorsAsyncResp& operator=(const SensorsAsyncResp&) = delete;
263 SensorsAsyncResp& operator=(SensorsAsyncResp&&) = delete;
264
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200265 void addMetadata(const nlohmann::json& sensorObject,
Ed Tanousc1d019a2022-08-06 09:36:06 -0700266 const std::string& dbusPath)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200267 {
268 if (metadata)
269 {
Ed Tanousc1d019a2022-08-06 09:36:06 -0700270 metadata->emplace_back(SensorData{
271 sensorObject["Name"], sensorObject["@odata.id"], dbusPath});
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200272 }
273 }
274
275 void updateUri(const std::string& name, const std::string& uri)
276 {
277 if (metadata)
278 {
279 for (auto& sensor : *metadata)
280 {
281 if (sensor.name == name)
282 {
283 sensor.uri = uri;
284 }
285 }
286 }
287 }
288
zhanghch058d1b46d2021-04-01 11:18:24 +0800289 const std::shared_ptr<bmcweb::AsyncResp> asyncResp;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200290 const std::string chassisId;
Ed Tanouscf9e4172022-12-21 09:30:16 -0800291 const std::span<const std::string_view> types;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200292 const std::string chassisSubNode;
Nan Zhou928fefb2022-03-28 08:45:00 -0700293 const bool efficientExpand;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200294
295 private:
296 std::optional<std::vector<SensorData>> metadata;
297 DataCompleteCb dataComplete;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100298};
299
300/**
Anthony Wilsond5005492019-07-31 16:34:17 -0500301 * Possible states for physical inventory leds
302 */
303enum class LedState
304{
305 OFF,
306 ON,
307 BLINK,
308 UNKNOWN
309};
310
311/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500312 * D-Bus inventory item associated with one or more sensors.
313 */
314class InventoryItem
315{
316 public:
Ed Tanous4e23a442022-06-06 09:57:26 -0700317 explicit InventoryItem(const std::string& objPath) : objectPath(objPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500318 {
319 // Set inventory item name to last node of object path
George Liu28aa8de2021-02-01 15:13:30 +0800320 sdbusplus::message::object_path path(objectPath);
321 name = path.filename();
322 if (name.empty())
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500323 {
Ed Tanous62598e32023-07-17 17:06:25 -0700324 BMCWEB_LOG_ERROR("Failed to find '/' in {}", objectPath);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500325 }
326 }
327
328 std::string objectPath;
329 std::string name;
Ed Tanouse05aec52022-01-25 10:28:56 -0800330 bool isPresent = true;
331 bool isFunctional = true;
332 bool isPowerSupply = false;
333 int powerSupplyEfficiencyPercent = -1;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500334 std::string manufacturer;
335 std::string model;
336 std::string partNumber;
337 std::string serialNumber;
338 std::set<std::string> sensors;
Anthony Wilsond5005492019-07-31 16:34:17 -0500339 std::string ledObjectPath;
Ed Tanouse05aec52022-01-25 10:28:56 -0800340 LedState ledState = LedState::UNKNOWN;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500341};
342
343/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530344 * @brief Get objects with connection necessary for sensors
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200345 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100346 * @param sensorNames Sensors retrieved from chassis
347 * @param callback Callback for processing gathered connections
348 */
349template <typename Callback>
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530350void getObjectsWithConnection(
Ed Tanous81ce6092020-12-17 16:54:55 +0000351 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +0000352 const std::shared_ptr<std::set<std::string>>& sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530353 Callback&& callback)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700354{
Ed Tanous62598e32023-07-17 17:06:25 -0700355 BMCWEB_LOG_DEBUG("getObjectsWithConnection enter");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700356 const std::string path = "/xyz/openbmc_project/sensors";
George Liue99073f2022-12-09 11:06:16 +0800357 constexpr std::array<std::string_view, 1> interfaces = {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700358 "xyz.openbmc_project.Sensor.Value"};
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100359
George Liue99073f2022-12-09 11:06:16 +0800360 // Make call to ObjectMapper to find all sensors objects
361 dbus::utility::getSubTree(
362 path, 2, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -0700363 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
George Liue99073f2022-12-09 11:06:16 +0800364 sensorNames](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -0700365 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +0800366 // Response handler for parsing objects subtree
Ed Tanous62598e32023-07-17 17:06:25 -0700367 BMCWEB_LOG_DEBUG("getObjectsWithConnection resp_handler enter");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700368 if (ec)
369 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800370 messages::internalError(sensorsAsyncResp->asyncResp->res);
Ed Tanous62598e32023-07-17 17:06:25 -0700371 BMCWEB_LOG_ERROR(
372 "getObjectsWithConnection resp_handler: Dbus error {}", ec);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700373 return;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100374 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100375
Ed Tanous62598e32023-07-17 17:06:25 -0700376 BMCWEB_LOG_DEBUG("Found {} subtrees", subtree.size());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700377
378 // Make unique list of connections only for requested sensor types and
379 // found in the chassis
Nan Zhoufe04d492022-06-22 17:10:41 +0000380 std::set<std::string> connections;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530381 std::set<std::pair<std::string, std::string>> objectsWithConnection;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700382
Ed Tanous62598e32023-07-17 17:06:25 -0700383 BMCWEB_LOG_DEBUG("sensorNames list count: {}", sensorNames->size());
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700384 for (const std::string& tsensor : *sensorNames)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700385 {
Ed Tanous62598e32023-07-17 17:06:25 -0700386 BMCWEB_LOG_DEBUG("Sensor to find: {}", tsensor);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700387 }
388
389 for (const std::pair<
390 std::string,
391 std::vector<std::pair<std::string, std::vector<std::string>>>>&
392 object : subtree)
393 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700394 if (sensorNames->find(object.first) != sensorNames->end())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700395 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700396 for (const std::pair<std::string, std::vector<std::string>>&
397 objData : object.second)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700398 {
Ed Tanous62598e32023-07-17 17:06:25 -0700399 BMCWEB_LOG_DEBUG("Adding connection: {}", objData.first);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700400 connections.insert(objData.first);
401 objectsWithConnection.insert(
402 std::make_pair(object.first, objData.first));
Ed Tanous1abe55e2018-09-05 08:30:59 -0700403 }
404 }
405 }
Ed Tanous62598e32023-07-17 17:06:25 -0700406 BMCWEB_LOG_DEBUG("Found {} connections", connections.size());
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530407 callback(std::move(connections), std::move(objectsWithConnection));
Ed Tanous62598e32023-07-17 17:06:25 -0700408 BMCWEB_LOG_DEBUG("getObjectsWithConnection resp_handler exit");
Patrick Williams5a39f772023-10-20 11:20:21 -0500409 });
Ed Tanous62598e32023-07-17 17:06:25 -0700410 BMCWEB_LOG_DEBUG("getObjectsWithConnection exit");
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530411}
412
413/**
414 * @brief Create connections necessary for sensors
415 * @param SensorsAsyncResp Pointer to object holding response data
416 * @param sensorNames Sensors retrieved from chassis
417 * @param callback Callback for processing gathered connections
418 */
419template <typename Callback>
Nan Zhoufe04d492022-06-22 17:10:41 +0000420void getConnections(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
421 const std::shared_ptr<std::set<std::string>> sensorNames,
422 Callback&& callback)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530423{
424 auto objectsWithConnectionCb =
Nan Zhoufe04d492022-06-22 17:10:41 +0000425 [callback](const std::set<std::string>& connections,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530426 const std::set<std::pair<std::string, std::string>>&
Ed Tanous3174e4d2020-10-07 11:41:22 -0700427 /*objectsWithConnection*/) { callback(connections); };
Ed Tanous81ce6092020-12-17 16:54:55 +0000428 getObjectsWithConnection(sensorsAsyncResp, sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530429 std::move(objectsWithConnectionCb));
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100430}
431
432/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700433 * @brief Shrinks the list of sensors for processing
434 * @param SensorsAysncResp The class holding the Redfish response
435 * @param allSensors A list of all the sensors associated to the
436 * chassis element (i.e. baseboard, front panel, etc...)
437 * @param activeSensors A list that is a reduction of the incoming
438 * allSensors list. Eliminate Thermal sensors when a Power request is
439 * made, and eliminate Power sensors when a Thermal request is made.
440 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000441inline void reduceSensorList(
Ed Tanous7f1cc262022-08-09 13:33:57 -0700442 crow::Response& res, std::string_view chassisSubNode,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800443 std::span<const std::string_view> sensorTypes,
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700444 const std::vector<std::string>* allSensors,
Nan Zhoufe04d492022-06-22 17:10:41 +0000445 const std::shared_ptr<std::set<std::string>>& activeSensors)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700446{
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700447 if ((allSensors == nullptr) || (activeSensors == nullptr))
448 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700449 messages::resourceNotFound(res, chassisSubNode,
450 chassisSubNode == sensors::node::thermal
451 ? "Temperatures"
452 : "Voltages");
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700453
454 return;
455 }
456 if (allSensors->empty())
457 {
458 // Nothing to do, the activeSensors object is also empty
459 return;
460 }
461
Ed Tanous7f1cc262022-08-09 13:33:57 -0700462 for (std::string_view type : sensorTypes)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700463 {
464 for (const std::string& sensor : *allSensors)
465 {
Ed Tanous11ba3972022-07-11 09:50:41 -0700466 if (sensor.starts_with(type))
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700467 {
468 activeSensors->emplace(sensor);
469 }
470 }
471 }
472}
473
Ed Tanous7f1cc262022-08-09 13:33:57 -0700474/*
475 *Populates the top level collection for a given subnode. Populates
476 *SensorCollection, Power, or Thermal schemas.
477 *
478 * */
479inline void populateChassisNode(nlohmann::json& jsonValue,
480 std::string_view chassisSubNode)
481{
482 if (chassisSubNode == sensors::node::power)
483 {
484 jsonValue["@odata.type"] = "#Power.v1_5_2.Power";
485 }
486 else if (chassisSubNode == sensors::node::thermal)
487 {
488 jsonValue["@odata.type"] = "#Thermal.v1_4_0.Thermal";
489 jsonValue["Fans"] = nlohmann::json::array();
490 jsonValue["Temperatures"] = nlohmann::json::array();
491 }
492 else if (chassisSubNode == sensors::node::sensors)
493 {
494 jsonValue["@odata.type"] = "#SensorCollection.SensorCollection";
495 jsonValue["Description"] = "Collection of Sensors for this Chassis";
496 jsonValue["Members"] = nlohmann::json::array();
497 jsonValue["Members@odata.count"] = 0;
498 }
499
500 if (chassisSubNode != sensors::node::sensors)
501 {
502 jsonValue["Id"] = chassisSubNode;
503 }
504 jsonValue["Name"] = chassisSubNode;
505}
506
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700507/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100508 * @brief Retrieves requested chassis sensors and redundancy data from DBus .
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200509 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100510 * @param callback Callback for next step in gathered sensor processing
511 */
512template <typename Callback>
Ed Tanous7f1cc262022-08-09 13:33:57 -0700513void getChassis(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
514 std::string_view chassisId, std::string_view chassisSubNode,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800515 std::span<const std::string_view> sensorTypes,
516 Callback&& callback)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700517{
Ed Tanous62598e32023-07-17 17:06:25 -0700518 BMCWEB_LOG_DEBUG("getChassis enter");
George Liu7a1dbc42022-12-07 16:03:22 +0800519 constexpr std::array<std::string_view, 2> interfaces = {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700520 "xyz.openbmc_project.Inventory.Item.Board",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500521 "xyz.openbmc_project.Inventory.Item.Chassis"};
George Liu7a1dbc42022-12-07 16:03:22 +0800522
523 // Get the Chassis Collection
524 dbus::utility::getSubTreePaths(
525 "/xyz/openbmc_project/inventory", 0, interfaces,
Ed Tanous7f1cc262022-08-09 13:33:57 -0700526 [callback{std::forward<Callback>(callback)}, asyncResp,
527 chassisIdStr{std::string(chassisId)},
528 chassisSubNode{std::string(chassisSubNode)}, sensorTypes](
George Liu7a1dbc42022-12-07 16:03:22 +0800529 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -0700530 const dbus::utility::MapperGetSubTreePathsResponse& chassisPaths) {
Ed Tanous62598e32023-07-17 17:06:25 -0700531 BMCWEB_LOG_DEBUG("getChassis respHandler enter");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700532 if (ec)
533 {
Ed Tanous62598e32023-07-17 17:06:25 -0700534 BMCWEB_LOG_ERROR("getChassis respHandler DBUS error: {}", ec);
Ed Tanous7f1cc262022-08-09 13:33:57 -0700535 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700536 return;
537 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700538 const std::string* chassisPath = nullptr;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700539 for (const std::string& chassis : chassisPaths)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700540 {
George Liu28aa8de2021-02-01 15:13:30 +0800541 sdbusplus::message::object_path path(chassis);
Ed Tanousf8fe53e2022-06-30 15:55:45 -0700542 std::string chassisName = path.filename();
George Liu28aa8de2021-02-01 15:13:30 +0800543 if (chassisName.empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700544 {
Ed Tanous62598e32023-07-17 17:06:25 -0700545 BMCWEB_LOG_ERROR("Failed to find '/' in {}", chassis);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700546 continue;
547 }
Ed Tanous7f1cc262022-08-09 13:33:57 -0700548 if (chassisName == chassisIdStr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700549 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700550 chassisPath = &chassis;
551 break;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700552 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700553 }
554 if (chassisPath == nullptr)
555 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700556 messages::resourceNotFound(asyncResp->res, "Chassis", chassisIdStr);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700557 return;
558 }
Ed Tanous7f1cc262022-08-09 13:33:57 -0700559 populateChassisNode(asyncResp->res.jsonValue, chassisSubNode);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700560
Ed Tanousef4c65b2023-04-24 15:28:50 -0700561 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
562 "/redfish/v1/Chassis/{}/{}", chassisIdStr, chassisSubNode);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500563
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500564 // Get the list of all sensors for this Chassis element
565 std::string sensorPath = *chassisPath + "/all_sensors";
George Liu6c3e9452023-03-03 13:55:29 +0800566 dbus::utility::getAssociationEndPoints(
567 sensorPath,
Ed Tanous7f1cc262022-08-09 13:33:57 -0700568 [asyncResp, chassisSubNode, sensorTypes,
Ed Tanousf94c4ec2022-01-06 12:44:41 -0800569 callback{std::forward<const Callback>(callback)}](
Ed Tanous8b242752023-06-27 17:17:13 -0700570 const boost::system::error_code& ec2,
George Liu6c3e9452023-03-03 13:55:29 +0800571 const dbus::utility::MapperEndPoints& nodeSensorList) {
Ed Tanous8b242752023-06-27 17:17:13 -0700572 if (ec2)
Ed Tanous002d39b2022-05-31 08:59:27 -0700573 {
Ed Tanous8b242752023-06-27 17:17:13 -0700574 if (ec2.value() != EBADR)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700575 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700576 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -0700577 return;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700578 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700579 }
Nan Zhoufe04d492022-06-22 17:10:41 +0000580 const std::shared_ptr<std::set<std::string>> culledSensorList =
581 std::make_shared<std::set<std::string>>();
Ed Tanous7f1cc262022-08-09 13:33:57 -0700582 reduceSensorList(asyncResp->res, chassisSubNode, sensorTypes,
583 &nodeSensorList, culledSensorList);
Ed Tanous62598e32023-07-17 17:06:25 -0700584 BMCWEB_LOG_DEBUG("Finishing with {}", culledSensorList->size());
Ed Tanous002d39b2022-05-31 08:59:27 -0700585 callback(culledSensorList);
George Liu7a1dbc42022-12-07 16:03:22 +0800586 });
Patrick Williams5a39f772023-10-20 11:20:21 -0500587 });
Ed Tanous62598e32023-07-17 17:06:25 -0700588 BMCWEB_LOG_DEBUG("getChassis exit");
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100589}
590
591/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500592 * @brief Returns the Redfish State value for the specified inventory item.
593 * @param inventoryItem D-Bus inventory item associated with a sensor.
594 * @return State value for inventory item.
James Feist34dd1792019-05-17 14:10:54 -0700595 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000596inline std::string getState(const InventoryItem* inventoryItem)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500597{
598 if ((inventoryItem != nullptr) && !(inventoryItem->isPresent))
599 {
600 return "Absent";
601 }
James Feist34dd1792019-05-17 14:10:54 -0700602
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500603 return "Enabled";
604}
605
606/**
607 * @brief Returns the Redfish Health value for the specified sensor.
608 * @param sensorJson Sensor JSON object.
Ed Tanous1d7c0052022-08-09 12:32:26 -0700609 * @param valuesDict Map of all sensor DBus values.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500610 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
611 * be nullptr if no associated inventory item was found.
612 * @return Health value for sensor.
613 */
Ed Tanous1d7c0052022-08-09 12:32:26 -0700614inline std::string getHealth(nlohmann::json& sensorJson,
615 const dbus::utility::DBusPropertiesMap& valuesDict,
616 const InventoryItem* inventoryItem)
James Feist34dd1792019-05-17 14:10:54 -0700617{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500618 // Get current health value (if any) in the sensor JSON object. Some JSON
619 // objects contain multiple sensors (such as PowerSupplies). We want to set
620 // the overall health to be the most severe of any of the sensors.
621 std::string currentHealth;
622 auto statusIt = sensorJson.find("Status");
623 if (statusIt != sensorJson.end())
624 {
625 auto healthIt = statusIt->find("Health");
626 if (healthIt != statusIt->end())
627 {
628 std::string* health = healthIt->get_ptr<std::string*>();
629 if (health != nullptr)
630 {
631 currentHealth = *health;
632 }
633 }
634 }
635
636 // If current health in JSON object is already Critical, return that. This
637 // should override the sensor health, which might be less severe.
638 if (currentHealth == "Critical")
639 {
640 return "Critical";
641 }
642
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200643 const bool* criticalAlarmHigh = nullptr;
644 const bool* criticalAlarmLow = nullptr;
645 const bool* warningAlarmHigh = nullptr;
646 const bool* warningAlarmLow = nullptr;
Ed Tanous711ac7a2021-12-20 09:34:41 -0800647
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200648 const bool success = sdbusplus::unpackPropertiesNoThrow(
649 dbus_utils::UnpackErrorPrinter(), valuesDict, "CriticalAlarmHigh",
650 criticalAlarmHigh, "CriticalAlarmLow", criticalAlarmLow,
651 "WarningAlarmHigh", warningAlarmHigh, "WarningAlarmLow",
652 warningAlarmLow);
653
654 if (success)
James Feist34dd1792019-05-17 14:10:54 -0700655 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200656 // Check if sensor has critical threshold alarm
657 if ((criticalAlarmHigh != nullptr && *criticalAlarmHigh) ||
658 (criticalAlarmLow != nullptr && *criticalAlarmLow))
James Feist34dd1792019-05-17 14:10:54 -0700659 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200660 return "Critical";
James Feist34dd1792019-05-17 14:10:54 -0700661 }
662 }
663
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500664 // Check if associated inventory item is not functional
665 if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional))
666 {
667 return "Critical";
668 }
669
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200670 // If current health in JSON object is already Warning, return that. This
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500671 // should override the sensor status, which might be less severe.
672 if (currentHealth == "Warning")
673 {
674 return "Warning";
675 }
676
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200677 if (success)
James Feist34dd1792019-05-17 14:10:54 -0700678 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200679 // Check if sensor has warning threshold alarm
680 if ((warningAlarmHigh != nullptr && *warningAlarmHigh) ||
681 (warningAlarmLow != nullptr && *warningAlarmLow))
James Feist34dd1792019-05-17 14:10:54 -0700682 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200683 return "Warning";
James Feist34dd1792019-05-17 14:10:54 -0700684 }
685 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500686
James Feist34dd1792019-05-17 14:10:54 -0700687 return "OK";
688}
689
Ed Tanous23a21a12020-07-25 04:45:05 +0000690inline void setLedState(nlohmann::json& sensorJson,
Anthony Wilsond5005492019-07-31 16:34:17 -0500691 const InventoryItem* inventoryItem)
692{
693 if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty())
694 {
695 switch (inventoryItem->ledState)
696 {
697 case LedState::OFF:
698 sensorJson["IndicatorLED"] = "Off";
699 break;
700 case LedState::ON:
701 sensorJson["IndicatorLED"] = "Lit";
702 break;
703 case LedState::BLINK:
704 sensorJson["IndicatorLED"] = "Blinking";
705 break;
Ed Tanous23a21a12020-07-25 04:45:05 +0000706 case LedState::UNKNOWN:
Anthony Wilsond5005492019-07-31 16:34:17 -0500707 break;
708 }
709 }
710}
711
James Feist34dd1792019-05-17 14:10:54 -0700712/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100713 * @brief Builds a json sensor representation of a sensor.
714 * @param sensorName The name of the sensor to be built
Gunnar Mills274fad52018-06-13 15:45:36 -0500715 * @param sensorType The type (temperature, fan_tach, etc) of the sensor to
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100716 * build
Ed Tanous8ece0e42024-01-02 13:16:50 -0800717 * @param chassisSubNode The subnode (thermal, sensor, etc) of the sensor
Ed Tanous1d7c0052022-08-09 12:32:26 -0700718 * @param propertiesDict A dictionary of the properties to build the sensor
719 * from.
720 * @param sensorJson The json object to fill
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500721 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
722 * be nullptr if no associated inventory item was found.
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100723 */
Ed Tanous1d7c0052022-08-09 12:32:26 -0700724inline void objectPropertiesToJson(
725 std::string_view sensorName, std::string_view sensorType,
726 std::string_view chassisSubNode,
727 const dbus::utility::DBusPropertiesMap& propertiesDict,
Ed Tanous81ce6092020-12-17 16:54:55 +0000728 nlohmann::json& sensorJson, InventoryItem* inventoryItem)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700729{
Ed Tanous1d7c0052022-08-09 12:32:26 -0700730 if (chassisSubNode == sensors::node::sensors)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500731 {
Ed Tanousc71d6122022-11-29 14:10:32 -0800732 std::string subNodeEscaped(sensorType);
Ed Tanous3544d2a2023-08-06 18:12:20 -0700733 auto remove = std::ranges::remove(subNodeEscaped, '_');
734 subNodeEscaped.erase(std::ranges::begin(remove), subNodeEscaped.end());
Ed Tanousc1d019a2022-08-06 09:36:06 -0700735
736 // For sensors in SensorCollection we set Id instead of MemberId,
737 // including power sensors.
738 subNodeEscaped += '_';
739 subNodeEscaped += sensorName;
740 sensorJson["Id"] = std::move(subNodeEscaped);
741
Ed Tanous1d7c0052022-08-09 12:32:26 -0700742 std::string sensorNameEs(sensorName);
743 std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
744 sensorJson["Name"] = std::move(sensorNameEs);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500745 }
746 else if (sensorType != "power")
747 {
748 // Set MemberId and Name for non-power sensors. For PowerSupplies and
749 // PowerControl, those properties have more general values because
750 // multiple sensors can be stored in the same JSON object.
Ed Tanous1d7c0052022-08-09 12:32:26 -0700751 std::string sensorNameEs(sensorName);
752 std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
753 sensorJson["Name"] = std::move(sensorNameEs);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500754 }
Ed Tanouse742b6c2019-05-03 15:06:53 -0700755
Ed Tanous81ce6092020-12-17 16:54:55 +0000756 sensorJson["Status"]["State"] = getState(inventoryItem);
Patrick Williams89492a12023-05-10 07:51:34 -0500757 sensorJson["Status"]["Health"] = getHealth(sensorJson, propertiesDict,
758 inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700759
760 // Parameter to set to override the type we get from dbus, and force it to
761 // int, regardless of what is available. This is used for schemas like fan,
762 // that require integers, not floats.
763 bool forceToInt = false;
764
Anthony Wilson3929aca2019-07-19 15:42:33 -0500765 nlohmann::json::json_pointer unit("/Reading");
Ed Tanous1d7c0052022-08-09 12:32:26 -0700766 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500767 {
Shounak Mitra2a4ba192022-06-01 23:34:12 +0000768 sensorJson["@odata.type"] = "#Sensor.v1_2_0.Sensor";
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000769
Ed Tanous0ec8b832022-03-14 14:56:47 -0700770 sensor::ReadingType readingType = sensors::toReadingType(sensorType);
771 if (readingType == sensor::ReadingType::Invalid)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500772 {
Ed Tanous62598e32023-07-17 17:06:25 -0700773 BMCWEB_LOG_ERROR("Redfish cannot map reading type for {}",
774 sensorType);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500775 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000776 else
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500777 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000778 sensorJson["ReadingType"] = readingType;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500779 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000780
Ed Tanous1d7c0052022-08-09 12:32:26 -0700781 std::string_view readingUnits = sensors::toReadingUnits(sensorType);
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000782 if (readingUnits.empty())
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200783 {
Ed Tanous62598e32023-07-17 17:06:25 -0700784 BMCWEB_LOG_ERROR("Redfish cannot map reading unit for {}",
785 sensorType);
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000786 }
787 else
788 {
789 sensorJson["ReadingUnits"] = readingUnits;
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200790 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500791 }
792 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700793 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500794 unit = "/ReadingCelsius"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000795 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700796 // TODO(ed) Documentation says that path should be type fan_tach,
797 // implementation seems to implement fan
798 }
799 else if (sensorType == "fan" || sensorType == "fan_tach")
800 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500801 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000802 sensorJson["ReadingUnits"] = "RPM";
803 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
804 setLedState(sensorJson, inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700805 forceToInt = true;
806 }
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700807 else if (sensorType == "fan_pwm")
808 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500809 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000810 sensorJson["ReadingUnits"] = "Percent";
811 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
812 setLedState(sensorJson, inventoryItem);
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700813 forceToInt = true;
814 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700815 else if (sensorType == "voltage")
816 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500817 unit = "/ReadingVolts"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000818 sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700819 }
Ed Tanous2474adf2018-09-05 16:31:16 -0700820 else if (sensorType == "power")
821 {
Ed Tanous18f8f602023-07-18 10:07:23 -0700822 std::string lower;
823 std::ranges::transform(sensorName, std::back_inserter(lower),
824 bmcweb::asciiToLower);
825 if (lower == "total_power")
Eddie James028f7eb2019-05-17 21:24:36 +0000826 {
Ed Tanous81ce6092020-12-17 16:54:55 +0000827 sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl";
Gunnar Mills7ab06f42019-07-02 13:07:16 -0500828 // Put multiple "sensors" into a single PowerControl, so have
829 // generic names for MemberId and Name. Follows Redfish mockup.
Ed Tanous81ce6092020-12-17 16:54:55 +0000830 sensorJson["MemberId"] = "0";
831 sensorJson["Name"] = "Chassis Power Control";
Anthony Wilson3929aca2019-07-19 15:42:33 -0500832 unit = "/PowerConsumedWatts"_json_pointer;
Eddie James028f7eb2019-05-17 21:24:36 +0000833 }
Ed Tanous18f8f602023-07-18 10:07:23 -0700834 else if (lower.find("input") != std::string::npos)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700835 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500836 unit = "/PowerInputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700837 }
838 else
839 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500840 unit = "/PowerOutputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700841 }
Ed Tanous2474adf2018-09-05 16:31:16 -0700842 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700843 else
844 {
Ed Tanous62598e32023-07-17 17:06:25 -0700845 BMCWEB_LOG_ERROR("Redfish cannot map object type for {}", sensorName);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700846 return;
847 }
848 // Map of dbus interface name, dbus property name and redfish property_name
Anthony Wilson3929aca2019-07-19 15:42:33 -0500849 std::vector<
850 std::tuple<const char*, const char*, nlohmann::json::json_pointer>>
851 properties;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700852 properties.reserve(7);
853
854 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600855
Ed Tanous1d7c0052022-08-09 12:32:26 -0700856 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson3929aca2019-07-19 15:42:33 -0500857 {
858 properties.emplace_back(
859 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh",
860 "/Thresholds/UpperCaution/Reading"_json_pointer);
861 properties.emplace_back(
862 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow",
863 "/Thresholds/LowerCaution/Reading"_json_pointer);
864 properties.emplace_back(
865 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh",
866 "/Thresholds/UpperCritical/Reading"_json_pointer);
867 properties.emplace_back(
868 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow",
869 "/Thresholds/LowerCritical/Reading"_json_pointer);
870 }
871 else if (sensorType != "power")
Shawn McCarneyde629b62019-03-08 10:42:51 -0600872 {
873 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500874 "WarningHigh",
875 "/UpperThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600876 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500877 "WarningLow",
878 "/LowerThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600879 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500880 "CriticalHigh",
881 "/UpperThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600882 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500883 "CriticalLow",
884 "/LowerThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600885 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700886
Ed Tanous2474adf2018-09-05 16:31:16 -0700887 // TODO Need to get UpperThresholdFatal and LowerThresholdFatal
888
Ed Tanous1d7c0052022-08-09 12:32:26 -0700889 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500890 {
891 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500892 "/ReadingRangeMin"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500893 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500894 "/ReadingRangeMax"_json_pointer);
George Liu51c35a82022-10-13 20:22:14 +0800895 properties.emplace_back("xyz.openbmc_project.Sensor.Accuracy",
896 "Accuracy", "/Accuracy"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500897 }
898 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700899 {
900 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500901 "/MinReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700902 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500903 "/MaxReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700904 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500905 else if (sensorType != "power")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700906 {
907 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500908 "/MinReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700909 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500910 "/MaxReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700911 }
912
Anthony Wilson3929aca2019-07-19 15:42:33 -0500913 for (const std::tuple<const char*, const char*,
914 nlohmann::json::json_pointer>& p : properties)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700915 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700916 for (const auto& [valueName, valueVariant] : propertiesDict)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700917 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700918 if (valueName != std::get<1>(p))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700919 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800920 continue;
921 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700922
923 // The property we want to set may be nested json, so use
924 // a json_pointer for easy indexing into the json structure.
925 const nlohmann::json::json_pointer& key = std::get<2>(p);
926
Ed Tanous1d7c0052022-08-09 12:32:26 -0700927 const double* doubleValue = std::get_if<double>(&valueVariant);
Ed Tanous40e4f382022-08-09 18:42:51 -0700928 if (doubleValue == nullptr)
Ed Tanous711ac7a2021-12-20 09:34:41 -0800929 {
Ed Tanous62598e32023-07-17 17:06:25 -0700930 BMCWEB_LOG_ERROR("Got value interface that wasn't double");
Ed Tanous1d7c0052022-08-09 12:32:26 -0700931 continue;
932 }
Ed Tanous283860f2022-08-29 14:08:50 -0700933 if (!std::isfinite(*doubleValue))
934 {
935 if (valueName == "Value")
936 {
937 // Readings are allowed to be NAN for unavailable; coerce
938 // them to null in the json response.
939 sensorJson[key] = nullptr;
940 continue;
941 }
Ed Tanous62598e32023-07-17 17:06:25 -0700942 BMCWEB_LOG_WARNING("Sensor value for {} was unexpectedly {}",
943 valueName, *doubleValue);
Ed Tanous283860f2022-08-29 14:08:50 -0700944 continue;
945 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700946 if (forceToInt)
947 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700948 sensorJson[key] = static_cast<int64_t>(*doubleValue);
Ed Tanous1d7c0052022-08-09 12:32:26 -0700949 }
950 else
951 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700952 sensorJson[key] = *doubleValue;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700953 }
954 }
955 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100956}
957
Ed Tanous1d7c0052022-08-09 12:32:26 -0700958/**
959 * @brief Builds a json sensor representation of a sensor.
960 * @param sensorName The name of the sensor to be built
961 * @param sensorType The type (temperature, fan_tach, etc) of the sensor to
962 * build
Ed Tanous8ece0e42024-01-02 13:16:50 -0800963 * @param chassisSubNode The subnode (thermal, sensor, etc) of the sensor
Ed Tanous1d7c0052022-08-09 12:32:26 -0700964 * @param interfacesDict A dictionary of the interfaces and properties of said
965 * interfaces to be built from
966 * @param sensorJson The json object to fill
967 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
968 * be nullptr if no associated inventory item was found.
969 */
970inline void objectInterfacesToJson(
971 const std::string& sensorName, const std::string& sensorType,
972 const std::string& chassisSubNode,
Michael Shen80f79a42023-08-24 13:41:53 +0000973 const dbus::utility::DBusInterfacesMap& interfacesDict,
Ed Tanous1d7c0052022-08-09 12:32:26 -0700974 nlohmann::json& sensorJson, InventoryItem* inventoryItem)
975{
Ed Tanous1d7c0052022-08-09 12:32:26 -0700976 for (const auto& [interface, valuesDict] : interfacesDict)
977 {
978 objectPropertiesToJson(sensorName, sensorType, chassisSubNode,
979 valuesDict, sensorJson, inventoryItem);
980 }
Ed Tanous62598e32023-07-17 17:06:25 -0700981 BMCWEB_LOG_DEBUG("Added sensor {}", sensorName);
Ed Tanous1d7c0052022-08-09 12:32:26 -0700982}
983
Ed Tanousb5a76932020-09-29 16:16:58 -0700984inline void populateFanRedundancy(
985 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
James Feist8bd25cc2019-03-15 15:14:00 -0700986{
George Liue99073f2022-12-09 11:06:16 +0800987 constexpr std::array<std::string_view, 1> interfaces = {
988 "xyz.openbmc_project.Control.FanRedundancy"};
989 dbus::utility::getSubTree(
990 "/xyz/openbmc_project/control", 2, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800991 [sensorsAsyncResp](
George Liue99073f2022-12-09 11:06:16 +0800992 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800993 const dbus::utility::MapperGetSubTreeResponse& resp) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700994 if (ec)
995 {
996 return; // don't have to have this interface
997 }
George Liu6c3e9452023-03-03 13:55:29 +0800998 for (const std::pair<std::string, dbus::utility::MapperServiceMap>&
Ed Tanous002d39b2022-05-31 08:59:27 -0700999 pathPair : resp)
1000 {
1001 const std::string& path = pathPair.first;
George Liu6c3e9452023-03-03 13:55:29 +08001002 const dbus::utility::MapperServiceMap& objDict = pathPair.second;
Ed Tanous002d39b2022-05-31 08:59:27 -07001003 if (objDict.empty())
James Feist8bd25cc2019-03-15 15:14:00 -07001004 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001005 continue; // this should be impossible
James Feist8bd25cc2019-03-15 15:14:00 -07001006 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001007
1008 const std::string& owner = objDict.begin()->first;
George Liu6c3e9452023-03-03 13:55:29 +08001009 dbus::utility::getAssociationEndPoints(
1010 path + "/chassis",
1011 [path, owner, sensorsAsyncResp](
Ed Tanous8b242752023-06-27 17:17:13 -07001012 const boost::system::error_code& ec2,
George Liu6c3e9452023-03-03 13:55:29 +08001013 const dbus::utility::MapperEndPoints& endpoints) {
Ed Tanous8b242752023-06-27 17:17:13 -07001014 if (ec2)
James Feist8bd25cc2019-03-15 15:14:00 -07001015 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001016 return; // if they don't have an association we
1017 // can't tell what chassis is
James Feist8bd25cc2019-03-15 15:14:00 -07001018 }
Ed Tanous3544d2a2023-08-06 18:12:20 -07001019 auto found = std::ranges::find_if(
1020 endpoints, [sensorsAsyncResp](const std::string& entry) {
Patrick Williams5a39f772023-10-20 11:20:21 -05001021 return entry.find(sensorsAsyncResp->chassisId) !=
1022 std::string::npos;
1023 });
James Feist8bd25cc2019-03-15 15:14:00 -07001024
Ed Tanous002d39b2022-05-31 08:59:27 -07001025 if (found == endpoints.end())
1026 {
1027 return;
1028 }
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001029 sdbusplus::asio::getAllProperties(
1030 *crow::connections::systemBus, owner, path,
1031 "xyz.openbmc_project.Control.FanRedundancy",
Ed Tanous002d39b2022-05-31 08:59:27 -07001032 [path, sensorsAsyncResp](
Ed Tanous8b242752023-06-27 17:17:13 -07001033 const boost::system::error_code& ec3,
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001034 const dbus::utility::DBusPropertiesMap& ret) {
Ed Tanous8b242752023-06-27 17:17:13 -07001035 if (ec3)
Ed Tanous002d39b2022-05-31 08:59:27 -07001036 {
1037 return; // don't have to have this
1038 // interface
1039 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001040
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001041 const uint8_t* allowedFailures = nullptr;
1042 const std::vector<std::string>* collection = nullptr;
1043 const std::string* status = nullptr;
1044
1045 const bool success = sdbusplus::unpackPropertiesNoThrow(
1046 dbus_utils::UnpackErrorPrinter(), ret,
1047 "AllowedFailures", allowedFailures, "Collection",
1048 collection, "Status", status);
1049
1050 if (!success)
1051 {
1052 messages::internalError(
1053 sensorsAsyncResp->asyncResp->res);
1054 return;
1055 }
1056
1057 if (allowedFailures == nullptr || collection == nullptr ||
1058 status == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -07001059 {
Ed Tanous62598e32023-07-17 17:06:25 -07001060 BMCWEB_LOG_ERROR("Invalid redundancy interface");
Ed Tanous002d39b2022-05-31 08:59:27 -07001061 messages::internalError(
1062 sensorsAsyncResp->asyncResp->res);
1063 return;
1064 }
1065
Ed Tanous002d39b2022-05-31 08:59:27 -07001066 sdbusplus::message::object_path objectPath(path);
1067 std::string name = objectPath.filename();
1068 if (name.empty())
1069 {
1070 // this should be impossible
1071 messages::internalError(
1072 sensorsAsyncResp->asyncResp->res);
1073 return;
1074 }
Ed Tanous18f8f602023-07-18 10:07:23 -07001075 std::ranges::replace(name, '_', ' ');
Ed Tanous002d39b2022-05-31 08:59:27 -07001076
1077 std::string health;
1078
Ed Tanous11ba3972022-07-11 09:50:41 -07001079 if (status->ends_with("Full"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001080 {
1081 health = "OK";
1082 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001083 else if (status->ends_with("Degraded"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001084 {
1085 health = "Warning";
1086 }
1087 else
1088 {
1089 health = "Critical";
1090 }
1091 nlohmann::json::array_t redfishCollection;
1092 const auto& fanRedfish =
1093 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"];
1094 for (const std::string& item : *collection)
1095 {
Ed Tanous8a592812022-06-04 09:06:59 -07001096 sdbusplus::message::object_path itemPath(item);
1097 std::string itemName = itemPath.filename();
Ed Tanous002d39b2022-05-31 08:59:27 -07001098 if (itemName.empty())
James Feist8bd25cc2019-03-15 15:14:00 -07001099 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001100 continue;
James Feist8bd25cc2019-03-15 15:14:00 -07001101 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001102 /*
1103 todo(ed): merge patch that fixes the names
1104 std::replace(itemName.begin(),
1105 itemName.end(), '_', ' ');*/
Ed Tanous3544d2a2023-08-06 18:12:20 -07001106 auto schemaItem = std::ranges::find_if(
1107 fanRedfish, [itemName](const nlohmann::json& fan) {
Patrick Williams5a39f772023-10-20 11:20:21 -05001108 return fan["Name"] == itemName;
1109 });
Ed Tanous002d39b2022-05-31 08:59:27 -07001110 if (schemaItem != fanRedfish.end())
James Feist8bd25cc2019-03-15 15:14:00 -07001111 {
Ed Tanous8a592812022-06-04 09:06:59 -07001112 nlohmann::json::object_t collectionId;
1113 collectionId["@odata.id"] =
Ed Tanous002d39b2022-05-31 08:59:27 -07001114 (*schemaItem)["@odata.id"];
1115 redfishCollection.emplace_back(
Ed Tanous8a592812022-06-04 09:06:59 -07001116 std::move(collectionId));
Ed Tanous002d39b2022-05-31 08:59:27 -07001117 }
1118 else
1119 {
Ed Tanous62598e32023-07-17 17:06:25 -07001120 BMCWEB_LOG_ERROR("failed to find fan in schema");
Ed Tanous002d39b2022-05-31 08:59:27 -07001121 messages::internalError(
1122 sensorsAsyncResp->asyncResp->res);
James Feist8bd25cc2019-03-15 15:14:00 -07001123 return;
1124 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001125 }
James Feist8bd25cc2019-03-15 15:14:00 -07001126
Patrick Williams89492a12023-05-10 07:51:34 -05001127 size_t minNumNeeded = collection->empty()
1128 ? 0
1129 : collection->size() -
1130 *allowedFailures;
Ed Tanous002d39b2022-05-31 08:59:27 -07001131 nlohmann::json& jResp = sensorsAsyncResp->asyncResp->res
1132 .jsonValue["Redundancy"];
James Feist8bd25cc2019-03-15 15:14:00 -07001133
Ed Tanous002d39b2022-05-31 08:59:27 -07001134 nlohmann::json::object_t redundancy;
Ed Tanousef4c65b2023-04-24 15:28:50 -07001135 boost::urls::url url =
1136 boost::urls::format("/redfish/v1/Chassis/{}/{}",
1137 sensorsAsyncResp->chassisId,
1138 sensorsAsyncResp->chassisSubNode);
Willy Tueddfc432022-09-26 16:46:38 +00001139 url.set_fragment(("/Redundancy"_json_pointer / jResp.size())
1140 .to_string());
1141 redundancy["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -07001142 redundancy["@odata.type"] = "#Redundancy.v1_3_2.Redundancy";
1143 redundancy["MinNumNeeded"] = minNumNeeded;
Ed Tanous002d39b2022-05-31 08:59:27 -07001144 redundancy["Mode"] = "N+m";
1145 redundancy["Name"] = name;
1146 redundancy["RedundancySet"] = redfishCollection;
1147 redundancy["Status"]["Health"] = health;
1148 redundancy["Status"]["State"] = "Enabled";
James Feist8bd25cc2019-03-15 15:14:00 -07001149
Patrick Williamsb2ba3072023-05-12 10:27:39 -05001150 jResp.emplace_back(std::move(redundancy));
Ed Tanous002d39b2022-05-31 08:59:27 -07001151 });
Patrick Williams5a39f772023-10-20 11:20:21 -05001152 });
Ed Tanous002d39b2022-05-31 08:59:27 -07001153 }
Patrick Williams5a39f772023-10-20 11:20:21 -05001154 });
James Feist8bd25cc2019-03-15 15:14:00 -07001155}
1156
Ed Tanousb5a76932020-09-29 16:16:58 -07001157inline void
Ed Tanous81ce6092020-12-17 16:54:55 +00001158 sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001159{
zhanghch058d1b46d2021-04-01 11:18:24 +08001160 nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001161 std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"};
Ed Tanous81ce6092020-12-17 16:54:55 +00001162 if (sensorsAsyncResp->chassisSubNode == sensors::node::power)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001163 {
1164 sensorHeaders = {"Voltages", "PowerSupplies"};
1165 }
1166 for (const std::string& sensorGroup : sensorHeaders)
1167 {
1168 nlohmann::json::iterator entry = response.find(sensorGroup);
1169 if (entry != response.end())
1170 {
1171 std::sort(entry->begin(), entry->end(),
Ed Tanous02cad962022-06-30 16:50:15 -07001172 [](const nlohmann::json& c1, const nlohmann::json& c2) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001173 return c1["Name"] < c2["Name"];
1174 });
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001175
1176 // add the index counts to the end of each entry
1177 size_t count = 0;
1178 for (nlohmann::json& sensorJson : *entry)
1179 {
1180 nlohmann::json::iterator odata = sensorJson.find("@odata.id");
1181 if (odata == sensorJson.end())
1182 {
1183 continue;
1184 }
1185 std::string* value = odata->get_ptr<std::string*>();
1186 if (value != nullptr)
1187 {
Willy Tueddfc432022-09-26 16:46:38 +00001188 *value += "/" + std::to_string(count);
George Liu3e35c762023-03-08 16:56:38 +08001189 sensorJson["MemberId"] = std::to_string(count);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001190 count++;
Ed Tanous81ce6092020-12-17 16:54:55 +00001191 sensorsAsyncResp->updateUri(sensorJson["Name"], *value);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001192 }
1193 }
1194 }
1195 }
1196}
1197
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01001198/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001199 * @brief Finds the inventory item with the specified object path.
1200 * @param inventoryItems D-Bus inventory items associated with sensors.
1201 * @param invItemObjPath D-Bus object path of inventory item.
1202 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001203 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001204inline InventoryItem* findInventoryItem(
Ed Tanousb5a76932020-09-29 16:16:58 -07001205 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001206 const std::string& invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001207{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001208 for (InventoryItem& inventoryItem : *inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001209 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001210 if (inventoryItem.objectPath == invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001211 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001212 return &inventoryItem;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001213 }
1214 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001215 return nullptr;
1216}
1217
1218/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001219 * @brief Finds the inventory item associated with the specified sensor.
1220 * @param inventoryItems D-Bus inventory items associated with sensors.
1221 * @param sensorObjPath D-Bus object path of sensor.
1222 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001223 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001224inline InventoryItem* findInventoryItemForSensor(
Ed Tanousb5a76932020-09-29 16:16:58 -07001225 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001226 const std::string& sensorObjPath)
1227{
1228 for (InventoryItem& inventoryItem : *inventoryItems)
1229 {
Ed Tanousdb0d36e2023-06-30 10:37:05 -07001230 if (inventoryItem.sensors.contains(sensorObjPath))
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001231 {
1232 return &inventoryItem;
1233 }
1234 }
1235 return nullptr;
1236}
1237
1238/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001239 * @brief Finds the inventory item associated with the specified led path.
1240 * @param inventoryItems D-Bus inventory items associated with sensors.
1241 * @param ledObjPath D-Bus object path of led.
1242 * @return Inventory item within vector, or nullptr if no match found.
1243 */
1244inline InventoryItem*
1245 findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems,
1246 const std::string& ledObjPath)
1247{
1248 for (InventoryItem& inventoryItem : inventoryItems)
1249 {
1250 if (inventoryItem.ledObjectPath == ledObjPath)
1251 {
1252 return &inventoryItem;
1253 }
1254 }
1255 return nullptr;
1256}
1257
1258/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001259 * @brief Adds inventory item and associated sensor to specified vector.
1260 *
1261 * Adds a new InventoryItem to the vector if necessary. Searches for an
1262 * existing InventoryItem with the specified object path. If not found, one is
1263 * added to the vector.
1264 *
1265 * Next, the specified sensor is added to the set of sensors associated with the
1266 * InventoryItem.
1267 *
1268 * @param inventoryItems D-Bus inventory items associated with sensors.
1269 * @param invItemObjPath D-Bus object path of inventory item.
1270 * @param sensorObjPath D-Bus object path of sensor
1271 */
Ed Tanousb5a76932020-09-29 16:16:58 -07001272inline void addInventoryItem(
1273 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
1274 const std::string& invItemObjPath, const std::string& sensorObjPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001275{
1276 // Look for inventory item in vector
Patrick Williams89492a12023-05-10 07:51:34 -05001277 InventoryItem* inventoryItem = findInventoryItem(inventoryItems,
1278 invItemObjPath);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001279
1280 // If inventory item doesn't exist in vector, add it
1281 if (inventoryItem == nullptr)
1282 {
1283 inventoryItems->emplace_back(invItemObjPath);
1284 inventoryItem = &(inventoryItems->back());
1285 }
1286
1287 // Add sensor to set of sensors associated with inventory item
1288 inventoryItem->sensors.emplace(sensorObjPath);
1289}
1290
1291/**
1292 * @brief Stores D-Bus data in the specified inventory item.
1293 *
1294 * Finds D-Bus data in the specified map of interfaces. Stores the data in the
1295 * specified InventoryItem.
1296 *
1297 * This data is later used to provide sensor property values in the JSON
1298 * response.
1299 *
1300 * @param inventoryItem Inventory item where data will be stored.
1301 * @param interfacesDict Map containing D-Bus interfaces and their properties
1302 * for the specified inventory item.
1303 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001304inline void storeInventoryItemData(
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001305 InventoryItem& inventoryItem,
Michael Shen80f79a42023-08-24 13:41:53 +00001306 const dbus::utility::DBusInterfacesMap& interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001307{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001308 // Get properties from Inventory.Item interface
Ed Tanous711ac7a2021-12-20 09:34:41 -08001309
Ed Tanous9eb808c2022-01-25 10:19:23 -08001310 for (const auto& [interface, values] : interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001311 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001312 if (interface == "xyz.openbmc_project.Inventory.Item")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001313 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001314 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001315 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001316 if (name == "Present")
1317 {
1318 const bool* value = std::get_if<bool>(&dbusValue);
1319 if (value != nullptr)
1320 {
1321 inventoryItem.isPresent = *value;
1322 }
1323 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001324 }
1325 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001326 // Check if Inventory.Item.PowerSupply interface is present
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001327
Ed Tanous711ac7a2021-12-20 09:34:41 -08001328 if (interface == "xyz.openbmc_project.Inventory.Item.PowerSupply")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001329 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001330 inventoryItem.isPowerSupply = true;
1331 }
1332
1333 // Get properties from Inventory.Decorator.Asset interface
1334 if (interface == "xyz.openbmc_project.Inventory.Decorator.Asset")
1335 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001336 for (const auto& [name, dbusValue] : values)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001337 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001338 if (name == "Manufacturer")
1339 {
1340 const std::string* value =
1341 std::get_if<std::string>(&dbusValue);
1342 if (value != nullptr)
1343 {
1344 inventoryItem.manufacturer = *value;
1345 }
1346 }
1347 if (name == "Model")
1348 {
1349 const std::string* value =
1350 std::get_if<std::string>(&dbusValue);
1351 if (value != nullptr)
1352 {
1353 inventoryItem.model = *value;
1354 }
1355 }
1356 if (name == "SerialNumber")
1357 {
1358 const std::string* value =
1359 std::get_if<std::string>(&dbusValue);
1360 if (value != nullptr)
1361 {
1362 inventoryItem.serialNumber = *value;
1363 }
1364 }
1365 if (name == "PartNumber")
1366 {
1367 const std::string* value =
1368 std::get_if<std::string>(&dbusValue);
1369 if (value != nullptr)
1370 {
1371 inventoryItem.partNumber = *value;
1372 }
1373 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001374 }
1375 }
1376
Ed Tanous711ac7a2021-12-20 09:34:41 -08001377 if (interface ==
1378 "xyz.openbmc_project.State.Decorator.OperationalStatus")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001379 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001380 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001381 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001382 if (name == "Functional")
1383 {
1384 const bool* value = std::get_if<bool>(&dbusValue);
1385 if (value != nullptr)
1386 {
1387 inventoryItem.isFunctional = *value;
1388 }
1389 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001390 }
1391 }
1392 }
1393}
1394
1395/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001396 * @brief Gets D-Bus data for inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001397 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001398 * Uses the specified connections (services) to obtain D-Bus data for inventory
1399 * items associated with sensors. Stores the resulting data in the
1400 * inventoryItems vector.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001401 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001402 * This data is later used to provide sensor property values in the JSON
1403 * response.
1404 *
1405 * Finds the inventory item data asynchronously. Invokes callback when data has
1406 * been obtained.
1407 *
1408 * The callback must have the following signature:
1409 * @code
Anthony Wilsond5005492019-07-31 16:34:17 -05001410 * callback(void)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001411 * @endcode
1412 *
1413 * This function is called recursively, obtaining data asynchronously from one
1414 * connection in each call. This ensures the callback is not invoked until the
1415 * last asynchronous function has completed.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001416 *
1417 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001418 * @param inventoryItems D-Bus inventory items associated with sensors.
1419 * @param invConnections Connections that provide data for the inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001420 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001421 * @param callback Callback to invoke when inventory data has been obtained.
1422 * @param invConnectionsIndex Current index in invConnections. Only specified
1423 * in recursive calls to this function.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001424 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001425template <typename Callback>
1426static void getInventoryItemsData(
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001427 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001428 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07001429 std::shared_ptr<std::set<std::string>> invConnections, Callback&& callback,
1430 size_t invConnectionsIndex = 0)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001431{
Ed Tanous62598e32023-07-17 17:06:25 -07001432 BMCWEB_LOG_DEBUG("getInventoryItemsData enter");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001433
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001434 // If no more connections left, call callback
1435 if (invConnectionsIndex >= invConnections->size())
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001436 {
Anthony Wilsond5005492019-07-31 16:34:17 -05001437 callback();
Ed Tanous62598e32023-07-17 17:06:25 -07001438 BMCWEB_LOG_DEBUG("getInventoryItemsData exit");
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001439 return;
1440 }
1441
1442 // Get inventory item data from current connection
Nan Zhoufe04d492022-06-22 17:10:41 +00001443 auto it = invConnections->begin();
1444 std::advance(it, invConnectionsIndex);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001445 if (it != invConnections->end())
1446 {
1447 const std::string& invConnection = *it;
1448
George Liu5eb468d2023-06-20 17:03:24 +08001449 // Get all object paths and their interfaces for current connection
1450 sdbusplus::message::object_path path("/xyz/openbmc_project/inventory");
1451 dbus::utility::getManagedObjects(
1452 invConnection, path,
1453 [sensorsAsyncResp, inventoryItems, invConnections,
1454 callback{std::forward<Callback>(callback)}, invConnectionsIndex](
1455 const boost::system::error_code& ec,
1456 const dbus::utility::ManagedObjectType& resp) {
Ed Tanous62598e32023-07-17 17:06:25 -07001457 BMCWEB_LOG_DEBUG("getInventoryItemsData respHandler enter");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001458 if (ec)
1459 {
Ed Tanous62598e32023-07-17 17:06:25 -07001460 BMCWEB_LOG_ERROR(
1461 "getInventoryItemsData respHandler DBus error {}", ec);
zhanghch058d1b46d2021-04-01 11:18:24 +08001462 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001463 return;
1464 }
1465
1466 // Loop through returned object paths
1467 for (const auto& objDictEntry : resp)
1468 {
1469 const std::string& objPath =
1470 static_cast<const std::string&>(objDictEntry.first);
1471
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001472 // If this object path is one of the specified inventory items
Patrick Williams89492a12023-05-10 07:51:34 -05001473 InventoryItem* inventoryItem = findInventoryItem(inventoryItems,
1474 objPath);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001475 if (inventoryItem != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001476 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001477 // Store inventory data in InventoryItem
1478 storeInventoryItemData(*inventoryItem, objDictEntry.second);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001479 }
1480 }
1481
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001482 // Recurse to get inventory item data from next connection
1483 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07001484 invConnections, std::move(callback),
1485 invConnectionsIndex + 1);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001486
Ed Tanous62598e32023-07-17 17:06:25 -07001487 BMCWEB_LOG_DEBUG("getInventoryItemsData respHandler exit");
Patrick Williams5a39f772023-10-20 11:20:21 -05001488 });
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001489 }
1490
Ed Tanous62598e32023-07-17 17:06:25 -07001491 BMCWEB_LOG_DEBUG("getInventoryItemsData exit");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001492}
1493
1494/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001495 * @brief Gets connections that provide D-Bus data for inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001496 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001497 * Gets the D-Bus connections (services) that provide data for the inventory
1498 * items that are associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001499 *
1500 * Finds the connections asynchronously. Invokes callback when information has
1501 * been obtained.
1502 *
1503 * The callback must have the following signature:
1504 * @code
Nan Zhoufe04d492022-06-22 17:10:41 +00001505 * callback(std::shared_ptr<std::set<std::string>> invConnections)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001506 * @endcode
1507 *
1508 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001509 * @param inventoryItems D-Bus inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001510 * @param callback Callback to invoke when connections have been obtained.
1511 */
1512template <typename Callback>
1513static void getInventoryItemsConnections(
Ed Tanousb5a76932020-09-29 16:16:58 -07001514 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
1515 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001516 Callback&& callback)
1517{
Ed Tanous62598e32023-07-17 17:06:25 -07001518 BMCWEB_LOG_DEBUG("getInventoryItemsConnections enter");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001519
1520 const std::string path = "/xyz/openbmc_project/inventory";
George Liue99073f2022-12-09 11:06:16 +08001521 constexpr std::array<std::string_view, 4> interfaces = {
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001522 "xyz.openbmc_project.Inventory.Item",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001523 "xyz.openbmc_project.Inventory.Item.PowerSupply",
1524 "xyz.openbmc_project.Inventory.Decorator.Asset",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001525 "xyz.openbmc_project.State.Decorator.OperationalStatus"};
1526
George Liue99073f2022-12-09 11:06:16 +08001527 // Make call to ObjectMapper to find all inventory items
1528 dbus::utility::getSubTree(
1529 path, 0, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -07001530 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1531 inventoryItems](
George Liue99073f2022-12-09 11:06:16 +08001532 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001533 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +08001534 // Response handler for parsing output from GetSubTree
Ed Tanous62598e32023-07-17 17:06:25 -07001535 BMCWEB_LOG_DEBUG("getInventoryItemsConnections respHandler enter");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001536 if (ec)
1537 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001538 messages::internalError(sensorsAsyncResp->asyncResp->res);
Ed Tanous62598e32023-07-17 17:06:25 -07001539 BMCWEB_LOG_ERROR(
1540 "getInventoryItemsConnections respHandler DBus error {}", ec);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001541 return;
1542 }
1543
1544 // Make unique list of connections for desired inventory items
Nan Zhoufe04d492022-06-22 17:10:41 +00001545 std::shared_ptr<std::set<std::string>> invConnections =
1546 std::make_shared<std::set<std::string>>();
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001547
1548 // Loop through objects from GetSubTree
1549 for (const std::pair<
1550 std::string,
1551 std::vector<std::pair<std::string, std::vector<std::string>>>>&
1552 object : subtree)
1553 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001554 // Check if object path is one of the specified inventory items
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001555 const std::string& objPath = object.first;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001556 if (findInventoryItem(inventoryItems, objPath) != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001557 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001558 // Store all connections to inventory item
1559 for (const std::pair<std::string, std::vector<std::string>>&
1560 objData : object.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001561 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001562 const std::string& invConnection = objData.first;
1563 invConnections->insert(invConnection);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001564 }
1565 }
1566 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001567
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001568 callback(invConnections);
Ed Tanous62598e32023-07-17 17:06:25 -07001569 BMCWEB_LOG_DEBUG("getInventoryItemsConnections respHandler exit");
Patrick Williams5a39f772023-10-20 11:20:21 -05001570 });
Ed Tanous62598e32023-07-17 17:06:25 -07001571 BMCWEB_LOG_DEBUG("getInventoryItemsConnections exit");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001572}
1573
1574/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001575 * @brief Gets associations from sensors to inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001576 *
1577 * Looks for ObjectMapper associations from the specified sensors to related
Anthony Wilsond5005492019-07-31 16:34:17 -05001578 * inventory items. Then finds the associations from those inventory items to
1579 * their LEDs, if any.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001580 *
1581 * Finds the inventory items asynchronously. Invokes callback when information
1582 * has been obtained.
1583 *
1584 * The callback must have the following signature:
1585 * @code
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001586 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001587 * @endcode
1588 *
1589 * @param sensorsAsyncResp Pointer to object holding response data.
1590 * @param sensorNames All sensors within the current chassis.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001591 * implements ObjectManager.
1592 * @param callback Callback to invoke when inventory items have been obtained.
1593 */
1594template <typename Callback>
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001595static void getInventoryItemAssociations(
Ed Tanousb5a76932020-09-29 16:16:58 -07001596 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +00001597 const std::shared_ptr<std::set<std::string>>& sensorNames,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001598 Callback&& callback)
1599{
Ed Tanous62598e32023-07-17 17:06:25 -07001600 BMCWEB_LOG_DEBUG("getInventoryItemAssociations enter");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001601
George Liu5eb468d2023-06-20 17:03:24 +08001602 // Call GetManagedObjects on the ObjectMapper to get all associations
1603 sdbusplus::message::object_path path("/");
1604 dbus::utility::getManagedObjects(
1605 "xyz.openbmc_project.ObjectMapper", path,
Ed Tanous02cad962022-06-30 16:50:15 -07001606 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001607 sensorNames](const boost::system::error_code& ec,
Ed Tanous02cad962022-06-30 16:50:15 -07001608 const dbus::utility::ManagedObjectType& resp) {
Ed Tanous62598e32023-07-17 17:06:25 -07001609 BMCWEB_LOG_DEBUG("getInventoryItemAssociations respHandler enter");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001610 if (ec)
1611 {
Ed Tanous62598e32023-07-17 17:06:25 -07001612 BMCWEB_LOG_ERROR(
1613 "getInventoryItemAssociations respHandler DBus error {}", ec);
zhanghch058d1b46d2021-04-01 11:18:24 +08001614 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001615 return;
1616 }
1617
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001618 // Create vector to hold list of inventory items
1619 std::shared_ptr<std::vector<InventoryItem>> inventoryItems =
1620 std::make_shared<std::vector<InventoryItem>>();
1621
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001622 // Loop through returned object paths
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001623 std::string sensorAssocPath;
1624 sensorAssocPath.reserve(128); // avoid memory allocations
1625 for (const auto& objDictEntry : resp)
1626 {
1627 const std::string& objPath =
1628 static_cast<const std::string&>(objDictEntry.first);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001629
1630 // If path is inventory association for one of the specified sensors
1631 for (const std::string& sensorName : *sensorNames)
1632 {
1633 sensorAssocPath = sensorName;
1634 sensorAssocPath += "/inventory";
1635 if (objPath == sensorAssocPath)
1636 {
1637 // Get Association interface for object path
Ed Tanous711ac7a2021-12-20 09:34:41 -08001638 for (const auto& [interface, values] : objDictEntry.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001639 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001640 if (interface == "xyz.openbmc_project.Association")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001641 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001642 for (const auto& [valueName, value] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001643 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001644 if (valueName == "endpoints")
1645 {
1646 const std::vector<std::string>* endpoints =
1647 std::get_if<std::vector<std::string>>(
1648 &value);
1649 if ((endpoints != nullptr) &&
1650 !endpoints->empty())
1651 {
1652 // Add inventory item to vector
1653 const std::string& invItemPath =
1654 endpoints->front();
1655 addInventoryItem(inventoryItems,
1656 invItemPath,
1657 sensorName);
1658 }
1659 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001660 }
1661 }
1662 }
1663 break;
1664 }
1665 }
1666 }
1667
Anthony Wilsond5005492019-07-31 16:34:17 -05001668 // Now loop through the returned object paths again, this time to
1669 // find the leds associated with the inventory items we just found
1670 std::string inventoryAssocPath;
1671 inventoryAssocPath.reserve(128); // avoid memory allocations
1672 for (const auto& objDictEntry : resp)
1673 {
1674 const std::string& objPath =
1675 static_cast<const std::string&>(objDictEntry.first);
Anthony Wilsond5005492019-07-31 16:34:17 -05001676
1677 for (InventoryItem& inventoryItem : *inventoryItems)
1678 {
1679 inventoryAssocPath = inventoryItem.objectPath;
1680 inventoryAssocPath += "/leds";
1681 if (objPath == inventoryAssocPath)
1682 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001683 for (const auto& [interface, values] : objDictEntry.second)
Anthony Wilsond5005492019-07-31 16:34:17 -05001684 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001685 if (interface == "xyz.openbmc_project.Association")
Anthony Wilsond5005492019-07-31 16:34:17 -05001686 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001687 for (const auto& [valueName, value] : values)
Anthony Wilsond5005492019-07-31 16:34:17 -05001688 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001689 if (valueName == "endpoints")
1690 {
1691 const std::vector<std::string>* endpoints =
1692 std::get_if<std::vector<std::string>>(
1693 &value);
1694 if ((endpoints != nullptr) &&
1695 !endpoints->empty())
1696 {
1697 // Add inventory item to vector
1698 // Store LED path in inventory item
1699 const std::string& ledPath =
1700 endpoints->front();
1701 inventoryItem.ledObjectPath = ledPath;
1702 }
1703 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001704 }
1705 }
1706 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001707
Anthony Wilsond5005492019-07-31 16:34:17 -05001708 break;
1709 }
1710 }
1711 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001712 callback(inventoryItems);
Ed Tanous62598e32023-07-17 17:06:25 -07001713 BMCWEB_LOG_DEBUG("getInventoryItemAssociations respHandler exit");
Patrick Williams5a39f772023-10-20 11:20:21 -05001714 });
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001715
Ed Tanous62598e32023-07-17 17:06:25 -07001716 BMCWEB_LOG_DEBUG("getInventoryItemAssociations exit");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001717}
1718
1719/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001720 * @brief Gets D-Bus data for inventory item leds associated with sensors.
1721 *
1722 * Uses the specified connections (services) to obtain D-Bus data for inventory
1723 * item leds associated with sensors. Stores the resulting data in the
1724 * inventoryItems vector.
1725 *
1726 * This data is later used to provide sensor property values in the JSON
1727 * response.
1728 *
1729 * Finds the inventory item led data asynchronously. Invokes callback when data
1730 * has been obtained.
1731 *
1732 * The callback must have the following signature:
1733 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05001734 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05001735 * @endcode
1736 *
1737 * This function is called recursively, obtaining data asynchronously from one
1738 * connection in each call. This ensures the callback is not invoked until the
1739 * last asynchronous function has completed.
1740 *
1741 * @param sensorsAsyncResp Pointer to object holding response data.
1742 * @param inventoryItems D-Bus inventory items associated with sensors.
1743 * @param ledConnections Connections that provide data for the inventory leds.
1744 * @param callback Callback to invoke when inventory data has been obtained.
1745 * @param ledConnectionsIndex Current index in ledConnections. Only specified
1746 * in recursive calls to this function.
1747 */
1748template <typename Callback>
1749void getInventoryLedData(
1750 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1751 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Nan Zhoufe04d492022-06-22 17:10:41 +00001752 std::shared_ptr<std::map<std::string, std::string>> ledConnections,
Anthony Wilsond5005492019-07-31 16:34:17 -05001753 Callback&& callback, size_t ledConnectionsIndex = 0)
1754{
Ed Tanous62598e32023-07-17 17:06:25 -07001755 BMCWEB_LOG_DEBUG("getInventoryLedData enter");
Anthony Wilsond5005492019-07-31 16:34:17 -05001756
1757 // If no more connections left, call callback
1758 if (ledConnectionsIndex >= ledConnections->size())
1759 {
Gunnar Mills42cbe532019-08-15 15:26:54 -05001760 callback();
Ed Tanous62598e32023-07-17 17:06:25 -07001761 BMCWEB_LOG_DEBUG("getInventoryLedData exit");
Anthony Wilsond5005492019-07-31 16:34:17 -05001762 return;
1763 }
1764
1765 // Get inventory item data from current connection
Nan Zhoufe04d492022-06-22 17:10:41 +00001766 auto it = ledConnections->begin();
1767 std::advance(it, ledConnectionsIndex);
Anthony Wilsond5005492019-07-31 16:34:17 -05001768 if (it != ledConnections->end())
1769 {
1770 const std::string& ledPath = (*it).first;
1771 const std::string& ledConnection = (*it).second;
1772 // Response handler for Get State property
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001773 auto respHandler =
1774 [sensorsAsyncResp, inventoryItems, ledConnections, ledPath,
Ed Tanousf94c4ec2022-01-06 12:44:41 -08001775 callback{std::forward<Callback>(callback)}, ledConnectionsIndex](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001776 const boost::system::error_code& ec, const std::string& state) {
Ed Tanous62598e32023-07-17 17:06:25 -07001777 BMCWEB_LOG_DEBUG("getInventoryLedData respHandler enter");
Ed Tanous002d39b2022-05-31 08:59:27 -07001778 if (ec)
1779 {
Ed Tanous62598e32023-07-17 17:06:25 -07001780 BMCWEB_LOG_ERROR(
1781 "getInventoryLedData respHandler DBus error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07001782 messages::internalError(sensorsAsyncResp->asyncResp->res);
1783 return;
1784 }
1785
Ed Tanous62598e32023-07-17 17:06:25 -07001786 BMCWEB_LOG_DEBUG("Led state: {}", state);
Ed Tanous002d39b2022-05-31 08:59:27 -07001787 // Find inventory item with this LED object path
1788 InventoryItem* inventoryItem =
1789 findInventoryItemForLed(*inventoryItems, ledPath);
1790 if (inventoryItem != nullptr)
1791 {
1792 // Store LED state in InventoryItem
Ed Tanous11ba3972022-07-11 09:50:41 -07001793 if (state.ends_with("On"))
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001794 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001795 inventoryItem->ledState = LedState::ON;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001796 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001797 else if (state.ends_with("Blink"))
Anthony Wilsond5005492019-07-31 16:34:17 -05001798 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001799 inventoryItem->ledState = LedState::BLINK;
Anthony Wilsond5005492019-07-31 16:34:17 -05001800 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001801 else if (state.ends_with("Off"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001802 {
1803 inventoryItem->ledState = LedState::OFF;
1804 }
1805 else
1806 {
1807 inventoryItem->ledState = LedState::UNKNOWN;
1808 }
1809 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001810
Ed Tanous002d39b2022-05-31 08:59:27 -07001811 // Recurse to get LED data from next connection
1812 getInventoryLedData(sensorsAsyncResp, inventoryItems,
1813 ledConnections, std::move(callback),
1814 ledConnectionsIndex + 1);
Anthony Wilsond5005492019-07-31 16:34:17 -05001815
Ed Tanous62598e32023-07-17 17:06:25 -07001816 BMCWEB_LOG_DEBUG("getInventoryLedData respHandler exit");
Ed Tanous002d39b2022-05-31 08:59:27 -07001817 };
Anthony Wilsond5005492019-07-31 16:34:17 -05001818
1819 // Get the State property for the current LED
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001820 sdbusplus::asio::getProperty<std::string>(
1821 *crow::connections::systemBus, ledConnection, ledPath,
1822 "xyz.openbmc_project.Led.Physical", "State",
1823 std::move(respHandler));
Anthony Wilsond5005492019-07-31 16:34:17 -05001824 }
1825
Ed Tanous62598e32023-07-17 17:06:25 -07001826 BMCWEB_LOG_DEBUG("getInventoryLedData exit");
Anthony Wilsond5005492019-07-31 16:34:17 -05001827}
1828
1829/**
1830 * @brief Gets LED data for LEDs associated with given inventory items.
1831 *
1832 * Gets the D-Bus connections (services) that provide LED data for the LEDs
1833 * associated with the specified inventory items. Then gets the LED data from
1834 * each connection and stores it in the inventory item.
1835 *
1836 * This data is later used to provide sensor property values in the JSON
1837 * response.
1838 *
1839 * Finds the LED data asynchronously. Invokes callback when information has
1840 * been obtained.
1841 *
1842 * The callback must have the following signature:
1843 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05001844 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05001845 * @endcode
1846 *
1847 * @param sensorsAsyncResp Pointer to object holding response data.
1848 * @param inventoryItems D-Bus inventory items associated with sensors.
1849 * @param callback Callback to invoke when inventory items have been obtained.
1850 */
1851template <typename Callback>
1852void getInventoryLeds(
1853 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1854 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1855 Callback&& callback)
1856{
Ed Tanous62598e32023-07-17 17:06:25 -07001857 BMCWEB_LOG_DEBUG("getInventoryLeds enter");
Anthony Wilsond5005492019-07-31 16:34:17 -05001858
1859 const std::string path = "/xyz/openbmc_project";
George Liue99073f2022-12-09 11:06:16 +08001860 constexpr std::array<std::string_view, 1> interfaces = {
Anthony Wilsond5005492019-07-31 16:34:17 -05001861 "xyz.openbmc_project.Led.Physical"};
1862
George Liue99073f2022-12-09 11:06:16 +08001863 // Make call to ObjectMapper to find all inventory items
1864 dbus::utility::getSubTree(
1865 path, 0, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -07001866 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1867 inventoryItems](
George Liue99073f2022-12-09 11:06:16 +08001868 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07001869 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +08001870 // Response handler for parsing output from GetSubTree
Ed Tanous62598e32023-07-17 17:06:25 -07001871 BMCWEB_LOG_DEBUG("getInventoryLeds respHandler enter");
Anthony Wilsond5005492019-07-31 16:34:17 -05001872 if (ec)
1873 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001874 messages::internalError(sensorsAsyncResp->asyncResp->res);
Ed Tanous62598e32023-07-17 17:06:25 -07001875 BMCWEB_LOG_ERROR("getInventoryLeds respHandler DBus error {}", ec);
Anthony Wilsond5005492019-07-31 16:34:17 -05001876 return;
1877 }
1878
1879 // Build map of LED object paths to connections
Nan Zhoufe04d492022-06-22 17:10:41 +00001880 std::shared_ptr<std::map<std::string, std::string>> ledConnections =
1881 std::make_shared<std::map<std::string, std::string>>();
Anthony Wilsond5005492019-07-31 16:34:17 -05001882
1883 // Loop through objects from GetSubTree
1884 for (const std::pair<
1885 std::string,
1886 std::vector<std::pair<std::string, std::vector<std::string>>>>&
1887 object : subtree)
1888 {
1889 // Check if object path is LED for one of the specified inventory
1890 // items
1891 const std::string& ledPath = object.first;
1892 if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr)
1893 {
1894 // Add mapping from ledPath to connection
1895 const std::string& connection = object.second.begin()->first;
1896 (*ledConnections)[ledPath] = connection;
Ed Tanous62598e32023-07-17 17:06:25 -07001897 BMCWEB_LOG_DEBUG("Added mapping {} -> {}", ledPath, connection);
Anthony Wilsond5005492019-07-31 16:34:17 -05001898 }
1899 }
1900
1901 getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections,
1902 std::move(callback));
Ed Tanous62598e32023-07-17 17:06:25 -07001903 BMCWEB_LOG_DEBUG("getInventoryLeds respHandler exit");
Patrick Williams5a39f772023-10-20 11:20:21 -05001904 });
Ed Tanous62598e32023-07-17 17:06:25 -07001905 BMCWEB_LOG_DEBUG("getInventoryLeds exit");
Anthony Wilsond5005492019-07-31 16:34:17 -05001906}
1907
1908/**
Gunnar Mills42cbe532019-08-15 15:26:54 -05001909 * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent
1910 *
1911 * Uses the specified connections (services) (currently assumes just one) to
1912 * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in
1913 * the inventoryItems vector. Only stores data in Power Supply inventoryItems.
1914 *
1915 * This data is later used to provide sensor property values in the JSON
1916 * response.
1917 *
1918 * Finds the Power Supply Attributes data asynchronously. Invokes callback
1919 * when data has been obtained.
1920 *
1921 * The callback must have the following signature:
1922 * @code
1923 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
1924 * @endcode
1925 *
1926 * @param sensorsAsyncResp Pointer to object holding response data.
1927 * @param inventoryItems D-Bus inventory items associated with sensors.
1928 * @param psAttributesConnections Connections that provide data for the Power
1929 * Supply Attributes
1930 * @param callback Callback to invoke when data has been obtained.
1931 */
1932template <typename Callback>
1933void getPowerSupplyAttributesData(
Ed Tanousb5a76932020-09-29 16:16:58 -07001934 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Gunnar Mills42cbe532019-08-15 15:26:54 -05001935 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Nan Zhoufe04d492022-06-22 17:10:41 +00001936 const std::map<std::string, std::string>& psAttributesConnections,
Gunnar Mills42cbe532019-08-15 15:26:54 -05001937 Callback&& callback)
1938{
Ed Tanous62598e32023-07-17 17:06:25 -07001939 BMCWEB_LOG_DEBUG("getPowerSupplyAttributesData enter");
Gunnar Mills42cbe532019-08-15 15:26:54 -05001940
1941 if (psAttributesConnections.empty())
1942 {
Ed Tanous62598e32023-07-17 17:06:25 -07001943 BMCWEB_LOG_DEBUG("Can't find PowerSupplyAttributes, no connections!");
Gunnar Mills42cbe532019-08-15 15:26:54 -05001944 callback(inventoryItems);
1945 return;
1946 }
1947
1948 // Assuming just one connection (service) for now
Nan Zhoufe04d492022-06-22 17:10:41 +00001949 auto it = psAttributesConnections.begin();
Gunnar Mills42cbe532019-08-15 15:26:54 -05001950
1951 const std::string& psAttributesPath = (*it).first;
1952 const std::string& psAttributesConnection = (*it).second;
1953
1954 // Response handler for Get DeratingFactor property
Patrick Williams5a39f772023-10-20 11:20:21 -05001955 auto respHandler = [sensorsAsyncResp, inventoryItems,
1956 callback{std::forward<Callback>(callback)}](
1957 const boost::system::error_code& ec,
1958 const uint32_t value) {
Ed Tanous62598e32023-07-17 17:06:25 -07001959 BMCWEB_LOG_DEBUG("getPowerSupplyAttributesData respHandler enter");
Gunnar Mills42cbe532019-08-15 15:26:54 -05001960 if (ec)
1961 {
Ed Tanous62598e32023-07-17 17:06:25 -07001962 BMCWEB_LOG_ERROR(
1963 "getPowerSupplyAttributesData respHandler DBus error {}", ec);
zhanghch058d1b46d2021-04-01 11:18:24 +08001964 messages::internalError(sensorsAsyncResp->asyncResp->res);
Gunnar Mills42cbe532019-08-15 15:26:54 -05001965 return;
1966 }
1967
Ed Tanous62598e32023-07-17 17:06:25 -07001968 BMCWEB_LOG_DEBUG("PS EfficiencyPercent value: {}", value);
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001969 // Store value in Power Supply Inventory Items
1970 for (InventoryItem& inventoryItem : *inventoryItems)
Gunnar Mills42cbe532019-08-15 15:26:54 -05001971 {
Ed Tanous55f79e62022-01-25 11:26:16 -08001972 if (inventoryItem.isPowerSupply)
Gunnar Mills42cbe532019-08-15 15:26:54 -05001973 {
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001974 inventoryItem.powerSupplyEfficiencyPercent =
1975 static_cast<int>(value);
Gunnar Mills42cbe532019-08-15 15:26:54 -05001976 }
1977 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05001978
Ed Tanous62598e32023-07-17 17:06:25 -07001979 BMCWEB_LOG_DEBUG("getPowerSupplyAttributesData respHandler exit");
Gunnar Mills42cbe532019-08-15 15:26:54 -05001980 callback(inventoryItems);
1981 };
1982
1983 // Get the DeratingFactor property for the PowerSupplyAttributes
1984 // Currently only property on the interface/only one we care about
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001985 sdbusplus::asio::getProperty<uint32_t>(
1986 *crow::connections::systemBus, psAttributesConnection, psAttributesPath,
1987 "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor",
1988 std::move(respHandler));
Gunnar Mills42cbe532019-08-15 15:26:54 -05001989
Ed Tanous62598e32023-07-17 17:06:25 -07001990 BMCWEB_LOG_DEBUG("getPowerSupplyAttributesData exit");
Gunnar Mills42cbe532019-08-15 15:26:54 -05001991}
1992
1993/**
1994 * @brief Gets the Power Supply Attributes such as EfficiencyPercent
1995 *
1996 * Gets the D-Bus connection (service) that provides Power Supply Attributes
1997 * data. Then gets the Power Supply Attributes data from the connection
1998 * (currently just assumes 1 connection) and stores the data in the inventory
1999 * item.
2000 *
2001 * This data is later used to provide sensor property values in the JSON
2002 * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish.
2003 *
2004 * Finds the Power Supply Attributes data asynchronously. Invokes callback
2005 * when information has been obtained.
2006 *
2007 * The callback must have the following signature:
2008 * @code
2009 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2010 * @endcode
2011 *
2012 * @param sensorsAsyncResp Pointer to object holding response data.
2013 * @param inventoryItems D-Bus inventory items associated with sensors.
2014 * @param callback Callback to invoke when data has been obtained.
2015 */
2016template <typename Callback>
2017void getPowerSupplyAttributes(
2018 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2019 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
2020 Callback&& callback)
2021{
Ed Tanous62598e32023-07-17 17:06:25 -07002022 BMCWEB_LOG_DEBUG("getPowerSupplyAttributes enter");
Gunnar Mills42cbe532019-08-15 15:26:54 -05002023
2024 // Only need the power supply attributes when the Power Schema
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002025 if (sensorsAsyncResp->chassisSubNode != sensors::node::power)
Gunnar Mills42cbe532019-08-15 15:26:54 -05002026 {
Ed Tanous62598e32023-07-17 17:06:25 -07002027 BMCWEB_LOG_DEBUG("getPowerSupplyAttributes exit since not Power");
Gunnar Mills42cbe532019-08-15 15:26:54 -05002028 callback(inventoryItems);
2029 return;
2030 }
2031
George Liue99073f2022-12-09 11:06:16 +08002032 constexpr std::array<std::string_view, 1> interfaces = {
Gunnar Mills42cbe532019-08-15 15:26:54 -05002033 "xyz.openbmc_project.Control.PowerSupplyAttributes"};
2034
George Liue99073f2022-12-09 11:06:16 +08002035 // Make call to ObjectMapper to find the PowerSupplyAttributes service
2036 dbus::utility::getSubTree(
2037 "/xyz/openbmc_project", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -08002038 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
2039 inventoryItems](
George Liue99073f2022-12-09 11:06:16 +08002040 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08002041 const dbus::utility::MapperGetSubTreeResponse& subtree) {
George Liue99073f2022-12-09 11:06:16 +08002042 // Response handler for parsing output from GetSubTree
Ed Tanous62598e32023-07-17 17:06:25 -07002043 BMCWEB_LOG_DEBUG("getPowerSupplyAttributes respHandler enter");
Ed Tanous002d39b2022-05-31 08:59:27 -07002044 if (ec)
2045 {
2046 messages::internalError(sensorsAsyncResp->asyncResp->res);
Ed Tanous62598e32023-07-17 17:06:25 -07002047 BMCWEB_LOG_ERROR(
2048 "getPowerSupplyAttributes respHandler DBus error {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07002049 return;
2050 }
2051 if (subtree.empty())
2052 {
Ed Tanous62598e32023-07-17 17:06:25 -07002053 BMCWEB_LOG_DEBUG("Can't find Power Supply Attributes!");
Ed Tanous002d39b2022-05-31 08:59:27 -07002054 callback(inventoryItems);
2055 return;
2056 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002057
Ed Tanous002d39b2022-05-31 08:59:27 -07002058 // Currently we only support 1 power supply attribute, use this for
2059 // all the power supplies. Build map of object path to connection.
2060 // Assume just 1 connection and 1 path for now.
Nan Zhoufe04d492022-06-22 17:10:41 +00002061 std::map<std::string, std::string> psAttributesConnections;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002062
Ed Tanous002d39b2022-05-31 08:59:27 -07002063 if (subtree[0].first.empty() || subtree[0].second.empty())
2064 {
Ed Tanous62598e32023-07-17 17:06:25 -07002065 BMCWEB_LOG_DEBUG("Power Supply Attributes mapper error!");
Ed Tanous002d39b2022-05-31 08:59:27 -07002066 callback(inventoryItems);
2067 return;
2068 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002069
Ed Tanous002d39b2022-05-31 08:59:27 -07002070 const std::string& psAttributesPath = subtree[0].first;
2071 const std::string& connection = subtree[0].second.begin()->first;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002072
Ed Tanous002d39b2022-05-31 08:59:27 -07002073 if (connection.empty())
2074 {
Ed Tanous62598e32023-07-17 17:06:25 -07002075 BMCWEB_LOG_DEBUG("Power Supply Attributes mapper error!");
Ed Tanous002d39b2022-05-31 08:59:27 -07002076 callback(inventoryItems);
2077 return;
2078 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002079
Ed Tanous002d39b2022-05-31 08:59:27 -07002080 psAttributesConnections[psAttributesPath] = connection;
Ed Tanous62598e32023-07-17 17:06:25 -07002081 BMCWEB_LOG_DEBUG("Added mapping {} -> {}", psAttributesPath,
2082 connection);
Gunnar Mills42cbe532019-08-15 15:26:54 -05002083
Ed Tanous002d39b2022-05-31 08:59:27 -07002084 getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems,
2085 psAttributesConnections,
2086 std::move(callback));
Ed Tanous62598e32023-07-17 17:06:25 -07002087 BMCWEB_LOG_DEBUG("getPowerSupplyAttributes respHandler exit");
Patrick Williams5a39f772023-10-20 11:20:21 -05002088 });
Ed Tanous62598e32023-07-17 17:06:25 -07002089 BMCWEB_LOG_DEBUG("getPowerSupplyAttributes exit");
Gunnar Mills42cbe532019-08-15 15:26:54 -05002090}
2091
2092/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002093 * @brief Gets inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002094 *
2095 * Finds the inventory items that are associated with the specified sensors.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002096 * Then gets D-Bus data for the inventory items, such as presence and VPD.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002097 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002098 * This data is later used to provide sensor property values in the JSON
2099 * response.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002100 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002101 * Finds the inventory items asynchronously. Invokes callback when the
2102 * inventory items have been obtained.
2103 *
2104 * The callback must have the following signature:
2105 * @code
2106 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2107 * @endcode
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002108 *
2109 * @param sensorsAsyncResp Pointer to object holding response data.
2110 * @param sensorNames All sensors within the current chassis.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002111 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002112 * @param callback Callback to invoke when inventory items have been obtained.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002113 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002114template <typename Callback>
Ed Tanousd0090732022-10-04 17:22:56 -07002115static void
2116 getInventoryItems(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2117 const std::shared_ptr<std::set<std::string>> sensorNames,
2118 Callback&& callback)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002119{
Ed Tanous62598e32023-07-17 17:06:25 -07002120 BMCWEB_LOG_DEBUG("getInventoryItems enter");
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002121 auto getInventoryItemAssociationsCb =
Ed Tanousd0090732022-10-04 17:22:56 -07002122 [sensorsAsyncResp, callback{std::forward<Callback>(callback)}](
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002123 std::shared_ptr<std::vector<InventoryItem>> inventoryItems) {
Ed Tanous62598e32023-07-17 17:06:25 -07002124 BMCWEB_LOG_DEBUG("getInventoryItemAssociationsCb enter");
Ed Tanous002d39b2022-05-31 08:59:27 -07002125 auto getInventoryItemsConnectionsCb =
Ed Tanousd0090732022-10-04 17:22:56 -07002126 [sensorsAsyncResp, inventoryItems,
Ed Tanous002d39b2022-05-31 08:59:27 -07002127 callback{std::forward<const Callback>(callback)}](
Nan Zhoufe04d492022-06-22 17:10:41 +00002128 std::shared_ptr<std::set<std::string>> invConnections) {
Ed Tanous62598e32023-07-17 17:06:25 -07002129 BMCWEB_LOG_DEBUG("getInventoryItemsConnectionsCb enter");
Ed Tanous002d39b2022-05-31 08:59:27 -07002130 auto getInventoryItemsDataCb = [sensorsAsyncResp, inventoryItems,
2131 callback{std::move(callback)}]() {
Ed Tanous62598e32023-07-17 17:06:25 -07002132 BMCWEB_LOG_DEBUG("getInventoryItemsDataCb enter");
Gunnar Mills42cbe532019-08-15 15:26:54 -05002133
Ed Tanous002d39b2022-05-31 08:59:27 -07002134 auto getInventoryLedsCb = [sensorsAsyncResp, inventoryItems,
2135 callback{std::move(callback)}]() {
Ed Tanous62598e32023-07-17 17:06:25 -07002136 BMCWEB_LOG_DEBUG("getInventoryLedsCb enter");
Ed Tanous002d39b2022-05-31 08:59:27 -07002137 // Find Power Supply Attributes and get the data
2138 getPowerSupplyAttributes(sensorsAsyncResp, inventoryItems,
2139 std::move(callback));
Ed Tanous62598e32023-07-17 17:06:25 -07002140 BMCWEB_LOG_DEBUG("getInventoryLedsCb exit");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002141 };
2142
Ed Tanous002d39b2022-05-31 08:59:27 -07002143 // Find led connections and get the data
2144 getInventoryLeds(sensorsAsyncResp, inventoryItems,
2145 std::move(getInventoryLedsCb));
Ed Tanous62598e32023-07-17 17:06:25 -07002146 BMCWEB_LOG_DEBUG("getInventoryItemsDataCb exit");
Ed Tanous002d39b2022-05-31 08:59:27 -07002147 };
2148
2149 // Get inventory item data from connections
2150 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07002151 invConnections,
Ed Tanous002d39b2022-05-31 08:59:27 -07002152 std::move(getInventoryItemsDataCb));
Ed Tanous62598e32023-07-17 17:06:25 -07002153 BMCWEB_LOG_DEBUG("getInventoryItemsConnectionsCb exit");
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002154 };
2155
Ed Tanous002d39b2022-05-31 08:59:27 -07002156 // Get connections that provide inventory item data
2157 getInventoryItemsConnections(sensorsAsyncResp, inventoryItems,
2158 std::move(getInventoryItemsConnectionsCb));
Ed Tanous62598e32023-07-17 17:06:25 -07002159 BMCWEB_LOG_DEBUG("getInventoryItemAssociationsCb exit");
Ed Tanous002d39b2022-05-31 08:59:27 -07002160 };
2161
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002162 // Get associations from sensors to inventory items
Ed Tanousd0090732022-10-04 17:22:56 -07002163 getInventoryItemAssociations(sensorsAsyncResp, sensorNames,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002164 std::move(getInventoryItemAssociationsCb));
Ed Tanous62598e32023-07-17 17:06:25 -07002165 BMCWEB_LOG_DEBUG("getInventoryItems exit");
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002166}
2167
2168/**
2169 * @brief Returns JSON PowerSupply object for the specified inventory item.
2170 *
2171 * Searches for a JSON PowerSupply object that matches the specified inventory
2172 * item. If one is not found, a new PowerSupply object is added to the JSON
2173 * array.
2174 *
2175 * Multiple sensors are often associated with one power supply inventory item.
2176 * As a result, multiple sensor values are stored in one JSON PowerSupply
2177 * object.
2178 *
2179 * @param powerSupplyArray JSON array containing Redfish PowerSupply objects.
2180 * @param inventoryItem Inventory item for the power supply.
2181 * @param chassisId Chassis that contains the power supply.
2182 * @return JSON PowerSupply object for the specified inventory item.
2183 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002184inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002185 const InventoryItem& inventoryItem,
2186 const std::string& chassisId)
2187{
Ed Tanous18f8f602023-07-18 10:07:23 -07002188 std::string nameS;
2189 std::ranges::replace_copy(inventoryItem.name, nameS.begin(), '_', ' ');
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002190 // Check if matching PowerSupply object already exists in JSON array
2191 for (nlohmann::json& powerSupply : powerSupplyArray)
2192 {
Ed Tanous18f8f602023-07-18 10:07:23 -07002193 nlohmann::json::iterator nameIt = powerSupply.find("Name");
2194 if (nameIt == powerSupply.end())
2195 {
2196 continue;
2197 }
2198 const std::string* name = nameIt->get_ptr<std::string*>();
2199 if (name == nullptr)
2200 {
2201 continue;
2202 }
2203 if (nameS == *name)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002204 {
2205 return powerSupply;
2206 }
2207 }
2208
2209 // Add new PowerSupply object to JSON array
2210 powerSupplyArray.push_back({});
2211 nlohmann::json& powerSupply = powerSupplyArray.back();
Ed Tanousef4c65b2023-04-24 15:28:50 -07002212 boost::urls::url url = boost::urls::format("/redfish/v1/Chassis/{}/Power",
2213 chassisId);
Willy Tueddfc432022-09-26 16:46:38 +00002214 url.set_fragment(("/PowerSupplies"_json_pointer).to_string());
2215 powerSupply["@odata.id"] = std::move(url);
Ed Tanous18f8f602023-07-18 10:07:23 -07002216 std::string escaped;
2217 std::ranges::replace_copy(inventoryItem.name, escaped.begin(), '_', ' ');
2218 powerSupply["Name"] = std::move(escaped);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002219 powerSupply["Manufacturer"] = inventoryItem.manufacturer;
2220 powerSupply["Model"] = inventoryItem.model;
2221 powerSupply["PartNumber"] = inventoryItem.partNumber;
2222 powerSupply["SerialNumber"] = inventoryItem.serialNumber;
Anthony Wilsond5005492019-07-31 16:34:17 -05002223 setLedState(powerSupply, &inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002224
Gunnar Mills42cbe532019-08-15 15:26:54 -05002225 if (inventoryItem.powerSupplyEfficiencyPercent >= 0)
2226 {
2227 powerSupply["EfficiencyPercent"] =
2228 inventoryItem.powerSupplyEfficiencyPercent;
2229 }
2230
2231 powerSupply["Status"]["State"] = getState(&inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002232 const char* health = inventoryItem.isFunctional ? "OK" : "Critical";
2233 powerSupply["Status"]["Health"] = health;
2234
2235 return powerSupply;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002236}
2237
2238/**
Shawn McCarneyde629b62019-03-08 10:42:51 -06002239 * @brief Gets the values of the specified sensors.
2240 *
2241 * Stores the results as JSON in the SensorsAsyncResp.
2242 *
2243 * Gets the sensor values asynchronously. Stores the results later when the
2244 * information has been obtained.
2245 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002246 * The sensorNames set contains all requested sensors for the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002247 *
2248 * To minimize the number of DBus calls, the DBus method
2249 * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the
2250 * values of all sensors provided by a connection (service).
2251 *
2252 * The connections set contains all the connections that provide sensor values.
2253 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002254 * The InventoryItem vector contains D-Bus inventory items associated with the
2255 * sensors. Inventory item data is needed for some Redfish sensor properties.
2256 *
Shawn McCarneyde629b62019-03-08 10:42:51 -06002257 * @param SensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002258 * @param sensorNames All requested sensors within the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002259 * @param connections Connections that provide sensor values.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002260 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002261 * @param inventoryItems Inventory items associated with the sensors.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002262 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002263inline void getSensorData(
Ed Tanous81ce6092020-12-17 16:54:55 +00002264 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +00002265 const std::shared_ptr<std::set<std::string>>& sensorNames,
2266 const std::set<std::string>& connections,
Ed Tanousb5a76932020-09-29 16:16:58 -07002267 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002268{
Ed Tanous62598e32023-07-17 17:06:25 -07002269 BMCWEB_LOG_DEBUG("getSensorData enter");
Shawn McCarneyde629b62019-03-08 10:42:51 -06002270 // Get managed objects from all services exposing sensors
2271 for (const std::string& connection : connections)
2272 {
George Liu5eb468d2023-06-20 17:03:24 +08002273 sdbusplus::message::object_path sensorPath(
2274 "/xyz/openbmc_project/sensors");
2275 dbus::utility::getManagedObjects(
2276 connection, sensorPath,
Ed Tanous002d39b2022-05-31 08:59:27 -07002277 [sensorsAsyncResp, sensorNames,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002278 inventoryItems](const boost::system::error_code& ec,
Ed Tanous02cad962022-06-30 16:50:15 -07002279 const dbus::utility::ManagedObjectType& resp) {
Ed Tanous62598e32023-07-17 17:06:25 -07002280 BMCWEB_LOG_DEBUG("getManagedObjectsCb enter");
Shawn McCarneyde629b62019-03-08 10:42:51 -06002281 if (ec)
2282 {
Ed Tanous62598e32023-07-17 17:06:25 -07002283 BMCWEB_LOG_ERROR("getManagedObjectsCb DBUS error: {}", ec);
zhanghch058d1b46d2021-04-01 11:18:24 +08002284 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002285 return;
2286 }
2287 // Go through all objects and update response with sensor data
2288 for (const auto& objDictEntry : resp)
2289 {
2290 const std::string& objPath =
2291 static_cast<const std::string&>(objDictEntry.first);
Ed Tanous62598e32023-07-17 17:06:25 -07002292 BMCWEB_LOG_DEBUG("getManagedObjectsCb parsing object {}",
2293 objPath);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002294
Shawn McCarneyde629b62019-03-08 10:42:51 -06002295 std::vector<std::string> split;
2296 // Reserve space for
2297 // /xyz/openbmc_project/sensors/<name>/<subname>
2298 split.reserve(6);
Ed Tanous50ebd4a2023-01-19 19:03:17 -08002299 // NOLINTNEXTLINE
2300 bmcweb::split(split, objPath, '/');
Shawn McCarneyde629b62019-03-08 10:42:51 -06002301 if (split.size() < 6)
2302 {
Ed Tanous62598e32023-07-17 17:06:25 -07002303 BMCWEB_LOG_ERROR("Got path that isn't long enough {}",
2304 objPath);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002305 continue;
2306 }
Ed Tanous50ebd4a2023-01-19 19:03:17 -08002307 // These indexes aren't intuitive, as split puts an empty
Shawn McCarneyde629b62019-03-08 10:42:51 -06002308 // string at the beginning
2309 const std::string& sensorType = split[4];
2310 const std::string& sensorName = split[5];
Ed Tanous62598e32023-07-17 17:06:25 -07002311 BMCWEB_LOG_DEBUG("sensorName {} sensorType {}", sensorName,
2312 sensorType);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002313 if (sensorNames->find(objPath) == sensorNames->end())
Shawn McCarneyde629b62019-03-08 10:42:51 -06002314 {
Ed Tanous62598e32023-07-17 17:06:25 -07002315 BMCWEB_LOG_DEBUG("{} not in sensor list ", sensorName);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002316 continue;
2317 }
2318
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002319 // Find inventory item (if any) associated with sensor
2320 InventoryItem* inventoryItem =
2321 findInventoryItemForSensor(inventoryItems, objPath);
2322
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002323 const std::string& sensorSchema =
Ed Tanous81ce6092020-12-17 16:54:55 +00002324 sensorsAsyncResp->chassisSubNode;
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002325
2326 nlohmann::json* sensorJson = nullptr;
2327
Nan Zhou928fefb2022-03-28 08:45:00 -07002328 if (sensorSchema == sensors::node::sensors &&
2329 !sensorsAsyncResp->efficientExpand)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002330 {
Ed Tanousc1d019a2022-08-06 09:36:06 -07002331 std::string sensorTypeEscaped(sensorType);
Ed Tanous3544d2a2023-08-06 18:12:20 -07002332 auto remove = std::ranges::remove(sensorTypeEscaped, '_');
2333
2334 sensorTypeEscaped.erase(std::ranges::begin(remove),
2335 sensorTypeEscaped.end());
Ed Tanousc1d019a2022-08-06 09:36:06 -07002336 std::string sensorId(sensorTypeEscaped);
2337 sensorId += "_";
2338 sensorId += sensorName;
2339
zhanghch058d1b46d2021-04-01 11:18:24 +08002340 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] =
Ed Tanousef4c65b2023-04-24 15:28:50 -07002341 boost::urls::format("/redfish/v1/Chassis/{}/{}/{}",
2342 sensorsAsyncResp->chassisId,
2343 sensorsAsyncResp->chassisSubNode,
2344 sensorId);
zhanghch058d1b46d2021-04-01 11:18:24 +08002345 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002346 }
2347 else
2348 {
Ed Tanous271584a2019-07-09 16:24:22 -07002349 std::string fieldName;
Nan Zhou928fefb2022-03-28 08:45:00 -07002350 if (sensorsAsyncResp->efficientExpand)
2351 {
2352 fieldName = "Members";
2353 }
2354 else if (sensorType == "temperature")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002355 {
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002356 fieldName = "Temperatures";
2357 }
2358 else if (sensorType == "fan" || sensorType == "fan_tach" ||
2359 sensorType == "fan_pwm")
2360 {
2361 fieldName = "Fans";
2362 }
2363 else if (sensorType == "voltage")
2364 {
2365 fieldName = "Voltages";
2366 }
2367 else if (sensorType == "power")
2368 {
Ed Tanous55f79e62022-01-25 11:26:16 -08002369 if (sensorName == "total_power")
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002370 {
2371 fieldName = "PowerControl";
2372 }
2373 else if ((inventoryItem != nullptr) &&
2374 (inventoryItem->isPowerSupply))
2375 {
2376 fieldName = "PowerSupplies";
2377 }
2378 else
2379 {
2380 // Other power sensors are in SensorCollection
2381 continue;
2382 }
2383 }
2384 else
2385 {
Ed Tanous62598e32023-07-17 17:06:25 -07002386 BMCWEB_LOG_ERROR("Unsure how to handle sensorType {}",
2387 sensorType);
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002388 continue;
2389 }
2390
2391 nlohmann::json& tempArray =
zhanghch058d1b46d2021-04-01 11:18:24 +08002392 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName];
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002393 if (fieldName == "PowerControl")
2394 {
2395 if (tempArray.empty())
2396 {
2397 // Put multiple "sensors" into a single
2398 // PowerControl. Follows MemberId naming and
2399 // naming in power.hpp.
Ed Tanous14766872022-03-15 10:44:42 -07002400 nlohmann::json::object_t power;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002401 boost::urls::url url = boost::urls::format(
2402 "/redfish/v1/Chassis/{}/{}",
Willy Tueddfc432022-09-26 16:46:38 +00002403 sensorsAsyncResp->chassisId,
2404 sensorsAsyncResp->chassisSubNode);
2405 url.set_fragment((""_json_pointer / fieldName / "0")
2406 .to_string());
2407 power["@odata.id"] = std::move(url);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002408 tempArray.emplace_back(std::move(power));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002409 }
2410 sensorJson = &(tempArray.back());
2411 }
2412 else if (fieldName == "PowerSupplies")
2413 {
2414 if (inventoryItem != nullptr)
2415 {
2416 sensorJson =
2417 &(getPowerSupply(tempArray, *inventoryItem,
Ed Tanous81ce6092020-12-17 16:54:55 +00002418 sensorsAsyncResp->chassisId));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002419 }
2420 }
Nan Zhou928fefb2022-03-28 08:45:00 -07002421 else if (fieldName == "Members")
2422 {
Ed Tanous677bb752022-09-15 10:52:19 -07002423 std::string sensorTypeEscaped(sensorType);
Ed Tanous3544d2a2023-08-06 18:12:20 -07002424 auto remove = std::ranges::remove(sensorTypeEscaped,
2425 '_');
2426 sensorTypeEscaped.erase(std::ranges::begin(remove),
2427 sensorTypeEscaped.end());
Ed Tanous677bb752022-09-15 10:52:19 -07002428 std::string sensorId(sensorTypeEscaped);
2429 sensorId += "_";
2430 sensorId += sensorName;
2431
Ed Tanous14766872022-03-15 10:44:42 -07002432 nlohmann::json::object_t member;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002433 member["@odata.id"] = boost::urls::format(
2434 "/redfish/v1/Chassis/{}/{}/{}",
Ed Tanous677bb752022-09-15 10:52:19 -07002435 sensorsAsyncResp->chassisId,
2436 sensorsAsyncResp->chassisSubNode, sensorId);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002437 tempArray.emplace_back(std::move(member));
Nan Zhou928fefb2022-03-28 08:45:00 -07002438 sensorJson = &(tempArray.back());
2439 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002440 else
2441 {
Ed Tanous14766872022-03-15 10:44:42 -07002442 nlohmann::json::object_t member;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002443 boost::urls::url url = boost::urls::format(
2444 "/redfish/v1/Chassis/{}/{}",
Willy Tueddfc432022-09-26 16:46:38 +00002445 sensorsAsyncResp->chassisId,
2446 sensorsAsyncResp->chassisSubNode);
2447 url.set_fragment(
2448 (""_json_pointer / fieldName).to_string());
2449 member["@odata.id"] = std::move(url);
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002450 tempArray.emplace_back(std::move(member));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002451 sensorJson = &(tempArray.back());
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002452 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002453 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002454
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002455 if (sensorJson != nullptr)
2456 {
Ed Tanous1d7c0052022-08-09 12:32:26 -07002457 objectInterfacesToJson(sensorName, sensorType,
2458 sensorsAsyncResp->chassisSubNode,
2459 objDictEntry.second, *sensorJson,
2460 inventoryItem);
2461
2462 std::string path = "/xyz/openbmc_project/sensors/";
2463 path += sensorType;
2464 path += "/";
2465 path += sensorName;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002466 sensorsAsyncResp->addMetadata(*sensorJson, path);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002467 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002468 }
Ed Tanous81ce6092020-12-17 16:54:55 +00002469 if (sensorsAsyncResp.use_count() == 1)
James Feist8bd25cc2019-03-15 15:14:00 -07002470 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002471 sortJSONResponse(sensorsAsyncResp);
Nan Zhou928fefb2022-03-28 08:45:00 -07002472 if (sensorsAsyncResp->chassisSubNode ==
2473 sensors::node::sensors &&
2474 sensorsAsyncResp->efficientExpand)
2475 {
2476 sensorsAsyncResp->asyncResp->res
2477 .jsonValue["Members@odata.count"] =
2478 sensorsAsyncResp->asyncResp->res.jsonValue["Members"]
2479 .size();
2480 }
2481 else if (sensorsAsyncResp->chassisSubNode ==
2482 sensors::node::thermal)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002483 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002484 populateFanRedundancy(sensorsAsyncResp);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002485 }
James Feist8bd25cc2019-03-15 15:14:00 -07002486 }
Ed Tanous62598e32023-07-17 17:06:25 -07002487 BMCWEB_LOG_DEBUG("getManagedObjectsCb exit");
Patrick Williams5a39f772023-10-20 11:20:21 -05002488 });
Ed Tanous23a21a12020-07-25 04:45:05 +00002489 }
Ed Tanous62598e32023-07-17 17:06:25 -07002490 BMCWEB_LOG_DEBUG("getSensorData exit");
Shawn McCarneyde629b62019-03-08 10:42:51 -06002491}
2492
Nan Zhoufe04d492022-06-22 17:10:41 +00002493inline void
2494 processSensorList(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
2495 const std::shared_ptr<std::set<std::string>>& sensorNames)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002496{
Nan Zhoufe04d492022-06-22 17:10:41 +00002497 auto getConnectionCb = [sensorsAsyncResp, sensorNames](
2498 const std::set<std::string>& connections) {
Ed Tanous62598e32023-07-17 17:06:25 -07002499 BMCWEB_LOG_DEBUG("getConnectionCb enter");
Ed Tanousd0090732022-10-04 17:22:56 -07002500 auto getInventoryItemsCb =
2501 [sensorsAsyncResp, sensorNames,
2502 connections](const std::shared_ptr<std::vector<InventoryItem>>&
2503 inventoryItems) {
Ed Tanous62598e32023-07-17 17:06:25 -07002504 BMCWEB_LOG_DEBUG("getInventoryItemsCb enter");
Ed Tanousd0090732022-10-04 17:22:56 -07002505 // Get sensor data and store results in JSON
2506 getSensorData(sensorsAsyncResp, sensorNames, connections,
2507 inventoryItems);
Ed Tanous62598e32023-07-17 17:06:25 -07002508 BMCWEB_LOG_DEBUG("getInventoryItemsCb exit");
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002509 };
2510
Ed Tanousd0090732022-10-04 17:22:56 -07002511 // Get inventory items associated with sensors
2512 getInventoryItems(sensorsAsyncResp, sensorNames,
2513 std::move(getInventoryItemsCb));
2514
Ed Tanous62598e32023-07-17 17:06:25 -07002515 BMCWEB_LOG_DEBUG("getConnectionCb exit");
Ed Tanous002d39b2022-05-31 08:59:27 -07002516 };
2517
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002518 // Get set of connections that provide sensor values
Ed Tanous81ce6092020-12-17 16:54:55 +00002519 getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002520}
2521
Shawn McCarneyde629b62019-03-08 10:42:51 -06002522/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002523 * @brief Entry point for retrieving sensors data related to requested
2524 * chassis.
Kowalski, Kamil588c3f02018-04-03 14:55:27 +02002525 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002526 */
Ed Tanousb5a76932020-09-29 16:16:58 -07002527inline void
Ed Tanous81ce6092020-12-17 16:54:55 +00002528 getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
Ed Tanous1abe55e2018-09-05 08:30:59 -07002529{
Ed Tanous62598e32023-07-17 17:06:25 -07002530 BMCWEB_LOG_DEBUG("getChassisData enter");
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002531 auto getChassisCb =
Ed Tanous81ce6092020-12-17 16:54:55 +00002532 [sensorsAsyncResp](
Nan Zhoufe04d492022-06-22 17:10:41 +00002533 const std::shared_ptr<std::set<std::string>>& sensorNames) {
Ed Tanous62598e32023-07-17 17:06:25 -07002534 BMCWEB_LOG_DEBUG("getChassisCb enter");
Ed Tanous002d39b2022-05-31 08:59:27 -07002535 processSensorList(sensorsAsyncResp, sensorNames);
Ed Tanous62598e32023-07-17 17:06:25 -07002536 BMCWEB_LOG_DEBUG("getChassisCb exit");
Ed Tanous002d39b2022-05-31 08:59:27 -07002537 };
Nan Zhou928fefb2022-03-28 08:45:00 -07002538 // SensorCollection doesn't contain the Redundancy property
2539 if (sensorsAsyncResp->chassisSubNode != sensors::node::sensors)
2540 {
2541 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] =
2542 nlohmann::json::array();
2543 }
Shawn McCarney26f03892019-05-03 13:20:24 -05002544 // Get set of sensors in chassis
Ed Tanous7f1cc262022-08-09 13:33:57 -07002545 getChassis(sensorsAsyncResp->asyncResp, sensorsAsyncResp->chassisId,
2546 sensorsAsyncResp->chassisSubNode, sensorsAsyncResp->types,
2547 std::move(getChassisCb));
Ed Tanous62598e32023-07-17 17:06:25 -07002548 BMCWEB_LOG_DEBUG("getChassisData exit");
Ed Tanous271584a2019-07-09 16:24:22 -07002549}
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002550
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302551/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002552 * @brief Find the requested sensorName in the list of all sensors supplied by
2553 * the chassis node
2554 *
2555 * @param sensorName The sensor name supplied in the PATCH request
2556 * @param sensorsList The list of sensors managed by the chassis node
2557 * @param sensorsModified The list of sensors that were found as a result of
2558 * repeated calls to this function
2559 */
Nan Zhoufe04d492022-06-22 17:10:41 +00002560inline bool
2561 findSensorNameUsingSensorPath(std::string_view sensorName,
Ed Tanous02cad962022-06-30 16:50:15 -07002562 const std::set<std::string>& sensorsList,
Nan Zhoufe04d492022-06-22 17:10:41 +00002563 std::set<std::string>& sensorsModified)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002564{
Nan Zhoufe04d492022-06-22 17:10:41 +00002565 for (const auto& chassisSensor : sensorsList)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002566 {
George Liu28aa8de2021-02-01 15:13:30 +08002567 sdbusplus::message::object_path path(chassisSensor);
Ed Tanousb00dcc22021-02-23 12:52:50 -08002568 std::string thisSensorName = path.filename();
George Liu28aa8de2021-02-01 15:13:30 +08002569 if (thisSensorName.empty())
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002570 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002571 continue;
2572 }
2573 if (thisSensorName == sensorName)
2574 {
2575 sensorsModified.emplace(chassisSensor);
2576 return true;
2577 }
2578 }
2579 return false;
2580}
2581
Ed Tanousc71d6122022-11-29 14:10:32 -08002582inline std::pair<std::string, std::string>
2583 splitSensorNameAndType(std::string_view sensorId)
2584{
2585 size_t index = sensorId.find('_');
2586 if (index == std::string::npos)
2587 {
2588 return std::make_pair<std::string, std::string>("", "");
2589 }
2590 std::string sensorType{sensorId.substr(0, index)};
2591 std::string sensorName{sensorId.substr(index + 1)};
2592 // fan_pwm and fan_tach need special handling
2593 if (sensorType == "fantach" || sensorType == "fanpwm")
2594 {
2595 sensorType.insert(3, 1, '_');
2596 }
2597 return std::make_pair(sensorType, sensorName);
2598}
2599
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002600/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302601 * @brief Entry point for overriding sensor values of given sensor
2602 *
zhanghch058d1b46d2021-04-01 11:18:24 +08002603 * @param sensorAsyncResp response object
Carol Wang4bb3dc32019-10-17 18:15:02 +08002604 * @param allCollections Collections extract from sensors' request patch info
jayaprakash Mutyala91e130a2020-03-04 22:26:38 +00002605 * @param chassisSubNode Chassis Node for which the query has to happen
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302606 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002607inline void setSensorsOverride(
Ed Tanousb5a76932020-09-29 16:16:58 -07002608 const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp,
Carol Wang4bb3dc32019-10-17 18:15:02 +08002609 std::unordered_map<std::string, std::vector<nlohmann::json>>&
jayaprakash Mutyala397fd612020-02-06 23:33:34 +00002610 allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302611{
Ed Tanous62598e32023-07-17 17:06:25 -07002612 BMCWEB_LOG_INFO("setSensorsOverride for subNode{}",
2613 sensorAsyncResp->chassisSubNode);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302614
Ed Tanous543f4402022-01-06 13:12:53 -08002615 const char* propertyValueName = nullptr;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302616 std::unordered_map<std::string, std::pair<double, std::string>> overrideMap;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302617 std::string memberId;
Ed Tanous543f4402022-01-06 13:12:53 -08002618 double value = 0.0;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302619 for (auto& collectionItems : allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302620 {
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302621 if (collectionItems.first == "Temperatures")
2622 {
2623 propertyValueName = "ReadingCelsius";
2624 }
2625 else if (collectionItems.first == "Fans")
2626 {
2627 propertyValueName = "Reading";
2628 }
2629 else
2630 {
2631 propertyValueName = "ReadingVolts";
2632 }
2633 for (auto& item : collectionItems.second)
2634 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002635 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res,
2636 "MemberId", memberId, propertyValueName,
2637 value))
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302638 {
2639 return;
2640 }
2641 overrideMap.emplace(memberId,
2642 std::make_pair(value, collectionItems.first));
2643 }
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302644 }
Carol Wang4bb3dc32019-10-17 18:15:02 +08002645
Ed Tanous002d39b2022-05-31 08:59:27 -07002646 auto getChassisSensorListCb =
2647 [sensorAsyncResp, overrideMap](
Nan Zhoufe04d492022-06-22 17:10:41 +00002648 const std::shared_ptr<std::set<std::string>>& sensorsList) {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002649 // Match sensor names in the PATCH request to those managed by the
2650 // chassis node
Nan Zhoufe04d492022-06-22 17:10:41 +00002651 const std::shared_ptr<std::set<std::string>> sensorNames =
2652 std::make_shared<std::set<std::string>>();
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302653 for (const auto& item : overrideMap)
2654 {
2655 const auto& sensor = item.first;
Ed Tanousc71d6122022-11-29 14:10:32 -08002656 std::pair<std::string, std::string> sensorNameType =
2657 splitSensorNameAndType(sensor);
2658 if (!findSensorNameUsingSensorPath(sensorNameType.second,
2659 *sensorsList, *sensorNames))
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302660 {
Ed Tanous62598e32023-07-17 17:06:25 -07002661 BMCWEB_LOG_INFO("Unable to find memberId {}", item.first);
zhanghch058d1b46d2021-04-01 11:18:24 +08002662 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302663 item.second.second, item.first);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302664 return;
2665 }
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302666 }
2667 // Get the connection to which the memberId belongs
Ed Tanous002d39b2022-05-31 08:59:27 -07002668 auto getObjectsWithConnectionCb =
Nan Zhoufe04d492022-06-22 17:10:41 +00002669 [sensorAsyncResp,
2670 overrideMap](const std::set<std::string>& /*connections*/,
2671 const std::set<std::pair<std::string, std::string>>&
2672 objectsWithConnection) {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002673 if (objectsWithConnection.size() != overrideMap.size())
2674 {
Ed Tanous62598e32023-07-17 17:06:25 -07002675 BMCWEB_LOG_INFO(
2676 "Unable to find all objects with proper connection {} requested {}",
2677 objectsWithConnection.size(), overrideMap.size());
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002678 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
2679 sensorAsyncResp->chassisSubNode ==
2680 sensors::node::thermal
2681 ? "Temperatures"
2682 : "Voltages",
2683 "Count");
2684 return;
2685 }
2686 for (const auto& item : objectsWithConnection)
2687 {
2688 sdbusplus::message::object_path path(item.first);
2689 std::string sensorName = path.filename();
2690 if (sensorName.empty())
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302691 {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002692 messages::internalError(sensorAsyncResp->asyncResp->res);
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302693 return;
2694 }
Ban Feng3f5eb752023-06-29 09:19:20 +08002695 std::string id = path.parent_path().filename();
Ed Tanous3544d2a2023-08-06 18:12:20 -07002696 auto remove = std::ranges::remove(id, '_');
2697 id.erase(std::ranges::begin(remove), id.end());
Ban Feng3f5eb752023-06-29 09:19:20 +08002698 id += "_";
2699 id += sensorName;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302700
Ban Feng3f5eb752023-06-29 09:19:20 +08002701 const auto& iterator = overrideMap.find(id);
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002702 if (iterator == overrideMap.end())
2703 {
Ed Tanous62598e32023-07-17 17:06:25 -07002704 BMCWEB_LOG_INFO("Unable to find sensor object{}",
2705 item.first);
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002706 messages::internalError(sensorAsyncResp->asyncResp->res);
2707 return;
2708 }
George Liu9ae226f2023-06-21 17:56:46 +08002709 sdbusplus::asio::setProperty(
2710 *crow::connections::systemBus, item.second, item.first,
2711 "xyz.openbmc_project.Sensor.Value", "Value",
2712 iterator->second.first,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002713 [sensorAsyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002714 if (ec)
2715 {
2716 if (ec.value() ==
2717 boost::system::errc::permission_denied)
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002718 {
Ed Tanous62598e32023-07-17 17:06:25 -07002719 BMCWEB_LOG_WARNING(
2720 "Manufacturing mode is not Enabled...can't "
2721 "Override the sensor value. ");
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002722
Ed Tanous002d39b2022-05-31 08:59:27 -07002723 messages::insufficientPrivilege(
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002724 sensorAsyncResp->asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07002725 return;
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002726 }
Ed Tanous62598e32023-07-17 17:06:25 -07002727 BMCWEB_LOG_DEBUG(
2728 "setOverrideValueStatus DBUS error: {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -07002729 messages::internalError(
2730 sensorAsyncResp->asyncResp->res);
2731 }
Patrick Williams5a39f772023-10-20 11:20:21 -05002732 });
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002733 }
2734 };
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302735 // Get object with connection for the given sensor name
2736 getObjectsWithConnection(sensorAsyncResp, sensorNames,
2737 std::move(getObjectsWithConnectionCb));
2738 };
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302739 // get full sensor list for the given chassisId and cross verify the sensor.
Ed Tanous7f1cc262022-08-09 13:33:57 -07002740 getChassis(sensorAsyncResp->asyncResp, sensorAsyncResp->chassisId,
2741 sensorAsyncResp->chassisSubNode, sensorAsyncResp->types,
2742 std::move(getChassisSensorListCb));
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302743}
2744
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002745/**
2746 * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus
2747 * path of the sensor.
2748 *
2749 * Function builds valid Redfish response for sensor query of given chassis and
2750 * node. It then builds metadata about Redfish<->D-Bus correlations and provides
2751 * it to caller in a callback.
2752 *
2753 * @param chassis Chassis for which retrieval should be performed
2754 * @param node Node (group) of sensors. See sensors::node for supported values
2755 * @param mapComplete Callback to be called with retrieval result
2756 */
Ed Tanous931edc72023-11-01 12:09:07 -07002757template <typename Callback>
Krzysztof Grobelny021d32c2021-10-29 16:00:07 +02002758inline void retrieveUriToDbusMap(const std::string& chassis,
2759 const std::string& node,
Ed Tanous931edc72023-11-01 12:09:07 -07002760 Callback&& mapComplete)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002761{
Ed Tanous02da7c52022-02-27 00:09:02 -08002762 decltype(sensors::paths)::const_iterator pathIt =
2763 std::find_if(sensors::paths.cbegin(), sensors::paths.cend(),
2764 [&node](auto&& val) { return val.first == node; });
2765 if (pathIt == sensors::paths.cend())
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002766 {
Ed Tanous62598e32023-07-17 17:06:25 -07002767 BMCWEB_LOG_ERROR("Wrong node provided : {}", node);
Ed Tanous6804b5c2023-10-31 14:50:03 -07002768 std::map<std::string, std::string> noop;
2769 mapComplete(boost::beast::http::status::bad_request, noop);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002770 return;
2771 }
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002772
Nan Zhou72374eb2022-01-27 17:06:51 -08002773 auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
Ed Tanous931edc72023-11-01 12:09:07 -07002774 auto callback = [asyncResp,
2775 mapCompleteCb{std::forward<Callback>(mapComplete)}](
Nan Zhoufe04d492022-06-22 17:10:41 +00002776 const boost::beast::http::status status,
2777 const std::map<std::string, std::string>& uriToDbus) {
2778 mapCompleteCb(status, uriToDbus);
2779 };
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002780
2781 auto resp = std::make_shared<SensorsAsyncResp>(
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002782 asyncResp, chassis, pathIt->second, node, std::move(callback));
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002783 getChassisData(resp);
2784}
2785
Nan Zhoubacb2162022-04-06 11:28:32 -07002786namespace sensors
2787{
Nan Zhou928fefb2022-03-28 08:45:00 -07002788
Nan Zhoubacb2162022-04-06 11:28:32 -07002789inline void getChassisCallback(
Ed Tanousc1d019a2022-08-06 09:36:06 -07002790 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2791 std::string_view chassisId, std::string_view chassisSubNode,
Nan Zhoufe04d492022-06-22 17:10:41 +00002792 const std::shared_ptr<std::set<std::string>>& sensorNames)
Nan Zhoubacb2162022-04-06 11:28:32 -07002793{
Ed Tanous62598e32023-07-17 17:06:25 -07002794 BMCWEB_LOG_DEBUG("getChassisCallback enter ");
Nan Zhoubacb2162022-04-06 11:28:32 -07002795
Ed Tanousc1d019a2022-08-06 09:36:06 -07002796 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
2797 for (const std::string& sensor : *sensorNames)
Nan Zhoubacb2162022-04-06 11:28:32 -07002798 {
Ed Tanous62598e32023-07-17 17:06:25 -07002799 BMCWEB_LOG_DEBUG("Adding sensor: {}", sensor);
Nan Zhoubacb2162022-04-06 11:28:32 -07002800
2801 sdbusplus::message::object_path path(sensor);
2802 std::string sensorName = path.filename();
2803 if (sensorName.empty())
2804 {
Ed Tanous62598e32023-07-17 17:06:25 -07002805 BMCWEB_LOG_ERROR("Invalid sensor path: {}", sensor);
Ed Tanousc1d019a2022-08-06 09:36:06 -07002806 messages::internalError(asyncResp->res);
Nan Zhoubacb2162022-04-06 11:28:32 -07002807 return;
2808 }
Ed Tanousc1d019a2022-08-06 09:36:06 -07002809 std::string type = path.parent_path().filename();
2810 // fan_tach has an underscore in it, so remove it to "normalize" the
2811 // type in the URI
Ed Tanous3544d2a2023-08-06 18:12:20 -07002812 auto remove = std::ranges::remove(type, '_');
2813 type.erase(std::ranges::begin(remove), type.end());
Ed Tanousc1d019a2022-08-06 09:36:06 -07002814
Ed Tanous14766872022-03-15 10:44:42 -07002815 nlohmann::json::object_t member;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002816 std::string id = type;
2817 id += "_";
2818 id += sensorName;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002819 member["@odata.id"] = boost::urls::format(
2820 "/redfish/v1/Chassis/{}/{}/{}", chassisId, chassisSubNode, id);
Ed Tanousc1d019a2022-08-06 09:36:06 -07002821
Patrick Williamsb2ba3072023-05-12 10:27:39 -05002822 entriesArray.emplace_back(std::move(member));
Nan Zhoubacb2162022-04-06 11:28:32 -07002823 }
2824
Ed Tanousc1d019a2022-08-06 09:36:06 -07002825 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
Ed Tanous62598e32023-07-17 17:06:25 -07002826 BMCWEB_LOG_DEBUG("getChassisCallback exit");
Nan Zhoubacb2162022-04-06 11:28:32 -07002827}
Nan Zhoue6bd8462022-06-01 04:35:35 +00002828
Ed Tanousac106bf2023-06-07 09:24:59 -07002829inline void handleSensorCollectionGet(
2830 App& app, const crow::Request& req,
2831 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2832 const std::string& chassisId)
Nan Zhoude167a62022-06-01 04:47:45 +00002833{
2834 query_param::QueryCapabilities capabilities = {
2835 .canDelegateExpandLevel = 1,
2836 };
2837 query_param::Query delegatedQuery;
Ed Tanousac106bf2023-06-07 09:24:59 -07002838 if (!redfish::setUpRedfishRouteWithDelegation(app, req, asyncResp,
Nan Zhoude167a62022-06-01 04:47:45 +00002839 delegatedQuery, capabilities))
2840 {
2841 return;
2842 }
2843
2844 if (delegatedQuery.expandType != query_param::ExpandType::None)
2845 {
2846 // we perform efficient expand.
Ed Tanousac106bf2023-06-07 09:24:59 -07002847 auto sensorsAsyncResp = std::make_shared<SensorsAsyncResp>(
2848 asyncResp, chassisId, sensors::dbus::sensorPaths,
Nan Zhoude167a62022-06-01 04:47:45 +00002849 sensors::node::sensors,
2850 /*efficientExpand=*/true);
Ed Tanousac106bf2023-06-07 09:24:59 -07002851 getChassisData(sensorsAsyncResp);
Nan Zhoude167a62022-06-01 04:47:45 +00002852
Ed Tanous62598e32023-07-17 17:06:25 -07002853 BMCWEB_LOG_DEBUG(
2854 "SensorCollection doGet exit via efficient expand handler");
Nan Zhoude167a62022-06-01 04:47:45 +00002855 return;
Ed Tanous0bad3202022-06-02 13:53:59 -07002856 }
Nan Zhoude167a62022-06-01 04:47:45 +00002857
Nan Zhoude167a62022-06-01 04:47:45 +00002858 // We get all sensors as hyperlinkes in the chassis (this
2859 // implies we reply on the default query parameters handler)
Ed Tanousac106bf2023-06-07 09:24:59 -07002860 getChassis(asyncResp, chassisId, sensors::node::sensors, dbus::sensorPaths,
2861 std::bind_front(sensors::getChassisCallback, asyncResp,
2862 chassisId, sensors::node::sensors));
Ed Tanousc1d019a2022-08-06 09:36:06 -07002863}
Ed Tanous7f1cc262022-08-09 13:33:57 -07002864
Ed Tanousc1d019a2022-08-06 09:36:06 -07002865inline void
2866 getSensorFromDbus(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2867 const std::string& sensorPath,
2868 const ::dbus::utility::MapperGetObject& mapperResponse)
2869{
2870 if (mapperResponse.size() != 1)
2871 {
2872 messages::internalError(asyncResp->res);
2873 return;
2874 }
2875 const auto& valueIface = *mapperResponse.begin();
2876 const std::string& connectionName = valueIface.first;
Ed Tanous62598e32023-07-17 17:06:25 -07002877 BMCWEB_LOG_DEBUG("Looking up {}", connectionName);
2878 BMCWEB_LOG_DEBUG("Path {}", sensorPath);
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +02002879
2880 sdbusplus::asio::getAllProperties(
2881 *crow::connections::systemBus, connectionName, sensorPath, "",
Ed Tanousc1d019a2022-08-06 09:36:06 -07002882 [asyncResp,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002883 sensorPath](const boost::system::error_code& ec,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002884 const ::dbus::utility::DBusPropertiesMap& valuesDict) {
2885 if (ec)
2886 {
2887 messages::internalError(asyncResp->res);
2888 return;
2889 }
2890 sdbusplus::message::object_path path(sensorPath);
2891 std::string name = path.filename();
2892 path = path.parent_path();
2893 std::string type = path.filename();
2894 objectPropertiesToJson(name, type, sensors::node::sensors, valuesDict,
2895 asyncResp->res.jsonValue, nullptr);
Patrick Williams5a39f772023-10-20 11:20:21 -05002896 });
Nan Zhoude167a62022-06-01 04:47:45 +00002897}
2898
Nan Zhoue6bd8462022-06-01 04:35:35 +00002899inline void handleSensorGet(App& app, const crow::Request& req,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002900 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous677bb752022-09-15 10:52:19 -07002901 const std::string& chassisId,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002902 const std::string& sensorId)
Nan Zhoue6bd8462022-06-01 04:35:35 +00002903{
Ed Tanousc1d019a2022-08-06 09:36:06 -07002904 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Nan Zhoue6bd8462022-06-01 04:35:35 +00002905 {
2906 return;
2907 }
Ed Tanousc71d6122022-11-29 14:10:32 -08002908 std::pair<std::string, std::string> nameType =
2909 splitSensorNameAndType(sensorId);
2910 if (nameType.first.empty() || nameType.second.empty())
Ed Tanousc1d019a2022-08-06 09:36:06 -07002911 {
2912 messages::resourceNotFound(asyncResp->res, sensorId, "Sensor");
2913 return;
2914 }
Ed Tanousc71d6122022-11-29 14:10:32 -08002915
Ed Tanousef4c65b2023-04-24 15:28:50 -07002916 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
2917 "/redfish/v1/Chassis/{}/Sensors/{}", chassisId, sensorId);
Ed Tanousc1d019a2022-08-06 09:36:06 -07002918
Ed Tanous62598e32023-07-17 17:06:25 -07002919 BMCWEB_LOG_DEBUG("Sensor doGet enter");
Nan Zhoue6bd8462022-06-01 04:35:35 +00002920
George Liu2b731192023-01-11 16:27:13 +08002921 constexpr std::array<std::string_view, 1> interfaces = {
Nan Zhoue6bd8462022-06-01 04:35:35 +00002922 "xyz.openbmc_project.Sensor.Value"};
Ed Tanousc71d6122022-11-29 14:10:32 -08002923 std::string sensorPath = "/xyz/openbmc_project/sensors/" + nameType.first +
2924 '/' + nameType.second;
Nan Zhoue6bd8462022-06-01 04:35:35 +00002925 // Get a list of all of the sensors that implement Sensor.Value
2926 // and get the path and service name associated with the sensor
George Liu2b731192023-01-11 16:27:13 +08002927 ::dbus::utility::getDbusObject(
2928 sensorPath, interfaces,
Myung Baeaec0ec32023-05-31 15:10:01 -05002929 [asyncResp, sensorId,
George Liu2b731192023-01-11 16:27:13 +08002930 sensorPath](const boost::system::error_code& ec,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002931 const ::dbus::utility::MapperGetObject& subtree) {
Ed Tanous62598e32023-07-17 17:06:25 -07002932 BMCWEB_LOG_DEBUG("respHandler1 enter");
Myung Baeaec0ec32023-05-31 15:10:01 -05002933 if (ec == boost::system::errc::io_error)
2934 {
Ed Tanous62598e32023-07-17 17:06:25 -07002935 BMCWEB_LOG_WARNING("Sensor not found from getSensorPaths");
Myung Baeaec0ec32023-05-31 15:10:01 -05002936 messages::resourceNotFound(asyncResp->res, sensorId, "Sensor");
2937 return;
2938 }
Nan Zhoue6bd8462022-06-01 04:35:35 +00002939 if (ec)
2940 {
Ed Tanousc1d019a2022-08-06 09:36:06 -07002941 messages::internalError(asyncResp->res);
Ed Tanous62598e32023-07-17 17:06:25 -07002942 BMCWEB_LOG_ERROR(
2943 "Sensor getSensorPaths resp_handler: Dbus error {}", ec);
Nan Zhoue6bd8462022-06-01 04:35:35 +00002944 return;
2945 }
Ed Tanousc1d019a2022-08-06 09:36:06 -07002946 getSensorFromDbus(asyncResp, sensorPath, subtree);
Ed Tanous62598e32023-07-17 17:06:25 -07002947 BMCWEB_LOG_DEBUG("respHandler1 exit");
Patrick Williams5a39f772023-10-20 11:20:21 -05002948 });
Nan Zhoue6bd8462022-06-01 04:35:35 +00002949}
2950
Nan Zhoubacb2162022-04-06 11:28:32 -07002951} // namespace sensors
2952
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002953inline void requestRoutesSensorCollection(App& app)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002954{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002955 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/")
Ed Tanoused398212021-06-09 17:05:54 -07002956 .privileges(redfish::privileges::getSensorCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07002957 .methods(boost::beast::http::verb::get)(
Nan Zhoude167a62022-06-01 04:47:45 +00002958 std::bind_front(sensors::handleSensorCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002959}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002960
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002961inline void requestRoutesSensor(App& app)
2962{
2963 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002964 .privileges(redfish::privileges::getSensor)
Ed Tanous002d39b2022-05-31 08:59:27 -07002965 .methods(boost::beast::http::verb::get)(
Nan Zhoue6bd8462022-06-01 04:35:35 +00002966 std::bind_front(sensors::handleSensorGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002967}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002968
Ed Tanous1abe55e2018-09-05 08:30:59 -07002969} // namespace redfish