blob: 5bb49082626637159664477ad66ae07081936c9c [file] [log] [blame]
Borawski.Lukasz9c3106852018-02-09 15:24:22 +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
Sui Chena51fc2d2022-07-14 17:21:53 -070020#include "app.hpp"
21#include "dbus_utility.hpp"
James Feistb49ac872019-05-21 15:12:01 -070022#include "health.hpp"
Sui Chena51fc2d2022-07-14 17:21:53 -070023#include "query.hpp"
Jennifer Leec5d03ff2019-03-08 15:42:58 -080024#include "redfish_util.hpp"
Sui Chena51fc2d2022-07-14 17:21:53 -070025#include "registries/privilege_registry.hpp"
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +020026#include "utils/dbus_utils.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080027#include "utils/json_utils.hpp"
Sui Chena51fc2d2022-07-14 17:21:53 -070028#include "utils/sw_utils.hpp"
29#include "utils/systemd_utils.hpp"
Ed Tanous2b829372022-08-03 14:22:34 -070030#include "utils/time_utils.hpp"
Borawski.Lukasz9c3106852018-02-09 15:24:22 +010031
George Liue99073f2022-12-09 11:06:16 +080032#include <boost/system/error_code.hpp>
Ed Tanousef4c65b2023-04-24 15:28:50 -070033#include <boost/url/format.hpp>
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +020034#include <sdbusplus/asio/property.hpp>
35#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050036
Ed Tanousa170f272022-06-30 21:53:27 -070037#include <algorithm>
George Liue99073f2022-12-09 11:06:16 +080038#include <array>
Gunnar Mills4bfefa72020-07-30 13:54:29 -050039#include <cstdint>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050040#include <memory>
41#include <sstream>
George Liue99073f2022-12-09 11:06:16 +080042#include <string_view>
Ed Tanousabf2add2019-01-22 16:40:12 -080043#include <variant>
James Feist5b4aa862018-08-16 14:07:01 -070044
Ed Tanous1abe55e2018-09-05 08:30:59 -070045namespace redfish
46{
Jennifer Leeed5befb2018-08-10 11:29:45 -070047
48/**
Gunnar Mills2a5c4402020-05-19 09:07:24 -050049 * Function reboots the BMC.
50 *
51 * @param[in] asyncResp - Shared pointer for completing asynchronous calls
Jennifer Leeed5befb2018-08-10 11:29:45 -070052 */
zhanghch058d1b46d2021-04-01 11:18:24 +080053inline void
54 doBMCGracefulRestart(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
Gunnar Mills2a5c4402020-05-19 09:07:24 -050055{
56 const char* processName = "xyz.openbmc_project.State.BMC";
57 const char* objectPath = "/xyz/openbmc_project/state/bmc0";
58 const char* interfaceName = "xyz.openbmc_project.State.BMC";
59 const std::string& propertyValue =
60 "xyz.openbmc_project.State.BMC.Transition.Reboot";
61 const char* destProperty = "RequestedBMCTransition";
62
63 // Create the D-Bus variant for D-Bus call.
Ed Tanous168e20c2021-12-13 14:39:53 -080064 dbus::utility::DbusVariantType dbusPropertyValue(propertyValue);
Gunnar Mills2a5c4402020-05-19 09:07:24 -050065
66 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -080067 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -070068 // Use "Set" method to set the property value.
69 if (ec)
70 {
71 BMCWEB_LOG_DEBUG << "[Set] Bad D-Bus request error: " << ec;
72 messages::internalError(asyncResp->res);
73 return;
74 }
Gunnar Mills2a5c4402020-05-19 09:07:24 -050075
Ed Tanous002d39b2022-05-31 08:59:27 -070076 messages::success(asyncResp->res);
Gunnar Mills2a5c4402020-05-19 09:07:24 -050077 },
78 processName, objectPath, "org.freedesktop.DBus.Properties", "Set",
79 interfaceName, destProperty, dbusPropertyValue);
80}
81
zhanghch058d1b46d2021-04-01 11:18:24 +080082inline void
83 doBMCForceRestart(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +000084{
85 const char* processName = "xyz.openbmc_project.State.BMC";
86 const char* objectPath = "/xyz/openbmc_project/state/bmc0";
87 const char* interfaceName = "xyz.openbmc_project.State.BMC";
88 const std::string& propertyValue =
89 "xyz.openbmc_project.State.BMC.Transition.HardReboot";
90 const char* destProperty = "RequestedBMCTransition";
91
92 // Create the D-Bus variant for D-Bus call.
Ed Tanous168e20c2021-12-13 14:39:53 -080093 dbus::utility::DbusVariantType dbusPropertyValue(propertyValue);
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +000094
95 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -080096 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -070097 // Use "Set" method to set the property value.
98 if (ec)
99 {
100 BMCWEB_LOG_DEBUG << "[Set] Bad D-Bus request error: " << ec;
101 messages::internalError(asyncResp->res);
102 return;
103 }
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +0000104
Ed Tanous002d39b2022-05-31 08:59:27 -0700105 messages::success(asyncResp->res);
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +0000106 },
107 processName, objectPath, "org.freedesktop.DBus.Properties", "Set",
108 interfaceName, destProperty, dbusPropertyValue);
109}
110
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500111/**
112 * ManagerResetAction class supports the POST method for the Reset (reboot)
113 * action.
114 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700115inline void requestRoutesManagerResetAction(App& app)
Jennifer Leeed5befb2018-08-10 11:29:45 -0700116{
Jennifer Leeed5befb2018-08-10 11:29:45 -0700117 /**
Jennifer Leeed5befb2018-08-10 11:29:45 -0700118 * Function handles POST method request.
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500119 * Analyzes POST body before sending Reset (Reboot) request data to D-Bus.
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +0000120 * OpenBMC supports ResetType "GracefulRestart" and "ForceRestart".
Jennifer Leeed5befb2018-08-10 11:29:45 -0700121 */
Jennifer Leeed5befb2018-08-10 11:29:45 -0700122
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700123 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/Actions/Manager.Reset/")
Ed Tanoused398212021-06-09 17:05:54 -0700124 .privileges(redfish::privileges::postManager)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700125 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -0700126 [&app](const crow::Request& req,
127 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +0000128 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -0700129 {
130 return;
131 }
132 BMCWEB_LOG_DEBUG << "Post Manager Reset.";
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500133
Ed Tanous002d39b2022-05-31 08:59:27 -0700134 std::string resetType;
Jennifer Leeed5befb2018-08-10 11:29:45 -0700135
Ed Tanous002d39b2022-05-31 08:59:27 -0700136 if (!json_util::readJsonAction(req, asyncResp->res, "ResetType",
137 resetType))
138 {
139 return;
140 }
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500141
Ed Tanous002d39b2022-05-31 08:59:27 -0700142 if (resetType == "GracefulRestart")
143 {
144 BMCWEB_LOG_DEBUG << "Proceeding with " << resetType;
145 doBMCGracefulRestart(asyncResp);
146 return;
147 }
148 if (resetType == "ForceRestart")
149 {
150 BMCWEB_LOG_DEBUG << "Proceeding with " << resetType;
151 doBMCForceRestart(asyncResp);
152 return;
153 }
154 BMCWEB_LOG_DEBUG << "Invalid property value for ResetType: "
155 << resetType;
156 messages::actionParameterNotSupported(asyncResp->res, resetType,
157 "ResetType");
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700158
Ed Tanous002d39b2022-05-31 08:59:27 -0700159 return;
160 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700161}
Jennifer Leeed5befb2018-08-10 11:29:45 -0700162
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500163/**
164 * ManagerResetToDefaultsAction class supports POST method for factory reset
165 * action.
166 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700167inline void requestRoutesManagerResetToDefaultsAction(App& app)
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500168{
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500169 /**
170 * Function handles ResetToDefaults POST method request.
171 *
172 * Analyzes POST body message and factory resets BMC by calling
173 * BMC code updater factory reset followed by a BMC reboot.
174 *
175 * BMC code updater factory reset wipes the whole BMC read-write
176 * filesystem which includes things like the network settings.
177 *
178 * OpenBMC only supports ResetToDefaultsType "ResetAll".
179 */
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500180
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700181 BMCWEB_ROUTE(app,
182 "/redfish/v1/Managers/bmc/Actions/Manager.ResetToDefaults/")
Ed Tanoused398212021-06-09 17:05:54 -0700183 .privileges(redfish::privileges::postManager)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700184 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -0700185 [&app](const crow::Request& req,
186 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +0000187 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -0700188 {
189 return;
190 }
191 BMCWEB_LOG_DEBUG << "Post ResetToDefaults.";
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500192
Ed Tanous002d39b2022-05-31 08:59:27 -0700193 std::string resetType;
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500194
Ed Tanous002d39b2022-05-31 08:59:27 -0700195 if (!json_util::readJsonAction(req, asyncResp->res,
196 "ResetToDefaultsType", resetType))
197 {
198 BMCWEB_LOG_DEBUG << "Missing property ResetToDefaultsType.";
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700199
Ed Tanous002d39b2022-05-31 08:59:27 -0700200 messages::actionParameterMissing(asyncResp->res, "ResetToDefaults",
201 "ResetToDefaultsType");
202 return;
203 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700204
Ed Tanous002d39b2022-05-31 08:59:27 -0700205 if (resetType != "ResetAll")
206 {
207 BMCWEB_LOG_DEBUG
208 << "Invalid property value for ResetToDefaultsType: "
209 << resetType;
210 messages::actionParameterNotSupported(asyncResp->res, resetType,
211 "ResetToDefaultsType");
212 return;
213 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700214
Ed Tanous002d39b2022-05-31 08:59:27 -0700215 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800216 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700217 if (ec)
218 {
219 BMCWEB_LOG_DEBUG << "Failed to ResetToDefaults: " << ec;
220 messages::internalError(asyncResp->res);
221 return;
222 }
223 // Factory Reset doesn't actually happen until a reboot
224 // Can't erase what the BMC is running on
225 doBMCGracefulRestart(asyncResp);
226 },
227 "xyz.openbmc_project.Software.BMC.Updater",
228 "/xyz/openbmc_project/software",
229 "xyz.openbmc_project.Common.FactoryReset", "Reset");
230 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700231}
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500232
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530233/**
234 * ManagerResetActionInfo derived class for delivering Manager
235 * ResetType AllowableValues using ResetInfo schema.
236 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700237inline void requestRoutesManagerResetActionInfo(App& app)
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530238{
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530239 /**
240 * Functions triggers appropriate requests on DBus
241 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700242
243 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/ResetActionInfo/")
Ed Tanoused398212021-06-09 17:05:54 -0700244 .privileges(redfish::privileges::getActionInfo)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700245 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -0700246 [&app](const crow::Request& req,
247 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +0000248 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -0700249 {
250 return;
251 }
Ed Tanous14766872022-03-15 10:44:42 -0700252
Ed Tanous002d39b2022-05-31 08:59:27 -0700253 asyncResp->res.jsonValue["@odata.type"] =
254 "#ActionInfo.v1_1_2.ActionInfo";
255 asyncResp->res.jsonValue["@odata.id"] =
256 "/redfish/v1/Managers/bmc/ResetActionInfo";
257 asyncResp->res.jsonValue["Name"] = "Reset Action Info";
258 asyncResp->res.jsonValue["Id"] = "ResetActionInfo";
259 nlohmann::json::object_t parameter;
260 parameter["Name"] = "ResetType";
261 parameter["Required"] = true;
262 parameter["DataType"] = "String";
Ed Tanous14766872022-03-15 10:44:42 -0700263
Ed Tanous002d39b2022-05-31 08:59:27 -0700264 nlohmann::json::array_t allowableValues;
Patrick Williamsad539542023-05-12 10:10:08 -0500265 allowableValues.emplace_back("GracefulRestart");
266 allowableValues.emplace_back("ForceRestart");
Ed Tanous002d39b2022-05-31 08:59:27 -0700267 parameter["AllowableValues"] = std::move(allowableValues);
Ed Tanous14766872022-03-15 10:44:42 -0700268
Ed Tanous002d39b2022-05-31 08:59:27 -0700269 nlohmann::json::array_t parameters;
Patrick Williamsad539542023-05-12 10:10:08 -0500270 parameters.emplace_back(std::move(parameter));
Ed Tanous14766872022-03-15 10:44:42 -0700271
Ed Tanous002d39b2022-05-31 08:59:27 -0700272 asyncResp->res.jsonValue["Parameters"] = std::move(parameters);
273 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700274}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530275
James Feist5b4aa862018-08-16 14:07:01 -0700276static constexpr const char* objectManagerIface =
277 "org.freedesktop.DBus.ObjectManager";
278static constexpr const char* pidConfigurationIface =
279 "xyz.openbmc_project.Configuration.Pid";
280static constexpr const char* pidZoneConfigurationIface =
281 "xyz.openbmc_project.Configuration.Pid.Zone";
James Feistb7a08d02018-12-11 14:55:37 -0800282static constexpr const char* stepwiseConfigurationIface =
283 "xyz.openbmc_project.Configuration.Stepwise";
James Feist73df0db2019-03-25 15:29:35 -0700284static constexpr const char* thermalModeIface =
285 "xyz.openbmc_project.Control.ThermalMode";
Borawski.Lukasz9c3106852018-02-09 15:24:22 +0100286
zhanghch058d1b46d2021-04-01 11:18:24 +0800287inline void
288 asyncPopulatePid(const std::string& connection, const std::string& path,
289 const std::string& currentProfile,
290 const std::vector<std::string>& supportedProfiles,
291 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
James Feist5b4aa862018-08-16 14:07:01 -0700292{
James Feist5b4aa862018-08-16 14:07:01 -0700293 crow::connections::systemBus->async_method_call(
James Feist73df0db2019-03-25 15:29:35 -0700294 [asyncResp, currentProfile, supportedProfiles](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800295 const boost::system::error_code& ec,
James Feist73df0db2019-03-25 15:29:35 -0700296 const dbus::utility::ManagedObjectType& managedObj) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700297 if (ec)
298 {
299 BMCWEB_LOG_ERROR << ec;
Ed Tanous002d39b2022-05-31 08:59:27 -0700300 messages::internalError(asyncResp->res);
301 return;
302 }
303 nlohmann::json& configRoot =
304 asyncResp->res.jsonValue["Oem"]["OpenBmc"]["Fan"];
305 nlohmann::json& fans = configRoot["FanControllers"];
306 fans["@odata.type"] = "#OemManager.FanControllers";
307 fans["@odata.id"] =
308 "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanControllers";
309
310 nlohmann::json& pids = configRoot["PidControllers"];
311 pids["@odata.type"] = "#OemManager.PidControllers";
312 pids["@odata.id"] =
313 "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/PidControllers";
314
315 nlohmann::json& stepwise = configRoot["StepwiseControllers"];
316 stepwise["@odata.type"] = "#OemManager.StepwiseControllers";
317 stepwise["@odata.id"] =
318 "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/StepwiseControllers";
319
320 nlohmann::json& zones = configRoot["FanZones"];
321 zones["@odata.id"] =
322 "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanZones";
323 zones["@odata.type"] = "#OemManager.FanZones";
324 configRoot["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan";
325 configRoot["@odata.type"] = "#OemManager.Fan";
326 configRoot["Profile@Redfish.AllowableValues"] = supportedProfiles;
327
328 if (!currentProfile.empty())
329 {
330 configRoot["Profile"] = currentProfile;
331 }
332 BMCWEB_LOG_ERROR << "profile = " << currentProfile << " !";
333
334 for (const auto& pathPair : managedObj)
335 {
336 for (const auto& intfPair : pathPair.second)
James Feist5b4aa862018-08-16 14:07:01 -0700337 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700338 if (intfPair.first != pidConfigurationIface &&
339 intfPair.first != pidZoneConfigurationIface &&
340 intfPair.first != stepwiseConfigurationIface)
James Feist5b4aa862018-08-16 14:07:01 -0700341 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700342 continue;
343 }
James Feist73df0db2019-03-25 15:29:35 -0700344
Ed Tanous002d39b2022-05-31 08:59:27 -0700345 std::string name;
James Feist73df0db2019-03-25 15:29:35 -0700346
Ed Tanous002d39b2022-05-31 08:59:27 -0700347 for (const std::pair<std::string,
348 dbus::utility::DbusVariantType>& propPair :
349 intfPair.second)
350 {
351 if (propPair.first == "Name")
James Feist73df0db2019-03-25 15:29:35 -0700352 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700353 const std::string* namePtr =
354 std::get_if<std::string>(&propPair.second);
355 if (namePtr == nullptr)
James Feist73df0db2019-03-25 15:29:35 -0700356 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700357 BMCWEB_LOG_ERROR << "Pid Name Field illegal";
James Feistc33a90e2019-03-01 10:17:44 -0800358 messages::internalError(asyncResp->res);
359 return;
360 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700361 name = *namePtr;
362 dbus::utility::escapePathForDbus(name);
James Feistb7a08d02018-12-11 14:55:37 -0800363 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700364 else if (propPair.first == "Profiles")
James Feistb7a08d02018-12-11 14:55:37 -0800365 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700366 const std::vector<std::string>* profiles =
367 std::get_if<std::vector<std::string>>(
368 &propPair.second);
369 if (profiles == nullptr)
James Feistb7a08d02018-12-11 14:55:37 -0800370 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700371 BMCWEB_LOG_ERROR << "Pid Profiles Field illegal";
James Feistb7a08d02018-12-11 14:55:37 -0800372 messages::internalError(asyncResp->res);
373 return;
374 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700375 if (std::find(profiles->begin(), profiles->end(),
376 currentProfile) == profiles->end())
James Feistb7a08d02018-12-11 14:55:37 -0800377 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700378 BMCWEB_LOG_INFO
379 << name << " not supported in current profile";
380 continue;
James Feistb7a08d02018-12-11 14:55:37 -0800381 }
382 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700383 }
384 nlohmann::json* config = nullptr;
385 const std::string* classPtr = nullptr;
386
387 for (const std::pair<std::string,
388 dbus::utility::DbusVariantType>& propPair :
389 intfPair.second)
390 {
391 if (propPair.first == "Class")
James Feistb7a08d02018-12-11 14:55:37 -0800392 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700393 classPtr = std::get_if<std::string>(&propPair.second);
394 }
395 }
396
Ed Tanousef4c65b2023-04-24 15:28:50 -0700397 boost::urls::url url("/redfish/v1/Managers/bmc");
Ed Tanous002d39b2022-05-31 08:59:27 -0700398 if (intfPair.first == pidZoneConfigurationIface)
399 {
400 std::string chassis;
401 if (!dbus::utility::getNthStringFromPath(pathPair.first.str,
402 5, chassis))
403 {
404 chassis = "#IllegalValue";
405 }
406 nlohmann::json& zone = zones[name];
Ed Tanousef4c65b2023-04-24 15:28:50 -0700407 zone["Chassis"]["@odata.id"] =
408 boost::urls::format("/redfish/v1/Chassis/{}", chassis);
Willy Tueddfc432022-09-26 16:46:38 +0000409 url.set_fragment(
410 ("/Oem/OpenBmc/Fan/FanZones"_json_pointer / name)
411 .to_string());
412 zone["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700413 zone["@odata.type"] = "#OemManager.FanZone";
414 config = &zone;
415 }
416
417 else if (intfPair.first == stepwiseConfigurationIface)
418 {
419 if (classPtr == nullptr)
420 {
421 BMCWEB_LOG_ERROR << "Pid Class Field illegal";
James Feistb7a08d02018-12-11 14:55:37 -0800422 messages::internalError(asyncResp->res);
423 return;
424 }
425
Ed Tanous002d39b2022-05-31 08:59:27 -0700426 nlohmann::json& controller = stepwise[name];
427 config = &controller;
Willy Tueddfc432022-09-26 16:46:38 +0000428 url.set_fragment(
429 ("/Oem/OpenBmc/Fan/StepwiseControllers"_json_pointer /
430 name)
431 .to_string());
432 controller["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700433 controller["@odata.type"] =
434 "#OemManager.StepwiseController";
435
436 controller["Direction"] = *classPtr;
437 }
438
439 // pid and fans are off the same configuration
440 else if (intfPair.first == pidConfigurationIface)
441 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700442 if (classPtr == nullptr)
James Feist5b4aa862018-08-16 14:07:01 -0700443 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700444 BMCWEB_LOG_ERROR << "Pid Class Field illegal";
445 messages::internalError(asyncResp->res);
446 return;
447 }
448 bool isFan = *classPtr == "fan";
449 nlohmann::json& element = isFan ? fans[name] : pids[name];
450 config = &element;
451 if (isFan)
452 {
Willy Tueddfc432022-09-26 16:46:38 +0000453 url.set_fragment(
454 ("/Oem/OpenBmc/Fan/FanControllers"_json_pointer /
455 name)
456 .to_string());
457 element["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700458 element["@odata.type"] = "#OemManager.FanController";
459 }
460 else
461 {
Willy Tueddfc432022-09-26 16:46:38 +0000462 url.set_fragment(
463 ("/Oem/OpenBmc/Fan/PidControllers"_json_pointer /
464 name)
465 .to_string());
466 element["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700467 element["@odata.type"] = "#OemManager.PidController";
468 }
469 }
470 else
471 {
472 BMCWEB_LOG_ERROR << "Unexpected configuration";
473 messages::internalError(asyncResp->res);
474 return;
475 }
James Feist5b4aa862018-08-16 14:07:01 -0700476
Ed Tanous002d39b2022-05-31 08:59:27 -0700477 // used for making maps out of 2 vectors
478 const std::vector<double>* keys = nullptr;
479 const std::vector<double>* values = nullptr;
480
481 for (const auto& propertyPair : intfPair.second)
482 {
483 if (propertyPair.first == "Type" ||
484 propertyPair.first == "Class" ||
485 propertyPair.first == "Name")
486 {
487 continue;
488 }
489
490 // zones
491 if (intfPair.first == pidZoneConfigurationIface)
492 {
493 const double* ptr =
494 std::get_if<double>(&propertyPair.second);
495 if (ptr == nullptr)
496 {
497 BMCWEB_LOG_ERROR << "Field Illegal "
498 << propertyPair.first;
499 messages::internalError(asyncResp->res);
500 return;
501 }
502 (*config)[propertyPair.first] = *ptr;
503 }
504
505 if (intfPair.first == stepwiseConfigurationIface)
506 {
507 if (propertyPair.first == "Reading" ||
508 propertyPair.first == "Output")
509 {
510 const std::vector<double>* ptr =
511 std::get_if<std::vector<double>>(
512 &propertyPair.second);
513
514 if (ptr == nullptr)
515 {
516 BMCWEB_LOG_ERROR << "Field Illegal "
517 << propertyPair.first;
518 messages::internalError(asyncResp->res);
519 return;
520 }
521
522 if (propertyPair.first == "Reading")
523 {
524 keys = ptr;
525 }
526 else
527 {
528 values = ptr;
529 }
530 if (keys != nullptr && values != nullptr)
531 {
532 if (keys->size() != values->size())
533 {
534 BMCWEB_LOG_ERROR
535 << "Reading and Output size don't match ";
536 messages::internalError(asyncResp->res);
537 return;
538 }
539 nlohmann::json& steps = (*config)["Steps"];
540 steps = nlohmann::json::array();
541 for (size_t ii = 0; ii < keys->size(); ii++)
542 {
543 nlohmann::json::object_t step;
544 step["Target"] = (*keys)[ii];
545 step["Output"] = (*values)[ii];
Patrick Williamsb2ba3072023-05-12 10:27:39 -0500546 steps.emplace_back(std::move(step));
Ed Tanous002d39b2022-05-31 08:59:27 -0700547 }
548 }
549 }
550 if (propertyPair.first == "NegativeHysteresis" ||
551 propertyPair.first == "PositiveHysteresis")
James Feist5b4aa862018-08-16 14:07:01 -0700552 {
Ed Tanous1b6b96c2018-11-30 11:35:41 -0800553 const double* ptr =
Ed Tanousabf2add2019-01-22 16:40:12 -0800554 std::get_if<double>(&propertyPair.second);
James Feist5b4aa862018-08-16 14:07:01 -0700555 if (ptr == nullptr)
556 {
557 BMCWEB_LOG_ERROR << "Field Illegal "
558 << propertyPair.first;
Jason M. Billsf12894f2018-10-09 12:45:45 -0700559 messages::internalError(asyncResp->res);
James Feist5b4aa862018-08-16 14:07:01 -0700560 return;
561 }
James Feistb7a08d02018-12-11 14:55:37 -0800562 (*config)[propertyPair.first] = *ptr;
563 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700564 }
James Feistb7a08d02018-12-11 14:55:37 -0800565
Ed Tanous002d39b2022-05-31 08:59:27 -0700566 // pid and fans are off the same configuration
567 if (intfPair.first == pidConfigurationIface ||
568 intfPair.first == stepwiseConfigurationIface)
569 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700570 if (propertyPair.first == "Zones")
James Feistb7a08d02018-12-11 14:55:37 -0800571 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700572 const std::vector<std::string>* inputs =
573 std::get_if<std::vector<std::string>>(
574 &propertyPair.second);
575
576 if (inputs == nullptr)
James Feistb7a08d02018-12-11 14:55:37 -0800577 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700578 BMCWEB_LOG_ERROR << "Zones Pid Field Illegal";
579 messages::internalError(asyncResp->res);
580 return;
James Feistb7a08d02018-12-11 14:55:37 -0800581 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700582 auto& data = (*config)[propertyPair.first];
583 data = nlohmann::json::array();
584 for (std::string itemCopy : *inputs)
James Feistb7a08d02018-12-11 14:55:37 -0800585 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700586 dbus::utility::escapePathForDbus(itemCopy);
587 nlohmann::json::object_t input;
Ed Tanousef4c65b2023-04-24 15:28:50 -0700588 boost::urls::url managerUrl = boost::urls::format(
589 "/redfish/v1/Managers/bmc#{}",
Willy Tueddfc432022-09-26 16:46:38 +0000590 ("/Oem/OpenBmc/Fan/FanZones"_json_pointer /
591 itemCopy)
592 .to_string());
593 input["@odata.id"] = std::move(managerUrl);
Patrick Williamsb2ba3072023-05-12 10:27:39 -0500594 data.emplace_back(std::move(input));
James Feistb7a08d02018-12-11 14:55:37 -0800595 }
James Feist5b4aa862018-08-16 14:07:01 -0700596 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700597 // todo(james): may never happen, but this
598 // assumes configuration data referenced in the
599 // PID config is provided by the same daemon, we
600 // could add another loop to cover all cases,
601 // but I'm okay kicking this can down the road a
602 // bit
James Feist5b4aa862018-08-16 14:07:01 -0700603
Ed Tanous002d39b2022-05-31 08:59:27 -0700604 else if (propertyPair.first == "Inputs" ||
605 propertyPair.first == "Outputs")
James Feist5b4aa862018-08-16 14:07:01 -0700606 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700607 auto& data = (*config)[propertyPair.first];
608 const std::vector<std::string>* inputs =
609 std::get_if<std::vector<std::string>>(
610 &propertyPair.second);
James Feist5b4aa862018-08-16 14:07:01 -0700611
Ed Tanous002d39b2022-05-31 08:59:27 -0700612 if (inputs == nullptr)
James Feist5b4aa862018-08-16 14:07:01 -0700613 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700614 BMCWEB_LOG_ERROR << "Field Illegal "
615 << propertyPair.first;
616 messages::internalError(asyncResp->res);
617 return;
James Feist5b4aa862018-08-16 14:07:01 -0700618 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700619 data = *inputs;
620 }
621 else if (propertyPair.first == "SetPointOffset")
622 {
623 const std::string* ptr =
624 std::get_if<std::string>(&propertyPair.second);
James Feist5b4aa862018-08-16 14:07:01 -0700625
Ed Tanous002d39b2022-05-31 08:59:27 -0700626 if (ptr == nullptr)
James Feist5b4aa862018-08-16 14:07:01 -0700627 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700628 BMCWEB_LOG_ERROR << "Field Illegal "
629 << propertyPair.first;
630 messages::internalError(asyncResp->res);
631 return;
James Feistb943aae2019-07-11 16:33:56 -0700632 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700633 // translate from dbus to redfish
634 if (*ptr == "WarningHigh")
James Feistb943aae2019-07-11 16:33:56 -0700635 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700636 (*config)["SetPointOffset"] =
637 "UpperThresholdNonCritical";
James Feistb943aae2019-07-11 16:33:56 -0700638 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700639 else if (*ptr == "WarningLow")
James Feist5b4aa862018-08-16 14:07:01 -0700640 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700641 (*config)["SetPointOffset"] =
642 "LowerThresholdNonCritical";
James Feist5b4aa862018-08-16 14:07:01 -0700643 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700644 else if (*ptr == "CriticalHigh")
645 {
646 (*config)["SetPointOffset"] =
647 "UpperThresholdCritical";
648 }
649 else if (*ptr == "CriticalLow")
650 {
651 (*config)["SetPointOffset"] =
652 "LowerThresholdCritical";
653 }
654 else
655 {
656 BMCWEB_LOG_ERROR << "Value Illegal " << *ptr;
657 messages::internalError(asyncResp->res);
658 return;
659 }
660 }
661 // doubles
662 else if (propertyPair.first == "FFGainCoefficient" ||
663 propertyPair.first == "FFOffCoefficient" ||
664 propertyPair.first == "ICoefficient" ||
665 propertyPair.first == "ILimitMax" ||
666 propertyPair.first == "ILimitMin" ||
667 propertyPair.first == "PositiveHysteresis" ||
668 propertyPair.first == "NegativeHysteresis" ||
669 propertyPair.first == "OutLimitMax" ||
670 propertyPair.first == "OutLimitMin" ||
671 propertyPair.first == "PCoefficient" ||
672 propertyPair.first == "SetPoint" ||
673 propertyPair.first == "SlewNeg" ||
674 propertyPair.first == "SlewPos")
675 {
676 const double* ptr =
677 std::get_if<double>(&propertyPair.second);
678 if (ptr == nullptr)
679 {
680 BMCWEB_LOG_ERROR << "Field Illegal "
681 << propertyPair.first;
682 messages::internalError(asyncResp->res);
683 return;
684 }
685 (*config)[propertyPair.first] = *ptr;
James Feist5b4aa862018-08-16 14:07:01 -0700686 }
687 }
688 }
689 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700690 }
James Feist5b4aa862018-08-16 14:07:01 -0700691 },
692 connection, path, objectManagerIface, "GetManagedObjects");
693}
Jennifer Leeca537922018-08-10 10:07:30 -0700694
James Feist83ff9ab2018-08-31 10:18:24 -0700695enum class CreatePIDRet
696{
697 fail,
698 del,
699 patch
700};
701
zhanghch058d1b46d2021-04-01 11:18:24 +0800702inline bool
703 getZonesFromJsonReq(const std::shared_ptr<bmcweb::AsyncResp>& response,
704 std::vector<nlohmann::json>& config,
705 std::vector<std::string>& zones)
James Feist5f2caae2018-12-12 14:08:25 -0800706{
James Feistb6baeaa2019-02-21 10:41:40 -0800707 if (config.empty())
708 {
709 BMCWEB_LOG_ERROR << "Empty Zones";
Ed Tanousf818b042022-06-27 13:17:35 -0700710 messages::propertyValueFormatError(response->res, config, "Zones");
James Feistb6baeaa2019-02-21 10:41:40 -0800711 return false;
712 }
James Feist5f2caae2018-12-12 14:08:25 -0800713 for (auto& odata : config)
714 {
715 std::string path;
716 if (!redfish::json_util::readJson(odata, response->res, "@odata.id",
717 path))
718 {
719 return false;
720 }
721 std::string input;
James Feist61adbda2019-03-25 13:03:51 -0700722
723 // 8 below comes from
724 // /redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanZones/Left
725 // 0 1 2 3 4 5 6 7 8
726 if (!dbus::utility::getNthStringFromPath(path, 8, input))
James Feist5f2caae2018-12-12 14:08:25 -0800727 {
728 BMCWEB_LOG_ERROR << "Got invalid path " << path;
729 BMCWEB_LOG_ERROR << "Illegal Type Zones";
Ed Tanousf818b042022-06-27 13:17:35 -0700730 messages::propertyValueFormatError(response->res, odata, "Zones");
James Feist5f2caae2018-12-12 14:08:25 -0800731 return false;
732 }
Ed Tanousa170f272022-06-30 21:53:27 -0700733 std::replace(input.begin(), input.end(), '_', ' ');
James Feist5f2caae2018-12-12 14:08:25 -0800734 zones.emplace_back(std::move(input));
735 }
736 return true;
737}
738
Ed Tanous711ac7a2021-12-20 09:34:41 -0800739inline const dbus::utility::ManagedObjectType::value_type*
James Feist73df0db2019-03-25 15:29:35 -0700740 findChassis(const dbus::utility::ManagedObjectType& managedObj,
741 const std::string& value, std::string& chassis)
James Feistb6baeaa2019-02-21 10:41:40 -0800742{
743 BMCWEB_LOG_DEBUG << "Find Chassis: " << value << "\n";
744
Ed Tanousa170f272022-06-30 21:53:27 -0700745 std::string escaped = value;
Yaswanth Reddy M6ce82fa2023-03-10 07:29:45 +0000746 std::replace(escaped.begin(), escaped.end(), ' ', '_');
James Feistb6baeaa2019-02-21 10:41:40 -0800747 escaped = "/" + escaped;
Ed Tanous002d39b2022-05-31 08:59:27 -0700748 auto it = std::find_if(managedObj.begin(), managedObj.end(),
749 [&escaped](const auto& obj) {
750 if (boost::algorithm::ends_with(obj.first.str, escaped))
751 {
752 BMCWEB_LOG_DEBUG << "Matched " << obj.first.str << "\n";
753 return true;
754 }
755 return false;
756 });
James Feistb6baeaa2019-02-21 10:41:40 -0800757
758 if (it == managedObj.end())
759 {
James Feist73df0db2019-03-25 15:29:35 -0700760 return nullptr;
James Feistb6baeaa2019-02-21 10:41:40 -0800761 }
762 // 5 comes from <chassis-name> being the 5th element
763 // /xyz/openbmc_project/inventory/system/chassis/<chassis-name>
James Feist73df0db2019-03-25 15:29:35 -0700764 if (dbus::utility::getNthStringFromPath(it->first.str, 5, chassis))
765 {
766 return &(*it);
767 }
768
769 return nullptr;
James Feistb6baeaa2019-02-21 10:41:40 -0800770}
771
Ed Tanous23a21a12020-07-25 04:45:05 +0000772inline CreatePIDRet createPidInterface(
zhanghch058d1b46d2021-04-01 11:18:24 +0800773 const std::shared_ptr<bmcweb::AsyncResp>& response, const std::string& type,
Ed Tanousb5a76932020-09-29 16:16:58 -0700774 const nlohmann::json::iterator& it, const std::string& path,
James Feist83ff9ab2018-08-31 10:18:24 -0700775 const dbus::utility::ManagedObjectType& managedObj, bool createNewObject,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800776 dbus::utility::DBusPropertiesMap& output, std::string& chassis,
777 const std::string& profile)
James Feist83ff9ab2018-08-31 10:18:24 -0700778{
James Feist5f2caae2018-12-12 14:08:25 -0800779 // common deleter
James Feistb6baeaa2019-02-21 10:41:40 -0800780 if (it.value() == nullptr)
James Feist5f2caae2018-12-12 14:08:25 -0800781 {
782 std::string iface;
783 if (type == "PidControllers" || type == "FanControllers")
784 {
785 iface = pidConfigurationIface;
786 }
787 else if (type == "FanZones")
788 {
789 iface = pidZoneConfigurationIface;
790 }
791 else if (type == "StepwiseControllers")
792 {
793 iface = stepwiseConfigurationIface;
794 }
795 else
796 {
Gunnar Millsa0744d32020-11-09 15:40:45 -0600797 BMCWEB_LOG_ERROR << "Illegal Type " << type;
James Feist5f2caae2018-12-12 14:08:25 -0800798 messages::propertyUnknown(response->res, type);
799 return CreatePIDRet::fail;
800 }
James Feist6ee7f772020-02-06 16:25:27 -0800801
802 BMCWEB_LOG_DEBUG << "del " << path << " " << iface << "\n";
James Feist5f2caae2018-12-12 14:08:25 -0800803 // delete interface
804 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800805 [response, path](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700806 if (ec)
807 {
808 BMCWEB_LOG_ERROR << "Error patching " << path << ": " << ec;
809 messages::internalError(response->res);
810 return;
811 }
812 messages::success(response->res);
James Feist5f2caae2018-12-12 14:08:25 -0800813 },
814 "xyz.openbmc_project.EntityManager", path, iface, "Delete");
815 return CreatePIDRet::del;
816 }
817
Ed Tanous711ac7a2021-12-20 09:34:41 -0800818 const dbus::utility::ManagedObjectType::value_type* managedItem = nullptr;
James Feistb6baeaa2019-02-21 10:41:40 -0800819 if (!createNewObject)
820 {
821 // if we aren't creating a new object, we should be able to find it on
822 // d-bus
James Feist73df0db2019-03-25 15:29:35 -0700823 managedItem = findChassis(managedObj, it.key(), chassis);
824 if (managedItem == nullptr)
James Feistb6baeaa2019-02-21 10:41:40 -0800825 {
826 BMCWEB_LOG_ERROR << "Failed to get chassis from config patch";
Ed Tanousef4c65b2023-04-24 15:28:50 -0700827 messages::invalidObject(
828 response->res,
829 boost::urls::format("/redfish/v1/Chassis/{}", chassis));
James Feistb6baeaa2019-02-21 10:41:40 -0800830 return CreatePIDRet::fail;
831 }
832 }
833
Ed Tanous26f69762022-01-25 09:49:11 -0800834 if (!profile.empty() &&
James Feist73df0db2019-03-25 15:29:35 -0700835 (type == "PidControllers" || type == "FanControllers" ||
836 type == "StepwiseControllers"))
837 {
838 if (managedItem == nullptr)
839 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800840 output.emplace_back("Profiles", std::vector<std::string>{profile});
James Feist73df0db2019-03-25 15:29:35 -0700841 }
842 else
843 {
844 std::string interface;
845 if (type == "StepwiseControllers")
846 {
847 interface = stepwiseConfigurationIface;
848 }
849 else
850 {
851 interface = pidConfigurationIface;
852 }
Ed Tanous711ac7a2021-12-20 09:34:41 -0800853 bool ifaceFound = false;
854 for (const auto& iface : managedItem->second)
855 {
856 if (iface.first == interface)
857 {
858 ifaceFound = true;
859 for (const auto& prop : iface.second)
860 {
861 if (prop.first == "Profiles")
862 {
863 const std::vector<std::string>* curProfiles =
864 std::get_if<std::vector<std::string>>(
865 &(prop.second));
866 if (curProfiles == nullptr)
867 {
868 BMCWEB_LOG_ERROR
869 << "Illegal profiles in managed object";
870 messages::internalError(response->res);
871 return CreatePIDRet::fail;
872 }
873 if (std::find(curProfiles->begin(),
874 curProfiles->end(),
875 profile) == curProfiles->end())
876 {
877 std::vector<std::string> newProfiles =
878 *curProfiles;
879 newProfiles.push_back(profile);
Ed Tanousb9d36b42022-02-26 21:42:46 -0800880 output.emplace_back("Profiles", newProfiles);
Ed Tanous711ac7a2021-12-20 09:34:41 -0800881 }
882 }
883 }
884 }
885 }
886
887 if (!ifaceFound)
James Feist73df0db2019-03-25 15:29:35 -0700888 {
889 BMCWEB_LOG_ERROR
890 << "Failed to find interface in managed object";
891 messages::internalError(response->res);
892 return CreatePIDRet::fail;
893 }
James Feist73df0db2019-03-25 15:29:35 -0700894 }
895 }
896
James Feist83ff9ab2018-08-31 10:18:24 -0700897 if (type == "PidControllers" || type == "FanControllers")
898 {
899 if (createNewObject)
900 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800901 output.emplace_back("Class",
902 type == "PidControllers" ? "temp" : "fan");
903 output.emplace_back("Type", "Pid");
James Feist83ff9ab2018-08-31 10:18:24 -0700904 }
James Feist5f2caae2018-12-12 14:08:25 -0800905
906 std::optional<std::vector<nlohmann::json>> zones;
907 std::optional<std::vector<std::string>> inputs;
908 std::optional<std::vector<std::string>> outputs;
909 std::map<std::string, std::optional<double>> doubles;
James Feistb943aae2019-07-11 16:33:56 -0700910 std::optional<std::string> setpointOffset;
James Feist5f2caae2018-12-12 14:08:25 -0800911 if (!redfish::json_util::readJson(
James Feistb6baeaa2019-02-21 10:41:40 -0800912 it.value(), response->res, "Inputs", inputs, "Outputs", outputs,
James Feist5f2caae2018-12-12 14:08:25 -0800913 "Zones", zones, "FFGainCoefficient",
914 doubles["FFGainCoefficient"], "FFOffCoefficient",
915 doubles["FFOffCoefficient"], "ICoefficient",
916 doubles["ICoefficient"], "ILimitMax", doubles["ILimitMax"],
917 "ILimitMin", doubles["ILimitMin"], "OutLimitMax",
918 doubles["OutLimitMax"], "OutLimitMin", doubles["OutLimitMin"],
919 "PCoefficient", doubles["PCoefficient"], "SetPoint",
James Feistb943aae2019-07-11 16:33:56 -0700920 doubles["SetPoint"], "SetPointOffset", setpointOffset,
921 "SlewNeg", doubles["SlewNeg"], "SlewPos", doubles["SlewPos"],
922 "PositiveHysteresis", doubles["PositiveHysteresis"],
923 "NegativeHysteresis", doubles["NegativeHysteresis"]))
James Feist83ff9ab2018-08-31 10:18:24 -0700924 {
James Feist5f2caae2018-12-12 14:08:25 -0800925 return CreatePIDRet::fail;
James Feist83ff9ab2018-08-31 10:18:24 -0700926 }
James Feist5f2caae2018-12-12 14:08:25 -0800927 if (zones)
James Feist83ff9ab2018-08-31 10:18:24 -0700928 {
James Feist5f2caae2018-12-12 14:08:25 -0800929 std::vector<std::string> zonesStr;
930 if (!getZonesFromJsonReq(response, *zones, zonesStr))
James Feist83ff9ab2018-08-31 10:18:24 -0700931 {
Gunnar Millsa0744d32020-11-09 15:40:45 -0600932 BMCWEB_LOG_ERROR << "Illegal Zones";
James Feist5f2caae2018-12-12 14:08:25 -0800933 return CreatePIDRet::fail;
James Feist83ff9ab2018-08-31 10:18:24 -0700934 }
James Feistb6baeaa2019-02-21 10:41:40 -0800935 if (chassis.empty() &&
Ed Tanouse662eae2022-01-25 10:39:19 -0800936 findChassis(managedObj, zonesStr[0], chassis) == nullptr)
James Feistb6baeaa2019-02-21 10:41:40 -0800937 {
938 BMCWEB_LOG_ERROR << "Failed to get chassis from config patch";
Ed Tanousace85d62021-10-26 12:45:59 -0700939 messages::invalidObject(
Ed Tanousef4c65b2023-04-24 15:28:50 -0700940 response->res,
941 boost::urls::format("/redfish/v1/Chassis/{}", chassis));
James Feistb6baeaa2019-02-21 10:41:40 -0800942 return CreatePIDRet::fail;
943 }
Ed Tanousb9d36b42022-02-26 21:42:46 -0800944 output.emplace_back("Zones", std::move(zonesStr));
James Feist5f2caae2018-12-12 14:08:25 -0800945 }
Ed Tanousafb9ee02022-12-21 11:59:17 -0800946
947 if (inputs)
James Feist5f2caae2018-12-12 14:08:25 -0800948 {
Ed Tanousafb9ee02022-12-21 11:59:17 -0800949 for (std::string& value : *inputs)
James Feist83ff9ab2018-08-31 10:18:24 -0700950 {
Ed Tanousafb9ee02022-12-21 11:59:17 -0800951 std::replace(value.begin(), value.end(), '_', ' ');
James Feist83ff9ab2018-08-31 10:18:24 -0700952 }
Ed Tanousafb9ee02022-12-21 11:59:17 -0800953 output.emplace_back("Inputs", *inputs);
954 }
955
956 if (outputs)
957 {
958 for (std::string& value : *outputs)
959 {
960 std::replace(value.begin(), value.end(), '_', ' ');
961 }
962 output.emplace_back("Outputs", *outputs);
James Feist5f2caae2018-12-12 14:08:25 -0800963 }
James Feist83ff9ab2018-08-31 10:18:24 -0700964
James Feistb943aae2019-07-11 16:33:56 -0700965 if (setpointOffset)
966 {
967 // translate between redfish and dbus names
968 if (*setpointOffset == "UpperThresholdNonCritical")
969 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800970 output.emplace_back("SetPointOffset", "WarningLow");
James Feistb943aae2019-07-11 16:33:56 -0700971 }
972 else if (*setpointOffset == "LowerThresholdNonCritical")
973 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800974 output.emplace_back("SetPointOffset", "WarningHigh");
James Feistb943aae2019-07-11 16:33:56 -0700975 }
976 else if (*setpointOffset == "LowerThresholdCritical")
977 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800978 output.emplace_back("SetPointOffset", "CriticalLow");
James Feistb943aae2019-07-11 16:33:56 -0700979 }
980 else if (*setpointOffset == "UpperThresholdCritical")
981 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800982 output.emplace_back("SetPointOffset", "CriticalHigh");
James Feistb943aae2019-07-11 16:33:56 -0700983 }
984 else
985 {
986 BMCWEB_LOG_ERROR << "Invalid setpointoffset "
987 << *setpointOffset;
Ed Tanousace85d62021-10-26 12:45:59 -0700988 messages::propertyValueNotInList(response->res, it.key(),
989 "SetPointOffset");
James Feistb943aae2019-07-11 16:33:56 -0700990 return CreatePIDRet::fail;
991 }
992 }
993
James Feist5f2caae2018-12-12 14:08:25 -0800994 // doubles
995 for (const auto& pairs : doubles)
996 {
997 if (!pairs.second)
James Feist83ff9ab2018-08-31 10:18:24 -0700998 {
James Feist5f2caae2018-12-12 14:08:25 -0800999 continue;
James Feist83ff9ab2018-08-31 10:18:24 -07001000 }
James Feist5f2caae2018-12-12 14:08:25 -08001001 BMCWEB_LOG_DEBUG << pairs.first << " = " << *pairs.second;
Ed Tanousb9d36b42022-02-26 21:42:46 -08001002 output.emplace_back(pairs.first, *pairs.second);
James Feist83ff9ab2018-08-31 10:18:24 -07001003 }
1004 }
James Feist5f2caae2018-12-12 14:08:25 -08001005
James Feist83ff9ab2018-08-31 10:18:24 -07001006 else if (type == "FanZones")
1007 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001008 output.emplace_back("Type", "Pid.Zone");
James Feist83ff9ab2018-08-31 10:18:24 -07001009
James Feist5f2caae2018-12-12 14:08:25 -08001010 std::optional<nlohmann::json> chassisContainer;
1011 std::optional<double> failSafePercent;
James Feistd3ec07f2019-02-25 14:51:15 -08001012 std::optional<double> minThermalOutput;
James Feistb6baeaa2019-02-21 10:41:40 -08001013 if (!redfish::json_util::readJson(it.value(), response->res, "Chassis",
James Feist5f2caae2018-12-12 14:08:25 -08001014 chassisContainer, "FailSafePercent",
James Feistd3ec07f2019-02-25 14:51:15 -08001015 failSafePercent, "MinThermalOutput",
1016 minThermalOutput))
James Feist83ff9ab2018-08-31 10:18:24 -07001017 {
James Feist5f2caae2018-12-12 14:08:25 -08001018 return CreatePIDRet::fail;
1019 }
James Feist83ff9ab2018-08-31 10:18:24 -07001020
James Feist5f2caae2018-12-12 14:08:25 -08001021 if (chassisContainer)
1022 {
James Feist5f2caae2018-12-12 14:08:25 -08001023 std::string chassisId;
1024 if (!redfish::json_util::readJson(*chassisContainer, response->res,
1025 "@odata.id", chassisId))
James Feist83ff9ab2018-08-31 10:18:24 -07001026 {
James Feist83ff9ab2018-08-31 10:18:24 -07001027 return CreatePIDRet::fail;
1028 }
James Feist5f2caae2018-12-12 14:08:25 -08001029
AppaRao Puli717794d2019-10-18 22:54:53 +05301030 // /redfish/v1/chassis/chassis_name/
James Feist5f2caae2018-12-12 14:08:25 -08001031 if (!dbus::utility::getNthStringFromPath(chassisId, 3, chassis))
1032 {
1033 BMCWEB_LOG_ERROR << "Got invalid path " << chassisId;
Ed Tanousace85d62021-10-26 12:45:59 -07001034 messages::invalidObject(
Ed Tanousef4c65b2023-04-24 15:28:50 -07001035 response->res,
1036 boost::urls::format("/redfish/v1/Chassis/{}", chassisId));
James Feist5f2caae2018-12-12 14:08:25 -08001037 return CreatePIDRet::fail;
1038 }
1039 }
James Feistd3ec07f2019-02-25 14:51:15 -08001040 if (minThermalOutput)
James Feist5f2caae2018-12-12 14:08:25 -08001041 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001042 output.emplace_back("MinThermalOutput", *minThermalOutput);
James Feist5f2caae2018-12-12 14:08:25 -08001043 }
1044 if (failSafePercent)
1045 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001046 output.emplace_back("FailSafePercent", *failSafePercent);
James Feist5f2caae2018-12-12 14:08:25 -08001047 }
1048 }
1049 else if (type == "StepwiseControllers")
1050 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001051 output.emplace_back("Type", "Stepwise");
James Feist5f2caae2018-12-12 14:08:25 -08001052
1053 std::optional<std::vector<nlohmann::json>> zones;
1054 std::optional<std::vector<nlohmann::json>> steps;
1055 std::optional<std::vector<std::string>> inputs;
1056 std::optional<double> positiveHysteresis;
1057 std::optional<double> negativeHysteresis;
James Feistc33a90e2019-03-01 10:17:44 -08001058 std::optional<std::string> direction; // upper clipping curve vs lower
James Feist5f2caae2018-12-12 14:08:25 -08001059 if (!redfish::json_util::readJson(
James Feistb6baeaa2019-02-21 10:41:40 -08001060 it.value(), response->res, "Zones", zones, "Steps", steps,
1061 "Inputs", inputs, "PositiveHysteresis", positiveHysteresis,
James Feistc33a90e2019-03-01 10:17:44 -08001062 "NegativeHysteresis", negativeHysteresis, "Direction",
1063 direction))
James Feist5f2caae2018-12-12 14:08:25 -08001064 {
James Feist5f2caae2018-12-12 14:08:25 -08001065 return CreatePIDRet::fail;
1066 }
1067
1068 if (zones)
1069 {
James Feistb6baeaa2019-02-21 10:41:40 -08001070 std::vector<std::string> zonesStrs;
1071 if (!getZonesFromJsonReq(response, *zones, zonesStrs))
James Feist5f2caae2018-12-12 14:08:25 -08001072 {
Gunnar Millsa0744d32020-11-09 15:40:45 -06001073 BMCWEB_LOG_ERROR << "Illegal Zones";
James Feist5f2caae2018-12-12 14:08:25 -08001074 return CreatePIDRet::fail;
1075 }
James Feistb6baeaa2019-02-21 10:41:40 -08001076 if (chassis.empty() &&
Ed Tanouse662eae2022-01-25 10:39:19 -08001077 findChassis(managedObj, zonesStrs[0], chassis) == nullptr)
James Feistb6baeaa2019-02-21 10:41:40 -08001078 {
1079 BMCWEB_LOG_ERROR << "Failed to get chassis from config patch";
Ed Tanousace85d62021-10-26 12:45:59 -07001080 messages::invalidObject(
Ed Tanousef4c65b2023-04-24 15:28:50 -07001081 response->res,
1082 boost::urls::format("/redfish/v1/Chassis/{}", chassis));
James Feistb6baeaa2019-02-21 10:41:40 -08001083 return CreatePIDRet::fail;
1084 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001085 output.emplace_back("Zones", std::move(zonesStrs));
James Feist5f2caae2018-12-12 14:08:25 -08001086 }
1087 if (steps)
1088 {
1089 std::vector<double> readings;
1090 std::vector<double> outputs;
1091 for (auto& step : *steps)
1092 {
Ed Tanous543f4402022-01-06 13:12:53 -08001093 double target = 0.0;
1094 double out = 0.0;
James Feist5f2caae2018-12-12 14:08:25 -08001095
1096 if (!redfish::json_util::readJson(step, response->res, "Target",
Ed Tanous23a21a12020-07-25 04:45:05 +00001097 target, "Output", out))
James Feist5f2caae2018-12-12 14:08:25 -08001098 {
James Feist5f2caae2018-12-12 14:08:25 -08001099 return CreatePIDRet::fail;
1100 }
1101 readings.emplace_back(target);
Ed Tanous23a21a12020-07-25 04:45:05 +00001102 outputs.emplace_back(out);
James Feist5f2caae2018-12-12 14:08:25 -08001103 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001104 output.emplace_back("Reading", std::move(readings));
1105 output.emplace_back("Output", std::move(outputs));
James Feist5f2caae2018-12-12 14:08:25 -08001106 }
1107 if (inputs)
1108 {
1109 for (std::string& value : *inputs)
1110 {
Ed Tanousa170f272022-06-30 21:53:27 -07001111 std::replace(value.begin(), value.end(), '_', ' ');
James Feist5f2caae2018-12-12 14:08:25 -08001112 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001113 output.emplace_back("Inputs", std::move(*inputs));
James Feist5f2caae2018-12-12 14:08:25 -08001114 }
1115 if (negativeHysteresis)
1116 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001117 output.emplace_back("NegativeHysteresis", *negativeHysteresis);
James Feist5f2caae2018-12-12 14:08:25 -08001118 }
1119 if (positiveHysteresis)
1120 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001121 output.emplace_back("PositiveHysteresis", *positiveHysteresis);
James Feist83ff9ab2018-08-31 10:18:24 -07001122 }
James Feistc33a90e2019-03-01 10:17:44 -08001123 if (direction)
1124 {
1125 constexpr const std::array<const char*, 2> allowedDirections = {
1126 "Ceiling", "Floor"};
1127 if (std::find(allowedDirections.begin(), allowedDirections.end(),
1128 *direction) == allowedDirections.end())
1129 {
1130 messages::propertyValueTypeError(response->res, "Direction",
1131 *direction);
1132 return CreatePIDRet::fail;
1133 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001134 output.emplace_back("Class", *direction);
James Feistc33a90e2019-03-01 10:17:44 -08001135 }
James Feist83ff9ab2018-08-31 10:18:24 -07001136 }
1137 else
1138 {
Gunnar Millsa0744d32020-11-09 15:40:45 -06001139 BMCWEB_LOG_ERROR << "Illegal Type " << type;
Jason M. Bills35a62c72018-10-09 12:45:45 -07001140 messages::propertyUnknown(response->res, type);
James Feist83ff9ab2018-08-31 10:18:24 -07001141 return CreatePIDRet::fail;
1142 }
1143 return CreatePIDRet::patch;
1144}
James Feist73df0db2019-03-25 15:29:35 -07001145struct GetPIDValues : std::enable_shared_from_this<GetPIDValues>
1146{
Ed Tanous6936afe2022-09-08 15:10:39 -07001147 struct CompletionValues
1148 {
1149 std::vector<std::string> supportedProfiles;
1150 std::string currentProfile;
1151 dbus::utility::MapperGetSubTreeResponse subtree;
1152 };
James Feist73df0db2019-03-25 15:29:35 -07001153
Ed Tanous4e23a442022-06-06 09:57:26 -07001154 explicit GetPIDValues(
1155 const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn) :
Ed Tanous23a21a12020-07-25 04:45:05 +00001156 asyncResp(asyncRespIn)
James Feist73df0db2019-03-25 15:29:35 -07001157
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001158 {}
James Feist73df0db2019-03-25 15:29:35 -07001159
1160 void run()
1161 {
1162 std::shared_ptr<GetPIDValues> self = shared_from_this();
1163
1164 // get all configurations
George Liue99073f2022-12-09 11:06:16 +08001165 constexpr std::array<std::string_view, 4> interfaces = {
1166 pidConfigurationIface, pidZoneConfigurationIface,
1167 objectManagerIface, stepwiseConfigurationIface};
1168 dbus::utility::getSubTree(
1169 "/", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001170 [self](
George Liue99073f2022-12-09 11:06:16 +08001171 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001172 const dbus::utility::MapperGetSubTreeResponse& subtreeLocal) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001173 if (ec)
1174 {
1175 BMCWEB_LOG_ERROR << ec;
1176 messages::internalError(self->asyncResp->res);
1177 return;
1178 }
Ed Tanous6936afe2022-09-08 15:10:39 -07001179 self->complete.subtree = subtreeLocal;
George Liue99073f2022-12-09 11:06:16 +08001180 });
James Feist73df0db2019-03-25 15:29:35 -07001181
1182 // at the same time get the selected profile
George Liue99073f2022-12-09 11:06:16 +08001183 constexpr std::array<std::string_view, 1> thermalModeIfaces = {
1184 thermalModeIface};
1185 dbus::utility::getSubTree(
1186 "/", 0, thermalModeIfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001187 [self](
George Liue99073f2022-12-09 11:06:16 +08001188 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001189 const dbus::utility::MapperGetSubTreeResponse& subtreeLocal) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001190 if (ec || subtreeLocal.empty())
1191 {
1192 return;
1193 }
1194 if (subtreeLocal[0].second.size() != 1)
1195 {
1196 // invalid mapper response, should never happen
1197 BMCWEB_LOG_ERROR << "GetPIDValues: Mapper Error";
1198 messages::internalError(self->asyncResp->res);
1199 return;
1200 }
1201
1202 const std::string& path = subtreeLocal[0].first;
1203 const std::string& owner = subtreeLocal[0].second[0].first;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001204
1205 sdbusplus::asio::getAllProperties(
1206 *crow::connections::systemBus, owner, path, thermalModeIface,
Ed Tanous002d39b2022-05-31 08:59:27 -07001207 [path, owner,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001208 self](const boost::system::error_code& ec2,
Ed Tanous002d39b2022-05-31 08:59:27 -07001209 const dbus::utility::DBusPropertiesMap& resp) {
1210 if (ec2)
James Feist73df0db2019-03-25 15:29:35 -07001211 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001212 BMCWEB_LOG_ERROR
1213 << "GetPIDValues: Can't get thermalModeIface " << path;
James Feist73df0db2019-03-25 15:29:35 -07001214 messages::internalError(self->asyncResp->res);
1215 return;
1216 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001217
Ed Tanous002d39b2022-05-31 08:59:27 -07001218 const std::string* current = nullptr;
1219 const std::vector<std::string>* supported = nullptr;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001220
1221 const bool success = sdbusplus::unpackPropertiesNoThrow(
1222 dbus_utils::UnpackErrorPrinter(), resp, "Current", current,
1223 "Supported", supported);
1224
1225 if (!success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001226 {
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001227 messages::internalError(self->asyncResp->res);
1228 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07001229 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001230
Ed Tanous002d39b2022-05-31 08:59:27 -07001231 if (current == nullptr || supported == nullptr)
1232 {
1233 BMCWEB_LOG_ERROR
1234 << "GetPIDValues: thermal mode iface invalid " << path;
1235 messages::internalError(self->asyncResp->res);
1236 return;
1237 }
Ed Tanous6936afe2022-09-08 15:10:39 -07001238 self->complete.currentProfile = *current;
1239 self->complete.supportedProfiles = *supported;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001240 });
George Liue99073f2022-12-09 11:06:16 +08001241 });
James Feist73df0db2019-03-25 15:29:35 -07001242 }
1243
Ed Tanous6936afe2022-09-08 15:10:39 -07001244 static void
1245 processingComplete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1246 const CompletionValues& completion)
James Feist73df0db2019-03-25 15:29:35 -07001247 {
1248 if (asyncResp->res.result() != boost::beast::http::status::ok)
1249 {
1250 return;
1251 }
1252 // create map of <connection, path to objMgr>>
Ed Tanous6936afe2022-09-08 15:10:39 -07001253 boost::container::flat_map<
1254 std::string, std::string, std::less<>,
1255 std::vector<std::pair<std::string, std::string>>>
1256 objectMgrPaths;
1257 boost::container::flat_set<std::string, std::less<>,
1258 std::vector<std::string>>
1259 calledConnections;
1260 for (const auto& pathGroup : completion.subtree)
James Feist73df0db2019-03-25 15:29:35 -07001261 {
1262 for (const auto& connectionGroup : pathGroup.second)
1263 {
1264 auto findConnection =
1265 calledConnections.find(connectionGroup.first);
1266 if (findConnection != calledConnections.end())
1267 {
1268 break;
1269 }
1270 for (const std::string& interface : connectionGroup.second)
1271 {
1272 if (interface == objectManagerIface)
1273 {
1274 objectMgrPaths[connectionGroup.first] = pathGroup.first;
1275 }
1276 // this list is alphabetical, so we
1277 // should have found the objMgr by now
1278 if (interface == pidConfigurationIface ||
1279 interface == pidZoneConfigurationIface ||
1280 interface == stepwiseConfigurationIface)
1281 {
1282 auto findObjMgr =
1283 objectMgrPaths.find(connectionGroup.first);
1284 if (findObjMgr == objectMgrPaths.end())
1285 {
1286 BMCWEB_LOG_DEBUG << connectionGroup.first
1287 << "Has no Object Manager";
1288 continue;
1289 }
1290
1291 calledConnections.insert(connectionGroup.first);
1292
1293 asyncPopulatePid(findObjMgr->first, findObjMgr->second,
Ed Tanous6936afe2022-09-08 15:10:39 -07001294 completion.currentProfile,
1295 completion.supportedProfiles,
James Feist73df0db2019-03-25 15:29:35 -07001296 asyncResp);
1297 break;
1298 }
1299 }
1300 }
1301 }
1302 }
1303
Ed Tanous6936afe2022-09-08 15:10:39 -07001304 ~GetPIDValues()
1305 {
1306 boost::asio::post(crow::connections::systemBus->get_io_context(),
1307 std::bind_front(&processingComplete, asyncResp,
1308 std::move(complete)));
1309 }
1310
Ed Tanousecd6a3a2022-01-07 09:18:40 -08001311 GetPIDValues(const GetPIDValues&) = delete;
1312 GetPIDValues(GetPIDValues&&) = delete;
1313 GetPIDValues& operator=(const GetPIDValues&) = delete;
1314 GetPIDValues& operator=(GetPIDValues&&) = delete;
1315
zhanghch058d1b46d2021-04-01 11:18:24 +08001316 std::shared_ptr<bmcweb::AsyncResp> asyncResp;
Ed Tanous6936afe2022-09-08 15:10:39 -07001317 CompletionValues complete;
James Feist73df0db2019-03-25 15:29:35 -07001318};
1319
1320struct SetPIDValues : std::enable_shared_from_this<SetPIDValues>
1321{
zhanghch058d1b46d2021-04-01 11:18:24 +08001322 SetPIDValues(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
James Feist73df0db2019-03-25 15:29:35 -07001323 nlohmann::json& data) :
Ed Tanous271584a2019-07-09 16:24:22 -07001324 asyncResp(asyncRespIn)
James Feist73df0db2019-03-25 15:29:35 -07001325 {
James Feist73df0db2019-03-25 15:29:35 -07001326 std::optional<nlohmann::json> pidControllers;
1327 std::optional<nlohmann::json> fanControllers;
1328 std::optional<nlohmann::json> fanZones;
1329 std::optional<nlohmann::json> stepwiseControllers;
1330
1331 if (!redfish::json_util::readJson(
1332 data, asyncResp->res, "PidControllers", pidControllers,
1333 "FanControllers", fanControllers, "FanZones", fanZones,
1334 "StepwiseControllers", stepwiseControllers, "Profile", profile))
1335 {
James Feist73df0db2019-03-25 15:29:35 -07001336 return;
1337 }
1338 configuration.emplace_back("PidControllers", std::move(pidControllers));
1339 configuration.emplace_back("FanControllers", std::move(fanControllers));
1340 configuration.emplace_back("FanZones", std::move(fanZones));
1341 configuration.emplace_back("StepwiseControllers",
1342 std::move(stepwiseControllers));
1343 }
Ed Tanousecd6a3a2022-01-07 09:18:40 -08001344
1345 SetPIDValues(const SetPIDValues&) = delete;
1346 SetPIDValues(SetPIDValues&&) = delete;
1347 SetPIDValues& operator=(const SetPIDValues&) = delete;
1348 SetPIDValues& operator=(SetPIDValues&&) = delete;
1349
James Feist73df0db2019-03-25 15:29:35 -07001350 void run()
1351 {
1352 if (asyncResp->res.result() != boost::beast::http::status::ok)
1353 {
1354 return;
1355 }
1356
1357 std::shared_ptr<SetPIDValues> self = shared_from_this();
1358
1359 // todo(james): might make sense to do a mapper call here if this
1360 // interface gets more traction
1361 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001362 [self](const boost::system::error_code& ec,
Ed Tanous914e2d52022-01-07 11:38:34 -08001363 const dbus::utility::ManagedObjectType& mObj) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001364 if (ec)
1365 {
1366 BMCWEB_LOG_ERROR << "Error communicating to Entity Manager";
1367 messages::internalError(self->asyncResp->res);
1368 return;
1369 }
1370 const std::array<const char*, 3> configurations = {
1371 pidConfigurationIface, pidZoneConfigurationIface,
1372 stepwiseConfigurationIface};
James Feiste69d9de2020-02-07 12:23:27 -08001373
Ed Tanous002d39b2022-05-31 08:59:27 -07001374 for (const auto& [path, object] : mObj)
1375 {
1376 for (const auto& [interface, _] : object)
James Feiste69d9de2020-02-07 12:23:27 -08001377 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001378 if (std::find(configurations.begin(), configurations.end(),
1379 interface) != configurations.end())
James Feiste69d9de2020-02-07 12:23:27 -08001380 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001381 self->objectCount++;
1382 break;
James Feiste69d9de2020-02-07 12:23:27 -08001383 }
James Feiste69d9de2020-02-07 12:23:27 -08001384 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001385 }
1386 self->managedObj = mObj;
James Feist73df0db2019-03-25 15:29:35 -07001387 },
Nan Zhouc106b672022-09-20 22:35:31 +00001388 "xyz.openbmc_project.EntityManager",
1389 "/xyz/openbmc_project/inventory", objectManagerIface,
James Feist73df0db2019-03-25 15:29:35 -07001390 "GetManagedObjects");
1391
1392 // at the same time get the profile information
George Liue99073f2022-12-09 11:06:16 +08001393 constexpr std::array<std::string_view, 1> thermalModeIfaces = {
1394 thermalModeIface};
1395 dbus::utility::getSubTree(
1396 "/", 0, thermalModeIfaces,
1397 [self](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001398 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001399 if (ec || subtree.empty())
1400 {
1401 return;
1402 }
1403 if (subtree[0].second.empty())
1404 {
1405 // invalid mapper response, should never happen
1406 BMCWEB_LOG_ERROR << "SetPIDValues: Mapper Error";
1407 messages::internalError(self->asyncResp->res);
1408 return;
1409 }
1410
1411 const std::string& path = subtree[0].first;
1412 const std::string& owner = subtree[0].second[0].first;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001413 sdbusplus::asio::getAllProperties(
1414 *crow::connections::systemBus, owner, path, thermalModeIface,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001415 [self, path, owner](const boost::system::error_code& ec2,
Ed Tanous002d39b2022-05-31 08:59:27 -07001416 const dbus::utility::DBusPropertiesMap& r) {
1417 if (ec2)
James Feist73df0db2019-03-25 15:29:35 -07001418 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001419 BMCWEB_LOG_ERROR
1420 << "SetPIDValues: Can't get thermalModeIface " << path;
James Feist73df0db2019-03-25 15:29:35 -07001421 messages::internalError(self->asyncResp->res);
1422 return;
1423 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001424 const std::string* current = nullptr;
1425 const std::vector<std::string>* supported = nullptr;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001426
1427 const bool success = sdbusplus::unpackPropertiesNoThrow(
1428 dbus_utils::UnpackErrorPrinter(), r, "Current", current,
1429 "Supported", supported);
1430
1431 if (!success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001432 {
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001433 messages::internalError(self->asyncResp->res);
1434 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07001435 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001436
Ed Tanous002d39b2022-05-31 08:59:27 -07001437 if (current == nullptr || supported == nullptr)
1438 {
1439 BMCWEB_LOG_ERROR
1440 << "SetPIDValues: thermal mode iface invalid " << path;
1441 messages::internalError(self->asyncResp->res);
1442 return;
1443 }
1444 self->currentProfile = *current;
1445 self->supportedProfiles = *supported;
1446 self->profileConnection = owner;
1447 self->profilePath = path;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001448 });
George Liue99073f2022-12-09 11:06:16 +08001449 });
James Feist73df0db2019-03-25 15:29:35 -07001450 }
Ed Tanous24b2fe82022-01-06 12:45:54 -08001451 void pidSetDone()
James Feist73df0db2019-03-25 15:29:35 -07001452 {
1453 if (asyncResp->res.result() != boost::beast::http::status::ok)
1454 {
1455 return;
1456 }
zhanghch058d1b46d2021-04-01 11:18:24 +08001457 std::shared_ptr<bmcweb::AsyncResp> response = asyncResp;
James Feist73df0db2019-03-25 15:29:35 -07001458 if (profile)
1459 {
1460 if (std::find(supportedProfiles.begin(), supportedProfiles.end(),
1461 *profile) == supportedProfiles.end())
1462 {
1463 messages::actionParameterUnknown(response->res, "Profile",
1464 *profile);
1465 return;
1466 }
1467 currentProfile = *profile;
1468 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001469 [response](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001470 if (ec)
1471 {
1472 BMCWEB_LOG_ERROR << "Error patching profile" << ec;
1473 messages::internalError(response->res);
1474 }
James Feist73df0db2019-03-25 15:29:35 -07001475 },
1476 profileConnection, profilePath,
1477 "org.freedesktop.DBus.Properties", "Set", thermalModeIface,
Ed Tanous168e20c2021-12-13 14:39:53 -08001478 "Current", dbus::utility::DbusVariantType(*profile));
James Feist73df0db2019-03-25 15:29:35 -07001479 }
1480
1481 for (auto& containerPair : configuration)
1482 {
1483 auto& container = containerPair.second;
1484 if (!container)
1485 {
1486 continue;
1487 }
James Feist6ee7f772020-02-06 16:25:27 -08001488 BMCWEB_LOG_DEBUG << *container;
1489
Ed Tanous02cad962022-06-30 16:50:15 -07001490 const std::string& type = containerPair.first;
James Feist73df0db2019-03-25 15:29:35 -07001491
1492 for (nlohmann::json::iterator it = container->begin();
Manojkiran Eda17a897d2020-09-12 15:31:58 +05301493 it != container->end(); ++it)
James Feist73df0db2019-03-25 15:29:35 -07001494 {
1495 const auto& name = it.key();
Potin Laicddbf3d2023-02-14 14:28:58 +08001496 std::string dbusObjName = name;
1497 std::replace(dbusObjName.begin(), dbusObjName.end(), ' ', '_');
James Feist6ee7f772020-02-06 16:25:27 -08001498 BMCWEB_LOG_DEBUG << "looking for " << name;
1499
Patrick Williams89492a12023-05-10 07:51:34 -05001500 auto pathItr = std::find_if(managedObj.begin(),
1501 managedObj.end(),
1502 [&dbusObjName](const auto& obj) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001503 return boost::algorithm::ends_with(obj.first.str,
Potin Laicddbf3d2023-02-14 14:28:58 +08001504 "/" + dbusObjName);
Patrick Williams89492a12023-05-10 07:51:34 -05001505 });
Ed Tanousb9d36b42022-02-26 21:42:46 -08001506 dbus::utility::DBusPropertiesMap output;
James Feist73df0db2019-03-25 15:29:35 -07001507
1508 output.reserve(16); // The pid interface length
1509
1510 // determines if we're patching entity-manager or
1511 // creating a new object
1512 bool createNewObject = (pathItr == managedObj.end());
James Feist6ee7f772020-02-06 16:25:27 -08001513 BMCWEB_LOG_DEBUG << "Found = " << !createNewObject;
1514
James Feist73df0db2019-03-25 15:29:35 -07001515 std::string iface;
Ed Tanousea2b6702022-03-07 16:48:38 -08001516 if (!createNewObject)
James Feist73df0db2019-03-25 15:29:35 -07001517 {
Potin Lai8be2b5b2022-11-22 13:27:16 +08001518 bool findInterface = false;
Ed Tanousea2b6702022-03-07 16:48:38 -08001519 for (const auto& interface : pathItr->second)
James Feist73df0db2019-03-25 15:29:35 -07001520 {
Ed Tanousea2b6702022-03-07 16:48:38 -08001521 if (interface.first == pidConfigurationIface)
1522 {
1523 if (type == "PidControllers" ||
1524 type == "FanControllers")
1525 {
1526 iface = pidConfigurationIface;
Potin Lai8be2b5b2022-11-22 13:27:16 +08001527 findInterface = true;
1528 break;
Ed Tanousea2b6702022-03-07 16:48:38 -08001529 }
1530 }
1531 else if (interface.first == pidZoneConfigurationIface)
1532 {
1533 if (type == "FanZones")
1534 {
1535 iface = pidConfigurationIface;
Potin Lai8be2b5b2022-11-22 13:27:16 +08001536 findInterface = true;
1537 break;
Ed Tanousea2b6702022-03-07 16:48:38 -08001538 }
1539 }
1540 else if (interface.first == stepwiseConfigurationIface)
1541 {
1542 if (type == "StepwiseControllers")
1543 {
1544 iface = stepwiseConfigurationIface;
Potin Lai8be2b5b2022-11-22 13:27:16 +08001545 findInterface = true;
1546 break;
Ed Tanousea2b6702022-03-07 16:48:38 -08001547 }
1548 }
James Feist73df0db2019-03-25 15:29:35 -07001549 }
Potin Lai8be2b5b2022-11-22 13:27:16 +08001550
1551 // create new object if interface not found
1552 if (!findInterface)
1553 {
1554 createNewObject = true;
1555 }
James Feist73df0db2019-03-25 15:29:35 -07001556 }
James Feist6ee7f772020-02-06 16:25:27 -08001557
1558 if (createNewObject && it.value() == nullptr)
1559 {
Gunnar Mills4e0453b2020-07-08 14:00:30 -05001560 // can't delete a non-existent object
Ed Tanouse2616cc2022-06-27 12:45:55 -07001561 messages::propertyValueNotInList(response->res, it.value(),
1562 name);
James Feist6ee7f772020-02-06 16:25:27 -08001563 continue;
1564 }
1565
1566 std::string path;
1567 if (pathItr != managedObj.end())
1568 {
1569 path = pathItr->first.str;
1570 }
1571
James Feist73df0db2019-03-25 15:29:35 -07001572 BMCWEB_LOG_DEBUG << "Create new = " << createNewObject << "\n";
James Feiste69d9de2020-02-07 12:23:27 -08001573
1574 // arbitrary limit to avoid attacks
1575 constexpr const size_t controllerLimit = 500;
James Feist14b0b8d2020-02-12 11:52:07 -08001576 if (createNewObject && objectCount >= controllerLimit)
James Feiste69d9de2020-02-07 12:23:27 -08001577 {
1578 messages::resourceExhaustion(response->res, type);
1579 continue;
1580 }
Ed Tanousa170f272022-06-30 21:53:27 -07001581 std::string escaped = name;
1582 std::replace(escaped.begin(), escaped.end(), '_', ' ');
1583 output.emplace_back("Name", escaped);
James Feist73df0db2019-03-25 15:29:35 -07001584
1585 std::string chassis;
1586 CreatePIDRet ret = createPidInterface(
James Feist6ee7f772020-02-06 16:25:27 -08001587 response, type, it, path, managedObj, createNewObject,
1588 output, chassis, currentProfile);
James Feist73df0db2019-03-25 15:29:35 -07001589 if (ret == CreatePIDRet::fail)
1590 {
1591 return;
1592 }
Ed Tanous3174e4d2020-10-07 11:41:22 -07001593 if (ret == CreatePIDRet::del)
James Feist73df0db2019-03-25 15:29:35 -07001594 {
1595 continue;
1596 }
1597
1598 if (!createNewObject)
1599 {
1600 for (const auto& property : output)
1601 {
1602 crow::connections::systemBus->async_method_call(
1603 [response,
1604 propertyName{std::string(property.first)}](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001605 const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001606 if (ec)
1607 {
1608 BMCWEB_LOG_ERROR << "Error patching "
1609 << propertyName << ": " << ec;
1610 messages::internalError(response->res);
1611 return;
1612 }
1613 messages::success(response->res);
James Feist73df0db2019-03-25 15:29:35 -07001614 },
James Feist6ee7f772020-02-06 16:25:27 -08001615 "xyz.openbmc_project.EntityManager", path,
James Feist73df0db2019-03-25 15:29:35 -07001616 "org.freedesktop.DBus.Properties", "Set", iface,
1617 property.first, property.second);
1618 }
1619 }
1620 else
1621 {
1622 if (chassis.empty())
1623 {
1624 BMCWEB_LOG_ERROR << "Failed to get chassis from config";
Ed Tanousace85d62021-10-26 12:45:59 -07001625 messages::internalError(response->res);
James Feist73df0db2019-03-25 15:29:35 -07001626 return;
1627 }
1628
1629 bool foundChassis = false;
1630 for (const auto& obj : managedObj)
1631 {
1632 if (boost::algorithm::ends_with(obj.first.str, chassis))
1633 {
1634 chassis = obj.first.str;
1635 foundChassis = true;
1636 break;
1637 }
1638 }
1639 if (!foundChassis)
1640 {
1641 BMCWEB_LOG_ERROR << "Failed to find chassis on dbus";
1642 messages::resourceMissingAtURI(
Ed Tanousace85d62021-10-26 12:45:59 -07001643 response->res,
Ed Tanousef4c65b2023-04-24 15:28:50 -07001644 boost::urls::format("/redfish/v1/Chassis/{}",
1645 chassis));
James Feist73df0db2019-03-25 15:29:35 -07001646 return;
1647 }
1648
1649 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001650 [response](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001651 if (ec)
1652 {
1653 BMCWEB_LOG_ERROR << "Error Adding Pid Object "
1654 << ec;
1655 messages::internalError(response->res);
1656 return;
1657 }
1658 messages::success(response->res);
James Feist73df0db2019-03-25 15:29:35 -07001659 },
1660 "xyz.openbmc_project.EntityManager", chassis,
1661 "xyz.openbmc_project.AddObject", "AddObject", output);
1662 }
1663 }
1664 }
1665 }
Ed Tanous24b2fe82022-01-06 12:45:54 -08001666
1667 ~SetPIDValues()
1668 {
1669 try
1670 {
1671 pidSetDone();
1672 }
1673 catch (...)
1674 {
1675 BMCWEB_LOG_CRITICAL << "pidSetDone threw exception";
1676 }
1677 }
1678
zhanghch058d1b46d2021-04-01 11:18:24 +08001679 std::shared_ptr<bmcweb::AsyncResp> asyncResp;
James Feist73df0db2019-03-25 15:29:35 -07001680 std::vector<std::pair<std::string, std::optional<nlohmann::json>>>
1681 configuration;
1682 std::optional<std::string> profile;
1683 dbus::utility::ManagedObjectType managedObj;
1684 std::vector<std::string> supportedProfiles;
1685 std::string currentProfile;
1686 std::string profileConnection;
1687 std::string profilePath;
James Feist14b0b8d2020-02-12 11:52:07 -08001688 size_t objectCount = 0;
James Feist73df0db2019-03-25 15:29:35 -07001689};
James Feist83ff9ab2018-08-31 10:18:24 -07001690
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001691/**
1692 * @brief Retrieves BMC manager location data over DBus
1693 *
Ed Tanousac106bf2023-06-07 09:24:59 -07001694 * @param[in] asyncResp Shared pointer for completing asynchronous calls
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001695 * @param[in] connectionName - service name
1696 * @param[in] path - object path
1697 * @return none
1698 */
Ed Tanousac106bf2023-06-07 09:24:59 -07001699inline void getLocation(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001700 const std::string& connectionName,
1701 const std::string& path)
1702{
1703 BMCWEB_LOG_DEBUG << "Get BMC manager Location data.";
1704
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001705 sdbusplus::asio::getProperty<std::string>(
1706 *crow::connections::systemBus, connectionName, path,
1707 "xyz.openbmc_project.Inventory.Decorator.LocationCode", "LocationCode",
Ed Tanousac106bf2023-06-07 09:24:59 -07001708 [asyncResp](const boost::system::error_code& ec,
1709 const std::string& property) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001710 if (ec)
1711 {
1712 BMCWEB_LOG_DEBUG << "DBUS response error for "
1713 "Location";
Ed Tanousac106bf2023-06-07 09:24:59 -07001714 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07001715 return;
1716 }
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001717
Ed Tanousac106bf2023-06-07 09:24:59 -07001718 asyncResp->res.jsonValue["Location"]["PartLocation"]["ServiceLabel"] =
Ed Tanous002d39b2022-05-31 08:59:27 -07001719 property;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001720 });
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001721}
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001722// avoid name collision systems.hpp
1723inline void
Ed Tanousac106bf2023-06-07 09:24:59 -07001724 managerGetLastResetTime(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001725{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001726 BMCWEB_LOG_DEBUG << "Getting Manager Last Reset Time";
Ed Tanous52cc1122020-07-18 13:51:21 -07001727
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001728 sdbusplus::asio::getProperty<uint64_t>(
1729 *crow::connections::systemBus, "xyz.openbmc_project.State.BMC",
1730 "/xyz/openbmc_project/state/bmc0", "xyz.openbmc_project.State.BMC",
1731 "LastRebootTime",
Ed Tanousac106bf2023-06-07 09:24:59 -07001732 [asyncResp](const boost::system::error_code& ec,
1733 const uint64_t lastResetTime) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001734 if (ec)
1735 {
1736 BMCWEB_LOG_DEBUG << "D-BUS response error " << ec;
1737 return;
1738 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001739
Ed Tanous002d39b2022-05-31 08:59:27 -07001740 // LastRebootTime is epoch time, in milliseconds
1741 // https://github.com/openbmc/phosphor-dbus-interfaces/blob/7f9a128eb9296e926422ddc312c148b625890bb6/xyz/openbmc_project/State/BMC.interface.yaml#L19
1742 uint64_t lastResetTimeStamp = lastResetTime / 1000;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001743
Ed Tanous002d39b2022-05-31 08:59:27 -07001744 // Convert to ISO 8601 standard
Ed Tanousac106bf2023-06-07 09:24:59 -07001745 asyncResp->res.jsonValue["LastResetTime"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001746 redfish::time_utils::getDateTimeUint(lastResetTimeStamp);
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001747 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001748}
1749
1750/**
1751 * @brief Set the running firmware image
1752 *
Ed Tanousac106bf2023-06-07 09:24:59 -07001753 * @param[i,o] asyncResp - Async response object
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001754 * @param[i] runningFirmwareTarget - Image to make the running image
1755 *
1756 * @return void
1757 */
1758inline void
Ed Tanousac106bf2023-06-07 09:24:59 -07001759 setActiveFirmwareImage(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001760 const std::string& runningFirmwareTarget)
1761{
1762 // Get the Id from /redfish/v1/UpdateService/FirmwareInventory/<Id>
1763 std::string::size_type idPos = runningFirmwareTarget.rfind('/');
1764 if (idPos == std::string::npos)
1765 {
Ed Tanousac106bf2023-06-07 09:24:59 -07001766 messages::propertyValueNotInList(asyncResp->res, runningFirmwareTarget,
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001767 "@odata.id");
1768 BMCWEB_LOG_DEBUG << "Can't parse firmware ID!";
1769 return;
1770 }
1771 idPos++;
1772 if (idPos >= runningFirmwareTarget.size())
1773 {
Ed Tanousac106bf2023-06-07 09:24:59 -07001774 messages::propertyValueNotInList(asyncResp->res, runningFirmwareTarget,
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001775 "@odata.id");
1776 BMCWEB_LOG_DEBUG << "Invalid firmware ID.";
1777 return;
1778 }
1779 std::string firmwareId = runningFirmwareTarget.substr(idPos);
1780
1781 // Make sure the image is valid before setting priority
1782 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07001783 [asyncResp, firmwareId,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001784 runningFirmwareTarget](const boost::system::error_code& ec,
Ed Tanous711ac7a2021-12-20 09:34:41 -08001785 dbus::utility::ManagedObjectType& subtree) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001786 if (ec)
1787 {
1788 BMCWEB_LOG_DEBUG << "D-Bus response error getting objects.";
Ed Tanousac106bf2023-06-07 09:24:59 -07001789 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07001790 return;
1791 }
1792
1793 if (subtree.empty())
1794 {
1795 BMCWEB_LOG_DEBUG << "Can't find image!";
Ed Tanousac106bf2023-06-07 09:24:59 -07001796 messages::internalError(asyncResp->res);
Ed Tanous002d39b2022-05-31 08:59:27 -07001797 return;
1798 }
1799
1800 bool foundImage = false;
Ed Tanous02cad962022-06-30 16:50:15 -07001801 for (const auto& object : subtree)
Ed Tanous002d39b2022-05-31 08:59:27 -07001802 {
1803 const std::string& path =
1804 static_cast<const std::string&>(object.first);
1805 std::size_t idPos2 = path.rfind('/');
1806
1807 if (idPos2 == std::string::npos)
1808 {
1809 continue;
1810 }
1811
1812 idPos2++;
1813 if (idPos2 >= path.size())
1814 {
1815 continue;
1816 }
1817
1818 if (path.substr(idPos2) == firmwareId)
1819 {
1820 foundImage = true;
1821 break;
1822 }
1823 }
1824
1825 if (!foundImage)
1826 {
Ed Tanousac106bf2023-06-07 09:24:59 -07001827 messages::propertyValueNotInList(
1828 asyncResp->res, runningFirmwareTarget, "@odata.id");
Ed Tanous002d39b2022-05-31 08:59:27 -07001829 BMCWEB_LOG_DEBUG << "Invalid firmware ID.";
1830 return;
1831 }
1832
1833 BMCWEB_LOG_DEBUG << "Setting firmware version " << firmwareId
1834 << " to priority 0.";
1835
1836 // Only support Immediate
1837 // An addition could be a Redfish Setting like
1838 // ActiveSoftwareImageApplyTime and support OnReset
1839 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07001840 [asyncResp](const boost::system::error_code& ec2) {
Ed Tanous8a592812022-06-04 09:06:59 -07001841 if (ec2)
Gunnar Mills4bfefa72020-07-30 13:54:29 -05001842 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001843 BMCWEB_LOG_DEBUG << "D-Bus response error setting.";
Ed Tanousac106bf2023-06-07 09:24:59 -07001844 messages::internalError(asyncResp->res);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001845 return;
1846 }
Ed Tanousac106bf2023-06-07 09:24:59 -07001847 doBMCGracefulRestart(asyncResp);
Ed Tanous002d39b2022-05-31 08:59:27 -07001848 },
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001849
Ed Tanous002d39b2022-05-31 08:59:27 -07001850 "xyz.openbmc_project.Software.BMC.Updater",
1851 "/xyz/openbmc_project/software/" + firmwareId,
1852 "org.freedesktop.DBus.Properties", "Set",
1853 "xyz.openbmc_project.Software.RedundancyPriority", "Priority",
1854 dbus::utility::DbusVariantType(static_cast<uint8_t>(0)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001855 },
1856 "xyz.openbmc_project.Software.BMC.Updater",
1857 "/xyz/openbmc_project/software", "org.freedesktop.DBus.ObjectManager",
1858 "GetManagedObjects");
1859}
Ed Tanous1abe55e2018-09-05 08:30:59 -07001860
Ed Tanousac106bf2023-06-07 09:24:59 -07001861inline void setDateTime(std::shared_ptr<bmcweb::AsyncResp> asyncResp,
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001862 std::string datetime)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001863{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001864 BMCWEB_LOG_DEBUG << "Set date time: " << datetime;
Borawski.Lukasz9c3106852018-02-09 15:24:22 +01001865
Ed Tanousc2e32002023-01-07 22:05:08 -08001866 std::optional<redfish::time_utils::usSinceEpoch> us =
1867 redfish::time_utils::dateStringToEpoch(datetime);
1868 if (!us)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001869 {
Ed Tanousac106bf2023-06-07 09:24:59 -07001870 messages::propertyValueFormatError(asyncResp->res, datetime,
1871 "DateTime");
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001872 return;
1873 }
Ed Tanousc2e32002023-01-07 22:05:08 -08001874 crow::connections::systemBus->async_method_call(
Ed Tanousac106bf2023-06-07 09:24:59 -07001875 [asyncResp{std::move(asyncResp)},
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001876 datetime{std::move(datetime)}](const boost::system::error_code& ec) {
Ed Tanousc2e32002023-01-07 22:05:08 -08001877 if (ec)
1878 {
1879 BMCWEB_LOG_DEBUG << "Failed to set elapsed time. "
1880 "DBUS response error "
1881 << ec;
Ed Tanousac106bf2023-06-07 09:24:59 -07001882 messages::internalError(asyncResp->res);
Ed Tanousc2e32002023-01-07 22:05:08 -08001883 return;
1884 }
Ed Tanousac106bf2023-06-07 09:24:59 -07001885 asyncResp->res.jsonValue["DateTime"] = datetime;
Ed Tanousc2e32002023-01-07 22:05:08 -08001886 },
1887 "xyz.openbmc_project.Time.Manager", "/xyz/openbmc_project/time/bmc",
1888 "org.freedesktop.DBus.Properties", "Set",
1889 "xyz.openbmc_project.Time.EpochTime", "Elapsed",
1890 dbus::utility::DbusVariantType(us->count()));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001891}
1892
Ed Tanous75815e52022-10-05 17:21:13 -07001893inline void
1894 checkForQuiesced(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
1895{
1896 sdbusplus::asio::getProperty<std::string>(
1897 *crow::connections::systemBus, "org.freedesktop.systemd1",
1898 "/org/freedesktop/systemd1/unit/obmc-bmc-service-quiesce@0.target",
1899 "org.freedesktop.systemd1.Unit", "ActiveState",
1900 [asyncResp](const boost::system::error_code& ec,
1901 const std::string& val) {
1902 if (!ec)
1903 {
1904 if (val == "active")
1905 {
1906 asyncResp->res.jsonValue["Status"]["Health"] = "Critical";
1907 asyncResp->res.jsonValue["Status"]["State"] = "Quiesced";
1908 return;
1909 }
1910 }
1911 asyncResp->res.jsonValue["Status"]["Health"] = "OK";
1912 asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
1913 });
1914}
1915
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001916inline void requestRoutesManager(App& app)
1917{
1918 std::string uuid = persistent_data::getConfig().systemUuid;
1919
1920 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/")
Ed Tanoused398212021-06-09 17:05:54 -07001921 .privileges(redfish::privileges::getManager)
Ed Tanous002d39b2022-05-31 08:59:27 -07001922 .methods(boost::beast::http::verb::get)(
1923 [&app, uuid](const crow::Request& req,
Ed Tanous45ca1b82022-03-25 13:07:27 -07001924 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001925 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001926 {
1927 return;
1928 }
1929 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Managers/bmc";
Sui Chena51fc2d2022-07-14 17:21:53 -07001930 asyncResp->res.jsonValue["@odata.type"] = "#Manager.v1_14_0.Manager";
Ed Tanous002d39b2022-05-31 08:59:27 -07001931 asyncResp->res.jsonValue["Id"] = "bmc";
1932 asyncResp->res.jsonValue["Name"] = "OpenBmc Manager";
1933 asyncResp->res.jsonValue["Description"] =
1934 "Baseboard Management Controller";
1935 asyncResp->res.jsonValue["PowerState"] = "On";
Ed Tanous14766872022-03-15 10:44:42 -07001936
Ed Tanous002d39b2022-05-31 08:59:27 -07001937 asyncResp->res.jsonValue["ManagerType"] = "BMC";
1938 asyncResp->res.jsonValue["UUID"] = systemd_utils::getUuid();
1939 asyncResp->res.jsonValue["ServiceEntryPointUUID"] = uuid;
1940 asyncResp->res.jsonValue["Model"] = "OpenBmc"; // TODO(ed), get model
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001941
Ed Tanous002d39b2022-05-31 08:59:27 -07001942 asyncResp->res.jsonValue["LogServices"]["@odata.id"] =
1943 "/redfish/v1/Managers/bmc/LogServices";
1944 asyncResp->res.jsonValue["NetworkProtocol"]["@odata.id"] =
1945 "/redfish/v1/Managers/bmc/NetworkProtocol";
1946 asyncResp->res.jsonValue["EthernetInterfaces"]["@odata.id"] =
1947 "/redfish/v1/Managers/bmc/EthernetInterfaces";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001948
1949#ifdef BMCWEB_ENABLE_VM_NBDPROXY
Ed Tanous002d39b2022-05-31 08:59:27 -07001950 asyncResp->res.jsonValue["VirtualMedia"]["@odata.id"] =
1951 "/redfish/v1/Managers/bmc/VirtualMedia";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001952#endif // BMCWEB_ENABLE_VM_NBDPROXY
1953
Ed Tanous002d39b2022-05-31 08:59:27 -07001954 // default oem data
1955 nlohmann::json& oem = asyncResp->res.jsonValue["Oem"];
1956 nlohmann::json& oemOpenbmc = oem["OpenBmc"];
1957 oem["@odata.type"] = "#OemManager.Oem";
1958 oem["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem";
1959 oemOpenbmc["@odata.type"] = "#OemManager.OpenBmc";
1960 oemOpenbmc["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc";
Ed Tanous14766872022-03-15 10:44:42 -07001961
Ed Tanous002d39b2022-05-31 08:59:27 -07001962 nlohmann::json::object_t certificates;
1963 certificates["@odata.id"] =
1964 "/redfish/v1/Managers/bmc/Truststore/Certificates";
1965 oemOpenbmc["Certificates"] = std::move(certificates);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001966
Ed Tanous002d39b2022-05-31 08:59:27 -07001967 // Manager.Reset (an action) can be many values, OpenBMC only
1968 // supports BMC reboot.
1969 nlohmann::json& managerReset =
1970 asyncResp->res.jsonValue["Actions"]["#Manager.Reset"];
1971 managerReset["target"] =
1972 "/redfish/v1/Managers/bmc/Actions/Manager.Reset";
1973 managerReset["@Redfish.ActionInfo"] =
1974 "/redfish/v1/Managers/bmc/ResetActionInfo";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001975
Ed Tanous002d39b2022-05-31 08:59:27 -07001976 // ResetToDefaults (Factory Reset) has values like
1977 // PreserveNetworkAndUsers and PreserveNetwork that aren't supported
1978 // on OpenBMC
1979 nlohmann::json& resetToDefaults =
1980 asyncResp->res.jsonValue["Actions"]["#Manager.ResetToDefaults"];
1981 resetToDefaults["target"] =
1982 "/redfish/v1/Managers/bmc/Actions/Manager.ResetToDefaults";
Ed Tanous613dabe2022-07-09 11:17:36 -07001983 resetToDefaults["ResetType@Redfish.AllowableValues"] =
1984 nlohmann::json::array_t({"ResetAll"});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001985
Ed Tanous002d39b2022-05-31 08:59:27 -07001986 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07001987 redfish::time_utils::getDateTimeOffsetNow();
Tejas Patil7c8c4052021-06-04 17:43:14 +05301988
Ed Tanous002d39b2022-05-31 08:59:27 -07001989 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
1990 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
1991 redfishDateTimeOffset.second;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001992
Ed Tanous002d39b2022-05-31 08:59:27 -07001993 // TODO (Gunnar): Remove these one day since moved to ComputerSystem
1994 // Still used by OCP profiles
1995 // https://github.com/opencomputeproject/OCP-Profiles/issues/23
1996 // Fill in SerialConsole info
1997 asyncResp->res.jsonValue["SerialConsole"]["ServiceEnabled"] = true;
1998 asyncResp->res.jsonValue["SerialConsole"]["MaxConcurrentSessions"] = 15;
Ed Tanous613dabe2022-07-09 11:17:36 -07001999 asyncResp->res.jsonValue["SerialConsole"]["ConnectTypesSupported"] =
2000 nlohmann::json::array_t({"IPMI", "SSH"});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002001#ifdef BMCWEB_ENABLE_KVM
Ed Tanous002d39b2022-05-31 08:59:27 -07002002 // Fill in GraphicalConsole info
2003 asyncResp->res.jsonValue["GraphicalConsole"]["ServiceEnabled"] = true;
2004 asyncResp->res.jsonValue["GraphicalConsole"]["MaxConcurrentSessions"] =
2005 4;
Ed Tanous613dabe2022-07-09 11:17:36 -07002006 asyncResp->res.jsonValue["GraphicalConsole"]["ConnectTypesSupported"] =
2007 nlohmann::json::array_t({"KVMIP"});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002008#endif // BMCWEB_ENABLE_KVM
2009
Ed Tanous002d39b2022-05-31 08:59:27 -07002010 asyncResp->res.jsonValue["Links"]["ManagerForServers@odata.count"] = 1;
Ed Tanous14766872022-03-15 10:44:42 -07002011
Ed Tanous002d39b2022-05-31 08:59:27 -07002012 nlohmann::json::array_t managerForServers;
2013 nlohmann::json::object_t manager;
2014 manager["@odata.id"] = "/redfish/v1/Systems/system";
Patrick Williamsad539542023-05-12 10:10:08 -05002015 managerForServers.emplace_back(std::move(manager));
Ed Tanous002d39b2022-05-31 08:59:27 -07002016
2017 asyncResp->res.jsonValue["Links"]["ManagerForServers"] =
2018 std::move(managerForServers);
2019
Willy Tu13451e32023-05-24 16:08:18 -07002020 if constexpr (bmcwebEnableHealthPopulate)
2021 {
2022 auto health = std::make_shared<HealthPopulate>(asyncResp);
2023 health->isManagersHealth = true;
2024 health->populate();
2025 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002026
Willy Tueee00132022-06-14 14:53:17 -07002027 sw_util::populateSoftwareInformation(asyncResp, sw_util::bmcPurpose,
Ed Tanous002d39b2022-05-31 08:59:27 -07002028 "FirmwareVersion", true);
2029
2030 managerGetLastResetTime(asyncResp);
2031
Sui Chena51fc2d2022-07-14 17:21:53 -07002032 // ManagerDiagnosticData is added for all BMCs.
2033 nlohmann::json& managerDiagnosticData =
2034 asyncResp->res.jsonValue["ManagerDiagnosticData"];
2035 managerDiagnosticData["@odata.id"] =
2036 "/redfish/v1/Managers/bmc/ManagerDiagnosticData";
2037
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002038#ifdef BMCWEB_ENABLE_REDFISH_OEM_MANAGER_FAN_DATA
Ed Tanous002d39b2022-05-31 08:59:27 -07002039 auto pids = std::make_shared<GetPIDValues>(asyncResp);
2040 pids->run();
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002041#endif
Ed Tanous002d39b2022-05-31 08:59:27 -07002042
2043 getMainChassisId(asyncResp,
2044 [](const std::string& chassisId,
2045 const std::shared_ptr<bmcweb::AsyncResp>& aRsp) {
2046 aRsp->res.jsonValue["Links"]["ManagerForChassis@odata.count"] = 1;
2047 nlohmann::json::array_t managerForChassis;
Ed Tanous8a592812022-06-04 09:06:59 -07002048 nlohmann::json::object_t managerObj;
Ed Tanousef4c65b2023-04-24 15:28:50 -07002049 boost::urls::url chassiUrl =
2050 boost::urls::format("/redfish/v1/Chassis/{}", chassisId);
Willy Tueddfc432022-09-26 16:46:38 +00002051 managerObj["@odata.id"] = chassiUrl;
Patrick Williamsad539542023-05-12 10:10:08 -05002052 managerForChassis.emplace_back(std::move(managerObj));
Ed Tanous002d39b2022-05-31 08:59:27 -07002053 aRsp->res.jsonValue["Links"]["ManagerForChassis"] =
2054 std::move(managerForChassis);
2055 aRsp->res.jsonValue["Links"]["ManagerInChassis"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +00002056 chassiUrl;
Ed Tanous002d39b2022-05-31 08:59:27 -07002057 });
Ed Tanous14766872022-03-15 10:44:42 -07002058
Ed Tanous75815e52022-10-05 17:21:13 -07002059 sdbusplus::asio::getProperty<double>(
2060 *crow::connections::systemBus, "org.freedesktop.systemd1",
2061 "/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager",
2062 "Progress",
2063 [asyncResp](const boost::system::error_code& ec, double val) {
2064 if (ec)
2065 {
2066 BMCWEB_LOG_ERROR << "Error while getting progress";
2067 messages::internalError(asyncResp->res);
2068 return;
2069 }
2070 if (val < 1.0)
2071 {
2072 asyncResp->res.jsonValue["Status"]["Health"] = "OK";
2073 asyncResp->res.jsonValue["Status"]["State"] = "Starting";
2074 return;
2075 }
2076 checkForQuiesced(asyncResp);
2077 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002078
George Liue99073f2022-12-09 11:06:16 +08002079 constexpr std::array<std::string_view, 1> interfaces = {
2080 "xyz.openbmc_project.Inventory.Item.Bmc"};
2081 dbus::utility::getSubTree(
2082 "/xyz/openbmc_project/inventory", 0, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -07002083 [asyncResp](
George Liue99073f2022-12-09 11:06:16 +08002084 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07002085 const dbus::utility::MapperGetSubTreeResponse& subtree) {
2086 if (ec)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002087 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002088 BMCWEB_LOG_DEBUG << "D-Bus response error on GetSubTree " << ec;
2089 return;
2090 }
2091 if (subtree.empty())
2092 {
2093 BMCWEB_LOG_DEBUG << "Can't find bmc D-Bus object!";
2094 return;
2095 }
2096 // Assume only 1 bmc D-Bus object
2097 // Throw an error if there is more than 1
2098 if (subtree.size() > 1)
2099 {
2100 BMCWEB_LOG_DEBUG << "Found more than 1 bmc D-Bus object!";
2101 messages::internalError(asyncResp->res);
2102 return;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002103 }
2104
Ed Tanous002d39b2022-05-31 08:59:27 -07002105 if (subtree[0].first.empty() || subtree[0].second.size() != 1)
2106 {
2107 BMCWEB_LOG_DEBUG << "Error getting bmc D-Bus object!";
2108 messages::internalError(asyncResp->res);
2109 return;
2110 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002111
Ed Tanous002d39b2022-05-31 08:59:27 -07002112 const std::string& path = subtree[0].first;
2113 const std::string& connectionName = subtree[0].second[0].first;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002114
Ed Tanous002d39b2022-05-31 08:59:27 -07002115 for (const auto& interfaceName : subtree[0].second[0].second)
2116 {
2117 if (interfaceName ==
2118 "xyz.openbmc_project.Inventory.Decorator.Asset")
2119 {
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02002120 sdbusplus::asio::getAllProperties(
2121 *crow::connections::systemBus, connectionName, path,
2122 "xyz.openbmc_project.Inventory.Decorator.Asset",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002123 [asyncResp](const boost::system::error_code& ec2,
Ed Tanousb9d36b42022-02-26 21:42:46 -08002124 const dbus::utility::DBusPropertiesMap&
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002125 propertiesList) {
Ed Tanous8a592812022-06-04 09:06:59 -07002126 if (ec2)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002127 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002128 BMCWEB_LOG_DEBUG << "Can't get bmc asset!";
2129 return;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002130 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002131
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02002132 const std::string* partNumber = nullptr;
2133 const std::string* serialNumber = nullptr;
2134 const std::string* manufacturer = nullptr;
2135 const std::string* model = nullptr;
2136 const std::string* sparePartNumber = nullptr;
2137
2138 const bool success = sdbusplus::unpackPropertiesNoThrow(
2139 dbus_utils::UnpackErrorPrinter(), propertiesList,
2140 "PartNumber", partNumber, "SerialNumber",
2141 serialNumber, "Manufacturer", manufacturer, "Model",
2142 model, "SparePartNumber", sparePartNumber);
2143
2144 if (!success)
2145 {
2146 messages::internalError(asyncResp->res);
2147 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07002148 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02002149
2150 if (partNumber != nullptr)
2151 {
2152 asyncResp->res.jsonValue["PartNumber"] =
2153 *partNumber;
2154 }
2155
2156 if (serialNumber != nullptr)
2157 {
2158 asyncResp->res.jsonValue["SerialNumber"] =
2159 *serialNumber;
2160 }
2161
2162 if (manufacturer != nullptr)
2163 {
2164 asyncResp->res.jsonValue["Manufacturer"] =
2165 *manufacturer;
2166 }
2167
2168 if (model != nullptr)
2169 {
2170 asyncResp->res.jsonValue["Model"] = *model;
2171 }
2172
2173 if (sparePartNumber != nullptr)
2174 {
2175 asyncResp->res.jsonValue["SparePartNumber"] =
2176 *sparePartNumber;
2177 }
2178 });
Ed Tanous002d39b2022-05-31 08:59:27 -07002179 }
2180 else if (interfaceName ==
2181 "xyz.openbmc_project.Inventory.Decorator.LocationCode")
2182 {
2183 getLocation(asyncResp, connectionName, path);
2184 }
2185 }
George Liue99073f2022-12-09 11:06:16 +08002186 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002187 });
2188
2189 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/")
Ed Tanoused398212021-06-09 17:05:54 -07002190 .privileges(redfish::privileges::patchManager)
Ed Tanous45ca1b82022-03-25 13:07:27 -07002191 .methods(boost::beast::http::verb::patch)(
2192 [&app](const crow::Request& req,
2193 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002194 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002195 {
2196 return;
2197 }
2198 std::optional<nlohmann::json> oem;
2199 std::optional<nlohmann::json> links;
2200 std::optional<std::string> datetime;
2201
2202 if (!json_util::readJsonPatch(req, asyncResp->res, "Oem", oem,
2203 "DateTime", datetime, "Links", links))
2204 {
2205 return;
2206 }
2207
2208 if (oem)
2209 {
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002210#ifdef BMCWEB_ENABLE_REDFISH_OEM_MANAGER_FAN_DATA
Ed Tanous002d39b2022-05-31 08:59:27 -07002211 std::optional<nlohmann::json> openbmc;
2212 if (!redfish::json_util::readJson(*oem, asyncResp->res, "OpenBmc",
2213 openbmc))
2214 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002215 return;
2216 }
2217 if (openbmc)
2218 {
2219 std::optional<nlohmann::json> fan;
2220 if (!redfish::json_util::readJson(*openbmc, asyncResp->res,
2221 "Fan", fan))
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002222 {
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002223 return;
2224 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002225 if (fan)
2226 {
2227 auto pid = std::make_shared<SetPIDValues>(asyncResp, *fan);
2228 pid->run();
2229 }
2230 }
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002231#else
2232 messages::propertyUnknown(asyncResp->res, "Oem");
2233 return;
2234#endif
Ed Tanous002d39b2022-05-31 08:59:27 -07002235 }
2236 if (links)
2237 {
2238 std::optional<nlohmann::json> activeSoftwareImage;
2239 if (!redfish::json_util::readJson(*links, asyncResp->res,
2240 "ActiveSoftwareImage",
2241 activeSoftwareImage))
2242 {
2243 return;
2244 }
2245 if (activeSoftwareImage)
2246 {
2247 std::optional<std::string> odataId;
2248 if (!json_util::readJson(*activeSoftwareImage, asyncResp->res,
2249 "@odata.id", odataId))
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002250 {
Ed Tanous45ca1b82022-03-25 13:07:27 -07002251 return;
2252 }
2253
Ed Tanous002d39b2022-05-31 08:59:27 -07002254 if (odataId)
Ed Tanous45ca1b82022-03-25 13:07:27 -07002255 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002256 setActiveFirmwareImage(asyncResp, *odataId);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002257 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002258 }
2259 }
2260 if (datetime)
2261 {
2262 setDateTime(asyncResp, std::move(*datetime));
2263 }
2264 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002265}
2266
2267inline void requestRoutesManagerCollection(App& app)
2268{
2269 BMCWEB_ROUTE(app, "/redfish/v1/Managers/")
Ed Tanoused398212021-06-09 17:05:54 -07002270 .privileges(redfish::privileges::getManagerCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002271 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002272 [&app](const crow::Request& req,
2273 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002274 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002275 {
2276 return;
2277 }
2278 // Collections don't include the static data added by SubRoute
2279 // because it has a duplicate entry for members
2280 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Managers";
2281 asyncResp->res.jsonValue["@odata.type"] =
2282 "#ManagerCollection.ManagerCollection";
2283 asyncResp->res.jsonValue["Name"] = "Manager Collection";
2284 asyncResp->res.jsonValue["Members@odata.count"] = 1;
2285 nlohmann::json::array_t members;
2286 nlohmann::json& bmc = members.emplace_back();
2287 bmc["@odata.id"] = "/redfish/v1/Managers/bmc";
2288 asyncResp->res.jsonValue["Members"] = std::move(members);
2289 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002290}
Ed Tanous1abe55e2018-09-05 08:30:59 -07002291} // namespace redfish