blob: 3a5c73bfb3554b3a2604d97a0a2a2cb10154eeee [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
John Edward Broadbent7e860f12021-04-08 15:57:16 -070018#include <app.hpp>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010019#include <boost/algorithm/string/predicate.hpp>
20#include <boost/algorithm/string/split.hpp>
21#include <boost/container/flat_map.hpp>
22#include <boost/range/algorithm/replace_copy_if.hpp>
Ed Tanous1abe55e2018-09-05 08:30:59 -070023#include <dbus_singleton.hpp>
Ed Tanous168e20c2021-12-13 14:39:53 -080024#include <dbus_utility.hpp>
Ed Tanous45ca1b82022-03-25 13:07:27 -070025#include <query.hpp>
Ed Tanoused398212021-06-09 17:05:54 -070026#include <registries/privilege_registry.hpp>
Jonathan Doman1e1e5982021-06-11 09:36:17 -070027#include <sdbusplus/asio/property.hpp>
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +053028#include <utils/json_utils.hpp>
Nan Zhou928fefb2022-03-28 08:45:00 -070029#include <utils/query_param.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050030
31#include <cmath>
Ed Tanousb5a76932020-09-29 16:16:58 -070032#include <utility>
Ed Tanousabf2add2019-01-22 16:40:12 -080033#include <variant>
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010034
Ed Tanous1abe55e2018-09-05 08:30:59 -070035namespace redfish
36{
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +010037
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020038namespace sensors
39{
40namespace node
41{
42static constexpr std::string_view power = "Power";
43static constexpr std::string_view sensors = "Sensors";
44static constexpr std::string_view thermal = "Thermal";
45} // namespace node
46
Ed Tanous02da7c52022-02-27 00:09:02 -080047// clang-format off
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +020048namespace dbus
49{
Ed Tanous02da7c52022-02-27 00:09:02 -080050auto powerPaths = std::to_array<std::string_view>({
51 "/xyz/openbmc_project/sensors/voltage",
52 "/xyz/openbmc_project/sensors/power"
53});
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000054
Ed Tanous02da7c52022-02-27 00:09:02 -080055auto sensorPaths = std::to_array<std::string_view>({
56 "/xyz/openbmc_project/sensors/power",
57 "/xyz/openbmc_project/sensors/current",
58 "/xyz/openbmc_project/sensors/airflow",
Gunnar Mills5deabed2022-04-20 13:43:45 -060059 "/xyz/openbmc_project/sensors/humidity",
George Liue8204932021-02-01 14:42:49 +080060#ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
Ed Tanous02da7c52022-02-27 00:09:02 -080061 "/xyz/openbmc_project/sensors/voltage",
62 "/xyz/openbmc_project/sensors/fan_tach",
63 "/xyz/openbmc_project/sensors/temperature",
64 "/xyz/openbmc_project/sensors/fan_pwm",
65 "/xyz/openbmc_project/sensors/altitude",
66 "/xyz/openbmc_project/sensors/energy",
George Liue8204932021-02-01 14:42:49 +080067#endif
Ed Tanous02da7c52022-02-27 00:09:02 -080068 "/xyz/openbmc_project/sensors/utilization"
69});
70
71auto thermalPaths = std::to_array<std::string_view>({
72 "/xyz/openbmc_project/sensors/fan_tach",
73 "/xyz/openbmc_project/sensors/temperature",
74 "/xyz/openbmc_project/sensors/fan_pwm"
75});
76
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000077} // namespace dbus
Ed Tanous02da7c52022-02-27 00:09:02 -080078// clang-format on
79
80using sensorPair = std::pair<std::string_view, std::span<std::string_view>>;
81static constexpr std::array<sensorPair, 3> paths = {
82 {{node::power, std::span<std::string_view>(dbus::powerPaths)},
83 {node::sensors, std::span<std::string_view>(dbus::sensorPaths)},
84 {node::thermal, std::span<std::string_view>(dbus::thermalPaths)}}};
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +000085
86inline const char* toReadingType(const std::string& sensorType)
87{
88 if (sensorType == "voltage")
89 {
90 return "Voltage";
91 }
92 if (sensorType == "power")
93 {
94 return "Power";
95 }
96 if (sensorType == "current")
97 {
98 return "Current";
99 }
100 if (sensorType == "fan_tach")
101 {
102 return "Rotational";
103 }
104 if (sensorType == "temperature")
105 {
106 return "Temperature";
107 }
108 if (sensorType == "fan_pwm" || sensorType == "utilization")
109 {
110 return "Percent";
111 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600112 if (sensorType == "humidity")
113 {
114 return "Humidity";
115 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000116 if (sensorType == "altitude")
117 {
118 return "Altitude";
119 }
120 if (sensorType == "airflow")
121 {
122 return "AirFlow";
123 }
124 if (sensorType == "energy")
125 {
126 return "EnergyJoules";
127 }
128 return "";
129}
130
131inline const char* toReadingUnits(const std::string& sensorType)
132{
133 if (sensorType == "voltage")
134 {
135 return "V";
136 }
137 if (sensorType == "power")
138 {
139 return "W";
140 }
141 if (sensorType == "current")
142 {
143 return "A";
144 }
145 if (sensorType == "fan_tach")
146 {
147 return "RPM";
148 }
149 if (sensorType == "temperature")
150 {
151 return "Cel";
152 }
Gunnar Mills5deabed2022-04-20 13:43:45 -0600153 if (sensorType == "fan_pwm" || sensorType == "utilization" ||
154 sensorType == "humidity")
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000155 {
156 return "%";
157 }
158 if (sensorType == "altitude")
159 {
160 return "m";
161 }
162 if (sensorType == "airflow")
163 {
164 return "cft_i/min";
165 }
166 if (sensorType == "energy")
167 {
168 return "J";
169 }
170 return "";
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200171}
172} // namespace sensors
173
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100174/**
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200175 * SensorsAsyncResp
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100176 * Gathers data needed for response processing after async calls are done
177 */
Ed Tanous1abe55e2018-09-05 08:30:59 -0700178class SensorsAsyncResp
179{
180 public:
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200181 using DataCompleteCb = std::function<void(
182 const boost::beast::http::status status,
183 const boost::container::flat_map<std::string, std::string>& uriToDbus)>;
184
185 struct SensorData
186 {
187 const std::string name;
188 std::string uri;
189 const std::string valueKey;
190 const std::string dbusPath;
191 };
192
zhanghch058d1b46d2021-04-01 11:18:24 +0800193 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
194 const std::string& chassisIdIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800195 std::span<std::string_view> typesIn,
196 std::string_view subNode) :
zhanghch058d1b46d2021-04-01 11:18:24 +0800197 asyncResp(asyncResp),
Nan Zhou928fefb2022-03-28 08:45:00 -0700198 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
199 efficientExpand(false)
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500200 {}
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200201
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200202 // Store extra data about sensor mapping and return it in callback
zhanghch058d1b46d2021-04-01 11:18:24 +0800203 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
204 const std::string& chassisIdIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800205 std::span<std::string_view> typesIn,
206 std::string_view subNode,
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200207 DataCompleteCb&& creationComplete) :
zhanghch058d1b46d2021-04-01 11:18:24 +0800208 asyncResp(asyncResp),
Nan Zhou928fefb2022-03-28 08:45:00 -0700209 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
210 efficientExpand(false), metadata{std::vector<SensorData>()},
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200211 dataComplete{std::move(creationComplete)}
212 {}
213
Nan Zhou928fefb2022-03-28 08:45:00 -0700214 // sensor collections expand
215 SensorsAsyncResp(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
216 const std::string& chassisIdIn,
Ed Tanous02da7c52022-02-27 00:09:02 -0800217 const std::span<std::string_view> typesIn,
Nan Zhou928fefb2022-03-28 08:45:00 -0700218 const std::string_view& subNode, bool efficientExpand) :
219 asyncResp(asyncResp),
220 chassisId(chassisIdIn), types(typesIn), chassisSubNode(subNode),
221 efficientExpand(efficientExpand)
222 {}
223
Ed Tanous1abe55e2018-09-05 08:30:59 -0700224 ~SensorsAsyncResp()
225 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800226 if (asyncResp->res.result() ==
227 boost::beast::http::status::internal_server_error)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700228 {
229 // Reset the json object to clear out any data that made it in
230 // before the error happened todo(ed) handle error condition with
231 // proper code
zhanghch058d1b46d2021-04-01 11:18:24 +0800232 asyncResp->res.jsonValue = nlohmann::json::object();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700233 }
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200234
235 if (dataComplete && metadata)
236 {
237 boost::container::flat_map<std::string, std::string> map;
zhanghch058d1b46d2021-04-01 11:18:24 +0800238 if (asyncResp->res.result() == boost::beast::http::status::ok)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200239 {
240 for (auto& sensor : *metadata)
241 {
242 map.insert(std::make_pair(sensor.uri + sensor.valueKey,
243 sensor.dbusPath));
244 }
245 }
zhanghch058d1b46d2021-04-01 11:18:24 +0800246 dataComplete(asyncResp->res.result(), map);
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200247 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700248 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100249
Ed Tanousecd6a3a2022-01-07 09:18:40 -0800250 SensorsAsyncResp(const SensorsAsyncResp&) = delete;
251 SensorsAsyncResp(SensorsAsyncResp&&) = delete;
252 SensorsAsyncResp& operator=(const SensorsAsyncResp&) = delete;
253 SensorsAsyncResp& operator=(SensorsAsyncResp&&) = delete;
254
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200255 void addMetadata(const nlohmann::json& sensorObject,
256 const std::string& valueKey, const std::string& dbusPath)
257 {
258 if (metadata)
259 {
260 metadata->emplace_back(SensorData{sensorObject["Name"],
261 sensorObject["@odata.id"],
262 valueKey, dbusPath});
263 }
264 }
265
266 void updateUri(const std::string& name, const std::string& uri)
267 {
268 if (metadata)
269 {
270 for (auto& sensor : *metadata)
271 {
272 if (sensor.name == name)
273 {
274 sensor.uri = uri;
275 }
276 }
277 }
278 }
279
zhanghch058d1b46d2021-04-01 11:18:24 +0800280 const std::shared_ptr<bmcweb::AsyncResp> asyncResp;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200281 const std::string chassisId;
Ed Tanous02da7c52022-02-27 00:09:02 -0800282 const std::span<std::string_view> types;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200283 const std::string chassisSubNode;
Nan Zhou928fefb2022-03-28 08:45:00 -0700284 const bool efficientExpand;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200285
286 private:
287 std::optional<std::vector<SensorData>> metadata;
288 DataCompleteCb dataComplete;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100289};
290
291/**
Anthony Wilsond5005492019-07-31 16:34:17 -0500292 * Possible states for physical inventory leds
293 */
294enum class LedState
295{
296 OFF,
297 ON,
298 BLINK,
299 UNKNOWN
300};
301
302/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500303 * D-Bus inventory item associated with one or more sensors.
304 */
305class InventoryItem
306{
307 public:
Ed Tanouse05aec52022-01-25 10:28:56 -0800308 InventoryItem(const std::string& objPath) : objectPath(objPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500309 {
310 // Set inventory item name to last node of object path
George Liu28aa8de2021-02-01 15:13:30 +0800311 sdbusplus::message::object_path path(objectPath);
312 name = path.filename();
313 if (name.empty())
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500314 {
George Liu28aa8de2021-02-01 15:13:30 +0800315 BMCWEB_LOG_ERROR << "Failed to find '/' in " << objectPath;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500316 }
317 }
318
319 std::string objectPath;
320 std::string name;
Ed Tanouse05aec52022-01-25 10:28:56 -0800321 bool isPresent = true;
322 bool isFunctional = true;
323 bool isPowerSupply = false;
324 int powerSupplyEfficiencyPercent = -1;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500325 std::string manufacturer;
326 std::string model;
327 std::string partNumber;
328 std::string serialNumber;
329 std::set<std::string> sensors;
Anthony Wilsond5005492019-07-31 16:34:17 -0500330 std::string ledObjectPath;
Ed Tanouse05aec52022-01-25 10:28:56 -0800331 LedState ledState = LedState::UNKNOWN;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500332};
333
334/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530335 * @brief Get objects with connection necessary for sensors
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200336 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100337 * @param sensorNames Sensors retrieved from chassis
338 * @param callback Callback for processing gathered connections
339 */
340template <typename Callback>
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530341void getObjectsWithConnection(
Ed Tanous81ce6092020-12-17 16:54:55 +0000342 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Ed Tanousb5a76932020-09-29 16:16:58 -0700343 const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530344 Callback&& callback)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700345{
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530346 BMCWEB_LOG_DEBUG << "getObjectsWithConnection enter";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700347 const std::string path = "/xyz/openbmc_project/sensors";
348 const std::array<std::string, 1> interfaces = {
349 "xyz.openbmc_project.Sensor.Value"};
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100350
Ed Tanous1abe55e2018-09-05 08:30:59 -0700351 // Response handler for parsing objects subtree
Ed Tanousf94c4ec2022-01-06 12:44:41 -0800352 auto respHandler = [callback{std::forward<Callback>(callback)},
Ed Tanousb9d36b42022-02-26 21:42:46 -0800353 sensorsAsyncResp, sensorNames](
354 const boost::system::error_code ec,
355 const dbus::utility::MapperGetSubTreeResponse&
356 subtree) {
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530357 BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler enter";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700358 if (ec)
359 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800360 messages::internalError(sensorsAsyncResp->asyncResp->res);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530361 BMCWEB_LOG_ERROR
362 << "getObjectsWithConnection resp_handler: Dbus error " << ec;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700363 return;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100364 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100365
Ed Tanous1abe55e2018-09-05 08:30:59 -0700366 BMCWEB_LOG_DEBUG << "Found " << subtree.size() << " subtrees";
367
368 // Make unique list of connections only for requested sensor types and
369 // found in the chassis
370 boost::container::flat_set<std::string> connections;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530371 std::set<std::pair<std::string, std::string>> objectsWithConnection;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700372 // Intrinsic to avoid malloc. Most systems will have < 8 sensor
373 // producers
374 connections.reserve(8);
375
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700376 BMCWEB_LOG_DEBUG << "sensorNames list count: " << sensorNames->size();
377 for (const std::string& tsensor : *sensorNames)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700378 {
379 BMCWEB_LOG_DEBUG << "Sensor to find: " << tsensor;
380 }
381
382 for (const std::pair<
383 std::string,
384 std::vector<std::pair<std::string, std::vector<std::string>>>>&
385 object : subtree)
386 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700387 if (sensorNames->find(object.first) != sensorNames->end())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700388 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700389 for (const std::pair<std::string, std::vector<std::string>>&
390 objData : object.second)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700391 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700392 BMCWEB_LOG_DEBUG << "Adding connection: " << objData.first;
393 connections.insert(objData.first);
394 objectsWithConnection.insert(
395 std::make_pair(object.first, objData.first));
Ed Tanous1abe55e2018-09-05 08:30:59 -0700396 }
397 }
398 }
399 BMCWEB_LOG_DEBUG << "Found " << connections.size() << " connections";
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530400 callback(std::move(connections), std::move(objectsWithConnection));
401 BMCWEB_LOG_DEBUG << "getObjectsWithConnection resp_handler exit";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700402 };
Ed Tanous1abe55e2018-09-05 08:30:59 -0700403 // Make call to ObjectMapper to find all sensors objects
404 crow::connections::systemBus->async_method_call(
405 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
406 "/xyz/openbmc_project/object_mapper",
407 "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 2, interfaces);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530408 BMCWEB_LOG_DEBUG << "getObjectsWithConnection exit";
409}
410
411/**
412 * @brief Create connections necessary for sensors
413 * @param SensorsAsyncResp Pointer to object holding response data
414 * @param sensorNames Sensors retrieved from chassis
415 * @param callback Callback for processing gathered connections
416 */
417template <typename Callback>
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700418void getConnections(
Ed Tanous81ce6092020-12-17 16:54:55 +0000419 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700420 const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames,
421 Callback&& callback)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530422{
423 auto objectsWithConnectionCb =
424 [callback](const boost::container::flat_set<std::string>& connections,
425 const std::set<std::pair<std::string, std::string>>&
Ed Tanous3174e4d2020-10-07 11:41:22 -0700426 /*objectsWithConnection*/) { callback(connections); };
Ed Tanous81ce6092020-12-17 16:54:55 +0000427 getObjectsWithConnection(sensorsAsyncResp, sensorNames,
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +0530428 std::move(objectsWithConnectionCb));
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100429}
430
431/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700432 * @brief Shrinks the list of sensors for processing
433 * @param SensorsAysncResp The class holding the Redfish response
434 * @param allSensors A list of all the sensors associated to the
435 * chassis element (i.e. baseboard, front panel, etc...)
436 * @param activeSensors A list that is a reduction of the incoming
437 * allSensors list. Eliminate Thermal sensors when a Power request is
438 * made, and eliminate Power sensors when a Thermal request is made.
439 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000440inline void reduceSensorList(
Ed Tanous81ce6092020-12-17 16:54:55 +0000441 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700442 const std::vector<std::string>* allSensors,
Ed Tanousb5a76932020-09-29 16:16:58 -0700443 const std::shared_ptr<boost::container::flat_set<std::string>>&
444 activeSensors)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700445{
Ed Tanous81ce6092020-12-17 16:54:55 +0000446 if (sensorsAsyncResp == nullptr)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700447 {
448 return;
449 }
450 if ((allSensors == nullptr) || (activeSensors == nullptr))
451 {
452 messages::resourceNotFound(
zhanghch058d1b46d2021-04-01 11:18:24 +0800453 sensorsAsyncResp->asyncResp->res, sensorsAsyncResp->chassisSubNode,
Ed Tanous81ce6092020-12-17 16:54:55 +0000454 sensorsAsyncResp->chassisSubNode == sensors::node::thermal
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200455 ? "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 Tanous02da7c52022-02-27 00:09:02 -0800466 for (std::string_view type : sensorsAsyncResp->types)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700467 {
468 for (const std::string& sensor : *allSensors)
469 {
470 if (boost::starts_with(sensor, type))
471 {
472 activeSensors->emplace(sensor);
473 }
474 }
475 }
476}
477
478/**
Carol Wang4bb3dc32019-10-17 18:15:02 +0800479 * @brief Retrieves valid chassis path
480 * @param asyncResp Pointer to object holding response data
481 * @param callback Callback for next step to get valid chassis path
482 */
483template <typename Callback>
Ed Tanousb5a76932020-09-29 16:16:58 -0700484void getValidChassisPath(const std::shared_ptr<SensorsAsyncResp>& asyncResp,
Carol Wang4bb3dc32019-10-17 18:15:02 +0800485 Callback&& callback)
486{
487 BMCWEB_LOG_DEBUG << "checkChassisId enter";
488 const std::array<const char*, 2> interfaces = {
489 "xyz.openbmc_project.Inventory.Item.Board",
490 "xyz.openbmc_project.Inventory.Item.Chassis"};
491
Ed Tanousb9d36b42022-02-26 21:42:46 -0800492 auto respHandler = [callback{std::forward<Callback>(callback)}, asyncResp](
493 const boost::system::error_code ec,
494 const dbus::utility::MapperGetSubTreePathsResponse&
495 chassisPaths) mutable {
496 BMCWEB_LOG_DEBUG << "getValidChassisPath respHandler enter";
497 if (ec)
498 {
499 BMCWEB_LOG_ERROR << "getValidChassisPath respHandler DBUS error: "
500 << ec;
501 messages::internalError(asyncResp->asyncResp->res);
502 return;
503 }
Carol Wang4bb3dc32019-10-17 18:15:02 +0800504
Ed Tanousb9d36b42022-02-26 21:42:46 -0800505 std::optional<std::string> chassisPath;
506 std::string chassisName;
507 for (const std::string& chassis : chassisPaths)
508 {
509 sdbusplus::message::object_path path(chassis);
510 chassisName = path.filename();
511 if (chassisName.empty())
Carol Wang4bb3dc32019-10-17 18:15:02 +0800512 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800513 BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis;
514 continue;
Carol Wang4bb3dc32019-10-17 18:15:02 +0800515 }
Ed Tanousb9d36b42022-02-26 21:42:46 -0800516 if (chassisName == asyncResp->chassisId)
517 {
518 chassisPath = chassis;
519 break;
520 }
521 }
522 callback(chassisPath);
523 };
Carol Wang4bb3dc32019-10-17 18:15:02 +0800524
525 // Get the Chassis Collection
526 crow::connections::systemBus->async_method_call(
527 respHandler, "xyz.openbmc_project.ObjectMapper",
528 "/xyz/openbmc_project/object_mapper",
529 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
530 "/xyz/openbmc_project/inventory", 0, interfaces);
531 BMCWEB_LOG_DEBUG << "checkChassisId exit";
532}
533
534/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100535 * @brief Retrieves requested chassis sensors and redundancy data from DBus .
Kowalski, Kamil588c3f02018-04-03 14:55:27 +0200536 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100537 * @param callback Callback for next step in gathered sensor processing
538 */
539template <typename Callback>
Ed Tanousb5a76932020-09-29 16:16:58 -0700540void getChassis(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Ed Tanous1abe55e2018-09-05 08:30:59 -0700541 Callback&& callback)
542{
543 BMCWEB_LOG_DEBUG << "getChassis enter";
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500544 const std::array<const char*, 2> interfaces = {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700545 "xyz.openbmc_project.Inventory.Item.Board",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500546 "xyz.openbmc_project.Inventory.Item.Chassis"};
Ed Tanousf94c4ec2022-01-06 12:44:41 -0800547 auto respHandler = [callback{std::forward<Callback>(callback)},
548 sensorsAsyncResp](
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700549 const boost::system::error_code ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800550 const dbus::utility::MapperGetSubTreePathsResponse&
551 chassisPaths) {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700552 BMCWEB_LOG_DEBUG << "getChassis respHandler enter";
553 if (ec)
554 {
555 BMCWEB_LOG_ERROR << "getChassis respHandler DBUS error: " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +0800556 messages::internalError(sensorsAsyncResp->asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700557 return;
558 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100559
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700560 const std::string* chassisPath = nullptr;
561 std::string chassisName;
562 for (const std::string& chassis : chassisPaths)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700563 {
George Liu28aa8de2021-02-01 15:13:30 +0800564 sdbusplus::message::object_path path(chassis);
565 chassisName = path.filename();
566 if (chassisName.empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700567 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700568 BMCWEB_LOG_ERROR << "Failed to find '/' in " << chassis;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700569 continue;
570 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700571 if (chassisName == sensorsAsyncResp->chassisId)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700572 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700573 chassisPath = &chassis;
574 break;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700575 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700576 }
577 if (chassisPath == nullptr)
578 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800579 messages::resourceNotFound(sensorsAsyncResp->asyncResp->res,
580 "Chassis", sensorsAsyncResp->chassisId);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700581 return;
582 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700583
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700584 const std::string& chassisSubNode = sensorsAsyncResp->chassisSubNode;
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200585 if (chassisSubNode == sensors::node::power)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700586 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800587 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] =
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700588 "#Power.v1_5_2.Power";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700589 }
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200590 else if (chassisSubNode == sensors::node::thermal)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700591 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800592 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] =
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700593 "#Thermal.v1_4_0.Thermal";
zhanghch058d1b46d2021-04-01 11:18:24 +0800594 sensorsAsyncResp->asyncResp->res.jsonValue["Fans"] =
595 nlohmann::json::array();
596 sensorsAsyncResp->asyncResp->res.jsonValue["Temperatures"] =
Jennifer Lee4f9a2132019-03-04 12:45:19 -0800597 nlohmann::json::array();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700598 }
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200599 else if (chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500600 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800601 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.type"] =
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500602 "#SensorCollection.SensorCollection";
zhanghch058d1b46d2021-04-01 11:18:24 +0800603 sensorsAsyncResp->asyncResp->res.jsonValue["Description"] =
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500604 "Collection of Sensors for this Chassis";
zhanghch058d1b46d2021-04-01 11:18:24 +0800605 sensorsAsyncResp->asyncResp->res.jsonValue["Members"] =
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500606 nlohmann::json::array();
zhanghch058d1b46d2021-04-01 11:18:24 +0800607 sensorsAsyncResp->asyncResp->res.jsonValue["Members@odata.count"] =
608 0;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500609 }
610
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200611 if (chassisSubNode != sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500612 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800613 sensorsAsyncResp->asyncResp->res.jsonValue["Id"] = chassisSubNode;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500614 }
615
zhanghch058d1b46d2021-04-01 11:18:24 +0800616 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] =
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700617 "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId + "/" +
618 chassisSubNode;
zhanghch058d1b46d2021-04-01 11:18:24 +0800619 sensorsAsyncResp->asyncResp->res.jsonValue["Name"] = chassisSubNode;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500620 // Get the list of all sensors for this Chassis element
621 std::string sensorPath = *chassisPath + "/all_sensors";
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700622 sdbusplus::asio::getProperty<std::vector<std::string>>(
623 *crow::connections::systemBus, "xyz.openbmc_project.ObjectMapper",
624 sensorPath, "xyz.openbmc_project.Association", "endpoints",
Ed Tanousf94c4ec2022-01-06 12:44:41 -0800625 [sensorsAsyncResp,
626 callback{std::forward<const Callback>(callback)}](
Ed Tanous271584a2019-07-09 16:24:22 -0700627 const boost::system::error_code& e,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700628 const std::vector<std::string>& nodeSensorList) {
Ed Tanous271584a2019-07-09 16:24:22 -0700629 if (e)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700630 {
Ed Tanous271584a2019-07-09 16:24:22 -0700631 if (e.value() != EBADR)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700632 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800633 messages::internalError(
634 sensorsAsyncResp->asyncResp->res);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700635 return;
636 }
637 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700638 const std::shared_ptr<boost::container::flat_set<std::string>>
639 culledSensorList = std::make_shared<
640 boost::container::flat_set<std::string>>();
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700641 reduceSensorList(sensorsAsyncResp, &nodeSensorList,
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700642 culledSensorList);
643 callback(culledSensorList);
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700644 });
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100645 };
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100646
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700647 // Get the Chassis Collection
Ed Tanous1abe55e2018-09-05 08:30:59 -0700648 crow::connections::systemBus->async_method_call(
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700649 respHandler, "xyz.openbmc_project.ObjectMapper",
650 "/xyz/openbmc_project/object_mapper",
651 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths",
Ed Tanous271584a2019-07-09 16:24:22 -0700652 "/xyz/openbmc_project/inventory", 0, interfaces);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700653 BMCWEB_LOG_DEBUG << "getChassis exit";
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100654}
655
656/**
Shawn McCarneyde629b62019-03-08 10:42:51 -0600657 * @brief Finds all DBus object paths that implement ObjectManager.
658 *
659 * Creates a mapping from the associated connection name to the object path.
660 *
661 * Finds the object paths asynchronously. Invokes callback when information has
662 * been obtained.
663 *
664 * The callback must have the following signature:
665 * @code
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500666 * callback(std::shared_ptr<boost::container::flat_map<std::string,
667 * std::string>> objectMgrPaths)
Shawn McCarneyde629b62019-03-08 10:42:51 -0600668 * @endcode
669 *
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700670 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyde629b62019-03-08 10:42:51 -0600671 * @param callback Callback to invoke when object paths obtained.
672 */
673template <typename Callback>
Ed Tanousb5a76932020-09-29 16:16:58 -0700674void getObjectManagerPaths(
Ed Tanous81ce6092020-12-17 16:54:55 +0000675 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Ed Tanousb5a76932020-09-29 16:16:58 -0700676 Callback&& callback)
Shawn McCarneyde629b62019-03-08 10:42:51 -0600677{
678 BMCWEB_LOG_DEBUG << "getObjectManagerPaths enter";
679 const std::array<std::string, 1> interfaces = {
680 "org.freedesktop.DBus.ObjectManager"};
681
682 // Response handler for GetSubTree DBus method
Ed Tanousf94c4ec2022-01-06 12:44:41 -0800683 auto respHandler = [callback{std::forward<Callback>(callback)},
Ed Tanousb9d36b42022-02-26 21:42:46 -0800684 sensorsAsyncResp](
685 const boost::system::error_code ec,
686 const dbus::utility::MapperGetSubTreeResponse&
687 subtree) {
Shawn McCarneyde629b62019-03-08 10:42:51 -0600688 BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler enter";
689 if (ec)
690 {
zhanghch058d1b46d2021-04-01 11:18:24 +0800691 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600692 BMCWEB_LOG_ERROR << "getObjectManagerPaths respHandler: DBus error "
693 << ec;
694 return;
695 }
696
697 // Loop over returned object paths
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500698 std::shared_ptr<boost::container::flat_map<std::string, std::string>>
699 objectMgrPaths = std::make_shared<
700 boost::container::flat_map<std::string, std::string>>();
Shawn McCarneyde629b62019-03-08 10:42:51 -0600701 for (const std::pair<
702 std::string,
703 std::vector<std::pair<std::string, std::vector<std::string>>>>&
704 object : subtree)
705 {
706 // Loop over connections for current object path
707 const std::string& objectPath = object.first;
708 for (const std::pair<std::string, std::vector<std::string>>&
709 objData : object.second)
710 {
711 // Add mapping from connection to object path
712 const std::string& connection = objData.first;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500713 (*objectMgrPaths)[connection] = objectPath;
Shawn McCarneyde629b62019-03-08 10:42:51 -0600714 BMCWEB_LOG_DEBUG << "Added mapping " << connection << " -> "
715 << objectPath;
716 }
717 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -0500718 callback(objectMgrPaths);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600719 BMCWEB_LOG_DEBUG << "getObjectManagerPaths respHandler exit";
720 };
721
722 // Query mapper for all DBus object paths that implement ObjectManager
723 crow::connections::systemBus->async_method_call(
724 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
725 "/xyz/openbmc_project/object_mapper",
Ed Tanous271584a2019-07-09 16:24:22 -0700726 "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, interfaces);
Shawn McCarneyde629b62019-03-08 10:42:51 -0600727 BMCWEB_LOG_DEBUG << "getObjectManagerPaths exit";
728}
729
730/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500731 * @brief Returns the Redfish State value for the specified inventory item.
732 * @param inventoryItem D-Bus inventory item associated with a sensor.
733 * @return State value for inventory item.
James Feist34dd1792019-05-17 14:10:54 -0700734 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000735inline std::string getState(const InventoryItem* inventoryItem)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500736{
737 if ((inventoryItem != nullptr) && !(inventoryItem->isPresent))
738 {
739 return "Absent";
740 }
James Feist34dd1792019-05-17 14:10:54 -0700741
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500742 return "Enabled";
743}
744
745/**
746 * @brief Returns the Redfish Health value for the specified sensor.
747 * @param sensorJson Sensor JSON object.
748 * @param interfacesDict Map of all sensor interfaces.
749 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
750 * be nullptr if no associated inventory item was found.
751 * @return Health value for sensor.
752 */
Ed Tanous711ac7a2021-12-20 09:34:41 -0800753inline std::string
754 getHealth(nlohmann::json& sensorJson,
755 const dbus::utility::DBusInteracesMap& interfacesDict,
756 const InventoryItem* inventoryItem)
James Feist34dd1792019-05-17 14:10:54 -0700757{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500758 // Get current health value (if any) in the sensor JSON object. Some JSON
759 // objects contain multiple sensors (such as PowerSupplies). We want to set
760 // the overall health to be the most severe of any of the sensors.
761 std::string currentHealth;
762 auto statusIt = sensorJson.find("Status");
763 if (statusIt != sensorJson.end())
764 {
765 auto healthIt = statusIt->find("Health");
766 if (healthIt != statusIt->end())
767 {
768 std::string* health = healthIt->get_ptr<std::string*>();
769 if (health != nullptr)
770 {
771 currentHealth = *health;
772 }
773 }
774 }
775
776 // If current health in JSON object is already Critical, return that. This
777 // should override the sensor health, which might be less severe.
778 if (currentHealth == "Critical")
779 {
780 return "Critical";
781 }
782
783 // Check if sensor has critical threshold alarm
Ed Tanous711ac7a2021-12-20 09:34:41 -0800784
Ed Tanous9eb808c2022-01-25 10:19:23 -0800785 for (const auto& [interface, values] : interfacesDict)
James Feist34dd1792019-05-17 14:10:54 -0700786 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800787 if (interface == "xyz.openbmc_project.Sensor.Threshold.Critical")
James Feist34dd1792019-05-17 14:10:54 -0700788 {
Ed Tanous9eb808c2022-01-25 10:19:23 -0800789 for (const auto& [valueName, value] : values)
James Feist34dd1792019-05-17 14:10:54 -0700790 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800791 if (valueName == "CriticalAlarmHigh" ||
792 valueName == "CriticalAlarmLow")
793 {
794 const bool* asserted = std::get_if<bool>(&value);
795 if (asserted == nullptr)
796 {
797 BMCWEB_LOG_ERROR << "Illegal sensor threshold";
798 }
799 else if (*asserted)
800 {
801 return "Critical";
802 }
803 }
James Feist34dd1792019-05-17 14:10:54 -0700804 }
805 }
806 }
807
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500808 // Check if associated inventory item is not functional
809 if ((inventoryItem != nullptr) && !(inventoryItem->isFunctional))
810 {
811 return "Critical";
812 }
813
814 // If current health in JSON object is already Warning, return that. This
815 // should override the sensor status, which might be less severe.
816 if (currentHealth == "Warning")
817 {
818 return "Warning";
819 }
820
821 // Check if sensor has warning threshold alarm
Ed Tanous9eb808c2022-01-25 10:19:23 -0800822 for (const auto& [interface, values] : interfacesDict)
James Feist34dd1792019-05-17 14:10:54 -0700823 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800824 if (interface == "xyz.openbmc_project.Sensor.Threshold.Warning")
James Feist34dd1792019-05-17 14:10:54 -0700825 {
Ed Tanous9eb808c2022-01-25 10:19:23 -0800826 for (const auto& [valueName, value] : values)
James Feist34dd1792019-05-17 14:10:54 -0700827 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800828 if (valueName == "WarningAlarmHigh" ||
829 valueName == "WarningAlarmLow")
830 {
831 const bool* asserted = std::get_if<bool>(&value);
832 if (asserted == nullptr)
833 {
834 BMCWEB_LOG_ERROR << "Illegal sensor threshold";
835 }
836 else if (*asserted)
837 {
Ed Tanousebe4d912022-01-12 12:38:17 -0800838 return "Warning";
Ed Tanous711ac7a2021-12-20 09:34:41 -0800839 }
840 }
James Feist34dd1792019-05-17 14:10:54 -0700841 }
842 }
843 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500844
James Feist34dd1792019-05-17 14:10:54 -0700845 return "OK";
846}
847
Ed Tanous23a21a12020-07-25 04:45:05 +0000848inline void setLedState(nlohmann::json& sensorJson,
Anthony Wilsond5005492019-07-31 16:34:17 -0500849 const InventoryItem* inventoryItem)
850{
851 if (inventoryItem != nullptr && !inventoryItem->ledObjectPath.empty())
852 {
853 switch (inventoryItem->ledState)
854 {
855 case LedState::OFF:
856 sensorJson["IndicatorLED"] = "Off";
857 break;
858 case LedState::ON:
859 sensorJson["IndicatorLED"] = "Lit";
860 break;
861 case LedState::BLINK:
862 sensorJson["IndicatorLED"] = "Blinking";
863 break;
Ed Tanous23a21a12020-07-25 04:45:05 +0000864 case LedState::UNKNOWN:
Anthony Wilsond5005492019-07-31 16:34:17 -0500865 break;
866 }
867 }
868}
869
James Feist34dd1792019-05-17 14:10:54 -0700870/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100871 * @brief Builds a json sensor representation of a sensor.
872 * @param sensorName The name of the sensor to be built
Gunnar Mills274fad52018-06-13 15:45:36 -0500873 * @param sensorType The type (temperature, fan_tach, etc) of the sensor to
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100874 * build
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200875 * @param sensorsAsyncResp Sensor metadata
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100876 * @param interfacesDict A dictionary of the interfaces and properties of said
877 * interfaces to be built from
878 * @param sensor_json The json object to fill
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500879 * @param inventoryItem D-Bus inventory item associated with the sensor. Will
880 * be nullptr if no associated inventory item was found.
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100881 */
Ed Tanous23a21a12020-07-25 04:45:05 +0000882inline void objectInterfacesToJson(
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100883 const std::string& sensorName, const std::string& sensorType,
Ed Tanousb5a76932020-09-29 16:16:58 -0700884 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Ed Tanous711ac7a2021-12-20 09:34:41 -0800885 const dbus::utility::DBusInteracesMap& interfacesDict,
Ed Tanous81ce6092020-12-17 16:54:55 +0000886 nlohmann::json& sensorJson, InventoryItem* inventoryItem)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700887{
Ed Tanous1abe55e2018-09-05 08:30:59 -0700888 // Assume values exist as is (10^0 == 1) if no scale exists
889 int64_t scaleMultiplier = 0;
Ed Tanous9eb808c2022-01-25 10:19:23 -0800890 for (const auto& [interface, values] : interfacesDict)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700891 {
Ed Tanous711ac7a2021-12-20 09:34:41 -0800892 if (interface == "xyz.openbmc_project.Sensor.Value")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700893 {
Ed Tanous9eb808c2022-01-25 10:19:23 -0800894 for (const auto& [valueName, value] : values)
Ed Tanous711ac7a2021-12-20 09:34:41 -0800895 {
896 if (valueName == "Scale")
897 {
898 const int64_t* int64Value = std::get_if<int64_t>(&value);
899 if (int64Value != nullptr)
900 {
901 scaleMultiplier = *int64Value;
902 }
903 }
904 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100905 }
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +0100906 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700907
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200908 if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500909 {
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500910 // For sensors in SensorCollection we set Id instead of MemberId,
911 // including power sensors.
Ed Tanous81ce6092020-12-17 16:54:55 +0000912 sensorJson["Id"] = sensorName;
913 sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " ");
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500914 }
915 else if (sensorType != "power")
916 {
917 // Set MemberId and Name for non-power sensors. For PowerSupplies and
918 // PowerControl, those properties have more general values because
919 // multiple sensors can be stored in the same JSON object.
Ed Tanous81ce6092020-12-17 16:54:55 +0000920 sensorJson["MemberId"] = sensorName;
921 sensorJson["Name"] = boost::replace_all_copy(sensorName, "_", " ");
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -0500922 }
Ed Tanouse742b6c2019-05-03 15:06:53 -0700923
Ed Tanous81ce6092020-12-17 16:54:55 +0000924 sensorJson["Status"]["State"] = getState(inventoryItem);
925 sensorJson["Status"]["Health"] =
926 getHealth(sensorJson, interfacesDict, inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700927
928 // Parameter to set to override the type we get from dbus, and force it to
929 // int, regardless of what is available. This is used for schemas like fan,
930 // that require integers, not floats.
931 bool forceToInt = false;
932
Anthony Wilson3929aca2019-07-19 15:42:33 -0500933 nlohmann::json::json_pointer unit("/Reading");
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +0200934 if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500935 {
Ed Tanous81ce6092020-12-17 16:54:55 +0000936 sensorJson["@odata.type"] = "#Sensor.v1_0_0.Sensor";
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000937
938 const std::string& readingType = sensors::toReadingType(sensorType);
939 if (readingType.empty())
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500940 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000941 BMCWEB_LOG_ERROR << "Redfish cannot map reading type for "
942 << sensorType;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500943 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000944 else
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500945 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000946 sensorJson["ReadingType"] = readingType;
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500947 }
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000948
949 const std::string& readingUnits = sensors::toReadingUnits(sensorType);
950 if (readingUnits.empty())
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200951 {
Wludzik, Jozefc2bf7f92021-03-08 14:35:54 +0000952 BMCWEB_LOG_ERROR << "Redfish cannot map reading unit for "
953 << sensorType;
954 }
955 else
956 {
957 sensorJson["ReadingUnits"] = readingUnits;
Adrian Ambrożewiczf8ede152020-06-02 13:26:33 +0200958 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -0500959 }
960 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700961 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500962 unit = "/ReadingCelsius"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000963 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Temperature";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700964 // TODO(ed) Documentation says that path should be type fan_tach,
965 // implementation seems to implement fan
966 }
967 else if (sensorType == "fan" || sensorType == "fan_tach")
968 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500969 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000970 sensorJson["ReadingUnits"] = "RPM";
971 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
972 setLedState(sensorJson, inventoryItem);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700973 forceToInt = true;
974 }
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700975 else if (sensorType == "fan_pwm")
976 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500977 unit = "/Reading"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000978 sensorJson["ReadingUnits"] = "Percent";
979 sensorJson["@odata.type"] = "#Thermal.v1_3_0.Fan";
980 setLedState(sensorJson, inventoryItem);
Ed Tanous6f6d0d32018-10-12 11:16:43 -0700981 forceToInt = true;
982 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700983 else if (sensorType == "voltage")
984 {
Anthony Wilson3929aca2019-07-19 15:42:33 -0500985 unit = "/ReadingVolts"_json_pointer;
Ed Tanous81ce6092020-12-17 16:54:55 +0000986 sensorJson["@odata.type"] = "#Power.v1_0_0.Voltage";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700987 }
Ed Tanous2474adf2018-09-05 16:31:16 -0700988 else if (sensorType == "power")
989 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -0700990 std::string sensorNameLower =
991 boost::algorithm::to_lower_copy(sensorName);
992
Ed Tanous55f79e62022-01-25 11:26:16 -0800993 if (sensorName == "total_power")
Eddie James028f7eb2019-05-17 21:24:36 +0000994 {
Ed Tanous81ce6092020-12-17 16:54:55 +0000995 sensorJson["@odata.type"] = "#Power.v1_0_0.PowerControl";
Gunnar Mills7ab06f42019-07-02 13:07:16 -0500996 // Put multiple "sensors" into a single PowerControl, so have
997 // generic names for MemberId and Name. Follows Redfish mockup.
Ed Tanous81ce6092020-12-17 16:54:55 +0000998 sensorJson["MemberId"] = "0";
999 sensorJson["Name"] = "Chassis Power Control";
Anthony Wilson3929aca2019-07-19 15:42:33 -05001000 unit = "/PowerConsumedWatts"_json_pointer;
Eddie James028f7eb2019-05-17 21:24:36 +00001001 }
1002 else if (sensorNameLower.find("input") != std::string::npos)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001003 {
Anthony Wilson3929aca2019-07-19 15:42:33 -05001004 unit = "/PowerInputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001005 }
1006 else
1007 {
Anthony Wilson3929aca2019-07-19 15:42:33 -05001008 unit = "/PowerOutputWatts"_json_pointer;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001009 }
Ed Tanous2474adf2018-09-05 16:31:16 -07001010 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001011 else
1012 {
1013 BMCWEB_LOG_ERROR << "Redfish cannot map object type for " << sensorName;
1014 return;
1015 }
1016 // Map of dbus interface name, dbus property name and redfish property_name
Anthony Wilson3929aca2019-07-19 15:42:33 -05001017 std::vector<
1018 std::tuple<const char*, const char*, nlohmann::json::json_pointer>>
1019 properties;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001020 properties.reserve(7);
1021
1022 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "Value", unit);
Shawn McCarneyde629b62019-03-08 10:42:51 -06001023
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02001024 if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors)
Anthony Wilson3929aca2019-07-19 15:42:33 -05001025 {
1026 properties.emplace_back(
1027 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningHigh",
1028 "/Thresholds/UpperCaution/Reading"_json_pointer);
1029 properties.emplace_back(
1030 "xyz.openbmc_project.Sensor.Threshold.Warning", "WarningLow",
1031 "/Thresholds/LowerCaution/Reading"_json_pointer);
1032 properties.emplace_back(
1033 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalHigh",
1034 "/Thresholds/UpperCritical/Reading"_json_pointer);
1035 properties.emplace_back(
1036 "xyz.openbmc_project.Sensor.Threshold.Critical", "CriticalLow",
1037 "/Thresholds/LowerCritical/Reading"_json_pointer);
1038 }
1039 else if (sensorType != "power")
Shawn McCarneyde629b62019-03-08 10:42:51 -06001040 {
1041 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001042 "WarningHigh",
1043 "/UpperThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -06001044 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Warning",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001045 "WarningLow",
1046 "/LowerThresholdNonCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -06001047 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001048 "CriticalHigh",
1049 "/UpperThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -06001050 properties.emplace_back("xyz.openbmc_project.Sensor.Threshold.Critical",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001051 "CriticalLow",
1052 "/LowerThresholdCritical"_json_pointer);
Shawn McCarneyde629b62019-03-08 10:42:51 -06001053 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001054
Ed Tanous2474adf2018-09-05 16:31:16 -07001055 // TODO Need to get UpperThresholdFatal and LowerThresholdFatal
1056
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02001057 if (sensorsAsyncResp->chassisSubNode == sensors::node::sensors)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05001058 {
1059 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001060 "/ReadingRangeMin"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -05001061 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001062 "/ReadingRangeMax"_json_pointer);
Anthony Wilson95a3eca2019-06-11 10:44:47 -05001063 }
1064 else if (sensorType == "temperature")
Ed Tanous1abe55e2018-09-05 08:30:59 -07001065 {
1066 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001067 "/MinReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001068 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001069 "/MaxReadingRangeTemp"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001070 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001071 else if (sensorType != "power")
Ed Tanous1abe55e2018-09-05 08:30:59 -07001072 {
1073 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MinValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001074 "/MinReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001075 properties.emplace_back("xyz.openbmc_project.Sensor.Value", "MaxValue",
Anthony Wilson3929aca2019-07-19 15:42:33 -05001076 "/MaxReadingRange"_json_pointer);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001077 }
1078
Anthony Wilson3929aca2019-07-19 15:42:33 -05001079 for (const std::tuple<const char*, const char*,
1080 nlohmann::json::json_pointer>& p : properties)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001081 {
Ed Tanous55f79e62022-01-25 11:26:16 -08001082 for (const auto& [interface, values] : interfacesDict)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001083 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001084 if (interface != std::get<0>(p))
Ed Tanous1abe55e2018-09-05 08:30:59 -07001085 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001086 continue;
1087 }
Ed Tanous55f79e62022-01-25 11:26:16 -08001088 for (const auto& [valueName, valueVariant] : values)
Ed Tanous711ac7a2021-12-20 09:34:41 -08001089 {
1090 if (valueName != std::get<1>(p))
1091 {
1092 continue;
1093 }
Anthony Wilson3929aca2019-07-19 15:42:33 -05001094
1095 // The property we want to set may be nested json, so use
1096 // a json_pointer for easy indexing into the json structure.
1097 const nlohmann::json::json_pointer& key = std::get<2>(p);
1098
Ed Tanous1abe55e2018-09-05 08:30:59 -07001099 // Attempt to pull the int64 directly
Ed Tanousabf2add2019-01-22 16:40:12 -08001100 const int64_t* int64Value = std::get_if<int64_t>(&valueVariant);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001101
Ed Tanousabf2add2019-01-22 16:40:12 -08001102 const double* doubleValue = std::get_if<double>(&valueVariant);
Eddie James028f7eb2019-05-17 21:24:36 +00001103 const uint32_t* uValue = std::get_if<uint32_t>(&valueVariant);
Ed Tanous6f6d0d32018-10-12 11:16:43 -07001104 double temp = 0.0;
1105 if (int64Value != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001106 {
Ed Tanous271584a2019-07-09 16:24:22 -07001107 temp = static_cast<double>(*int64Value);
Ed Tanous6f6d0d32018-10-12 11:16:43 -07001108 }
1109 else if (doubleValue != nullptr)
1110 {
1111 temp = *doubleValue;
1112 }
Eddie James028f7eb2019-05-17 21:24:36 +00001113 else if (uValue != nullptr)
1114 {
1115 temp = *uValue;
1116 }
Ed Tanous6f6d0d32018-10-12 11:16:43 -07001117 else
1118 {
1119 BMCWEB_LOG_ERROR
1120 << "Got value interface that wasn't int or double";
1121 continue;
1122 }
1123 temp = temp * std::pow(10, scaleMultiplier);
1124 if (forceToInt)
1125 {
Ed Tanous81ce6092020-12-17 16:54:55 +00001126 sensorJson[key] = static_cast<int64_t>(temp);
Ed Tanous6f6d0d32018-10-12 11:16:43 -07001127 }
1128 else
1129 {
Ed Tanous81ce6092020-12-17 16:54:55 +00001130 sensorJson[key] = temp;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001131 }
1132 }
1133 }
1134 }
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02001135
Ed Tanous81ce6092020-12-17 16:54:55 +00001136 sensorsAsyncResp->addMetadata(sensorJson, unit.to_string(),
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02001137 "/xyz/openbmc_project/sensors/" + sensorType +
1138 "/" + sensorName);
1139
Ed Tanous1abe55e2018-09-05 08:30:59 -07001140 BMCWEB_LOG_DEBUG << "Added sensor " << sensorName;
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01001141}
1142
Ed Tanousb5a76932020-09-29 16:16:58 -07001143inline void populateFanRedundancy(
1144 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
James Feist8bd25cc2019-03-15 15:14:00 -07001145{
1146 crow::connections::systemBus->async_method_call(
Ed Tanousb9d36b42022-02-26 21:42:46 -08001147 [sensorsAsyncResp](
1148 const boost::system::error_code ec,
1149 const dbus::utility::MapperGetSubTreeResponse& resp) {
James Feist8bd25cc2019-03-15 15:14:00 -07001150 if (ec)
1151 {
1152 return; // don't have to have this interface
1153 }
Ed Tanouse278c182019-03-13 16:23:37 -07001154 for (const std::pair<std::string,
1155 std::vector<std::pair<
1156 std::string, std::vector<std::string>>>>&
1157 pathPair : resp)
James Feist8bd25cc2019-03-15 15:14:00 -07001158 {
Ed Tanouse278c182019-03-13 16:23:37 -07001159 const std::string& path = pathPair.first;
1160 const std::vector<
1161 std::pair<std::string, std::vector<std::string>>>& objDict =
1162 pathPair.second;
James Feist8bd25cc2019-03-15 15:14:00 -07001163 if (objDict.empty())
1164 {
1165 continue; // this should be impossible
1166 }
1167
1168 const std::string& owner = objDict.begin()->first;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001169 sdbusplus::asio::getProperty<std::vector<std::string>>(
1170 *crow::connections::systemBus,
1171 "xyz.openbmc_project.ObjectMapper", path + "/chassis",
1172 "xyz.openbmc_project.Association", "endpoints",
1173 [path, owner, sensorsAsyncResp](
1174 const boost::system::error_code e,
1175 const std::vector<std::string>& endpoints) {
Ed Tanous271584a2019-07-09 16:24:22 -07001176 if (e)
James Feist8bd25cc2019-03-15 15:14:00 -07001177 {
1178 return; // if they don't have an association we
1179 // can't tell what chassis is
1180 }
James Feist8bd25cc2019-03-15 15:14:00 -07001181 auto found = std::find_if(
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001182 endpoints.begin(), endpoints.end(),
James Feist8bd25cc2019-03-15 15:14:00 -07001183 [sensorsAsyncResp](const std::string& entry) {
1184 return entry.find(
1185 sensorsAsyncResp->chassisId) !=
1186 std::string::npos;
1187 });
1188
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001189 if (found == endpoints.end())
James Feist8bd25cc2019-03-15 15:14:00 -07001190 {
1191 return;
1192 }
1193 crow::connections::systemBus->async_method_call(
1194 [path, sensorsAsyncResp](
Ed Tanous271584a2019-07-09 16:24:22 -07001195 const boost::system::error_code& err,
James Feist8bd25cc2019-03-15 15:14:00 -07001196 const boost::container::flat_map<
1197 std::string,
Ed Tanous168e20c2021-12-13 14:39:53 -08001198 dbus::utility::DbusVariantType>& ret) {
Ed Tanous271584a2019-07-09 16:24:22 -07001199 if (err)
James Feist8bd25cc2019-03-15 15:14:00 -07001200 {
1201 return; // don't have to have this
1202 // interface
1203 }
1204 auto findFailures = ret.find("AllowedFailures");
1205 auto findCollection = ret.find("Collection");
1206 auto findStatus = ret.find("Status");
1207
1208 if (findFailures == ret.end() ||
1209 findCollection == ret.end() ||
1210 findStatus == ret.end())
1211 {
1212 BMCWEB_LOG_ERROR
1213 << "Invalid redundancy interface";
1214 messages::internalError(
zhanghch058d1b46d2021-04-01 11:18:24 +08001215 sensorsAsyncResp->asyncResp->res);
James Feist8bd25cc2019-03-15 15:14:00 -07001216 return;
1217 }
1218
Ed Tanous9eb808c2022-01-25 10:19:23 -08001219 const uint8_t* allowedFailures =
1220 std::get_if<uint8_t>(
1221 &(findFailures->second));
1222 const std::vector<std::string>* collection =
James Feist8bd25cc2019-03-15 15:14:00 -07001223 std::get_if<std::vector<std::string>>(
1224 &(findCollection->second));
Ed Tanous9eb808c2022-01-25 10:19:23 -08001225 const std::string* status =
1226 std::get_if<std::string>(
1227 &(findStatus->second));
James Feist8bd25cc2019-03-15 15:14:00 -07001228
1229 if (allowedFailures == nullptr ||
1230 collection == nullptr || status == nullptr)
1231 {
1232
1233 BMCWEB_LOG_ERROR
George Liu0fda0f12021-11-16 10:06:17 +08001234 << "Invalid redundancy interface types";
James Feist8bd25cc2019-03-15 15:14:00 -07001235 messages::internalError(
zhanghch058d1b46d2021-04-01 11:18:24 +08001236 sensorsAsyncResp->asyncResp->res);
James Feist8bd25cc2019-03-15 15:14:00 -07001237 return;
1238 }
George Liu28aa8de2021-02-01 15:13:30 +08001239 sdbusplus::message::object_path objectPath(
1240 path);
1241 std::string name = objectPath.filename();
1242 if (name.empty())
James Feist8bd25cc2019-03-15 15:14:00 -07001243 {
1244 // this should be impossible
1245 messages::internalError(
zhanghch058d1b46d2021-04-01 11:18:24 +08001246 sensorsAsyncResp->asyncResp->res);
James Feist8bd25cc2019-03-15 15:14:00 -07001247 return;
1248 }
James Feist8bd25cc2019-03-15 15:14:00 -07001249 std::replace(name.begin(), name.end(), '_',
1250 ' ');
1251
1252 std::string health;
1253
1254 if (boost::ends_with(*status, "Full"))
1255 {
1256 health = "OK";
1257 }
1258 else if (boost::ends_with(*status, "Degraded"))
1259 {
1260 health = "Warning";
1261 }
1262 else
1263 {
1264 health = "Critical";
1265 }
1266 std::vector<nlohmann::json> redfishCollection;
1267 const auto& fanRedfish =
zhanghch058d1b46d2021-04-01 11:18:24 +08001268 sensorsAsyncResp->asyncResp->res
1269 .jsonValue["Fans"];
James Feist8bd25cc2019-03-15 15:14:00 -07001270 for (const std::string& item : *collection)
1271 {
George Liu28aa8de2021-02-01 15:13:30 +08001272 sdbusplus::message::object_path path(item);
1273 std::string itemName = path.filename();
1274 if (itemName.empty())
1275 {
1276 continue;
1277 }
James Feist8bd25cc2019-03-15 15:14:00 -07001278 /*
1279 todo(ed): merge patch that fixes the names
1280 std::replace(itemName.begin(),
1281 itemName.end(), '_', ' ');*/
1282 auto schemaItem = std::find_if(
1283 fanRedfish.begin(), fanRedfish.end(),
1284 [itemName](const nlohmann::json& fan) {
1285 return fan["MemberId"] == itemName;
1286 });
1287 if (schemaItem != fanRedfish.end())
1288 {
1289 redfishCollection.push_back(
1290 {{"@odata.id",
1291 (*schemaItem)["@odata.id"]}});
1292 }
1293 else
1294 {
1295 BMCWEB_LOG_ERROR
1296 << "failed to find fan in schema";
1297 messages::internalError(
zhanghch058d1b46d2021-04-01 11:18:24 +08001298 sensorsAsyncResp->asyncResp->res);
James Feist8bd25cc2019-03-15 15:14:00 -07001299 return;
1300 }
1301 }
1302
Kuiying Wang3e9e72e2020-07-07 10:18:32 +08001303 size_t minNumNeeded =
Ed Tanous26f69762022-01-25 09:49:11 -08001304 collection->empty()
1305 ? 0
1306 : collection->size() - *allowedFailures;
Ed Tanous271584a2019-07-09 16:24:22 -07001307 nlohmann::json& jResp =
zhanghch058d1b46d2021-04-01 11:18:24 +08001308 sensorsAsyncResp->asyncResp->res
Ed Tanous271584a2019-07-09 16:24:22 -07001309 .jsonValue["Redundancy"];
1310 jResp.push_back(
James Feist8bd25cc2019-03-15 15:14:00 -07001311 {{"@odata.id",
AppaRao Puli717794d2019-10-18 22:54:53 +05301312 "/redfish/v1/Chassis/" +
James Feist8bd25cc2019-03-15 15:14:00 -07001313 sensorsAsyncResp->chassisId + "/" +
1314 sensorsAsyncResp->chassisSubNode +
1315 "#/Redundancy/" +
Ed Tanous271584a2019-07-09 16:24:22 -07001316 std::to_string(jResp.size())},
James Feist8bd25cc2019-03-15 15:14:00 -07001317 {"@odata.type",
1318 "#Redundancy.v1_3_2.Redundancy"},
Kuiying Wang3e9e72e2020-07-07 10:18:32 +08001319 {"MinNumNeeded", minNumNeeded},
James Feist8bd25cc2019-03-15 15:14:00 -07001320 {"MemberId", name},
1321 {"Mode", "N+m"},
1322 {"Name", name},
1323 {"RedundancySet", redfishCollection},
1324 {"Status",
1325 {{"Health", health},
1326 {"State", "Enabled"}}}});
1327 },
1328 owner, path, "org.freedesktop.DBus.Properties",
1329 "GetAll",
1330 "xyz.openbmc_project.Control.FanRedundancy");
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001331 });
James Feist8bd25cc2019-03-15 15:14:00 -07001332 }
1333 },
1334 "xyz.openbmc_project.ObjectMapper",
1335 "/xyz/openbmc_project/object_mapper",
1336 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
1337 "/xyz/openbmc_project/control", 2,
1338 std::array<const char*, 1>{
1339 "xyz.openbmc_project.Control.FanRedundancy"});
1340}
1341
Ed Tanousb5a76932020-09-29 16:16:58 -07001342inline void
Ed Tanous81ce6092020-12-17 16:54:55 +00001343 sortJSONResponse(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001344{
zhanghch058d1b46d2021-04-01 11:18:24 +08001345 nlohmann::json& response = sensorsAsyncResp->asyncResp->res.jsonValue;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001346 std::array<std::string, 2> sensorHeaders{"Temperatures", "Fans"};
Ed Tanous81ce6092020-12-17 16:54:55 +00001347 if (sensorsAsyncResp->chassisSubNode == sensors::node::power)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001348 {
1349 sensorHeaders = {"Voltages", "PowerSupplies"};
1350 }
1351 for (const std::string& sensorGroup : sensorHeaders)
1352 {
1353 nlohmann::json::iterator entry = response.find(sensorGroup);
1354 if (entry != response.end())
1355 {
1356 std::sort(entry->begin(), entry->end(),
1357 [](nlohmann::json& c1, nlohmann::json& c2) {
1358 return c1["Name"] < c2["Name"];
1359 });
1360
1361 // add the index counts to the end of each entry
1362 size_t count = 0;
1363 for (nlohmann::json& sensorJson : *entry)
1364 {
1365 nlohmann::json::iterator odata = sensorJson.find("@odata.id");
1366 if (odata == sensorJson.end())
1367 {
1368 continue;
1369 }
1370 std::string* value = odata->get_ptr<std::string*>();
1371 if (value != nullptr)
1372 {
1373 *value += std::to_string(count);
1374 count++;
Ed Tanous81ce6092020-12-17 16:54:55 +00001375 sensorsAsyncResp->updateUri(sensorJson["Name"], *value);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07001376 }
1377 }
1378 }
1379 }
1380}
1381
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01001382/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001383 * @brief Finds the inventory item with the specified object path.
1384 * @param inventoryItems D-Bus inventory items associated with sensors.
1385 * @param invItemObjPath D-Bus object path of inventory item.
1386 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001387 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001388inline InventoryItem* findInventoryItem(
Ed Tanousb5a76932020-09-29 16:16:58 -07001389 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001390 const std::string& invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001391{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001392 for (InventoryItem& inventoryItem : *inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001393 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001394 if (inventoryItem.objectPath == invItemObjPath)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001395 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001396 return &inventoryItem;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001397 }
1398 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001399 return nullptr;
1400}
1401
1402/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001403 * @brief Finds the inventory item associated with the specified sensor.
1404 * @param inventoryItems D-Bus inventory items associated with sensors.
1405 * @param sensorObjPath D-Bus object path of sensor.
1406 * @return Inventory item within vector, or nullptr if no match found.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001407 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001408inline InventoryItem* findInventoryItemForSensor(
Ed Tanousb5a76932020-09-29 16:16:58 -07001409 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001410 const std::string& sensorObjPath)
1411{
1412 for (InventoryItem& inventoryItem : *inventoryItems)
1413 {
1414 if (inventoryItem.sensors.count(sensorObjPath) > 0)
1415 {
1416 return &inventoryItem;
1417 }
1418 }
1419 return nullptr;
1420}
1421
1422/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001423 * @brief Finds the inventory item associated with the specified led path.
1424 * @param inventoryItems D-Bus inventory items associated with sensors.
1425 * @param ledObjPath D-Bus object path of led.
1426 * @return Inventory item within vector, or nullptr if no match found.
1427 */
1428inline InventoryItem*
1429 findInventoryItemForLed(std::vector<InventoryItem>& inventoryItems,
1430 const std::string& ledObjPath)
1431{
1432 for (InventoryItem& inventoryItem : inventoryItems)
1433 {
1434 if (inventoryItem.ledObjectPath == ledObjPath)
1435 {
1436 return &inventoryItem;
1437 }
1438 }
1439 return nullptr;
1440}
1441
1442/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001443 * @brief Adds inventory item and associated sensor to specified vector.
1444 *
1445 * Adds a new InventoryItem to the vector if necessary. Searches for an
1446 * existing InventoryItem with the specified object path. If not found, one is
1447 * added to the vector.
1448 *
1449 * Next, the specified sensor is added to the set of sensors associated with the
1450 * InventoryItem.
1451 *
1452 * @param inventoryItems D-Bus inventory items associated with sensors.
1453 * @param invItemObjPath D-Bus object path of inventory item.
1454 * @param sensorObjPath D-Bus object path of sensor
1455 */
Ed Tanousb5a76932020-09-29 16:16:58 -07001456inline void addInventoryItem(
1457 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
1458 const std::string& invItemObjPath, const std::string& sensorObjPath)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001459{
1460 // Look for inventory item in vector
1461 InventoryItem* inventoryItem =
1462 findInventoryItem(inventoryItems, invItemObjPath);
1463
1464 // If inventory item doesn't exist in vector, add it
1465 if (inventoryItem == nullptr)
1466 {
1467 inventoryItems->emplace_back(invItemObjPath);
1468 inventoryItem = &(inventoryItems->back());
1469 }
1470
1471 // Add sensor to set of sensors associated with inventory item
1472 inventoryItem->sensors.emplace(sensorObjPath);
1473}
1474
1475/**
1476 * @brief Stores D-Bus data in the specified inventory item.
1477 *
1478 * Finds D-Bus data in the specified map of interfaces. Stores the data in the
1479 * specified InventoryItem.
1480 *
1481 * This data is later used to provide sensor property values in the JSON
1482 * response.
1483 *
1484 * @param inventoryItem Inventory item where data will be stored.
1485 * @param interfacesDict Map containing D-Bus interfaces and their properties
1486 * for the specified inventory item.
1487 */
Ed Tanous23a21a12020-07-25 04:45:05 +00001488inline void storeInventoryItemData(
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001489 InventoryItem& inventoryItem,
Ed Tanous711ac7a2021-12-20 09:34:41 -08001490 const dbus::utility::DBusInteracesMap& interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001491{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001492 // Get properties from Inventory.Item interface
Ed Tanous711ac7a2021-12-20 09:34:41 -08001493
Ed Tanous9eb808c2022-01-25 10:19:23 -08001494 for (const auto& [interface, values] : interfacesDict)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001495 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001496 if (interface == "xyz.openbmc_project.Inventory.Item")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001497 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001498 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001499 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001500 if (name == "Present")
1501 {
1502 const bool* value = std::get_if<bool>(&dbusValue);
1503 if (value != nullptr)
1504 {
1505 inventoryItem.isPresent = *value;
1506 }
1507 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001508 }
1509 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001510 // Check if Inventory.Item.PowerSupply interface is present
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001511
Ed Tanous711ac7a2021-12-20 09:34:41 -08001512 if (interface == "xyz.openbmc_project.Inventory.Item.PowerSupply")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001513 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001514 inventoryItem.isPowerSupply = true;
1515 }
1516
1517 // Get properties from Inventory.Decorator.Asset interface
1518 if (interface == "xyz.openbmc_project.Inventory.Decorator.Asset")
1519 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001520 for (const auto& [name, dbusValue] : values)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001521 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001522 if (name == "Manufacturer")
1523 {
1524 const std::string* value =
1525 std::get_if<std::string>(&dbusValue);
1526 if (value != nullptr)
1527 {
1528 inventoryItem.manufacturer = *value;
1529 }
1530 }
1531 if (name == "Model")
1532 {
1533 const std::string* value =
1534 std::get_if<std::string>(&dbusValue);
1535 if (value != nullptr)
1536 {
1537 inventoryItem.model = *value;
1538 }
1539 }
1540 if (name == "SerialNumber")
1541 {
1542 const std::string* value =
1543 std::get_if<std::string>(&dbusValue);
1544 if (value != nullptr)
1545 {
1546 inventoryItem.serialNumber = *value;
1547 }
1548 }
1549 if (name == "PartNumber")
1550 {
1551 const std::string* value =
1552 std::get_if<std::string>(&dbusValue);
1553 if (value != nullptr)
1554 {
1555 inventoryItem.partNumber = *value;
1556 }
1557 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001558 }
1559 }
1560
Ed Tanous711ac7a2021-12-20 09:34:41 -08001561 if (interface ==
1562 "xyz.openbmc_project.State.Decorator.OperationalStatus")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001563 {
Ed Tanous9eb808c2022-01-25 10:19:23 -08001564 for (const auto& [name, dbusValue] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001565 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001566 if (name == "Functional")
1567 {
1568 const bool* value = std::get_if<bool>(&dbusValue);
1569 if (value != nullptr)
1570 {
1571 inventoryItem.isFunctional = *value;
1572 }
1573 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001574 }
1575 }
1576 }
1577}
1578
1579/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001580 * @brief Gets D-Bus data for inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001581 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001582 * Uses the specified connections (services) to obtain D-Bus data for inventory
1583 * items associated with sensors. Stores the resulting data in the
1584 * inventoryItems vector.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001585 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001586 * This data is later used to provide sensor property values in the JSON
1587 * response.
1588 *
1589 * Finds the inventory item data asynchronously. Invokes callback when data has
1590 * been obtained.
1591 *
1592 * The callback must have the following signature:
1593 * @code
Anthony Wilsond5005492019-07-31 16:34:17 -05001594 * callback(void)
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001595 * @endcode
1596 *
1597 * This function is called recursively, obtaining data asynchronously from one
1598 * connection in each call. This ensures the callback is not invoked until the
1599 * last asynchronous function has completed.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001600 *
1601 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001602 * @param inventoryItems D-Bus inventory items associated with sensors.
1603 * @param invConnections Connections that provide data for the inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001604 * @param objectMgrPaths Mappings from connection name to DBus object path that
1605 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001606 * @param callback Callback to invoke when inventory data has been obtained.
1607 * @param invConnectionsIndex Current index in invConnections. Only specified
1608 * in recursive calls to this function.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001609 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001610template <typename Callback>
1611static void getInventoryItemsData(
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001612 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001613 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001614 std::shared_ptr<boost::container::flat_set<std::string>> invConnections,
1615 std::shared_ptr<boost::container::flat_map<std::string, std::string>>
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001616 objectMgrPaths,
Ed Tanous271584a2019-07-09 16:24:22 -07001617 Callback&& callback, size_t invConnectionsIndex = 0)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001618{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001619 BMCWEB_LOG_DEBUG << "getInventoryItemsData enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001620
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001621 // If no more connections left, call callback
1622 if (invConnectionsIndex >= invConnections->size())
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001623 {
Anthony Wilsond5005492019-07-31 16:34:17 -05001624 callback();
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001625 BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
1626 return;
1627 }
1628
1629 // Get inventory item data from current connection
1630 auto it = invConnections->nth(invConnectionsIndex);
1631 if (it != invConnections->end())
1632 {
1633 const std::string& invConnection = *it;
1634
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001635 // Response handler for GetManagedObjects
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001636 auto respHandler = [sensorsAsyncResp, inventoryItems, invConnections,
Ed Tanousf94c4ec2022-01-06 12:44:41 -08001637 objectMgrPaths,
1638 callback{std::forward<Callback>(callback)},
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001639 invConnectionsIndex](
1640 const boost::system::error_code ec,
Ed Tanous711ac7a2021-12-20 09:34:41 -08001641 dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001642 BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001643 if (ec)
1644 {
1645 BMCWEB_LOG_ERROR
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001646 << "getInventoryItemsData respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001647 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001648 return;
1649 }
1650
1651 // Loop through returned object paths
1652 for (const auto& objDictEntry : resp)
1653 {
1654 const std::string& objPath =
1655 static_cast<const std::string&>(objDictEntry.first);
1656
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001657 // If this object path is one of the specified inventory items
1658 InventoryItem* inventoryItem =
1659 findInventoryItem(inventoryItems, objPath);
1660 if (inventoryItem != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001661 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001662 // Store inventory data in InventoryItem
1663 storeInventoryItemData(*inventoryItem, objDictEntry.second);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001664 }
1665 }
1666
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001667 // Recurse to get inventory item data from next connection
1668 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
1669 invConnections, objectMgrPaths,
1670 std::move(callback), invConnectionsIndex + 1);
1671
1672 BMCWEB_LOG_DEBUG << "getInventoryItemsData respHandler exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001673 };
1674
1675 // Find DBus object path that implements ObjectManager for the current
1676 // connection. If no mapping found, default to "/".
1677 auto iter = objectMgrPaths->find(invConnection);
1678 const std::string& objectMgrPath =
1679 (iter != objectMgrPaths->end()) ? iter->second : "/";
1680 BMCWEB_LOG_DEBUG << "ObjectManager path for " << invConnection << " is "
1681 << objectMgrPath;
1682
1683 // Get all object paths and their interfaces for current connection
1684 crow::connections::systemBus->async_method_call(
1685 std::move(respHandler), invConnection, objectMgrPath,
1686 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1687 }
1688
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001689 BMCWEB_LOG_DEBUG << "getInventoryItemsData exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001690}
1691
1692/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001693 * @brief Gets connections that provide D-Bus data for inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001694 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001695 * Gets the D-Bus connections (services) that provide data for the inventory
1696 * items that are associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001697 *
1698 * Finds the connections asynchronously. Invokes callback when information has
1699 * been obtained.
1700 *
1701 * The callback must have the following signature:
1702 * @code
1703 * callback(std::shared_ptr<boost::container::flat_set<std::string>>
1704 * invConnections)
1705 * @endcode
1706 *
1707 * @param sensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001708 * @param inventoryItems D-Bus inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001709 * @param callback Callback to invoke when connections have been obtained.
1710 */
1711template <typename Callback>
1712static void getInventoryItemsConnections(
Ed Tanousb5a76932020-09-29 16:16:58 -07001713 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
1714 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001715 Callback&& callback)
1716{
1717 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections enter";
1718
1719 const std::string path = "/xyz/openbmc_project/inventory";
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001720 const std::array<std::string, 4> interfaces = {
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001721 "xyz.openbmc_project.Inventory.Item",
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001722 "xyz.openbmc_project.Inventory.Item.PowerSupply",
1723 "xyz.openbmc_project.Inventory.Decorator.Asset",
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001724 "xyz.openbmc_project.State.Decorator.OperationalStatus"};
1725
1726 // Response handler for parsing output from GetSubTree
Ed Tanousf94c4ec2022-01-06 12:44:41 -08001727 auto respHandler = [callback{std::forward<Callback>(callback)},
Ed Tanousb9d36b42022-02-26 21:42:46 -08001728 sensorsAsyncResp, inventoryItems](
1729 const boost::system::error_code ec,
1730 const dbus::utility::MapperGetSubTreeResponse&
1731 subtree) {
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001732 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler enter";
1733 if (ec)
1734 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001735 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001736 BMCWEB_LOG_ERROR
1737 << "getInventoryItemsConnections respHandler DBus error " << ec;
1738 return;
1739 }
1740
1741 // Make unique list of connections for desired inventory items
1742 std::shared_ptr<boost::container::flat_set<std::string>>
1743 invConnections =
1744 std::make_shared<boost::container::flat_set<std::string>>();
1745 invConnections->reserve(8);
1746
1747 // Loop through objects from GetSubTree
1748 for (const std::pair<
1749 std::string,
1750 std::vector<std::pair<std::string, std::vector<std::string>>>>&
1751 object : subtree)
1752 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001753 // Check if object path is one of the specified inventory items
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001754 const std::string& objPath = object.first;
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001755 if (findInventoryItem(inventoryItems, objPath) != nullptr)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001756 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001757 // Store all connections to inventory item
1758 for (const std::pair<std::string, std::vector<std::string>>&
1759 objData : object.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001760 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001761 const std::string& invConnection = objData.first;
1762 invConnections->insert(invConnection);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001763 }
1764 }
1765 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001766
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001767 callback(invConnections);
1768 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections respHandler exit";
1769 };
1770
1771 // Make call to ObjectMapper to find all inventory items
1772 crow::connections::systemBus->async_method_call(
1773 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
1774 "/xyz/openbmc_project/object_mapper",
1775 "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces);
1776 BMCWEB_LOG_DEBUG << "getInventoryItemsConnections exit";
1777}
1778
1779/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001780 * @brief Gets associations from sensors to inventory items.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001781 *
1782 * Looks for ObjectMapper associations from the specified sensors to related
Anthony Wilsond5005492019-07-31 16:34:17 -05001783 * inventory items. Then finds the associations from those inventory items to
1784 * their LEDs, if any.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001785 *
1786 * Finds the inventory items asynchronously. Invokes callback when information
1787 * has been obtained.
1788 *
1789 * The callback must have the following signature:
1790 * @code
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001791 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001792 * @endcode
1793 *
1794 * @param sensorsAsyncResp Pointer to object holding response data.
1795 * @param sensorNames All sensors within the current chassis.
1796 * @param objectMgrPaths Mappings from connection name to DBus object path that
1797 * implements ObjectManager.
1798 * @param callback Callback to invoke when inventory items have been obtained.
1799 */
1800template <typename Callback>
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001801static void getInventoryItemAssociations(
Ed Tanousb5a76932020-09-29 16:16:58 -07001802 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
1803 const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames,
1804 const std::shared_ptr<boost::container::flat_map<std::string, std::string>>&
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001805 objectMgrPaths,
1806 Callback&& callback)
1807{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001808 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001809
1810 // Response handler for GetManagedObjects
Ed Tanousf94c4ec2022-01-06 12:44:41 -08001811 auto respHandler = [callback{std::forward<Callback>(callback)},
1812 sensorsAsyncResp,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001813 sensorNames](const boost::system::error_code ec,
1814 dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001815 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001816 if (ec)
1817 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001818 BMCWEB_LOG_ERROR
1819 << "getInventoryItemAssociations respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08001820 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001821 return;
1822 }
1823
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001824 // Create vector to hold list of inventory items
1825 std::shared_ptr<std::vector<InventoryItem>> inventoryItems =
1826 std::make_shared<std::vector<InventoryItem>>();
1827
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001828 // Loop through returned object paths
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001829 std::string sensorAssocPath;
1830 sensorAssocPath.reserve(128); // avoid memory allocations
1831 for (const auto& objDictEntry : resp)
1832 {
1833 const std::string& objPath =
1834 static_cast<const std::string&>(objDictEntry.first);
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001835
1836 // If path is inventory association for one of the specified sensors
1837 for (const std::string& sensorName : *sensorNames)
1838 {
1839 sensorAssocPath = sensorName;
1840 sensorAssocPath += "/inventory";
1841 if (objPath == sensorAssocPath)
1842 {
1843 // Get Association interface for object path
Ed Tanous711ac7a2021-12-20 09:34:41 -08001844 for (const auto& [interface, values] : objDictEntry.second)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001845 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001846 if (interface == "xyz.openbmc_project.Association")
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001847 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001848 for (const auto& [valueName, value] : values)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001849 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001850 if (valueName == "endpoints")
1851 {
1852 const std::vector<std::string>* endpoints =
1853 std::get_if<std::vector<std::string>>(
1854 &value);
1855 if ((endpoints != nullptr) &&
1856 !endpoints->empty())
1857 {
1858 // Add inventory item to vector
1859 const std::string& invItemPath =
1860 endpoints->front();
1861 addInventoryItem(inventoryItems,
1862 invItemPath,
1863 sensorName);
1864 }
1865 }
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001866 }
1867 }
1868 }
1869 break;
1870 }
1871 }
1872 }
1873
Anthony Wilsond5005492019-07-31 16:34:17 -05001874 // Now loop through the returned object paths again, this time to
1875 // find the leds associated with the inventory items we just found
1876 std::string inventoryAssocPath;
1877 inventoryAssocPath.reserve(128); // avoid memory allocations
1878 for (const auto& objDictEntry : resp)
1879 {
1880 const std::string& objPath =
1881 static_cast<const std::string&>(objDictEntry.first);
Anthony Wilsond5005492019-07-31 16:34:17 -05001882
1883 for (InventoryItem& inventoryItem : *inventoryItems)
1884 {
1885 inventoryAssocPath = inventoryItem.objectPath;
1886 inventoryAssocPath += "/leds";
1887 if (objPath == inventoryAssocPath)
1888 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001889 for (const auto& [interface, values] : objDictEntry.second)
Anthony Wilsond5005492019-07-31 16:34:17 -05001890 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001891 if (interface == "xyz.openbmc_project.Association")
Anthony Wilsond5005492019-07-31 16:34:17 -05001892 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001893 for (const auto& [valueName, value] : values)
Anthony Wilsond5005492019-07-31 16:34:17 -05001894 {
Ed Tanous711ac7a2021-12-20 09:34:41 -08001895 if (valueName == "endpoints")
1896 {
1897 const std::vector<std::string>* endpoints =
1898 std::get_if<std::vector<std::string>>(
1899 &value);
1900 if ((endpoints != nullptr) &&
1901 !endpoints->empty())
1902 {
1903 // Add inventory item to vector
1904 // Store LED path in inventory item
1905 const std::string& ledPath =
1906 endpoints->front();
1907 inventoryItem.ledObjectPath = ledPath;
1908 }
1909 }
Anthony Wilsond5005492019-07-31 16:34:17 -05001910 }
1911 }
1912 }
Ed Tanous711ac7a2021-12-20 09:34:41 -08001913
Anthony Wilsond5005492019-07-31 16:34:17 -05001914 break;
1915 }
1916 }
1917 }
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001918 callback(inventoryItems);
1919 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations respHandler exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001920 };
1921
1922 // Find DBus object path that implements ObjectManager for ObjectMapper
1923 std::string connection = "xyz.openbmc_project.ObjectMapper";
1924 auto iter = objectMgrPaths->find(connection);
1925 const std::string& objectMgrPath =
1926 (iter != objectMgrPaths->end()) ? iter->second : "/";
1927 BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is "
1928 << objectMgrPath;
1929
1930 // Call GetManagedObjects on the ObjectMapper to get all associations
1931 crow::connections::systemBus->async_method_call(
1932 std::move(respHandler), connection, objectMgrPath,
1933 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
1934
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05001935 BMCWEB_LOG_DEBUG << "getInventoryItemAssociations exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05001936}
1937
1938/**
Anthony Wilsond5005492019-07-31 16:34:17 -05001939 * @brief Gets D-Bus data for inventory item leds associated with sensors.
1940 *
1941 * Uses the specified connections (services) to obtain D-Bus data for inventory
1942 * item leds associated with sensors. Stores the resulting data in the
1943 * inventoryItems vector.
1944 *
1945 * This data is later used to provide sensor property values in the JSON
1946 * response.
1947 *
1948 * Finds the inventory item led data asynchronously. Invokes callback when data
1949 * has been obtained.
1950 *
1951 * The callback must have the following signature:
1952 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05001953 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05001954 * @endcode
1955 *
1956 * This function is called recursively, obtaining data asynchronously from one
1957 * connection in each call. This ensures the callback is not invoked until the
1958 * last asynchronous function has completed.
1959 *
1960 * @param sensorsAsyncResp Pointer to object holding response data.
1961 * @param inventoryItems D-Bus inventory items associated with sensors.
1962 * @param ledConnections Connections that provide data for the inventory leds.
1963 * @param callback Callback to invoke when inventory data has been obtained.
1964 * @param ledConnectionsIndex Current index in ledConnections. Only specified
1965 * in recursive calls to this function.
1966 */
1967template <typename Callback>
1968void getInventoryLedData(
1969 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
1970 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
1971 std::shared_ptr<boost::container::flat_map<std::string, std::string>>
1972 ledConnections,
1973 Callback&& callback, size_t ledConnectionsIndex = 0)
1974{
1975 BMCWEB_LOG_DEBUG << "getInventoryLedData enter";
1976
1977 // If no more connections left, call callback
1978 if (ledConnectionsIndex >= ledConnections->size())
1979 {
Gunnar Mills42cbe532019-08-15 15:26:54 -05001980 callback();
Anthony Wilsond5005492019-07-31 16:34:17 -05001981 BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
1982 return;
1983 }
1984
1985 // Get inventory item data from current connection
1986 auto it = ledConnections->nth(ledConnectionsIndex);
1987 if (it != ledConnections->end())
1988 {
1989 const std::string& ledPath = (*it).first;
1990 const std::string& ledConnection = (*it).second;
1991 // Response handler for Get State property
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001992 auto respHandler =
1993 [sensorsAsyncResp, inventoryItems, ledConnections, ledPath,
Ed Tanousf94c4ec2022-01-06 12:44:41 -08001994 callback{std::forward<Callback>(callback)}, ledConnectionsIndex](
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001995 const boost::system::error_code ec, const std::string& state) {
1996 BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler enter";
1997 if (ec)
1998 {
1999 BMCWEB_LOG_ERROR
2000 << "getInventoryLedData respHandler DBus error " << ec;
2001 messages::internalError(sensorsAsyncResp->asyncResp->res);
2002 return;
2003 }
Anthony Wilsond5005492019-07-31 16:34:17 -05002004
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002005 BMCWEB_LOG_DEBUG << "Led state: " << state;
Ed Tanous168e20c2021-12-13 14:39:53 -08002006 // Find inventory item with this LED object path
2007 InventoryItem* inventoryItem =
2008 findInventoryItemForLed(*inventoryItems, ledPath);
2009 if (inventoryItem != nullptr)
Anthony Wilsond5005492019-07-31 16:34:17 -05002010 {
Ed Tanous168e20c2021-12-13 14:39:53 -08002011 // Store LED state in InventoryItem
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002012 if (boost::ends_with(state, "On"))
Anthony Wilsond5005492019-07-31 16:34:17 -05002013 {
Ed Tanous168e20c2021-12-13 14:39:53 -08002014 inventoryItem->ledState = LedState::ON;
2015 }
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002016 else if (boost::ends_with(state, "Blink"))
Ed Tanous168e20c2021-12-13 14:39:53 -08002017 {
2018 inventoryItem->ledState = LedState::BLINK;
2019 }
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002020 else if (boost::ends_with(state, "Off"))
Ed Tanous168e20c2021-12-13 14:39:53 -08002021 {
2022 inventoryItem->ledState = LedState::OFF;
2023 }
2024 else
2025 {
2026 inventoryItem->ledState = LedState::UNKNOWN;
Anthony Wilsond5005492019-07-31 16:34:17 -05002027 }
2028 }
Anthony Wilsond5005492019-07-31 16:34:17 -05002029
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002030 // Recurse to get LED data from next connection
2031 getInventoryLedData(sensorsAsyncResp, inventoryItems,
2032 ledConnections, std::move(callback),
2033 ledConnectionsIndex + 1);
Anthony Wilsond5005492019-07-31 16:34:17 -05002034
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002035 BMCWEB_LOG_DEBUG << "getInventoryLedData respHandler exit";
2036 };
Anthony Wilsond5005492019-07-31 16:34:17 -05002037
2038 // Get the State property for the current LED
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002039 sdbusplus::asio::getProperty<std::string>(
2040 *crow::connections::systemBus, ledConnection, ledPath,
2041 "xyz.openbmc_project.Led.Physical", "State",
2042 std::move(respHandler));
Anthony Wilsond5005492019-07-31 16:34:17 -05002043 }
2044
2045 BMCWEB_LOG_DEBUG << "getInventoryLedData exit";
2046}
2047
2048/**
2049 * @brief Gets LED data for LEDs associated with given inventory items.
2050 *
2051 * Gets the D-Bus connections (services) that provide LED data for the LEDs
2052 * associated with the specified inventory items. Then gets the LED data from
2053 * each connection and stores it in the inventory item.
2054 *
2055 * This data is later used to provide sensor property values in the JSON
2056 * response.
2057 *
2058 * Finds the LED data asynchronously. Invokes callback when information has
2059 * been obtained.
2060 *
2061 * The callback must have the following signature:
2062 * @code
Gunnar Mills42cbe532019-08-15 15:26:54 -05002063 * callback()
Anthony Wilsond5005492019-07-31 16:34:17 -05002064 * @endcode
2065 *
2066 * @param sensorsAsyncResp Pointer to object holding response data.
2067 * @param inventoryItems D-Bus inventory items associated with sensors.
2068 * @param callback Callback to invoke when inventory items have been obtained.
2069 */
2070template <typename Callback>
2071void getInventoryLeds(
2072 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2073 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
2074 Callback&& callback)
2075{
2076 BMCWEB_LOG_DEBUG << "getInventoryLeds enter";
2077
2078 const std::string path = "/xyz/openbmc_project";
2079 const std::array<std::string, 1> interfaces = {
2080 "xyz.openbmc_project.Led.Physical"};
2081
2082 // Response handler for parsing output from GetSubTree
Ed Tanousf94c4ec2022-01-06 12:44:41 -08002083 auto respHandler = [callback{std::forward<Callback>(callback)},
Ed Tanousb9d36b42022-02-26 21:42:46 -08002084 sensorsAsyncResp, inventoryItems](
2085 const boost::system::error_code ec,
2086 const dbus::utility::MapperGetSubTreeResponse&
2087 subtree) {
Anthony Wilsond5005492019-07-31 16:34:17 -05002088 BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler enter";
2089 if (ec)
2090 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002091 messages::internalError(sensorsAsyncResp->asyncResp->res);
Anthony Wilsond5005492019-07-31 16:34:17 -05002092 BMCWEB_LOG_ERROR << "getInventoryLeds respHandler DBus error "
2093 << ec;
2094 return;
2095 }
2096
2097 // Build map of LED object paths to connections
2098 std::shared_ptr<boost::container::flat_map<std::string, std::string>>
2099 ledConnections = std::make_shared<
2100 boost::container::flat_map<std::string, std::string>>();
2101
2102 // Loop through objects from GetSubTree
2103 for (const std::pair<
2104 std::string,
2105 std::vector<std::pair<std::string, std::vector<std::string>>>>&
2106 object : subtree)
2107 {
2108 // Check if object path is LED for one of the specified inventory
2109 // items
2110 const std::string& ledPath = object.first;
2111 if (findInventoryItemForLed(*inventoryItems, ledPath) != nullptr)
2112 {
2113 // Add mapping from ledPath to connection
2114 const std::string& connection = object.second.begin()->first;
2115 (*ledConnections)[ledPath] = connection;
2116 BMCWEB_LOG_DEBUG << "Added mapping " << ledPath << " -> "
2117 << connection;
2118 }
2119 }
2120
2121 getInventoryLedData(sensorsAsyncResp, inventoryItems, ledConnections,
2122 std::move(callback));
2123 BMCWEB_LOG_DEBUG << "getInventoryLeds respHandler exit";
2124 };
2125 // Make call to ObjectMapper to find all inventory items
2126 crow::connections::systemBus->async_method_call(
2127 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
2128 "/xyz/openbmc_project/object_mapper",
2129 "xyz.openbmc_project.ObjectMapper", "GetSubTree", path, 0, interfaces);
2130 BMCWEB_LOG_DEBUG << "getInventoryLeds exit";
2131}
2132
2133/**
Gunnar Mills42cbe532019-08-15 15:26:54 -05002134 * @brief Gets D-Bus data for Power Supply Attributes such as EfficiencyPercent
2135 *
2136 * Uses the specified connections (services) (currently assumes just one) to
2137 * obtain D-Bus data for Power Supply Attributes. Stores the resulting data in
2138 * the inventoryItems vector. Only stores data in Power Supply inventoryItems.
2139 *
2140 * This data is later used to provide sensor property values in the JSON
2141 * response.
2142 *
2143 * Finds the Power Supply Attributes data asynchronously. Invokes callback
2144 * when data has been obtained.
2145 *
2146 * The callback must have the following signature:
2147 * @code
2148 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2149 * @endcode
2150 *
2151 * @param sensorsAsyncResp Pointer to object holding response data.
2152 * @param inventoryItems D-Bus inventory items associated with sensors.
2153 * @param psAttributesConnections Connections that provide data for the Power
2154 * Supply Attributes
2155 * @param callback Callback to invoke when data has been obtained.
2156 */
2157template <typename Callback>
2158void getPowerSupplyAttributesData(
Ed Tanousb5a76932020-09-29 16:16:58 -07002159 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Gunnar Mills42cbe532019-08-15 15:26:54 -05002160 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
2161 const boost::container::flat_map<std::string, std::string>&
2162 psAttributesConnections,
2163 Callback&& callback)
2164{
2165 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData enter";
2166
2167 if (psAttributesConnections.empty())
2168 {
2169 BMCWEB_LOG_DEBUG << "Can't find PowerSupplyAttributes, no connections!";
2170 callback(inventoryItems);
2171 return;
2172 }
2173
2174 // Assuming just one connection (service) for now
2175 auto it = psAttributesConnections.nth(0);
2176
2177 const std::string& psAttributesPath = (*it).first;
2178 const std::string& psAttributesConnection = (*it).second;
2179
2180 // Response handler for Get DeratingFactor property
2181 auto respHandler = [sensorsAsyncResp, inventoryItems,
Ed Tanousf94c4ec2022-01-06 12:44:41 -08002182 callback{std::forward<Callback>(callback)}](
Gunnar Mills42cbe532019-08-15 15:26:54 -05002183 const boost::system::error_code ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002184 const uint32_t value) {
Gunnar Mills42cbe532019-08-15 15:26:54 -05002185 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler enter";
2186 if (ec)
2187 {
2188 BMCWEB_LOG_ERROR
2189 << "getPowerSupplyAttributesData respHandler DBus error " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08002190 messages::internalError(sensorsAsyncResp->asyncResp->res);
Gunnar Mills42cbe532019-08-15 15:26:54 -05002191 return;
2192 }
2193
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002194 BMCWEB_LOG_DEBUG << "PS EfficiencyPercent value: " << value;
2195 // Store value in Power Supply Inventory Items
2196 for (InventoryItem& inventoryItem : *inventoryItems)
Gunnar Mills42cbe532019-08-15 15:26:54 -05002197 {
Ed Tanous55f79e62022-01-25 11:26:16 -08002198 if (inventoryItem.isPowerSupply)
Gunnar Mills42cbe532019-08-15 15:26:54 -05002199 {
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002200 inventoryItem.powerSupplyEfficiencyPercent =
2201 static_cast<int>(value);
Gunnar Mills42cbe532019-08-15 15:26:54 -05002202 }
2203 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002204
2205 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData respHandler exit";
2206 callback(inventoryItems);
2207 };
2208
2209 // Get the DeratingFactor property for the PowerSupplyAttributes
2210 // Currently only property on the interface/only one we care about
Jonathan Doman1e1e5982021-06-11 09:36:17 -07002211 sdbusplus::asio::getProperty<uint32_t>(
2212 *crow::connections::systemBus, psAttributesConnection, psAttributesPath,
2213 "xyz.openbmc_project.Control.PowerSupplyAttributes", "DeratingFactor",
2214 std::move(respHandler));
Gunnar Mills42cbe532019-08-15 15:26:54 -05002215
2216 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributesData exit";
2217}
2218
2219/**
2220 * @brief Gets the Power Supply Attributes such as EfficiencyPercent
2221 *
2222 * Gets the D-Bus connection (service) that provides Power Supply Attributes
2223 * data. Then gets the Power Supply Attributes data from the connection
2224 * (currently just assumes 1 connection) and stores the data in the inventory
2225 * item.
2226 *
2227 * This data is later used to provide sensor property values in the JSON
2228 * response. DeratingFactor on D-Bus is mapped to EfficiencyPercent on Redfish.
2229 *
2230 * Finds the Power Supply Attributes data asynchronously. Invokes callback
2231 * when information has been obtained.
2232 *
2233 * The callback must have the following signature:
2234 * @code
2235 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2236 * @endcode
2237 *
2238 * @param sensorsAsyncResp Pointer to object holding response data.
2239 * @param inventoryItems D-Bus inventory items associated with sensors.
2240 * @param callback Callback to invoke when data has been obtained.
2241 */
2242template <typename Callback>
2243void getPowerSupplyAttributes(
2244 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2245 std::shared_ptr<std::vector<InventoryItem>> inventoryItems,
2246 Callback&& callback)
2247{
2248 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes enter";
2249
2250 // Only need the power supply attributes when the Power Schema
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002251 if (sensorsAsyncResp->chassisSubNode != sensors::node::power)
Gunnar Mills42cbe532019-08-15 15:26:54 -05002252 {
2253 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit since not Power";
2254 callback(inventoryItems);
2255 return;
2256 }
2257
2258 const std::array<std::string, 1> interfaces = {
2259 "xyz.openbmc_project.Control.PowerSupplyAttributes"};
2260
2261 // Response handler for parsing output from GetSubTree
Ed Tanousb9d36b42022-02-26 21:42:46 -08002262 auto respHandler =
2263 [callback{std::forward<Callback>(callback)}, sensorsAsyncResp,
2264 inventoryItems](
2265 const boost::system::error_code ec,
2266 const dbus::utility::MapperGetSubTreeResponse& subtree) {
2267 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler enter";
2268 if (ec)
2269 {
2270 messages::internalError(sensorsAsyncResp->asyncResp->res);
2271 BMCWEB_LOG_ERROR
2272 << "getPowerSupplyAttributes respHandler DBus error " << ec;
2273 return;
2274 }
2275 if (subtree.empty())
2276 {
2277 BMCWEB_LOG_DEBUG << "Can't find Power Supply Attributes!";
2278 callback(inventoryItems);
2279 return;
2280 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002281
Ed Tanousb9d36b42022-02-26 21:42:46 -08002282 // Currently we only support 1 power supply attribute, use this for
2283 // all the power supplies. Build map of object path to connection.
2284 // Assume just 1 connection and 1 path for now.
2285 boost::container::flat_map<std::string, std::string>
2286 psAttributesConnections;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002287
Ed Tanousb9d36b42022-02-26 21:42:46 -08002288 if (subtree[0].first.empty() || subtree[0].second.empty())
2289 {
2290 BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
2291 callback(inventoryItems);
2292 return;
2293 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002294
Ed Tanousb9d36b42022-02-26 21:42:46 -08002295 const std::string& psAttributesPath = subtree[0].first;
2296 const std::string& connection = subtree[0].second.begin()->first;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002297
Ed Tanousb9d36b42022-02-26 21:42:46 -08002298 if (connection.empty())
2299 {
2300 BMCWEB_LOG_DEBUG << "Power Supply Attributes mapper error!";
2301 callback(inventoryItems);
2302 return;
2303 }
Gunnar Mills42cbe532019-08-15 15:26:54 -05002304
Ed Tanousb9d36b42022-02-26 21:42:46 -08002305 psAttributesConnections[psAttributesPath] = connection;
2306 BMCWEB_LOG_DEBUG << "Added mapping " << psAttributesPath << " -> "
2307 << connection;
Gunnar Mills42cbe532019-08-15 15:26:54 -05002308
Ed Tanousb9d36b42022-02-26 21:42:46 -08002309 getPowerSupplyAttributesData(sensorsAsyncResp, inventoryItems,
2310 psAttributesConnections,
2311 std::move(callback));
2312 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes respHandler exit";
2313 };
Gunnar Mills42cbe532019-08-15 15:26:54 -05002314 // Make call to ObjectMapper to find the PowerSupplyAttributes service
2315 crow::connections::systemBus->async_method_call(
2316 std::move(respHandler), "xyz.openbmc_project.ObjectMapper",
2317 "/xyz/openbmc_project/object_mapper",
2318 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
2319 "/xyz/openbmc_project", 0, interfaces);
2320 BMCWEB_LOG_DEBUG << "getPowerSupplyAttributes exit";
2321}
2322
2323/**
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002324 * @brief Gets inventory items associated with sensors.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002325 *
2326 * Finds the inventory items that are associated with the specified sensors.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002327 * Then gets D-Bus data for the inventory items, such as presence and VPD.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002328 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002329 * This data is later used to provide sensor property values in the JSON
2330 * response.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002331 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002332 * Finds the inventory items asynchronously. Invokes callback when the
2333 * inventory items have been obtained.
2334 *
2335 * The callback must have the following signature:
2336 * @code
2337 * callback(std::shared_ptr<std::vector<InventoryItem>> inventoryItems)
2338 * @endcode
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002339 *
2340 * @param sensorsAsyncResp Pointer to object holding response data.
2341 * @param sensorNames All sensors within the current chassis.
2342 * @param objectMgrPaths Mappings from connection name to DBus object path that
2343 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002344 * @param callback Callback to invoke when inventory items have been obtained.
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002345 */
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002346template <typename Callback>
2347static void getInventoryItems(
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002348 std::shared_ptr<SensorsAsyncResp> sensorsAsyncResp,
2349 const std::shared_ptr<boost::container::flat_set<std::string>> sensorNames,
2350 std::shared_ptr<boost::container::flat_map<std::string, std::string>>
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002351 objectMgrPaths,
2352 Callback&& callback)
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002353{
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002354 BMCWEB_LOG_DEBUG << "getInventoryItems enter";
2355 auto getInventoryItemAssociationsCb =
Ed Tanousf94c4ec2022-01-06 12:44:41 -08002356 [sensorsAsyncResp, objectMgrPaths,
2357 callback{std::forward<Callback>(callback)}](
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002358 std::shared_ptr<std::vector<InventoryItem>> inventoryItems) {
2359 BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb enter";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002360 auto getInventoryItemsConnectionsCb =
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002361 [sensorsAsyncResp, inventoryItems, objectMgrPaths,
Ed Tanousf94c4ec2022-01-06 12:44:41 -08002362 callback{std::forward<const Callback>(callback)}](
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002363 std::shared_ptr<boost::container::flat_set<std::string>>
2364 invConnections) {
2365 BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb enter";
Anthony Wilsond5005492019-07-31 16:34:17 -05002366 auto getInventoryItemsDataCb =
2367 [sensorsAsyncResp, inventoryItems,
2368 callback{std::move(callback)}]() {
2369 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb enter";
Gunnar Mills42cbe532019-08-15 15:26:54 -05002370
2371 auto getInventoryLedsCb = [sensorsAsyncResp,
2372 inventoryItems,
2373 callback{std::move(
2374 callback)}]() {
2375 BMCWEB_LOG_DEBUG << "getInventoryLedsCb enter";
2376 // Find Power Supply Attributes and get the data
2377 getPowerSupplyAttributes(sensorsAsyncResp,
2378 inventoryItems,
2379 std::move(callback));
2380 BMCWEB_LOG_DEBUG << "getInventoryLedsCb exit";
2381 };
2382
Anthony Wilsond5005492019-07-31 16:34:17 -05002383 // Find led connections and get the data
2384 getInventoryLeds(sensorsAsyncResp, inventoryItems,
Gunnar Mills42cbe532019-08-15 15:26:54 -05002385 std::move(getInventoryLedsCb));
Anthony Wilsond5005492019-07-31 16:34:17 -05002386 BMCWEB_LOG_DEBUG << "getInventoryItemsDataCb exit";
2387 };
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002388
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002389 // Get inventory item data from connections
2390 getInventoryItemsData(sensorsAsyncResp, inventoryItems,
2391 invConnections, objectMgrPaths,
Anthony Wilsond5005492019-07-31 16:34:17 -05002392 std::move(getInventoryItemsDataCb));
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002393 BMCWEB_LOG_DEBUG << "getInventoryItemsConnectionsCb exit";
2394 };
2395
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002396 // Get connections that provide inventory item data
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002397 getInventoryItemsConnections(
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002398 sensorsAsyncResp, inventoryItems,
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002399 std::move(getInventoryItemsConnectionsCb));
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002400 BMCWEB_LOG_DEBUG << "getInventoryItemAssociationsCb exit";
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002401 };
2402
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002403 // Get associations from sensors to inventory items
2404 getInventoryItemAssociations(sensorsAsyncResp, sensorNames, objectMgrPaths,
2405 std::move(getInventoryItemAssociationsCb));
2406 BMCWEB_LOG_DEBUG << "getInventoryItems exit";
2407}
2408
2409/**
2410 * @brief Returns JSON PowerSupply object for the specified inventory item.
2411 *
2412 * Searches for a JSON PowerSupply object that matches the specified inventory
2413 * item. If one is not found, a new PowerSupply object is added to the JSON
2414 * array.
2415 *
2416 * Multiple sensors are often associated with one power supply inventory item.
2417 * As a result, multiple sensor values are stored in one JSON PowerSupply
2418 * object.
2419 *
2420 * @param powerSupplyArray JSON array containing Redfish PowerSupply objects.
2421 * @param inventoryItem Inventory item for the power supply.
2422 * @param chassisId Chassis that contains the power supply.
2423 * @return JSON PowerSupply object for the specified inventory item.
2424 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002425inline nlohmann::json& getPowerSupply(nlohmann::json& powerSupplyArray,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002426 const InventoryItem& inventoryItem,
2427 const std::string& chassisId)
2428{
2429 // Check if matching PowerSupply object already exists in JSON array
2430 for (nlohmann::json& powerSupply : powerSupplyArray)
2431 {
2432 if (powerSupply["MemberId"] == inventoryItem.name)
2433 {
2434 return powerSupply;
2435 }
2436 }
2437
2438 // Add new PowerSupply object to JSON array
2439 powerSupplyArray.push_back({});
2440 nlohmann::json& powerSupply = powerSupplyArray.back();
2441 powerSupply["@odata.id"] =
2442 "/redfish/v1/Chassis/" + chassisId + "/Power#/PowerSupplies/";
2443 powerSupply["MemberId"] = inventoryItem.name;
2444 powerSupply["Name"] = boost::replace_all_copy(inventoryItem.name, "_", " ");
2445 powerSupply["Manufacturer"] = inventoryItem.manufacturer;
2446 powerSupply["Model"] = inventoryItem.model;
2447 powerSupply["PartNumber"] = inventoryItem.partNumber;
2448 powerSupply["SerialNumber"] = inventoryItem.serialNumber;
Anthony Wilsond5005492019-07-31 16:34:17 -05002449 setLedState(powerSupply, &inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002450
Gunnar Mills42cbe532019-08-15 15:26:54 -05002451 if (inventoryItem.powerSupplyEfficiencyPercent >= 0)
2452 {
2453 powerSupply["EfficiencyPercent"] =
2454 inventoryItem.powerSupplyEfficiencyPercent;
2455 }
2456
2457 powerSupply["Status"]["State"] = getState(&inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002458 const char* health = inventoryItem.isFunctional ? "OK" : "Critical";
2459 powerSupply["Status"]["Health"] = health;
2460
2461 return powerSupply;
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002462}
2463
2464/**
Shawn McCarneyde629b62019-03-08 10:42:51 -06002465 * @brief Gets the values of the specified sensors.
2466 *
2467 * Stores the results as JSON in the SensorsAsyncResp.
2468 *
2469 * Gets the sensor values asynchronously. Stores the results later when the
2470 * information has been obtained.
2471 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002472 * The sensorNames set contains all requested sensors for the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002473 *
2474 * To minimize the number of DBus calls, the DBus method
2475 * org.freedesktop.DBus.ObjectManager.GetManagedObjects() is used to get the
2476 * values of all sensors provided by a connection (service).
2477 *
2478 * The connections set contains all the connections that provide sensor values.
2479 *
2480 * The objectMgrPaths map contains mappings from a connection name to the
2481 * corresponding DBus object path that implements ObjectManager.
2482 *
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002483 * The InventoryItem vector contains D-Bus inventory items associated with the
2484 * sensors. Inventory item data is needed for some Redfish sensor properties.
2485 *
Shawn McCarneyde629b62019-03-08 10:42:51 -06002486 * @param SensorsAsyncResp Pointer to object holding response data.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002487 * @param sensorNames All requested sensors within the current chassis.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002488 * @param connections Connections that provide sensor values.
2489 * @param objectMgrPaths Mappings from connection name to DBus object path that
2490 * implements ObjectManager.
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002491 * @param inventoryItems Inventory items associated with the sensors.
Shawn McCarneyde629b62019-03-08 10:42:51 -06002492 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002493inline void getSensorData(
Ed Tanous81ce6092020-12-17 16:54:55 +00002494 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Ed Tanousb5a76932020-09-29 16:16:58 -07002495 const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames,
Shawn McCarneyde629b62019-03-08 10:42:51 -06002496 const boost::container::flat_set<std::string>& connections,
Ed Tanousb5a76932020-09-29 16:16:58 -07002497 const std::shared_ptr<boost::container::flat_map<std::string, std::string>>&
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002498 objectMgrPaths,
Ed Tanousb5a76932020-09-29 16:16:58 -07002499 const std::shared_ptr<std::vector<InventoryItem>>& inventoryItems)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002500{
2501 BMCWEB_LOG_DEBUG << "getSensorData enter";
2502 // Get managed objects from all services exposing sensors
2503 for (const std::string& connection : connections)
2504 {
2505 // Response handler to process managed objects
Ed Tanous81ce6092020-12-17 16:54:55 +00002506 auto getManagedObjectsCb = [sensorsAsyncResp, sensorNames,
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002507 inventoryItems](
Shawn McCarneyde629b62019-03-08 10:42:51 -06002508 const boost::system::error_code ec,
Ed Tanous711ac7a2021-12-20 09:34:41 -08002509 dbus::utility::ManagedObjectType& resp) {
Shawn McCarneyde629b62019-03-08 10:42:51 -06002510 BMCWEB_LOG_DEBUG << "getManagedObjectsCb enter";
2511 if (ec)
2512 {
2513 BMCWEB_LOG_ERROR << "getManagedObjectsCb DBUS error: " << ec;
zhanghch058d1b46d2021-04-01 11:18:24 +08002514 messages::internalError(sensorsAsyncResp->asyncResp->res);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002515 return;
2516 }
2517 // Go through all objects and update response with sensor data
2518 for (const auto& objDictEntry : resp)
2519 {
2520 const std::string& objPath =
2521 static_cast<const std::string&>(objDictEntry.first);
2522 BMCWEB_LOG_DEBUG << "getManagedObjectsCb parsing object "
2523 << objPath;
2524
Shawn McCarneyde629b62019-03-08 10:42:51 -06002525 std::vector<std::string> split;
2526 // Reserve space for
2527 // /xyz/openbmc_project/sensors/<name>/<subname>
2528 split.reserve(6);
2529 boost::algorithm::split(split, objPath, boost::is_any_of("/"));
2530 if (split.size() < 6)
2531 {
2532 BMCWEB_LOG_ERROR << "Got path that isn't long enough "
2533 << objPath;
2534 continue;
2535 }
2536 // These indexes aren't intuitive, as boost::split puts an empty
2537 // string at the beginning
2538 const std::string& sensorType = split[4];
2539 const std::string& sensorName = split[5];
2540 BMCWEB_LOG_DEBUG << "sensorName " << sensorName
2541 << " sensorType " << sensorType;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002542 if (sensorNames->find(objPath) == sensorNames->end())
Shawn McCarneyde629b62019-03-08 10:42:51 -06002543 {
Andrew Geissleraccdbb22021-11-09 15:24:45 -06002544 BMCWEB_LOG_DEBUG << sensorName << " not in sensor list ";
Shawn McCarneyde629b62019-03-08 10:42:51 -06002545 continue;
2546 }
2547
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002548 // Find inventory item (if any) associated with sensor
2549 InventoryItem* inventoryItem =
2550 findInventoryItemForSensor(inventoryItems, objPath);
2551
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002552 const std::string& sensorSchema =
Ed Tanous81ce6092020-12-17 16:54:55 +00002553 sensorsAsyncResp->chassisSubNode;
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002554
2555 nlohmann::json* sensorJson = nullptr;
2556
Nan Zhou928fefb2022-03-28 08:45:00 -07002557 if (sensorSchema == sensors::node::sensors &&
2558 !sensorsAsyncResp->efficientExpand)
Shawn McCarneyde629b62019-03-08 10:42:51 -06002559 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002560 sensorsAsyncResp->asyncResp->res.jsonValue["@odata.id"] =
Ed Tanous81ce6092020-12-17 16:54:55 +00002561 "/redfish/v1/Chassis/" + sensorsAsyncResp->chassisId +
2562 "/" + sensorsAsyncResp->chassisSubNode + "/" +
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002563 sensorName;
zhanghch058d1b46d2021-04-01 11:18:24 +08002564 sensorJson = &(sensorsAsyncResp->asyncResp->res.jsonValue);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002565 }
2566 else
2567 {
Ed Tanous271584a2019-07-09 16:24:22 -07002568 std::string fieldName;
Nan Zhou928fefb2022-03-28 08:45:00 -07002569 if (sensorsAsyncResp->efficientExpand)
2570 {
2571 fieldName = "Members";
2572 }
2573 else if (sensorType == "temperature")
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002574 {
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002575 fieldName = "Temperatures";
2576 }
2577 else if (sensorType == "fan" || sensorType == "fan_tach" ||
2578 sensorType == "fan_pwm")
2579 {
2580 fieldName = "Fans";
2581 }
2582 else if (sensorType == "voltage")
2583 {
2584 fieldName = "Voltages";
2585 }
2586 else if (sensorType == "power")
2587 {
Ed Tanous55f79e62022-01-25 11:26:16 -08002588 if (sensorName == "total_power")
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002589 {
2590 fieldName = "PowerControl";
2591 }
2592 else if ((inventoryItem != nullptr) &&
2593 (inventoryItem->isPowerSupply))
2594 {
2595 fieldName = "PowerSupplies";
2596 }
2597 else
2598 {
2599 // Other power sensors are in SensorCollection
2600 continue;
2601 }
2602 }
2603 else
2604 {
2605 BMCWEB_LOG_ERROR << "Unsure how to handle sensorType "
2606 << sensorType;
2607 continue;
2608 }
2609
2610 nlohmann::json& tempArray =
zhanghch058d1b46d2021-04-01 11:18:24 +08002611 sensorsAsyncResp->asyncResp->res.jsonValue[fieldName];
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002612 if (fieldName == "PowerControl")
2613 {
2614 if (tempArray.empty())
2615 {
2616 // Put multiple "sensors" into a single
2617 // PowerControl. Follows MemberId naming and
2618 // naming in power.hpp.
2619 tempArray.push_back(
2620 {{"@odata.id",
2621 "/redfish/v1/Chassis/" +
Ed Tanous81ce6092020-12-17 16:54:55 +00002622 sensorsAsyncResp->chassisId + "/" +
2623 sensorsAsyncResp->chassisSubNode + "#/" +
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002624 fieldName + "/0"}});
2625 }
2626 sensorJson = &(tempArray.back());
2627 }
2628 else if (fieldName == "PowerSupplies")
2629 {
2630 if (inventoryItem != nullptr)
2631 {
2632 sensorJson =
2633 &(getPowerSupply(tempArray, *inventoryItem,
Ed Tanous81ce6092020-12-17 16:54:55 +00002634 sensorsAsyncResp->chassisId));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002635 }
2636 }
Nan Zhou928fefb2022-03-28 08:45:00 -07002637 else if (fieldName == "Members")
2638 {
2639 tempArray.push_back(
2640 {{"@odata.id",
2641 "/redfish/v1/Chassis/" +
2642 sensorsAsyncResp->chassisId + "/" +
2643 sensorsAsyncResp->chassisSubNode + "/" +
2644 sensorName}});
2645 sensorJson = &(tempArray.back());
2646 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002647 else
2648 {
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002649 tempArray.push_back(
2650 {{"@odata.id",
2651 "/redfish/v1/Chassis/" +
Ed Tanous81ce6092020-12-17 16:54:55 +00002652 sensorsAsyncResp->chassisId + "/" +
2653 sensorsAsyncResp->chassisSubNode + "#/" +
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002654 fieldName + "/"}});
2655 sensorJson = &(tempArray.back());
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002656 }
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002657 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002658
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002659 if (sensorJson != nullptr)
2660 {
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002661 objectInterfacesToJson(
Ed Tanous81ce6092020-12-17 16:54:55 +00002662 sensorName, sensorType, sensorsAsyncResp,
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002663 objDictEntry.second, *sensorJson, inventoryItem);
Shawn McCarneyadc4f0d2019-07-24 09:21:50 -05002664 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002665 }
Ed Tanous81ce6092020-12-17 16:54:55 +00002666 if (sensorsAsyncResp.use_count() == 1)
James Feist8bd25cc2019-03-15 15:14:00 -07002667 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002668 sortJSONResponse(sensorsAsyncResp);
Nan Zhou928fefb2022-03-28 08:45:00 -07002669 if (sensorsAsyncResp->chassisSubNode ==
2670 sensors::node::sensors &&
2671 sensorsAsyncResp->efficientExpand)
2672 {
2673 sensorsAsyncResp->asyncResp->res
2674 .jsonValue["Members@odata.count"] =
2675 sensorsAsyncResp->asyncResp->res.jsonValue["Members"]
2676 .size();
2677 }
2678 else if (sensorsAsyncResp->chassisSubNode ==
2679 sensors::node::thermal)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002680 {
Ed Tanous81ce6092020-12-17 16:54:55 +00002681 populateFanRedundancy(sensorsAsyncResp);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002682 }
James Feist8bd25cc2019-03-15 15:14:00 -07002683 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002684 BMCWEB_LOG_DEBUG << "getManagedObjectsCb exit";
2685 };
2686
2687 // Find DBus object path that implements ObjectManager for the current
2688 // connection. If no mapping found, default to "/".
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002689 auto iter = objectMgrPaths->find(connection);
Shawn McCarneyde629b62019-03-08 10:42:51 -06002690 const std::string& objectMgrPath =
Shawn McCarney8fb49dd2019-06-12 17:47:00 -05002691 (iter != objectMgrPaths->end()) ? iter->second : "/";
Shawn McCarneyde629b62019-03-08 10:42:51 -06002692 BMCWEB_LOG_DEBUG << "ObjectManager path for " << connection << " is "
2693 << objectMgrPath;
2694
2695 crow::connections::systemBus->async_method_call(
2696 getManagedObjectsCb, connection, objectMgrPath,
2697 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
Ed Tanous23a21a12020-07-25 04:45:05 +00002698 }
Shawn McCarneyde629b62019-03-08 10:42:51 -06002699 BMCWEB_LOG_DEBUG << "getSensorData exit";
2700}
2701
Ed Tanous23a21a12020-07-25 04:45:05 +00002702inline void processSensorList(
Ed Tanous81ce6092020-12-17 16:54:55 +00002703 const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp,
Ed Tanousb5a76932020-09-29 16:16:58 -07002704 const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002705{
2706 auto getConnectionCb =
Ed Tanous81ce6092020-12-17 16:54:55 +00002707 [sensorsAsyncResp, sensorNames](
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002708 const boost::container::flat_set<std::string>& connections) {
2709 BMCWEB_LOG_DEBUG << "getConnectionCb enter";
2710 auto getObjectManagerPathsCb =
Ed Tanous81ce6092020-12-17 16:54:55 +00002711 [sensorsAsyncResp, sensorNames,
Ed Tanousb5a76932020-09-29 16:16:58 -07002712 connections](const std::shared_ptr<boost::container::flat_map<
2713 std::string, std::string>>& objectMgrPaths) {
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002714 BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb enter";
2715 auto getInventoryItemsCb =
Ed Tanous81ce6092020-12-17 16:54:55 +00002716 [sensorsAsyncResp, sensorNames, connections,
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002717 objectMgrPaths](
Ed Tanousf23b7292020-10-15 09:41:17 -07002718 const std::shared_ptr<std::vector<InventoryItem>>&
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002719 inventoryItems) {
2720 BMCWEB_LOG_DEBUG << "getInventoryItemsCb enter";
2721 // Get sensor data and store results in JSON
Ed Tanous81ce6092020-12-17 16:54:55 +00002722 getSensorData(sensorsAsyncResp, sensorNames,
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002723 connections, objectMgrPaths,
Ed Tanousf23b7292020-10-15 09:41:17 -07002724 inventoryItems);
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002725 BMCWEB_LOG_DEBUG << "getInventoryItemsCb exit";
2726 };
2727
2728 // Get inventory items associated with sensors
Ed Tanous81ce6092020-12-17 16:54:55 +00002729 getInventoryItems(sensorsAsyncResp, sensorNames,
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002730 objectMgrPaths,
2731 std::move(getInventoryItemsCb));
2732
2733 BMCWEB_LOG_DEBUG << "getObjectManagerPathsCb exit";
2734 };
2735
2736 // Get mapping from connection names to the DBus object
2737 // paths that implement the ObjectManager interface
Ed Tanous81ce6092020-12-17 16:54:55 +00002738 getObjectManagerPaths(sensorsAsyncResp,
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002739 std::move(getObjectManagerPathsCb));
2740 BMCWEB_LOG_DEBUG << "getConnectionCb exit";
2741 };
2742
2743 // Get set of connections that provide sensor values
Ed Tanous81ce6092020-12-17 16:54:55 +00002744 getConnections(sensorsAsyncResp, sensorNames, std::move(getConnectionCb));
Anthony Wilson95a3eca2019-06-11 10:44:47 -05002745}
2746
Shawn McCarneyde629b62019-03-08 10:42:51 -06002747/**
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002748 * @brief Entry point for retrieving sensors data related to requested
2749 * chassis.
Kowalski, Kamil588c3f02018-04-03 14:55:27 +02002750 * @param SensorsAsyncResp Pointer to object holding response data
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002751 */
Ed Tanousb5a76932020-09-29 16:16:58 -07002752inline void
Ed Tanous81ce6092020-12-17 16:54:55 +00002753 getChassisData(const std::shared_ptr<SensorsAsyncResp>& sensorsAsyncResp)
Ed Tanous1abe55e2018-09-05 08:30:59 -07002754{
2755 BMCWEB_LOG_DEBUG << "getChassisData enter";
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002756 auto getChassisCb =
Ed Tanous81ce6092020-12-17 16:54:55 +00002757 [sensorsAsyncResp](
Ed Tanousf23b7292020-10-15 09:41:17 -07002758 const std::shared_ptr<boost::container::flat_set<std::string>>&
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002759 sensorNames) {
2760 BMCWEB_LOG_DEBUG << "getChassisCb enter";
Ed Tanous81ce6092020-12-17 16:54:55 +00002761 processSensorList(sensorsAsyncResp, sensorNames);
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002762 BMCWEB_LOG_DEBUG << "getChassisCb exit";
2763 };
Nan Zhou928fefb2022-03-28 08:45:00 -07002764 // SensorCollection doesn't contain the Redundancy property
2765 if (sensorsAsyncResp->chassisSubNode != sensors::node::sensors)
2766 {
2767 sensorsAsyncResp->asyncResp->res.jsonValue["Redundancy"] =
2768 nlohmann::json::array();
2769 }
Shawn McCarney26f03892019-05-03 13:20:24 -05002770 // Get set of sensors in chassis
Ed Tanous81ce6092020-12-17 16:54:55 +00002771 getChassis(sensorsAsyncResp, std::move(getChassisCb));
Ed Tanous1abe55e2018-09-05 08:30:59 -07002772 BMCWEB_LOG_DEBUG << "getChassisData exit";
Ed Tanous271584a2019-07-09 16:24:22 -07002773}
Lewanczyk, Dawid08777fb2018-03-22 23:33:49 +01002774
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302775/**
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002776 * @brief Find the requested sensorName in the list of all sensors supplied by
2777 * the chassis node
2778 *
2779 * @param sensorName The sensor name supplied in the PATCH request
2780 * @param sensorsList The list of sensors managed by the chassis node
2781 * @param sensorsModified The list of sensors that were found as a result of
2782 * repeated calls to this function
2783 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002784inline bool findSensorNameUsingSensorPath(
Richard Marian Thomaiyar0a86feb2019-05-27 23:16:40 +05302785 std::string_view sensorName,
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002786 boost::container::flat_set<std::string>& sensorsList,
2787 boost::container::flat_set<std::string>& sensorsModified)
2788{
George Liu28aa8de2021-02-01 15:13:30 +08002789 for (auto& chassisSensor : sensorsList)
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002790 {
George Liu28aa8de2021-02-01 15:13:30 +08002791 sdbusplus::message::object_path path(chassisSensor);
Ed Tanousb00dcc22021-02-23 12:52:50 -08002792 std::string thisSensorName = path.filename();
George Liu28aa8de2021-02-01 15:13:30 +08002793 if (thisSensorName.empty())
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002794 {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002795 continue;
2796 }
2797 if (thisSensorName == sensorName)
2798 {
2799 sensorsModified.emplace(chassisSensor);
2800 return true;
2801 }
2802 }
2803 return false;
2804}
2805
2806/**
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302807 * @brief Entry point for overriding sensor values of given sensor
2808 *
zhanghch058d1b46d2021-04-01 11:18:24 +08002809 * @param sensorAsyncResp response object
Carol Wang4bb3dc32019-10-17 18:15:02 +08002810 * @param allCollections Collections extract from sensors' request patch info
jayaprakash Mutyala91e130a2020-03-04 22:26:38 +00002811 * @param chassisSubNode Chassis Node for which the query has to happen
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302812 */
Ed Tanous23a21a12020-07-25 04:45:05 +00002813inline void setSensorsOverride(
Ed Tanousb5a76932020-09-29 16:16:58 -07002814 const std::shared_ptr<SensorsAsyncResp>& sensorAsyncResp,
Carol Wang4bb3dc32019-10-17 18:15:02 +08002815 std::unordered_map<std::string, std::vector<nlohmann::json>>&
jayaprakash Mutyala397fd612020-02-06 23:33:34 +00002816 allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302817{
jayaprakash Mutyala70d1d0a2020-01-21 23:41:36 +00002818 BMCWEB_LOG_INFO << "setSensorsOverride for subNode"
Carol Wang4bb3dc32019-10-17 18:15:02 +08002819 << sensorAsyncResp->chassisSubNode << "\n";
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302820
Ed Tanous543f4402022-01-06 13:12:53 -08002821 const char* propertyValueName = nullptr;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302822 std::unordered_map<std::string, std::pair<double, std::string>> overrideMap;
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302823 std::string memberId;
Ed Tanous543f4402022-01-06 13:12:53 -08002824 double value = 0.0;
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302825 for (auto& collectionItems : allCollections)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302826 {
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302827 if (collectionItems.first == "Temperatures")
2828 {
2829 propertyValueName = "ReadingCelsius";
2830 }
2831 else if (collectionItems.first == "Fans")
2832 {
2833 propertyValueName = "Reading";
2834 }
2835 else
2836 {
2837 propertyValueName = "ReadingVolts";
2838 }
2839 for (auto& item : collectionItems.second)
2840 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002841 if (!json_util::readJson(item, sensorAsyncResp->asyncResp->res,
2842 "MemberId", memberId, propertyValueName,
2843 value))
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302844 {
2845 return;
2846 }
2847 overrideMap.emplace(memberId,
2848 std::make_pair(value, collectionItems.first));
2849 }
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302850 }
Carol Wang4bb3dc32019-10-17 18:15:02 +08002851
Ed Tanousb5a76932020-09-29 16:16:58 -07002852 auto getChassisSensorListCb = [sensorAsyncResp, overrideMap](
2853 const std::shared_ptr<
2854 boost::container::flat_set<
2855 std::string>>& sensorsList) {
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002856 // Match sensor names in the PATCH request to those managed by the
2857 // chassis node
2858 const std::shared_ptr<boost::container::flat_set<std::string>>
2859 sensorNames =
2860 std::make_shared<boost::container::flat_set<std::string>>();
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302861 for (const auto& item : overrideMap)
2862 {
2863 const auto& sensor = item.first;
Johnathan Mantey49c53ac2019-05-02 09:22:38 -07002864 if (!findSensorNameUsingSensorPath(sensor, *sensorsList,
2865 *sensorNames))
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302866 {
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302867 BMCWEB_LOG_INFO << "Unable to find memberId " << item.first;
zhanghch058d1b46d2021-04-01 11:18:24 +08002868 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302869 item.second.second, item.first);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302870 return;
2871 }
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302872 }
2873 // Get the connection to which the memberId belongs
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002874 auto getObjectsWithConnectionCb = [sensorAsyncResp, overrideMap](
2875 const boost::container::flat_set<
2876 std::string>& /*connections*/,
2877 const std::set<std::pair<
2878 std::string, std::string>>&
2879 objectsWithConnection) {
2880 if (objectsWithConnection.size() != overrideMap.size())
2881 {
2882 BMCWEB_LOG_INFO
2883 << "Unable to find all objects with proper connection "
2884 << objectsWithConnection.size() << " requested "
2885 << overrideMap.size() << "\n";
2886 messages::resourceNotFound(sensorAsyncResp->asyncResp->res,
2887 sensorAsyncResp->chassisSubNode ==
2888 sensors::node::thermal
2889 ? "Temperatures"
2890 : "Voltages",
2891 "Count");
2892 return;
2893 }
2894 for (const auto& item : objectsWithConnection)
2895 {
2896 sdbusplus::message::object_path path(item.first);
2897 std::string sensorName = path.filename();
2898 if (sensorName.empty())
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302899 {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002900 messages::internalError(sensorAsyncResp->asyncResp->res);
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302901 return;
2902 }
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302903
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002904 const auto& iterator = overrideMap.find(sensorName);
2905 if (iterator == overrideMap.end())
2906 {
2907 BMCWEB_LOG_INFO << "Unable to find sensor object"
2908 << item.first << "\n";
2909 messages::internalError(sensorAsyncResp->asyncResp->res);
2910 return;
2911 }
2912 crow::connections::systemBus->async_method_call(
2913 [sensorAsyncResp](const boost::system::error_code ec) {
2914 if (ec)
2915 {
2916 if (ec.value() ==
2917 boost::system::errc::permission_denied)
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302918 {
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002919 BMCWEB_LOG_WARNING
2920 << "Manufacturing mode is not Enabled...can't "
2921 "Override the sensor value. ";
2922
2923 messages::insufficientPrivilege(
zhanghch058d1b46d2021-04-01 11:18:24 +08002924 sensorAsyncResp->asyncResp->res);
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302925 return;
2926 }
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002927 BMCWEB_LOG_DEBUG
2928 << "setOverrideValueStatus DBUS error: " << ec;
2929 messages::internalError(
2930 sensorAsyncResp->asyncResp->res);
2931 }
2932 },
2933 item.second, item.first, "org.freedesktop.DBus.Properties",
2934 "Set", "xyz.openbmc_project.Sensor.Value", "Value",
Ed Tanous168e20c2021-12-13 14:39:53 -08002935 dbus::utility::DbusVariantType(iterator->second.first));
Jayaprakash Mutyala4f277b52021-12-08 22:46:49 +00002936 }
2937 };
Richard Marian Thomaiyarf65af9e2019-02-13 23:35:05 +05302938 // Get object with connection for the given sensor name
2939 getObjectsWithConnection(sensorAsyncResp, sensorNames,
2940 std::move(getObjectsWithConnectionCb));
2941 };
Richard Marian Thomaiyar413961d2019-02-01 00:43:39 +05302942 // get full sensor list for the given chassisId and cross verify the sensor.
2943 getChassis(sensorAsyncResp, std::move(getChassisSensorListCb));
2944}
2945
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002946/**
2947 * @brief Retrieves mapping of Redfish URIs to sensor value property to D-Bus
2948 * path of the sensor.
2949 *
2950 * Function builds valid Redfish response for sensor query of given chassis and
2951 * node. It then builds metadata about Redfish<->D-Bus correlations and provides
2952 * it to caller in a callback.
2953 *
2954 * @param chassis Chassis for which retrieval should be performed
2955 * @param node Node (group) of sensors. See sensors::node for supported values
2956 * @param mapComplete Callback to be called with retrieval result
2957 */
Krzysztof Grobelny021d32c2021-10-29 16:00:07 +02002958inline void retrieveUriToDbusMap(const std::string& chassis,
2959 const std::string& node,
2960 SensorsAsyncResp::DataCompleteCb&& mapComplete)
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002961{
Ed Tanous02da7c52022-02-27 00:09:02 -08002962 decltype(sensors::paths)::const_iterator pathIt =
2963 std::find_if(sensors::paths.cbegin(), sensors::paths.cend(),
2964 [&node](auto&& val) { return val.first == node; });
2965 if (pathIt == sensors::paths.cend())
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002966 {
2967 BMCWEB_LOG_ERROR << "Wrong node provided : " << node;
2968 mapComplete(boost::beast::http::status::bad_request, {});
2969 return;
2970 }
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002971
Nan Zhou72374eb2022-01-27 17:06:51 -08002972 auto asyncResp = std::make_shared<bmcweb::AsyncResp>();
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002973 auto callback =
Nan Zhou72374eb2022-01-27 17:06:51 -08002974 [asyncResp, mapCompleteCb{std::move(mapComplete)}](
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002975 const boost::beast::http::status status,
2976 const boost::container::flat_map<std::string, std::string>&
2977 uriToDbus) { mapCompleteCb(status, uriToDbus); };
2978
2979 auto resp = std::make_shared<SensorsAsyncResp>(
Krzysztof Grobelnyd51e0722021-04-16 13:15:21 +00002980 asyncResp, chassis, pathIt->second, node, std::move(callback));
Adrian Ambrożewicza0ec28b2020-04-10 14:47:28 +02002981 getChassisData(resp);
2982}
2983
Nan Zhoubacb2162022-04-06 11:28:32 -07002984namespace sensors
2985{
Nan Zhou928fefb2022-03-28 08:45:00 -07002986
Nan Zhoubacb2162022-04-06 11:28:32 -07002987inline void getChassisCallback(
2988 const std::shared_ptr<SensorsAsyncResp>& asyncResp,
2989 const std::shared_ptr<boost::container::flat_set<std::string>>& sensorNames)
2990{
2991 BMCWEB_LOG_DEBUG << "getChassisCallback enter";
2992
2993 nlohmann::json& entriesArray =
2994 asyncResp->asyncResp->res.jsonValue["Members"];
2995 for (auto& sensor : *sensorNames)
2996 {
2997 BMCWEB_LOG_DEBUG << "Adding sensor: " << sensor;
2998
2999 sdbusplus::message::object_path path(sensor);
3000 std::string sensorName = path.filename();
3001 if (sensorName.empty())
3002 {
3003 BMCWEB_LOG_ERROR << "Invalid sensor path: " << sensor;
3004 messages::internalError(asyncResp->asyncResp->res);
3005 return;
3006 }
3007 entriesArray.push_back(
3008 {{"@odata.id", "/redfish/v1/Chassis/" + asyncResp->chassisId + "/" +
3009 asyncResp->chassisSubNode + "/" + sensorName}});
3010 }
3011
3012 asyncResp->asyncResp->res.jsonValue["Members@odata.count"] =
3013 entriesArray.size();
3014 BMCWEB_LOG_DEBUG << "getChassisCallback exit";
3015}
3016} // namespace sensors
3017
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003018inline void requestRoutesSensorCollection(App& app)
Anthony Wilson95a3eca2019-06-11 10:44:47 -05003019{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003020 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/")
Ed Tanoused398212021-06-09 17:05:54 -07003021 .privileges(redfish::privileges::getSensorCollection)
Nan Zhou928fefb2022-03-28 08:45:00 -07003022 .methods(
3023 boost::beast::http::verb::get)([&app](
3024 const crow::Request& req,
3025 const std::shared_ptr<
3026 bmcweb::AsyncResp>& aResp,
3027 const std::string& chassisId) {
3028 query_param::QueryCapabilities capabilities = {
3029 .canDelegateExpandLevel = 1,
3030 };
3031 query_param::Query delegatedQuery;
3032 if (!redfish::setUpRedfishRouteWithDelegation(
3033 app, req, aResp->res, delegatedQuery, capabilities))
3034 {
3035 return;
3036 }
Anthony Wilson95a3eca2019-06-11 10:44:47 -05003037
Nan Zhou928fefb2022-03-28 08:45:00 -07003038 if (delegatedQuery.expandType != query_param::ExpandType::None)
3039 {
3040 // we perform efficient expand.
3041 auto asyncResp = std::make_shared<SensorsAsyncResp>(
Ed Tanous02da7c52022-02-27 00:09:02 -08003042 aResp, chassisId, sensors::dbus::sensorPaths,
Nan Zhou928fefb2022-03-28 08:45:00 -07003043 sensors::node::sensors,
3044 /*efficientExpand=*/true);
3045 getChassisData(asyncResp);
zhanghch058d1b46d2021-04-01 11:18:24 +08003046
Nan Zhou928fefb2022-03-28 08:45:00 -07003047 BMCWEB_LOG_DEBUG
3048 << "SensorCollection doGet exit via efficient expand handler";
3049 return;
3050 };
3051
3052 // if there's no efficient expand available, we use the default
3053 // Query Parameters route
3054 auto asyncResp = std::make_shared<SensorsAsyncResp>(
Ed Tanous02da7c52022-02-27 00:09:02 -08003055 aResp, chassisId, sensors::dbus::sensorPaths,
Nan Zhou928fefb2022-03-28 08:45:00 -07003056 sensors::node::sensors);
3057
3058 // We get all sensors as hyperlinkes in the chassis (this
3059 // implies we reply on the default query parameters handler)
3060 getChassis(asyncResp,
3061 std::bind_front(sensors::getChassisCallback, asyncResp));
3062 BMCWEB_LOG_DEBUG << "SensorCollection doGet exit";
3063 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003064}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05003065
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003066inline void requestRoutesSensor(App& app)
3067{
3068 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Sensors/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -07003069 .privileges(redfish::privileges::getSensor)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003070 .methods(
Ed Tanous45ca1b82022-03-25 13:07:27 -07003071 boost::beast::http::verb::get)([&app](
3072 const crow::Request& req,
3073 const std::shared_ptr<
3074 bmcweb::AsyncResp>& aResp,
3075 const std::string& chassisId,
3076 const std::string& sensorName) {
3077 if (!redfish::setUpRedfishRoute(app, req, aResp->res))
3078 {
3079 return;
3080 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003081 BMCWEB_LOG_DEBUG << "Sensor doGet enter";
3082 std::shared_ptr<SensorsAsyncResp> asyncResp =
Ed Tanous02da7c52022-02-27 00:09:02 -08003083 std::make_shared<SensorsAsyncResp>(
3084 aResp, chassisId, std::span<std::string_view>(),
3085 sensors::node::sensors);
Anthony Wilson95a3eca2019-06-11 10:44:47 -05003086
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003087 const std::array<const char*, 1> interfaces = {
3088 "xyz.openbmc_project.Sensor.Value"};
3089
3090 // Get a list of all of the sensors that implement Sensor.Value
3091 // and get the path and service name associated with the sensor
3092 crow::connections::systemBus->async_method_call(
Ed Tanousb9d36b42022-02-26 21:42:46 -08003093 [asyncResp, sensorName](
3094 const boost::system::error_code ec,
3095 const dbus::utility::MapperGetSubTreeResponse& subtree) {
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003096 BMCWEB_LOG_DEBUG << "respHandler1 enter";
3097 if (ec)
3098 {
3099 messages::internalError(asyncResp->asyncResp->res);
3100 BMCWEB_LOG_ERROR
3101 << "Sensor getSensorPaths resp_handler: "
3102 << "Dbus error " << ec;
3103 return;
3104 }
3105
Ed Tanousb9d36b42022-02-26 21:42:46 -08003106 dbus::utility::MapperGetSubTreeResponse::const_iterator it =
3107 std::find_if(
3108 subtree.begin(), subtree.end(),
3109 [sensorName](
3110 const std::pair<std::string,
3111 std::vector<std::pair<
3112 std::string,
3113 std::vector<std::string>>>>&
3114 object) {
3115 sdbusplus::message::object_path path(
3116 object.first);
3117 std::string name = path.filename();
3118 if (name.empty())
3119 {
3120 BMCWEB_LOG_ERROR << "Invalid sensor path: "
3121 << object.first;
3122 return false;
3123 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003124
Ed Tanousb9d36b42022-02-26 21:42:46 -08003125 return name == sensorName;
3126 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07003127
3128 if (it == subtree.end())
3129 {
3130 BMCWEB_LOG_ERROR << "Could not find path for sensor: "
3131 << sensorName;
3132 messages::resourceNotFound(asyncResp->asyncResp->res,
3133 "Sensor", sensorName);
3134 return;
3135 }
3136 std::string_view sensorPath = (*it).first;
3137 BMCWEB_LOG_DEBUG << "Found sensor path for sensor '"
3138 << sensorName << "': " << sensorPath;
3139
3140 const std::shared_ptr<
3141 boost::container::flat_set<std::string>>
3142 sensorList = std::make_shared<
3143 boost::container::flat_set<std::string>>();
3144
3145 sensorList->emplace(sensorPath);
3146 processSensorList(asyncResp, sensorList);
3147 BMCWEB_LOG_DEBUG << "respHandler1 exit";
3148 },
3149 "xyz.openbmc_project.ObjectMapper",
3150 "/xyz/openbmc_project/object_mapper",
3151 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
3152 "/xyz/openbmc_project/sensors", 2, interfaces);
3153 });
3154}
Anthony Wilson95a3eca2019-06-11 10:44:47 -05003155
Ed Tanous1abe55e2018-09-05 08:30:59 -07003156} // namespace redfish