blob: 6038384201313fb7c882dd3823a1ccd8bd71184c [file] [log] [blame]
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +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
Willy Tu13451e32023-05-24 16:08:18 -070018#include "bmcweb_config.h"
19
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080020#include "app.hpp"
George Liu7a1dbc42022-12-07 16:03:22 +080021#include "dbus_utility.hpp"
James Feistb49ac872019-05-21 15:12:01 -070022#include "health.hpp"
James Feist1c8fba92019-12-20 15:12:07 -080023#include "led.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080024#include "query.hpp"
Chau Ly7164bc62023-10-15 14:55:30 +000025#include "redfish_util.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080026#include "registries/privilege_registry.hpp"
27#include "utils/collection.hpp"
28#include "utils/dbus_utils.hpp"
Nan Zhoucf7eba02022-07-21 23:53:20 +000029#include "utils/json_utils.hpp"
Ed Tanous1abe55e2018-09-05 08:30:59 -070030
George Liue99073f2022-12-09 11:06:16 +080031#include <boost/system/error_code.hpp>
Ed Tanousef4c65b2023-04-24 15:28:50 -070032#include <boost/url/format.hpp>
Jonathan Doman1e1e5982021-06-11 09:36:17 -070033#include <sdbusplus/asio/property.hpp>
Andrew Geisslerfc903b32023-05-31 14:15:42 -040034#include <sdbusplus/message.hpp>
Krzysztof Grobelny86d89ed2022-08-29 14:49:20 +020035#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050036
George Liu7a1dbc42022-12-07 16:03:22 +080037#include <array>
Ed Tanous3544d2a2023-08-06 18:12:20 -070038#include <ranges>
George Liu7a1dbc42022-12-07 16:03:22 +080039#include <string_view>
40
Ed Tanous1abe55e2018-09-05 08:30:59 -070041namespace redfish
42{
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +010043
44/**
Willy Tu5e577bc2022-07-26 00:41:55 +000045 * @brief Retrieves resources over dbus to link to the chassis
46 *
47 * @param[in] asyncResp - Shared pointer for completing asynchronous
48 * calls
49 * @param[in] path - Chassis dbus path to look for the storage.
50 *
51 * Calls the Association endpoints on the path + "/storage" and add the link of
52 * json["Links"]["Storage@odata.count"] =
53 * {"@odata.id", "/redfish/v1/Storage/" + resourceId}
54 *
55 * @return None.
56 */
57inline void getStorageLink(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
58 const sdbusplus::message::object_path& path)
59{
60 sdbusplus::asio::getProperty<std::vector<std::string>>(
61 *crow::connections::systemBus, "xyz.openbmc_project.ObjectMapper",
62 (path / "storage").str, "xyz.openbmc_project.Association", "endpoints",
Willy Tud4b054c2023-06-12 15:18:45 -070063 [asyncResp](const boost::system::error_code& ec,
Willy Tu5e577bc2022-07-26 00:41:55 +000064 const std::vector<std::string>& storageList) {
65 if (ec)
66 {
Ed Tanous62598e32023-07-17 17:06:25 -070067 BMCWEB_LOG_DEBUG("getStorageLink got DBUS response error");
Willy Tu5e577bc2022-07-26 00:41:55 +000068 return;
69 }
70
71 nlohmann::json::array_t storages;
72 for (const std::string& storagePath : storageList)
73 {
74 std::string id =
75 sdbusplus::message::object_path(storagePath).filename();
76 if (id.empty())
77 {
78 continue;
79 }
80
81 nlohmann::json::object_t storage;
82 storage["@odata.id"] = boost::urls::format(
83 "/redfish/v1/Systems/system/Storage/{}", id);
84 storages.emplace_back(std::move(storage));
85 }
86 asyncResp->res.jsonValue["Links"]["Storage@odata.count"] =
87 storages.size();
88 asyncResp->res.jsonValue["Links"]["Storage"] = std::move(storages);
Patrick Williams5a39f772023-10-20 11:20:21 -050089 });
Willy Tu5e577bc2022-07-26 00:41:55 +000090}
91
92/**
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060093 * @brief Retrieves chassis state properties over dbus
94 *
Ed Tanousac106bf2023-06-07 09:24:59 -070095 * @param[in] asyncResp - Shared pointer for completing asynchronous calls.
Gunnar Millsbeeca0a2019-02-14 16:30:45 -060096 *
97 * @return None.
98 */
Ed Tanousac106bf2023-06-07 09:24:59 -070099inline void getChassisState(std::shared_ptr<bmcweb::AsyncResp> asyncResp)
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600100{
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700101 // crow::connections::systemBus->async_method_call(
102 sdbusplus::asio::getProperty<std::string>(
103 *crow::connections::systemBus, "xyz.openbmc_project.State.Chassis",
104 "/xyz/openbmc_project/state/chassis0",
105 "xyz.openbmc_project.State.Chassis", "CurrentPowerState",
Ed Tanousac106bf2023-06-07 09:24:59 -0700106 [asyncResp{std::move(asyncResp)}](const boost::system::error_code& ec,
107 const std::string& chassisState) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700108 if (ec)
109 {
110 if (ec == boost::system::errc::host_unreachable)
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600111 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700112 // Service not available, no error, just don't return
113 // chassis state info
Ed Tanous62598e32023-07-17 17:06:25 -0700114 BMCWEB_LOG_DEBUG("Service not available {}", ec);
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600115 return;
116 }
Ed Tanous62598e32023-07-17 17:06:25 -0700117 BMCWEB_LOG_DEBUG("DBUS response error {}", ec);
Ed Tanousac106bf2023-06-07 09:24:59 -0700118 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -0700119 return;
120 }
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600121
Ed Tanous62598e32023-07-17 17:06:25 -0700122 BMCWEB_LOG_DEBUG("Chassis state: {}", chassisState);
Ed Tanous002d39b2022-05-31 08:59:27 -0700123 // Verify Chassis State
124 if (chassisState == "xyz.openbmc_project.State.Chassis.PowerState.On")
125 {
Ed Tanousac106bf2023-06-07 09:24:59 -0700126 asyncResp->res.jsonValue["PowerState"] = "On";
127 asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
Ed Tanous002d39b2022-05-31 08:59:27 -0700128 }
129 else if (chassisState ==
130 "xyz.openbmc_project.State.Chassis.PowerState.Off")
131 {
Ed Tanousac106bf2023-06-07 09:24:59 -0700132 asyncResp->res.jsonValue["PowerState"] = "Off";
133 asyncResp->res.jsonValue["Status"]["State"] = "StandbyOffline";
Ed Tanous002d39b2022-05-31 08:59:27 -0700134 }
Patrick Williams5a39f772023-10-20 11:20:21 -0500135 });
Gunnar Millsbeeca0a2019-02-14 16:30:45 -0600136}
137
Qiang XUc1819422019-02-27 13:51:32 +0800138/**
139 * Retrieves physical security properties over dbus
140 */
Chau Ly7164bc62023-10-15 14:55:30 +0000141inline void handlePhysicalSecurityGetSubTree(
142 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
143 const boost::system::error_code& ec,
144 const dbus::utility::MapperGetSubTreeResponse& subtree)
Qiang XUc1819422019-02-27 13:51:32 +0800145{
Chau Ly7164bc62023-10-15 14:55:30 +0000146 if (ec)
147 {
148 // do not add err msg in redfish response, because this is not
149 // mandatory property
150 BMCWEB_LOG_INFO("DBUS error: no matched iface {}", ec);
151 return;
152 }
153 // Iterate over all retrieved ObjectPaths.
154 for (const auto& object : subtree)
155 {
156 if (!object.second.empty())
Ed Tanous002d39b2022-05-31 08:59:27 -0700157 {
Chau Ly7164bc62023-10-15 14:55:30 +0000158 const auto service = object.second.front();
159
160 BMCWEB_LOG_DEBUG("Get intrusion status by service ");
161
162 sdbusplus::asio::getProperty<std::string>(
163 *crow::connections::systemBus, service.first, object.first,
164 "xyz.openbmc_project.Chassis.Intrusion", "Status",
165 [asyncResp](const boost::system::error_code& ec1,
166 const std::string& value) {
167 if (ec1)
168 {
169 // do not add err msg in redfish response, because this is
170 // not
171 // mandatory property
172 BMCWEB_LOG_ERROR("DBUS response error {}", ec1);
173 return;
174 }
175 asyncResp->res
176 .jsonValue["PhysicalSecurity"]["IntrusionSensorNumber"] = 1;
177 asyncResp->res
178 .jsonValue["PhysicalSecurity"]["IntrusionSensor"] = value;
179 });
180
Ed Tanous002d39b2022-05-31 08:59:27 -0700181 return;
182 }
Chau Ly7164bc62023-10-15 14:55:30 +0000183 }
Qiang XUc1819422019-02-27 13:51:32 +0800184}
185
Nan Zhoucf7eba02022-07-21 23:53:20 +0000186inline void handleChassisCollectionGet(
187 App& app, const crow::Request& req,
188 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
189{
190 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
191 {
192 return;
193 }
194 asyncResp->res.jsonValue["@odata.type"] =
195 "#ChassisCollection.ChassisCollection";
196 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Chassis";
197 asyncResp->res.jsonValue["Name"] = "Chassis Collection";
198
George Liu7a1dbc42022-12-07 16:03:22 +0800199 constexpr std::array<std::string_view, 2> interfaces{
200 "xyz.openbmc_project.Inventory.Item.Board",
201 "xyz.openbmc_project.Inventory.Item.Chassis"};
Nan Zhoucf7eba02022-07-21 23:53:20 +0000202 collection_util::getCollectionMembers(
Lakshmi Yadlapati36b5f1e2023-09-26 23:53:28 -0500203 asyncResp, boost::urls::url("/redfish/v1/Chassis"), interfaces,
204 "/xyz/openbmc_project/inventory");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000205}
206
Jie Yanga5617492021-06-29 12:59:14 -0700207inline void getChassisContainedBy(
208 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
209 const std::string& chassisId, const boost::system::error_code& ec,
210 const dbus::utility::MapperEndPoints& upstreamChassisPaths)
211{
212 if (ec)
213 {
214 if (ec.value() != EBADR)
215 {
Ed Tanous62598e32023-07-17 17:06:25 -0700216 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
Jie Yanga5617492021-06-29 12:59:14 -0700217 messages::internalError(asyncResp->res);
218 }
219 return;
220 }
221 if (upstreamChassisPaths.empty())
222 {
223 return;
224 }
225 if (upstreamChassisPaths.size() > 1)
226 {
Ed Tanous8ece0e42024-01-02 13:16:50 -0800227 BMCWEB_LOG_ERROR("{} is contained by multiple chassis", chassisId);
Jie Yanga5617492021-06-29 12:59:14 -0700228 messages::internalError(asyncResp->res);
229 return;
230 }
231
232 sdbusplus::message::object_path upstreamChassisPath(
233 upstreamChassisPaths[0]);
234 std::string upstreamChassis = upstreamChassisPath.filename();
235 if (upstreamChassis.empty())
236 {
Ed Tanous62598e32023-07-17 17:06:25 -0700237 BMCWEB_LOG_WARNING("Malformed upstream Chassis path {} on {}",
238 upstreamChassisPath.str, chassisId);
Jie Yanga5617492021-06-29 12:59:14 -0700239 return;
240 }
241
242 asyncResp->res.jsonValue["Links"]["ContainedBy"]["@odata.id"] =
243 boost::urls::format("/redfish/v1/Chassis/{}", upstreamChassis);
244}
245
246inline void getChassisContains(
247 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
248 const std::string& chassisId, const boost::system::error_code& ec,
249 const dbus::utility::MapperEndPoints& downstreamChassisPaths)
250{
251 if (ec)
252 {
253 if (ec.value() != EBADR)
254 {
Ed Tanous62598e32023-07-17 17:06:25 -0700255 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
Jie Yanga5617492021-06-29 12:59:14 -0700256 messages::internalError(asyncResp->res);
257 }
258 return;
259 }
260 if (downstreamChassisPaths.empty())
261 {
262 return;
263 }
264 nlohmann::json& jValue = asyncResp->res.jsonValue["Links"]["Contains"];
265 if (!jValue.is_array())
266 {
267 // Create the array if it was empty
268 jValue = nlohmann::json::array();
269 }
270 for (const auto& p : downstreamChassisPaths)
271 {
272 sdbusplus::message::object_path downstreamChassisPath(p);
273 std::string downstreamChassis = downstreamChassisPath.filename();
274 if (downstreamChassis.empty())
275 {
Ed Tanous62598e32023-07-17 17:06:25 -0700276 BMCWEB_LOG_WARNING("Malformed downstream Chassis path {} on {}",
277 downstreamChassisPath.str, chassisId);
Jie Yanga5617492021-06-29 12:59:14 -0700278 continue;
279 }
280 nlohmann::json link;
281 link["@odata.id"] = boost::urls::format("/redfish/v1/Chassis/{}",
282 downstreamChassis);
283 jValue.push_back(std::move(link));
284 }
285 asyncResp->res.jsonValue["Links"]["Contains@odata.count"] = jValue.size();
286}
287
288inline void
289 getChassisConnectivity(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
290 const std::string& chassisId,
291 const std::string& chassisPath)
292{
Ed Tanous62598e32023-07-17 17:06:25 -0700293 BMCWEB_LOG_DEBUG("Get chassis connectivity");
Jie Yanga5617492021-06-29 12:59:14 -0700294
295 dbus::utility::getAssociationEndPoints(
296 chassisPath + "/contained_by",
297 std::bind_front(getChassisContainedBy, asyncResp, chassisId));
298
299 dbus::utility::getAssociationEndPoints(
300 chassisPath + "/containing",
301 std::bind_front(getChassisContains, asyncResp, chassisId));
302}
303
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100304/**
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100305 * ChassisCollection derived class for delivering Chassis Collection Schema
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700306 * Functions triggers appropriate requests on DBus
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100307 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700308inline void requestRoutesChassisCollection(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700309{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700310 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/")
Ed Tanoused398212021-06-09 17:05:54 -0700311 .privileges(redfish::privileges::getChassisCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700312 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000313 std::bind_front(handleChassisCollectionGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700314}
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100315
Willy Tu308f70c2021-09-28 20:24:52 -0700316inline void
317 getChassisLocationCode(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
318 const std::string& connectionName,
319 const std::string& path)
320{
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700321 sdbusplus::asio::getProperty<std::string>(
322 *crow::connections::systemBus, connectionName, path,
323 "xyz.openbmc_project.Inventory.Decorator.LocationCode", "LocationCode",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800324 [asyncResp](const boost::system::error_code& ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700325 const std::string& property) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700326 if (ec)
327 {
Ed Tanous62598e32023-07-17 17:06:25 -0700328 BMCWEB_LOG_ERROR("DBUS response error for Location");
Ed Tanous002d39b2022-05-31 08:59:27 -0700329 messages::internalError(asyncResp->res);
330 return;
331 }
Willy Tu308f70c2021-09-28 20:24:52 -0700332
Ed Tanous002d39b2022-05-31 08:59:27 -0700333 asyncResp->res.jsonValue["Location"]["PartLocation"]["ServiceLabel"] =
334 property;
Patrick Williams5a39f772023-10-20 11:20:21 -0500335 });
Willy Tu308f70c2021-09-28 20:24:52 -0700336}
337
338inline void getChassisUUID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
339 const std::string& connectionName,
340 const std::string& path)
341{
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700342 sdbusplus::asio::getProperty<std::string>(
343 *crow::connections::systemBus, connectionName, path,
344 "xyz.openbmc_project.Common.UUID", "UUID",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800345 [asyncResp](const boost::system::error_code& ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -0700346 const std::string& chassisUUID) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700347 if (ec)
348 {
Ed Tanous62598e32023-07-17 17:06:25 -0700349 BMCWEB_LOG_ERROR("DBUS response error for UUID");
Ed Tanous002d39b2022-05-31 08:59:27 -0700350 messages::internalError(asyncResp->res);
351 return;
352 }
353 asyncResp->res.jsonValue["UUID"] = chassisUUID;
Patrick Williams5a39f772023-10-20 11:20:21 -0500354 });
Willy Tu308f70c2021-09-28 20:24:52 -0700355}
356
Chau Ly7164bc62023-10-15 14:55:30 +0000357inline void handleDecoratorAssetProperties(
358 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
359 const std::string& chassisId, const std::string& path,
360 const dbus::utility::DBusPropertiesMap& propertiesList)
361{
362 const std::string* partNumber = nullptr;
363 const std::string* serialNumber = nullptr;
364 const std::string* manufacturer = nullptr;
365 const std::string* model = nullptr;
366 const std::string* sparePartNumber = nullptr;
367
368 const bool success = sdbusplus::unpackPropertiesNoThrow(
369 dbus_utils::UnpackErrorPrinter(), propertiesList, "PartNumber",
370 partNumber, "SerialNumber", serialNumber, "Manufacturer", manufacturer,
371 "Model", model, "SparePartNumber", sparePartNumber);
372
373 if (!success)
374 {
375 messages::internalError(asyncResp->res);
376 return;
377 }
378
379 if (partNumber != nullptr)
380 {
381 asyncResp->res.jsonValue["PartNumber"] = *partNumber;
382 }
383
384 if (serialNumber != nullptr)
385 {
386 asyncResp->res.jsonValue["SerialNumber"] = *serialNumber;
387 }
388
389 if (manufacturer != nullptr)
390 {
391 asyncResp->res.jsonValue["Manufacturer"] = *manufacturer;
392 }
393
394 if (model != nullptr)
395 {
396 asyncResp->res.jsonValue["Model"] = *model;
397 }
398
399 // SparePartNumber is optional on D-Bus
400 // so skip if it is empty
401 if (sparePartNumber != nullptr && !sparePartNumber->empty())
402 {
403 asyncResp->res.jsonValue["SparePartNumber"] = *sparePartNumber;
404 }
405
406 asyncResp->res.jsonValue["Name"] = chassisId;
407 asyncResp->res.jsonValue["Id"] = chassisId;
408#ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL
409 asyncResp->res.jsonValue["Thermal"]["@odata.id"] =
410 boost::urls::format("/redfish/v1/Chassis/{}/Thermal", chassisId);
411 // Power object
412 asyncResp->res.jsonValue["Power"]["@odata.id"] =
413 boost::urls::format("/redfish/v1/Chassis/{}/Power", chassisId);
414#endif
415#ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM
416 asyncResp->res.jsonValue["ThermalSubsystem"]["@odata.id"] =
417 boost::urls::format("/redfish/v1/Chassis/{}/ThermalSubsystem",
418 chassisId);
419 asyncResp->res.jsonValue["PowerSubsystem"]["@odata.id"] =
420 boost::urls::format("/redfish/v1/Chassis/{}/PowerSubsystem", chassisId);
421 asyncResp->res.jsonValue["EnvironmentMetrics"]["@odata.id"] =
422 boost::urls::format("/redfish/v1/Chassis/{}/EnvironmentMetrics",
423 chassisId);
424#endif
425 // SensorCollection
426 asyncResp->res.jsonValue["Sensors"]["@odata.id"] =
427 boost::urls::format("/redfish/v1/Chassis/{}/Sensors", chassisId);
428 asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
429
430 nlohmann::json::array_t computerSystems;
431 nlohmann::json::object_t system;
432 system["@odata.id"] = "/redfish/v1/Systems/system";
433 computerSystems.emplace_back(std::move(system));
434 asyncResp->res.jsonValue["Links"]["ComputerSystems"] =
435 std::move(computerSystems);
436
437 nlohmann::json::array_t managedBy;
438 nlohmann::json::object_t manager;
439 manager["@odata.id"] = "/redfish/v1/Managers/bmc";
440 managedBy.emplace_back(std::move(manager));
441 asyncResp->res.jsonValue["Links"]["ManagedBy"] = std::move(managedBy);
442 getChassisState(asyncResp);
443 getStorageLink(asyncResp, path);
444}
445
446inline void handleChassisGetSubTree(
447 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
448 const std::string& chassisId, const boost::system::error_code& ec,
449 const dbus::utility::MapperGetSubTreeResponse& subtree)
450{
451 if (ec)
452 {
453 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
454 messages::internalError(asyncResp->res);
455 return;
456 }
457 // Iterate over all retrieved ObjectPaths.
458 for (const std::pair<
459 std::string,
460 std::vector<std::pair<std::string, std::vector<std::string>>>>&
461 object : subtree)
462 {
463 const std::string& path = object.first;
464 const std::vector<std::pair<std::string, std::vector<std::string>>>&
465 connectionNames = object.second;
466
467 sdbusplus::message::object_path objPath(path);
468 if (objPath.filename() != chassisId)
469 {
470 continue;
471 }
472
473 getChassisConnectivity(asyncResp, chassisId, path);
474
475 auto health = std::make_shared<HealthPopulate>(asyncResp);
476
477 if constexpr (bmcwebEnableHealthPopulate)
478 {
479 dbus::utility::getAssociationEndPoints(
480 path + "/all_sensors",
481 [health](const boost::system::error_code& ec2,
482 const dbus::utility::MapperEndPoints& resp) {
483 if (ec2)
484 {
485 return; // no sensors = no failures
486 }
487 health->inventory = resp;
488 });
489
490 health->populate();
491 }
492
493 if (connectionNames.empty())
494 {
495 BMCWEB_LOG_ERROR("Got 0 Connection names");
496 continue;
497 }
498
499 asyncResp->res.jsonValue["@odata.type"] = "#Chassis.v1_22_0.Chassis";
500 asyncResp->res.jsonValue["@odata.id"] =
501 boost::urls::format("/redfish/v1/Chassis/{}", chassisId);
502 asyncResp->res.jsonValue["Name"] = "Chassis Collection";
503 asyncResp->res.jsonValue["ChassisType"] = "RackMount";
504 asyncResp->res.jsonValue["Actions"]["#Chassis.Reset"]["target"] =
505 boost::urls::format("/redfish/v1/Chassis/{}/Actions/Chassis.Reset",
506 chassisId);
507 asyncResp->res
508 .jsonValue["Actions"]["#Chassis.Reset"]["@Redfish.ActionInfo"] =
509 boost::urls::format("/redfish/v1/Chassis/{}/ResetActionInfo",
510 chassisId);
Chau Ly7164bc62023-10-15 14:55:30 +0000511 dbus::utility::getAssociationEndPoints(
512 path + "/drive",
513 [asyncResp, chassisId](const boost::system::error_code& ec3,
514 const dbus::utility::MapperEndPoints& resp) {
515 if (ec3 || resp.empty())
516 {
517 return; // no drives = no failures
518 }
519
520 nlohmann::json reference;
521 reference["@odata.id"] =
522 boost::urls::format("/redfish/v1/Chassis/{}/Drives", chassisId);
523 asyncResp->res.jsonValue["Drives"] = std::move(reference);
524 });
525
526 const std::string& connectionName = connectionNames[0].first;
527
528 const std::vector<std::string>& interfaces2 = connectionNames[0].second;
George Liue5ae9c12021-11-16 10:31:23 +0800529 const std::array<const char*, 3> hasIndicatorLed = {
530 "xyz.openbmc_project.Inventory.Item.Chassis",
Chau Ly7164bc62023-10-15 14:55:30 +0000531 "xyz.openbmc_project.Inventory.Item.Panel",
532 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
533
534 const std::string assetTagInterface =
535 "xyz.openbmc_project.Inventory.Decorator.AssetTag";
536 const std::string replaceableInterface =
537 "xyz.openbmc_project.Inventory.Decorator.Replaceable";
Carson Labradob4d593f2024-02-16 22:34:32 +0000538 const std::string revisionInterface =
539 "xyz.openbmc_project.Inventory.Decorator.Revision";
Chau Ly7164bc62023-10-15 14:55:30 +0000540 for (const auto& interface : interfaces2)
541 {
542 if (interface == assetTagInterface)
543 {
544 sdbusplus::asio::getProperty<std::string>(
545 *crow::connections::systemBus, connectionName, path,
546 assetTagInterface, "AssetTag",
547 [asyncResp, chassisId](const boost::system::error_code& ec2,
548 const std::string& property) {
549 if (ec2)
550 {
551 BMCWEB_LOG_ERROR("DBus response error for AssetTag: {}",
552 ec2);
553 messages::internalError(asyncResp->res);
554 return;
555 }
556 asyncResp->res.jsonValue["AssetTag"] = property;
557 });
558 }
559 else if (interface == replaceableInterface)
560 {
561 sdbusplus::asio::getProperty<bool>(
562 *crow::connections::systemBus, connectionName, path,
563 replaceableInterface, "HotPluggable",
564 [asyncResp, chassisId](const boost::system::error_code& ec2,
565 const bool property) {
566 if (ec2)
567 {
568 BMCWEB_LOG_ERROR(
569 "DBus response error for HotPluggable: {}", ec2);
570 messages::internalError(asyncResp->res);
571 return;
572 }
573 asyncResp->res.jsonValue["HotPluggable"] = property;
574 });
575 }
Carson Labradob4d593f2024-02-16 22:34:32 +0000576 else if (interface == revisionInterface)
577 {
578 sdbusplus::asio::getProperty<std::string>(
579 *crow::connections::systemBus, connectionName, path,
580 revisionInterface, "Version",
581 [asyncResp, chassisId](const boost::system::error_code& ec2,
582 const std::string& property) {
583 if (ec2)
584 {
585 BMCWEB_LOG_ERROR("DBus response error for Version: {}",
586 ec2);
587 messages::internalError(asyncResp->res);
588 return;
589 }
590 asyncResp->res.jsonValue["Version"] = property;
591 });
592 }
Chau Ly7164bc62023-10-15 14:55:30 +0000593 }
594
595 for (const char* interface : hasIndicatorLed)
596 {
597 if (std::ranges::find(interfaces2, interface) != interfaces2.end())
598 {
599 getIndicatorLedState(asyncResp);
600 getSystemLocationIndicatorActive(asyncResp);
601 break;
602 }
603 }
604
605 sdbusplus::asio::getAllProperties(
606 *crow::connections::systemBus, connectionName, path,
607 "xyz.openbmc_project.Inventory.Decorator.Asset",
608 [asyncResp, chassisId,
609 path](const boost::system::error_code&,
610 const dbus::utility::DBusPropertiesMap& propertiesList) {
611 handleDecoratorAssetProperties(asyncResp, chassisId, path,
612 propertiesList);
613 });
614
615 for (const auto& interface : interfaces2)
616 {
617 if (interface == "xyz.openbmc_project.Common.UUID")
618 {
619 getChassisUUID(asyncResp, connectionName, path);
620 }
621 else if (interface ==
622 "xyz.openbmc_project.Inventory.Decorator.LocationCode")
623 {
624 getChassisLocationCode(asyncResp, connectionName, path);
625 }
626 }
627
628 return;
629 }
630
631 // Couldn't find an object with that name. return an error
632 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
633}
634
Nan Zhoucf7eba02022-07-21 23:53:20 +0000635inline void
636 handleChassisGet(App& app, const crow::Request& req,
637 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
638 const std::string& chassisId)
639{
640 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
641 {
642 return;
643 }
George Liue99073f2022-12-09 11:06:16 +0800644 constexpr std::array<std::string_view, 2> interfaces = {
Nan Zhoucf7eba02022-07-21 23:53:20 +0000645 "xyz.openbmc_project.Inventory.Item.Board",
646 "xyz.openbmc_project.Inventory.Item.Chassis"};
647
George Liue99073f2022-12-09 11:06:16 +0800648 dbus::utility::getSubTree(
649 "/xyz/openbmc_project/inventory", 0, interfaces,
Chau Ly7164bc62023-10-15 14:55:30 +0000650 std::bind_front(handleChassisGetSubTree, asyncResp, chassisId));
Nan Zhoucf7eba02022-07-21 23:53:20 +0000651
Chau Ly7164bc62023-10-15 14:55:30 +0000652 constexpr std::array<std::string_view, 1> interfaces2 = {
653 "xyz.openbmc_project.Chassis.Intrusion"};
Nan Zhoucf7eba02022-07-21 23:53:20 +0000654
Chau Ly7164bc62023-10-15 14:55:30 +0000655 dbus::utility::getSubTree(
656 "/xyz/openbmc_project", 0, interfaces2,
657 std::bind_front(handlePhysicalSecurityGetSubTree, asyncResp));
Nan Zhoucf7eba02022-07-21 23:53:20 +0000658}
659
660inline void
661 handleChassisPatch(App& app, const crow::Request& req,
662 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
663 const std::string& param)
664{
665 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
666 {
667 return;
668 }
669 std::optional<bool> locationIndicatorActive;
670 std::optional<std::string> indicatorLed;
671
672 if (param.empty())
673 {
674 return;
675 }
676
677 if (!json_util::readJsonPatch(
678 req, asyncResp->res, "LocationIndicatorActive",
679 locationIndicatorActive, "IndicatorLED", indicatorLed))
680 {
681 return;
682 }
683
684 // TODO (Gunnar): Remove IndicatorLED after enough time has passed
685 if (!locationIndicatorActive && !indicatorLed)
686 {
687 return; // delete this when we support more patch properties
688 }
689 if (indicatorLed)
690 {
691 asyncResp->res.addHeader(
692 boost::beast::http::field::warning,
693 "299 - \"IndicatorLED is deprecated. Use LocationIndicatorActive instead.\"");
694 }
695
George Liue99073f2022-12-09 11:06:16 +0800696 constexpr std::array<std::string_view, 2> interfaces = {
Nan Zhoucf7eba02022-07-21 23:53:20 +0000697 "xyz.openbmc_project.Inventory.Item.Board",
698 "xyz.openbmc_project.Inventory.Item.Chassis"};
699
700 const std::string& chassisId = param;
701
George Liue99073f2022-12-09 11:06:16 +0800702 dbus::utility::getSubTree(
703 "/xyz/openbmc_project/inventory", 0, interfaces,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000704 [asyncResp, chassisId, locationIndicatorActive,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800705 indicatorLed](const boost::system::error_code& ec,
Nan Zhoucf7eba02022-07-21 23:53:20 +0000706 const dbus::utility::MapperGetSubTreeResponse& subtree) {
707 if (ec)
708 {
Ed Tanous62598e32023-07-17 17:06:25 -0700709 BMCWEB_LOG_ERROR("DBUS response error {}", ec);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000710 messages::internalError(asyncResp->res);
711 return;
712 }
713
714 // Iterate over all retrieved ObjectPaths.
715 for (const std::pair<
716 std::string,
717 std::vector<std::pair<std::string, std::vector<std::string>>>>&
718 object : subtree)
719 {
720 const std::string& path = object.first;
721 const std::vector<std::pair<std::string, std::vector<std::string>>>&
722 connectionNames = object.second;
723
724 sdbusplus::message::object_path objPath(path);
725 if (objPath.filename() != chassisId)
726 {
727 continue;
728 }
729
730 if (connectionNames.empty())
731 {
Ed Tanous62598e32023-07-17 17:06:25 -0700732 BMCWEB_LOG_ERROR("Got 0 Connection names");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000733 continue;
734 }
735
736 const std::vector<std::string>& interfaces3 =
737 connectionNames[0].second;
738
George Liue5ae9c12021-11-16 10:31:23 +0800739 const std::array<const char*, 3> hasIndicatorLed = {
740 "xyz.openbmc_project.Inventory.Item.Chassis",
Nan Zhoucf7eba02022-07-21 23:53:20 +0000741 "xyz.openbmc_project.Inventory.Item.Panel",
742 "xyz.openbmc_project.Inventory.Item.Board.Motherboard"};
743 bool indicatorChassis = false;
744 for (const char* interface : hasIndicatorLed)
745 {
Ed Tanous3544d2a2023-08-06 18:12:20 -0700746 if (std::ranges::find(interfaces3, interface) !=
747 interfaces3.end())
Nan Zhoucf7eba02022-07-21 23:53:20 +0000748 {
749 indicatorChassis = true;
750 break;
751 }
752 }
753 if (locationIndicatorActive)
754 {
755 if (indicatorChassis)
756 {
George Liu59a17e42022-10-08 09:27:47 +0800757 setSystemLocationIndicatorActive(asyncResp,
758 *locationIndicatorActive);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000759 }
760 else
761 {
762 messages::propertyUnknown(asyncResp->res,
763 "LocationIndicatorActive");
764 }
765 }
766 if (indicatorLed)
767 {
768 if (indicatorChassis)
769 {
770 setIndicatorLedState(asyncResp, *indicatorLed);
771 }
772 else
773 {
774 messages::propertyUnknown(asyncResp->res, "IndicatorLED");
775 }
776 }
777 return;
778 }
779
Jiaqing Zhaod8a5d5d2022-08-05 16:21:51 +0800780 messages::resourceNotFound(asyncResp->res, "Chassis", chassisId);
Patrick Williams5a39f772023-10-20 11:20:21 -0500781 });
Nan Zhoucf7eba02022-07-21 23:53:20 +0000782}
783
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100784/**
785 * Chassis override class for delivering Chassis Schema
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700786 * Functions triggers appropriate requests on DBus
Rapkiewicz, Pawele37f8452018-03-09 13:49:50 +0100787 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700788inline void requestRoutesChassis(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700789{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700790 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700791 .privileges(redfish::privileges::getChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700792 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000793 std::bind_front(handleChassisGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700794
795 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/")
Ed Tanoused398212021-06-09 17:05:54 -0700796 .privileges(redfish::privileges::patchChassis)
Ed Tanous002d39b2022-05-31 08:59:27 -0700797 .methods(boost::beast::http::verb::patch)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000798 std::bind_front(handleChassisPatch, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700799}
P.K. Leedd99e042020-06-17 19:43:16 +0800800
zhanghch058d1b46d2021-04-01 11:18:24 +0800801inline void
802 doChassisPowerCycle(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
P.K. Leedd99e042020-06-17 19:43:16 +0800803{
George Liu7a1dbc42022-12-07 16:03:22 +0800804 constexpr std::array<std::string_view, 1> interfaces = {
Vijay Khemkac3b3c922020-09-22 23:00:12 -0700805 "xyz.openbmc_project.State.Chassis"};
806
807 // Use mapper to get subtree paths.
George Liu7a1dbc42022-12-07 16:03:22 +0800808 dbus::utility::getSubTreePaths(
809 "/", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800810 [asyncResp](
George Liu7a1dbc42022-12-07 16:03:22 +0800811 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800812 const dbus::utility::MapperGetSubTreePathsResponse& chassisList) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700813 if (ec)
814 {
Ed Tanous62598e32023-07-17 17:06:25 -0700815 BMCWEB_LOG_ERROR("[mapper] Bad D-Bus request error: {}", ec);
Ed Tanous002d39b2022-05-31 08:59:27 -0700816 messages::internalError(asyncResp->res);
817 return;
818 }
819
820 const char* processName = "xyz.openbmc_project.State.Chassis";
821 const char* interfaceName = "xyz.openbmc_project.State.Chassis";
822 const char* destProperty = "RequestedPowerTransition";
823 const std::string propertyValue =
824 "xyz.openbmc_project.State.Chassis.Transition.PowerCycle";
825 std::string objectPath = "/xyz/openbmc_project/state/chassis_system0";
826
827 /* Look for system reset chassis path */
Ed Tanous3544d2a2023-08-06 18:12:20 -0700828 if ((std::ranges::find(chassisList, objectPath)) == chassisList.end())
Ed Tanous002d39b2022-05-31 08:59:27 -0700829 {
830 /* We prefer to reset the full chassis_system, but if it doesn't
831 * exist on some platforms, fall back to a host-only power reset
832 */
833 objectPath = "/xyz/openbmc_project/state/chassis0";
834 }
835
Ed Tanousd02aad32024-02-13 14:43:34 -0800836 setDbusProperty(asyncResp, processName, objectPath, interfaceName,
837 destProperty, "ResetType", propertyValue);
Patrick Williams5a39f772023-10-20 11:20:21 -0500838 });
P.K. Leedd99e042020-06-17 19:43:16 +0800839}
840
Nan Zhoucf7eba02022-07-21 23:53:20 +0000841inline void handleChassisResetActionInfoPost(
842 App& app, const crow::Request& req,
843 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
844 const std::string& /*chassisId*/)
845{
846 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
847 {
848 return;
849 }
Ed Tanous62598e32023-07-17 17:06:25 -0700850 BMCWEB_LOG_DEBUG("Post Chassis Reset.");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000851
852 std::string resetType;
853
854 if (!json_util::readJsonAction(req, asyncResp->res, "ResetType", resetType))
855 {
856 return;
857 }
858
859 if (resetType != "PowerCycle")
860 {
Ed Tanous62598e32023-07-17 17:06:25 -0700861 BMCWEB_LOG_DEBUG("Invalid property value for ResetType: {}", resetType);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000862 messages::actionParameterNotSupported(asyncResp->res, resetType,
863 "ResetType");
864
865 return;
866 }
867 doChassisPowerCycle(asyncResp);
868}
869
P.K. Leedd99e042020-06-17 19:43:16 +0800870/**
871 * ChassisResetAction class supports the POST method for the Reset
872 * action.
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700873 * Function handles POST method request.
874 * Analyzes POST body before sending Reset request data to D-Bus.
P.K. Leedd99e042020-06-17 19:43:16 +0800875 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700876
877inline void requestRoutesChassisResetAction(App& app)
P.K. Leedd99e042020-06-17 19:43:16 +0800878{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700879 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Actions/Chassis.Reset/")
Ed Tanoused398212021-06-09 17:05:54 -0700880 .privileges(redfish::privileges::postChassis)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700881 .methods(boost::beast::http::verb::post)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000882 std::bind_front(handleChassisResetActionInfoPost, std::ref(app)));
883}
P.K. Leedd99e042020-06-17 19:43:16 +0800884
Nan Zhoucf7eba02022-07-21 23:53:20 +0000885inline void handleChassisResetActionInfoGet(
886 App& app, const crow::Request& req,
887 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
888 const std::string& chassisId)
889{
890 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
891 {
892 return;
893 }
894 asyncResp->res.jsonValue["@odata.type"] = "#ActionInfo.v1_1_2.ActionInfo";
Ed Tanousef4c65b2023-04-24 15:28:50 -0700895 asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
896 "/redfish/v1/Chassis/{}/ResetActionInfo", chassisId);
Nan Zhoucf7eba02022-07-21 23:53:20 +0000897 asyncResp->res.jsonValue["Name"] = "Reset Action Info";
P.K. Leedd99e042020-06-17 19:43:16 +0800898
Nan Zhoucf7eba02022-07-21 23:53:20 +0000899 asyncResp->res.jsonValue["Id"] = "ResetActionInfo";
900 nlohmann::json::array_t parameters;
901 nlohmann::json::object_t parameter;
902 parameter["Name"] = "ResetType";
903 parameter["Required"] = true;
904 parameter["DataType"] = "String";
905 nlohmann::json::array_t allowed;
Patrick Williamsad539542023-05-12 10:10:08 -0500906 allowed.emplace_back("PowerCycle");
Nan Zhoucf7eba02022-07-21 23:53:20 +0000907 parameter["AllowableValues"] = std::move(allowed);
Patrick Williamsad539542023-05-12 10:10:08 -0500908 parameters.emplace_back(std::move(parameter));
P.K. Leedd99e042020-06-17 19:43:16 +0800909
Nan Zhoucf7eba02022-07-21 23:53:20 +0000910 asyncResp->res.jsonValue["Parameters"] = std::move(parameters);
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700911}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530912
913/**
914 * ChassisResetActionInfo derived class for delivering Chassis
915 * ResetType AllowableValues using ResetInfo schema.
916 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700917inline void requestRoutesChassisResetActionInfo(App& app)
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530918{
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700919 BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/ResetActionInfo/")
Ed Tanoused398212021-06-09 17:05:54 -0700920 .privileges(redfish::privileges::getActionInfo)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700921 .methods(boost::beast::http::verb::get)(
Nan Zhoucf7eba02022-07-21 23:53:20 +0000922 std::bind_front(handleChassisResetActionInfoGet, std::ref(app)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700923}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530924
Ed Tanous1abe55e2018-09-05 08:30:59 -0700925} // namespace redfish