blob: 01ec4e510d2bbd5ffff98d2a825c87abe7f427d8 [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
Sui Chena51fc2d2022-07-14 17:21:53 -070018#include "app.hpp"
19#include "dbus_utility.hpp"
James Feistb49ac872019-05-21 15:12:01 -070020#include "health.hpp"
Sui Chena51fc2d2022-07-14 17:21:53 -070021#include "query.hpp"
Jennifer Leec5d03ff2019-03-08 15:42:58 -080022#include "redfish_util.hpp"
Sui Chena51fc2d2022-07-14 17:21:53 -070023#include "registries/privilege_registry.hpp"
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +020024#include "utils/dbus_utils.hpp"
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080025#include "utils/json_utils.hpp"
Sui Chena51fc2d2022-07-14 17:21:53 -070026#include "utils/sw_utils.hpp"
27#include "utils/systemd_utils.hpp"
Ed Tanous2b829372022-08-03 14:22:34 -070028#include "utils/time_utils.hpp"
Borawski.Lukasz9c3106852018-02-09 15:24:22 +010029
George Liue99073f2022-12-09 11:06:16 +080030#include <boost/system/error_code.hpp>
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +020031#include <sdbusplus/asio/property.hpp>
32#include <sdbusplus/unpack_properties.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050033
Ed Tanousa170f272022-06-30 21:53:27 -070034#include <algorithm>
George Liue99073f2022-12-09 11:06:16 +080035#include <array>
Gunnar Mills4bfefa72020-07-30 13:54:29 -050036#include <cstdint>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050037#include <memory>
38#include <sstream>
George Liue99073f2022-12-09 11:06:16 +080039#include <string_view>
Ed Tanousabf2add2019-01-22 16:40:12 -080040#include <variant>
James Feist5b4aa862018-08-16 14:07:01 -070041
Ed Tanous1abe55e2018-09-05 08:30:59 -070042namespace redfish
43{
Jennifer Leeed5befb2018-08-10 11:29:45 -070044
45/**
Gunnar Mills2a5c4402020-05-19 09:07:24 -050046 * Function reboots the BMC.
47 *
48 * @param[in] asyncResp - Shared pointer for completing asynchronous calls
Jennifer Leeed5befb2018-08-10 11:29:45 -070049 */
zhanghch058d1b46d2021-04-01 11:18:24 +080050inline void
51 doBMCGracefulRestart(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
Gunnar Mills2a5c4402020-05-19 09:07:24 -050052{
53 const char* processName = "xyz.openbmc_project.State.BMC";
54 const char* objectPath = "/xyz/openbmc_project/state/bmc0";
55 const char* interfaceName = "xyz.openbmc_project.State.BMC";
56 const std::string& propertyValue =
57 "xyz.openbmc_project.State.BMC.Transition.Reboot";
58 const char* destProperty = "RequestedBMCTransition";
59
60 // Create the D-Bus variant for D-Bus call.
Ed Tanous168e20c2021-12-13 14:39:53 -080061 dbus::utility::DbusVariantType dbusPropertyValue(propertyValue);
Gunnar Mills2a5c4402020-05-19 09:07:24 -050062
63 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -080064 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -070065 // Use "Set" method to set the property value.
66 if (ec)
67 {
68 BMCWEB_LOG_DEBUG << "[Set] Bad D-Bus request error: " << ec;
69 messages::internalError(asyncResp->res);
70 return;
71 }
Gunnar Mills2a5c4402020-05-19 09:07:24 -050072
Ed Tanous002d39b2022-05-31 08:59:27 -070073 messages::success(asyncResp->res);
Gunnar Mills2a5c4402020-05-19 09:07:24 -050074 },
75 processName, objectPath, "org.freedesktop.DBus.Properties", "Set",
76 interfaceName, destProperty, dbusPropertyValue);
77}
78
zhanghch058d1b46d2021-04-01 11:18:24 +080079inline void
80 doBMCForceRestart(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +000081{
82 const char* processName = "xyz.openbmc_project.State.BMC";
83 const char* objectPath = "/xyz/openbmc_project/state/bmc0";
84 const char* interfaceName = "xyz.openbmc_project.State.BMC";
85 const std::string& propertyValue =
86 "xyz.openbmc_project.State.BMC.Transition.HardReboot";
87 const char* destProperty = "RequestedBMCTransition";
88
89 // Create the D-Bus variant for D-Bus call.
Ed Tanous168e20c2021-12-13 14:39:53 -080090 dbus::utility::DbusVariantType dbusPropertyValue(propertyValue);
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +000091
92 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -080093 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -070094 // Use "Set" method to set the property value.
95 if (ec)
96 {
97 BMCWEB_LOG_DEBUG << "[Set] Bad D-Bus request error: " << ec;
98 messages::internalError(asyncResp->res);
99 return;
100 }
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +0000101
Ed Tanous002d39b2022-05-31 08:59:27 -0700102 messages::success(asyncResp->res);
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +0000103 },
104 processName, objectPath, "org.freedesktop.DBus.Properties", "Set",
105 interfaceName, destProperty, dbusPropertyValue);
106}
107
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500108/**
109 * ManagerResetAction class supports the POST method for the Reset (reboot)
110 * action.
111 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700112inline void requestRoutesManagerResetAction(App& app)
Jennifer Leeed5befb2018-08-10 11:29:45 -0700113{
Jennifer Leeed5befb2018-08-10 11:29:45 -0700114 /**
Jennifer Leeed5befb2018-08-10 11:29:45 -0700115 * Function handles POST method request.
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500116 * Analyzes POST body before sending Reset (Reboot) request data to D-Bus.
Jayaprakash Mutyalaf92af382020-06-16 23:29:41 +0000117 * OpenBMC supports ResetType "GracefulRestart" and "ForceRestart".
Jennifer Leeed5befb2018-08-10 11:29:45 -0700118 */
Jennifer Leeed5befb2018-08-10 11:29:45 -0700119
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700120 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/Actions/Manager.Reset/")
Ed Tanoused398212021-06-09 17:05:54 -0700121 .privileges(redfish::privileges::postManager)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700122 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -0700123 [&app](const crow::Request& req,
124 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +0000125 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -0700126 {
127 return;
128 }
129 BMCWEB_LOG_DEBUG << "Post Manager Reset.";
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500130
Ed Tanous002d39b2022-05-31 08:59:27 -0700131 std::string resetType;
Jennifer Leeed5befb2018-08-10 11:29:45 -0700132
Ed Tanous002d39b2022-05-31 08:59:27 -0700133 if (!json_util::readJsonAction(req, asyncResp->res, "ResetType",
134 resetType))
135 {
136 return;
137 }
Gunnar Mills2a5c4402020-05-19 09:07:24 -0500138
Ed Tanous002d39b2022-05-31 08:59:27 -0700139 if (resetType == "GracefulRestart")
140 {
141 BMCWEB_LOG_DEBUG << "Proceeding with " << resetType;
142 doBMCGracefulRestart(asyncResp);
143 return;
144 }
145 if (resetType == "ForceRestart")
146 {
147 BMCWEB_LOG_DEBUG << "Proceeding with " << resetType;
148 doBMCForceRestart(asyncResp);
149 return;
150 }
151 BMCWEB_LOG_DEBUG << "Invalid property value for ResetType: "
152 << resetType;
153 messages::actionParameterNotSupported(asyncResp->res, resetType,
154 "ResetType");
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700155
Ed Tanous002d39b2022-05-31 08:59:27 -0700156 return;
157 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700158}
Jennifer Leeed5befb2018-08-10 11:29:45 -0700159
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500160/**
161 * ManagerResetToDefaultsAction class supports POST method for factory reset
162 * action.
163 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700164inline void requestRoutesManagerResetToDefaultsAction(App& app)
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500165{
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500166
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500167 /**
168 * Function handles ResetToDefaults POST method request.
169 *
170 * Analyzes POST body message and factory resets BMC by calling
171 * BMC code updater factory reset followed by a BMC reboot.
172 *
173 * BMC code updater factory reset wipes the whole BMC read-write
174 * filesystem which includes things like the network settings.
175 *
176 * OpenBMC only supports ResetToDefaultsType "ResetAll".
177 */
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500178
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700179 BMCWEB_ROUTE(app,
180 "/redfish/v1/Managers/bmc/Actions/Manager.ResetToDefaults/")
Ed Tanoused398212021-06-09 17:05:54 -0700181 .privileges(redfish::privileges::postManager)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700182 .methods(boost::beast::http::verb::post)(
Ed Tanous45ca1b82022-03-25 13:07:27 -0700183 [&app](const crow::Request& req,
184 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +0000185 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -0700186 {
187 return;
188 }
189 BMCWEB_LOG_DEBUG << "Post ResetToDefaults.";
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500190
Ed Tanous002d39b2022-05-31 08:59:27 -0700191 std::string resetType;
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500192
Ed Tanous002d39b2022-05-31 08:59:27 -0700193 if (!json_util::readJsonAction(req, asyncResp->res,
194 "ResetToDefaultsType", resetType))
195 {
196 BMCWEB_LOG_DEBUG << "Missing property ResetToDefaultsType.";
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700197
Ed Tanous002d39b2022-05-31 08:59:27 -0700198 messages::actionParameterMissing(asyncResp->res, "ResetToDefaults",
199 "ResetToDefaultsType");
200 return;
201 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700202
Ed Tanous002d39b2022-05-31 08:59:27 -0700203 if (resetType != "ResetAll")
204 {
205 BMCWEB_LOG_DEBUG
206 << "Invalid property value for ResetToDefaultsType: "
207 << resetType;
208 messages::actionParameterNotSupported(asyncResp->res, resetType,
209 "ResetToDefaultsType");
210 return;
211 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700212
Ed Tanous002d39b2022-05-31 08:59:27 -0700213 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800214 [asyncResp](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700215 if (ec)
216 {
217 BMCWEB_LOG_DEBUG << "Failed to ResetToDefaults: " << ec;
218 messages::internalError(asyncResp->res);
219 return;
220 }
221 // Factory Reset doesn't actually happen until a reboot
222 // Can't erase what the BMC is running on
223 doBMCGracefulRestart(asyncResp);
224 },
225 "xyz.openbmc_project.Software.BMC.Updater",
226 "/xyz/openbmc_project/software",
227 "xyz.openbmc_project.Common.FactoryReset", "Reset");
228 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700229}
Gunnar Mills3e40fc72020-05-19 19:18:17 -0500230
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530231/**
232 * ManagerResetActionInfo derived class for delivering Manager
233 * ResetType AllowableValues using ResetInfo schema.
234 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700235inline void requestRoutesManagerResetActionInfo(App& app)
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530236{
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530237 /**
238 * Functions triggers appropriate requests on DBus
239 */
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700240
241 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/ResetActionInfo/")
Ed Tanoused398212021-06-09 17:05:54 -0700242 .privileges(redfish::privileges::getActionInfo)
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700243 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -0700244 [&app](const crow::Request& req,
245 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +0000246 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -0700247 {
248 return;
249 }
Ed Tanous14766872022-03-15 10:44:42 -0700250
Ed Tanous002d39b2022-05-31 08:59:27 -0700251 asyncResp->res.jsonValue["@odata.type"] =
252 "#ActionInfo.v1_1_2.ActionInfo";
253 asyncResp->res.jsonValue["@odata.id"] =
254 "/redfish/v1/Managers/bmc/ResetActionInfo";
255 asyncResp->res.jsonValue["Name"] = "Reset Action Info";
256 asyncResp->res.jsonValue["Id"] = "ResetActionInfo";
257 nlohmann::json::object_t parameter;
258 parameter["Name"] = "ResetType";
259 parameter["Required"] = true;
260 parameter["DataType"] = "String";
Ed Tanous14766872022-03-15 10:44:42 -0700261
Ed Tanous002d39b2022-05-31 08:59:27 -0700262 nlohmann::json::array_t allowableValues;
263 allowableValues.push_back("GracefulRestart");
264 allowableValues.push_back("ForceRestart");
265 parameter["AllowableValues"] = std::move(allowableValues);
Ed Tanous14766872022-03-15 10:44:42 -0700266
Ed Tanous002d39b2022-05-31 08:59:27 -0700267 nlohmann::json::array_t parameters;
268 parameters.push_back(std::move(parameter));
Ed Tanous14766872022-03-15 10:44:42 -0700269
Ed Tanous002d39b2022-05-31 08:59:27 -0700270 asyncResp->res.jsonValue["Parameters"] = std::move(parameters);
271 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -0700272}
AppaRao Puli1cb1a9e2020-07-17 23:38:57 +0530273
James Feist5b4aa862018-08-16 14:07:01 -0700274static constexpr const char* objectManagerIface =
275 "org.freedesktop.DBus.ObjectManager";
276static constexpr const char* pidConfigurationIface =
277 "xyz.openbmc_project.Configuration.Pid";
278static constexpr const char* pidZoneConfigurationIface =
279 "xyz.openbmc_project.Configuration.Pid.Zone";
James Feistb7a08d02018-12-11 14:55:37 -0800280static constexpr const char* stepwiseConfigurationIface =
281 "xyz.openbmc_project.Configuration.Stepwise";
James Feist73df0db2019-03-25 15:29:35 -0700282static constexpr const char* thermalModeIface =
283 "xyz.openbmc_project.Control.ThermalMode";
Borawski.Lukasz9c3106852018-02-09 15:24:22 +0100284
zhanghch058d1b46d2021-04-01 11:18:24 +0800285inline void
286 asyncPopulatePid(const std::string& connection, const std::string& path,
287 const std::string& currentProfile,
288 const std::vector<std::string>& supportedProfiles,
289 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
James Feist5b4aa862018-08-16 14:07:01 -0700290{
291
292 crow::connections::systemBus->async_method_call(
James Feist73df0db2019-03-25 15:29:35 -0700293 [asyncResp, currentProfile, supportedProfiles](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800294 const boost::system::error_code& ec,
James Feist73df0db2019-03-25 15:29:35 -0700295 const dbus::utility::ManagedObjectType& managedObj) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700296 if (ec)
297 {
298 BMCWEB_LOG_ERROR << ec;
299 asyncResp->res.jsonValue.clear();
300 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
Willy Tueddfc432022-09-26 16:46:38 +0000397 boost::urls::url url = crow::utility::urlFromPieces(
398 "redfish", "v1", "Managers", "bmc");
Ed Tanous002d39b2022-05-31 08:59:27 -0700399 if (intfPair.first == pidZoneConfigurationIface)
400 {
401 std::string chassis;
402 if (!dbus::utility::getNthStringFromPath(pathPair.first.str,
403 5, chassis))
404 {
405 chassis = "#IllegalValue";
406 }
407 nlohmann::json& zone = zones[name];
Willy Tueddfc432022-09-26 16:46:38 +0000408 zone["Chassis"]["@odata.id"] = crow::utility::urlFromPieces(
409 "redfish", "v1", "Chassis", chassis);
410 url.set_fragment(
411 ("/Oem/OpenBmc/Fan/FanZones"_json_pointer / name)
412 .to_string());
413 zone["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700414 zone["@odata.type"] = "#OemManager.FanZone";
415 config = &zone;
416 }
417
418 else if (intfPair.first == stepwiseConfigurationIface)
419 {
420 if (classPtr == nullptr)
421 {
422 BMCWEB_LOG_ERROR << "Pid Class Field illegal";
James Feistb7a08d02018-12-11 14:55:37 -0800423 messages::internalError(asyncResp->res);
424 return;
425 }
426
Ed Tanous002d39b2022-05-31 08:59:27 -0700427 nlohmann::json& controller = stepwise[name];
428 config = &controller;
Willy Tueddfc432022-09-26 16:46:38 +0000429 url.set_fragment(
430 ("/Oem/OpenBmc/Fan/StepwiseControllers"_json_pointer /
431 name)
432 .to_string());
433 controller["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700434 controller["@odata.type"] =
435 "#OemManager.StepwiseController";
436
437 controller["Direction"] = *classPtr;
438 }
439
440 // pid and fans are off the same configuration
441 else if (intfPair.first == pidConfigurationIface)
442 {
443
444 if (classPtr == nullptr)
James Feist5b4aa862018-08-16 14:07:01 -0700445 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700446 BMCWEB_LOG_ERROR << "Pid Class Field illegal";
447 messages::internalError(asyncResp->res);
448 return;
449 }
450 bool isFan = *classPtr == "fan";
451 nlohmann::json& element = isFan ? fans[name] : pids[name];
452 config = &element;
453 if (isFan)
454 {
Willy Tueddfc432022-09-26 16:46:38 +0000455 url.set_fragment(
456 ("/Oem/OpenBmc/Fan/FanControllers"_json_pointer /
457 name)
458 .to_string());
459 element["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700460 element["@odata.type"] = "#OemManager.FanController";
461 }
462 else
463 {
Willy Tueddfc432022-09-26 16:46:38 +0000464 url.set_fragment(
465 ("/Oem/OpenBmc/Fan/PidControllers"_json_pointer /
466 name)
467 .to_string());
468 element["@odata.id"] = std::move(url);
Ed Tanous002d39b2022-05-31 08:59:27 -0700469 element["@odata.type"] = "#OemManager.PidController";
470 }
471 }
472 else
473 {
474 BMCWEB_LOG_ERROR << "Unexpected configuration";
475 messages::internalError(asyncResp->res);
476 return;
477 }
James Feist5b4aa862018-08-16 14:07:01 -0700478
Ed Tanous002d39b2022-05-31 08:59:27 -0700479 // used for making maps out of 2 vectors
480 const std::vector<double>* keys = nullptr;
481 const std::vector<double>* values = nullptr;
482
483 for (const auto& propertyPair : intfPair.second)
484 {
485 if (propertyPair.first == "Type" ||
486 propertyPair.first == "Class" ||
487 propertyPair.first == "Name")
488 {
489 continue;
490 }
491
492 // zones
493 if (intfPair.first == pidZoneConfigurationIface)
494 {
495 const double* ptr =
496 std::get_if<double>(&propertyPair.second);
497 if (ptr == nullptr)
498 {
499 BMCWEB_LOG_ERROR << "Field Illegal "
500 << propertyPair.first;
501 messages::internalError(asyncResp->res);
502 return;
503 }
504 (*config)[propertyPair.first] = *ptr;
505 }
506
507 if (intfPair.first == stepwiseConfigurationIface)
508 {
509 if (propertyPair.first == "Reading" ||
510 propertyPair.first == "Output")
511 {
512 const std::vector<double>* ptr =
513 std::get_if<std::vector<double>>(
514 &propertyPair.second);
515
516 if (ptr == nullptr)
517 {
518 BMCWEB_LOG_ERROR << "Field Illegal "
519 << propertyPair.first;
520 messages::internalError(asyncResp->res);
521 return;
522 }
523
524 if (propertyPair.first == "Reading")
525 {
526 keys = ptr;
527 }
528 else
529 {
530 values = ptr;
531 }
532 if (keys != nullptr && values != nullptr)
533 {
534 if (keys->size() != values->size())
535 {
536 BMCWEB_LOG_ERROR
537 << "Reading and Output size don't match ";
538 messages::internalError(asyncResp->res);
539 return;
540 }
541 nlohmann::json& steps = (*config)["Steps"];
542 steps = nlohmann::json::array();
543 for (size_t ii = 0; ii < keys->size(); ii++)
544 {
545 nlohmann::json::object_t step;
546 step["Target"] = (*keys)[ii];
547 step["Output"] = (*values)[ii];
548 steps.push_back(std::move(step));
549 }
550 }
551 }
552 if (propertyPair.first == "NegativeHysteresis" ||
553 propertyPair.first == "PositiveHysteresis")
James Feist5b4aa862018-08-16 14:07:01 -0700554 {
Ed Tanous1b6b96c2018-11-30 11:35:41 -0800555 const double* ptr =
Ed Tanousabf2add2019-01-22 16:40:12 -0800556 std::get_if<double>(&propertyPair.second);
James Feist5b4aa862018-08-16 14:07:01 -0700557 if (ptr == nullptr)
558 {
559 BMCWEB_LOG_ERROR << "Field Illegal "
560 << propertyPair.first;
Jason M. Billsf12894f2018-10-09 12:45:45 -0700561 messages::internalError(asyncResp->res);
James Feist5b4aa862018-08-16 14:07:01 -0700562 return;
563 }
James Feistb7a08d02018-12-11 14:55:37 -0800564 (*config)[propertyPair.first] = *ptr;
565 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700566 }
James Feistb7a08d02018-12-11 14:55:37 -0800567
Ed Tanous002d39b2022-05-31 08:59:27 -0700568 // pid and fans are off the same configuration
569 if (intfPair.first == pidConfigurationIface ||
570 intfPair.first == stepwiseConfigurationIface)
571 {
572
573 if (propertyPair.first == "Zones")
James Feistb7a08d02018-12-11 14:55:37 -0800574 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700575 const std::vector<std::string>* inputs =
576 std::get_if<std::vector<std::string>>(
577 &propertyPair.second);
578
579 if (inputs == nullptr)
James Feistb7a08d02018-12-11 14:55:37 -0800580 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700581 BMCWEB_LOG_ERROR << "Zones Pid Field Illegal";
582 messages::internalError(asyncResp->res);
583 return;
James Feistb7a08d02018-12-11 14:55:37 -0800584 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700585 auto& data = (*config)[propertyPair.first];
586 data = nlohmann::json::array();
587 for (std::string itemCopy : *inputs)
James Feistb7a08d02018-12-11 14:55:37 -0800588 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700589 dbus::utility::escapePathForDbus(itemCopy);
590 nlohmann::json::object_t input;
Willy Tueddfc432022-09-26 16:46:38 +0000591 boost::urls::url managerUrl =
592 crow::utility::urlFromPieces(
593 "redfish", "v1", "Managers", "bmc");
594 managerUrl.set_fragment(
595 ("/Oem/OpenBmc/Fan/FanZones"_json_pointer /
596 itemCopy)
597 .to_string());
598 input["@odata.id"] = std::move(managerUrl);
Ed Tanous002d39b2022-05-31 08:59:27 -0700599 data.push_back(std::move(input));
James Feistb7a08d02018-12-11 14:55:37 -0800600 }
James Feist5b4aa862018-08-16 14:07:01 -0700601 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700602 // todo(james): may never happen, but this
603 // assumes configuration data referenced in the
604 // PID config is provided by the same daemon, we
605 // could add another loop to cover all cases,
606 // but I'm okay kicking this can down the road a
607 // bit
James Feist5b4aa862018-08-16 14:07:01 -0700608
Ed Tanous002d39b2022-05-31 08:59:27 -0700609 else if (propertyPair.first == "Inputs" ||
610 propertyPair.first == "Outputs")
James Feist5b4aa862018-08-16 14:07:01 -0700611 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700612 auto& data = (*config)[propertyPair.first];
613 const std::vector<std::string>* inputs =
614 std::get_if<std::vector<std::string>>(
615 &propertyPair.second);
James Feist5b4aa862018-08-16 14:07:01 -0700616
Ed Tanous002d39b2022-05-31 08:59:27 -0700617 if (inputs == nullptr)
James Feist5b4aa862018-08-16 14:07:01 -0700618 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700619 BMCWEB_LOG_ERROR << "Field Illegal "
620 << propertyPair.first;
621 messages::internalError(asyncResp->res);
622 return;
James Feist5b4aa862018-08-16 14:07:01 -0700623 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700624 data = *inputs;
625 }
626 else if (propertyPair.first == "SetPointOffset")
627 {
628 const std::string* ptr =
629 std::get_if<std::string>(&propertyPair.second);
James Feist5b4aa862018-08-16 14:07:01 -0700630
Ed Tanous002d39b2022-05-31 08:59:27 -0700631 if (ptr == nullptr)
James Feist5b4aa862018-08-16 14:07:01 -0700632 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700633 BMCWEB_LOG_ERROR << "Field Illegal "
634 << propertyPair.first;
635 messages::internalError(asyncResp->res);
636 return;
James Feistb943aae2019-07-11 16:33:56 -0700637 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700638 // translate from dbus to redfish
639 if (*ptr == "WarningHigh")
James Feistb943aae2019-07-11 16:33:56 -0700640 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700641 (*config)["SetPointOffset"] =
642 "UpperThresholdNonCritical";
James Feistb943aae2019-07-11 16:33:56 -0700643 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700644 else if (*ptr == "WarningLow")
James Feist5b4aa862018-08-16 14:07:01 -0700645 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700646 (*config)["SetPointOffset"] =
647 "LowerThresholdNonCritical";
James Feist5b4aa862018-08-16 14:07:01 -0700648 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700649 else if (*ptr == "CriticalHigh")
650 {
651 (*config)["SetPointOffset"] =
652 "UpperThresholdCritical";
653 }
654 else if (*ptr == "CriticalLow")
655 {
656 (*config)["SetPointOffset"] =
657 "LowerThresholdCritical";
658 }
659 else
660 {
661 BMCWEB_LOG_ERROR << "Value Illegal " << *ptr;
662 messages::internalError(asyncResp->res);
663 return;
664 }
665 }
666 // doubles
667 else if (propertyPair.first == "FFGainCoefficient" ||
668 propertyPair.first == "FFOffCoefficient" ||
669 propertyPair.first == "ICoefficient" ||
670 propertyPair.first == "ILimitMax" ||
671 propertyPair.first == "ILimitMin" ||
672 propertyPair.first == "PositiveHysteresis" ||
673 propertyPair.first == "NegativeHysteresis" ||
674 propertyPair.first == "OutLimitMax" ||
675 propertyPair.first == "OutLimitMin" ||
676 propertyPair.first == "PCoefficient" ||
677 propertyPair.first == "SetPoint" ||
678 propertyPair.first == "SlewNeg" ||
679 propertyPair.first == "SlewPos")
680 {
681 const double* ptr =
682 std::get_if<double>(&propertyPair.second);
683 if (ptr == nullptr)
684 {
685 BMCWEB_LOG_ERROR << "Field Illegal "
686 << propertyPair.first;
687 messages::internalError(asyncResp->res);
688 return;
689 }
690 (*config)[propertyPair.first] = *ptr;
James Feist5b4aa862018-08-16 14:07:01 -0700691 }
692 }
693 }
694 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700695 }
James Feist5b4aa862018-08-16 14:07:01 -0700696 },
697 connection, path, objectManagerIface, "GetManagedObjects");
698}
Jennifer Leeca537922018-08-10 10:07:30 -0700699
James Feist83ff9ab2018-08-31 10:18:24 -0700700enum class CreatePIDRet
701{
702 fail,
703 del,
704 patch
705};
706
zhanghch058d1b46d2021-04-01 11:18:24 +0800707inline bool
708 getZonesFromJsonReq(const std::shared_ptr<bmcweb::AsyncResp>& response,
709 std::vector<nlohmann::json>& config,
710 std::vector<std::string>& zones)
James Feist5f2caae2018-12-12 14:08:25 -0800711{
James Feistb6baeaa2019-02-21 10:41:40 -0800712 if (config.empty())
713 {
714 BMCWEB_LOG_ERROR << "Empty Zones";
Ed Tanous1668ce62022-02-07 23:44:31 -0800715 messages::propertyValueFormatError(response->res, "[]", "Zones");
James Feistb6baeaa2019-02-21 10:41:40 -0800716 return false;
717 }
James Feist5f2caae2018-12-12 14:08:25 -0800718 for (auto& odata : config)
719 {
720 std::string path;
721 if (!redfish::json_util::readJson(odata, response->res, "@odata.id",
722 path))
723 {
724 return false;
725 }
726 std::string input;
James Feist61adbda2019-03-25 13:03:51 -0700727
728 // 8 below comes from
729 // /redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanZones/Left
730 // 0 1 2 3 4 5 6 7 8
731 if (!dbus::utility::getNthStringFromPath(path, 8, input))
James Feist5f2caae2018-12-12 14:08:25 -0800732 {
733 BMCWEB_LOG_ERROR << "Got invalid path " << path;
734 BMCWEB_LOG_ERROR << "Illegal Type Zones";
735 messages::propertyValueFormatError(response->res, odata.dump(),
736 "Zones");
737 return false;
738 }
Ed Tanousa170f272022-06-30 21:53:27 -0700739 std::replace(input.begin(), input.end(), '_', ' ');
James Feist5f2caae2018-12-12 14:08:25 -0800740 zones.emplace_back(std::move(input));
741 }
742 return true;
743}
744
Ed Tanous711ac7a2021-12-20 09:34:41 -0800745inline const dbus::utility::ManagedObjectType::value_type*
James Feist73df0db2019-03-25 15:29:35 -0700746 findChassis(const dbus::utility::ManagedObjectType& managedObj,
747 const std::string& value, std::string& chassis)
James Feistb6baeaa2019-02-21 10:41:40 -0800748{
749 BMCWEB_LOG_DEBUG << "Find Chassis: " << value << "\n";
750
Ed Tanousa170f272022-06-30 21:53:27 -0700751 std::string escaped = value;
752 std::replace(escaped.begin(), escaped.end(), '_', ' ');
James Feistb6baeaa2019-02-21 10:41:40 -0800753 escaped = "/" + escaped;
Ed Tanous002d39b2022-05-31 08:59:27 -0700754 auto it = std::find_if(managedObj.begin(), managedObj.end(),
755 [&escaped](const auto& obj) {
756 if (boost::algorithm::ends_with(obj.first.str, escaped))
757 {
758 BMCWEB_LOG_DEBUG << "Matched " << obj.first.str << "\n";
759 return true;
760 }
761 return false;
762 });
James Feistb6baeaa2019-02-21 10:41:40 -0800763
764 if (it == managedObj.end())
765 {
James Feist73df0db2019-03-25 15:29:35 -0700766 return nullptr;
James Feistb6baeaa2019-02-21 10:41:40 -0800767 }
768 // 5 comes from <chassis-name> being the 5th element
769 // /xyz/openbmc_project/inventory/system/chassis/<chassis-name>
James Feist73df0db2019-03-25 15:29:35 -0700770 if (dbus::utility::getNthStringFromPath(it->first.str, 5, chassis))
771 {
772 return &(*it);
773 }
774
775 return nullptr;
James Feistb6baeaa2019-02-21 10:41:40 -0800776}
777
Ed Tanous23a21a12020-07-25 04:45:05 +0000778inline CreatePIDRet createPidInterface(
zhanghch058d1b46d2021-04-01 11:18:24 +0800779 const std::shared_ptr<bmcweb::AsyncResp>& response, const std::string& type,
Ed Tanousb5a76932020-09-29 16:16:58 -0700780 const nlohmann::json::iterator& it, const std::string& path,
James Feist83ff9ab2018-08-31 10:18:24 -0700781 const dbus::utility::ManagedObjectType& managedObj, bool createNewObject,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800782 dbus::utility::DBusPropertiesMap& output, std::string& chassis,
783 const std::string& profile)
James Feist83ff9ab2018-08-31 10:18:24 -0700784{
785
James Feist5f2caae2018-12-12 14:08:25 -0800786 // common deleter
James Feistb6baeaa2019-02-21 10:41:40 -0800787 if (it.value() == nullptr)
James Feist5f2caae2018-12-12 14:08:25 -0800788 {
789 std::string iface;
790 if (type == "PidControllers" || type == "FanControllers")
791 {
792 iface = pidConfigurationIface;
793 }
794 else if (type == "FanZones")
795 {
796 iface = pidZoneConfigurationIface;
797 }
798 else if (type == "StepwiseControllers")
799 {
800 iface = stepwiseConfigurationIface;
801 }
802 else
803 {
Gunnar Millsa0744d32020-11-09 15:40:45 -0600804 BMCWEB_LOG_ERROR << "Illegal Type " << type;
James Feist5f2caae2018-12-12 14:08:25 -0800805 messages::propertyUnknown(response->res, type);
806 return CreatePIDRet::fail;
807 }
James Feist6ee7f772020-02-06 16:25:27 -0800808
809 BMCWEB_LOG_DEBUG << "del " << path << " " << iface << "\n";
James Feist5f2caae2018-12-12 14:08:25 -0800810 // delete interface
811 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800812 [response, path](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700813 if (ec)
814 {
815 BMCWEB_LOG_ERROR << "Error patching " << path << ": " << ec;
816 messages::internalError(response->res);
817 return;
818 }
819 messages::success(response->res);
James Feist5f2caae2018-12-12 14:08:25 -0800820 },
821 "xyz.openbmc_project.EntityManager", path, iface, "Delete");
822 return CreatePIDRet::del;
823 }
824
Ed Tanous711ac7a2021-12-20 09:34:41 -0800825 const dbus::utility::ManagedObjectType::value_type* managedItem = nullptr;
James Feistb6baeaa2019-02-21 10:41:40 -0800826 if (!createNewObject)
827 {
828 // if we aren't creating a new object, we should be able to find it on
829 // d-bus
James Feist73df0db2019-03-25 15:29:35 -0700830 managedItem = findChassis(managedObj, it.key(), chassis);
831 if (managedItem == nullptr)
James Feistb6baeaa2019-02-21 10:41:40 -0800832 {
833 BMCWEB_LOG_ERROR << "Failed to get chassis from config patch";
Ed Tanousace85d62021-10-26 12:45:59 -0700834 messages::invalidObject(response->res,
835 crow::utility::urlFromPieces(
836 "redfish", "v1", "Chassis", chassis));
James Feistb6baeaa2019-02-21 10:41:40 -0800837 return CreatePIDRet::fail;
838 }
839 }
840
Ed Tanous26f69762022-01-25 09:49:11 -0800841 if (!profile.empty() &&
James Feist73df0db2019-03-25 15:29:35 -0700842 (type == "PidControllers" || type == "FanControllers" ||
843 type == "StepwiseControllers"))
844 {
845 if (managedItem == nullptr)
846 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800847 output.emplace_back("Profiles", std::vector<std::string>{profile});
James Feist73df0db2019-03-25 15:29:35 -0700848 }
849 else
850 {
851 std::string interface;
852 if (type == "StepwiseControllers")
853 {
854 interface = stepwiseConfigurationIface;
855 }
856 else
857 {
858 interface = pidConfigurationIface;
859 }
Ed Tanous711ac7a2021-12-20 09:34:41 -0800860 bool ifaceFound = false;
861 for (const auto& iface : managedItem->second)
862 {
863 if (iface.first == interface)
864 {
865 ifaceFound = true;
866 for (const auto& prop : iface.second)
867 {
868 if (prop.first == "Profiles")
869 {
870 const std::vector<std::string>* curProfiles =
871 std::get_if<std::vector<std::string>>(
872 &(prop.second));
873 if (curProfiles == nullptr)
874 {
875 BMCWEB_LOG_ERROR
876 << "Illegal profiles in managed object";
877 messages::internalError(response->res);
878 return CreatePIDRet::fail;
879 }
880 if (std::find(curProfiles->begin(),
881 curProfiles->end(),
882 profile) == curProfiles->end())
883 {
884 std::vector<std::string> newProfiles =
885 *curProfiles;
886 newProfiles.push_back(profile);
Ed Tanousb9d36b42022-02-26 21:42:46 -0800887 output.emplace_back("Profiles", newProfiles);
Ed Tanous711ac7a2021-12-20 09:34:41 -0800888 }
889 }
890 }
891 }
892 }
893
894 if (!ifaceFound)
James Feist73df0db2019-03-25 15:29:35 -0700895 {
896 BMCWEB_LOG_ERROR
897 << "Failed to find interface in managed object";
898 messages::internalError(response->res);
899 return CreatePIDRet::fail;
900 }
James Feist73df0db2019-03-25 15:29:35 -0700901 }
902 }
903
James Feist83ff9ab2018-08-31 10:18:24 -0700904 if (type == "PidControllers" || type == "FanControllers")
905 {
906 if (createNewObject)
907 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800908 output.emplace_back("Class",
909 type == "PidControllers" ? "temp" : "fan");
910 output.emplace_back("Type", "Pid");
James Feist83ff9ab2018-08-31 10:18:24 -0700911 }
James Feist5f2caae2018-12-12 14:08:25 -0800912
913 std::optional<std::vector<nlohmann::json>> zones;
914 std::optional<std::vector<std::string>> inputs;
915 std::optional<std::vector<std::string>> outputs;
916 std::map<std::string, std::optional<double>> doubles;
James Feistb943aae2019-07-11 16:33:56 -0700917 std::optional<std::string> setpointOffset;
James Feist5f2caae2018-12-12 14:08:25 -0800918 if (!redfish::json_util::readJson(
James Feistb6baeaa2019-02-21 10:41:40 -0800919 it.value(), response->res, "Inputs", inputs, "Outputs", outputs,
James Feist5f2caae2018-12-12 14:08:25 -0800920 "Zones", zones, "FFGainCoefficient",
921 doubles["FFGainCoefficient"], "FFOffCoefficient",
922 doubles["FFOffCoefficient"], "ICoefficient",
923 doubles["ICoefficient"], "ILimitMax", doubles["ILimitMax"],
924 "ILimitMin", doubles["ILimitMin"], "OutLimitMax",
925 doubles["OutLimitMax"], "OutLimitMin", doubles["OutLimitMin"],
926 "PCoefficient", doubles["PCoefficient"], "SetPoint",
James Feistb943aae2019-07-11 16:33:56 -0700927 doubles["SetPoint"], "SetPointOffset", setpointOffset,
928 "SlewNeg", doubles["SlewNeg"], "SlewPos", doubles["SlewPos"],
929 "PositiveHysteresis", doubles["PositiveHysteresis"],
930 "NegativeHysteresis", doubles["NegativeHysteresis"]))
James Feist83ff9ab2018-08-31 10:18:24 -0700931 {
Ed Tanous71f52d92021-02-19 08:51:17 -0800932 BMCWEB_LOG_ERROR
933 << "Illegal Property "
934 << it.value().dump(2, ' ', true,
935 nlohmann::json::error_handler_t::replace);
James Feist5f2caae2018-12-12 14:08:25 -0800936 return CreatePIDRet::fail;
James Feist83ff9ab2018-08-31 10:18:24 -0700937 }
James Feist5f2caae2018-12-12 14:08:25 -0800938 if (zones)
James Feist83ff9ab2018-08-31 10:18:24 -0700939 {
James Feist5f2caae2018-12-12 14:08:25 -0800940 std::vector<std::string> zonesStr;
941 if (!getZonesFromJsonReq(response, *zones, zonesStr))
James Feist83ff9ab2018-08-31 10:18:24 -0700942 {
Gunnar Millsa0744d32020-11-09 15:40:45 -0600943 BMCWEB_LOG_ERROR << "Illegal Zones";
James Feist5f2caae2018-12-12 14:08:25 -0800944 return CreatePIDRet::fail;
James Feist83ff9ab2018-08-31 10:18:24 -0700945 }
James Feistb6baeaa2019-02-21 10:41:40 -0800946 if (chassis.empty() &&
Ed Tanouse662eae2022-01-25 10:39:19 -0800947 findChassis(managedObj, zonesStr[0], chassis) == nullptr)
James Feistb6baeaa2019-02-21 10:41:40 -0800948 {
949 BMCWEB_LOG_ERROR << "Failed to get chassis from config patch";
Ed Tanousace85d62021-10-26 12:45:59 -0700950 messages::invalidObject(
951 response->res, crow::utility::urlFromPieces(
952 "redfish", "v1", "Chassis", chassis));
James Feistb6baeaa2019-02-21 10:41:40 -0800953 return CreatePIDRet::fail;
954 }
Ed Tanousb9d36b42022-02-26 21:42:46 -0800955 output.emplace_back("Zones", std::move(zonesStr));
James Feist5f2caae2018-12-12 14:08:25 -0800956 }
Ed Tanousafb9ee02022-12-21 11:59:17 -0800957
958 if (inputs)
James Feist5f2caae2018-12-12 14:08:25 -0800959 {
Ed Tanousafb9ee02022-12-21 11:59:17 -0800960 for (std::string& value : *inputs)
James Feist83ff9ab2018-08-31 10:18:24 -0700961 {
Ed Tanousafb9ee02022-12-21 11:59:17 -0800962 std::replace(value.begin(), value.end(), '_', ' ');
James Feist83ff9ab2018-08-31 10:18:24 -0700963 }
Ed Tanousafb9ee02022-12-21 11:59:17 -0800964 output.emplace_back("Inputs", *inputs);
965 }
966
967 if (outputs)
968 {
969 for (std::string& value : *outputs)
970 {
971 std::replace(value.begin(), value.end(), '_', ' ');
972 }
973 output.emplace_back("Outputs", *outputs);
James Feist5f2caae2018-12-12 14:08:25 -0800974 }
James Feist83ff9ab2018-08-31 10:18:24 -0700975
James Feistb943aae2019-07-11 16:33:56 -0700976 if (setpointOffset)
977 {
978 // translate between redfish and dbus names
979 if (*setpointOffset == "UpperThresholdNonCritical")
980 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800981 output.emplace_back("SetPointOffset", "WarningLow");
James Feistb943aae2019-07-11 16:33:56 -0700982 }
983 else if (*setpointOffset == "LowerThresholdNonCritical")
984 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800985 output.emplace_back("SetPointOffset", "WarningHigh");
James Feistb943aae2019-07-11 16:33:56 -0700986 }
987 else if (*setpointOffset == "LowerThresholdCritical")
988 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800989 output.emplace_back("SetPointOffset", "CriticalLow");
James Feistb943aae2019-07-11 16:33:56 -0700990 }
991 else if (*setpointOffset == "UpperThresholdCritical")
992 {
Ed Tanousb9d36b42022-02-26 21:42:46 -0800993 output.emplace_back("SetPointOffset", "CriticalHigh");
James Feistb943aae2019-07-11 16:33:56 -0700994 }
995 else
996 {
997 BMCWEB_LOG_ERROR << "Invalid setpointoffset "
998 << *setpointOffset;
Ed Tanousace85d62021-10-26 12:45:59 -0700999 messages::propertyValueNotInList(response->res, it.key(),
1000 "SetPointOffset");
James Feistb943aae2019-07-11 16:33:56 -07001001 return CreatePIDRet::fail;
1002 }
1003 }
1004
James Feist5f2caae2018-12-12 14:08:25 -08001005 // doubles
1006 for (const auto& pairs : doubles)
1007 {
1008 if (!pairs.second)
James Feist83ff9ab2018-08-31 10:18:24 -07001009 {
James Feist5f2caae2018-12-12 14:08:25 -08001010 continue;
James Feist83ff9ab2018-08-31 10:18:24 -07001011 }
James Feist5f2caae2018-12-12 14:08:25 -08001012 BMCWEB_LOG_DEBUG << pairs.first << " = " << *pairs.second;
Ed Tanousb9d36b42022-02-26 21:42:46 -08001013 output.emplace_back(pairs.first, *pairs.second);
James Feist83ff9ab2018-08-31 10:18:24 -07001014 }
1015 }
James Feist5f2caae2018-12-12 14:08:25 -08001016
James Feist83ff9ab2018-08-31 10:18:24 -07001017 else if (type == "FanZones")
1018 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001019 output.emplace_back("Type", "Pid.Zone");
James Feist83ff9ab2018-08-31 10:18:24 -07001020
James Feist5f2caae2018-12-12 14:08:25 -08001021 std::optional<nlohmann::json> chassisContainer;
1022 std::optional<double> failSafePercent;
James Feistd3ec07f2019-02-25 14:51:15 -08001023 std::optional<double> minThermalOutput;
James Feistb6baeaa2019-02-21 10:41:40 -08001024 if (!redfish::json_util::readJson(it.value(), response->res, "Chassis",
James Feist5f2caae2018-12-12 14:08:25 -08001025 chassisContainer, "FailSafePercent",
James Feistd3ec07f2019-02-25 14:51:15 -08001026 failSafePercent, "MinThermalOutput",
1027 minThermalOutput))
James Feist83ff9ab2018-08-31 10:18:24 -07001028 {
Ed Tanous71f52d92021-02-19 08:51:17 -08001029 BMCWEB_LOG_ERROR
1030 << "Illegal Property "
1031 << it.value().dump(2, ' ', true,
1032 nlohmann::json::error_handler_t::replace);
James Feist5f2caae2018-12-12 14:08:25 -08001033 return CreatePIDRet::fail;
1034 }
James Feist83ff9ab2018-08-31 10:18:24 -07001035
James Feist5f2caae2018-12-12 14:08:25 -08001036 if (chassisContainer)
1037 {
1038
1039 std::string chassisId;
1040 if (!redfish::json_util::readJson(*chassisContainer, response->res,
1041 "@odata.id", chassisId))
James Feist83ff9ab2018-08-31 10:18:24 -07001042 {
Ed Tanous71f52d92021-02-19 08:51:17 -08001043 BMCWEB_LOG_ERROR
1044 << "Illegal Property "
1045 << chassisContainer->dump(
1046 2, ' ', true,
1047 nlohmann::json::error_handler_t::replace);
James Feist83ff9ab2018-08-31 10:18:24 -07001048 return CreatePIDRet::fail;
1049 }
James Feist5f2caae2018-12-12 14:08:25 -08001050
AppaRao Puli717794d2019-10-18 22:54:53 +05301051 // /redfish/v1/chassis/chassis_name/
James Feist5f2caae2018-12-12 14:08:25 -08001052 if (!dbus::utility::getNthStringFromPath(chassisId, 3, chassis))
1053 {
1054 BMCWEB_LOG_ERROR << "Got invalid path " << chassisId;
Ed Tanousace85d62021-10-26 12:45:59 -07001055 messages::invalidObject(
1056 response->res, crow::utility::urlFromPieces(
1057 "redfish", "v1", "Chassis", chassisId));
James Feist5f2caae2018-12-12 14:08:25 -08001058 return CreatePIDRet::fail;
1059 }
1060 }
James Feistd3ec07f2019-02-25 14:51:15 -08001061 if (minThermalOutput)
James Feist5f2caae2018-12-12 14:08:25 -08001062 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001063 output.emplace_back("MinThermalOutput", *minThermalOutput);
James Feist5f2caae2018-12-12 14:08:25 -08001064 }
1065 if (failSafePercent)
1066 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001067 output.emplace_back("FailSafePercent", *failSafePercent);
James Feist5f2caae2018-12-12 14:08:25 -08001068 }
1069 }
1070 else if (type == "StepwiseControllers")
1071 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001072 output.emplace_back("Type", "Stepwise");
James Feist5f2caae2018-12-12 14:08:25 -08001073
1074 std::optional<std::vector<nlohmann::json>> zones;
1075 std::optional<std::vector<nlohmann::json>> steps;
1076 std::optional<std::vector<std::string>> inputs;
1077 std::optional<double> positiveHysteresis;
1078 std::optional<double> negativeHysteresis;
James Feistc33a90e2019-03-01 10:17:44 -08001079 std::optional<std::string> direction; // upper clipping curve vs lower
James Feist5f2caae2018-12-12 14:08:25 -08001080 if (!redfish::json_util::readJson(
James Feistb6baeaa2019-02-21 10:41:40 -08001081 it.value(), response->res, "Zones", zones, "Steps", steps,
1082 "Inputs", inputs, "PositiveHysteresis", positiveHysteresis,
James Feistc33a90e2019-03-01 10:17:44 -08001083 "NegativeHysteresis", negativeHysteresis, "Direction",
1084 direction))
James Feist5f2caae2018-12-12 14:08:25 -08001085 {
Ed Tanous71f52d92021-02-19 08:51:17 -08001086 BMCWEB_LOG_ERROR
1087 << "Illegal Property "
1088 << it.value().dump(2, ' ', true,
1089 nlohmann::json::error_handler_t::replace);
James Feist5f2caae2018-12-12 14:08:25 -08001090 return CreatePIDRet::fail;
1091 }
1092
1093 if (zones)
1094 {
James Feistb6baeaa2019-02-21 10:41:40 -08001095 std::vector<std::string> zonesStrs;
1096 if (!getZonesFromJsonReq(response, *zones, zonesStrs))
James Feist5f2caae2018-12-12 14:08:25 -08001097 {
Gunnar Millsa0744d32020-11-09 15:40:45 -06001098 BMCWEB_LOG_ERROR << "Illegal Zones";
James Feist5f2caae2018-12-12 14:08:25 -08001099 return CreatePIDRet::fail;
1100 }
James Feistb6baeaa2019-02-21 10:41:40 -08001101 if (chassis.empty() &&
Ed Tanouse662eae2022-01-25 10:39:19 -08001102 findChassis(managedObj, zonesStrs[0], chassis) == nullptr)
James Feistb6baeaa2019-02-21 10:41:40 -08001103 {
1104 BMCWEB_LOG_ERROR << "Failed to get chassis from config patch";
Ed Tanousace85d62021-10-26 12:45:59 -07001105 messages::invalidObject(
1106 response->res, crow::utility::urlFromPieces(
1107 "redfish", "v1", "Chassis", chassis));
James Feistb6baeaa2019-02-21 10:41:40 -08001108 return CreatePIDRet::fail;
1109 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001110 output.emplace_back("Zones", std::move(zonesStrs));
James Feist5f2caae2018-12-12 14:08:25 -08001111 }
1112 if (steps)
1113 {
1114 std::vector<double> readings;
1115 std::vector<double> outputs;
1116 for (auto& step : *steps)
1117 {
Ed Tanous543f4402022-01-06 13:12:53 -08001118 double target = 0.0;
1119 double out = 0.0;
James Feist5f2caae2018-12-12 14:08:25 -08001120
1121 if (!redfish::json_util::readJson(step, response->res, "Target",
Ed Tanous23a21a12020-07-25 04:45:05 +00001122 target, "Output", out))
James Feist5f2caae2018-12-12 14:08:25 -08001123 {
Ed Tanous71f52d92021-02-19 08:51:17 -08001124 BMCWEB_LOG_ERROR
1125 << "Illegal Property "
1126 << it.value().dump(
1127 2, ' ', true,
1128 nlohmann::json::error_handler_t::replace);
James Feist5f2caae2018-12-12 14:08:25 -08001129 return CreatePIDRet::fail;
1130 }
1131 readings.emplace_back(target);
Ed Tanous23a21a12020-07-25 04:45:05 +00001132 outputs.emplace_back(out);
James Feist5f2caae2018-12-12 14:08:25 -08001133 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001134 output.emplace_back("Reading", std::move(readings));
1135 output.emplace_back("Output", std::move(outputs));
James Feist5f2caae2018-12-12 14:08:25 -08001136 }
1137 if (inputs)
1138 {
1139 for (std::string& value : *inputs)
1140 {
Ed Tanousa170f272022-06-30 21:53:27 -07001141
1142 std::replace(value.begin(), value.end(), '_', ' ');
James Feist5f2caae2018-12-12 14:08:25 -08001143 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001144 output.emplace_back("Inputs", std::move(*inputs));
James Feist5f2caae2018-12-12 14:08:25 -08001145 }
1146 if (negativeHysteresis)
1147 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001148 output.emplace_back("NegativeHysteresis", *negativeHysteresis);
James Feist5f2caae2018-12-12 14:08:25 -08001149 }
1150 if (positiveHysteresis)
1151 {
Ed Tanousb9d36b42022-02-26 21:42:46 -08001152 output.emplace_back("PositiveHysteresis", *positiveHysteresis);
James Feist83ff9ab2018-08-31 10:18:24 -07001153 }
James Feistc33a90e2019-03-01 10:17:44 -08001154 if (direction)
1155 {
1156 constexpr const std::array<const char*, 2> allowedDirections = {
1157 "Ceiling", "Floor"};
1158 if (std::find(allowedDirections.begin(), allowedDirections.end(),
1159 *direction) == allowedDirections.end())
1160 {
1161 messages::propertyValueTypeError(response->res, "Direction",
1162 *direction);
1163 return CreatePIDRet::fail;
1164 }
Ed Tanousb9d36b42022-02-26 21:42:46 -08001165 output.emplace_back("Class", *direction);
James Feistc33a90e2019-03-01 10:17:44 -08001166 }
James Feist83ff9ab2018-08-31 10:18:24 -07001167 }
1168 else
1169 {
Gunnar Millsa0744d32020-11-09 15:40:45 -06001170 BMCWEB_LOG_ERROR << "Illegal Type " << type;
Jason M. Bills35a62c72018-10-09 12:45:45 -07001171 messages::propertyUnknown(response->res, type);
James Feist83ff9ab2018-08-31 10:18:24 -07001172 return CreatePIDRet::fail;
1173 }
1174 return CreatePIDRet::patch;
1175}
James Feist73df0db2019-03-25 15:29:35 -07001176struct GetPIDValues : std::enable_shared_from_this<GetPIDValues>
1177{
Ed Tanous6936afe2022-09-08 15:10:39 -07001178 struct CompletionValues
1179 {
1180 std::vector<std::string> supportedProfiles;
1181 std::string currentProfile;
1182 dbus::utility::MapperGetSubTreeResponse subtree;
1183 };
James Feist73df0db2019-03-25 15:29:35 -07001184
Ed Tanous4e23a442022-06-06 09:57:26 -07001185 explicit GetPIDValues(
1186 const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn) :
Ed Tanous23a21a12020-07-25 04:45:05 +00001187 asyncResp(asyncRespIn)
James Feist73df0db2019-03-25 15:29:35 -07001188
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001189 {}
James Feist73df0db2019-03-25 15:29:35 -07001190
1191 void run()
1192 {
1193 std::shared_ptr<GetPIDValues> self = shared_from_this();
1194
1195 // get all configurations
George Liue99073f2022-12-09 11:06:16 +08001196 constexpr std::array<std::string_view, 4> interfaces = {
1197 pidConfigurationIface, pidZoneConfigurationIface,
1198 objectManagerIface, stepwiseConfigurationIface};
1199 dbus::utility::getSubTree(
1200 "/", 0, interfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001201 [self](
George Liue99073f2022-12-09 11:06:16 +08001202 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001203 const dbus::utility::MapperGetSubTreeResponse& subtreeLocal) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001204 if (ec)
1205 {
1206 BMCWEB_LOG_ERROR << ec;
1207 messages::internalError(self->asyncResp->res);
1208 return;
1209 }
Ed Tanous6936afe2022-09-08 15:10:39 -07001210 self->complete.subtree = subtreeLocal;
George Liue99073f2022-12-09 11:06:16 +08001211 });
James Feist73df0db2019-03-25 15:29:35 -07001212
1213 // at the same time get the selected profile
George Liue99073f2022-12-09 11:06:16 +08001214 constexpr std::array<std::string_view, 1> thermalModeIfaces = {
1215 thermalModeIface};
1216 dbus::utility::getSubTree(
1217 "/", 0, thermalModeIfaces,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001218 [self](
George Liue99073f2022-12-09 11:06:16 +08001219 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001220 const dbus::utility::MapperGetSubTreeResponse& subtreeLocal) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001221 if (ec || subtreeLocal.empty())
1222 {
1223 return;
1224 }
1225 if (subtreeLocal[0].second.size() != 1)
1226 {
1227 // invalid mapper response, should never happen
1228 BMCWEB_LOG_ERROR << "GetPIDValues: Mapper Error";
1229 messages::internalError(self->asyncResp->res);
1230 return;
1231 }
1232
1233 const std::string& path = subtreeLocal[0].first;
1234 const std::string& owner = subtreeLocal[0].second[0].first;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001235
1236 sdbusplus::asio::getAllProperties(
1237 *crow::connections::systemBus, owner, path, thermalModeIface,
Ed Tanous002d39b2022-05-31 08:59:27 -07001238 [path, owner,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001239 self](const boost::system::error_code& ec2,
Ed Tanous002d39b2022-05-31 08:59:27 -07001240 const dbus::utility::DBusPropertiesMap& resp) {
1241 if (ec2)
James Feist73df0db2019-03-25 15:29:35 -07001242 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001243 BMCWEB_LOG_ERROR
1244 << "GetPIDValues: Can't get thermalModeIface " << path;
James Feist73df0db2019-03-25 15:29:35 -07001245 messages::internalError(self->asyncResp->res);
1246 return;
1247 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001248
Ed Tanous002d39b2022-05-31 08:59:27 -07001249 const std::string* current = nullptr;
1250 const std::vector<std::string>* supported = nullptr;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001251
1252 const bool success = sdbusplus::unpackPropertiesNoThrow(
1253 dbus_utils::UnpackErrorPrinter(), resp, "Current", current,
1254 "Supported", supported);
1255
1256 if (!success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001257 {
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001258 messages::internalError(self->asyncResp->res);
1259 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07001260 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001261
Ed Tanous002d39b2022-05-31 08:59:27 -07001262 if (current == nullptr || supported == nullptr)
1263 {
1264 BMCWEB_LOG_ERROR
1265 << "GetPIDValues: thermal mode iface invalid " << path;
1266 messages::internalError(self->asyncResp->res);
1267 return;
1268 }
Ed Tanous6936afe2022-09-08 15:10:39 -07001269 self->complete.currentProfile = *current;
1270 self->complete.supportedProfiles = *supported;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001271 });
George Liue99073f2022-12-09 11:06:16 +08001272 });
James Feist73df0db2019-03-25 15:29:35 -07001273 }
1274
Ed Tanous6936afe2022-09-08 15:10:39 -07001275 static void
1276 processingComplete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1277 const CompletionValues& completion)
James Feist73df0db2019-03-25 15:29:35 -07001278 {
1279 if (asyncResp->res.result() != boost::beast::http::status::ok)
1280 {
1281 return;
1282 }
1283 // create map of <connection, path to objMgr>>
Ed Tanous6936afe2022-09-08 15:10:39 -07001284 boost::container::flat_map<
1285 std::string, std::string, std::less<>,
1286 std::vector<std::pair<std::string, std::string>>>
1287 objectMgrPaths;
1288 boost::container::flat_set<std::string, std::less<>,
1289 std::vector<std::string>>
1290 calledConnections;
1291 for (const auto& pathGroup : completion.subtree)
James Feist73df0db2019-03-25 15:29:35 -07001292 {
1293 for (const auto& connectionGroup : pathGroup.second)
1294 {
1295 auto findConnection =
1296 calledConnections.find(connectionGroup.first);
1297 if (findConnection != calledConnections.end())
1298 {
1299 break;
1300 }
1301 for (const std::string& interface : connectionGroup.second)
1302 {
1303 if (interface == objectManagerIface)
1304 {
1305 objectMgrPaths[connectionGroup.first] = pathGroup.first;
1306 }
1307 // this list is alphabetical, so we
1308 // should have found the objMgr by now
1309 if (interface == pidConfigurationIface ||
1310 interface == pidZoneConfigurationIface ||
1311 interface == stepwiseConfigurationIface)
1312 {
1313 auto findObjMgr =
1314 objectMgrPaths.find(connectionGroup.first);
1315 if (findObjMgr == objectMgrPaths.end())
1316 {
1317 BMCWEB_LOG_DEBUG << connectionGroup.first
1318 << "Has no Object Manager";
1319 continue;
1320 }
1321
1322 calledConnections.insert(connectionGroup.first);
1323
1324 asyncPopulatePid(findObjMgr->first, findObjMgr->second,
Ed Tanous6936afe2022-09-08 15:10:39 -07001325 completion.currentProfile,
1326 completion.supportedProfiles,
James Feist73df0db2019-03-25 15:29:35 -07001327 asyncResp);
1328 break;
1329 }
1330 }
1331 }
1332 }
1333 }
1334
Ed Tanous6936afe2022-09-08 15:10:39 -07001335 ~GetPIDValues()
1336 {
1337 boost::asio::post(crow::connections::systemBus->get_io_context(),
1338 std::bind_front(&processingComplete, asyncResp,
1339 std::move(complete)));
1340 }
1341
Ed Tanousecd6a3a2022-01-07 09:18:40 -08001342 GetPIDValues(const GetPIDValues&) = delete;
1343 GetPIDValues(GetPIDValues&&) = delete;
1344 GetPIDValues& operator=(const GetPIDValues&) = delete;
1345 GetPIDValues& operator=(GetPIDValues&&) = delete;
1346
zhanghch058d1b46d2021-04-01 11:18:24 +08001347 std::shared_ptr<bmcweb::AsyncResp> asyncResp;
Ed Tanous6936afe2022-09-08 15:10:39 -07001348 CompletionValues complete;
James Feist73df0db2019-03-25 15:29:35 -07001349};
1350
1351struct SetPIDValues : std::enable_shared_from_this<SetPIDValues>
1352{
1353
zhanghch058d1b46d2021-04-01 11:18:24 +08001354 SetPIDValues(const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn,
James Feist73df0db2019-03-25 15:29:35 -07001355 nlohmann::json& data) :
Ed Tanous271584a2019-07-09 16:24:22 -07001356 asyncResp(asyncRespIn)
James Feist73df0db2019-03-25 15:29:35 -07001357 {
1358
1359 std::optional<nlohmann::json> pidControllers;
1360 std::optional<nlohmann::json> fanControllers;
1361 std::optional<nlohmann::json> fanZones;
1362 std::optional<nlohmann::json> stepwiseControllers;
1363
1364 if (!redfish::json_util::readJson(
1365 data, asyncResp->res, "PidControllers", pidControllers,
1366 "FanControllers", fanControllers, "FanZones", fanZones,
1367 "StepwiseControllers", stepwiseControllers, "Profile", profile))
1368 {
Ed Tanous71f52d92021-02-19 08:51:17 -08001369 BMCWEB_LOG_ERROR
1370 << "Illegal Property "
1371 << data.dump(2, ' ', true,
1372 nlohmann::json::error_handler_t::replace);
James Feist73df0db2019-03-25 15:29:35 -07001373 return;
1374 }
1375 configuration.emplace_back("PidControllers", std::move(pidControllers));
1376 configuration.emplace_back("FanControllers", std::move(fanControllers));
1377 configuration.emplace_back("FanZones", std::move(fanZones));
1378 configuration.emplace_back("StepwiseControllers",
1379 std::move(stepwiseControllers));
1380 }
Ed Tanousecd6a3a2022-01-07 09:18:40 -08001381
1382 SetPIDValues(const SetPIDValues&) = delete;
1383 SetPIDValues(SetPIDValues&&) = delete;
1384 SetPIDValues& operator=(const SetPIDValues&) = delete;
1385 SetPIDValues& operator=(SetPIDValues&&) = delete;
1386
James Feist73df0db2019-03-25 15:29:35 -07001387 void run()
1388 {
1389 if (asyncResp->res.result() != boost::beast::http::status::ok)
1390 {
1391 return;
1392 }
1393
1394 std::shared_ptr<SetPIDValues> self = shared_from_this();
1395
1396 // todo(james): might make sense to do a mapper call here if this
1397 // interface gets more traction
1398 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001399 [self](const boost::system::error_code& ec,
Ed Tanous914e2d52022-01-07 11:38:34 -08001400 const dbus::utility::ManagedObjectType& mObj) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001401 if (ec)
1402 {
1403 BMCWEB_LOG_ERROR << "Error communicating to Entity Manager";
1404 messages::internalError(self->asyncResp->res);
1405 return;
1406 }
1407 const std::array<const char*, 3> configurations = {
1408 pidConfigurationIface, pidZoneConfigurationIface,
1409 stepwiseConfigurationIface};
James Feiste69d9de2020-02-07 12:23:27 -08001410
Ed Tanous002d39b2022-05-31 08:59:27 -07001411 for (const auto& [path, object] : mObj)
1412 {
1413 for (const auto& [interface, _] : object)
James Feiste69d9de2020-02-07 12:23:27 -08001414 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001415 if (std::find(configurations.begin(), configurations.end(),
1416 interface) != configurations.end())
James Feiste69d9de2020-02-07 12:23:27 -08001417 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001418 self->objectCount++;
1419 break;
James Feiste69d9de2020-02-07 12:23:27 -08001420 }
James Feiste69d9de2020-02-07 12:23:27 -08001421 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001422 }
1423 self->managedObj = mObj;
James Feist73df0db2019-03-25 15:29:35 -07001424 },
Nan Zhouc106b672022-09-20 22:35:31 +00001425 "xyz.openbmc_project.EntityManager",
1426 "/xyz/openbmc_project/inventory", objectManagerIface,
James Feist73df0db2019-03-25 15:29:35 -07001427 "GetManagedObjects");
1428
1429 // at the same time get the profile information
George Liue99073f2022-12-09 11:06:16 +08001430 constexpr std::array<std::string_view, 1> thermalModeIfaces = {
1431 thermalModeIface};
1432 dbus::utility::getSubTree(
1433 "/", 0, thermalModeIfaces,
1434 [self](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001435 const dbus::utility::MapperGetSubTreeResponse& subtree) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001436 if (ec || subtree.empty())
1437 {
1438 return;
1439 }
1440 if (subtree[0].second.empty())
1441 {
1442 // invalid mapper response, should never happen
1443 BMCWEB_LOG_ERROR << "SetPIDValues: Mapper Error";
1444 messages::internalError(self->asyncResp->res);
1445 return;
1446 }
1447
1448 const std::string& path = subtree[0].first;
1449 const std::string& owner = subtree[0].second[0].first;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001450 sdbusplus::asio::getAllProperties(
1451 *crow::connections::systemBus, owner, path, thermalModeIface,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001452 [self, path, owner](const boost::system::error_code& ec2,
Ed Tanous002d39b2022-05-31 08:59:27 -07001453 const dbus::utility::DBusPropertiesMap& r) {
1454 if (ec2)
James Feist73df0db2019-03-25 15:29:35 -07001455 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001456 BMCWEB_LOG_ERROR
1457 << "SetPIDValues: Can't get thermalModeIface " << path;
James Feist73df0db2019-03-25 15:29:35 -07001458 messages::internalError(self->asyncResp->res);
1459 return;
1460 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001461 const std::string* current = nullptr;
1462 const std::vector<std::string>* supported = nullptr;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001463
1464 const bool success = sdbusplus::unpackPropertiesNoThrow(
1465 dbus_utils::UnpackErrorPrinter(), r, "Current", current,
1466 "Supported", supported);
1467
1468 if (!success)
Ed Tanous002d39b2022-05-31 08:59:27 -07001469 {
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001470 messages::internalError(self->asyncResp->res);
1471 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07001472 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001473
Ed Tanous002d39b2022-05-31 08:59:27 -07001474 if (current == nullptr || supported == nullptr)
1475 {
1476 BMCWEB_LOG_ERROR
1477 << "SetPIDValues: thermal mode iface invalid " << path;
1478 messages::internalError(self->asyncResp->res);
1479 return;
1480 }
1481 self->currentProfile = *current;
1482 self->supportedProfiles = *supported;
1483 self->profileConnection = owner;
1484 self->profilePath = path;
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02001485 });
George Liue99073f2022-12-09 11:06:16 +08001486 });
James Feist73df0db2019-03-25 15:29:35 -07001487 }
Ed Tanous24b2fe82022-01-06 12:45:54 -08001488 void pidSetDone()
James Feist73df0db2019-03-25 15:29:35 -07001489 {
1490 if (asyncResp->res.result() != boost::beast::http::status::ok)
1491 {
1492 return;
1493 }
zhanghch058d1b46d2021-04-01 11:18:24 +08001494 std::shared_ptr<bmcweb::AsyncResp> response = asyncResp;
James Feist73df0db2019-03-25 15:29:35 -07001495 if (profile)
1496 {
1497 if (std::find(supportedProfiles.begin(), supportedProfiles.end(),
1498 *profile) == supportedProfiles.end())
1499 {
1500 messages::actionParameterUnknown(response->res, "Profile",
1501 *profile);
1502 return;
1503 }
1504 currentProfile = *profile;
1505 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001506 [response](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001507 if (ec)
1508 {
1509 BMCWEB_LOG_ERROR << "Error patching profile" << ec;
1510 messages::internalError(response->res);
1511 }
James Feist73df0db2019-03-25 15:29:35 -07001512 },
1513 profileConnection, profilePath,
1514 "org.freedesktop.DBus.Properties", "Set", thermalModeIface,
Ed Tanous168e20c2021-12-13 14:39:53 -08001515 "Current", dbus::utility::DbusVariantType(*profile));
James Feist73df0db2019-03-25 15:29:35 -07001516 }
1517
1518 for (auto& containerPair : configuration)
1519 {
1520 auto& container = containerPair.second;
1521 if (!container)
1522 {
1523 continue;
1524 }
James Feist6ee7f772020-02-06 16:25:27 -08001525 BMCWEB_LOG_DEBUG << *container;
1526
Ed Tanous02cad962022-06-30 16:50:15 -07001527 const std::string& type = containerPair.first;
James Feist73df0db2019-03-25 15:29:35 -07001528
1529 for (nlohmann::json::iterator it = container->begin();
Manojkiran Eda17a897d2020-09-12 15:31:58 +05301530 it != container->end(); ++it)
James Feist73df0db2019-03-25 15:29:35 -07001531 {
1532 const auto& name = it.key();
James Feist6ee7f772020-02-06 16:25:27 -08001533 BMCWEB_LOG_DEBUG << "looking for " << name;
1534
James Feist73df0db2019-03-25 15:29:35 -07001535 auto pathItr =
1536 std::find_if(managedObj.begin(), managedObj.end(),
1537 [&name](const auto& obj) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001538 return boost::algorithm::ends_with(obj.first.str,
1539 "/" + name);
1540 });
Ed Tanousb9d36b42022-02-26 21:42:46 -08001541 dbus::utility::DBusPropertiesMap output;
James Feist73df0db2019-03-25 15:29:35 -07001542
1543 output.reserve(16); // The pid interface length
1544
1545 // determines if we're patching entity-manager or
1546 // creating a new object
1547 bool createNewObject = (pathItr == managedObj.end());
James Feist6ee7f772020-02-06 16:25:27 -08001548 BMCWEB_LOG_DEBUG << "Found = " << !createNewObject;
1549
James Feist73df0db2019-03-25 15:29:35 -07001550 std::string iface;
Ed Tanousea2b6702022-03-07 16:48:38 -08001551 if (!createNewObject)
James Feist73df0db2019-03-25 15:29:35 -07001552 {
Potin Lai8be2b5b2022-11-22 13:27:16 +08001553 bool findInterface = false;
Ed Tanousea2b6702022-03-07 16:48:38 -08001554 for (const auto& interface : pathItr->second)
James Feist73df0db2019-03-25 15:29:35 -07001555 {
Ed Tanousea2b6702022-03-07 16:48:38 -08001556 if (interface.first == pidConfigurationIface)
1557 {
1558 if (type == "PidControllers" ||
1559 type == "FanControllers")
1560 {
1561 iface = pidConfigurationIface;
Potin Lai8be2b5b2022-11-22 13:27:16 +08001562 findInterface = true;
1563 break;
Ed Tanousea2b6702022-03-07 16:48:38 -08001564 }
1565 }
1566 else if (interface.first == pidZoneConfigurationIface)
1567 {
1568 if (type == "FanZones")
1569 {
1570 iface = pidConfigurationIface;
Potin Lai8be2b5b2022-11-22 13:27:16 +08001571 findInterface = true;
1572 break;
Ed Tanousea2b6702022-03-07 16:48:38 -08001573 }
1574 }
1575 else if (interface.first == stepwiseConfigurationIface)
1576 {
1577 if (type == "StepwiseControllers")
1578 {
1579 iface = stepwiseConfigurationIface;
Potin Lai8be2b5b2022-11-22 13:27:16 +08001580 findInterface = true;
1581 break;
Ed Tanousea2b6702022-03-07 16:48:38 -08001582 }
1583 }
James Feist73df0db2019-03-25 15:29:35 -07001584 }
Potin Lai8be2b5b2022-11-22 13:27:16 +08001585
1586 // create new object if interface not found
1587 if (!findInterface)
1588 {
1589 createNewObject = true;
1590 }
James Feist73df0db2019-03-25 15:29:35 -07001591 }
James Feist6ee7f772020-02-06 16:25:27 -08001592
1593 if (createNewObject && it.value() == nullptr)
1594 {
Gunnar Mills4e0453b2020-07-08 14:00:30 -05001595 // can't delete a non-existent object
Ed Tanous1668ce62022-02-07 23:44:31 -08001596 messages::propertyValueNotInList(response->res,
1597 it.value().dump(), name);
James Feist6ee7f772020-02-06 16:25:27 -08001598 continue;
1599 }
1600
1601 std::string path;
1602 if (pathItr != managedObj.end())
1603 {
1604 path = pathItr->first.str;
1605 }
1606
James Feist73df0db2019-03-25 15:29:35 -07001607 BMCWEB_LOG_DEBUG << "Create new = " << createNewObject << "\n";
James Feiste69d9de2020-02-07 12:23:27 -08001608
1609 // arbitrary limit to avoid attacks
1610 constexpr const size_t controllerLimit = 500;
James Feist14b0b8d2020-02-12 11:52:07 -08001611 if (createNewObject && objectCount >= controllerLimit)
James Feiste69d9de2020-02-07 12:23:27 -08001612 {
1613 messages::resourceExhaustion(response->res, type);
1614 continue;
1615 }
Ed Tanousa170f272022-06-30 21:53:27 -07001616 std::string escaped = name;
1617 std::replace(escaped.begin(), escaped.end(), '_', ' ');
1618 output.emplace_back("Name", escaped);
James Feist73df0db2019-03-25 15:29:35 -07001619
1620 std::string chassis;
1621 CreatePIDRet ret = createPidInterface(
James Feist6ee7f772020-02-06 16:25:27 -08001622 response, type, it, path, managedObj, createNewObject,
1623 output, chassis, currentProfile);
James Feist73df0db2019-03-25 15:29:35 -07001624 if (ret == CreatePIDRet::fail)
1625 {
1626 return;
1627 }
Ed Tanous3174e4d2020-10-07 11:41:22 -07001628 if (ret == CreatePIDRet::del)
James Feist73df0db2019-03-25 15:29:35 -07001629 {
1630 continue;
1631 }
1632
1633 if (!createNewObject)
1634 {
1635 for (const auto& property : output)
1636 {
1637 crow::connections::systemBus->async_method_call(
1638 [response,
1639 propertyName{std::string(property.first)}](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001640 const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001641 if (ec)
1642 {
1643 BMCWEB_LOG_ERROR << "Error patching "
1644 << propertyName << ": " << ec;
1645 messages::internalError(response->res);
1646 return;
1647 }
1648 messages::success(response->res);
James Feist73df0db2019-03-25 15:29:35 -07001649 },
James Feist6ee7f772020-02-06 16:25:27 -08001650 "xyz.openbmc_project.EntityManager", path,
James Feist73df0db2019-03-25 15:29:35 -07001651 "org.freedesktop.DBus.Properties", "Set", iface,
1652 property.first, property.second);
1653 }
1654 }
1655 else
1656 {
1657 if (chassis.empty())
1658 {
1659 BMCWEB_LOG_ERROR << "Failed to get chassis from config";
Ed Tanousace85d62021-10-26 12:45:59 -07001660 messages::internalError(response->res);
James Feist73df0db2019-03-25 15:29:35 -07001661 return;
1662 }
1663
1664 bool foundChassis = false;
1665 for (const auto& obj : managedObj)
1666 {
1667 if (boost::algorithm::ends_with(obj.first.str, chassis))
1668 {
1669 chassis = obj.first.str;
1670 foundChassis = true;
1671 break;
1672 }
1673 }
1674 if (!foundChassis)
1675 {
1676 BMCWEB_LOG_ERROR << "Failed to find chassis on dbus";
1677 messages::resourceMissingAtURI(
Ed Tanousace85d62021-10-26 12:45:59 -07001678 response->res,
1679 crow::utility::urlFromPieces("redfish", "v1",
1680 "Chassis", chassis));
James Feist73df0db2019-03-25 15:29:35 -07001681 return;
1682 }
1683
1684 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001685 [response](const boost::system::error_code& ec) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001686 if (ec)
1687 {
1688 BMCWEB_LOG_ERROR << "Error Adding Pid Object "
1689 << ec;
1690 messages::internalError(response->res);
1691 return;
1692 }
1693 messages::success(response->res);
James Feist73df0db2019-03-25 15:29:35 -07001694 },
1695 "xyz.openbmc_project.EntityManager", chassis,
1696 "xyz.openbmc_project.AddObject", "AddObject", output);
1697 }
1698 }
1699 }
1700 }
Ed Tanous24b2fe82022-01-06 12:45:54 -08001701
1702 ~SetPIDValues()
1703 {
1704 try
1705 {
1706 pidSetDone();
1707 }
1708 catch (...)
1709 {
1710 BMCWEB_LOG_CRITICAL << "pidSetDone threw exception";
1711 }
1712 }
1713
zhanghch058d1b46d2021-04-01 11:18:24 +08001714 std::shared_ptr<bmcweb::AsyncResp> asyncResp;
James Feist73df0db2019-03-25 15:29:35 -07001715 std::vector<std::pair<std::string, std::optional<nlohmann::json>>>
1716 configuration;
1717 std::optional<std::string> profile;
1718 dbus::utility::ManagedObjectType managedObj;
1719 std::vector<std::string> supportedProfiles;
1720 std::string currentProfile;
1721 std::string profileConnection;
1722 std::string profilePath;
James Feist14b0b8d2020-02-12 11:52:07 -08001723 size_t objectCount = 0;
James Feist73df0db2019-03-25 15:29:35 -07001724};
James Feist83ff9ab2018-08-31 10:18:24 -07001725
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001726/**
1727 * @brief Retrieves BMC manager location data over DBus
1728 *
1729 * @param[in] aResp Shared pointer for completing asynchronous calls
1730 * @param[in] connectionName - service name
1731 * @param[in] path - object path
1732 * @return none
1733 */
zhanghch058d1b46d2021-04-01 11:18:24 +08001734inline void getLocation(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001735 const std::string& connectionName,
1736 const std::string& path)
1737{
1738 BMCWEB_LOG_DEBUG << "Get BMC manager Location data.";
1739
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001740 sdbusplus::asio::getProperty<std::string>(
1741 *crow::connections::systemBus, connectionName, path,
1742 "xyz.openbmc_project.Inventory.Decorator.LocationCode", "LocationCode",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001743 [aResp](const boost::system::error_code& ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001744 const std::string& property) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001745 if (ec)
1746 {
1747 BMCWEB_LOG_DEBUG << "DBUS response error for "
1748 "Location";
1749 messages::internalError(aResp->res);
1750 return;
1751 }
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001752
Ed Tanous002d39b2022-05-31 08:59:27 -07001753 aResp->res.jsonValue["Location"]["PartLocation"]["ServiceLabel"] =
1754 property;
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001755 });
SunnySrivastava1984071d8fd2020-10-28 02:20:30 -05001756}
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001757// avoid name collision systems.hpp
1758inline void
1759 managerGetLastResetTime(const std::shared_ptr<bmcweb::AsyncResp>& aResp)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001760{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001761 BMCWEB_LOG_DEBUG << "Getting Manager Last Reset Time";
Ed Tanous52cc1122020-07-18 13:51:21 -07001762
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001763 sdbusplus::asio::getProperty<uint64_t>(
1764 *crow::connections::systemBus, "xyz.openbmc_project.State.BMC",
1765 "/xyz/openbmc_project/state/bmc0", "xyz.openbmc_project.State.BMC",
1766 "LastRebootTime",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001767 [aResp](const boost::system::error_code& ec,
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001768 const uint64_t lastResetTime) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001769 if (ec)
1770 {
1771 BMCWEB_LOG_DEBUG << "D-BUS response error " << ec;
1772 return;
1773 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001774
Ed Tanous002d39b2022-05-31 08:59:27 -07001775 // LastRebootTime is epoch time, in milliseconds
1776 // https://github.com/openbmc/phosphor-dbus-interfaces/blob/7f9a128eb9296e926422ddc312c148b625890bb6/xyz/openbmc_project/State/BMC.interface.yaml#L19
1777 uint64_t lastResetTimeStamp = lastResetTime / 1000;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001778
Ed Tanous002d39b2022-05-31 08:59:27 -07001779 // Convert to ISO 8601 standard
1780 aResp->res.jsonValue["LastResetTime"] =
Ed Tanous2b829372022-08-03 14:22:34 -07001781 redfish::time_utils::getDateTimeUint(lastResetTimeStamp);
Jonathan Doman1e1e5982021-06-11 09:36:17 -07001782 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001783}
1784
1785/**
1786 * @brief Set the running firmware image
1787 *
1788 * @param[i,o] aResp - Async response object
1789 * @param[i] runningFirmwareTarget - Image to make the running image
1790 *
1791 * @return void
1792 */
1793inline void
1794 setActiveFirmwareImage(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
1795 const std::string& runningFirmwareTarget)
1796{
1797 // Get the Id from /redfish/v1/UpdateService/FirmwareInventory/<Id>
1798 std::string::size_type idPos = runningFirmwareTarget.rfind('/');
1799 if (idPos == std::string::npos)
1800 {
1801 messages::propertyValueNotInList(aResp->res, runningFirmwareTarget,
1802 "@odata.id");
1803 BMCWEB_LOG_DEBUG << "Can't parse firmware ID!";
1804 return;
1805 }
1806 idPos++;
1807 if (idPos >= runningFirmwareTarget.size())
1808 {
1809 messages::propertyValueNotInList(aResp->res, runningFirmwareTarget,
1810 "@odata.id");
1811 BMCWEB_LOG_DEBUG << "Invalid firmware ID.";
1812 return;
1813 }
1814 std::string firmwareId = runningFirmwareTarget.substr(idPos);
1815
1816 // Make sure the image is valid before setting priority
1817 crow::connections::systemBus->async_method_call(
Ed Tanous711ac7a2021-12-20 09:34:41 -08001818 [aResp, firmwareId,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001819 runningFirmwareTarget](const boost::system::error_code& ec,
Ed Tanous711ac7a2021-12-20 09:34:41 -08001820 dbus::utility::ManagedObjectType& subtree) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001821 if (ec)
1822 {
1823 BMCWEB_LOG_DEBUG << "D-Bus response error getting objects.";
1824 messages::internalError(aResp->res);
1825 return;
1826 }
1827
1828 if (subtree.empty())
1829 {
1830 BMCWEB_LOG_DEBUG << "Can't find image!";
1831 messages::internalError(aResp->res);
1832 return;
1833 }
1834
1835 bool foundImage = false;
Ed Tanous02cad962022-06-30 16:50:15 -07001836 for (const auto& object : subtree)
Ed Tanous002d39b2022-05-31 08:59:27 -07001837 {
1838 const std::string& path =
1839 static_cast<const std::string&>(object.first);
1840 std::size_t idPos2 = path.rfind('/');
1841
1842 if (idPos2 == std::string::npos)
1843 {
1844 continue;
1845 }
1846
1847 idPos2++;
1848 if (idPos2 >= path.size())
1849 {
1850 continue;
1851 }
1852
1853 if (path.substr(idPos2) == firmwareId)
1854 {
1855 foundImage = true;
1856 break;
1857 }
1858 }
1859
1860 if (!foundImage)
1861 {
1862 messages::propertyValueNotInList(aResp->res, runningFirmwareTarget,
1863 "@odata.id");
1864 BMCWEB_LOG_DEBUG << "Invalid firmware ID.";
1865 return;
1866 }
1867
1868 BMCWEB_LOG_DEBUG << "Setting firmware version " << firmwareId
1869 << " to priority 0.";
1870
1871 // Only support Immediate
1872 // An addition could be a Redfish Setting like
1873 // ActiveSoftwareImageApplyTime and support OnReset
1874 crow::connections::systemBus->async_method_call(
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001875 [aResp](const boost::system::error_code& ec2) {
Ed Tanous8a592812022-06-04 09:06:59 -07001876 if (ec2)
Gunnar Mills4bfefa72020-07-30 13:54:29 -05001877 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001878 BMCWEB_LOG_DEBUG << "D-Bus response error setting.";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001879 messages::internalError(aResp->res);
1880 return;
1881 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001882 doBMCGracefulRestart(aResp);
1883 },
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001884
Ed Tanous002d39b2022-05-31 08:59:27 -07001885 "xyz.openbmc_project.Software.BMC.Updater",
1886 "/xyz/openbmc_project/software/" + firmwareId,
1887 "org.freedesktop.DBus.Properties", "Set",
1888 "xyz.openbmc_project.Software.RedundancyPriority", "Priority",
1889 dbus::utility::DbusVariantType(static_cast<uint8_t>(0)));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001890 },
1891 "xyz.openbmc_project.Software.BMC.Updater",
1892 "/xyz/openbmc_project/software", "org.freedesktop.DBus.ObjectManager",
1893 "GetManagedObjects");
1894}
Ed Tanous1abe55e2018-09-05 08:30:59 -07001895
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001896inline void setDateTime(std::shared_ptr<bmcweb::AsyncResp> aResp,
1897 std::string datetime)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001898{
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001899 BMCWEB_LOG_DEBUG << "Set date time: " << datetime;
Borawski.Lukasz9c3106852018-02-09 15:24:22 +01001900
Ed Tanousc2e32002023-01-07 22:05:08 -08001901 std::optional<redfish::time_utils::usSinceEpoch> us =
1902 redfish::time_utils::dateStringToEpoch(datetime);
1903 if (!us)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001904 {
1905 messages::propertyValueFormatError(aResp->res, datetime, "DateTime");
1906 return;
1907 }
Ed Tanousc2e32002023-01-07 22:05:08 -08001908 crow::connections::systemBus->async_method_call(
1909 [aResp{std::move(aResp)},
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001910 datetime{std::move(datetime)}](const boost::system::error_code& ec) {
Ed Tanousc2e32002023-01-07 22:05:08 -08001911 if (ec)
1912 {
1913 BMCWEB_LOG_DEBUG << "Failed to set elapsed time. "
1914 "DBUS response error "
1915 << ec;
1916 messages::internalError(aResp->res);
1917 return;
1918 }
1919 aResp->res.jsonValue["DateTime"] = datetime;
1920 },
1921 "xyz.openbmc_project.Time.Manager", "/xyz/openbmc_project/time/bmc",
1922 "org.freedesktop.DBus.Properties", "Set",
1923 "xyz.openbmc_project.Time.EpochTime", "Elapsed",
1924 dbus::utility::DbusVariantType(us->count()));
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001925}
1926
1927inline void requestRoutesManager(App& app)
1928{
1929 std::string uuid = persistent_data::getConfig().systemUuid;
1930
1931 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/")
Ed Tanoused398212021-06-09 17:05:54 -07001932 .privileges(redfish::privileges::getManager)
Ed Tanous002d39b2022-05-31 08:59:27 -07001933 .methods(boost::beast::http::verb::get)(
1934 [&app, uuid](const crow::Request& req,
Ed Tanous45ca1b82022-03-25 13:07:27 -07001935 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00001936 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07001937 {
1938 return;
1939 }
1940 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Managers/bmc";
Sui Chena51fc2d2022-07-14 17:21:53 -07001941 asyncResp->res.jsonValue["@odata.type"] = "#Manager.v1_14_0.Manager";
Ed Tanous002d39b2022-05-31 08:59:27 -07001942 asyncResp->res.jsonValue["Id"] = "bmc";
1943 asyncResp->res.jsonValue["Name"] = "OpenBmc Manager";
1944 asyncResp->res.jsonValue["Description"] =
1945 "Baseboard Management Controller";
1946 asyncResp->res.jsonValue["PowerState"] = "On";
1947 asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
1948 asyncResp->res.jsonValue["Status"]["Health"] = "OK";
Ed Tanous14766872022-03-15 10:44:42 -07001949
Ed Tanous002d39b2022-05-31 08:59:27 -07001950 asyncResp->res.jsonValue["ManagerType"] = "BMC";
1951 asyncResp->res.jsonValue["UUID"] = systemd_utils::getUuid();
1952 asyncResp->res.jsonValue["ServiceEntryPointUUID"] = uuid;
1953 asyncResp->res.jsonValue["Model"] = "OpenBmc"; // TODO(ed), get model
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001954
Ed Tanous002d39b2022-05-31 08:59:27 -07001955 asyncResp->res.jsonValue["LogServices"]["@odata.id"] =
1956 "/redfish/v1/Managers/bmc/LogServices";
1957 asyncResp->res.jsonValue["NetworkProtocol"]["@odata.id"] =
1958 "/redfish/v1/Managers/bmc/NetworkProtocol";
1959 asyncResp->res.jsonValue["EthernetInterfaces"]["@odata.id"] =
1960 "/redfish/v1/Managers/bmc/EthernetInterfaces";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001961
1962#ifdef BMCWEB_ENABLE_VM_NBDPROXY
Ed Tanous002d39b2022-05-31 08:59:27 -07001963 asyncResp->res.jsonValue["VirtualMedia"]["@odata.id"] =
1964 "/redfish/v1/Managers/bmc/VirtualMedia";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001965#endif // BMCWEB_ENABLE_VM_NBDPROXY
1966
Ed Tanous002d39b2022-05-31 08:59:27 -07001967 // default oem data
1968 nlohmann::json& oem = asyncResp->res.jsonValue["Oem"];
1969 nlohmann::json& oemOpenbmc = oem["OpenBmc"];
1970 oem["@odata.type"] = "#OemManager.Oem";
1971 oem["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem";
1972 oemOpenbmc["@odata.type"] = "#OemManager.OpenBmc";
1973 oemOpenbmc["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc";
Ed Tanous14766872022-03-15 10:44:42 -07001974
Ed Tanous002d39b2022-05-31 08:59:27 -07001975 nlohmann::json::object_t certificates;
1976 certificates["@odata.id"] =
1977 "/redfish/v1/Managers/bmc/Truststore/Certificates";
1978 oemOpenbmc["Certificates"] = std::move(certificates);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001979
Ed Tanous002d39b2022-05-31 08:59:27 -07001980 // Manager.Reset (an action) can be many values, OpenBMC only
1981 // supports BMC reboot.
1982 nlohmann::json& managerReset =
1983 asyncResp->res.jsonValue["Actions"]["#Manager.Reset"];
1984 managerReset["target"] =
1985 "/redfish/v1/Managers/bmc/Actions/Manager.Reset";
1986 managerReset["@Redfish.ActionInfo"] =
1987 "/redfish/v1/Managers/bmc/ResetActionInfo";
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001988
Ed Tanous002d39b2022-05-31 08:59:27 -07001989 // ResetToDefaults (Factory Reset) has values like
1990 // PreserveNetworkAndUsers and PreserveNetwork that aren't supported
1991 // on OpenBMC
1992 nlohmann::json& resetToDefaults =
1993 asyncResp->res.jsonValue["Actions"]["#Manager.ResetToDefaults"];
1994 resetToDefaults["target"] =
1995 "/redfish/v1/Managers/bmc/Actions/Manager.ResetToDefaults";
Ed Tanous613dabe2022-07-09 11:17:36 -07001996 resetToDefaults["ResetType@Redfish.AllowableValues"] =
1997 nlohmann::json::array_t({"ResetAll"});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07001998
Ed Tanous002d39b2022-05-31 08:59:27 -07001999 std::pair<std::string, std::string> redfishDateTimeOffset =
Ed Tanous2b829372022-08-03 14:22:34 -07002000 redfish::time_utils::getDateTimeOffsetNow();
Tejas Patil7c8c4052021-06-04 17:43:14 +05302001
Ed Tanous002d39b2022-05-31 08:59:27 -07002002 asyncResp->res.jsonValue["DateTime"] = redfishDateTimeOffset.first;
2003 asyncResp->res.jsonValue["DateTimeLocalOffset"] =
2004 redfishDateTimeOffset.second;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002005
Ed Tanous002d39b2022-05-31 08:59:27 -07002006 // TODO (Gunnar): Remove these one day since moved to ComputerSystem
2007 // Still used by OCP profiles
2008 // https://github.com/opencomputeproject/OCP-Profiles/issues/23
2009 // Fill in SerialConsole info
2010 asyncResp->res.jsonValue["SerialConsole"]["ServiceEnabled"] = true;
2011 asyncResp->res.jsonValue["SerialConsole"]["MaxConcurrentSessions"] = 15;
Ed Tanous613dabe2022-07-09 11:17:36 -07002012 asyncResp->res.jsonValue["SerialConsole"]["ConnectTypesSupported"] =
2013 nlohmann::json::array_t({"IPMI", "SSH"});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002014#ifdef BMCWEB_ENABLE_KVM
Ed Tanous002d39b2022-05-31 08:59:27 -07002015 // Fill in GraphicalConsole info
2016 asyncResp->res.jsonValue["GraphicalConsole"]["ServiceEnabled"] = true;
2017 asyncResp->res.jsonValue["GraphicalConsole"]["MaxConcurrentSessions"] =
2018 4;
Ed Tanous613dabe2022-07-09 11:17:36 -07002019 asyncResp->res.jsonValue["GraphicalConsole"]["ConnectTypesSupported"] =
2020 nlohmann::json::array_t({"KVMIP"});
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002021#endif // BMCWEB_ENABLE_KVM
2022
Ed Tanous002d39b2022-05-31 08:59:27 -07002023 asyncResp->res.jsonValue["Links"]["ManagerForServers@odata.count"] = 1;
Ed Tanous14766872022-03-15 10:44:42 -07002024
Ed Tanous002d39b2022-05-31 08:59:27 -07002025 nlohmann::json::array_t managerForServers;
2026 nlohmann::json::object_t manager;
2027 manager["@odata.id"] = "/redfish/v1/Systems/system";
2028 managerForServers.push_back(std::move(manager));
2029
2030 asyncResp->res.jsonValue["Links"]["ManagerForServers"] =
2031 std::move(managerForServers);
2032
2033 auto health = std::make_shared<HealthPopulate>(asyncResp);
2034 health->isManagersHealth = true;
2035 health->populate();
2036
Willy Tueee00132022-06-14 14:53:17 -07002037 sw_util::populateSoftwareInformation(asyncResp, sw_util::bmcPurpose,
Ed Tanous002d39b2022-05-31 08:59:27 -07002038 "FirmwareVersion", true);
2039
2040 managerGetLastResetTime(asyncResp);
2041
Sui Chena51fc2d2022-07-14 17:21:53 -07002042 // ManagerDiagnosticData is added for all BMCs.
2043 nlohmann::json& managerDiagnosticData =
2044 asyncResp->res.jsonValue["ManagerDiagnosticData"];
2045 managerDiagnosticData["@odata.id"] =
2046 "/redfish/v1/Managers/bmc/ManagerDiagnosticData";
2047
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002048#ifdef BMCWEB_ENABLE_REDFISH_OEM_MANAGER_FAN_DATA
Ed Tanous002d39b2022-05-31 08:59:27 -07002049 auto pids = std::make_shared<GetPIDValues>(asyncResp);
2050 pids->run();
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002051#endif
Ed Tanous002d39b2022-05-31 08:59:27 -07002052
2053 getMainChassisId(asyncResp,
2054 [](const std::string& chassisId,
2055 const std::shared_ptr<bmcweb::AsyncResp>& aRsp) {
2056 aRsp->res.jsonValue["Links"]["ManagerForChassis@odata.count"] = 1;
2057 nlohmann::json::array_t managerForChassis;
Ed Tanous8a592812022-06-04 09:06:59 -07002058 nlohmann::json::object_t managerObj;
Willy Tueddfc432022-09-26 16:46:38 +00002059 boost::urls::url chassiUrl = crow::utility::urlFromPieces(
2060 "redfish", "v1", "Chassis", chassisId);
2061 managerObj["@odata.id"] = chassiUrl;
Ed Tanous8a592812022-06-04 09:06:59 -07002062 managerForChassis.push_back(std::move(managerObj));
Ed Tanous002d39b2022-05-31 08:59:27 -07002063 aRsp->res.jsonValue["Links"]["ManagerForChassis"] =
2064 std::move(managerForChassis);
2065 aRsp->res.jsonValue["Links"]["ManagerInChassis"]["@odata.id"] =
Willy Tueddfc432022-09-26 16:46:38 +00002066 chassiUrl;
Ed Tanous002d39b2022-05-31 08:59:27 -07002067 });
Ed Tanous14766872022-03-15 10:44:42 -07002068
Ed Tanous002d39b2022-05-31 08:59:27 -07002069 static bool started = false;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002070
Ed Tanous002d39b2022-05-31 08:59:27 -07002071 if (!started)
2072 {
2073 sdbusplus::asio::getProperty<double>(
2074 *crow::connections::systemBus, "org.freedesktop.systemd1",
2075 "/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager",
2076 "Progress",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002077 [asyncResp](const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07002078 const double& val) {
2079 if (ec)
2080 {
2081 BMCWEB_LOG_ERROR << "Error while getting progress";
2082 messages::internalError(asyncResp->res);
2083 return;
2084 }
2085 if (val < 1.0)
2086 {
2087 asyncResp->res.jsonValue["Status"]["State"] = "Starting";
2088 started = true;
2089 }
2090 });
2091 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002092
George Liue99073f2022-12-09 11:06:16 +08002093 constexpr std::array<std::string_view, 1> interfaces = {
2094 "xyz.openbmc_project.Inventory.Item.Bmc"};
2095 dbus::utility::getSubTree(
2096 "/xyz/openbmc_project/inventory", 0, interfaces,
Ed Tanous002d39b2022-05-31 08:59:27 -07002097 [asyncResp](
George Liue99073f2022-12-09 11:06:16 +08002098 const boost::system::error_code& ec,
Ed Tanous002d39b2022-05-31 08:59:27 -07002099 const dbus::utility::MapperGetSubTreeResponse& subtree) {
2100 if (ec)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002101 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002102 BMCWEB_LOG_DEBUG << "D-Bus response error on GetSubTree " << ec;
2103 return;
2104 }
2105 if (subtree.empty())
2106 {
2107 BMCWEB_LOG_DEBUG << "Can't find bmc D-Bus object!";
2108 return;
2109 }
2110 // Assume only 1 bmc D-Bus object
2111 // Throw an error if there is more than 1
2112 if (subtree.size() > 1)
2113 {
2114 BMCWEB_LOG_DEBUG << "Found more than 1 bmc D-Bus object!";
2115 messages::internalError(asyncResp->res);
2116 return;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002117 }
2118
Ed Tanous002d39b2022-05-31 08:59:27 -07002119 if (subtree[0].first.empty() || subtree[0].second.size() != 1)
2120 {
2121 BMCWEB_LOG_DEBUG << "Error getting bmc D-Bus object!";
2122 messages::internalError(asyncResp->res);
2123 return;
2124 }
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002125
Ed Tanous002d39b2022-05-31 08:59:27 -07002126 const std::string& path = subtree[0].first;
2127 const std::string& connectionName = subtree[0].second[0].first;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002128
Ed Tanous002d39b2022-05-31 08:59:27 -07002129 for (const auto& interfaceName : subtree[0].second[0].second)
2130 {
2131 if (interfaceName ==
2132 "xyz.openbmc_project.Inventory.Decorator.Asset")
2133 {
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02002134
2135 sdbusplus::asio::getAllProperties(
2136 *crow::connections::systemBus, connectionName, path,
2137 "xyz.openbmc_project.Inventory.Decorator.Asset",
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002138 [asyncResp](const boost::system::error_code& ec2,
Ed Tanousb9d36b42022-02-26 21:42:46 -08002139 const dbus::utility::DBusPropertiesMap&
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002140 propertiesList) {
Ed Tanous8a592812022-06-04 09:06:59 -07002141 if (ec2)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002142 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002143 BMCWEB_LOG_DEBUG << "Can't get bmc asset!";
2144 return;
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002145 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002146
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02002147 const std::string* partNumber = nullptr;
2148 const std::string* serialNumber = nullptr;
2149 const std::string* manufacturer = nullptr;
2150 const std::string* model = nullptr;
2151 const std::string* sparePartNumber = nullptr;
2152
2153 const bool success = sdbusplus::unpackPropertiesNoThrow(
2154 dbus_utils::UnpackErrorPrinter(), propertiesList,
2155 "PartNumber", partNumber, "SerialNumber",
2156 serialNumber, "Manufacturer", manufacturer, "Model",
2157 model, "SparePartNumber", sparePartNumber);
2158
2159 if (!success)
2160 {
2161 messages::internalError(asyncResp->res);
2162 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07002163 }
Krzysztof Grobelnyfac6e532022-08-04 12:42:45 +02002164
2165 if (partNumber != nullptr)
2166 {
2167 asyncResp->res.jsonValue["PartNumber"] =
2168 *partNumber;
2169 }
2170
2171 if (serialNumber != nullptr)
2172 {
2173 asyncResp->res.jsonValue["SerialNumber"] =
2174 *serialNumber;
2175 }
2176
2177 if (manufacturer != nullptr)
2178 {
2179 asyncResp->res.jsonValue["Manufacturer"] =
2180 *manufacturer;
2181 }
2182
2183 if (model != nullptr)
2184 {
2185 asyncResp->res.jsonValue["Model"] = *model;
2186 }
2187
2188 if (sparePartNumber != nullptr)
2189 {
2190 asyncResp->res.jsonValue["SparePartNumber"] =
2191 *sparePartNumber;
2192 }
2193 });
Ed Tanous002d39b2022-05-31 08:59:27 -07002194 }
2195 else if (interfaceName ==
2196 "xyz.openbmc_project.Inventory.Decorator.LocationCode")
2197 {
2198 getLocation(asyncResp, connectionName, path);
2199 }
2200 }
George Liue99073f2022-12-09 11:06:16 +08002201 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002202 });
2203
2204 BMCWEB_ROUTE(app, "/redfish/v1/Managers/bmc/")
Ed Tanoused398212021-06-09 17:05:54 -07002205 .privileges(redfish::privileges::patchManager)
Ed Tanous45ca1b82022-03-25 13:07:27 -07002206 .methods(boost::beast::http::verb::patch)(
2207 [&app](const crow::Request& req,
2208 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002209 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002210 {
2211 return;
2212 }
2213 std::optional<nlohmann::json> oem;
2214 std::optional<nlohmann::json> links;
2215 std::optional<std::string> datetime;
2216
2217 if (!json_util::readJsonPatch(req, asyncResp->res, "Oem", oem,
2218 "DateTime", datetime, "Links", links))
2219 {
2220 return;
2221 }
2222
2223 if (oem)
2224 {
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002225#ifdef BMCWEB_ENABLE_REDFISH_OEM_MANAGER_FAN_DATA
Ed Tanous002d39b2022-05-31 08:59:27 -07002226 std::optional<nlohmann::json> openbmc;
2227 if (!redfish::json_util::readJson(*oem, asyncResp->res, "OpenBmc",
2228 openbmc))
2229 {
2230 BMCWEB_LOG_ERROR
2231 << "Illegal Property "
2232 << oem->dump(2, ' ', true,
2233 nlohmann::json::error_handler_t::replace);
2234 return;
2235 }
2236 if (openbmc)
2237 {
2238 std::optional<nlohmann::json> fan;
2239 if (!redfish::json_util::readJson(*openbmc, asyncResp->res,
2240 "Fan", fan))
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002241 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002242 BMCWEB_LOG_ERROR
2243 << "Illegal Property "
2244 << openbmc->dump(
2245 2, ' ', true,
2246 nlohmann::json::error_handler_t::replace);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002247 return;
2248 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002249 if (fan)
2250 {
2251 auto pid = std::make_shared<SetPIDValues>(asyncResp, *fan);
2252 pid->run();
2253 }
2254 }
Gunnar Mills54dce7f2022-08-05 17:01:32 +00002255#else
2256 messages::propertyUnknown(asyncResp->res, "Oem");
2257 return;
2258#endif
Ed Tanous002d39b2022-05-31 08:59:27 -07002259 }
2260 if (links)
2261 {
2262 std::optional<nlohmann::json> activeSoftwareImage;
2263 if (!redfish::json_util::readJson(*links, asyncResp->res,
2264 "ActiveSoftwareImage",
2265 activeSoftwareImage))
2266 {
2267 return;
2268 }
2269 if (activeSoftwareImage)
2270 {
2271 std::optional<std::string> odataId;
2272 if (!json_util::readJson(*activeSoftwareImage, asyncResp->res,
2273 "@odata.id", odataId))
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002274 {
Ed Tanous45ca1b82022-03-25 13:07:27 -07002275 return;
2276 }
2277
Ed Tanous002d39b2022-05-31 08:59:27 -07002278 if (odataId)
Ed Tanous45ca1b82022-03-25 13:07:27 -07002279 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002280 setActiveFirmwareImage(asyncResp, *odataId);
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002281 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002282 }
2283 }
2284 if (datetime)
2285 {
2286 setDateTime(asyncResp, std::move(*datetime));
2287 }
2288 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002289}
2290
2291inline void requestRoutesManagerCollection(App& app)
2292{
2293 BMCWEB_ROUTE(app, "/redfish/v1/Managers/")
Ed Tanoused398212021-06-09 17:05:54 -07002294 .privileges(redfish::privileges::getManagerCollection)
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002295 .methods(boost::beast::http::verb::get)(
Ed Tanous45ca1b82022-03-25 13:07:27 -07002296 [&app](const crow::Request& req,
2297 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Carson Labrado3ba00072022-06-06 19:40:56 +00002298 if (!redfish::setUpRedfishRoute(app, req, asyncResp))
Ed Tanous002d39b2022-05-31 08:59:27 -07002299 {
2300 return;
2301 }
2302 // Collections don't include the static data added by SubRoute
2303 // because it has a duplicate entry for members
2304 asyncResp->res.jsonValue["@odata.id"] = "/redfish/v1/Managers";
2305 asyncResp->res.jsonValue["@odata.type"] =
2306 "#ManagerCollection.ManagerCollection";
2307 asyncResp->res.jsonValue["Name"] = "Manager Collection";
2308 asyncResp->res.jsonValue["Members@odata.count"] = 1;
2309 nlohmann::json::array_t members;
2310 nlohmann::json& bmc = members.emplace_back();
2311 bmc["@odata.id"] = "/redfish/v1/Managers/bmc";
2312 asyncResp->res.jsonValue["Members"] = std::move(members);
2313 });
John Edward Broadbent7e860f12021-04-08 15:57:16 -07002314}
Ed Tanous1abe55e2018-09-05 08:30:59 -07002315} // namespace redfish