/* // Copyright (c) 2018 Intel Corporation // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. */ #pragma once #include "health.hpp" #include "node.hpp" #include "redfish_util.hpp" #include #include #include #include #include #include #include #include namespace redfish { /** * ManagerActionsReset class supports handle POST method for Reset action. * The class retrieves and sends data directly to dbus. */ class ManagerActionsReset : public Node { public: ManagerActionsReset(CrowApp& app) : Node(app, "/redfish/v1/Managers/bmc/Actions/Manager.Reset/") { entityPrivileges = { {boost::beast::http::verb::get, {{"Login"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, {boost::beast::http::verb::put, {{"ConfigureManager"}}}, {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; } private: /** * Function handles POST method request. * Analyzes POST body message before sends Reset request data to dbus. * OpenBMC allows for ResetType is GracefulRestart only. */ void doPost(crow::Response& res, const crow::Request& req, const std::vector& params) override { std::string resetType; if (!json_util::readJson(req, res, "ResetType", resetType)) { return; } if (resetType != "GracefulRestart") { res.result(boost::beast::http::status::bad_request); messages::actionParameterNotSupported(res, resetType, "ResetType"); BMCWEB_LOG_ERROR << "Request incorrect action parameter: " << resetType; res.end(); return; } doBMCGracefulRestart(res, req, params); } /** * Function transceives data with dbus directly. * All BMC state properties will be retrieved before sending reset request. */ void doBMCGracefulRestart(crow::Response& res, const crow::Request& req, const std::vector& params) { const char* processName = "xyz.openbmc_project.State.BMC"; const char* objectPath = "/xyz/openbmc_project/state/bmc0"; const char* interfaceName = "xyz.openbmc_project.State.BMC"; const std::string& propertyValue = "xyz.openbmc_project.State.BMC.Transition.Reboot"; const char* destProperty = "RequestedBMCTransition"; // Create the D-Bus variant for D-Bus call. VariantType dbusPropertyValue(propertyValue); std::shared_ptr asyncResp = std::make_shared(res); crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec) { // Use "Set" method to set the property value. if (ec) { BMCWEB_LOG_ERROR << "[Set] Bad D-Bus request error: " << ec; messages::internalError(asyncResp->res); return; } messages::success(asyncResp->res); }, processName, objectPath, "org.freedesktop.DBus.Properties", "Set", interfaceName, destProperty, dbusPropertyValue); } }; static constexpr const char* objectManagerIface = "org.freedesktop.DBus.ObjectManager"; static constexpr const char* pidConfigurationIface = "xyz.openbmc_project.Configuration.Pid"; static constexpr const char* pidZoneConfigurationIface = "xyz.openbmc_project.Configuration.Pid.Zone"; static constexpr const char* stepwiseConfigurationIface = "xyz.openbmc_project.Configuration.Stepwise"; static constexpr const char* thermalModeIface = "xyz.openbmc_project.Control.ThermalMode"; static void asyncPopulatePid(const std::string& connection, const std::string& path, const std::string& currentProfile, const std::vector& supportedProfiles, std::shared_ptr asyncResp) { crow::connections::systemBus->async_method_call( [asyncResp, currentProfile, supportedProfiles]( const boost::system::error_code ec, const dbus::utility::ManagedObjectType& managedObj) { if (ec) { BMCWEB_LOG_ERROR << ec; asyncResp->res.jsonValue.clear(); messages::internalError(asyncResp->res); return; } nlohmann::json& configRoot = asyncResp->res.jsonValue["Oem"]["OpenBmc"]["Fan"]; nlohmann::json& fans = configRoot["FanControllers"]; fans["@odata.type"] = "#OemManager.FanControllers"; fans["@odata.context"] = "/redfish/v1/$metadata#OemManager.FanControllers"; fans["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc/" "Fan/FanControllers"; nlohmann::json& pids = configRoot["PidControllers"]; pids["@odata.type"] = "#OemManager.PidControllers"; pids["@odata.context"] = "/redfish/v1/$metadata#OemManager.PidControllers"; pids["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/PidControllers"; nlohmann::json& stepwise = configRoot["StepwiseControllers"]; stepwise["@odata.type"] = "#OemManager.StepwiseControllers"; stepwise["@odata.context"] = "/redfish/v1/$metadata#OemManager.StepwiseControllers"; stepwise["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/StepwiseControllers"; nlohmann::json& zones = configRoot["FanZones"]; zones["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanZones"; zones["@odata.type"] = "#OemManager.FanZones"; zones["@odata.context"] = "/redfish/v1/$metadata#OemManager.FanZones"; configRoot["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan"; configRoot["@odata.type"] = "#OemManager.Fan"; configRoot["@odata.context"] = "/redfish/v1/$metadata#OemManager.Fan"; configRoot["Profile@Redfish.AllowableValues"] = supportedProfiles; if (!currentProfile.empty()) { configRoot["Profile"] = currentProfile; } BMCWEB_LOG_ERROR << "profile = " << currentProfile << " !"; for (const auto& pathPair : managedObj) { for (const auto& intfPair : pathPair.second) { if (intfPair.first != pidConfigurationIface && intfPair.first != pidZoneConfigurationIface && intfPair.first != stepwiseConfigurationIface) { continue; } auto findName = intfPair.second.find("Name"); if (findName == intfPair.second.end()) { BMCWEB_LOG_ERROR << "Pid Field missing Name"; messages::internalError(asyncResp->res); return; } const std::string* namePtr = std::get_if(&findName->second); if (namePtr == nullptr) { BMCWEB_LOG_ERROR << "Pid Name Field illegal"; messages::internalError(asyncResp->res); return; } std::string name = *namePtr; dbus::utility::escapePathForDbus(name); auto findProfiles = intfPair.second.find("Profiles"); if (findProfiles != intfPair.second.end()) { const std::vector* profiles = std::get_if>( &findProfiles->second); if (profiles == nullptr) { BMCWEB_LOG_ERROR << "Pid Profiles Field illegal"; messages::internalError(asyncResp->res); return; } if (std::find(profiles->begin(), profiles->end(), currentProfile) == profiles->end()) { BMCWEB_LOG_INFO << name << " not supported in current profile"; continue; } } nlohmann::json* config = nullptr; const std::string* classPtr = nullptr; auto findClass = intfPair.second.find("Class"); if (findClass != intfPair.second.end()) { classPtr = std::get_if(&findClass->second); } if (intfPair.first == pidZoneConfigurationIface) { std::string chassis; if (!dbus::utility::getNthStringFromPath( pathPair.first.str, 5, chassis)) { chassis = "#IllegalValue"; } nlohmann::json& zone = zones[name]; zone["Chassis"] = { {"@odata.id", "/redfish/v1/Chassis/" + chassis}}; zone["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/" "OpenBmc/Fan/FanZones/" + name; zone["@odata.type"] = "#OemManager.FanZone"; zone["@odata.context"] = "/redfish/v1/$metadata#OemManager.FanZone"; config = &zone; } else if (intfPair.first == stepwiseConfigurationIface) { if (classPtr == nullptr) { BMCWEB_LOG_ERROR << "Pid Class Field illegal"; messages::internalError(asyncResp->res); return; } nlohmann::json& controller = stepwise[name]; config = &controller; controller["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/" "OpenBmc/Fan/StepwiseControllers/" + name; controller["@odata.type"] = "#OemManager.StepwiseController"; controller["@odata.context"] = "/redfish/v1/" "$metadata#OemManager.StepwiseController"; controller["Direction"] = *classPtr; } // pid and fans are off the same configuration else if (intfPair.first == pidConfigurationIface) { if (classPtr == nullptr) { BMCWEB_LOG_ERROR << "Pid Class Field illegal"; messages::internalError(asyncResp->res); return; } bool isFan = *classPtr == "fan"; nlohmann::json& element = isFan ? fans[name] : pids[name]; config = &element; if (isFan) { element["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/" "OpenBmc/Fan/FanControllers/" + name; element["@odata.type"] = "#OemManager.FanController"; element["@odata.context"] = "/redfish/v1/" "$metadata#OemManager.FanController"; } else { element["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/" "OpenBmc/Fan/PidControllers/" + name; element["@odata.type"] = "#OemManager.PidController"; element["@odata.context"] = "/redfish/v1/$metadata" "#OemManager.PidController"; } } else { BMCWEB_LOG_ERROR << "Unexpected configuration"; messages::internalError(asyncResp->res); return; } // used for making maps out of 2 vectors const std::vector* keys = nullptr; const std::vector* values = nullptr; for (const auto& propertyPair : intfPair.second) { if (propertyPair.first == "Type" || propertyPair.first == "Class" || propertyPair.first == "Name") { continue; } // zones if (intfPair.first == pidZoneConfigurationIface) { const double* ptr = std::get_if(&propertyPair.second); if (ptr == nullptr) { BMCWEB_LOG_ERROR << "Field Illegal " << propertyPair.first; messages::internalError(asyncResp->res); return; } (*config)[propertyPair.first] = *ptr; } if (intfPair.first == stepwiseConfigurationIface) { if (propertyPair.first == "Reading" || propertyPair.first == "Output") { const std::vector* ptr = std::get_if>( &propertyPair.second); if (ptr == nullptr) { BMCWEB_LOG_ERROR << "Field Illegal " << propertyPair.first; messages::internalError(asyncResp->res); return; } if (propertyPair.first == "Reading") { keys = ptr; } else { values = ptr; } if (keys && values) { if (keys->size() != values->size()) { BMCWEB_LOG_ERROR << "Reading and Output size don't " "match "; messages::internalError(asyncResp->res); return; } nlohmann::json& steps = (*config)["Steps"]; steps = nlohmann::json::array(); for (size_t ii = 0; ii < keys->size(); ii++) { steps.push_back( {{"Target", (*keys)[ii]}, {"Output", (*values)[ii]}}); } } } if (propertyPair.first == "NegativeHysteresis" || propertyPair.first == "PositiveHysteresis") { const double* ptr = std::get_if(&propertyPair.second); if (ptr == nullptr) { BMCWEB_LOG_ERROR << "Field Illegal " << propertyPair.first; messages::internalError(asyncResp->res); return; } (*config)[propertyPair.first] = *ptr; } } // pid and fans are off the same configuration if (intfPair.first == pidConfigurationIface || intfPair.first == stepwiseConfigurationIface) { if (propertyPair.first == "Zones") { const std::vector* inputs = std::get_if>( &propertyPair.second); if (inputs == nullptr) { BMCWEB_LOG_ERROR << "Zones Pid Field Illegal"; messages::internalError(asyncResp->res); return; } auto& data = (*config)[propertyPair.first]; data = nlohmann::json::array(); for (std::string itemCopy : *inputs) { dbus::utility::escapePathForDbus(itemCopy); data.push_back( {{"@odata.id", "/redfish/v1/Managers/bmc#/Oem/" "OpenBmc/Fan/FanZones/" + itemCopy}}); } } // todo(james): may never happen, but this // assumes configuration data referenced in the // PID config is provided by the same daemon, we // could add another loop to cover all cases, // but I'm okay kicking this can down the road a // bit else if (propertyPair.first == "Inputs" || propertyPair.first == "Outputs") { auto& data = (*config)[propertyPair.first]; const std::vector* inputs = std::get_if>( &propertyPair.second); if (inputs == nullptr) { BMCWEB_LOG_ERROR << "Field Illegal " << propertyPair.first; messages::internalError(asyncResp->res); return; } data = *inputs; } else if (propertyPair.first == "SetPointOffset") { const std::string* ptr = std::get_if( &propertyPair.second); if (ptr == nullptr) { BMCWEB_LOG_ERROR << "Field Illegal " << propertyPair.first; messages::internalError(asyncResp->res); return; } // translate from dbus to redfish if (*ptr == "WarningHigh") { (*config)["SetPointOffset"] = "UpperThresholdNonCritical"; } else if (*ptr == "WarningLow") { (*config)["SetPointOffset"] = "LowerThresholdNonCritical"; } else if (*ptr == "CriticalHigh") { (*config)["SetPointOffset"] = "UpperThresholdCritical"; } else if (*ptr == "CriticalLow") { (*config)["SetPointOffset"] = "LowerThresholdCritical"; } else { BMCWEB_LOG_ERROR << "Value Illegal " << *ptr; messages::internalError(asyncResp->res); return; } } // doubles else if (propertyPair.first == "FFGainCoefficient" || propertyPair.first == "FFOffCoefficient" || propertyPair.first == "ICoefficient" || propertyPair.first == "ILimitMax" || propertyPair.first == "ILimitMin" || propertyPair.first == "PositiveHysteresis" || propertyPair.first == "NegativeHysteresis" || propertyPair.first == "OutLimitMax" || propertyPair.first == "OutLimitMin" || propertyPair.first == "PCoefficient" || propertyPair.first == "SetPoint" || propertyPair.first == "SlewNeg" || propertyPair.first == "SlewPos") { const double* ptr = std::get_if(&propertyPair.second); if (ptr == nullptr) { BMCWEB_LOG_ERROR << "Field Illegal " << propertyPair.first; messages::internalError(asyncResp->res); return; } (*config)[propertyPair.first] = *ptr; } } } } } }, connection, path, objectManagerIface, "GetManagedObjects"); } enum class CreatePIDRet { fail, del, patch }; static bool getZonesFromJsonReq(const std::shared_ptr& response, std::vector& config, std::vector& zones) { if (config.empty()) { BMCWEB_LOG_ERROR << "Empty Zones"; messages::propertyValueFormatError(response->res, nlohmann::json::array(), "Zones"); return false; } for (auto& odata : config) { std::string path; if (!redfish::json_util::readJson(odata, response->res, "@odata.id", path)) { return false; } std::string input; // 8 below comes from // /redfish/v1/Managers/bmc#/Oem/OpenBmc/Fan/FanZones/Left // 0 1 2 3 4 5 6 7 8 if (!dbus::utility::getNthStringFromPath(path, 8, input)) { BMCWEB_LOG_ERROR << "Got invalid path " << path; BMCWEB_LOG_ERROR << "Illegal Type Zones"; messages::propertyValueFormatError(response->res, odata.dump(), "Zones"); return false; } boost::replace_all(input, "_", " "); zones.emplace_back(std::move(input)); } return true; } static const dbus::utility::ManagedItem* findChassis(const dbus::utility::ManagedObjectType& managedObj, const std::string& value, std::string& chassis) { BMCWEB_LOG_DEBUG << "Find Chassis: " << value << "\n"; std::string escaped = boost::replace_all_copy(value, " ", "_"); escaped = "/" + escaped; auto it = std::find_if( managedObj.begin(), managedObj.end(), [&escaped](const auto& obj) { if (boost::algorithm::ends_with(obj.first.str, escaped)) { BMCWEB_LOG_DEBUG << "Matched " << obj.first.str << "\n"; return true; } return false; }); if (it == managedObj.end()) { return nullptr; } // 5 comes from being the 5th element // /xyz/openbmc_project/inventory/system/chassis/ if (dbus::utility::getNthStringFromPath(it->first.str, 5, chassis)) { return &(*it); } return nullptr; } static CreatePIDRet createPidInterface( const std::shared_ptr& response, const std::string& type, nlohmann::json::iterator it, const std::string& path, const dbus::utility::ManagedObjectType& managedObj, bool createNewObject, boost::container::flat_map& output, std::string& chassis, const std::string& profile) { // common deleter if (it.value() == nullptr) { std::string iface; if (type == "PidControllers" || type == "FanControllers") { iface = pidConfigurationIface; } else if (type == "FanZones") { iface = pidZoneConfigurationIface; } else if (type == "StepwiseControllers") { iface = stepwiseConfigurationIface; } else { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Type " << type; messages::propertyUnknown(response->res, type); return CreatePIDRet::fail; } // delete interface crow::connections::systemBus->async_method_call( [response, path](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "Error patching " << path << ": " << ec; messages::internalError(response->res); return; } messages::success(response->res); }, "xyz.openbmc_project.EntityManager", path, iface, "Delete"); return CreatePIDRet::del; } const dbus::utility::ManagedItem* managedItem = nullptr; if (!createNewObject) { // if we aren't creating a new object, we should be able to find it on // d-bus managedItem = findChassis(managedObj, it.key(), chassis); if (managedItem == nullptr) { BMCWEB_LOG_ERROR << "Failed to get chassis from config patch"; messages::invalidObject(response->res, it.key()); return CreatePIDRet::fail; } } if (profile.size() && (type == "PidControllers" || type == "FanControllers" || type == "StepwiseControllers")) { if (managedItem == nullptr) { output["Profiles"] = std::vector{profile}; } else { std::string interface; if (type == "StepwiseControllers") { interface = stepwiseConfigurationIface; } else { interface = pidConfigurationIface; } auto findConfig = managedItem->second.find(interface); if (findConfig == managedItem->second.end()) { BMCWEB_LOG_ERROR << "Failed to find interface in managed object"; messages::internalError(response->res); return CreatePIDRet::fail; } auto findProfiles = findConfig->second.find("Profiles"); if (findProfiles != findConfig->second.end()) { const std::vector* curProfiles = std::get_if>( &(findProfiles->second)); if (curProfiles == nullptr) { BMCWEB_LOG_ERROR << "Illegal profiles in managed object"; messages::internalError(response->res); return CreatePIDRet::fail; } if (std::find(curProfiles->begin(), curProfiles->end(), profile) == curProfiles->end()) { std::vector newProfiles = *curProfiles; newProfiles.push_back(profile); output["Profiles"] = newProfiles; } } } } if (type == "PidControllers" || type == "FanControllers") { if (createNewObject) { output["Class"] = type == "PidControllers" ? std::string("temp") : std::string("fan"); output["Type"] = std::string("Pid"); } std::optional> zones; std::optional> inputs; std::optional> outputs; std::map> doubles; std::optional setpointOffset; if (!redfish::json_util::readJson( it.value(), response->res, "Inputs", inputs, "Outputs", outputs, "Zones", zones, "FFGainCoefficient", doubles["FFGainCoefficient"], "FFOffCoefficient", doubles["FFOffCoefficient"], "ICoefficient", doubles["ICoefficient"], "ILimitMax", doubles["ILimitMax"], "ILimitMin", doubles["ILimitMin"], "OutLimitMax", doubles["OutLimitMax"], "OutLimitMin", doubles["OutLimitMin"], "PCoefficient", doubles["PCoefficient"], "SetPoint", doubles["SetPoint"], "SetPointOffset", setpointOffset, "SlewNeg", doubles["SlewNeg"], "SlewPos", doubles["SlewPos"], "PositiveHysteresis", doubles["PositiveHysteresis"], "NegativeHysteresis", doubles["NegativeHysteresis"])) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << it.value().dump(); return CreatePIDRet::fail; } if (zones) { std::vector zonesStr; if (!getZonesFromJsonReq(response, *zones, zonesStr)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Zones"; return CreatePIDRet::fail; } if (chassis.empty() && !findChassis(managedObj, zonesStr[0], chassis)) { BMCWEB_LOG_ERROR << "Failed to get chassis from config patch"; messages::invalidObject(response->res, it.key()); return CreatePIDRet::fail; } output["Zones"] = std::move(zonesStr); } if (inputs || outputs) { std::array>*, 2> containers = {&inputs, &outputs}; size_t index = 0; for (const auto& containerPtr : containers) { std::optional>& container = *containerPtr; if (!container) { index++; continue; } for (std::string& value : *container) { boost::replace_all(value, "_", " "); } std::string key; if (index == 0) { key = "Inputs"; } else { key = "Outputs"; } output[key] = *container; index++; } } if (setpointOffset) { // translate between redfish and dbus names if (*setpointOffset == "UpperThresholdNonCritical") { output["SetPointOffset"] = std::string("WarningLow"); } else if (*setpointOffset == "LowerThresholdNonCritical") { output["SetPointOffset"] = std::string("WarningHigh"); } else if (*setpointOffset == "LowerThresholdCritical") { output["SetPointOffset"] = std::string("CriticalLow"); } else if (*setpointOffset == "UpperThresholdCritical") { output["SetPointOffset"] = std::string("CriticalHigh"); } else { BMCWEB_LOG_ERROR << "Invalid setpointoffset " << *setpointOffset; messages::invalidObject(response->res, it.key()); return CreatePIDRet::fail; } } // doubles for (const auto& pairs : doubles) { if (!pairs.second) { continue; } BMCWEB_LOG_DEBUG << pairs.first << " = " << *pairs.second; output[pairs.first] = *(pairs.second); } } else if (type == "FanZones") { output["Type"] = std::string("Pid.Zone"); std::optional chassisContainer; std::optional failSafePercent; std::optional minThermalOutput; if (!redfish::json_util::readJson(it.value(), response->res, "Chassis", chassisContainer, "FailSafePercent", failSafePercent, "MinThermalOutput", minThermalOutput)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << it.value().dump(); return CreatePIDRet::fail; } if (chassisContainer) { std::string chassisId; if (!redfish::json_util::readJson(*chassisContainer, response->res, "@odata.id", chassisId)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << chassisContainer->dump(); return CreatePIDRet::fail; } // /redfish/v1/chassis/chassis_name/ if (!dbus::utility::getNthStringFromPath(chassisId, 3, chassis)) { BMCWEB_LOG_ERROR << "Got invalid path " << chassisId; messages::invalidObject(response->res, chassisId); return CreatePIDRet::fail; } } if (minThermalOutput) { output["MinThermalOutput"] = *minThermalOutput; } if (failSafePercent) { output["FailSafePercent"] = *failSafePercent; } } else if (type == "StepwiseControllers") { output["Type"] = std::string("Stepwise"); std::optional> zones; std::optional> steps; std::optional> inputs; std::optional positiveHysteresis; std::optional negativeHysteresis; std::optional direction; // upper clipping curve vs lower if (!redfish::json_util::readJson( it.value(), response->res, "Zones", zones, "Steps", steps, "Inputs", inputs, "PositiveHysteresis", positiveHysteresis, "NegativeHysteresis", negativeHysteresis, "Direction", direction)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << it.value().dump(); return CreatePIDRet::fail; } if (zones) { std::vector zonesStrs; if (!getZonesFromJsonReq(response, *zones, zonesStrs)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Zones"; return CreatePIDRet::fail; } if (chassis.empty() && !findChassis(managedObj, zonesStrs[0], chassis)) { BMCWEB_LOG_ERROR << "Failed to get chassis from config patch"; messages::invalidObject(response->res, it.key()); return CreatePIDRet::fail; } output["Zones"] = std::move(zonesStrs); } if (steps) { std::vector readings; std::vector outputs; for (auto& step : *steps) { double target; double output; if (!redfish::json_util::readJson(step, response->res, "Target", target, "Output", output)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << it.value().dump(); return CreatePIDRet::fail; } readings.emplace_back(target); outputs.emplace_back(output); } output["Reading"] = std::move(readings); output["Output"] = std::move(outputs); } if (inputs) { for (std::string& value : *inputs) { boost::replace_all(value, "_", " "); } output["Inputs"] = std::move(*inputs); } if (negativeHysteresis) { output["NegativeHysteresis"] = *negativeHysteresis; } if (positiveHysteresis) { output["PositiveHysteresis"] = *positiveHysteresis; } if (direction) { constexpr const std::array allowedDirections = { "Ceiling", "Floor"}; if (std::find(allowedDirections.begin(), allowedDirections.end(), *direction) == allowedDirections.end()) { messages::propertyValueTypeError(response->res, "Direction", *direction); return CreatePIDRet::fail; } output["Class"] = *direction; } } else { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Type " << type; messages::propertyUnknown(response->res, type); return CreatePIDRet::fail; } return CreatePIDRet::patch; } struct GetPIDValues : std::enable_shared_from_this { GetPIDValues(const std::shared_ptr& asyncResp) : asyncResp(asyncResp) { } void run() { std::shared_ptr self = shared_from_this(); // get all configurations crow::connections::systemBus->async_method_call( [self](const boost::system::error_code ec, const crow::openbmc_mapper::GetSubTreeType& subtree) { if (ec) { BMCWEB_LOG_ERROR << ec; messages::internalError(self->asyncResp->res); return; } self->subtree = subtree; }, "xyz.openbmc_project.ObjectMapper", "/xyz/openbmc_project/object_mapper", "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, std::array{ pidConfigurationIface, pidZoneConfigurationIface, objectManagerIface, stepwiseConfigurationIface}); // at the same time get the selected profile crow::connections::systemBus->async_method_call( [self](const boost::system::error_code ec, const crow::openbmc_mapper::GetSubTreeType& subtree) { if (ec || subtree.empty()) { return; } if (subtree[0].second.size() != 1) { // invalid mapper response, should never happen BMCWEB_LOG_ERROR << "GetPIDValues: Mapper Error"; messages::internalError(self->asyncResp->res); return; } const std::string& path = subtree[0].first; const std::string& owner = subtree[0].second[0].first; crow::connections::systemBus->async_method_call( [path, owner, self]( const boost::system::error_code ec, const boost::container::flat_map< std::string, std::variant, std::string>>& resp) { if (ec) { BMCWEB_LOG_ERROR << "GetPIDValues: Can't get " "thermalModeIface " << path; messages::internalError(self->asyncResp->res); return; } const std::string* current = nullptr; const std::vector* supported = nullptr; for (auto& [key, value] : resp) { if (key == "Current") { current = std::get_if(&value); if (current == nullptr) { BMCWEB_LOG_ERROR << "GetPIDValues: thermal mode " "iface invalid " << path; messages::internalError( self->asyncResp->res); return; } } if (key == "Supported") { supported = std::get_if>( &value); if (supported == nullptr) { BMCWEB_LOG_ERROR << "GetPIDValues: thermal mode " "iface invalid" << path; messages::internalError( self->asyncResp->res); return; } } } if (current == nullptr || supported == nullptr) { BMCWEB_LOG_ERROR << "GetPIDValues: thermal mode " "iface invalid " << path; messages::internalError(self->asyncResp->res); return; } self->currentProfile = *current; self->supportedProfiles = *supported; }, owner, path, "org.freedesktop.DBus.Properties", "GetAll", thermalModeIface); }, "xyz.openbmc_project.ObjectMapper", "/xyz/openbmc_project/object_mapper", "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, std::array{thermalModeIface}); } ~GetPIDValues() { if (asyncResp->res.result() != boost::beast::http::status::ok) { return; } // create map of > boost::container::flat_map objectMgrPaths; boost::container::flat_set calledConnections; for (const auto& pathGroup : subtree) { for (const auto& connectionGroup : pathGroup.second) { auto findConnection = calledConnections.find(connectionGroup.first); if (findConnection != calledConnections.end()) { break; } for (const std::string& interface : connectionGroup.second) { if (interface == objectManagerIface) { objectMgrPaths[connectionGroup.first] = pathGroup.first; } // this list is alphabetical, so we // should have found the objMgr by now if (interface == pidConfigurationIface || interface == pidZoneConfigurationIface || interface == stepwiseConfigurationIface) { auto findObjMgr = objectMgrPaths.find(connectionGroup.first); if (findObjMgr == objectMgrPaths.end()) { BMCWEB_LOG_DEBUG << connectionGroup.first << "Has no Object Manager"; continue; } calledConnections.insert(connectionGroup.first); asyncPopulatePid(findObjMgr->first, findObjMgr->second, currentProfile, supportedProfiles, asyncResp); break; } } } } } std::vector supportedProfiles; std::string currentProfile; crow::openbmc_mapper::GetSubTreeType subtree; std::shared_ptr asyncResp; }; struct SetPIDValues : std::enable_shared_from_this { SetPIDValues(const std::shared_ptr& asyncRespIn, nlohmann::json& data) : asyncResp(asyncRespIn) { std::optional pidControllers; std::optional fanControllers; std::optional fanZones; std::optional stepwiseControllers; if (!redfish::json_util::readJson( data, asyncResp->res, "PidControllers", pidControllers, "FanControllers", fanControllers, "FanZones", fanZones, "StepwiseControllers", stepwiseControllers, "Profile", profile)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << data.dump(); return; } configuration.emplace_back("PidControllers", std::move(pidControllers)); configuration.emplace_back("FanControllers", std::move(fanControllers)); configuration.emplace_back("FanZones", std::move(fanZones)); configuration.emplace_back("StepwiseControllers", std::move(stepwiseControllers)); } void run() { if (asyncResp->res.result() != boost::beast::http::status::ok) { return; } std::shared_ptr self = shared_from_this(); // todo(james): might make sense to do a mapper call here if this // interface gets more traction crow::connections::systemBus->async_method_call( [self](const boost::system::error_code ec, dbus::utility::ManagedObjectType& mObj) { if (ec) { BMCWEB_LOG_ERROR << "Error communicating to Entity Manager"; messages::internalError(self->asyncResp->res); return; } self->managedObj = std::move(mObj); }, "xyz.openbmc_project.EntityManager", "/", objectManagerIface, "GetManagedObjects"); // at the same time get the profile information crow::connections::systemBus->async_method_call( [self](const boost::system::error_code ec, const crow::openbmc_mapper::GetSubTreeType& subtree) { if (ec || subtree.empty()) { return; } if (subtree[0].second.empty()) { // invalid mapper response, should never happen BMCWEB_LOG_ERROR << "SetPIDValues: Mapper Error"; messages::internalError(self->asyncResp->res); return; } const std::string& path = subtree[0].first; const std::string& owner = subtree[0].second[0].first; crow::connections::systemBus->async_method_call( [self, path, owner]( const boost::system::error_code ec, const boost::container::flat_map< std::string, std::variant, std::string>>& r) { if (ec) { BMCWEB_LOG_ERROR << "SetPIDValues: Can't get " "thermalModeIface " << path; messages::internalError(self->asyncResp->res); return; } const std::string* current = nullptr; const std::vector* supported = nullptr; for (auto& [key, value] : r) { if (key == "Current") { current = std::get_if(&value); if (current == nullptr) { BMCWEB_LOG_ERROR << "SetPIDValues: thermal mode " "iface invalid " << path; messages::internalError( self->asyncResp->res); return; } } if (key == "Supported") { supported = std::get_if>( &value); if (supported == nullptr) { BMCWEB_LOG_ERROR << "SetPIDValues: thermal mode " "iface invalid" << path; messages::internalError( self->asyncResp->res); return; } } } if (current == nullptr || supported == nullptr) { BMCWEB_LOG_ERROR << "SetPIDValues: thermal mode " "iface invalid " << path; messages::internalError(self->asyncResp->res); return; } self->currentProfile = *current; self->supportedProfiles = *supported; self->profileConnection = owner; self->profilePath = path; }, owner, path, "org.freedesktop.DBus.Properties", "GetAll", thermalModeIface); }, "xyz.openbmc_project.ObjectMapper", "/xyz/openbmc_project/object_mapper", "xyz.openbmc_project.ObjectMapper", "GetSubTree", "/", 0, std::array{thermalModeIface}); } ~SetPIDValues() { if (asyncResp->res.result() != boost::beast::http::status::ok) { return; } std::shared_ptr response = asyncResp; if (profile) { if (std::find(supportedProfiles.begin(), supportedProfiles.end(), *profile) == supportedProfiles.end()) { messages::actionParameterUnknown(response->res, "Profile", *profile); return; } currentProfile = *profile; crow::connections::systemBus->async_method_call( [response](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "Error patching profile" << ec; messages::internalError(response->res); } }, profileConnection, profilePath, "org.freedesktop.DBus.Properties", "Set", thermalModeIface, "Current", std::variant(*profile)); } for (auto& containerPair : configuration) { auto& container = containerPair.second; if (!container) { continue; } std::string& type = containerPair.first; for (nlohmann::json::iterator it = container->begin(); it != container->end(); it++) { const auto& name = it.key(); auto pathItr = std::find_if(managedObj.begin(), managedObj.end(), [&name](const auto& obj) { return boost::algorithm::ends_with( obj.first.str, "/" + name); }); boost::container::flat_map output; output.reserve(16); // The pid interface length // determines if we're patching entity-manager or // creating a new object bool createNewObject = (pathItr == managedObj.end()); std::string iface; if (type == "PidControllers" || type == "FanControllers") { iface = pidConfigurationIface; if (!createNewObject && pathItr->second.find(pidConfigurationIface) == pathItr->second.end()) { createNewObject = true; } } else if (type == "FanZones") { iface = pidZoneConfigurationIface; if (!createNewObject && pathItr->second.find(pidZoneConfigurationIface) == pathItr->second.end()) { createNewObject = true; } } else if (type == "StepwiseControllers") { iface = stepwiseConfigurationIface; if (!createNewObject && pathItr->second.find(stepwiseConfigurationIface) == pathItr->second.end()) { createNewObject = true; } } BMCWEB_LOG_DEBUG << "Create new = " << createNewObject << "\n"; output["Name"] = boost::replace_all_copy(name, "_", " "); std::string chassis; CreatePIDRet ret = createPidInterface( response, type, it, pathItr->first.str, managedObj, createNewObject, output, chassis, currentProfile); if (ret == CreatePIDRet::fail) { return; } else if (ret == CreatePIDRet::del) { continue; } if (!createNewObject) { for (const auto& property : output) { crow::connections::systemBus->async_method_call( [response, propertyName{std::string(property.first)}]( const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "Error patching " << propertyName << ": " << ec; messages::internalError(response->res); return; } messages::success(response->res); }, "xyz.openbmc_project.EntityManager", pathItr->first.str, "org.freedesktop.DBus.Properties", "Set", iface, property.first, property.second); } } else { if (chassis.empty()) { BMCWEB_LOG_ERROR << "Failed to get chassis from config"; messages::invalidObject(response->res, name); return; } bool foundChassis = false; for (const auto& obj : managedObj) { if (boost::algorithm::ends_with(obj.first.str, chassis)) { chassis = obj.first.str; foundChassis = true; break; } } if (!foundChassis) { BMCWEB_LOG_ERROR << "Failed to find chassis on dbus"; messages::resourceMissingAtURI( response->res, "/redfish/v1/Chassis/" + chassis); return; } crow::connections::systemBus->async_method_call( [response](const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_ERROR << "Error Adding Pid Object " << ec; messages::internalError(response->res); return; } messages::success(response->res); }, "xyz.openbmc_project.EntityManager", chassis, "xyz.openbmc_project.AddObject", "AddObject", output); } } } } std::shared_ptr asyncResp; std::vector>> configuration; std::optional profile; dbus::utility::ManagedObjectType managedObj; std::vector supportedProfiles; std::string currentProfile; std::string profileConnection; std::string profilePath; }; class Manager : public Node { public: Manager(CrowApp& app) : Node(app, "/redfish/v1/Managers/bmc/") { uuid = app.template getMiddleware() .systemUuid; entityPrivileges = { {boost::beast::http::verb::get, {{"Login"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, {boost::beast::http::verb::put, {{"ConfigureManager"}}}, {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; } private: void doGet(crow::Response& res, const crow::Request& req, const std::vector& params) override { res.jsonValue["@odata.id"] = "/redfish/v1/Managers/bmc"; res.jsonValue["@odata.type"] = "#Manager.v1_3_0.Manager"; res.jsonValue["@odata.context"] = "/redfish/v1/$metadata#Manager.Manager"; res.jsonValue["Id"] = "bmc"; res.jsonValue["Name"] = "OpenBmc Manager"; res.jsonValue["Description"] = "Baseboard Management Controller"; res.jsonValue["PowerState"] = "On"; res.jsonValue["Status"] = {{"State", "Enabled"}, {"Health", "OK"}}; res.jsonValue["ManagerType"] = "BMC"; res.jsonValue["UUID"] = systemd_utils::getUuid(); res.jsonValue["ServiceEntryPointUUID"] = uuid; res.jsonValue["Model"] = "OpenBmc"; // TODO(ed), get model res.jsonValue["LogServices"] = { {"@odata.id", "/redfish/v1/Managers/bmc/LogServices"}}; res.jsonValue["NetworkProtocol"] = { {"@odata.id", "/redfish/v1/Managers/bmc/NetworkProtocol"}}; res.jsonValue["EthernetInterfaces"] = { {"@odata.id", "/redfish/v1/Managers/bmc/EthernetInterfaces"}}; // default oem data nlohmann::json& oem = res.jsonValue["Oem"]; nlohmann::json& oemOpenbmc = oem["OpenBmc"]; oem["@odata.type"] = "#OemManager.Oem"; oem["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem"; oem["@odata.context"] = "/redfish/v1/$metadata#OemManager.Oem"; oemOpenbmc["@odata.type"] = "#OemManager.OpenBmc"; oemOpenbmc["@odata.id"] = "/redfish/v1/Managers/bmc#/Oem/OpenBmc"; oemOpenbmc["@odata.context"] = "/redfish/v1/$metadata#OemManager.OpenBmc"; oemOpenbmc["Certificates"] = { {"@odata.id", "/redfish/v1/Managers/bmc/Truststore/Certificates"}}; // Update Actions object. nlohmann::json& manager_reset = res.jsonValue["Actions"]["#Manager.Reset"]; manager_reset["target"] = "/redfish/v1/Managers/bmc/Actions/Manager.Reset"; manager_reset["ResetType@Redfish.AllowableValues"] = { "GracefulRestart"}; res.jsonValue["DateTime"] = crow::utility::dateTimeNow(); // Fill in SerialConsole info res.jsonValue["SerialConsole"]["ServiceEnabled"] = true; res.jsonValue["SerialConsole"]["MaxConcurrentSessions"] = 15; res.jsonValue["SerialConsole"]["ConnectTypesSupported"] = {"IPMI", "SSH"}; #ifdef BMCWEB_ENABLE_KVM // Fill in GraphicalConsole info res.jsonValue["GraphicalConsole"]["ServiceEnabled"] = true; res.jsonValue["GraphicalConsole"]["MaxConcurrentSessions"] = 4; res.jsonValue["GraphicalConsole"]["ConnectTypesSupported"] = {"KVMIP"}; #endif // BMCWEB_ENABLE_KVM res.jsonValue["Links"]["ManagerForServers@odata.count"] = 1; res.jsonValue["Links"]["ManagerForServers"] = { {{"@odata.id", "/redfish/v1/Systems/system"}}}; std::shared_ptr asyncResp = std::make_shared(res); auto health = std::make_shared(asyncResp); health->isManagersHealth = true; health->populate(); fw_util::getActiveFwVersion(asyncResp, fw_util::bmcPurpose, "FirmwareVersion"); auto pids = std::make_shared(asyncResp); pids->run(); getMainChassisId(asyncResp, [](const std::string& chassisId, const std::shared_ptr aRsp) { aRsp->res.jsonValue["Links"]["ManagerForChassis@odata.count"] = 1; aRsp->res.jsonValue["Links"]["ManagerForChassis"] = { {{"@odata.id", "/redfish/v1/Chassis/" + chassisId}}}; aRsp->res.jsonValue["Links"]["ManagerInChassis"] = { {"@odata.id", "/redfish/v1/Chassis/" + chassisId}}; }); static bool started = false; if (!started) { crow::connections::systemBus->async_method_call( [asyncResp](const boost::system::error_code ec, const std::variant& resp) { if (ec) { BMCWEB_LOG_ERROR << "Error while getting progress"; messages::internalError(asyncResp->res); return; } const double* val = std::get_if(&resp); if (val == nullptr) { BMCWEB_LOG_ERROR << "Invalid response while getting progress"; messages::internalError(asyncResp->res); return; } if (*val < 1.0) { asyncResp->res.jsonValue["Status"]["State"] = "Starting"; started = true; } }, "org.freedesktop.systemd1", "/org/freedesktop/systemd1", "org.freedesktop.DBus.Properties", "Get", "org.freedesktop.systemd1.Manager", "Progress"); } } void doPatch(crow::Response& res, const crow::Request& req, const std::vector& params) override { std::optional oem; std::optional datetime; std::shared_ptr response = std::make_shared(res); if (!json_util::readJson(req, response->res, "Oem", oem, "DateTime", datetime)) { return; } if (oem) { std::optional openbmc; if (!redfish::json_util::readJson(*oem, res, "OpenBmc", openbmc)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << oem->dump(); return; } if (openbmc) { std::optional fan; if (!redfish::json_util::readJson(*openbmc, res, "Fan", fan)) { BMCWEB_LOG_ERROR << "Line:" << __LINE__ << ", Illegal Property " << openbmc->dump(); return; } if (fan) { auto pid = std::make_shared(response, *fan); pid->run(); } } } if (datetime) { setDateTime(response, std::move(*datetime)); } } void setDateTime(std::shared_ptr aResp, std::string datetime) const { BMCWEB_LOG_DEBUG << "Set date time: " << datetime; std::stringstream stream(datetime); // Convert from ISO 8601 to boost local_time // (BMC only has time in UTC) boost::posix_time::ptime posixTime; boost::posix_time::ptime epoch(boost::gregorian::date(1970, 1, 1)); // Facet gets deleted with the stringsteam auto ifc = std::make_unique( "%Y-%m-%d %H:%M:%S%F %ZP"); stream.imbue(std::locale(stream.getloc(), ifc.release())); boost::local_time::local_date_time ldt( boost::local_time::not_a_date_time); if (stream >> ldt) { posixTime = ldt.utc_time(); boost::posix_time::time_duration dur = posixTime - epoch; uint64_t durMicroSecs = static_cast(dur.total_microseconds()); crow::connections::systemBus->async_method_call( [aResp{std::move(aResp)}, datetime{std::move(datetime)}]( const boost::system::error_code ec) { if (ec) { BMCWEB_LOG_DEBUG << "Failed to set elapsed time. " "DBUS response error " << ec; messages::internalError(aResp->res); return; } aResp->res.jsonValue["DateTime"] = datetime; }, "xyz.openbmc_project.Time.Manager", "/xyz/openbmc_project/time/bmc", "org.freedesktop.DBus.Properties", "Set", "xyz.openbmc_project.Time.EpochTime", "Elapsed", std::variant(durMicroSecs)); } else { messages::propertyValueFormatError(aResp->res, datetime, "DateTime"); return; } } std::string uuid; }; class ManagerCollection : public Node { public: ManagerCollection(CrowApp& app) : Node(app, "/redfish/v1/Managers/") { entityPrivileges = { {boost::beast::http::verb::get, {{"Login"}}}, {boost::beast::http::verb::head, {{"Login"}}}, {boost::beast::http::verb::patch, {{"ConfigureManager"}}}, {boost::beast::http::verb::put, {{"ConfigureManager"}}}, {boost::beast::http::verb::delete_, {{"ConfigureManager"}}}, {boost::beast::http::verb::post, {{"ConfigureManager"}}}}; } private: void doGet(crow::Response& res, const crow::Request& req, const std::vector& params) override { // Collections don't include the static data added by SubRoute // because it has a duplicate entry for members res.jsonValue["@odata.id"] = "/redfish/v1/Managers"; res.jsonValue["@odata.type"] = "#ManagerCollection.ManagerCollection"; res.jsonValue["@odata.context"] = "/redfish/v1/$metadata#ManagerCollection.ManagerCollection"; res.jsonValue["Name"] = "Manager Collection"; res.jsonValue["Members@odata.count"] = 1; res.jsonValue["Members"] = { {{"@odata.id", "/redfish/v1/Managers/bmc"}}}; res.end(); } }; } // namespace redfish