Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 1 | /* |
| 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 Tu | 13451e3 | 2023-05-24 16:08:18 -0700 | [diff] [blame] | 18 | #include "bmcweb_config.h" |
| 19 | |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 20 | #include "app.hpp" |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 21 | #include "dbus_utility.hpp" |
James Feist | b49ac87 | 2019-05-21 15:12:01 -0700 | [diff] [blame] | 22 | #include "health.hpp" |
James Feist | 1c8fba9 | 2019-12-20 15:12:07 -0800 | [diff] [blame] | 23 | #include "led.hpp" |
Ed Tanous | 3ccb3ad | 2023-01-13 17:40:03 -0800 | [diff] [blame] | 24 | #include "query.hpp" |
| 25 | #include "registries/privilege_registry.hpp" |
| 26 | #include "utils/collection.hpp" |
| 27 | #include "utils/dbus_utils.hpp" |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 28 | #include "utils/json_utils.hpp" |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 29 | |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 30 | #include <boost/system/error_code.hpp> |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 31 | #include <boost/url/format.hpp> |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 32 | #include <sdbusplus/asio/property.hpp> |
Andrew Geissler | fc903b3 | 2023-05-31 14:15:42 -0400 | [diff] [blame] | 33 | #include <sdbusplus/message.hpp> |
Krzysztof Grobelny | 86d89ed | 2022-08-29 14:49:20 +0200 | [diff] [blame] | 34 | #include <sdbusplus/unpack_properties.hpp> |
Gunnar Mills | 1214b7e | 2020-06-04 10:11:30 -0500 | [diff] [blame] | 35 | |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 36 | #include <array> |
| 37 | #include <string_view> |
| 38 | |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 39 | namespace redfish |
| 40 | { |
Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 41 | |
| 42 | /** |
Willy Tu | 5e577bc | 2022-07-26 00:41:55 +0000 | [diff] [blame] | 43 | * @brief Retrieves resources over dbus to link to the chassis |
| 44 | * |
| 45 | * @param[in] asyncResp - Shared pointer for completing asynchronous |
| 46 | * calls |
| 47 | * @param[in] path - Chassis dbus path to look for the storage. |
| 48 | * |
| 49 | * Calls the Association endpoints on the path + "/storage" and add the link of |
| 50 | * json["Links"]["Storage@odata.count"] = |
| 51 | * {"@odata.id", "/redfish/v1/Storage/" + resourceId} |
| 52 | * |
| 53 | * @return None. |
| 54 | */ |
| 55 | inline void getStorageLink(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 56 | const sdbusplus::message::object_path& path) |
| 57 | { |
| 58 | sdbusplus::asio::getProperty<std::vector<std::string>>( |
| 59 | *crow::connections::systemBus, "xyz.openbmc_project.ObjectMapper", |
| 60 | (path / "storage").str, "xyz.openbmc_project.Association", "endpoints", |
Willy Tu | d4b054c | 2023-06-12 15:18:45 -0700 | [diff] [blame] | 61 | [asyncResp](const boost::system::error_code& ec, |
Willy Tu | 5e577bc | 2022-07-26 00:41:55 +0000 | [diff] [blame] | 62 | const std::vector<std::string>& storageList) { |
| 63 | if (ec) |
| 64 | { |
| 65 | BMCWEB_LOG_DEBUG << "getStorageLink got DBUS response error"; |
| 66 | return; |
| 67 | } |
| 68 | |
| 69 | nlohmann::json::array_t storages; |
| 70 | for (const std::string& storagePath : storageList) |
| 71 | { |
| 72 | std::string id = |
| 73 | sdbusplus::message::object_path(storagePath).filename(); |
| 74 | if (id.empty()) |
| 75 | { |
| 76 | continue; |
| 77 | } |
| 78 | |
| 79 | nlohmann::json::object_t storage; |
| 80 | storage["@odata.id"] = boost::urls::format( |
| 81 | "/redfish/v1/Systems/system/Storage/{}", id); |
| 82 | storages.emplace_back(std::move(storage)); |
| 83 | } |
| 84 | asyncResp->res.jsonValue["Links"]["Storage@odata.count"] = |
| 85 | storages.size(); |
| 86 | asyncResp->res.jsonValue["Links"]["Storage"] = std::move(storages); |
| 87 | }); |
| 88 | } |
| 89 | |
| 90 | /** |
Gunnar Mills | beeca0a | 2019-02-14 16:30:45 -0600 | [diff] [blame] | 91 | * @brief Retrieves chassis state properties over dbus |
| 92 | * |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 93 | * @param[in] asyncResp - Shared pointer for completing asynchronous calls. |
Gunnar Mills | beeca0a | 2019-02-14 16:30:45 -0600 | [diff] [blame] | 94 | * |
| 95 | * @return None. |
| 96 | */ |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 97 | inline void getChassisState(std::shared_ptr<bmcweb::AsyncResp> asyncResp) |
Gunnar Mills | beeca0a | 2019-02-14 16:30:45 -0600 | [diff] [blame] | 98 | { |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 99 | // crow::connections::systemBus->async_method_call( |
| 100 | sdbusplus::asio::getProperty<std::string>( |
| 101 | *crow::connections::systemBus, "xyz.openbmc_project.State.Chassis", |
| 102 | "/xyz/openbmc_project/state/chassis0", |
| 103 | "xyz.openbmc_project.State.Chassis", "CurrentPowerState", |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 104 | [asyncResp{std::move(asyncResp)}](const boost::system::error_code& ec, |
| 105 | const std::string& chassisState) { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 106 | if (ec) |
| 107 | { |
| 108 | if (ec == boost::system::errc::host_unreachable) |
Gunnar Mills | beeca0a | 2019-02-14 16:30:45 -0600 | [diff] [blame] | 109 | { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 110 | // Service not available, no error, just don't return |
| 111 | // chassis state info |
| 112 | BMCWEB_LOG_DEBUG << "Service not available " << ec; |
Gunnar Mills | beeca0a | 2019-02-14 16:30:45 -0600 | [diff] [blame] | 113 | return; |
| 114 | } |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 115 | BMCWEB_LOG_DEBUG << "DBUS response error " << ec; |
| 116 | messages::internalError(asyncResp->res); |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 117 | return; |
| 118 | } |
Gunnar Mills | beeca0a | 2019-02-14 16:30:45 -0600 | [diff] [blame] | 119 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 120 | BMCWEB_LOG_DEBUG << "Chassis state: " << chassisState; |
| 121 | // Verify Chassis State |
| 122 | if (chassisState == "xyz.openbmc_project.State.Chassis.PowerState.On") |
| 123 | { |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 124 | asyncResp->res.jsonValue["PowerState"] = "On"; |
| 125 | asyncResp->res.jsonValue["Status"]["State"] = "Enabled"; |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 126 | } |
| 127 | else if (chassisState == |
| 128 | "xyz.openbmc_project.State.Chassis.PowerState.Off") |
| 129 | { |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 130 | asyncResp->res.jsonValue["PowerState"] = "Off"; |
| 131 | asyncResp->res.jsonValue["Status"]["State"] = "StandbyOffline"; |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 132 | } |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 133 | }); |
Gunnar Mills | beeca0a | 2019-02-14 16:30:45 -0600 | [diff] [blame] | 134 | } |
| 135 | |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 136 | inline void getIntrusionByService(std::shared_ptr<bmcweb::AsyncResp> asyncResp, |
Ed Tanous | 23a21a1 | 2020-07-25 04:45:05 +0000 | [diff] [blame] | 137 | const std::string& service, |
| 138 | const std::string& objPath) |
Qiang XU | c181942 | 2019-02-27 13:51:32 +0800 | [diff] [blame] | 139 | { |
| 140 | BMCWEB_LOG_DEBUG << "Get intrusion status by service \n"; |
| 141 | |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 142 | sdbusplus::asio::getProperty<std::string>( |
| 143 | *crow::connections::systemBus, service, objPath, |
| 144 | "xyz.openbmc_project.Chassis.Intrusion", "Status", |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 145 | [asyncResp{std::move(asyncResp)}](const boost::system::error_code& ec, |
| 146 | const std::string& value) { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 147 | if (ec) |
| 148 | { |
| 149 | // do not add err msg in redfish response, because this is not |
| 150 | // mandatory property |
| 151 | BMCWEB_LOG_ERROR << "DBUS response error " << ec << "\n"; |
| 152 | return; |
| 153 | } |
Qiang XU | c181942 | 2019-02-27 13:51:32 +0800 | [diff] [blame] | 154 | |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 155 | asyncResp->res.jsonValue["PhysicalSecurity"]["IntrusionSensorNumber"] = |
| 156 | 1; |
| 157 | asyncResp->res.jsonValue["PhysicalSecurity"]["IntrusionSensor"] = value; |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 158 | }); |
Qiang XU | c181942 | 2019-02-27 13:51:32 +0800 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | /** |
| 162 | * Retrieves physical security properties over dbus |
| 163 | */ |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 164 | inline void |
| 165 | getPhysicalSecurityData(std::shared_ptr<bmcweb::AsyncResp> asyncResp) |
Qiang XU | c181942 | 2019-02-27 13:51:32 +0800 | [diff] [blame] | 166 | { |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 167 | constexpr std::array<std::string_view, 1> interfaces = { |
| 168 | "xyz.openbmc_project.Chassis.Intrusion"}; |
| 169 | dbus::utility::getSubTree( |
| 170 | "/xyz/openbmc_project/Intrusion", 1, interfaces, |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 171 | [asyncResp{std::move(asyncResp)}]( |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 172 | const boost::system::error_code& ec, |
Ed Tanous | b9d36b4 | 2022-02-26 21:42:46 -0800 | [diff] [blame] | 173 | const dbus::utility::MapperGetSubTreeResponse& subtree) { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 174 | if (ec) |
| 175 | { |
| 176 | // do not add err msg in redfish response, because this is not |
| 177 | // mandatory property |
| 178 | BMCWEB_LOG_INFO << "DBUS error: no matched iface " << ec << "\n"; |
| 179 | return; |
| 180 | } |
| 181 | // Iterate over all retrieved ObjectPaths. |
| 182 | for (const auto& object : subtree) |
| 183 | { |
Patrick Williams | 840a9ff | 2023-05-12 10:18:43 -0500 | [diff] [blame] | 184 | if (!object.second.empty()) |
Qiang XU | c181942 | 2019-02-27 13:51:32 +0800 | [diff] [blame] | 185 | { |
Patrick Williams | 840a9ff | 2023-05-12 10:18:43 -0500 | [diff] [blame] | 186 | const auto service = object.second.front(); |
Ed Tanous | ac106bf | 2023-06-07 09:24:59 -0700 | [diff] [blame] | 187 | getIntrusionByService(asyncResp, service.first, object.first); |
Qiang XU | c181942 | 2019-02-27 13:51:32 +0800 | [diff] [blame] | 188 | return; |
| 189 | } |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 190 | } |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 191 | }); |
Qiang XU | c181942 | 2019-02-27 13:51:32 +0800 | [diff] [blame] | 192 | } |
| 193 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 194 | inline void handleChassisCollectionGet( |
| 195 | App& app, const crow::Request& req, |
| 196 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) |
| 197 | { |
| 198 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| 199 | { |
| 200 | return; |
| 201 | } |
| 202 | asyncResp->res.jsonValue["@odata.type"] = |
| 203 | "#ChassisCollection.ChassisCollection"; |
| 204 | asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Chassis"; |
| 205 | asyncResp->res.jsonValue["Name"] = "Chassis Collection"; |
| 206 | |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 207 | constexpr std::array<std::string_view, 2> interfaces{ |
| 208 | "xyz.openbmc_project.Inventory.Item.Board", |
| 209 | "xyz.openbmc_project.Inventory.Item.Chassis"}; |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 210 | collection_util::getCollectionMembers( |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 211 | asyncResp, boost::urls::url("/redfish/v1/Chassis"), interfaces); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 212 | } |
| 213 | |
Jie Yang | a561749 | 2021-06-29 12:59:14 -0700 | [diff] [blame^] | 214 | inline void getChassisContainedBy( |
| 215 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 216 | const std::string& chassisId, const boost::system::error_code& ec, |
| 217 | const dbus::utility::MapperEndPoints& upstreamChassisPaths) |
| 218 | { |
| 219 | if (ec) |
| 220 | { |
| 221 | if (ec.value() != EBADR) |
| 222 | { |
| 223 | BMCWEB_LOG_ERROR << "DBUS response error " << ec; |
| 224 | messages::internalError(asyncResp->res); |
| 225 | } |
| 226 | return; |
| 227 | } |
| 228 | if (upstreamChassisPaths.empty()) |
| 229 | { |
| 230 | return; |
| 231 | } |
| 232 | if (upstreamChassisPaths.size() > 1) |
| 233 | { |
| 234 | BMCWEB_LOG_ERROR << chassisId << " is contained by mutliple chassis"; |
| 235 | messages::internalError(asyncResp->res); |
| 236 | return; |
| 237 | } |
| 238 | |
| 239 | sdbusplus::message::object_path upstreamChassisPath( |
| 240 | upstreamChassisPaths[0]); |
| 241 | std::string upstreamChassis = upstreamChassisPath.filename(); |
| 242 | if (upstreamChassis.empty()) |
| 243 | { |
| 244 | BMCWEB_LOG_WARNING << "Malformed upstream Chassis path " |
| 245 | << upstreamChassisPath.str << " on " << chassisId; |
| 246 | return; |
| 247 | } |
| 248 | |
| 249 | asyncResp->res.jsonValue["Links"]["ContainedBy"]["@odata.id"] = |
| 250 | boost::urls::format("/redfish/v1/Chassis/{}", upstreamChassis); |
| 251 | } |
| 252 | |
| 253 | inline void getChassisContains( |
| 254 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 255 | const std::string& chassisId, const boost::system::error_code& ec, |
| 256 | const dbus::utility::MapperEndPoints& downstreamChassisPaths) |
| 257 | { |
| 258 | if (ec) |
| 259 | { |
| 260 | if (ec.value() != EBADR) |
| 261 | { |
| 262 | BMCWEB_LOG_ERROR << "DBUS response error " << ec; |
| 263 | messages::internalError(asyncResp->res); |
| 264 | } |
| 265 | return; |
| 266 | } |
| 267 | if (downstreamChassisPaths.empty()) |
| 268 | { |
| 269 | return; |
| 270 | } |
| 271 | nlohmann::json& jValue = asyncResp->res.jsonValue["Links"]["Contains"]; |
| 272 | if (!jValue.is_array()) |
| 273 | { |
| 274 | // Create the array if it was empty |
| 275 | jValue = nlohmann::json::array(); |
| 276 | } |
| 277 | for (const auto& p : downstreamChassisPaths) |
| 278 | { |
| 279 | sdbusplus::message::object_path downstreamChassisPath(p); |
| 280 | std::string downstreamChassis = downstreamChassisPath.filename(); |
| 281 | if (downstreamChassis.empty()) |
| 282 | { |
| 283 | BMCWEB_LOG_WARNING << "Malformed downstream Chassis path " |
| 284 | << downstreamChassisPath.str << " on " |
| 285 | << chassisId; |
| 286 | continue; |
| 287 | } |
| 288 | nlohmann::json link; |
| 289 | link["@odata.id"] = boost::urls::format("/redfish/v1/Chassis/{}", |
| 290 | downstreamChassis); |
| 291 | jValue.push_back(std::move(link)); |
| 292 | } |
| 293 | asyncResp->res.jsonValue["Links"]["Contains@odata.count"] = jValue.size(); |
| 294 | } |
| 295 | |
| 296 | inline void |
| 297 | getChassisConnectivity(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 298 | const std::string& chassisId, |
| 299 | const std::string& chassisPath) |
| 300 | { |
| 301 | BMCWEB_LOG_DEBUG << "Get chassis connectivity"; |
| 302 | |
| 303 | dbus::utility::getAssociationEndPoints( |
| 304 | chassisPath + "/contained_by", |
| 305 | std::bind_front(getChassisContainedBy, asyncResp, chassisId)); |
| 306 | |
| 307 | dbus::utility::getAssociationEndPoints( |
| 308 | chassisPath + "/containing", |
| 309 | std::bind_front(getChassisContains, asyncResp, chassisId)); |
| 310 | } |
| 311 | |
Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 312 | /** |
Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 313 | * ChassisCollection derived class for delivering Chassis Collection Schema |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 314 | * Functions triggers appropriate requests on DBus |
Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 315 | */ |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 316 | inline void requestRoutesChassisCollection(App& app) |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 317 | { |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 318 | BMCWEB_ROUTE(app, "/redfish/v1/Chassis/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 319 | .privileges(redfish::privileges::getChassisCollection) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 320 | .methods(boost::beast::http::verb::get)( |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 321 | std::bind_front(handleChassisCollectionGet, std::ref(app))); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 322 | } |
Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 323 | |
Willy Tu | 308f70c | 2021-09-28 20:24:52 -0700 | [diff] [blame] | 324 | inline void |
| 325 | getChassisLocationCode(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 326 | const std::string& connectionName, |
| 327 | const std::string& path) |
| 328 | { |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 329 | sdbusplus::asio::getProperty<std::string>( |
| 330 | *crow::connections::systemBus, connectionName, path, |
| 331 | "xyz.openbmc_project.Inventory.Decorator.LocationCode", "LocationCode", |
Ed Tanous | 5e7e2dc | 2023-02-16 10:37:01 -0800 | [diff] [blame] | 332 | [asyncResp](const boost::system::error_code& ec, |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 333 | const std::string& property) { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 334 | if (ec) |
| 335 | { |
Andrew Geissler | 51dab2a | 2023-05-30 15:07:46 -0400 | [diff] [blame] | 336 | BMCWEB_LOG_ERROR << "DBUS response error for Location"; |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 337 | messages::internalError(asyncResp->res); |
| 338 | return; |
| 339 | } |
Willy Tu | 308f70c | 2021-09-28 20:24:52 -0700 | [diff] [blame] | 340 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 341 | asyncResp->res.jsonValue["Location"]["PartLocation"]["ServiceLabel"] = |
| 342 | property; |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 343 | }); |
Willy Tu | 308f70c | 2021-09-28 20:24:52 -0700 | [diff] [blame] | 344 | } |
| 345 | |
| 346 | inline void getChassisUUID(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 347 | const std::string& connectionName, |
| 348 | const std::string& path) |
| 349 | { |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 350 | sdbusplus::asio::getProperty<std::string>( |
| 351 | *crow::connections::systemBus, connectionName, path, |
| 352 | "xyz.openbmc_project.Common.UUID", "UUID", |
Ed Tanous | 5e7e2dc | 2023-02-16 10:37:01 -0800 | [diff] [blame] | 353 | [asyncResp](const boost::system::error_code& ec, |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 354 | const std::string& chassisUUID) { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 355 | if (ec) |
| 356 | { |
Andrew Geissler | 51dab2a | 2023-05-30 15:07:46 -0400 | [diff] [blame] | 357 | BMCWEB_LOG_ERROR << "DBUS response error for UUID"; |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 358 | messages::internalError(asyncResp->res); |
| 359 | return; |
| 360 | } |
| 361 | asyncResp->res.jsonValue["UUID"] = chassisUUID; |
Jonathan Doman | 1e1e598 | 2021-06-11 09:36:17 -0700 | [diff] [blame] | 362 | }); |
Willy Tu | 308f70c | 2021-09-28 20:24:52 -0700 | [diff] [blame] | 363 | } |
| 364 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 365 | inline void |
| 366 | handleChassisGet(App& app, const crow::Request& req, |
| 367 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 368 | const std::string& chassisId) |
| 369 | { |
| 370 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| 371 | { |
| 372 | return; |
| 373 | } |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 374 | constexpr std::array<std::string_view, 2> interfaces = { |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 375 | "xyz.openbmc_project.Inventory.Item.Board", |
| 376 | "xyz.openbmc_project.Inventory.Item.Chassis"}; |
| 377 | |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 378 | dbus::utility::getSubTree( |
| 379 | "/xyz/openbmc_project/inventory", 0, interfaces, |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 380 | [asyncResp, chassisId(std::string(chassisId))]( |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 381 | const boost::system::error_code& ec, |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 382 | const dbus::utility::MapperGetSubTreeResponse& subtree) { |
| 383 | if (ec) |
| 384 | { |
Andrew Geissler | 51dab2a | 2023-05-30 15:07:46 -0400 | [diff] [blame] | 385 | BMCWEB_LOG_ERROR << "DBUS response error " << ec; |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 386 | messages::internalError(asyncResp->res); |
| 387 | return; |
| 388 | } |
| 389 | // Iterate over all retrieved ObjectPaths. |
| 390 | for (const std::pair< |
| 391 | std::string, |
| 392 | std::vector<std::pair<std::string, std::vector<std::string>>>>& |
| 393 | object : subtree) |
| 394 | { |
| 395 | const std::string& path = object.first; |
| 396 | const std::vector<std::pair<std::string, std::vector<std::string>>>& |
| 397 | connectionNames = object.second; |
| 398 | |
| 399 | sdbusplus::message::object_path objPath(path); |
| 400 | if (objPath.filename() != chassisId) |
| 401 | { |
| 402 | continue; |
| 403 | } |
| 404 | |
Jie Yang | a561749 | 2021-06-29 12:59:14 -0700 | [diff] [blame^] | 405 | getChassisConnectivity(asyncResp, chassisId, path); |
| 406 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 407 | auto health = std::make_shared<HealthPopulate>(asyncResp); |
| 408 | |
Willy Tu | 13451e3 | 2023-05-24 16:08:18 -0700 | [diff] [blame] | 409 | if constexpr (bmcwebEnableHealthPopulate) |
| 410 | { |
| 411 | dbus::utility::getAssociationEndPoints( |
| 412 | path + "/all_sensors", |
| 413 | [health](const boost::system::error_code& ec2, |
| 414 | const dbus::utility::MapperEndPoints& resp) { |
| 415 | if (ec2) |
| 416 | { |
| 417 | return; // no sensors = no failures |
| 418 | } |
| 419 | health->inventory = resp; |
| 420 | }); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 421 | |
Willy Tu | 13451e3 | 2023-05-24 16:08:18 -0700 | [diff] [blame] | 422 | health->populate(); |
| 423 | } |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 424 | |
| 425 | if (connectionNames.empty()) |
| 426 | { |
| 427 | BMCWEB_LOG_ERROR << "Got 0 Connection names"; |
| 428 | continue; |
| 429 | } |
| 430 | |
| 431 | asyncResp->res.jsonValue["@odata.type"] = |
Logananth Sundararaj | 523d486 | 2023-01-24 11:56:28 +0530 | [diff] [blame] | 432 | "#Chassis.v1_22_0.Chassis"; |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 433 | asyncResp->res.jsonValue["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 434 | boost::urls::format("/redfish/v1/Chassis/{}", chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 435 | asyncResp->res.jsonValue["Name"] = "Chassis Collection"; |
| 436 | asyncResp->res.jsonValue["ChassisType"] = "RackMount"; |
| 437 | asyncResp->res.jsonValue["Actions"]["#Chassis.Reset"]["target"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 438 | boost::urls::format( |
| 439 | "/redfish/v1/Chassis/{}/Actions/Chassis.Reset", chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 440 | asyncResp->res |
| 441 | .jsonValue["Actions"]["#Chassis.Reset"]["@Redfish.ActionInfo"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 442 | boost::urls::format("/redfish/v1/Chassis/{}/ResetActionInfo", |
| 443 | chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 444 | asyncResp->res.jsonValue["PCIeDevices"]["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 445 | "/redfish/v1/Systems/system/PCIeDevices"; |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 446 | |
George Liu | 6c3e945 | 2023-03-03 13:55:29 +0800 | [diff] [blame] | 447 | dbus::utility::getAssociationEndPoints( |
| 448 | path + "/drive", |
| 449 | [asyncResp, |
| 450 | chassisId](const boost::system::error_code& ec3, |
| 451 | const dbus::utility::MapperEndPoints& resp) { |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 452 | if (ec3 || resp.empty()) |
| 453 | { |
| 454 | return; // no drives = no failures |
| 455 | } |
| 456 | |
| 457 | nlohmann::json reference; |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 458 | reference["@odata.id"] = boost::urls::format( |
| 459 | "/redfish/v1/Chassis/{}/Drives", chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 460 | asyncResp->res.jsonValue["Drives"] = std::move(reference); |
| 461 | }); |
| 462 | |
| 463 | const std::string& connectionName = connectionNames[0].first; |
| 464 | |
| 465 | const std::vector<std::string>& interfaces2 = |
| 466 | connectionNames[0].second; |
| 467 | const std::array<const char*, 2> hasIndicatorLed = { |
| 468 | "xyz.openbmc_project.Inventory.Item.Panel", |
| 469 | "xyz.openbmc_project.Inventory.Item.Board.Motherboard"}; |
| 470 | |
| 471 | const std::string assetTagInterface = |
| 472 | "xyz.openbmc_project.Inventory.Decorator.AssetTag"; |
Logananth Sundararaj | 523d486 | 2023-01-24 11:56:28 +0530 | [diff] [blame] | 473 | const std::string replaceableInterface = |
| 474 | "xyz.openbmc_project.Inventory.Decorator.Replaceable"; |
| 475 | for (const auto& interface : interfaces2) |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 476 | { |
Logananth Sundararaj | 523d486 | 2023-01-24 11:56:28 +0530 | [diff] [blame] | 477 | if (interface == assetTagInterface) |
| 478 | { |
| 479 | sdbusplus::asio::getProperty<std::string>( |
| 480 | *crow::connections::systemBus, connectionName, path, |
| 481 | assetTagInterface, "AssetTag", |
| 482 | [asyncResp, |
| 483 | chassisId](const boost::system::error_code& ec2, |
| 484 | const std::string& property) { |
| 485 | if (ec2) |
| 486 | { |
| 487 | BMCWEB_LOG_ERROR |
| 488 | << "DBus response error for AssetTag: " << ec2; |
| 489 | messages::internalError(asyncResp->res); |
| 490 | return; |
| 491 | } |
| 492 | asyncResp->res.jsonValue["AssetTag"] = property; |
| 493 | }); |
| 494 | } |
| 495 | else if (interface == replaceableInterface) |
| 496 | { |
| 497 | sdbusplus::asio::getProperty<bool>( |
| 498 | *crow::connections::systemBus, connectionName, path, |
| 499 | replaceableInterface, "HotPluggable", |
| 500 | [asyncResp, |
| 501 | chassisId](const boost::system::error_code& ec2, |
| 502 | const bool property) { |
| 503 | if (ec2) |
| 504 | { |
| 505 | BMCWEB_LOG_ERROR |
| 506 | << "DBus response error for HotPluggable: " |
| 507 | << ec2; |
| 508 | messages::internalError(asyncResp->res); |
| 509 | return; |
| 510 | } |
| 511 | asyncResp->res.jsonValue["HotPluggable"] = property; |
| 512 | }); |
| 513 | } |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 514 | } |
| 515 | |
| 516 | for (const char* interface : hasIndicatorLed) |
| 517 | { |
| 518 | if (std::find(interfaces2.begin(), interfaces2.end(), |
| 519 | interface) != interfaces2.end()) |
| 520 | { |
| 521 | getIndicatorLedState(asyncResp); |
| 522 | getLocationIndicatorActive(asyncResp); |
| 523 | break; |
| 524 | } |
| 525 | } |
| 526 | |
Krzysztof Grobelny | 86d89ed | 2022-08-29 14:49:20 +0200 | [diff] [blame] | 527 | sdbusplus::asio::getAllProperties( |
| 528 | *crow::connections::systemBus, connectionName, path, |
| 529 | "xyz.openbmc_project.Inventory.Decorator.Asset", |
Willy Tu | 5e577bc | 2022-07-26 00:41:55 +0000 | [diff] [blame] | 530 | [asyncResp, chassisId(std::string(chassisId)), |
| 531 | path](const boost::system::error_code& /*ec2*/, |
| 532 | const dbus::utility::DBusPropertiesMap& propertiesList) { |
Krzysztof Grobelny | 86d89ed | 2022-08-29 14:49:20 +0200 | [diff] [blame] | 533 | const std::string* partNumber = nullptr; |
| 534 | const std::string* serialNumber = nullptr; |
| 535 | const std::string* manufacturer = nullptr; |
| 536 | const std::string* model = nullptr; |
| 537 | const std::string* sparePartNumber = nullptr; |
| 538 | |
| 539 | const bool success = sdbusplus::unpackPropertiesNoThrow( |
| 540 | dbus_utils::UnpackErrorPrinter(), propertiesList, |
| 541 | "PartNumber", partNumber, "SerialNumber", serialNumber, |
| 542 | "Manufacturer", manufacturer, "Model", model, |
| 543 | "SparePartNumber", sparePartNumber); |
| 544 | |
| 545 | if (!success) |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 546 | { |
Krzysztof Grobelny | 86d89ed | 2022-08-29 14:49:20 +0200 | [diff] [blame] | 547 | messages::internalError(asyncResp->res); |
| 548 | return; |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 549 | } |
Krzysztof Grobelny | 86d89ed | 2022-08-29 14:49:20 +0200 | [diff] [blame] | 550 | |
| 551 | if (partNumber != nullptr) |
| 552 | { |
| 553 | asyncResp->res.jsonValue["PartNumber"] = *partNumber; |
| 554 | } |
| 555 | |
| 556 | if (serialNumber != nullptr) |
| 557 | { |
| 558 | asyncResp->res.jsonValue["SerialNumber"] = *serialNumber; |
| 559 | } |
| 560 | |
| 561 | if (manufacturer != nullptr) |
| 562 | { |
| 563 | asyncResp->res.jsonValue["Manufacturer"] = *manufacturer; |
| 564 | } |
| 565 | |
| 566 | if (model != nullptr) |
| 567 | { |
| 568 | asyncResp->res.jsonValue["Model"] = *model; |
| 569 | } |
| 570 | |
| 571 | // SparePartNumber is optional on D-Bus |
| 572 | // so skip if it is empty |
| 573 | if (sparePartNumber != nullptr && !sparePartNumber->empty()) |
| 574 | { |
| 575 | asyncResp->res.jsonValue["SparePartNumber"] = |
| 576 | *sparePartNumber; |
| 577 | } |
| 578 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 579 | asyncResp->res.jsonValue["Name"] = chassisId; |
| 580 | asyncResp->res.jsonValue["Id"] = chassisId; |
| 581 | #ifdef BMCWEB_ALLOW_DEPRECATED_POWER_THERMAL |
| 582 | asyncResp->res.jsonValue["Thermal"]["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 583 | boost::urls::format("/redfish/v1/Chassis/{}/Thermal", |
| 584 | chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 585 | // Power object |
| 586 | asyncResp->res.jsonValue["Power"]["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 587 | boost::urls::format("/redfish/v1/Chassis/{}/Power", |
| 588 | chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 589 | #endif |
Xiaochao Ma | 2973963 | 2021-03-02 15:53:13 +0800 | [diff] [blame] | 590 | #ifdef BMCWEB_NEW_POWERSUBSYSTEM_THERMALSUBSYSTEM |
| 591 | asyncResp->res.jsonValue["ThermalSubsystem"]["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 592 | boost::urls::format( |
| 593 | "/redfish/v1/Chassis/{}/ThermalSubsystem", chassisId); |
Chicago Duan | 77b3643 | 2021-02-05 15:48:26 +0800 | [diff] [blame] | 594 | asyncResp->res.jsonValue["PowerSubsystem"]["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 595 | boost::urls::format("/redfish/v1/Chassis/{}/PowerSubsystem", |
| 596 | chassisId); |
Albert Zhang | 4ca3ec3 | 2021-06-13 14:39:38 +0800 | [diff] [blame] | 597 | asyncResp->res.jsonValue["EnvironmentMetrics"]["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 598 | boost::urls::format( |
| 599 | "/redfish/v1/Chassis/{}/EnvironmentMetrics", chassisId); |
Xiaochao Ma | 2973963 | 2021-03-02 15:53:13 +0800 | [diff] [blame] | 600 | #endif |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 601 | // SensorCollection |
| 602 | asyncResp->res.jsonValue["Sensors"]["@odata.id"] = |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 603 | boost::urls::format("/redfish/v1/Chassis/{}/Sensors", |
| 604 | chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 605 | asyncResp->res.jsonValue["Status"]["State"] = "Enabled"; |
| 606 | |
| 607 | nlohmann::json::array_t computerSystems; |
| 608 | nlohmann::json::object_t system; |
| 609 | system["@odata.id"] = "/redfish/v1/Systems/system"; |
Patrick Williams | ad53954 | 2023-05-12 10:10:08 -0500 | [diff] [blame] | 610 | computerSystems.emplace_back(std::move(system)); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 611 | asyncResp->res.jsonValue["Links"]["ComputerSystems"] = |
| 612 | std::move(computerSystems); |
| 613 | |
| 614 | nlohmann::json::array_t managedBy; |
| 615 | nlohmann::json::object_t manager; |
| 616 | manager["@odata.id"] = "/redfish/v1/Managers/bmc"; |
Patrick Williams | ad53954 | 2023-05-12 10:10:08 -0500 | [diff] [blame] | 617 | managedBy.emplace_back(std::move(manager)); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 618 | asyncResp->res.jsonValue["Links"]["ManagedBy"] = |
| 619 | std::move(managedBy); |
| 620 | getChassisState(asyncResp); |
Willy Tu | 5e577bc | 2022-07-26 00:41:55 +0000 | [diff] [blame] | 621 | getStorageLink(asyncResp, path); |
Krzysztof Grobelny | 86d89ed | 2022-08-29 14:49:20 +0200 | [diff] [blame] | 622 | }); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 623 | |
| 624 | for (const auto& interface : interfaces2) |
| 625 | { |
| 626 | if (interface == "xyz.openbmc_project.Common.UUID") |
| 627 | { |
| 628 | getChassisUUID(asyncResp, connectionName, path); |
| 629 | } |
| 630 | else if (interface == |
| 631 | "xyz.openbmc_project.Inventory.Decorator.LocationCode") |
| 632 | { |
| 633 | getChassisLocationCode(asyncResp, connectionName, path); |
| 634 | } |
| 635 | } |
| 636 | |
| 637 | return; |
| 638 | } |
| 639 | |
| 640 | // Couldn't find an object with that name. return an error |
Jiaqing Zhao | d8a5d5d | 2022-08-05 16:21:51 +0800 | [diff] [blame] | 641 | messages::resourceNotFound(asyncResp->res, "Chassis", chassisId); |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 642 | }); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 643 | |
| 644 | getPhysicalSecurityData(asyncResp); |
| 645 | } |
| 646 | |
| 647 | inline void |
| 648 | handleChassisPatch(App& app, const crow::Request& req, |
| 649 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 650 | const std::string& param) |
| 651 | { |
| 652 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| 653 | { |
| 654 | return; |
| 655 | } |
| 656 | std::optional<bool> locationIndicatorActive; |
| 657 | std::optional<std::string> indicatorLed; |
| 658 | |
| 659 | if (param.empty()) |
| 660 | { |
| 661 | return; |
| 662 | } |
| 663 | |
| 664 | if (!json_util::readJsonPatch( |
| 665 | req, asyncResp->res, "LocationIndicatorActive", |
| 666 | locationIndicatorActive, "IndicatorLED", indicatorLed)) |
| 667 | { |
| 668 | return; |
| 669 | } |
| 670 | |
| 671 | // TODO (Gunnar): Remove IndicatorLED after enough time has passed |
| 672 | if (!locationIndicatorActive && !indicatorLed) |
| 673 | { |
| 674 | return; // delete this when we support more patch properties |
| 675 | } |
| 676 | if (indicatorLed) |
| 677 | { |
| 678 | asyncResp->res.addHeader( |
| 679 | boost::beast::http::field::warning, |
| 680 | "299 - \"IndicatorLED is deprecated. Use LocationIndicatorActive instead.\""); |
| 681 | } |
| 682 | |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 683 | constexpr std::array<std::string_view, 2> interfaces = { |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 684 | "xyz.openbmc_project.Inventory.Item.Board", |
| 685 | "xyz.openbmc_project.Inventory.Item.Chassis"}; |
| 686 | |
| 687 | const std::string& chassisId = param; |
| 688 | |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 689 | dbus::utility::getSubTree( |
| 690 | "/xyz/openbmc_project/inventory", 0, interfaces, |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 691 | [asyncResp, chassisId, locationIndicatorActive, |
Ed Tanous | 5e7e2dc | 2023-02-16 10:37:01 -0800 | [diff] [blame] | 692 | indicatorLed](const boost::system::error_code& ec, |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 693 | const dbus::utility::MapperGetSubTreeResponse& subtree) { |
| 694 | if (ec) |
| 695 | { |
Andrew Geissler | 51dab2a | 2023-05-30 15:07:46 -0400 | [diff] [blame] | 696 | BMCWEB_LOG_ERROR << "DBUS response error " << ec; |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 697 | messages::internalError(asyncResp->res); |
| 698 | return; |
| 699 | } |
| 700 | |
| 701 | // Iterate over all retrieved ObjectPaths. |
| 702 | for (const std::pair< |
| 703 | std::string, |
| 704 | std::vector<std::pair<std::string, std::vector<std::string>>>>& |
| 705 | object : subtree) |
| 706 | { |
| 707 | const std::string& path = object.first; |
| 708 | const std::vector<std::pair<std::string, std::vector<std::string>>>& |
| 709 | connectionNames = object.second; |
| 710 | |
| 711 | sdbusplus::message::object_path objPath(path); |
| 712 | if (objPath.filename() != chassisId) |
| 713 | { |
| 714 | continue; |
| 715 | } |
| 716 | |
| 717 | if (connectionNames.empty()) |
| 718 | { |
| 719 | BMCWEB_LOG_ERROR << "Got 0 Connection names"; |
| 720 | continue; |
| 721 | } |
| 722 | |
| 723 | const std::vector<std::string>& interfaces3 = |
| 724 | connectionNames[0].second; |
| 725 | |
| 726 | const std::array<const char*, 2> hasIndicatorLed = { |
| 727 | "xyz.openbmc_project.Inventory.Item.Panel", |
| 728 | "xyz.openbmc_project.Inventory.Item.Board.Motherboard"}; |
| 729 | bool indicatorChassis = false; |
| 730 | for (const char* interface : hasIndicatorLed) |
| 731 | { |
| 732 | if (std::find(interfaces3.begin(), interfaces3.end(), |
| 733 | interface) != interfaces3.end()) |
| 734 | { |
| 735 | indicatorChassis = true; |
| 736 | break; |
| 737 | } |
| 738 | } |
| 739 | if (locationIndicatorActive) |
| 740 | { |
| 741 | if (indicatorChassis) |
| 742 | { |
| 743 | setLocationIndicatorActive(asyncResp, |
| 744 | *locationIndicatorActive); |
| 745 | } |
| 746 | else |
| 747 | { |
| 748 | messages::propertyUnknown(asyncResp->res, |
| 749 | "LocationIndicatorActive"); |
| 750 | } |
| 751 | } |
| 752 | if (indicatorLed) |
| 753 | { |
| 754 | if (indicatorChassis) |
| 755 | { |
| 756 | setIndicatorLedState(asyncResp, *indicatorLed); |
| 757 | } |
| 758 | else |
| 759 | { |
| 760 | messages::propertyUnknown(asyncResp->res, "IndicatorLED"); |
| 761 | } |
| 762 | } |
| 763 | return; |
| 764 | } |
| 765 | |
Jiaqing Zhao | d8a5d5d | 2022-08-05 16:21:51 +0800 | [diff] [blame] | 766 | messages::resourceNotFound(asyncResp->res, "Chassis", chassisId); |
George Liu | e99073f | 2022-12-09 11:06:16 +0800 | [diff] [blame] | 767 | }); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 768 | } |
| 769 | |
Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 770 | /** |
| 771 | * Chassis override class for delivering Chassis Schema |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 772 | * Functions triggers appropriate requests on DBus |
Rapkiewicz, Pawel | e37f845 | 2018-03-09 13:49:50 +0100 | [diff] [blame] | 773 | */ |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 774 | inline void requestRoutesChassis(App& app) |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 775 | { |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 776 | BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 777 | .privileges(redfish::privileges::getChassis) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 778 | .methods(boost::beast::http::verb::get)( |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 779 | std::bind_front(handleChassisGet, std::ref(app))); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 780 | |
| 781 | BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 782 | .privileges(redfish::privileges::patchChassis) |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 783 | .methods(boost::beast::http::verb::patch)( |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 784 | std::bind_front(handleChassisPatch, std::ref(app))); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 785 | } |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 786 | |
Andrew Geissler | fc903b3 | 2023-05-31 14:15:42 -0400 | [diff] [blame] | 787 | /** |
| 788 | * Handle error responses from d-bus for chassis power cycles |
| 789 | */ |
| 790 | inline void handleChassisPowerCycleError(const boost::system::error_code& ec, |
| 791 | const sdbusplus::message_t& eMsg, |
| 792 | crow::Response& res) |
| 793 | { |
| 794 | if (eMsg.get_error() == nullptr) |
| 795 | { |
| 796 | BMCWEB_LOG_ERROR << "D-Bus response error: " << ec; |
| 797 | messages::internalError(res); |
| 798 | return; |
| 799 | } |
| 800 | std::string_view errorMessage = eMsg.get_error()->name; |
| 801 | |
| 802 | // If operation failed due to BMC not being in Ready state, tell |
| 803 | // user to retry in a bit |
| 804 | if (errorMessage == |
| 805 | std::string_view("xyz.openbmc_project.State.Chassis.Error.BMCNotReady")) |
| 806 | { |
| 807 | BMCWEB_LOG_DEBUG << "BMC not ready, operation not allowed right now"; |
| 808 | messages::serviceTemporarilyUnavailable(res, "10"); |
| 809 | return; |
| 810 | } |
| 811 | |
| 812 | BMCWEB_LOG_ERROR << "Chassis Power Cycle fail " << ec |
| 813 | << " sdbusplus:" << errorMessage; |
| 814 | messages::internalError(res); |
| 815 | } |
| 816 | |
zhanghch05 | 8d1b46d | 2021-04-01 11:18:24 +0800 | [diff] [blame] | 817 | inline void |
| 818 | doChassisPowerCycle(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 819 | { |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 820 | constexpr std::array<std::string_view, 1> interfaces = { |
Vijay Khemka | c3b3c92 | 2020-09-22 23:00:12 -0700 | [diff] [blame] | 821 | "xyz.openbmc_project.State.Chassis"}; |
| 822 | |
| 823 | // Use mapper to get subtree paths. |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 824 | dbus::utility::getSubTreePaths( |
| 825 | "/", 0, interfaces, |
Ed Tanous | b9d36b4 | 2022-02-26 21:42:46 -0800 | [diff] [blame] | 826 | [asyncResp]( |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 827 | const boost::system::error_code& ec, |
Ed Tanous | b9d36b4 | 2022-02-26 21:42:46 -0800 | [diff] [blame] | 828 | const dbus::utility::MapperGetSubTreePathsResponse& chassisList) { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 829 | if (ec) |
| 830 | { |
Andrew Geissler | 51dab2a | 2023-05-30 15:07:46 -0400 | [diff] [blame] | 831 | BMCWEB_LOG_ERROR << "[mapper] Bad D-Bus request error: " << ec; |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 832 | messages::internalError(asyncResp->res); |
| 833 | return; |
| 834 | } |
| 835 | |
| 836 | const char* processName = "xyz.openbmc_project.State.Chassis"; |
| 837 | const char* interfaceName = "xyz.openbmc_project.State.Chassis"; |
| 838 | const char* destProperty = "RequestedPowerTransition"; |
| 839 | const std::string propertyValue = |
| 840 | "xyz.openbmc_project.State.Chassis.Transition.PowerCycle"; |
| 841 | std::string objectPath = "/xyz/openbmc_project/state/chassis_system0"; |
| 842 | |
| 843 | /* Look for system reset chassis path */ |
| 844 | if ((std::find(chassisList.begin(), chassisList.end(), objectPath)) == |
| 845 | chassisList.end()) |
| 846 | { |
| 847 | /* We prefer to reset the full chassis_system, but if it doesn't |
| 848 | * exist on some platforms, fall back to a host-only power reset |
| 849 | */ |
| 850 | objectPath = "/xyz/openbmc_project/state/chassis0"; |
| 851 | } |
| 852 | |
George Liu | 9ae226f | 2023-06-21 17:56:46 +0800 | [diff] [blame] | 853 | sdbusplus::asio::setProperty( |
| 854 | *crow::connections::systemBus, processName, objectPath, |
| 855 | interfaceName, destProperty, propertyValue, |
Andrew Geissler | fc903b3 | 2023-05-31 14:15:42 -0400 | [diff] [blame] | 856 | [asyncResp](const boost::system::error_code& ec2, |
| 857 | sdbusplus::message_t& sdbusErrMsg) { |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 858 | // Use "Set" method to set the property value. |
Ed Tanous | 8a59281 | 2022-06-04 09:06:59 -0700 | [diff] [blame] | 859 | if (ec2) |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 860 | { |
Andrew Geissler | fc903b3 | 2023-05-31 14:15:42 -0400 | [diff] [blame] | 861 | handleChassisPowerCycleError(ec2, sdbusErrMsg, asyncResp->res); |
| 862 | |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 863 | return; |
| 864 | } |
| 865 | |
Ed Tanous | 002d39b | 2022-05-31 08:59:27 -0700 | [diff] [blame] | 866 | messages::success(asyncResp->res); |
George Liu | 9ae226f | 2023-06-21 17:56:46 +0800 | [diff] [blame] | 867 | }); |
George Liu | 7a1dbc4 | 2022-12-07 16:03:22 +0800 | [diff] [blame] | 868 | }); |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 869 | } |
| 870 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 871 | inline void handleChassisResetActionInfoPost( |
| 872 | App& app, const crow::Request& req, |
| 873 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 874 | const std::string& /*chassisId*/) |
| 875 | { |
| 876 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| 877 | { |
| 878 | return; |
| 879 | } |
| 880 | BMCWEB_LOG_DEBUG << "Post Chassis Reset."; |
| 881 | |
| 882 | std::string resetType; |
| 883 | |
| 884 | if (!json_util::readJsonAction(req, asyncResp->res, "ResetType", resetType)) |
| 885 | { |
| 886 | return; |
| 887 | } |
| 888 | |
| 889 | if (resetType != "PowerCycle") |
| 890 | { |
| 891 | BMCWEB_LOG_DEBUG << "Invalid property value for ResetType: " |
| 892 | << resetType; |
| 893 | messages::actionParameterNotSupported(asyncResp->res, resetType, |
| 894 | "ResetType"); |
| 895 | |
| 896 | return; |
| 897 | } |
| 898 | doChassisPowerCycle(asyncResp); |
| 899 | } |
| 900 | |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 901 | /** |
| 902 | * ChassisResetAction class supports the POST method for the Reset |
| 903 | * action. |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 904 | * Function handles POST method request. |
| 905 | * Analyzes POST body before sending Reset request data to D-Bus. |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 906 | */ |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 907 | |
| 908 | inline void requestRoutesChassisResetAction(App& app) |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 909 | { |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 910 | BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/Actions/Chassis.Reset/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 911 | .privileges(redfish::privileges::postChassis) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 912 | .methods(boost::beast::http::verb::post)( |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 913 | std::bind_front(handleChassisResetActionInfoPost, std::ref(app))); |
| 914 | } |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 915 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 916 | inline void handleChassisResetActionInfoGet( |
| 917 | App& app, const crow::Request& req, |
| 918 | const std::shared_ptr<bmcweb::AsyncResp>& asyncResp, |
| 919 | const std::string& chassisId) |
| 920 | { |
| 921 | if (!redfish::setUpRedfishRoute(app, req, asyncResp)) |
| 922 | { |
| 923 | return; |
| 924 | } |
| 925 | asyncResp->res.jsonValue["@odata.type"] = "#ActionInfo.v1_1_2.ActionInfo"; |
Ed Tanous | ef4c65b | 2023-04-24 15:28:50 -0700 | [diff] [blame] | 926 | asyncResp->res.jsonValue["@odata.id"] = boost::urls::format( |
| 927 | "/redfish/v1/Chassis/{}/ResetActionInfo", chassisId); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 928 | asyncResp->res.jsonValue["Name"] = "Reset Action Info"; |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 929 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 930 | asyncResp->res.jsonValue["Id"] = "ResetActionInfo"; |
| 931 | nlohmann::json::array_t parameters; |
| 932 | nlohmann::json::object_t parameter; |
| 933 | parameter["Name"] = "ResetType"; |
| 934 | parameter["Required"] = true; |
| 935 | parameter["DataType"] = "String"; |
| 936 | nlohmann::json::array_t allowed; |
Patrick Williams | ad53954 | 2023-05-12 10:10:08 -0500 | [diff] [blame] | 937 | allowed.emplace_back("PowerCycle"); |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 938 | parameter["AllowableValues"] = std::move(allowed); |
Patrick Williams | ad53954 | 2023-05-12 10:10:08 -0500 | [diff] [blame] | 939 | parameters.emplace_back(std::move(parameter)); |
P.K. Lee | dd99e04 | 2020-06-17 19:43:16 +0800 | [diff] [blame] | 940 | |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 941 | asyncResp->res.jsonValue["Parameters"] = std::move(parameters); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 942 | } |
AppaRao Puli | 1cb1a9e | 2020-07-17 23:38:57 +0530 | [diff] [blame] | 943 | |
| 944 | /** |
| 945 | * ChassisResetActionInfo derived class for delivering Chassis |
| 946 | * ResetType AllowableValues using ResetInfo schema. |
| 947 | */ |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 948 | inline void requestRoutesChassisResetActionInfo(App& app) |
AppaRao Puli | 1cb1a9e | 2020-07-17 23:38:57 +0530 | [diff] [blame] | 949 | { |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 950 | BMCWEB_ROUTE(app, "/redfish/v1/Chassis/<str>/ResetActionInfo/") |
Ed Tanous | ed39821 | 2021-06-09 17:05:54 -0700 | [diff] [blame] | 951 | .privileges(redfish::privileges::getActionInfo) |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 952 | .methods(boost::beast::http::verb::get)( |
Nan Zhou | cf7eba0 | 2022-07-21 23:53:20 +0000 | [diff] [blame] | 953 | std::bind_front(handleChassisResetActionInfoGet, std::ref(app))); |
John Edward Broadbent | 7e860f1 | 2021-04-08 15:57:16 -0700 | [diff] [blame] | 954 | } |
AppaRao Puli | 1cb1a9e | 2020-07-17 23:38:57 +0530 | [diff] [blame] | 955 | |
Ed Tanous | 1abe55e | 2018-09-05 08:30:59 -0700 | [diff] [blame] | 956 | } // namespace redfish |