blob: f5c4c3ba1ae8932cf8c76f47639bd9f28d07dd5d [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
George Liu7a1dbc42022-12-07 16:03:22 +080018#include "dbus_utility.hpp"
Ed Tanous0ec8b832022-03-14 14:56:47 -070019#include "generated/enums/sensor.hpp"
20
John Edward Broadbent7e860f12021-04-08 15:57:16 -070021#include <app.hpp>
Ed Tanous11ba3972022-07-11 09:50:41 -070022#include <boost/algorithm/string/classification.hpp>
Ed Tanous1d7c0052022-08-09 12:32:26 -070023#include <boost/algorithm/string/find.hpp>
24#include <boost/algorithm/string/predicate.hpp>
Ed Tanousc71d6122022-11-29 14:10:32 -080025#include <boost/algorithm/string/replace.hpp>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010026#include <boost/algorithm/string/split.hpp>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010027#include <boost/range/algorithm/replace_copy_if.hpp>
Ed Tanous1abe55e2018-09-05 08:30:59 -070028#include <dbus_singleton.hpp>
Ed Tanous168e20c2021-12-13 14:39:53 -080029#include <dbus_utility.hpp>
Ed Tanous45ca1b82022-03-25 13:07:27 -070030#include <query.hpp>
Ed Tanoused398212021-06-09 17:05:54 -070031#include <registries/privilege_registry.hpp>
Jonathan Doman1e1e5982021-06-11 09:36:17 -070032#include <sdbusplus/asio/property.hpp>
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +020033#include <sdbusplus/unpack_properties.hpp>
34#include <utils/dbus_utils.hpp>
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +053035#include <utils/json_utils.hpp>
Nan Zhou928fefb2022-03-28 08:45:00 -070036#include <utils/query_param.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050037
George Liu7a1dbc42022-12-07 16:03:22 +080038#include <array>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050039#include <cmath>
Nan Zhoufe04d492022-06-22 17:10:41 +000040#include <iterator>
41#include <map>
42#include <set>
George Liu7a1dbc42022-12-07 16:03:22 +080043#include <string_view>
Ed Tanousb5a76932020-09-29 16:16:58 -070044#include <utility>
Ed Tanousabf2add2019-01-22 16:40:12 -080045#include <variant>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010046
Ed Tanous1abe55e2018-09-05 08:30:59 -070047namespace redfish
48{
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010049
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020050namespace sensors
51{
52namespace node
53{
54static constexpr std::string_view power = "Power";
55static constexpr std::string_view sensors = "Sensors";
56static constexpr std::string_view thermal = "Thermal";
57} // namespace node
58
Ed Tanous02da7c52022-02-27 00:09:02 -080059// clang-format off
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020060namespace dbus
61{
Ed Tanouscf9e4172022-12-21 09:30:16 -080062constexpr auto powerPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080063 "/xyz/openbmc_project/sensors/voltage",
64 "/xyz/openbmc_project/sensors/power"
65});
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000066
Ed Tanouscf9e4172022-12-21 09:30:16 -080067constexpr auto sensorPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080068 "/xyz/openbmc_project/sensors/power",
69 "/xyz/openbmc_project/sensors/current",
70 "/xyz/openbmc_project/sensors/airflow",
Ed Tanous4e777662022-08-06 09:39:13 -070071 "/xyz/openbmc_project/sensors/humidity",
George Liue8204932021-02-01 14:42:49 +080072#ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
Ed Tanous02da7c52022-02-27 00:09:02 -080073 "/xyz/openbmc_project/sensors/voltage",
74 "/xyz/openbmc_project/sensors/fan_tach",
75 "/xyz/openbmc_project/sensors/temperature",
76 "/xyz/openbmc_project/sensors/fan_pwm",
77 "/xyz/openbmc_project/sensors/altitude",
78 "/xyz/openbmc_project/sensors/energy",
George Liue8204932021-02-01 14:42:49 +080079#endif
Ed Tanous02da7c52022-02-27 00:09:02 -080080 "/xyz/openbmc_project/sensors/utilization"
81});
82
Ed Tanouscf9e4172022-12-21 09:30:16 -080083constexpr auto thermalPaths = std::to_array<std::string_view>({
Ed Tanous02da7c52022-02-27 00:09:02 -080084 "/xyz/openbmc_project/sensors/fan_tach",
85 "/xyz/openbmc_project/sensors/temperature",
86 "/xyz/openbmc_project/sensors/fan_pwm"
87});
88
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000089} // namespace dbus
Ed Tanous02da7c52022-02-27 00:09:02 -080090// clang-format on
91
Ed Tanouscf9e4172022-12-21 09:30:16 -080092using sensorPair =
93 std::pair<std::string_view, std::span<const std::string_view>>;
Ed Tanous02da7c52022-02-27 00:09:02 -080094static constexpr std::array<sensorPair, 3> paths = {
Ed Tanouscf9e4172022-12-21 09:30:16 -080095 {{node::power, dbus::powerPaths},
96 {node::sensors, dbus::sensorPaths},
97 {node::thermal, dbus::thermalPaths}}};
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000098
Ed Tanous0ec8b832022-03-14 14:56:47 -070099inline sensor::ReadingType toReadingType(std::string_view sensorType)
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000100{
101 if (sensorType == "voltage")
102 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700103 return sensor::ReadingType::Voltage;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000104 }
105 if (sensorType == "power")
106 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700107 return sensor::ReadingType::Power;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000108 }
109 if (sensorType == "current")
110 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700111 return sensor::ReadingType::Current;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000112 }
113 if (sensorType == "fan_tach")
114 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700115 return sensor::ReadingType::Rotational;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000116 }
117 if (sensorType == "temperature")
118 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700119 return sensor::ReadingType::Temperature;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000120 }
121 if (sensorType == "fan_pwm" || sensorType == "utilization")
122 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700123 return sensor::ReadingType::Percent;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000124 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600125 if (sensorType == "humidity")
126 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700127 return sensor::ReadingType::Humidity;
Gunnar Mills5deabed2022-04-20 13:43:45 -0600128 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000129 if (sensorType == "altitude")
130 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700131 return sensor::ReadingType::Altitude;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000132 }
133 if (sensorType == "airflow")
134 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700135 return sensor::ReadingType::AirFlow;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000136 }
137 if (sensorType == "energy")
138 {
Ed Tanous0ec8b832022-03-14 14:56:47 -0700139 return sensor::ReadingType::EnergyJoules;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000140 }
Ed Tanous0ec8b832022-03-14 14:56:47 -0700141 return sensor::ReadingType::Invalid;
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000142}
143
Ed Tanous1d7c0052022-08-09 12:32:26 -0700144inline std::string_view toReadingUnits(std::string_view sensorType)
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000145{
146 if (sensorType == "voltage")
147 {
148 return "V";
149 }
150 if (sensorType == "power")
151 {
152 return "W";
153 }
154 if (sensorType == "current")
155 {
156 return "A";
157 }
158 if (sensorType == "fan_tach")
159 {
160 return "RPM";
161 }
162 if (sensorType == "temperature")
163 {
164 return "Cel";
165 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600166 if (sensorType == "fan_pwm" || sensorType == "utilization" ||
167 sensorType == "humidity")
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000168 {
169 return "%";
170 }
171 if (sensorType == "altitude")
172 {
173 return "m";
174 }
175 if (sensorType == "airflow")
176 {
177 return "cft_i/min";
178 }
179 if (sensorType == "energy")
180 {
181 return "J";
182 }
183 return "";
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200184}
185} // namespace sensors
186
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100187/**
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200188 * SensorsAsyncResp
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100189 * Gathers data needed for response processing after async calls are done
190 */
Ed Tanous1abe55e2018-09-05 08:30:59 -0700191class SensorsAsyncResp
192{
193 public:
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200194 using DataCompleteCb = std::function<void(
195 const boost::beast::http::status status,
Nan Zhoufe04d492022-06-22 17:10:41 +0000196 const std::map<std::string, std::string>& uriToDbus)>;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200197
198 struct SensorData
199 {
200 const std::string name;
201 std::string uri;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200202 const std::string dbusPath;
203 };
204
Ed Tanous8a592812022-06-04 09:06:59 -0700205 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
zhanghch058d1b46d2021-04-01 11:18:24 +0800206 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800207 std::span<const std::string_view> typesIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800208 std::string_view subNode) :
Ed Tanous8a592812022-06-04 09:06:59 -0700209 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700210 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
211 efficientExpand(false)
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500212 {}
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200213
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200214 // Store extra data about sensor mapping and return it in callback
Ed Tanous8a592812022-06-04 09:06:59 -0700215 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
zhanghch058d1b46d2021-04-01 11:18:24 +0800216 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800217 std::span<const std::string_view> typesIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800218 std::string_view subNode,
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200219 DataCompleteCb&& creationComplete) :
Ed Tanous8a592812022-06-04 09:06:59 -0700220 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700221 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
222 efficientExpand(false), metadata{std::vector<SensorData>()},
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200223 dataComplete{std::move(creationComplete)}
224 {}
225
Nan Zhou928fefb2022-03-28 08:45:00 -0700226 // sensor collections expand
Ed Tanous8a592812022-06-04 09:06:59 -0700227 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
Nan Zhou928fefb2022-03-28 08:45:00 -0700228 const std::string& chassisIdIn,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800229 std::span<const std::string_view> typesIn,
Ed Tanous8a592812022-06-04 09:06:59 -0700230 const std::string_view& subNode, bool efficientExpandIn) :
231 asyncResp(asyncRespIn),
Nan Zhou928fefb2022-03-28 08:45:00 -0700232 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
Ed Tanous8a592812022-06-04 09:06:59 -0700233 efficientExpand(efficientExpandIn)
Nan Zhou928fefb2022-03-28 08:45:00 -0700234 {}
235
Ed Tanous1abe55e2018-09-05 08:30:59 -0700236 ~SensorsAsyncResp()
237 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800238 if (asyncResp->res.result() ==
239 boost::beast::http::status::internal_server_error)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700240 {
241 // Reset the json object to clear out any data that made it in
242 // before the error happened todo(ed) handle error condition with
243 // proper code
zhanghch058d1b46d2021-04-01 11:18:24 +0800244 asyncResp->res.jsonValue = nlohmann::json::object();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700245 }
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200246
247 if (dataComplete && metadata)
248 {
Nan Zhoufe04d492022-06-22 17:10:41 +0000249 std::map<std::string, std::string> map;
zhanghch058d1b46d2021-04-01 11:18:24 +0800250 if (asyncResp->res.result() == boost::beast::http::status::ok)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200251 {
252 for (auto& sensor : *metadata)
253 {
Ed Tanousc1d019a2022-08-06 09:36:06 -0700254 map.emplace(sensor.uri, sensor.dbusPath);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200255 }
256 }
zhanghch058d1b46d2021-04-01 11:18:24 +0800257 dataComplete(asyncResp->res.result(), map);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200258 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700259 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100260
Ed Tanousecd6a3a2022-01-07 09:18:40 -0800261 SensorsAsyncResp(const SensorsAsyncResp&) = delete;
262 SensorsAsyncResp(SensorsAsyncResp&&) = delete;
263 SensorsAsyncResp& operator=(const SensorsAsyncResp&) = delete;
264 SensorsAsyncResp& operator=(SensorsAsyncResp&&) = delete;
265
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200266 void addMetadata(const nlohmann::json& sensorObject,
Ed Tanousc1d019a2022-08-06 09:36:06 -0700267 const std::string& dbusPath)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200268 {
269 if (metadata)
270 {
Ed Tanousc1d019a2022-08-06 09:36:06 -0700271 metadata->emplace_back(SensorData{
272 sensorObject["Name"], sensorObject["@odata.id"], dbusPath});
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200273 }
274 }
275
276 void updateUri(const std::string& name, const std::string& uri)
277 {
278 if (metadata)
279 {
280 for (auto& sensor : *metadata)
281 {
282 if (sensor.name == name)
283 {
284 sensor.uri = uri;
285 }
286 }
287 }
288 }
289
zhanghch058d1b46d2021-04-01 11:18:24 +0800290 const std::shared_ptr<bmcweb::AsyncResp> asyncResp;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200291 const std::string chassisId;
Ed Tanouscf9e4172022-12-21 09:30:16 -0800292 const std::span<const std::string_view> types;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200293 const std::string chassisSubNode;
Nan Zhou928fefb2022-03-28 08:45:00 -0700294 const bool efficientExpand;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200295
296 private:
297 std::optional<std::vector<SensorData>> metadata;
298 DataCompleteCb dataComplete;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100299};
300
301/**
Anthony Wilsond5005492019-07-31 16:34:17 -0500302 * Possible states for physical inventory leds
303 */
304enum class LedState
305{
306 OFF,
307 ON,
308 BLINK,
309 UNKNOWN
310};
311
312/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500313 * D-Bus inventory item associated with one or more sensors.
314 */
315class InventoryItem
316{
317 public:
Ed Tanous4e23a442022-06-06 09:57:26 -0700318 explicit InventoryItem(const std::string& objPath) : objectPath(objPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500319 {
320 // Set inventory item name to last node of object path
George Liu28aa8de2021-02-01 15:13:30 +0800321 sdbusplus::message::object_path path(objectPath);
322 name = path.filename();
323 if (name.empty())
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500324 {
George Liu28aa8de2021-02-01 15:13:30 +0800325 BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500326 }
327 }
328
329 std::string objectPath;
330 std::string name;
Ed Tanouse05aec52022-01-25 10:28:56 -0800331 bool isPresent = true;
332 bool isFunctional = true;
333 bool isPowerSupply = false;
334 int powerSupplyEfficiencyPercent = -1;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500335 std::string manufacturer;
336 std::string model;
337 std::string partNumber;
338 std::string serialNumber;
339 std::set<std::string> sensors;
Anthony Wilsond5005492019-07-31 16:34:17 -0500340 std::string ledObjectPath;
Ed Tanouse05aec52022-01-25 10:28:56 -0800341 LedState ledState = LedState::UNKNOWN;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500342};
343
344/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530345 * @brief Get objects with connection necessary for sensors
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200346 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100347 * @param sensorNames Sensors retrieved from chassis
348 * @param callback Callback for processing gathered connections
349 */
350template <typename Callback>
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530351void getObjectsWithConnection(
Ed Tanous81ce6092020-12-17 16:54:55 +0000352 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +0000353 const std::shared_ptr<std::set<std::string>>& sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530354 Callback&& callback)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700355{
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530356 BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700357 const std::string path = "/xyz/openbmc_project/sensors";
358 const std::array<std::string, 1> interfaces = {
359 "xyz.openbmc_project.Sensor.Value"};
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100360
Ed Tanous1abe55e2018-09-05 08:30:59 -0700361 // Response handler for parsing objects subtree
Ed Tanous002d39b2022-05-31 08:59:27 -0700362 auto respHandler =
363 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
364 sensorNames](const boost::system::error_code ec,
365 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530366 BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700367 if (ec)
368 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800369 messages::internalError(sensorsAsyncResp->asyncResp->res);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530370 BMCWEB_LOG_ERROR
371 << "getObjectsWithConnection resp_handler: Dbus error " << ec;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700372 return;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100373 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100374
Ed Tanous1abe55e2018-09-05 08:30:59 -0700375 BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees";
376
377 // Make unique list of connections only for requested sensor types and
378 // found in the chassis
Nan Zhoufe04d492022-06-22 17:10:41 +0000379 std::set<std::string> connections;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530380 std::set<std::pair<std::string, std::string>> objectsWithConnection;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700381
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700382 BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size();
383 for (const std::string& tsensor : *sensorNames)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700384 {
385 BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor;
386 }
387
388 for (const std::pair<
389 std::string,
390 std::vector<std::pair<std::string, std::vector<std::string>>>>&
391 object : subtree)
392 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700393 if (sensorNames->find(object.first) != sensorNames->end())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700394 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700395 for (const std::pair<std::string, std::vector<std::string>>&
396 objData : object.second)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700397 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700398 BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first;
399 connections.insert(objData.first);
400 objectsWithConnection.insert(
401 std::make_pair(object.first, objData.first));
Ed Tanous1abe55e2018-09-05 08:30:59 -0700402 }
403 }
404 }
405 BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections";
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530406 callback(std::move(connections), std::move(objectsWithConnection));
407 BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700408 };
Ed Tanous1abe55e2018-09-05 08:30:59 -0700409 // Make call to ObjectMapper to find all sensors objects
410 crow::connections::systemBus->async_method_call(
411 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
412 "/xyz/openbmc_project/object_mapper",
413 "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 2, interfaces);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530414 BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit";
415}
416
417/**
418 * @brief Create connections necessary for sensors
419 * @param SensorsAsyncResp Pointer to object holding response data
420 * @param sensorNames Sensors retrieved from chassis
421 * @param callback Callback for processing gathered connections
422 */
423template <typename Callback>
Nan Zhoufe04d492022-06-22 17:10:41 +0000424void getConnections(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
425 const std::shared_ptr<std::set<std::string>> sensorNames,
426 Callback&& callback)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530427{
428 auto objectsWithConnectionCb =
Nan Zhoufe04d492022-06-22 17:10:41 +0000429 [callback](const std::set<std::string>& connections,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530430 const std::set<std::pair<std::string, std::string>>&
Ed Tanous3174e4d2020-10-07 11:41:22 -0700431 /*objectsWithConnection*/) { callback(connections); };
Ed Tanous81ce6092020-12-17 16:54:55 +0000432 getObjectsWithConnection(sensorsAsyncResp, sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530433 std::move(objectsWithConnectionCb));
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100434}
435
436/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700437 * @brief Shrinks the list of sensors for processing
438 * @param SensorsAysncResp The class holding the Redfish response
439 * @param allSensors A list of all the sensors associated to the
440 * chassis element (i.e. baseboard, front panel, etc...)
441 * @param activeSensors A list that is a reduction of the incoming
442 * allSensors list. Eliminate Thermal sensors when a Power request is
443 * made, and eliminate Power sensors when a Thermal request is made.
444 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000445inline void reduceSensorList(
Ed Tanous7f1cc262022-08-09 13:33:57 -0700446 crow::Response& res, std::string_view chassisSubNode,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800447 std::span<const std::string_view> sensorTypes,
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700448 const std::vector<std::string>* allSensors,
Nan Zhoufe04d492022-06-22 17:10:41 +0000449 const std::shared_ptr<std::set<std::string>>& activeSensors)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700450{
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700451 if ((allSensors == nullptr) || (activeSensors == nullptr))
452 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700453 messages::resourceNotFound(res, chassisSubNode,
454 chassisSubNode == sensors::node::thermal
455 ? "Temperatures"
456 : "Voltages");
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700457
458 return;
459 }
460 if (allSensors->empty())
461 {
462 // Nothing to do, the activeSensors object is also empty
463 return;
464 }
465
Ed Tanous7f1cc262022-08-09 13:33:57 -0700466 for (std::string_view type : sensorTypes)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700467 {
468 for (const std::string& sensor : *allSensors)
469 {
Ed Tanous11ba3972022-07-11 09:50:41 -0700470 if (sensor.starts_with(type))
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700471 {
472 activeSensors->emplace(sensor);
473 }
474 }
475 }
476}
477
Ed Tanous7f1cc262022-08-09 13:33:57 -0700478/*
479 *Populates the top level collection for a given subnode. Populates
480 *SensorCollection, Power, or Thermal schemas.
481 *
482 * */
483inline void populateChassisNode(nlohmann::json& jsonValue,
484 std::string_view chassisSubNode)
485{
486 if (chassisSubNode == sensors::node::power)
487 {
488 jsonValue["@odata.type"] = "#Power.v1_5_2.Power";
489 }
490 else if (chassisSubNode == sensors::node::thermal)
491 {
492 jsonValue["@odata.type"] = "#Thermal.v1_4_0.Thermal";
493 jsonValue["Fans"] = nlohmann::json::array();
494 jsonValue["Temperatures"] = nlohmann::json::array();
495 }
496 else if (chassisSubNode == sensors::node::sensors)
497 {
498 jsonValue["@odata.type"] = "#SensorCollection.SensorCollection";
499 jsonValue["Description"] = "Collection of Sensors for this Chassis";
500 jsonValue["Members"] = nlohmann::json::array();
501 jsonValue["Members@odata.count"] = 0;
502 }
503
504 if (chassisSubNode != sensors::node::sensors)
505 {
506 jsonValue["Id"] = chassisSubNode;
507 }
508 jsonValue["Name"] = chassisSubNode;
509}
510
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700511/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100512 * @brief Retrieves requested chassis sensors and redundancy data from DBus .
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200513 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100514 * @param callback Callback for next step in gathered sensor processing
515 */
516template <typename Callback>
Ed Tanous7f1cc262022-08-09 13:33:57 -0700517void getChassis(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
518 std::string_view chassisId, std::string_view chassisSubNode,
Ed Tanouscf9e4172022-12-21 09:30:16 -0800519 std::span<const std::string_view> sensorTypes,
520 Callback&& callback)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700521{
522 BMCWEB_LOG_DEBUG << "getChassis enter";
George Liu7a1dbc42022-12-07 16:03:22 +0800523 constexpr std::array<std::string_view, 2> interfaces = {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700524 "xyz.openbmc_project.Inventory.Item.Board",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500525 "xyz.openbmc_project.Inventory.Item.Chassis"};
George Liu7a1dbc42022-12-07 16:03:22 +0800526
527 // Get the Chassis Collection
528 dbus::utility::getSubTreePaths(
529 "/xyz/openbmc_project/inventory", 0, interfaces,
Ed Tanous7f1cc262022-08-09 13:33:57 -0700530 [callback{std::forward<Callback>(callback)}, asyncResp,
531 chassisIdStr{std::string(chassisId)},
532 chassisSubNode{std::string(chassisSubNode)}, sensorTypes](
George Liu7a1dbc42022-12-07 16:03:22 +0800533 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -0700534 const dbus::utility::MapperGetSubTreePathsResponse& chassisPaths) {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700535 BMCWEB_LOG_DEBUG << "getChassis respHandler enter";
536 if (ec)
537 {
538 BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec;
Ed Tanous7f1cc262022-08-09 13:33:57 -0700539 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700540 return;
541 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700542 const std::string* chassisPath = nullptr;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700543 for (const std::string& chassis : chassisPaths)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700544 {
George Liu28aa8de2021-02-01 15:13:30 +0800545 sdbusplus::message::object_path path(chassis);
Ed Tanousf8fe53e2022-06-30 15:55:45 -0700546 std::string chassisName = path.filename();
George Liu28aa8de2021-02-01 15:13:30 +0800547 if (chassisName.empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700548 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700549 BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700550 continue;
551 }
Ed Tanous7f1cc262022-08-09 13:33:57 -0700552 if (chassisName == chassisIdStr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700553 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700554 chassisPath = &chassis;
555 break;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700556 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700557 }
558 if (chassisPath == nullptr)
559 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700560 messages::resourceNotFound(asyncResp->res, "Chassis", chassisIdStr);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700561 return;
562 }
Ed Tanous7f1cc262022-08-09 13:33:57 -0700563 populateChassisNode(asyncResp->res.jsonValue, chassisSubNode);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700564
Ed Tanous7f1cc262022-08-09 13:33:57 -0700565 asyncResp->res.jsonValue["@odata.id"] =
566 "/redfish/v1/Chassis/" + chassisIdStr + "/" + chassisSubNode;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500567
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500568 // Get the list of all sensors for this Chassis element
569 std::string sensorPath = *chassisPath + "/all_sensors";
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700570 sdbusplus::asio::getProperty<std::vector<std::string>>(
571 *crow::connections::systemBus, "xyz.openbmc_project.ObjectMapper",
572 sensorPath, "xyz.openbmc_project.Association", "endpoints",
Ed Tanous7f1cc262022-08-09 13:33:57 -0700573 [asyncResp, chassisSubNode, sensorTypes,
Ed Tanousf94c4ec2022-01-06 12:44:41 -0800574 callback{std::forward<const Callback>(callback)}](
Ed Tanous271584a2019-07-09 16:24:22 -0700575 const boost::system::error_code& e,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700576 const std::vector<std::string>& nodeSensorList) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700577 if (e)
578 {
579 if (e.value() != EBADR)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700580 {
Ed Tanous7f1cc262022-08-09 13:33:57 -0700581 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -0700582 return;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700583 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700584 }
Nan Zhoufe04d492022-06-22 17:10:41 +0000585 const std::shared_ptr<std::set<std::string>> culledSensorList =
586 std::make_shared<std::set<std::string>>();
Ed Tanous7f1cc262022-08-09 13:33:57 -0700587 reduceSensorList(asyncResp->res, chassisSubNode, sensorTypes,
588 &nodeSensorList, culledSensorList);
589 BMCWEB_LOG_DEBUG << "Finishing with " << culledSensorList->size();
Ed Tanous002d39b2022-05-31 08:59:27 -0700590 callback(culledSensorList);
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700591 });
George Liu7a1dbc42022-12-07 16:03:22 +0800592 });
Ed Tanous1abe55e2018-09-05 08:30:59 -0700593 BMCWEB_LOG_DEBUG << "getChassis exit";
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100594}
595
596/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500597 * @brief Returns the Redfish State value for the specified inventory item.
598 * @param inventoryItem D-Bus inventory item associated with a sensor.
599 * @return State value for inventory item.
James Feist34dd1792019-05-17 14:10:54 -0700600 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000601inline std::string getState(const InventoryItem* inventoryItem)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500602{
603 if ((inventoryItem != nullptr) && !(inventoryItem->isPresent))
604 {
605 return "Absent";
606 }
James Feist34dd1792019-05-17 14:10:54 -0700607
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500608 return "Enabled";
609}
610
611/**
612 * @brief Returns the Redfish Health value for the specified sensor.
613 * @param sensorJson Sensor JSON object.
Ed Tanous1d7c0052022-08-09 12:32:26 -0700614 * @param valuesDict Map of all sensor DBus values.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500615 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
616 * be nullptr if no associated inventory item was found.
617 * @return Health value for sensor.
618 */
Ed Tanous1d7c0052022-08-09 12:32:26 -0700619inline std::string getHealth(nlohmann::json& sensorJson,
620 const dbus::utility::DBusPropertiesMap& valuesDict,
621 const InventoryItem* inventoryItem)
James Feist34dd1792019-05-17 14:10:54 -0700622{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500623 // Get current health value (if any) in the sensor JSON object. Some JSON
624 // objects contain multiple sensors (such as PowerSupplies). We want to set
625 // the overall health to be the most severe of any of the sensors.
626 std::string currentHealth;
627 auto statusIt = sensorJson.find("Status");
628 if (statusIt != sensorJson.end())
629 {
630 auto healthIt = statusIt->find("Health");
631 if (healthIt != statusIt->end())
632 {
633 std::string* health = healthIt->get_ptr<std::string*>();
634 if (health != nullptr)
635 {
636 currentHealth = *health;
637 }
638 }
639 }
640
641 // If current health in JSON object is already Critical, return that. This
642 // should override the sensor health, which might be less severe.
643 if (currentHealth == "Critical")
644 {
645 return "Critical";
646 }
647
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200648 const bool* criticalAlarmHigh = nullptr;
649 const bool* criticalAlarmLow = nullptr;
650 const bool* warningAlarmHigh = nullptr;
651 const bool* warningAlarmLow = nullptr;
Ed Tanous711ac7a2021-12-20 09:34:41 -0800652
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200653 const bool success = sdbusplus::unpackPropertiesNoThrow(
654 dbus_utils::UnpackErrorPrinter(), valuesDict, "CriticalAlarmHigh",
655 criticalAlarmHigh, "CriticalAlarmLow", criticalAlarmLow,
656 "WarningAlarmHigh", warningAlarmHigh, "WarningAlarmLow",
657 warningAlarmLow);
658
659 if (success)
James Feist34dd1792019-05-17 14:10:54 -0700660 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200661 // Check if sensor has critical threshold alarm
662 if ((criticalAlarmHigh != nullptr && *criticalAlarmHigh) ||
663 (criticalAlarmLow != nullptr && *criticalAlarmLow))
James Feist34dd1792019-05-17 14:10:54 -0700664 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200665 return "Critical";
James Feist34dd1792019-05-17 14:10:54 -0700666 }
667 }
668
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500669 // Check if associated inventory item is not functional
670 if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional))
671 {
672 return "Critical";
673 }
674
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200675 // If current health in JSON object is already Warning, return that. This
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500676 // should override the sensor status, which might be less severe.
677 if (currentHealth == "Warning")
678 {
679 return "Warning";
680 }
681
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200682 if (success)
James Feist34dd1792019-05-17 14:10:54 -0700683 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200684 // Check if sensor has warning threshold alarm
685 if ((warningAlarmHigh != nullptr && *warningAlarmHigh) ||
686 (warningAlarmLow != nullptr && *warningAlarmLow))
James Feist34dd1792019-05-17 14:10:54 -0700687 {
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200688 return "Warning";
James Feist34dd1792019-05-17 14:10:54 -0700689 }
690 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500691
James Feist34dd1792019-05-17 14:10:54 -0700692 return "OK";
693}
694
Ed Tanous23a21a12020-07-25 04:45:05 +0000695inline void setLedState(nlohmann::json& sensorJson,
Anthony Wilsond5005492019-07-31 16:34:17 -0500696 const InventoryItem* inventoryItem)
697{
698 if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty())
699 {
700 switch (inventoryItem->ledState)
701 {
702 case LedState::OFF:
703 sensorJson["IndicatorLED"] = "Off";
704 break;
705 case LedState::ON:
706 sensorJson["IndicatorLED"] = "Lit";
707 break;
708 case LedState::BLINK:
709 sensorJson["IndicatorLED"] = "Blinking";
710 break;
Ed Tanous23a21a12020-07-25 04:45:05 +0000711 case LedState::UNKNOWN:
Anthony Wilsond5005492019-07-31 16:34:17 -0500712 break;
713 }
714 }
715}
716
James Feist34dd1792019-05-17 14:10:54 -0700717/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100718 * @brief Builds a json sensor representation of a sensor.
719 * @param sensorName The name of the sensor to be built
Gunnar Mills274fad52018-06-13 15:45:36 -0500720 * @param sensorType The type (temperature, fan_tach, etc) of the sensor to
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100721 * build
Ed Tanous1d7c0052022-08-09 12:32:26 -0700722 * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor
723 * @param propertiesDict A dictionary of the properties to build the sensor
724 * from.
725 * @param sensorJson The json object to fill
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500726 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
727 * be nullptr if no associated inventory item was found.
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100728 */
Ed Tanous1d7c0052022-08-09 12:32:26 -0700729inline void objectPropertiesToJson(
730 std::string_view sensorName, std::string_view sensorType,
731 std::string_view chassisSubNode,
732 const dbus::utility::DBusPropertiesMap& propertiesDict,
Ed Tanous81ce6092020-12-17 16:54:55 +0000733 nlohmann::json& sensorJson, InventoryItem* inventoryItem)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700734{
Ed Tanous1d7c0052022-08-09 12:32:26 -0700735 if (chassisSubNode == sensors::node::sensors)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500736 {
Ed Tanousc71d6122022-11-29 14:10:32 -0800737 std::string subNodeEscaped(sensorType);
Ed Tanousc1d019a2022-08-06 09:36:06 -0700738 subNodeEscaped.erase(
739 std::remove(subNodeEscaped.begin(), subNodeEscaped.end(), '_'),
740 subNodeEscaped.end());
741
742 // For sensors in SensorCollection we set Id instead of MemberId,
743 // including power sensors.
744 subNodeEscaped += '_';
745 subNodeEscaped += sensorName;
746 sensorJson["Id"] = std::move(subNodeEscaped);
747
Ed Tanous1d7c0052022-08-09 12:32:26 -0700748 std::string sensorNameEs(sensorName);
749 std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
750 sensorJson["Name"] = std::move(sensorNameEs);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500751 }
752 else if (sensorType != "power")
753 {
754 // Set MemberId and Name for non-power sensors. For PowerSupplies and
755 // PowerControl, those properties have more general values because
756 // multiple sensors can be stored in the same JSON object.
Ed Tanous81ce6092020-12-17 16:54:55 +0000757 sensorJson["MemberId"] = sensorName;
Ed Tanous1d7c0052022-08-09 12:32:26 -0700758 std::string sensorNameEs(sensorName);
759 std::replace(sensorNameEs.begin(), sensorNameEs.end(), '_', ' ');
760 sensorJson["Name"] = std::move(sensorNameEs);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500761 }
Ed Tanouse742b6c2019-05-03 15:06:53 -0700762
Ed Tanous81ce6092020-12-17 16:54:55 +0000763 sensorJson["Status"]["State"] = getState(inventoryItem);
764 sensorJson["Status"]["Health"] =
Ed Tanous1d7c0052022-08-09 12:32:26 -0700765 getHealth(sensorJson, propertiesDict, inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700766
767 // Parameter to set to override the type we get from dbus, and force it to
768 // int, regardless of what is available. This is used for schemas like fan,
769 // that require integers, not floats.
770 bool forceToInt = false;
771
Anthony Wilson3929aca2019-07-19 15:42:33 -0500772 nlohmann::json::json_pointer unit("/Reading");
Ed Tanous1d7c0052022-08-09 12:32:26 -0700773 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500774 {
Shounak Mitra2a4ba192022-06-01 23:34:12 +0000775 sensorJson["@odata.type"] = "#Sensor.v1_2_0.Sensor";
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000776
Ed Tanous0ec8b832022-03-14 14:56:47 -0700777 sensor::ReadingType readingType = sensors::toReadingType(sensorType);
778 if (readingType == sensor::ReadingType::Invalid)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500779 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000780 BMCWEB_LOG_ERROR << "Redfish cannot map reading type for "
781 << sensorType;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500782 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000783 else
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500784 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000785 sensorJson["ReadingType"] = readingType;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500786 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000787
Ed Tanous1d7c0052022-08-09 12:32:26 -0700788 std::string_view readingUnits = sensors::toReadingUnits(sensorType);
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000789 if (readingUnits.empty())
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200790 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000791 BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for "
792 << sensorType;
793 }
794 else
795 {
796 sensorJson["ReadingUnits"] = readingUnits;
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200797 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500798 }
799 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700800 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500801 unit = "/ReadingCelsius"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000802 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700803 // TODO(ed) Documentation says that path should be type fan_tach,
804 // implementation seems to implement fan
805 }
806 else if (sensorType == "fan" || sensorType == "fan_tach")
807 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500808 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000809 sensorJson["ReadingUnits"] = "RPM";
810 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
811 setLedState(sensorJson, inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700812 forceToInt = true;
813 }
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700814 else if (sensorType == "fan_pwm")
815 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500816 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000817 sensorJson["ReadingUnits"] = "Percent";
818 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
819 setLedState(sensorJson, inventoryItem);
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700820 forceToInt = true;
821 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700822 else if (sensorType == "voltage")
823 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500824 unit = "/ReadingVolts"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000825 sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700826 }
Ed Tanous2474adf2018-09-05 16:31:16 -0700827 else if (sensorType == "power")
828 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700829 if (boost::iequals(sensorName, "total_power"))
Eddie James028f7eb2019-05-17 21:24:36 +0000830 {
Ed Tanous81ce6092020-12-17 16:54:55 +0000831 sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl";
Gunnar Mills7ab06f42019-07-02 13:07:16 -0500832 // Put multiple "sensors" into a single PowerControl, so have
833 // generic names for MemberId and Name. Follows Redfish mockup.
Ed Tanous81ce6092020-12-17 16:54:55 +0000834 sensorJson["MemberId"] = "0";
835 sensorJson["Name"] = "Chassis Power Control";
Anthony Wilson3929aca2019-07-19 15:42:33 -0500836 unit = "/PowerConsumedWatts"_json_pointer;
Eddie James028f7eb2019-05-17 21:24:36 +0000837 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700838 else if (boost::ifind_first(sensorName, "input").empty())
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700839 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500840 unit = "/PowerInputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700841 }
842 else
843 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500844 unit = "/PowerOutputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700845 }
Ed Tanous2474adf2018-09-05 16:31:16 -0700846 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700847 else
848 {
849 BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName;
850 return;
851 }
852 // Map of dbus interface name, dbus property name and redfish property_name
Anthony Wilson3929aca2019-07-19 15:42:33 -0500853 std::vector<
854 std::tuple<const char*, const char*, nlohmann::json::json_pointer>>
855 properties;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700856 properties.reserve(7);
857
858 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600859
Ed Tanous1d7c0052022-08-09 12:32:26 -0700860 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson3929aca2019-07-19 15:42:33 -0500861 {
862 properties.emplace_back(
863 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh",
864 "/Thresholds/UpperCaution/Reading"_json_pointer);
865 properties.emplace_back(
866 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow",
867 "/Thresholds/LowerCaution/Reading"_json_pointer);
868 properties.emplace_back(
869 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh",
870 "/Thresholds/UpperCritical/Reading"_json_pointer);
871 properties.emplace_back(
872 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow",
873 "/Thresholds/LowerCritical/Reading"_json_pointer);
874 }
875 else if (sensorType != "power")
Shawn McCarneyde629b62019-03-08 10:42:51 -0600876 {
877 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500878 "WarningHigh",
879 "/UpperThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600880 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500881 "WarningLow",
882 "/LowerThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600883 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500884 "CriticalHigh",
885 "/UpperThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600886 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500887 "CriticalLow",
888 "/LowerThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600889 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700890
Ed Tanous2474adf2018-09-05 16:31:16 -0700891 // TODO Need to get UpperThresholdFatal and LowerThresholdFatal
892
Ed Tanous1d7c0052022-08-09 12:32:26 -0700893 if (chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500894 {
895 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500896 "/ReadingRangeMin"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500897 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500898 "/ReadingRangeMax"_json_pointer);
George Liu51c35a82022-10-13 20:22:14 +0800899 properties.emplace_back("xyz.openbmc_project.Sensor.Accuracy",
900 "Accuracy", "/Accuracy"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500901 }
902 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700903 {
904 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500905 "/MinReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700906 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500907 "/MaxReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700908 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500909 else if (sensorType != "power")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700910 {
911 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500912 "/MinReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700913 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -0500914 "/MaxReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700915 }
916
Anthony Wilson3929aca2019-07-19 15:42:33 -0500917 for (const std::tuple<const char*, const char*,
918 nlohmann::json::json_pointer>& p : properties)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700919 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700920 for (const auto& [valueName, valueVariant] : propertiesDict)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700921 {
Ed Tanous1d7c0052022-08-09 12:32:26 -0700922 if (valueName != std::get<1>(p))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700923 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800924 continue;
925 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700926
927 // The property we want to set may be nested json, so use
928 // a json_pointer for easy indexing into the json structure.
929 const nlohmann::json::json_pointer& key = std::get<2>(p);
930
Ed Tanous1d7c0052022-08-09 12:32:26 -0700931 const double* doubleValue = std::get_if<double>(&valueVariant);
Ed Tanous40e4f382022-08-09 18:42:51 -0700932 if (doubleValue == nullptr)
Ed Tanous711ac7a2021-12-20 09:34:41 -0800933 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700934 BMCWEB_LOG_ERROR << "Got value interface that wasn't double";
Ed Tanous1d7c0052022-08-09 12:32:26 -0700935 continue;
936 }
Ed Tanous1d7c0052022-08-09 12:32:26 -0700937 if (forceToInt)
938 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700939 sensorJson[key] = static_cast<int64_t>(*doubleValue);
Ed Tanous1d7c0052022-08-09 12:32:26 -0700940 }
941 else
942 {
Ed Tanous40e4f382022-08-09 18:42:51 -0700943 sensorJson[key] = *doubleValue;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700944 }
945 }
946 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100947}
948
Ed Tanous1d7c0052022-08-09 12:32:26 -0700949/**
950 * @brief Builds a json sensor representation of a sensor.
951 * @param sensorName The name of the sensor to be built
952 * @param sensorType The type (temperature, fan_tach, etc) of the sensor to
953 * build
954 * @param chassisSubNode The subnode (thermal, sensor, ect) of the sensor
955 * @param interfacesDict A dictionary of the interfaces and properties of said
956 * interfaces to be built from
957 * @param sensorJson The json object to fill
958 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
959 * be nullptr if no associated inventory item was found.
960 */
961inline void objectInterfacesToJson(
962 const std::string& sensorName, const std::string& sensorType,
963 const std::string& chassisSubNode,
964 const dbus::utility::DBusInteracesMap& interfacesDict,
965 nlohmann::json& sensorJson, InventoryItem* inventoryItem)
966{
967
968 for (const auto& [interface, valuesDict] : interfacesDict)
969 {
970 objectPropertiesToJson(sensorName, sensorType, chassisSubNode,
971 valuesDict, sensorJson, inventoryItem);
972 }
Ed Tanousc1d019a2022-08-06 09:36:06 -0700973 BMCWEB_LOG_DEBUG << "Added sensor " << sensorName;
Ed Tanous1d7c0052022-08-09 12:32:26 -0700974}
975
Ed Tanousb5a76932020-09-29 16:16:58 -0700976inline void populateFanRedundancy(
977 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
James Feist8bd25cc2019-03-15 15:14:00 -0700978{
979 crow::connections::systemBus->async_method_call(
Ed Tanousb9d36b42022-02-26 21:42:46 -0800980 [sensorsAsyncResp](
981 const boost::system::error_code ec,
982 const dbus::utility::MapperGetSubTreeResponse& resp) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700983 if (ec)
984 {
985 return; // don't have to have this interface
986 }
987 for (const std::pair<
988 std::string,
989 std::vector<std::pair<std::string, std::vector<std::string>>>>&
990 pathPair : resp)
991 {
992 const std::string& path = pathPair.first;
993 const std::vector<std::pair<std::string, std::vector<std::string>>>&
994 objDict = pathPair.second;
995 if (objDict.empty())
James Feist8bd25cc2019-03-15 15:14:00 -0700996 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700997 continue; // this should be impossible
James Feist8bd25cc2019-03-15 15:14:00 -0700998 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700999
1000 const std::string& owner = objDict.begin()->first;
1001 sdbusplus::asio::getProperty<std::vector<std::string>>(
1002 *crow::connections::systemBus,
1003 "xyz.openbmc_project.ObjectMapper", path + "/chassis",
1004 "xyz.openbmc_project.Association", "endpoints",
1005 [path, owner,
1006 sensorsAsyncResp](const boost::system::error_code e,
1007 const std::vector<std::string>& endpoints) {
1008 if (e)
James Feist8bd25cc2019-03-15 15:14:00 -07001009 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001010 return; // if they don't have an association we
1011 // can't tell what chassis is
James Feist8bd25cc2019-03-15 15:14:00 -07001012 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001013 auto found =
1014 std::find_if(endpoints.begin(), endpoints.end(),
1015 [sensorsAsyncResp](const std::string& entry) {
1016 return entry.find(sensorsAsyncResp->chassisId) !=
1017 std::string::npos;
1018 });
James Feist8bd25cc2019-03-15 15:14:00 -07001019
Ed Tanous002d39b2022-05-31 08:59:27 -07001020 if (found == endpoints.end())
1021 {
1022 return;
1023 }
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001024 sdbusplus::asio::getAllProperties(
1025 *crow::connections::systemBus, owner, path,
1026 "xyz.openbmc_project.Control.FanRedundancy",
Ed Tanous002d39b2022-05-31 08:59:27 -07001027 [path, sensorsAsyncResp](
1028 const boost::system::error_code& err,
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001029 const dbus::utility::DBusPropertiesMap& ret) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001030 if (err)
1031 {
1032 return; // don't have to have this
1033 // interface
1034 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001035
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001036 const uint8_t* allowedFailures = nullptr;
1037 const std::vector<std::string>* collection = nullptr;
1038 const std::string* status = nullptr;
1039
1040 const bool success = sdbusplus::unpackPropertiesNoThrow(
1041 dbus_utils::UnpackErrorPrinter(), ret,
1042 "AllowedFailures", allowedFailures, "Collection",
1043 collection, "Status", status);
1044
1045 if (!success)
1046 {
1047 messages::internalError(
1048 sensorsAsyncResp->asyncResp->res);
1049 return;
1050 }
1051
1052 if (allowedFailures == nullptr || collection == nullptr ||
1053 status == nullptr)
Ed Tanous002d39b2022-05-31 08:59:27 -07001054 {
1055 BMCWEB_LOG_ERROR << "Invalid redundancy interface";
1056 messages::internalError(
1057 sensorsAsyncResp->asyncResp->res);
1058 return;
1059 }
1060
Ed Tanous002d39b2022-05-31 08:59:27 -07001061 sdbusplus::message::object_path objectPath(path);
1062 std::string name = objectPath.filename();
1063 if (name.empty())
1064 {
1065 // this should be impossible
1066 messages::internalError(
1067 sensorsAsyncResp->asyncResp->res);
1068 return;
1069 }
1070 std::replace(name.begin(), name.end(), '_', ' ');
1071
1072 std::string health;
1073
Ed Tanous11ba3972022-07-11 09:50:41 -07001074 if (status->ends_with("Full"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001075 {
1076 health = "OK";
1077 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001078 else if (status->ends_with("Degraded"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001079 {
1080 health = "Warning";
1081 }
1082 else
1083 {
1084 health = "Critical";
1085 }
1086 nlohmann::json::array_t redfishCollection;
1087 const auto& fanRedfish =
1088 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"];
1089 for (const std::string& item : *collection)
1090 {
Ed Tanous8a592812022-06-04 09:06:59 -07001091 sdbusplus::message::object_path itemPath(item);
1092 std::string itemName = itemPath.filename();
Ed Tanous002d39b2022-05-31 08:59:27 -07001093 if (itemName.empty())
James Feist8bd25cc2019-03-15 15:14:00 -07001094 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001095 continue;
James Feist8bd25cc2019-03-15 15:14:00 -07001096 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001097 /*
1098 todo(ed): merge patch that fixes the names
1099 std::replace(itemName.begin(),
1100 itemName.end(), '_', ' ');*/
1101 auto schemaItem =
1102 std::find_if(fanRedfish.begin(), fanRedfish.end(),
1103 [itemName](const nlohmann::json& fan) {
1104 return fan["MemberId"] == itemName;
James Feist8bd25cc2019-03-15 15:14:00 -07001105 });
Ed Tanous002d39b2022-05-31 08:59:27 -07001106 if (schemaItem != fanRedfish.end())
James Feist8bd25cc2019-03-15 15:14:00 -07001107 {
Ed Tanous8a592812022-06-04 09:06:59 -07001108 nlohmann::json::object_t collectionId;
1109 collectionId["@odata.id"] =
Ed Tanous002d39b2022-05-31 08:59:27 -07001110 (*schemaItem)["@odata.id"];
1111 redfishCollection.emplace_back(
Ed Tanous8a592812022-06-04 09:06:59 -07001112 std::move(collectionId));
Ed Tanous002d39b2022-05-31 08:59:27 -07001113 }
1114 else
1115 {
1116 BMCWEB_LOG_ERROR << "failed to find fan in schema";
1117 messages::internalError(
1118 sensorsAsyncResp->asyncResp->res);
James Feist8bd25cc2019-03-15 15:14:00 -07001119 return;
1120 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001121 }
James Feist8bd25cc2019-03-15 15:14:00 -07001122
Ed Tanous002d39b2022-05-31 08:59:27 -07001123 size_t minNumNeeded =
1124 collection->empty()
1125 ? 0
1126 : collection->size() - *allowedFailures;
1127 nlohmann::json& jResp = sensorsAsyncResp->asyncResp->res
1128 .jsonValue["Redundancy"];
James Feist8bd25cc2019-03-15 15:14:00 -07001129
Ed Tanous002d39b2022-05-31 08:59:27 -07001130 nlohmann::json::object_t redundancy;
1131 redundancy["@odata.id"] =
1132 "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId +
1133 "/" + sensorsAsyncResp->chassisSubNode +
1134 "#/Redundancy/" + std::to_string(jResp.size());
1135 redundancy["@odata.type"] = "#Redundancy.v1_3_2.Redundancy";
1136 redundancy["MinNumNeeded"] = minNumNeeded;
1137 redundancy["MemberId"] = name;
1138 redundancy["Mode"] = "N+m";
1139 redundancy["Name"] = name;
1140 redundancy["RedundancySet"] = redfishCollection;
1141 redundancy["Status"]["Health"] = health;
1142 redundancy["Status"]["State"] = "Enabled";
James Feist8bd25cc2019-03-15 15:14:00 -07001143
Ed Tanous002d39b2022-05-31 08:59:27 -07001144 jResp.push_back(std::move(redundancy));
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +02001145 });
Ed Tanous002d39b2022-05-31 08:59:27 -07001146 });
1147 }
James Feist8bd25cc2019-03-15 15:14:00 -07001148 },
1149 "xyz.openbmc_project.ObjectMapper",
1150 "/xyz/openbmc_project/object_mapper",
1151 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
1152 "/xyz/openbmc_project/control", 2,
1153 std::array<const char*, 1>{
1154 "xyz.openbmc_project.Control.FanRedundancy"});
1155}
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 {
1188 *value += std::to_string(count);
1189 count++;
Ed Tanous81ce6092020-12-17 16:54:55 +00001190 sensorsAsyncResp->updateUri(sensorJson["Name"], *value);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001191 }
1192 }
1193 }
1194 }
1195}
1196
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01001197/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001198 * @brief Finds the inventory item with the specified object path.
1199 * @param inventoryItems D-Bus inventory items associated with sensors.
1200 * @param invItemObjPath D-Bus object path of inventory item.
1201 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001202 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001203inline InventoryItem* findInventoryItem(
Ed Tanousb5a76932020-09-29 16:16:58 -07001204 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001205 const std::string& invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001206{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001207 for (InventoryItem& inventoryItem : *inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001208 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001209 if (inventoryItem.objectPath == invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001210 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001211 return &inventoryItem;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001212 }
1213 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001214 return nullptr;
1215}
1216
1217/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001218 * @brief Finds the inventory item associated with the specified sensor.
1219 * @param inventoryItems D-Bus inventory items associated with sensors.
1220 * @param sensorObjPath D-Bus object path of sensor.
1221 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001222 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001223inline InventoryItem* findInventoryItemForSensor(
Ed Tanousb5a76932020-09-29 16:16:58 -07001224 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001225 const std::string& sensorObjPath)
1226{
1227 for (InventoryItem& inventoryItem : *inventoryItems)
1228 {
1229 if (inventoryItem.sensors.count(sensorObjPath) > 0)
1230 {
1231 return &inventoryItem;
1232 }
1233 }
1234 return nullptr;
1235}
1236
1237/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001238 * @brief Finds the inventory item associated with the specified led path.
1239 * @param inventoryItems D-Bus inventory items associated with sensors.
1240 * @param ledObjPath D-Bus object path of led.
1241 * @return Inventory item within vector, or nullptr if no match found.
1242 */
1243inline InventoryItem*
1244 findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems,
1245 const std::string& ledObjPath)
1246{
1247 for (InventoryItem& inventoryItem : inventoryItems)
1248 {
1249 if (inventoryItem.ledObjectPath == ledObjPath)
1250 {
1251 return &inventoryItem;
1252 }
1253 }
1254 return nullptr;
1255}
1256
1257/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001258 * @brief Adds inventory item and associated sensor to specified vector.
1259 *
1260 * Adds a new InventoryItem to the vector if necessary. Searches for an
1261 * existing InventoryItem with the specified object path. If not found, one is
1262 * added to the vector.
1263 *
1264 * Next, the specified sensor is added to the set of sensors associated with the
1265 * InventoryItem.
1266 *
1267 * @param inventoryItems D-Bus inventory items associated with sensors.
1268 * @param invItemObjPath D-Bus object path of inventory item.
1269 * @param sensorObjPath D-Bus object path of sensor
1270 */
Ed Tanousb5a76932020-09-29 16:16:58 -07001271inline void addInventoryItem(
1272 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
1273 const std::string& invItemObjPath, const std::string& sensorObjPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001274{
1275 // Look for inventory item in vector
1276 InventoryItem* inventoryItem =
1277 findInventoryItem(inventoryItems, invItemObjPath);
1278
1279 // If inventory item doesn't exist in vector, add it
1280 if (inventoryItem == nullptr)
1281 {
1282 inventoryItems->emplace_back(invItemObjPath);
1283 inventoryItem = &(inventoryItems->back());
1284 }
1285
1286 // Add sensor to set of sensors associated with inventory item
1287 inventoryItem->sensors.emplace(sensorObjPath);
1288}
1289
1290/**
1291 * @brief Stores D-Bus data in the specified inventory item.
1292 *
1293 * Finds D-Bus data in the specified map of interfaces. Stores the data in the
1294 * specified InventoryItem.
1295 *
1296 * This data is later used to provide sensor property values in the JSON
1297 * response.
1298 *
1299 * @param inventoryItem Inventory item where data will be stored.
1300 * @param interfacesDict Map containing D-Bus interfaces and their properties
1301 * for the specified inventory item.
1302 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001303inline void storeInventoryItemData(
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001304 InventoryItem& inventoryItem,
Ed Tanous711ac7a2021-12-20 09:34:41 -08001305 const dbus::utility::DBusInteracesMap& interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001306{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001307 // Get properties from Inventory.Item interface
Ed Tanous711ac7a2021-12-20 09:34:41 -08001308
Ed Tanous9eb808c2022-01-25 10:19:23 -08001309 for (const auto& [interface, values] : interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001310 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001311 if (interface == "xyz.openbmc_project.Inventory.Item")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001312 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001313 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001314 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001315 if (name == "Present")
1316 {
1317 const bool* value = std::get_if<bool>(&dbusValue);
1318 if (value != nullptr)
1319 {
1320 inventoryItem.isPresent = *value;
1321 }
1322 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001323 }
1324 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001325 // Check if Inventory.Item.PowerSupply interface is present
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001326
Ed Tanous711ac7a2021-12-20 09:34:41 -08001327 if (interface == "xyz.openbmc_project.Inventory.Item.PowerSupply")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001328 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001329 inventoryItem.isPowerSupply = true;
1330 }
1331
1332 // Get properties from Inventory.Decorator.Asset interface
1333 if (interface == "xyz.openbmc_project.Inventory.Decorator.Asset")
1334 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001335 for (const auto& [name, dbusValue] : values)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001336 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001337 if (name == "Manufacturer")
1338 {
1339 const std::string* value =
1340 std::get_if<std::string>(&dbusValue);
1341 if (value != nullptr)
1342 {
1343 inventoryItem.manufacturer = *value;
1344 }
1345 }
1346 if (name == "Model")
1347 {
1348 const std::string* value =
1349 std::get_if<std::string>(&dbusValue);
1350 if (value != nullptr)
1351 {
1352 inventoryItem.model = *value;
1353 }
1354 }
1355 if (name == "SerialNumber")
1356 {
1357 const std::string* value =
1358 std::get_if<std::string>(&dbusValue);
1359 if (value != nullptr)
1360 {
1361 inventoryItem.serialNumber = *value;
1362 }
1363 }
1364 if (name == "PartNumber")
1365 {
1366 const std::string* value =
1367 std::get_if<std::string>(&dbusValue);
1368 if (value != nullptr)
1369 {
1370 inventoryItem.partNumber = *value;
1371 }
1372 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001373 }
1374 }
1375
Ed Tanous711ac7a2021-12-20 09:34:41 -08001376 if (interface ==
1377 "xyz.openbmc_project.State.Decorator.OperationalStatus")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001378 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001379 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001380 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001381 if (name == "Functional")
1382 {
1383 const bool* value = std::get_if<bool>(&dbusValue);
1384 if (value != nullptr)
1385 {
1386 inventoryItem.isFunctional = *value;
1387 }
1388 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001389 }
1390 }
1391 }
1392}
1393
1394/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001395 * @brief Gets D-Bus data for inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001396 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001397 * Uses the specified connections (services) to obtain D-Bus data for inventory
1398 * items associated with sensors. Stores the resulting data in the
1399 * inventoryItems vector.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001400 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001401 * This data is later used to provide sensor property values in the JSON
1402 * response.
1403 *
1404 * Finds the inventory item data asynchronously. Invokes callback when data has
1405 * been obtained.
1406 *
1407 * The callback must have the following signature:
1408 * @code
Anthony Wilsond5005492019-07-31 16:34:17 -05001409 * callback(void)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001410 * @endcode
1411 *
1412 * This function is called recursively, obtaining data asynchronously from one
1413 * connection in each call. This ensures the callback is not invoked until the
1414 * last asynchronous function has completed.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001415 *
1416 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001417 * @param inventoryItems D-Bus inventory items associated with sensors.
1418 * @param invConnections Connections that provide data for the inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001419 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001420 * @param callback Callback to invoke when inventory data has been obtained.
1421 * @param invConnectionsIndex Current index in invConnections. Only specified
1422 * in recursive calls to this function.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001423 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001424template <typename Callback>
1425static void getInventoryItemsData(
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001426 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001427 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07001428 std::shared_ptr<std::set<std::string>> invConnections, Callback&& callback,
1429 size_t invConnectionsIndex = 0)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001430{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001431 BMCWEB_LOG_DEBUG << "getInventoryItemsData enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001432
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001433 // If no more connections left, call callback
1434 if (invConnectionsIndex >= invConnections->size())
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001435 {
Anthony Wilsond5005492019-07-31 16:34:17 -05001436 callback();
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001437 BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
1438 return;
1439 }
1440
1441 // Get inventory item data from current connection
Nan Zhoufe04d492022-06-22 17:10:41 +00001442 auto it = invConnections->begin();
1443 std::advance(it, invConnectionsIndex);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001444 if (it != invConnections->end())
1445 {
1446 const std::string& invConnection = *it;
1447
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001448 // Response handler for GetManagedObjects
Ed Tanousd0090732022-10-04 17:22:56 -07001449 auto respHandler = [sensorsAsyncResp, inventoryItems, invConnections,
1450 callback{std::forward<Callback>(callback)},
1451 invConnectionsIndex](
1452 const boost::system::error_code ec,
1453 const dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001454 BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001455 if (ec)
1456 {
1457 BMCWEB_LOG_ERROR
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001458 << "getInventoryItemsData respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001459 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001460 return;
1461 }
1462
1463 // Loop through returned object paths
1464 for (const auto& objDictEntry : resp)
1465 {
1466 const std::string& objPath =
1467 static_cast<const std::string&>(objDictEntry.first);
1468
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001469 // If this object path is one of the specified inventory items
1470 InventoryItem* inventoryItem =
1471 findInventoryItem(inventoryItems, objPath);
1472 if (inventoryItem != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001473 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001474 // Store inventory data in InventoryItem
1475 storeInventoryItemData(*inventoryItem, objDictEntry.second);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001476 }
1477 }
1478
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001479 // Recurse to get inventory item data from next connection
1480 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07001481 invConnections, std::move(callback),
1482 invConnectionsIndex + 1);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001483
1484 BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001485 };
1486
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001487 // Get all object paths and their interfaces for current connection
1488 crow::connections::systemBus->async_method_call(
Ed Tanousd0090732022-10-04 17:22:56 -07001489 std::move(respHandler), invConnection,
Ed Tanousf8bb0ff2022-12-09 11:08:45 -08001490 "/xyz/openbmc_project/inventory",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001491 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1492 }
1493
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001494 BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001495}
1496
1497/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001498 * @brief Gets connections that provide D-Bus data for inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001499 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001500 * Gets the D-Bus connections (services) that provide data for the inventory
1501 * items that are associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001502 *
1503 * Finds the connections asynchronously. Invokes callback when information has
1504 * been obtained.
1505 *
1506 * The callback must have the following signature:
1507 * @code
Nan Zhoufe04d492022-06-22 17:10:41 +00001508 * callback(std::shared_ptr<std::set<std::string>> invConnections)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001509 * @endcode
1510 *
1511 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001512 * @param inventoryItems D-Bus inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001513 * @param callback Callback to invoke when connections have been obtained.
1514 */
1515template <typename Callback>
1516static void getInventoryItemsConnections(
Ed Tanousb5a76932020-09-29 16:16:58 -07001517 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
1518 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001519 Callback&& callback)
1520{
1521 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter";
1522
1523 const std::string path = "/xyz/openbmc_project/inventory";
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001524 const std::array<std::string, 4> interfaces = {
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001525 "xyz.openbmc_project.Inventory.Item",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001526 "xyz.openbmc_project.Inventory.Item.PowerSupply",
1527 "xyz.openbmc_project.Inventory.Decorator.Asset",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001528 "xyz.openbmc_project.State.Decorator.OperationalStatus"};
1529
1530 // Response handler for parsing output from GetSubTree
Ed Tanous002d39b2022-05-31 08:59:27 -07001531 auto respHandler =
1532 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1533 inventoryItems](
1534 const boost::system::error_code ec,
1535 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001536 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter";
1537 if (ec)
1538 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001539 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001540 BMCWEB_LOG_ERROR
1541 << "getInventoryItemsConnections respHandler DBus error " << ec;
1542 return;
1543 }
1544
1545 // Make unique list of connections for desired inventory items
Nan Zhoufe04d492022-06-22 17:10:41 +00001546 std::shared_ptr<std::set<std::string>> invConnections =
1547 std::make_shared<std::set<std::string>>();
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001548
1549 // Loop through objects from GetSubTree
1550 for (const std::pair<
1551 std::string,
1552 std::vector<std::pair<std::string, std::vector<std::string>>>>&
1553 object : subtree)
1554 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001555 // Check if object path is one of the specified inventory items
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001556 const std::string& objPath = object.first;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001557 if (findInventoryItem(inventoryItems, objPath) != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001558 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001559 // Store all connections to inventory item
1560 for (const std::pair<std::string, std::vector<std::string>>&
1561 objData : object.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001562 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001563 const std::string& invConnection = objData.first;
1564 invConnections->insert(invConnection);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001565 }
1566 }
1567 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001568
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001569 callback(invConnections);
1570 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit";
1571 };
1572
1573 // Make call to ObjectMapper to find all inventory items
1574 crow::connections::systemBus->async_method_call(
1575 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
1576 "/xyz/openbmc_project/object_mapper",
1577 "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces);
1578 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit";
1579}
1580
1581/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001582 * @brief Gets associations from sensors to inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001583 *
1584 * Looks for ObjectMapper associations from the specified sensors to related
Anthony Wilsond5005492019-07-31 16:34:17 -05001585 * inventory items. Then finds the associations from those inventory items to
1586 * their LEDs, if any.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001587 *
1588 * Finds the inventory items asynchronously. Invokes callback when information
1589 * has been obtained.
1590 *
1591 * The callback must have the following signature:
1592 * @code
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001593 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001594 * @endcode
1595 *
1596 * @param sensorsAsyncResp Pointer to object holding response data.
1597 * @param sensorNames All sensors within the current chassis.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001598 * implements ObjectManager.
1599 * @param callback Callback to invoke when inventory items have been obtained.
1600 */
1601template <typename Callback>
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001602static void getInventoryItemAssociations(
Ed Tanousb5a76932020-09-29 16:16:58 -07001603 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +00001604 const std::shared_ptr<std::set<std::string>>& sensorNames,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001605 Callback&& callback)
1606{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001607 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001608
1609 // Response handler for GetManagedObjects
Ed Tanous02cad962022-06-30 16:50:15 -07001610 auto respHandler =
1611 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1612 sensorNames](const boost::system::error_code ec,
1613 const dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001614 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001615 if (ec)
1616 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001617 BMCWEB_LOG_ERROR
1618 << "getInventoryItemAssociations respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001619 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001620 return;
1621 }
1622
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001623 // Create vector to hold list of inventory items
1624 std::shared_ptr<std::vector<InventoryItem>> inventoryItems =
1625 std::make_shared<std::vector<InventoryItem>>();
1626
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001627 // Loop through returned object paths
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001628 std::string sensorAssocPath;
1629 sensorAssocPath.reserve(128); // avoid memory allocations
1630 for (const auto& objDictEntry : resp)
1631 {
1632 const std::string& objPath =
1633 static_cast<const std::string&>(objDictEntry.first);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001634
1635 // If path is inventory association for one of the specified sensors
1636 for (const std::string& sensorName : *sensorNames)
1637 {
1638 sensorAssocPath = sensorName;
1639 sensorAssocPath += "/inventory";
1640 if (objPath == sensorAssocPath)
1641 {
1642 // Get Association interface for object path
Ed Tanous711ac7a2021-12-20 09:34:41 -08001643 for (const auto& [interface, values] : objDictEntry.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001644 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001645 if (interface == "xyz.openbmc_project.Association")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001646 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001647 for (const auto& [valueName, value] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001648 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001649 if (valueName == "endpoints")
1650 {
1651 const std::vector<std::string>* endpoints =
1652 std::get_if<std::vector<std::string>>(
1653 &value);
1654 if ((endpoints != nullptr) &&
1655 !endpoints->empty())
1656 {
1657 // Add inventory item to vector
1658 const std::string& invItemPath =
1659 endpoints->front();
1660 addInventoryItem(inventoryItems,
1661 invItemPath,
1662 sensorName);
1663 }
1664 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001665 }
1666 }
1667 }
1668 break;
1669 }
1670 }
1671 }
1672
Anthony Wilsond5005492019-07-31 16:34:17 -05001673 // Now loop through the returned object paths again, this time to
1674 // find the leds associated with the inventory items we just found
1675 std::string inventoryAssocPath;
1676 inventoryAssocPath.reserve(128); // avoid memory allocations
1677 for (const auto& objDictEntry : resp)
1678 {
1679 const std::string& objPath =
1680 static_cast<const std::string&>(objDictEntry.first);
Anthony Wilsond5005492019-07-31 16:34:17 -05001681
1682 for (InventoryItem& inventoryItem : *inventoryItems)
1683 {
1684 inventoryAssocPath = inventoryItem.objectPath;
1685 inventoryAssocPath += "/leds";
1686 if (objPath == inventoryAssocPath)
1687 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001688 for (const auto& [interface, values] : objDictEntry.second)
Anthony Wilsond5005492019-07-31 16:34:17 -05001689 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001690 if (interface == "xyz.openbmc_project.Association")
Anthony Wilsond5005492019-07-31 16:34:17 -05001691 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001692 for (const auto& [valueName, value] : values)
Anthony Wilsond5005492019-07-31 16:34:17 -05001693 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001694 if (valueName == "endpoints")
1695 {
1696 const std::vector<std::string>* endpoints =
1697 std::get_if<std::vector<std::string>>(
1698 &value);
1699 if ((endpoints != nullptr) &&
1700 !endpoints->empty())
1701 {
1702 // Add inventory item to vector
1703 // Store LED path in inventory item
1704 const std::string& ledPath =
1705 endpoints->front();
1706 inventoryItem.ledObjectPath = ledPath;
1707 }
1708 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001709 }
1710 }
1711 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001712
Anthony Wilsond5005492019-07-31 16:34:17 -05001713 break;
1714 }
1715 }
1716 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001717 callback(inventoryItems);
1718 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001719 };
1720
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001721 // Call GetManagedObjects on the ObjectMapper to get all associations
1722 crow::connections::systemBus->async_method_call(
Ed Tanousd0090732022-10-04 17:22:56 -07001723 std::move(respHandler), "xyz.openbmc_project.ObjectMapper", "/",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001724 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1725
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001726 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001727}
1728
1729/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001730 * @brief Gets D-Bus data for inventory item leds associated with sensors.
1731 *
1732 * Uses the specified connections (services) to obtain D-Bus data for inventory
1733 * item leds associated with sensors. Stores the resulting data in the
1734 * inventoryItems vector.
1735 *
1736 * This data is later used to provide sensor property values in the JSON
1737 * response.
1738 *
1739 * Finds the inventory item led data asynchronously. Invokes callback when data
1740 * has been obtained.
1741 *
1742 * The callback must have the following signature:
1743 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05001744 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05001745 * @endcode
1746 *
1747 * This function is called recursively, obtaining data asynchronously from one
1748 * connection in each call. This ensures the callback is not invoked until the
1749 * last asynchronous function has completed.
1750 *
1751 * @param sensorsAsyncResp Pointer to object holding response data.
1752 * @param inventoryItems D-Bus inventory items associated with sensors.
1753 * @param ledConnections Connections that provide data for the inventory leds.
1754 * @param callback Callback to invoke when inventory data has been obtained.
1755 * @param ledConnectionsIndex Current index in ledConnections. Only specified
1756 * in recursive calls to this function.
1757 */
1758template <typename Callback>
1759void getInventoryLedData(
1760 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1761 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Nan Zhoufe04d492022-06-22 17:10:41 +00001762 std::shared_ptr<std::map<std::string, std::string>> ledConnections,
Anthony Wilsond5005492019-07-31 16:34:17 -05001763 Callback&& callback, size_t ledConnectionsIndex = 0)
1764{
1765 BMCWEB_LOG_DEBUG << "getInventoryLedData enter";
1766
1767 // If no more connections left, call callback
1768 if (ledConnectionsIndex >= ledConnections->size())
1769 {
Gunnar Mills42cbe532019-08-15 15:26:54 -05001770 callback();
Anthony Wilsond5005492019-07-31 16:34:17 -05001771 BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
1772 return;
1773 }
1774
1775 // Get inventory item data from current connection
Nan Zhoufe04d492022-06-22 17:10:41 +00001776 auto it = ledConnections->begin();
1777 std::advance(it, ledConnectionsIndex);
Anthony Wilsond5005492019-07-31 16:34:17 -05001778 if (it != ledConnections->end())
1779 {
1780 const std::string& ledPath = (*it).first;
1781 const std::string& ledConnection = (*it).second;
1782 // Response handler for Get State property
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001783 auto respHandler =
1784 [sensorsAsyncResp, inventoryItems, ledConnections, ledPath,
Ed Tanousf94c4ec2022-01-06 12:44:41 -08001785 callback{std::forward<Callback>(callback)}, ledConnectionsIndex](
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001786 const boost::system::error_code ec, const std::string& state) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001787 BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter";
1788 if (ec)
1789 {
1790 BMCWEB_LOG_ERROR
1791 << "getInventoryLedData respHandler DBus error " << ec;
1792 messages::internalError(sensorsAsyncResp->asyncResp->res);
1793 return;
1794 }
1795
1796 BMCWEB_LOG_DEBUG << "Led state: " << state;
1797 // Find inventory item with this LED object path
1798 InventoryItem* inventoryItem =
1799 findInventoryItemForLed(*inventoryItems, ledPath);
1800 if (inventoryItem != nullptr)
1801 {
1802 // Store LED state in InventoryItem
Ed Tanous11ba3972022-07-11 09:50:41 -07001803 if (state.ends_with("On"))
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001804 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001805 inventoryItem->ledState = LedState::ON;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001806 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001807 else if (state.ends_with("Blink"))
Anthony Wilsond5005492019-07-31 16:34:17 -05001808 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001809 inventoryItem->ledState = LedState::BLINK;
Anthony Wilsond5005492019-07-31 16:34:17 -05001810 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001811 else if (state.ends_with("Off"))
Ed Tanous002d39b2022-05-31 08:59:27 -07001812 {
1813 inventoryItem->ledState = LedState::OFF;
1814 }
1815 else
1816 {
1817 inventoryItem->ledState = LedState::UNKNOWN;
1818 }
1819 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001820
Ed Tanous002d39b2022-05-31 08:59:27 -07001821 // Recurse to get LED data from next connection
1822 getInventoryLedData(sensorsAsyncResp, inventoryItems,
1823 ledConnections, std::move(callback),
1824 ledConnectionsIndex + 1);
Anthony Wilsond5005492019-07-31 16:34:17 -05001825
Ed Tanous002d39b2022-05-31 08:59:27 -07001826 BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit";
1827 };
Anthony Wilsond5005492019-07-31 16:34:17 -05001828
1829 // Get the State property for the current LED
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001830 sdbusplus::asio::getProperty<std::string>(
1831 *crow::connections::systemBus, ledConnection, ledPath,
1832 "xyz.openbmc_project.Led.Physical", "State",
1833 std::move(respHandler));
Anthony Wilsond5005492019-07-31 16:34:17 -05001834 }
1835
1836 BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
1837}
1838
1839/**
1840 * @brief Gets LED data for LEDs associated with given inventory items.
1841 *
1842 * Gets the D-Bus connections (services) that provide LED data for the LEDs
1843 * associated with the specified inventory items. Then gets the LED data from
1844 * each connection and stores it in the inventory item.
1845 *
1846 * This data is later used to provide sensor property values in the JSON
1847 * response.
1848 *
1849 * Finds the LED data asynchronously. Invokes callback when information has
1850 * been obtained.
1851 *
1852 * The callback must have the following signature:
1853 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05001854 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05001855 * @endcode
1856 *
1857 * @param sensorsAsyncResp Pointer to object holding response data.
1858 * @param inventoryItems D-Bus inventory items associated with sensors.
1859 * @param callback Callback to invoke when inventory items have been obtained.
1860 */
1861template <typename Callback>
1862void getInventoryLeds(
1863 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1864 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1865 Callback&& callback)
1866{
1867 BMCWEB_LOG_DEBUG << "getInventoryLeds enter";
1868
1869 const std::string path = "/xyz/openbmc_project";
1870 const std::array<std::string, 1> interfaces = {
1871 "xyz.openbmc_project.Led.Physical"};
1872
1873 // Response handler for parsing output from GetSubTree
Ed Tanous002d39b2022-05-31 08:59:27 -07001874 auto respHandler =
1875 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
1876 inventoryItems](
1877 const boost::system::error_code ec,
1878 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Anthony Wilsond5005492019-07-31 16:34:17 -05001879 BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter";
1880 if (ec)
1881 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001882 messages::internalError(sensorsAsyncResp->asyncResp->res);
Anthony Wilsond5005492019-07-31 16:34:17 -05001883 BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error "
1884 << ec;
1885 return;
1886 }
1887
1888 // Build map of LED object paths to connections
Nan Zhoufe04d492022-06-22 17:10:41 +00001889 std::shared_ptr<std::map<std::string, std::string>> ledConnections =
1890 std::make_shared<std::map<std::string, std::string>>();
Anthony Wilsond5005492019-07-31 16:34:17 -05001891
1892 // Loop through objects from GetSubTree
1893 for (const std::pair<
1894 std::string,
1895 std::vector<std::pair<std::string, std::vector<std::string>>>>&
1896 object : subtree)
1897 {
1898 // Check if object path is LED for one of the specified inventory
1899 // items
1900 const std::string& ledPath = object.first;
1901 if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr)
1902 {
1903 // Add mapping from ledPath to connection
1904 const std::string& connection = object.second.begin()->first;
1905 (*ledConnections)[ledPath] = connection;
1906 BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> "
1907 << connection;
1908 }
1909 }
1910
1911 getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections,
1912 std::move(callback));
1913 BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit";
1914 };
1915 // Make call to ObjectMapper to find all inventory items
1916 crow::connections::systemBus->async_method_call(
1917 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
1918 "/xyz/openbmc_project/object_mapper",
1919 "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces);
1920 BMCWEB_LOG_DEBUG << "getInventoryLeds exit";
1921}
1922
1923/**
Gunnar Mills42cbe532019-08-15 15:26:54 -05001924 * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent
1925 *
1926 * Uses the specified connections (services) (currently assumes just one) to
1927 * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in
1928 * the inventoryItems vector. Only stores data in Power Supply inventoryItems.
1929 *
1930 * This data is later used to provide sensor property values in the JSON
1931 * response.
1932 *
1933 * Finds the Power Supply Attributes data asynchronously. Invokes callback
1934 * when data has been obtained.
1935 *
1936 * The callback must have the following signature:
1937 * @code
1938 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
1939 * @endcode
1940 *
1941 * @param sensorsAsyncResp Pointer to object holding response data.
1942 * @param inventoryItems D-Bus inventory items associated with sensors.
1943 * @param psAttributesConnections Connections that provide data for the Power
1944 * Supply Attributes
1945 * @param callback Callback to invoke when data has been obtained.
1946 */
1947template <typename Callback>
1948void getPowerSupplyAttributesData(
Ed Tanousb5a76932020-09-29 16:16:58 -07001949 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Gunnar Mills42cbe532019-08-15 15:26:54 -05001950 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Nan Zhoufe04d492022-06-22 17:10:41 +00001951 const std::map<std::string, std::string>& psAttributesConnections,
Gunnar Mills42cbe532019-08-15 15:26:54 -05001952 Callback&& callback)
1953{
1954 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter";
1955
1956 if (psAttributesConnections.empty())
1957 {
1958 BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!";
1959 callback(inventoryItems);
1960 return;
1961 }
1962
1963 // Assuming just one connection (service) for now
Nan Zhoufe04d492022-06-22 17:10:41 +00001964 auto it = psAttributesConnections.begin();
Gunnar Mills42cbe532019-08-15 15:26:54 -05001965
1966 const std::string& psAttributesPath = (*it).first;
1967 const std::string& psAttributesConnection = (*it).second;
1968
1969 // Response handler for Get DeratingFactor property
Ed Tanous002d39b2022-05-31 08:59:27 -07001970 auto respHandler =
1971 [sensorsAsyncResp, inventoryItems,
1972 callback{std::forward<Callback>(callback)}](
1973 const boost::system::error_code ec, const uint32_t value) {
Gunnar Mills42cbe532019-08-15 15:26:54 -05001974 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter";
1975 if (ec)
1976 {
1977 BMCWEB_LOG_ERROR
1978 << "getPowerSupplyAttributesData respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001979 messages::internalError(sensorsAsyncResp->asyncResp->res);
Gunnar Mills42cbe532019-08-15 15:26:54 -05001980 return;
1981 }
1982
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001983 BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << value;
1984 // Store value in Power Supply Inventory Items
1985 for (InventoryItem& inventoryItem : *inventoryItems)
Gunnar Mills42cbe532019-08-15 15:26:54 -05001986 {
Ed Tanous55f79e62022-01-25 11:26:16 -08001987 if (inventoryItem.isPowerSupply)
Gunnar Mills42cbe532019-08-15 15:26:54 -05001988 {
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001989 inventoryItem.powerSupplyEfficiencyPercent =
1990 static_cast<int>(value);
Gunnar Mills42cbe532019-08-15 15:26:54 -05001991 }
1992 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05001993
1994 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit";
1995 callback(inventoryItems);
1996 };
1997
1998 // Get the DeratingFactor property for the PowerSupplyAttributes
1999 // Currently only property on the interface/only one we care about
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002000 sdbusplus::asio::getProperty<uint32_t>(
2001 *crow::connections::systemBus, psAttributesConnection, psAttributesPath,
2002 "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor",
2003 std::move(respHandler));
Gunnar Mills42cbe532019-08-15 15:26:54 -05002004
2005 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit";
2006}
2007
2008/**
2009 * @brief Gets the Power Supply Attributes such as EfficiencyPercent
2010 *
2011 * Gets the D-Bus connection (service) that provides Power Supply Attributes
2012 * data. Then gets the Power Supply Attributes data from the connection
2013 * (currently just assumes 1 connection) and stores the data in the inventory
2014 * item.
2015 *
2016 * This data is later used to provide sensor property values in the JSON
2017 * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish.
2018 *
2019 * Finds the Power Supply Attributes data asynchronously. Invokes callback
2020 * when information has been obtained.
2021 *
2022 * The callback must have the following signature:
2023 * @code
2024 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2025 * @endcode
2026 *
2027 * @param sensorsAsyncResp Pointer to object holding response data.
2028 * @param inventoryItems D-Bus inventory items associated with sensors.
2029 * @param callback Callback to invoke when data has been obtained.
2030 */
2031template <typename Callback>
2032void getPowerSupplyAttributes(
2033 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2034 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
2035 Callback&& callback)
2036{
2037 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter";
2038
2039 // Only need the power supply attributes when the Power Schema
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002040 if (sensorsAsyncResp->chassisSubNode != sensors::node::power)
Gunnar Mills42cbe532019-08-15 15:26:54 -05002041 {
2042 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power";
2043 callback(inventoryItems);
2044 return;
2045 }
2046
2047 const std::array<std::string, 1> interfaces = {
2048 "xyz.openbmc_project.Control.PowerSupplyAttributes"};
2049
2050 // Response handler for parsing output from GetSubTree
Ed Tanousb9d36b42022-02-26 21:42:46 -08002051 auto respHandler =
2052 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
2053 inventoryItems](
2054 const boost::system::error_code ec,
2055 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002056 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter";
2057 if (ec)
2058 {
2059 messages::internalError(sensorsAsyncResp->asyncResp->res);
2060 BMCWEB_LOG_ERROR
2061 << "getPowerSupplyAttributes respHandler DBus error " << ec;
2062 return;
2063 }
2064 if (subtree.empty())
2065 {
2066 BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!";
2067 callback(inventoryItems);
2068 return;
2069 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002070
Ed Tanous002d39b2022-05-31 08:59:27 -07002071 // Currently we only support 1 power supply attribute, use this for
2072 // all the power supplies. Build map of object path to connection.
2073 // Assume just 1 connection and 1 path for now.
Nan Zhoufe04d492022-06-22 17:10:41 +00002074 std::map<std::string, std::string> psAttributesConnections;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002075
Ed Tanous002d39b2022-05-31 08:59:27 -07002076 if (subtree[0].first.empty() || subtree[0].second.empty())
2077 {
2078 BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
2079 callback(inventoryItems);
2080 return;
2081 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002082
Ed Tanous002d39b2022-05-31 08:59:27 -07002083 const std::string& psAttributesPath = subtree[0].first;
2084 const std::string& connection = subtree[0].second.begin()->first;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002085
Ed Tanous002d39b2022-05-31 08:59:27 -07002086 if (connection.empty())
2087 {
2088 BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
2089 callback(inventoryItems);
2090 return;
2091 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002092
Ed Tanous002d39b2022-05-31 08:59:27 -07002093 psAttributesConnections[psAttributesPath] = connection;
2094 BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> "
2095 << connection;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002096
Ed Tanous002d39b2022-05-31 08:59:27 -07002097 getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems,
2098 psAttributesConnections,
2099 std::move(callback));
2100 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit";
2101 };
Gunnar Mills42cbe532019-08-15 15:26:54 -05002102 // Make call to ObjectMapper to find the PowerSupplyAttributes service
2103 crow::connections::systemBus->async_method_call(
2104 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
2105 "/xyz/openbmc_project/object_mapper",
2106 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
2107 "/xyz/openbmc_project", 0, interfaces);
2108 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit";
2109}
2110
2111/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002112 * @brief Gets inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002113 *
2114 * Finds the inventory items that are associated with the specified sensors.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002115 * Then gets D-Bus data for the inventory items, such as presence and VPD.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002116 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002117 * This data is later used to provide sensor property values in the JSON
2118 * response.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002119 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002120 * Finds the inventory items asynchronously. Invokes callback when the
2121 * inventory items have been obtained.
2122 *
2123 * The callback must have the following signature:
2124 * @code
2125 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2126 * @endcode
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002127 *
2128 * @param sensorsAsyncResp Pointer to object holding response data.
2129 * @param sensorNames All sensors within the current chassis.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002130 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002131 * @param callback Callback to invoke when inventory items have been obtained.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002132 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002133template <typename Callback>
Ed Tanousd0090732022-10-04 17:22:56 -07002134static void
2135 getInventoryItems(std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2136 const std::shared_ptr<std::set<std::string>> sensorNames,
2137 Callback&& callback)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002138{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002139 BMCWEB_LOG_DEBUG << "getInventoryItems enter";
2140 auto getInventoryItemAssociationsCb =
Ed Tanousd0090732022-10-04 17:22:56 -07002141 [sensorsAsyncResp, callback{std::forward<Callback>(callback)}](
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002142 std::shared_ptr<std::vector<InventoryItem>> inventoryItems) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002143 BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter";
2144 auto getInventoryItemsConnectionsCb =
Ed Tanousd0090732022-10-04 17:22:56 -07002145 [sensorsAsyncResp, inventoryItems,
Ed Tanous002d39b2022-05-31 08:59:27 -07002146 callback{std::forward<const Callback>(callback)}](
Nan Zhoufe04d492022-06-22 17:10:41 +00002147 std::shared_ptr<std::set<std::string>> invConnections) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002148 BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter";
2149 auto getInventoryItemsDataCb = [sensorsAsyncResp, inventoryItems,
2150 callback{std::move(callback)}]() {
2151 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter";
Gunnar Mills42cbe532019-08-15 15:26:54 -05002152
Ed Tanous002d39b2022-05-31 08:59:27 -07002153 auto getInventoryLedsCb = [sensorsAsyncResp, inventoryItems,
2154 callback{std::move(callback)}]() {
2155 BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter";
2156 // Find Power Supply Attributes and get the data
2157 getPowerSupplyAttributes(sensorsAsyncResp, inventoryItems,
2158 std::move(callback));
2159 BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002160 };
2161
Ed Tanous002d39b2022-05-31 08:59:27 -07002162 // Find led connections and get the data
2163 getInventoryLeds(sensorsAsyncResp, inventoryItems,
2164 std::move(getInventoryLedsCb));
2165 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit";
2166 };
2167
2168 // Get inventory item data from connections
2169 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
Ed Tanousd0090732022-10-04 17:22:56 -07002170 invConnections,
Ed Tanous002d39b2022-05-31 08:59:27 -07002171 std::move(getInventoryItemsDataCb));
2172 BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002173 };
2174
Ed Tanous002d39b2022-05-31 08:59:27 -07002175 // Get connections that provide inventory item data
2176 getInventoryItemsConnections(sensorsAsyncResp, inventoryItems,
2177 std::move(getInventoryItemsConnectionsCb));
2178 BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit";
2179 };
2180
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002181 // Get associations from sensors to inventory items
Ed Tanousd0090732022-10-04 17:22:56 -07002182 getInventoryItemAssociations(sensorsAsyncResp, sensorNames,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002183 std::move(getInventoryItemAssociationsCb));
2184 BMCWEB_LOG_DEBUG << "getInventoryItems exit";
2185}
2186
2187/**
2188 * @brief Returns JSON PowerSupply object for the specified inventory item.
2189 *
2190 * Searches for a JSON PowerSupply object that matches the specified inventory
2191 * item. If one is not found, a new PowerSupply object is added to the JSON
2192 * array.
2193 *
2194 * Multiple sensors are often associated with one power supply inventory item.
2195 * As a result, multiple sensor values are stored in one JSON PowerSupply
2196 * object.
2197 *
2198 * @param powerSupplyArray JSON array containing Redfish PowerSupply objects.
2199 * @param inventoryItem Inventory item for the power supply.
2200 * @param chassisId Chassis that contains the power supply.
2201 * @return JSON PowerSupply object for the specified inventory item.
2202 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002203inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002204 const InventoryItem& inventoryItem,
2205 const std::string& chassisId)
2206{
2207 // Check if matching PowerSupply object already exists in JSON array
2208 for (nlohmann::json& powerSupply : powerSupplyArray)
2209 {
2210 if (powerSupply["MemberId"] == inventoryItem.name)
2211 {
2212 return powerSupply;
2213 }
2214 }
2215
2216 // Add new PowerSupply object to JSON array
2217 powerSupplyArray.push_back({});
2218 nlohmann::json& powerSupply = powerSupplyArray.back();
2219 powerSupply["@odata.id"] =
2220 "/redfish/v1/Chassis/" + chassisId + "/Power#/PowerSupplies/";
2221 powerSupply["MemberId"] = inventoryItem.name;
2222 powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " ");
2223 powerSupply["Manufacturer"] = inventoryItem.manufacturer;
2224 powerSupply["Model"] = inventoryItem.model;
2225 powerSupply["PartNumber"] = inventoryItem.partNumber;
2226 powerSupply["SerialNumber"] = inventoryItem.serialNumber;
Anthony Wilsond5005492019-07-31 16:34:17 -05002227 setLedState(powerSupply, &inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002228
Gunnar Mills42cbe532019-08-15 15:26:54 -05002229 if (inventoryItem.powerSupplyEfficiencyPercent >= 0)
2230 {
2231 powerSupply["EfficiencyPercent"] =
2232 inventoryItem.powerSupplyEfficiencyPercent;
2233 }
2234
2235 powerSupply["Status"]["State"] = getState(&inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002236 const char* health = inventoryItem.isFunctional ? "OK" : "Critical";
2237 powerSupply["Status"]["Health"] = health;
2238
2239 return powerSupply;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002240}
2241
2242/**
Shawn McCarneyde629b62019-03-08 10:42:51 -06002243 * @brief Gets the values of the specified sensors.
2244 *
2245 * Stores the results as JSON in the SensorsAsyncResp.
2246 *
2247 * Gets the sensor values asynchronously. Stores the results later when the
2248 * information has been obtained.
2249 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002250 * The sensorNames set contains all requested sensors for the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002251 *
2252 * To minimize the number of DBus calls, the DBus method
2253 * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the
2254 * values of all sensors provided by a connection (service).
2255 *
2256 * The connections set contains all the connections that provide sensor values.
2257 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002258 * The InventoryItem vector contains D-Bus inventory items associated with the
2259 * sensors. Inventory item data is needed for some Redfish sensor properties.
2260 *
Shawn McCarneyde629b62019-03-08 10:42:51 -06002261 * @param SensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002262 * @param sensorNames All requested sensors within the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002263 * @param connections Connections that provide sensor values.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002264 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002265 * @param inventoryItems Inventory items associated with the sensors.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002266 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002267inline void getSensorData(
Ed Tanous81ce6092020-12-17 16:54:55 +00002268 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Nan Zhoufe04d492022-06-22 17:10:41 +00002269 const std::shared_ptr<std::set<std::string>>& sensorNames,
2270 const std::set<std::string>& connections,
Ed Tanousb5a76932020-09-29 16:16:58 -07002271 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002272{
2273 BMCWEB_LOG_DEBUG << "getSensorData enter";
2274 // Get managed objects from all services exposing sensors
2275 for (const std::string& connection : connections)
2276 {
2277 // Response handler to process managed objects
Ed Tanous002d39b2022-05-31 08:59:27 -07002278 auto getManagedObjectsCb =
2279 [sensorsAsyncResp, sensorNames,
2280 inventoryItems](const boost::system::error_code ec,
Ed Tanous02cad962022-06-30 16:50:15 -07002281 const dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyde629b62019-03-08 10:42:51 -06002282 BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter";
2283 if (ec)
2284 {
2285 BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08002286 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002287 return;
2288 }
2289 // Go through all objects and update response with sensor data
2290 for (const auto& objDictEntry : resp)
2291 {
2292 const std::string& objPath =
2293 static_cast<const std::string&>(objDictEntry.first);
2294 BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object "
2295 << objPath;
2296
Shawn McCarneyde629b62019-03-08 10:42:51 -06002297 std::vector<std::string> split;
2298 // Reserve space for
2299 // /xyz/openbmc_project/sensors/<name>/<subname>
2300 split.reserve(6);
2301 boost::algorithm::split(split, objPath, boost::is_any_of("/"));
2302 if (split.size() < 6)
2303 {
2304 BMCWEB_LOG_ERROR << "Got path that isn't long enough "
2305 << objPath;
2306 continue;
2307 }
2308 // These indexes aren't intuitive, as boost::split puts an empty
2309 // string at the beginning
2310 const std::string& sensorType = split[4];
2311 const std::string& sensorName = split[5];
2312 BMCWEB_LOG_DEBUG << "sensorName " << sensorName
2313 << " sensorType " << sensorType;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002314 if (sensorNames->find(objPath) == sensorNames->end())
Shawn McCarneyde629b62019-03-08 10:42:51 -06002315 {
Andrew Geissleraccdbb22021-11-09 15:24:45 -06002316 BMCWEB_LOG_DEBUG << sensorName << " not in sensor list ";
Shawn McCarneyde629b62019-03-08 10:42:51 -06002317 continue;
2318 }
2319
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002320 // Find inventory item (if any) associated with sensor
2321 InventoryItem* inventoryItem =
2322 findInventoryItemForSensor(inventoryItems, objPath);
2323
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002324 const std::string& sensorSchema =
Ed Tanous81ce6092020-12-17 16:54:55 +00002325 sensorsAsyncResp->chassisSubNode;
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002326
2327 nlohmann::json* sensorJson = nullptr;
2328
Nan Zhou928fefb2022-03-28 08:45:00 -07002329 if (sensorSchema == sensors::node::sensors &&
2330 !sensorsAsyncResp->efficientExpand)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002331 {
Ed Tanousc1d019a2022-08-06 09:36:06 -07002332 std::string sensorTypeEscaped(sensorType);
2333 sensorTypeEscaped.erase(
2334 std::remove(sensorTypeEscaped.begin(),
2335 sensorTypeEscaped.end(), '_'),
2336 sensorTypeEscaped.end());
2337 std::string sensorId(sensorTypeEscaped);
2338 sensorId += "_";
2339 sensorId += sensorName;
2340
zhanghch058d1b46d2021-04-01 11:18:24 +08002341 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] =
Ed Tanousc1d019a2022-08-06 09:36:06 -07002342 crow::utility::urlFromPieces(
2343 "redfish", "v1", "Chassis",
2344 sensorsAsyncResp->chassisId,
2345 sensorsAsyncResp->chassisSubNode, sensorId);
zhanghch058d1b46d2021-04-01 11:18:24 +08002346 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002347 }
2348 else
2349 {
Ed Tanous271584a2019-07-09 16:24:22 -07002350 std::string fieldName;
Nan Zhou928fefb2022-03-28 08:45:00 -07002351 if (sensorsAsyncResp->efficientExpand)
2352 {
2353 fieldName = "Members";
2354 }
2355 else if (sensorType == "temperature")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002356 {
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002357 fieldName = "Temperatures";
2358 }
2359 else if (sensorType == "fan" || sensorType == "fan_tach" ||
2360 sensorType == "fan_pwm")
2361 {
2362 fieldName = "Fans";
2363 }
2364 else if (sensorType == "voltage")
2365 {
2366 fieldName = "Voltages";
2367 }
2368 else if (sensorType == "power")
2369 {
Ed Tanous55f79e62022-01-25 11:26:16 -08002370 if (sensorName == "total_power")
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002371 {
2372 fieldName = "PowerControl";
2373 }
2374 else if ((inventoryItem != nullptr) &&
2375 (inventoryItem->isPowerSupply))
2376 {
2377 fieldName = "PowerSupplies";
2378 }
2379 else
2380 {
2381 // Other power sensors are in SensorCollection
2382 continue;
2383 }
2384 }
2385 else
2386 {
2387 BMCWEB_LOG_ERROR << "Unsure how to handle sensorType "
2388 << sensorType;
2389 continue;
2390 }
2391
2392 nlohmann::json& tempArray =
zhanghch058d1b46d2021-04-01 11:18:24 +08002393 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName];
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002394 if (fieldName == "PowerControl")
2395 {
2396 if (tempArray.empty())
2397 {
2398 // Put multiple "sensors" into a single
2399 // PowerControl. Follows MemberId naming and
2400 // naming in power.hpp.
Ed Tanous14766872022-03-15 10:44:42 -07002401 nlohmann::json::object_t power;
2402 power["@odata.id"] =
2403 "/redfish/v1/Chassis/" +
2404 sensorsAsyncResp->chassisId + "/" +
2405 sensorsAsyncResp->chassisSubNode + "#/" +
2406 fieldName + "/0";
2407 tempArray.push_back(std::move(power));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002408 }
2409 sensorJson = &(tempArray.back());
2410 }
2411 else if (fieldName == "PowerSupplies")
2412 {
2413 if (inventoryItem != nullptr)
2414 {
2415 sensorJson =
2416 &(getPowerSupply(tempArray, *inventoryItem,
Ed Tanous81ce6092020-12-17 16:54:55 +00002417 sensorsAsyncResp->chassisId));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002418 }
2419 }
Nan Zhou928fefb2022-03-28 08:45:00 -07002420 else if (fieldName == "Members")
2421 {
Ed Tanous677bb752022-09-15 10:52:19 -07002422 std::string sensorTypeEscaped(sensorType);
2423 sensorTypeEscaped.erase(
2424 std::remove(sensorTypeEscaped.begin(),
2425 sensorTypeEscaped.end(), '_'),
2426 sensorTypeEscaped.end());
2427 std::string sensorId(sensorTypeEscaped);
2428 sensorId += "_";
2429 sensorId += sensorName;
2430
Ed Tanous14766872022-03-15 10:44:42 -07002431 nlohmann::json::object_t member;
Ed Tanous677bb752022-09-15 10:52:19 -07002432 member["@odata.id"] = crow::utility::urlFromPieces(
2433 "redfish", "v1", "Chassis",
2434 sensorsAsyncResp->chassisId,
2435 sensorsAsyncResp->chassisSubNode, sensorId);
Ed Tanous14766872022-03-15 10:44:42 -07002436 tempArray.push_back(std::move(member));
Nan Zhou928fefb2022-03-28 08:45:00 -07002437 sensorJson = &(tempArray.back());
2438 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002439 else
2440 {
Ed Tanous14766872022-03-15 10:44:42 -07002441 nlohmann::json::object_t member;
2442 member["@odata.id"] = "/redfish/v1/Chassis/" +
2443 sensorsAsyncResp->chassisId +
2444 "/" +
2445 sensorsAsyncResp->chassisSubNode +
2446 "#/" + fieldName + "/";
2447 tempArray.push_back(std::move(member));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002448 sensorJson = &(tempArray.back());
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002449 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002450 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002451
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002452 if (sensorJson != nullptr)
2453 {
Ed Tanous1d7c0052022-08-09 12:32:26 -07002454 objectInterfacesToJson(sensorName, sensorType,
2455 sensorsAsyncResp->chassisSubNode,
2456 objDictEntry.second, *sensorJson,
2457 inventoryItem);
2458
2459 std::string path = "/xyz/openbmc_project/sensors/";
2460 path += sensorType;
2461 path += "/";
2462 path += sensorName;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002463 sensorsAsyncResp->addMetadata(*sensorJson, path);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002464 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002465 }
Ed Tanous81ce6092020-12-17 16:54:55 +00002466 if (sensorsAsyncResp.use_count() == 1)
James Feist8bd25cc2019-03-15 15:14:00 -07002467 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002468 sortJSONResponse(sensorsAsyncResp);
Nan Zhou928fefb2022-03-28 08:45:00 -07002469 if (sensorsAsyncResp->chassisSubNode ==
2470 sensors::node::sensors &&
2471 sensorsAsyncResp->efficientExpand)
2472 {
2473 sensorsAsyncResp->asyncResp->res
2474 .jsonValue["Members@odata.count"] =
2475 sensorsAsyncResp->asyncResp->res.jsonValue["Members"]
2476 .size();
2477 }
2478 else if (sensorsAsyncResp->chassisSubNode ==
2479 sensors::node::thermal)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002480 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002481 populateFanRedundancy(sensorsAsyncResp);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002482 }
James Feist8bd25cc2019-03-15 15:14:00 -07002483 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002484 BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit";
2485 };
2486
Shawn McCarneyde629b62019-03-08 10:42:51 -06002487 crow::connections::systemBus->async_method_call(
Ed Tanousd0090732022-10-04 17:22:56 -07002488 getManagedObjectsCb, connection, "/xyz/openbmc_project/sensors",
Shawn McCarneyde629b62019-03-08 10:42:51 -06002489 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
Ed Tanous23a21a12020-07-25 04:45:05 +00002490 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002491 BMCWEB_LOG_DEBUG << "getSensorData exit";
2492}
2493
Nan Zhoufe04d492022-06-22 17:10:41 +00002494inline void
2495 processSensorList(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
2496 const std::shared_ptr<std::set<std::string>>& sensorNames)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002497{
Nan Zhoufe04d492022-06-22 17:10:41 +00002498 auto getConnectionCb = [sensorsAsyncResp, sensorNames](
2499 const std::set<std::string>& connections) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002500 BMCWEB_LOG_DEBUG << "getConnectionCb enter";
Ed Tanousd0090732022-10-04 17:22:56 -07002501 auto getInventoryItemsCb =
2502 [sensorsAsyncResp, sensorNames,
2503 connections](const std::shared_ptr<std::vector<InventoryItem>>&
2504 inventoryItems) {
2505 BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter";
2506 // Get sensor data and store results in JSON
2507 getSensorData(sensorsAsyncResp, sensorNames, connections,
2508 inventoryItems);
2509 BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit";
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002510 };
2511
Ed Tanousd0090732022-10-04 17:22:56 -07002512 // Get inventory items associated with sensors
2513 getInventoryItems(sensorsAsyncResp, sensorNames,
2514 std::move(getInventoryItemsCb));
2515
Ed Tanous002d39b2022-05-31 08:59:27 -07002516 BMCWEB_LOG_DEBUG << "getConnectionCb exit";
2517 };
2518
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002519 // Get set of connections that provide sensor values
Ed Tanous81ce6092020-12-17 16:54:55 +00002520 getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002521}
2522
Shawn McCarneyde629b62019-03-08 10:42:51 -06002523/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002524 * @brief Entry point for retrieving sensors data related to requested
2525 * chassis.
Kowalski, Kamil588c3f02018-04-03 14:55:27 +02002526 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002527 */
Ed Tanousb5a76932020-09-29 16:16:58 -07002528inline void
Ed Tanous81ce6092020-12-17 16:54:55 +00002529 getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
Ed Tanous1abe55e2018-09-05 08:30:59 -07002530{
2531 BMCWEB_LOG_DEBUG << "getChassisData enter";
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002532 auto getChassisCb =
Ed Tanous81ce6092020-12-17 16:54:55 +00002533 [sensorsAsyncResp](
Nan Zhoufe04d492022-06-22 17:10:41 +00002534 const std::shared_ptr<std::set<std::string>>& sensorNames) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002535 BMCWEB_LOG_DEBUG << "getChassisCb enter";
2536 processSensorList(sensorsAsyncResp, sensorNames);
2537 BMCWEB_LOG_DEBUG << "getChassisCb exit";
2538 };
Nan Zhou928fefb2022-03-28 08:45:00 -07002539 // SensorCollection doesn't contain the Redundancy property
2540 if (sensorsAsyncResp->chassisSubNode != sensors::node::sensors)
2541 {
2542 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] =
2543 nlohmann::json::array();
2544 }
Shawn McCarney26f03892019-05-03 13:20:24 -05002545 // Get set of sensors in chassis
Ed Tanous7f1cc262022-08-09 13:33:57 -07002546 getChassis(sensorsAsyncResp->asyncResp, sensorsAsyncResp->chassisId,
2547 sensorsAsyncResp->chassisSubNode, sensorsAsyncResp->types,
2548 std::move(getChassisCb));
Ed Tanous1abe55e2018-09-05 08:30:59 -07002549 BMCWEB_LOG_DEBUG << "getChassisData exit";
Ed Tanous271584a2019-07-09 16:24:22 -07002550}
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002551
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302552/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002553 * @brief Find the requested sensorName in the list of all sensors supplied by
2554 * the chassis node
2555 *
2556 * @param sensorName The sensor name supplied in the PATCH request
2557 * @param sensorsList The list of sensors managed by the chassis node
2558 * @param sensorsModified The list of sensors that were found as a result of
2559 * repeated calls to this function
2560 */
Nan Zhoufe04d492022-06-22 17:10:41 +00002561inline bool
2562 findSensorNameUsingSensorPath(std::string_view sensorName,
Ed Tanous02cad962022-06-30 16:50:15 -07002563 const std::set<std::string>& sensorsList,
Nan Zhoufe04d492022-06-22 17:10:41 +00002564 std::set<std::string>& sensorsModified)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002565{
Nan Zhoufe04d492022-06-22 17:10:41 +00002566 for (const auto& chassisSensor : sensorsList)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002567 {
George Liu28aa8de2021-02-01 15:13:30 +08002568 sdbusplus::message::object_path path(chassisSensor);
Ed Tanousb00dcc22021-02-23 12:52:50 -08002569 std::string thisSensorName = path.filename();
George Liu28aa8de2021-02-01 15:13:30 +08002570 if (thisSensorName.empty())
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002571 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002572 continue;
2573 }
2574 if (thisSensorName == sensorName)
2575 {
2576 sensorsModified.emplace(chassisSensor);
2577 return true;
2578 }
2579 }
2580 return false;
2581}
2582
Ed Tanousc71d6122022-11-29 14:10:32 -08002583inline std::pair<std::string, std::string>
2584 splitSensorNameAndType(std::string_view sensorId)
2585{
2586 size_t index = sensorId.find('_');
2587 if (index == std::string::npos)
2588 {
2589 return std::make_pair<std::string, std::string>("", "");
2590 }
2591 std::string sensorType{sensorId.substr(0, index)};
2592 std::string sensorName{sensorId.substr(index + 1)};
2593 // fan_pwm and fan_tach need special handling
2594 if (sensorType == "fantach" || sensorType == "fanpwm")
2595 {
2596 sensorType.insert(3, 1, '_');
2597 }
2598 return std::make_pair(sensorType, sensorName);
2599}
2600
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002601/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302602 * @brief Entry point for overriding sensor values of given sensor
2603 *
zhanghch058d1b46d2021-04-01 11:18:24 +08002604 * @param sensorAsyncResp response object
Carol Wang4bb3dc32019-10-17 18:15:02 +08002605 * @param allCollections Collections extract from sensors' request patch info
jayaprakash Mutyala91e130a2020-03-04 22:26:38 +00002606 * @param chassisSubNode Chassis Node for which the query has to happen
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302607 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002608inline void setSensorsOverride(
Ed Tanousb5a76932020-09-29 16:16:58 -07002609 const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp,
Carol Wang4bb3dc32019-10-17 18:15:02 +08002610 std::unordered_map<std::string, std::vector<nlohmann::json>>&
jayaprakash Mutyala397fd612020-02-06 23:33:34 +00002611 allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302612{
jayaprakash Mutyala70d1d0a2020-01-21 23:41:36 +00002613 BMCWEB_LOG_INFO << "setSensorsOverride for subNode"
Carol Wang4bb3dc32019-10-17 18:15:02 +08002614 << sensorAsyncResp->chassisSubNode << "\n";
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302615
Ed Tanous543f4402022-01-06 13:12:53 -08002616 const char* propertyValueName = nullptr;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302617 std::unordered_map<std::string, std::pair<double, std::string>> overrideMap;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302618 std::string memberId;
Ed Tanous543f4402022-01-06 13:12:53 -08002619 double value = 0.0;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302620 for (auto& collectionItems : allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302621 {
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302622 if (collectionItems.first == "Temperatures")
2623 {
2624 propertyValueName = "ReadingCelsius";
2625 }
2626 else if (collectionItems.first == "Fans")
2627 {
2628 propertyValueName = "Reading";
2629 }
2630 else
2631 {
2632 propertyValueName = "ReadingVolts";
2633 }
2634 for (auto& item : collectionItems.second)
2635 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002636 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res,
2637 "MemberId", memberId, propertyValueName,
2638 value))
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302639 {
2640 return;
2641 }
2642 overrideMap.emplace(memberId,
2643 std::make_pair(value, collectionItems.first));
2644 }
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302645 }
Carol Wang4bb3dc32019-10-17 18:15:02 +08002646
Ed Tanous002d39b2022-05-31 08:59:27 -07002647 auto getChassisSensorListCb =
2648 [sensorAsyncResp, overrideMap](
Nan Zhoufe04d492022-06-22 17:10:41 +00002649 const std::shared_ptr<std::set<std::string>>& sensorsList) {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002650 // Match sensor names in the PATCH request to those managed by the
2651 // chassis node
Nan Zhoufe04d492022-06-22 17:10:41 +00002652 const std::shared_ptr<std::set<std::string>> sensorNames =
2653 std::make_shared<std::set<std::string>>();
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302654 for (const auto& item : overrideMap)
2655 {
2656 const auto& sensor = item.first;
Ed Tanousc71d6122022-11-29 14:10:32 -08002657 std::pair<std::string, std::string> sensorNameType =
2658 splitSensorNameAndType(sensor);
2659 if (!findSensorNameUsingSensorPath(sensorNameType.second,
2660 *sensorsList, *sensorNames))
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302661 {
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302662 BMCWEB_LOG_INFO << "Unable to find memberId " << item.first;
zhanghch058d1b46d2021-04-01 11:18:24 +08002663 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302664 item.second.second, item.first);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302665 return;
2666 }
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302667 }
2668 // Get the connection to which the memberId belongs
Ed Tanous002d39b2022-05-31 08:59:27 -07002669 auto getObjectsWithConnectionCb =
Nan Zhoufe04d492022-06-22 17:10:41 +00002670 [sensorAsyncResp,
2671 overrideMap](const std::set<std::string>& /*connections*/,
2672 const std::set<std::pair<std::string, std::string>>&
2673 objectsWithConnection) {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002674 if (objectsWithConnection.size() != overrideMap.size())
2675 {
2676 BMCWEB_LOG_INFO
2677 << "Unable to find all objects with proper connection "
2678 << objectsWithConnection.size() << " requested "
2679 << overrideMap.size() << "\n";
2680 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
2681 sensorAsyncResp->chassisSubNode ==
2682 sensors::node::thermal
2683 ? "Temperatures"
2684 : "Voltages",
2685 "Count");
2686 return;
2687 }
2688 for (const auto& item : objectsWithConnection)
2689 {
2690 sdbusplus::message::object_path path(item.first);
2691 std::string sensorName = path.filename();
2692 if (sensorName.empty())
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302693 {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002694 messages::internalError(sensorAsyncResp->asyncResp->res);
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302695 return;
2696 }
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302697
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002698 const auto& iterator = overrideMap.find(sensorName);
2699 if (iterator == overrideMap.end())
2700 {
2701 BMCWEB_LOG_INFO << "Unable to find sensor object"
2702 << item.first << "\n";
2703 messages::internalError(sensorAsyncResp->asyncResp->res);
2704 return;
2705 }
2706 crow::connections::systemBus->async_method_call(
2707 [sensorAsyncResp](const boost::system::error_code ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002708 if (ec)
2709 {
2710 if (ec.value() ==
2711 boost::system::errc::permission_denied)
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002712 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002713 BMCWEB_LOG_WARNING
2714 << "Manufacturing mode is not Enabled...can't "
2715 "Override the sensor value. ";
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002716
Ed Tanous002d39b2022-05-31 08:59:27 -07002717 messages::insufficientPrivilege(
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002718 sensorAsyncResp->asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07002719 return;
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002720 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002721 BMCWEB_LOG_DEBUG
2722 << "setOverrideValueStatus DBUS error: " << ec;
2723 messages::internalError(
2724 sensorAsyncResp->asyncResp->res);
2725 }
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002726 },
2727 item.second, item.first, "org.freedesktop.DBus.Properties",
2728 "Set", "xyz.openbmc_project.Sensor.Value", "Value",
Ed Tanous168e20c2021-12-13 14:39:53 -08002729 dbus::utility::DbusVariantType(iterator->second.first));
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002730 }
2731 };
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302732 // Get object with connection for the given sensor name
2733 getObjectsWithConnection(sensorAsyncResp, sensorNames,
2734 std::move(getObjectsWithConnectionCb));
2735 };
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302736 // get full sensor list for the given chassisId and cross verify the sensor.
Ed Tanous7f1cc262022-08-09 13:33:57 -07002737 getChassis(sensorAsyncResp->asyncResp, sensorAsyncResp->chassisId,
2738 sensorAsyncResp->chassisSubNode, sensorAsyncResp->types,
2739 std::move(getChassisSensorListCb));
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302740}
2741
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002742/**
2743 * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus
2744 * path of the sensor.
2745 *
2746 * Function builds valid Redfish response for sensor query of given chassis and
2747 * node. It then builds metadata about Redfish<->D-Bus correlations and provides
2748 * it to caller in a callback.
2749 *
2750 * @param chassis Chassis for which retrieval should be performed
2751 * @param node Node (group) of sensors. See sensors::node for supported values
2752 * @param mapComplete Callback to be called with retrieval result
2753 */
Krzysztof Grobelny021d32c2021-10-29 16:00:07 +02002754inline void retrieveUriToDbusMap(const std::string& chassis,
2755 const std::string& node,
2756 SensorsAsyncResp::DataCompleteCb&& mapComplete)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002757{
Ed Tanous02da7c52022-02-27 00:09:02 -08002758 decltype(sensors::paths)::const_iterator pathIt =
2759 std::find_if(sensors::paths.cbegin(), sensors::paths.cend(),
2760 [&node](auto&& val) { return val.first == node; });
2761 if (pathIt == sensors::paths.cend())
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002762 {
2763 BMCWEB_LOG_ERROR << "Wrong node provided : " << node;
2764 mapComplete(boost::beast::http::status::bad_request, {});
2765 return;
2766 }
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002767
Nan Zhou72374eb2022-01-27 17:06:51 -08002768 auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
Nan Zhoufe04d492022-06-22 17:10:41 +00002769 auto callback = [asyncResp, mapCompleteCb{std::move(mapComplete)}](
2770 const boost::beast::http::status status,
2771 const std::map<std::string, std::string>& uriToDbus) {
2772 mapCompleteCb(status, uriToDbus);
2773 };
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002774
2775 auto resp = std::make_shared<SensorsAsyncResp>(
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002776 asyncResp, chassis, pathIt->second, node, std::move(callback));
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002777 getChassisData(resp);
2778}
2779
Nan Zhoubacb2162022-04-06 11:28:32 -07002780namespace sensors
2781{
Nan Zhou928fefb2022-03-28 08:45:00 -07002782
Nan Zhoubacb2162022-04-06 11:28:32 -07002783inline void getChassisCallback(
Ed Tanousc1d019a2022-08-06 09:36:06 -07002784 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2785 std::string_view chassisId, std::string_view chassisSubNode,
Nan Zhoufe04d492022-06-22 17:10:41 +00002786 const std::shared_ptr<std::set<std::string>>& sensorNames)
Nan Zhoubacb2162022-04-06 11:28:32 -07002787{
Ed Tanousc1d019a2022-08-06 09:36:06 -07002788 BMCWEB_LOG_DEBUG << "getChassisCallback enter ";
Nan Zhoubacb2162022-04-06 11:28:32 -07002789
Ed Tanousc1d019a2022-08-06 09:36:06 -07002790 nlohmann::json& entriesArray = asyncResp->res.jsonValue["Members"];
2791 for (const std::string& sensor : *sensorNames)
Nan Zhoubacb2162022-04-06 11:28:32 -07002792 {
2793 BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor;
2794
2795 sdbusplus::message::object_path path(sensor);
2796 std::string sensorName = path.filename();
2797 if (sensorName.empty())
2798 {
2799 BMCWEB_LOG_ERROR << "Invalid sensor path: " << sensor;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002800 messages::internalError(asyncResp->res);
Nan Zhoubacb2162022-04-06 11:28:32 -07002801 return;
2802 }
Ed Tanousc1d019a2022-08-06 09:36:06 -07002803 std::string type = path.parent_path().filename();
2804 // fan_tach has an underscore in it, so remove it to "normalize" the
2805 // type in the URI
2806 type.erase(std::remove(type.begin(), type.end(), '_'), type.end());
2807
Ed Tanous14766872022-03-15 10:44:42 -07002808 nlohmann::json::object_t member;
Ed Tanousc1d019a2022-08-06 09:36:06 -07002809 std::string id = type;
2810 id += "_";
2811 id += sensorName;
2812 member["@odata.id"] = crow::utility::urlFromPieces(
2813 "redfish", "v1", "Chassis", chassisId, chassisSubNode, id);
2814
Ed Tanous14766872022-03-15 10:44:42 -07002815 entriesArray.push_back(std::move(member));
Nan Zhoubacb2162022-04-06 11:28:32 -07002816 }
2817
Ed Tanousc1d019a2022-08-06 09:36:06 -07002818 asyncResp->res.jsonValue["Members@odata.count"] = entriesArray.size();
Nan Zhoubacb2162022-04-06 11:28:32 -07002819 BMCWEB_LOG_DEBUG << "getChassisCallback exit";
2820}
Nan Zhoue6bd8462022-06-01 04:35:35 +00002821
Nan Zhoude167a62022-06-01 04:47:45 +00002822inline void
2823 handleSensorCollectionGet(App& app, const crow::Request& req,
2824 const std::shared_ptr<bmcweb::AsyncResp>& aResp,
2825 const std::string& chassisId)
2826{
2827 query_param::QueryCapabilities capabilities = {
2828 .canDelegateExpandLevel = 1,
2829 };
2830 query_param::Query delegatedQuery;
Carson Labrado3ba00072022-06-06 19:40:56 +00002831 if (!redfish::setUpRedfishRouteWithDelegation(app, req, aResp,
Nan Zhoude167a62022-06-01 04:47:45 +00002832 delegatedQuery, capabilities))
2833 {
2834 return;
2835 }
2836
2837 if (delegatedQuery.expandType != query_param::ExpandType::None)
2838 {
2839 // we perform efficient expand.
2840 auto asyncResp = std::make_shared<SensorsAsyncResp>(
2841 aResp, chassisId, sensors::dbus::sensorPaths,
2842 sensors::node::sensors,
2843 /*efficientExpand=*/true);
2844 getChassisData(asyncResp);
2845
2846 BMCWEB_LOG_DEBUG
2847 << "SensorCollection doGet exit via efficient expand handler";
2848 return;
Ed Tanous0bad3202022-06-02 13:53:59 -07002849 }
Nan Zhoude167a62022-06-01 04:47:45 +00002850
Nan Zhoude167a62022-06-01 04:47:45 +00002851 // We get all sensors as hyperlinkes in the chassis (this
2852 // implies we reply on the default query parameters handler)
Ed Tanousc1d019a2022-08-06 09:36:06 -07002853 getChassis(aResp, chassisId, sensors::node::sensors, dbus::sensorPaths,
2854 std::bind_front(sensors::getChassisCallback, aResp, chassisId,
2855 sensors::node::sensors));
2856}
Ed Tanous7f1cc262022-08-09 13:33:57 -07002857
Ed Tanousc1d019a2022-08-06 09:36:06 -07002858inline void
2859 getSensorFromDbus(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2860 const std::string& sensorPath,
2861 const ::dbus::utility::MapperGetObject& mapperResponse)
2862{
2863 if (mapperResponse.size() != 1)
2864 {
2865 messages::internalError(asyncResp->res);
2866 return;
2867 }
2868 const auto& valueIface = *mapperResponse.begin();
2869 const std::string& connectionName = valueIface.first;
2870 BMCWEB_LOG_DEBUG << "Looking up " << connectionName;
2871 BMCWEB_LOG_DEBUG << "Path " << sensorPath;
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +02002872
2873 sdbusplus::asio::getAllProperties(
2874 *crow::connections::systemBus, connectionName, sensorPath, "",
Ed Tanousc1d019a2022-08-06 09:36:06 -07002875 [asyncResp,
2876 sensorPath](const boost::system::error_code ec,
2877 const ::dbus::utility::DBusPropertiesMap& valuesDict) {
2878 if (ec)
2879 {
2880 messages::internalError(asyncResp->res);
2881 return;
2882 }
2883 sdbusplus::message::object_path path(sensorPath);
2884 std::string name = path.filename();
2885 path = path.parent_path();
2886 std::string type = path.filename();
2887 objectPropertiesToJson(name, type, sensors::node::sensors, valuesDict,
2888 asyncResp->res.jsonValue, nullptr);
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +02002889 });
Nan Zhoude167a62022-06-01 04:47:45 +00002890}
2891
Nan Zhoue6bd8462022-06-01 04:35:35 +00002892inline void handleSensorGet(App& app, const crow::Request& req,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002893 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous677bb752022-09-15 10:52:19 -07002894 const std::string& chassisId,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002895 const std::string& sensorId)
Nan Zhoue6bd8462022-06-01 04:35:35 +00002896{
Ed Tanousc1d019a2022-08-06 09:36:06 -07002897 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Nan Zhoue6bd8462022-06-01 04:35:35 +00002898 {
2899 return;
2900 }
Ed Tanousc71d6122022-11-29 14:10:32 -08002901 std::pair<std::string, std::string> nameType =
2902 splitSensorNameAndType(sensorId);
2903 if (nameType.first.empty() || nameType.second.empty())
Ed Tanousc1d019a2022-08-06 09:36:06 -07002904 {
2905 messages::resourceNotFound(asyncResp->res, sensorId, "Sensor");
2906 return;
2907 }
Ed Tanousc71d6122022-11-29 14:10:32 -08002908
Ed Tanous677bb752022-09-15 10:52:19 -07002909 asyncResp->res.jsonValue["@odata.id"] = crow::utility::urlFromPieces(
2910 "redfish", "v1", "Chassis", chassisId, "Sensors", sensorId);
Ed Tanousc1d019a2022-08-06 09:36:06 -07002911
Nan Zhoue6bd8462022-06-01 04:35:35 +00002912 BMCWEB_LOG_DEBUG << "Sensor doGet enter";
Nan Zhoue6bd8462022-06-01 04:35:35 +00002913
2914 const std::array<const char*, 1> interfaces = {
2915 "xyz.openbmc_project.Sensor.Value"};
Ed Tanousc71d6122022-11-29 14:10:32 -08002916 std::string sensorPath = "/xyz/openbmc_project/sensors/" + nameType.first +
2917 '/' + nameType.second;
Nan Zhoue6bd8462022-06-01 04:35:35 +00002918 // Get a list of all of the sensors that implement Sensor.Value
2919 // and get the path and service name associated with the sensor
2920 crow::connections::systemBus->async_method_call(
Ed Tanousc71d6122022-11-29 14:10:32 -08002921 [asyncResp,
2922 sensorPath](const boost::system::error_code ec,
Ed Tanousc1d019a2022-08-06 09:36:06 -07002923 const ::dbus::utility::MapperGetObject& subtree) {
Nan Zhoue6bd8462022-06-01 04:35:35 +00002924 BMCWEB_LOG_DEBUG << "respHandler1 enter";
2925 if (ec)
2926 {
Ed Tanousc1d019a2022-08-06 09:36:06 -07002927 messages::internalError(asyncResp->res);
Nan Zhoue6bd8462022-06-01 04:35:35 +00002928 BMCWEB_LOG_ERROR << "Sensor getSensorPaths resp_handler: "
2929 << "Dbus error " << ec;
2930 return;
2931 }
Ed Tanousc1d019a2022-08-06 09:36:06 -07002932 getSensorFromDbus(asyncResp, sensorPath, subtree);
Nan Zhoue6bd8462022-06-01 04:35:35 +00002933 BMCWEB_LOG_DEBUG << "respHandler1 exit";
2934 },
2935 "xyz.openbmc_project.ObjectMapper",
2936 "/xyz/openbmc_project/object_mapper",
Ed Tanousc1d019a2022-08-06 09:36:06 -07002937 "xyz.openbmc_project.ObjectMapper", "GetObject", sensorPath,
2938 interfaces);
Nan Zhoue6bd8462022-06-01 04:35:35 +00002939}
2940
Nan Zhoubacb2162022-04-06 11:28:32 -07002941} // namespace sensors
2942
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002943inline void requestRoutesSensorCollection(App& app)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002944{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002945 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/")
Ed Tanoused398212021-06-09 17:05:54 -07002946 .privileges(redfish::privileges::getSensorCollection)
Ed Tanous002d39b2022-05-31 08:59:27 -07002947 .methods(boost::beast::http::verb::get)(
Nan Zhoude167a62022-06-01 04:47:45 +00002948 std::bind_front(sensors::handleSensorCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002949}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002950
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002951inline void requestRoutesSensor(App& app)
2952{
2953 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07002954 .privileges(redfish::privileges::getSensor)
Ed Tanous002d39b2022-05-31 08:59:27 -07002955 .methods(boost::beast::http::verb::get)(
Nan Zhoue6bd8462022-06-01 04:35:35 +00002956 std::bind_front(sensors::handleSensorGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002957}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002958
Ed Tanous1abe55e2018-09-05 08:30:59 -07002959} // namespace redfish