blob: e7b1113355366e44cb394b2b951f8f03c95527b2 [file] [log] [blame]
/*
// 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 <boost/container/flat_map.hpp>
#include <boost/format.hpp>
#include <node.hpp>
#include <utils/collection.hpp>
#include <utils/json_utils.hpp>
namespace redfish
{
using DimmProperty =
std::variant<std::string, std::vector<uint32_t>, std::vector<uint16_t>,
uint64_t, uint32_t, uint16_t, uint8_t, bool>;
using DimmProperties = boost::container::flat_map<std::string, DimmProperty>;
inline void dimmPropToHex(const std::shared_ptr<AsyncResp>& aResp,
const char* key,
const std::pair<std::string, DimmProperty>& property)
{
const uint16_t* value = std::get_if<uint16_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for " << property.first;
return;
}
aResp->res.jsonValue[key] = (boost::format("0x%04x") % *value).str();
}
inline void
getPersistentMemoryProperties(const std::shared_ptr<AsyncResp>& aResp,
const DimmProperties& properties)
{
for (const auto& property : properties)
{
if (property.first == "ModuleManufacturerID")
{
dimmPropToHex(aResp, "ModuleManufacturerID", property);
}
else if (property.first == "ModuleProductID")
{
dimmPropToHex(aResp, "ModuleProductID", property);
}
else if (property.first == "SubsystemVendorID")
{
dimmPropToHex(aResp, "MemorySubsystemControllerManufacturerID",
property);
}
else if (property.first == "SubsystemDeviceID")
{
dimmPropToHex(aResp, "MemorySubsystemControllerProductID",
property);
}
else if (property.first == "VolatileRegionSizeLimitInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for "
"VolatileRegionSizeLimitKiB";
continue;
}
aResp->res.jsonValue["VolatileRegionSizeLimitMiB"] = (*value) >> 10;
}
else if (property.first == "PmRegionSizeLimitInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG
<< "Invalid property type for PmRegioSizeLimitKiB";
continue;
}
aResp->res.jsonValue["PersistentRegionSizeLimitMiB"] =
(*value) >> 10;
}
else if (property.first == "VolatileSizeInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG
<< "Invalid property type for VolatileSizeInKiB";
continue;
}
aResp->res.jsonValue["VolatileSizeMiB"] = (*value) >> 10;
}
else if (property.first == "PmSizeInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for PmSizeInKiB";
continue;
}
aResp->res.jsonValue["NonVolatileSizeMiB"] = (*value) >> 10;
}
else if (property.first == "CacheSizeInKB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for CacheSizeInKB";
continue;
}
aResp->res.jsonValue["CacheSizeMiB"] = (*value >> 10);
}
else if (property.first == "VoltaileRegionMaxSizeInKib")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for "
"VolatileRegionMaxSizeInKib";
continue;
}
aResp->res.jsonValue["VolatileRegionSizeMaxMiB"] = (*value) >> 10;
}
else if (property.first == "PmRegionMaxSizeInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG
<< "Invalid property type for PmRegionMaxSizeInKiB";
continue;
}
aResp->res.jsonValue["PersistentRegionSizeMaxMiB"] = (*value) >> 10;
}
else if (property.first == "AllocationIncrementInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for "
"AllocationIncrementInKiB";
continue;
}
aResp->res.jsonValue["AllocationIncrementMiB"] = (*value) >> 10;
}
else if (property.first == "AllocationAlignmentInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for "
"AllocationAlignmentInKiB";
continue;
}
aResp->res.jsonValue["AllocationAlignmentMiB"] = (*value) >> 10;
}
else if (property.first == "VolatileRegionNumberLimit")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["VolatileRegionNumberLimit"] = *value;
}
else if (property.first == "PmRegionNumberLimit")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["PersistentRegionNumberLimit"] = *value;
}
else if (property.first == "SpareDeviceCount")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["SpareDeviceCount"] = *value;
}
else if (property.first == "IsSpareDeviceInUse")
{
const bool* value = std::get_if<bool>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["IsSpareDeviceEnabled"] = *value;
}
else if (property.first == "IsRankSpareEnabled")
{
const bool* value = std::get_if<bool>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["IsRankSpareEnabled"] = *value;
}
else if (property.first == "MaxAveragePowerLimitmW")
{
const auto* value =
std::get_if<std::vector<uint32_t>>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for "
"MaxAveragePowerLimitmW";
continue;
}
aResp->res.jsonValue["MaxTDPMilliWatts"] = *value;
}
else if (property.first == "ConfigurationLocked")
{
const bool* value = std::get_if<bool>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["ConfigurationLocked"] = *value;
}
else if (property.first == "AllowedMemoryModes")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for FormFactor";
continue;
}
constexpr const std::array<const char*, 3> values{"Volatile",
"PMEM", "Block"};
for (const char* v : values)
{
if (boost::ends_with(*value, v))
{
aResp->res.jsonValue["OperatingMemoryModes "] = v;
break;
}
}
}
else if (property.first == "MemoryMedia")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for MemoryMedia";
continue;
}
constexpr const std::array<const char*, 3> values{"DRAM", "NAND",
"Intel3DXPoint"};
for (const char* v : values)
{
if (boost::ends_with(*value, v))
{
aResp->res.jsonValue["MemoryMedia"] = v;
break;
}
}
}
// PersistantMemory.SecurityCapabilites interface
else if (property.first == "ConfigurationLockCapable" ||
property.first == "DataLockCapable" ||
property.first == "PassphraseCapable")
{
const bool* value = std::get_if<bool>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["SecurityCapabilities"][property.first] =
*value;
}
else if (property.first == "MaxPassphraseCount" ||
property.first == "PassphraseLockLimit")
{
const uint64_t* value = std::get_if<uint64_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["SecurityCapabilities"][property.first] =
*value;
}
}
}
inline void getDimmDataByService(std::shared_ptr<AsyncResp> aResp,
const std::string& dimmId,
const std::string& service,
const std::string& objPath)
{
auto health = std::make_shared<HealthPopulate>(aResp);
health->selfPath = objPath;
health->populate();
BMCWEB_LOG_DEBUG << "Get available system components.";
crow::connections::systemBus->async_method_call(
[dimmId, aResp{std::move(aResp)}](const boost::system::error_code ec,
const DimmProperties& properties) {
if (ec)
{
BMCWEB_LOG_DEBUG << "DBUS response error";
messages::internalError(aResp->res);
return;
}
aResp->res.jsonValue["Id"] = dimmId;
aResp->res.jsonValue["Name"] = "DIMM Slot";
const auto memorySizeProperty = properties.find("MemorySizeInKB");
if (memorySizeProperty != properties.end())
{
const uint32_t* memorySize =
std::get_if<uint32_t>(&memorySizeProperty->second);
if (memorySize == nullptr)
{
// Important property not in desired type
messages::internalError(aResp->res);
return;
}
if (*memorySize == 0)
{
// Slot is not populated, set status end return
aResp->res.jsonValue["Status"]["State"] = "Absent";
aResp->res.jsonValue["Status"]["Health"] = "OK";
// HTTP Code will be set up automatically, just return
return;
}
aResp->res.jsonValue["CapacityMiB"] = (*memorySize >> 10);
}
aResp->res.jsonValue["Status"]["State"] = "Enabled";
aResp->res.jsonValue["Status"]["Health"] = "OK";
for (const auto& property : properties)
{
if (property.first == "MemoryDataWidth")
{
const uint16_t* value =
std::get_if<uint16_t>(&property.second);
if (value == nullptr)
{
continue;
}
aResp->res.jsonValue["DataWidthBits"] = *value;
}
else if (property.first == "PartNumber")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
continue;
}
aResp->res.jsonValue["PartNumber"] = *value;
}
else if (property.first == "SerialNumber")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
continue;
}
aResp->res.jsonValue["SerialNumber"] = *value;
}
else if (property.first == "Manufacturer")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
continue;
}
aResp->res.jsonValue["Manufacturer"] = *value;
}
else if (property.first == "RevisionCode")
{
const uint16_t* value =
std::get_if<uint16_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG
<< "Invalid property type for RevisionCode";
continue;
}
aResp->res.jsonValue["FirmwareRevision"] =
std::to_string(*value);
}
else if (property.first == "MemoryTotalWidth")
{
const uint16_t* value =
std::get_if<uint16_t>(&property.second);
if (value == nullptr)
{
continue;
}
aResp->res.jsonValue["BusWidthBits"] = *value;
}
else if (property.first == "ECC")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for ECC";
continue;
}
constexpr const std::array<const char*, 4> values{
"NoECC", "SingleBitECC", "MultiBitECC",
"AddressParity"};
for (const char* v : values)
{
if (boost::ends_with(*value, v))
{
aResp->res.jsonValue["ErrorCorrection"] = v;
break;
}
}
}
else if (property.first == "FormFactor")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG
<< "Invalid property type for FormFactor";
continue;
}
constexpr const std::array<const char*, 11> values{
"RDIMM", "UDIMM", "SO_DIMM",
"LRDIMM", "Mini_RDIMM", "Mini_UDIMM",
"SO_RDIMM_72b", "SO_UDIMM_72b", "SO_DIMM_16b",
"SO_DIMM_32b", "Die"};
for (const char* v : values)
{
if (boost::ends_with(*value, v))
{
aResp->res.jsonValue["BaseModuleType"] = v;
break;
}
}
}
else if (property.first == "AllowedSpeedsMT")
{
const std::vector<uint16_t>* value =
std::get_if<std::vector<uint16_t>>(&property.second);
if (value == nullptr)
{
continue;
}
nlohmann::json& jValue =
aResp->res.jsonValue["AllowedSpeedsMHz"];
jValue = nlohmann::json::array();
for (uint16_t subVal : *value)
{
jValue.push_back(subVal);
}
}
else if (property.first == "MemoryAttributes")
{
const uint8_t* value =
std::get_if<uint8_t>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG
<< "Invalid property type for MemoryAttributes";
continue;
}
aResp->res.jsonValue["RankCount"] =
static_cast<uint64_t>(*value);
}
else if (property.first == "MemoryConfiguredSpeedInMhz")
{
const uint16_t* value =
std::get_if<uint16_t>(&property.second);
if (value == nullptr)
{
continue;
}
aResp->res.jsonValue["OperatingSpeedMhz"] = *value;
}
else if (property.first == "MemoryType")
{
const auto* value =
std::get_if<std::string>(&property.second);
if (value != nullptr)
{
size_t idx = value->rfind('.');
if (idx == std::string::npos ||
idx + 1 >= value->size())
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG << "Invalid property type for "
"MemoryType";
}
std::string result = value->substr(idx + 1);
aResp->res.jsonValue["MemoryDeviceType"] = result;
if (value->find("DDR") != std::string::npos)
{
aResp->res.jsonValue["MemoryType"] = "DRAM";
}
else if (boost::ends_with(*value, "Logical"))
{
aResp->res.jsonValue["MemoryType"] = "IntelOptane";
}
}
}
// memory location interface
else if (property.first == "Channel" ||
property.first == "MemoryController" ||
property.first == "Slot" || property.first == "Socket")
{
const std::string* value =
std::get_if<std::string>(&property.second);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
aResp->res.jsonValue["MemoryLocation"][property.first] =
*value;
}
else
{
getPersistentMemoryProperties(aResp, properties);
}
}
},
service, objPath, "org.freedesktop.DBus.Properties", "GetAll", "");
}
inline void getDimmPartitionData(std::shared_ptr<AsyncResp> aResp,
const std::string& service,
const std::string& path)
{
crow::connections::systemBus->async_method_call(
[aResp{std::move(aResp)}](
const boost::system::error_code ec,
const boost::container::flat_map<
std::string, std::variant<std::string, uint64_t, uint32_t,
bool>>& properties) {
if (ec)
{
BMCWEB_LOG_DEBUG << "DBUS response error";
messages::internalError(aResp->res);
return;
}
nlohmann::json& partition =
aResp->res.jsonValue["Regions"].emplace_back(
nlohmann::json::object());
for (const auto& [key, val] : properties)
{
if (key == "MemoryClassification")
{
const std::string* value = std::get_if<std::string>(&val);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
partition[key] = *value;
}
else if (key == "OffsetInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&val);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
partition["OffsetMiB"] = (*value >> 10);
}
else if (key == "PartitionId")
{
const std::string* value = std::get_if<std::string>(&val);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
partition["RegionId"] = *value;
}
else if (key == "PassphraseState")
{
const bool* value = std::get_if<bool>(&val);
if (value == nullptr)
{
messages::internalError(aResp->res);
continue;
}
partition["PassphraseEnabled"] = *value;
}
else if (key == "SizeInKiB")
{
const uint64_t* value = std::get_if<uint64_t>(&val);
if (value == nullptr)
{
messages::internalError(aResp->res);
BMCWEB_LOG_DEBUG
<< "Invalid property type for SizeInKiB";
continue;
}
partition["SizeMiB"] = (*value >> 10);
}
}
},
service, path, "org.freedesktop.DBus.Properties", "GetAll",
"xyz.openbmc_project.Inventory.Item.PersistentMemory.Partition");
}
inline void getDimmData(std::shared_ptr<AsyncResp> aResp,
const std::string& dimmId)
{
BMCWEB_LOG_DEBUG << "Get available system dimm resources.";
crow::connections::systemBus->async_method_call(
[dimmId, aResp{std::move(aResp)}](
const boost::system::error_code ec,
const boost::container::flat_map<
std::string, boost::container::flat_map<
std::string, std::vector<std::string>>>&
subtree) {
if (ec)
{
BMCWEB_LOG_DEBUG << "DBUS response error";
messages::internalError(aResp->res);
return;
}
bool found = false;
for (const auto& [path, object] : subtree)
{
if (path.find(dimmId) != std::string::npos)
{
for (const auto& [service, interfaces] : object)
{
if (!found &&
(std::find(
interfaces.begin(), interfaces.end(),
"xyz.openbmc_project.Inventory.Item.Dimm") !=
interfaces.end()))
{
getDimmDataByService(aResp, dimmId, service, path);
found = true;
}
// partitions are separate as there can be multiple per
// device, i.e.
// /xyz/openbmc_project/Inventory/Item/Dimm1/Partition1
// /xyz/openbmc_project/Inventory/Item/Dimm1/Partition2
if (std::find(interfaces.begin(), interfaces.end(),
"xyz.openbmc_project.Inventory.Item."
"PersistentMemory.Partition") !=
interfaces.end())
{
getDimmPartitionData(aResp, service, path);
}
}
}
}
// Object not found
if (!found)
{
messages::resourceNotFound(aResp->res, "Memory", dimmId);
}
return;
},
"xyz.openbmc_project.ObjectMapper",
"/xyz/openbmc_project/object_mapper",
"xyz.openbmc_project.ObjectMapper", "GetSubTree",
"/xyz/openbmc_project/inventory", 0,
std::array<const char*, 2>{
"xyz.openbmc_project.Inventory.Item.Dimm",
"xyz.openbmc_project.Inventory.Item.PersistentMemory.Partition"});
}
class MemoryCollection : public Node
{
public:
/*
* Default Constructor
*/
MemoryCollection(App& app) : Node(app, "/redfish/v1/Systems/system/Memory/")
{
entityPrivileges = {
{boost::beast::http::verb::get, {{"Login"}}},
{boost::beast::http::verb::head, {{"Login"}}},
{boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
{boost::beast::http::verb::put, {{"ConfigureComponents"}}},
{boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
{boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
}
private:
/**
* Functions triggers appropriate requests on DBus
*/
void doGet(crow::Response& res, const crow::Request&,
const std::vector<std::string>&) override
{
res.jsonValue["@odata.type"] = "#MemoryCollection.MemoryCollection";
res.jsonValue["Name"] = "Memory Module Collection";
res.jsonValue["@odata.id"] = "/redfish/v1/Systems/system/Memory";
auto asyncResp = std::make_shared<AsyncResp>(res);
collection_util::getCollectionMembers(
asyncResp, "/redfish/v1/Systems/system/Memory",
{"xyz.openbmc_project.Inventory.Item.Dimm"});
}
};
class Memory : public Node
{
public:
/*
* Default Constructor
*/
Memory(App& app) :
Node(app, "/redfish/v1/Systems/system/Memory/<str>/", std::string())
{
entityPrivileges = {
{boost::beast::http::verb::get, {{"Login"}}},
{boost::beast::http::verb::head, {{"Login"}}},
{boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
{boost::beast::http::verb::put, {{"ConfigureComponents"}}},
{boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
{boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
}
private:
/**
* Functions triggers appropriate requests on DBus
*/
void doGet(crow::Response& res, const crow::Request&,
const std::vector<std::string>& params) override
{
// Check if there is required param, truly entering this shall be
// impossible
if (params.size() != 1)
{
messages::internalError(res);
res.end();
return;
}
const std::string& dimmId = params[0];
res.jsonValue["@odata.type"] = "#Memory.v1_7_0.Memory";
res.jsonValue["@odata.id"] =
"/redfish/v1/Systems/system/Memory/" + dimmId;
auto asyncResp = std::make_shared<AsyncResp>(res);
getDimmData(asyncResp, dimmId);
}
};
} // namespace redfish