Allow more than 256 IPMI sensors in a system
Systems with more than 255 IPMI sensors report strange values for
sensors assigned beyond the 255 limit for a single LUN. This is due to
the sensor number assignment rolling over to 0, and then applying the
most recent SDR values to the sensor calculation.
This change assigns up to 255 sensors to a single LUN (0xFF is
reserved). When the 256th sensor is assigned the sensor gets placed in
the LUN. LUNs 0, 1, and 3 are used, as LUN 2 is special.
Another guard has been created that throws an exception when more than
765 sensors have been assigned. This makes it obvious to the system
designer the limit for IPMI sensors has been reached.
Tested:
Forced the maxmimum number of sensors in the system to be 63 per LUN.
"ipmitool sdr elist" returned correct values for every sensor even
when the sensor number displayed in the printout matched the value of
a sensor printed earlier.
"ipmitool sensor get P3V3" returns a valid reading. In my test "P3V3"
was in LUN1.
"ipmitool raw 4 0x20 0" reported 63 sensors for LUN0, and that LUN0
and LUN1 had sensors.
"ipmitool raw -l 1 4 0x20 0" reported the remaining sensor count.
"ipmitool raw 0xa 0x2d 0" returns the correct value for LUN0 Sensor 0
"ipmitool raw -l 1 0xa 0x2d 0" returns the correct value for LUN1
Sensor 0
Change-Id: Ic1708b66339e57b1b765f5a9a684e829a0ec8fba
Signed-off-by: Johnathan Mantey <johnathanx.mantey@intel.com>
diff --git a/include/sdrutils.hpp b/include/sdrutils.hpp
index b3d7689..43a53fd 100644
--- a/include/sdrutils.hpp
+++ b/include/sdrutils.hpp
@@ -48,6 +48,13 @@
using SensorNumMap = boost::bimap<int, std::string>;
+static constexpr uint16_t maxSensorsPerLUN = 255;
+static constexpr uint16_t maxIPMISensors = (maxSensorsPerLUN * 3);
+static constexpr uint16_t lun1Sensor0 = 0x100;
+static constexpr uint16_t lun3Sensor0 = 0x300;
+static constexpr uint16_t invalidSensorNumber = 0xFFFF;
+static constexpr uint8_t reservedSensorNumber = 0xFF;
+
namespace details
{
inline static bool getSensorSubtree(std::shared_ptr<SensorSubTree>& subtree)
@@ -131,11 +138,28 @@
sensorNumMapPtr = std::make_shared<SensorNumMap>();
- uint8_t sensorNum = 0;
+ uint16_t sensorNum = 0;
+ uint16_t sensorIndex = 0;
for (const auto& sensor : *sensorTree)
{
sensorNumMapPtr->insert(
- SensorNumMap::value_type(sensorNum++, sensor.first));
+ SensorNumMap::value_type(sensorNum, sensor.first));
+ sensorIndex++;
+ if (sensorIndex == maxSensorsPerLUN)
+ {
+ sensorIndex = lun1Sensor0;
+ }
+ else if (sensorIndex == (lun1Sensor0 | maxSensorsPerLUN))
+ {
+ // Skip assigning LUN 0x2 any sensors
+ sensorIndex = lun3Sensor0;
+ }
+ else if (sensorIndex == (lun3Sensor0 | maxSensorsPerLUN))
+ {
+ // this is an error, too many IPMI sensors
+ throw std::out_of_range("Maximum number of IPMI sensors exceeded.");
+ }
+ sensorNum = sensorIndex;
}
sensorNumMap = sensorNumMapPtr;
sensorNumMapUpated = true;
@@ -214,13 +238,13 @@
return sensorType;
}
-inline static uint8_t getSensorNumberFromPath(const std::string& path)
+inline static uint16_t getSensorNumberFromPath(const std::string& path)
{
std::shared_ptr<SensorNumMap> sensorNumMapPtr;
details::getSensorNumMap(sensorNumMapPtr);
if (!sensorNumMapPtr)
{
- return 0xFF;
+ return invalidSensorNumber;
}
try
@@ -230,7 +254,7 @@
catch (std::out_of_range& e)
{
phosphor::logging::log<phosphor::logging::level::ERR>(e.what());
- return 0xFF;
+ return invalidSensorNumber;
}
}
@@ -240,7 +264,7 @@
return 0x1; // reading type = threshold
}
-inline static std::string getPathFromSensorNumber(uint8_t sensorNum)
+inline static std::string getPathFromSensorNumber(uint16_t sensorNum)
{
std::shared_ptr<SensorNumMap> sensorNumMapPtr;
details::getSensorNumMap(sensorNumMapPtr);
diff --git a/include/sensorcommands.hpp b/include/sensorcommands.hpp
index c0d7853..a7f9fb2 100644
--- a/include/sensorcommands.hpp
+++ b/include/sensorcommands.hpp
@@ -121,7 +121,8 @@
namespace ipmi
{
extern SensorSubTree sensorTree;
-static ipmi_ret_t getSensorConnection(uint8_t sensnum, std::string& connection,
+static ipmi_ret_t getSensorConnection(ipmi::Context::ptr ctx, uint8_t sensnum,
+ std::string& connection,
std::string& path)
{
if (sensorTree.empty() && !getSensorSubtree(sensorTree))
@@ -129,22 +130,22 @@
return IPMI_CC_RESPONSE_ERROR;
}
- if (sensorTree.size() < (sensnum + 1))
+ if (ctx == nullptr)
+ {
+ return IPMI_CC_RESPONSE_ERROR;
+ }
+
+ path = getPathFromSensorNumber((ctx->lun << 8) | sensnum);
+ if (path.empty())
{
return IPMI_CC_INVALID_FIELD_REQUEST;
}
- uint8_t sensorIndex = sensnum;
for (const auto& sensor : sensorTree)
{
- if (sensorIndex-- == 0)
+ if (path == sensor.first)
{
- if (!sensor.second.size())
- {
- return IPMI_CC_RESPONSE_ERROR;
- }
connection = sensor.second.begin()->first;
- path = sensor.first;
break;
}
}
diff --git a/src/sensorcommands.cpp b/src/sensorcommands.cpp
index 06b4374..98051e5 100644
--- a/src/sensorcommands.cpp
+++ b/src/sensorcommands.cpp
@@ -49,6 +49,8 @@
using ManagedObjectType =
std::map<sdbusplus::message::object_path,
std::map<std::string, std::map<std::string, DbusVariant>>>;
+using SDRObjectType =
+ boost::container::flat_map<uint16_t, std::vector<uint8_t>>;
static constexpr int sensorMapUpdatePeriod = 10;
@@ -59,8 +61,12 @@
static uint16_t sdrReservationID;
static uint32_t sdrLastAdd = noTimestamp;
static uint32_t sdrLastRemove = noTimestamp;
+static constexpr size_t lastRecordIndex = 0xFFFF;
+static constexpr int GENERAL_ERROR = -1;
SensorSubTree sensorTree;
+SDRObjectType sensorDataRecords;
+
static boost::container::flat_map<std::string, ManagedObjectType> SensorCache;
// Specify the comparison required to sort and find char* map objects
@@ -387,19 +393,19 @@
}
ipmi::RspType<uint8_t, uint8_t, uint8_t, std::optional<uint8_t>>
- ipmiSenGetSensorReading(boost::asio::yield_context yield, uint8_t sensnum)
+ ipmiSenGetSensorReading(ipmi::Context::ptr ctx, uint8_t sensnum)
{
std::string connection;
std::string path;
- auto status = getSensorConnection(sensnum, connection, path);
+ auto status = getSensorConnection(ctx, sensnum, connection, path);
if (status)
{
return ipmi::response(status);
}
SensorMap sensorMap;
- if (!getSensorMap(yield, connection, path, sensorMap))
+ if (!getSensorMap(ctx->yield, connection, path, sensorMap))
{
return ipmi::responseResponseError();
}
@@ -533,13 +539,13 @@
* @returns IPMI completion code
*/
ipmi::RspType<> ipmiSenSetSensorThresholds(
- boost::asio::yield_context yield, uint8_t sensorNum,
- bool lowerNonCriticalThreshMask, bool lowerCriticalThreshMask,
- bool lowerNonRecovThreshMask, bool upperNonCriticalThreshMask,
- bool upperCriticalThreshMask, bool upperNonRecovThreshMask,
- uint2_t reserved, uint8_t lowerNonCritical, uint8_t lowerCritical,
- uint8_t lowerNonRecoverable, uint8_t upperNonCritical,
- uint8_t upperCritical, uint8_t upperNonRecoverable)
+ ipmi::Context::ptr ctx, uint8_t sensorNum, bool lowerNonCriticalThreshMask,
+ bool lowerCriticalThreshMask, bool lowerNonRecovThreshMask,
+ bool upperNonCriticalThreshMask, bool upperCriticalThreshMask,
+ bool upperNonRecovThreshMask, uint2_t reserved, uint8_t lowerNonCritical,
+ uint8_t lowerCritical, uint8_t lowerNonRecoverable,
+ uint8_t upperNonCritical, uint8_t upperCritical,
+ uint8_t upperNonRecoverable)
{
constexpr uint8_t thresholdMask = 0xFF;
@@ -565,13 +571,13 @@
std::string connection;
std::string path;
- ipmi::Cc status = getSensorConnection(sensorNum, connection, path);
+ ipmi::Cc status = getSensorConnection(ctx, sensorNum, connection, path);
if (status)
{
return ipmi::response(status);
}
SensorMap sensorMap;
- if (!getSensorMap(yield, connection, path, sensorMap))
+ if (!getSensorMap(ctx->yield, connection, path, sensorMap))
{
return ipmi::responseResponseError();
}
@@ -760,20 +766,19 @@
uint8_t, // upperNC
uint8_t, // upperCrit
uint8_t> // upperNRecoverable
- ipmiSenGetSensorThresholds(boost::asio::yield_context yield,
- uint8_t sensorNumber)
+ ipmiSenGetSensorThresholds(ipmi::Context::ptr ctx, uint8_t sensorNumber)
{
std::string connection;
std::string path;
- auto status = getSensorConnection(sensorNumber, connection, path);
+ auto status = getSensorConnection(ctx, sensorNumber, connection, path);
if (status)
{
return ipmi::response(status);
}
SensorMap sensorMap;
- if (!getSensorMap(yield, connection, path, sensorMap))
+ if (!getSensorMap(ctx->yield, connection, path, sensorMap))
{
return ipmi::responseResponseError();
}
@@ -843,8 +848,7 @@
uint8_t, // assertionEnabledMsb
uint8_t, // deassertionEnabledLsb
uint8_t> // deassertionEnabledMsb
- ipmiSenGetSensorEventEnable(boost::asio::yield_context yield,
- uint8_t sensorNum)
+ ipmiSenGetSensorEventEnable(ipmi::Context::ptr ctx, uint8_t sensorNum)
{
std::string connection;
std::string path;
@@ -855,14 +859,14 @@
uint8_t deassertionEnabledLsb = 0;
uint8_t deassertionEnabledMsb = 0;
- auto status = getSensorConnection(sensorNum, connection, path);
+ auto status = getSensorConnection(ctx, sensorNum, connection, path);
if (status)
{
return ipmi::response(status);
}
SensorMap sensorMap;
- if (!getSensorMap(yield, connection, path, sensorMap))
+ if (!getSensorMap(ctx->yield, connection, path, sensorMap))
{
return ipmi::responseResponseError();
}
@@ -938,17 +942,16 @@
std::bitset<16>, // assertions
std::bitset<16> // deassertion
>
- ipmiSenGetSensorEventStatus(boost::asio::yield_context yield,
- uint8_t sensorNum)
+ ipmiSenGetSensorEventStatus(ipmi::Context::ptr ctx, uint8_t sensorNum)
{
- if (sensorNum == 0xFF)
+ if (sensorNum == reservedSensorNumber)
{
return ipmi::responseInvalidFieldRequest();
}
std::string connection;
std::string path;
- auto status = getSensorConnection(sensorNum, connection, path);
+ auto status = getSensorConnection(ctx, sensorNum, connection, path);
if (status)
{
phosphor::logging::log<phosphor::logging::level::ERR>(
@@ -958,7 +961,7 @@
}
SensorMap sensorMap;
- if (!getSensorMap(yield, connection, path, sensorMap))
+ if (!getSensorMap(ctx->yield, connection, path, sensorMap))
{
phosphor::logging::log<phosphor::logging::level::ERR>(
"ipmiSenGetSensorEventStatus: Sensor Mapping Error",
@@ -1074,6 +1077,428 @@
return ipmi::responseSuccess(sensorEventStatus, assertions, deassertions);
}
+static int getSensorDataRecords(ipmi::Context::ptr ctx)
+{
+
+ size_t recordID = 0;
+ size_t fruCount = 0;
+
+ ipmi::Cc ret = ipmi::storage::getFruSdrCount(ctx, fruCount);
+ if (ret != ipmi::ccSuccess)
+ {
+ return GENERAL_ERROR;
+ }
+
+ size_t lastRecord = sensorTree.size() + fruCount +
+ ipmi::storage::type12Count +
+ ipmi::storage::nmDiscoverySDRCount - 1;
+ if (lastRecord > lastRecordIndex)
+ {
+ return GENERAL_ERROR;
+ }
+
+ std::string connection;
+ std::string path;
+ for (const auto& sensor : sensorTree)
+ {
+
+ connection = sensor.second.begin()->first;
+ path = sensor.first;
+
+ SensorMap sensorMap;
+ if (!getSensorMap(ctx->yield, connection, path, sensorMap))
+ {
+ return GENERAL_ERROR;
+ }
+ uint16_t sensorNum = getSensorNumberFromPath(path);
+ if (sensorNum == invalidSensorNumber)
+ {
+ return GENERAL_ERROR;
+ }
+ uint8_t sensornumber = static_cast<uint8_t>(sensorNum);
+ uint8_t lun = static_cast<uint8_t>(sensorNum >> 8);
+
+ get_sdr::SensorDataFullRecord record = {0};
+
+ get_sdr::header::set_record_id(
+ recordID,
+ reinterpret_cast<get_sdr::SensorDataRecordHeader*>(&record));
+ record.header.sdr_version = ipmiSdrVersion;
+ record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
+ record.header.record_length = sizeof(get_sdr::SensorDataFullRecord) -
+ sizeof(get_sdr::SensorDataRecordHeader);
+ record.key.owner_id = 0x20;
+ record.key.owner_lun = lun;
+ record.key.sensor_number = sensornumber;
+
+ record.body.sensor_capabilities = 0x68; // auto rearm - todo hysteresis
+ record.body.sensor_type = getSensorTypeFromPath(path);
+ std::string type = getSensorTypeStringFromPath(path);
+ auto typeCstr = type.c_str();
+ auto findUnits = sensorUnits.find(typeCstr);
+ if (findUnits != sensorUnits.end())
+ {
+ record.body.sensor_units_2_base =
+ static_cast<uint8_t>(findUnits->second);
+ } // else default 0x0 unspecified
+
+ record.body.event_reading_type = getSensorEventTypeFromPath(path);
+
+ auto sensorObject = sensorMap.find("xyz.openbmc_project.Sensor.Value");
+ if (sensorObject == sensorMap.end())
+ {
+ return GENERAL_ERROR;
+ }
+
+ uint8_t entityId = 0;
+ uint8_t entityInstance = 0x01;
+
+ // follow the association chain to get the parent board's entityid and
+ // entityInstance
+ updateIpmiFromAssociation(path, sensorMap, entityId, entityInstance);
+
+ record.body.entity_id = entityId;
+ record.body.entity_instance = entityInstance;
+
+ auto maxObject = sensorObject->second.find("MaxValue");
+ auto minObject = sensorObject->second.find("MinValue");
+
+ // If min and/or max are left unpopulated,
+ // then default to what a signed byte would be, namely (-128,127) range.
+ auto max = static_cast<double>(std::numeric_limits<int8_t>::max());
+ auto min = static_cast<double>(std::numeric_limits<int8_t>::lowest());
+ if (maxObject != sensorObject->second.end())
+ {
+ max = std::visit(VariantToDoubleVisitor(), maxObject->second);
+ }
+
+ if (minObject != sensorObject->second.end())
+ {
+ min = std::visit(VariantToDoubleVisitor(), minObject->second);
+ }
+
+ int16_t mValue = 0;
+ int8_t rExp = 0;
+ int16_t bValue = 0;
+ int8_t bExp = 0;
+ bool bSigned = false;
+
+ if (!getSensorAttributes(max, min, mValue, rExp, bValue, bExp, bSigned))
+ {
+ return GENERAL_ERROR;
+ }
+
+ // The record.body is a struct SensorDataFullRecordBody
+ // from sensorhandler.hpp in phosphor-ipmi-host.
+ // The meaning of these bits appears to come from
+ // table 43.1 of the IPMI spec.
+ // The above 5 sensor attributes are stuffed in as follows:
+ // Byte 21 = AA000000 = analog interpretation, 10 signed, 00 unsigned
+ // Byte 22-24 are for other purposes
+ // Byte 25 = MMMMMMMM = LSB of M
+ // Byte 26 = MMTTTTTT = MSB of M (signed), and Tolerance
+ // Byte 27 = BBBBBBBB = LSB of B
+ // Byte 28 = BBAAAAAA = MSB of B (signed), and LSB of Accuracy
+ // Byte 29 = AAAAEE00 = MSB of Accuracy, exponent of Accuracy
+ // Byte 30 = RRRRBBBB = rExp (signed), bExp (signed)
+
+ // apply M, B, and exponents, M and B are 10 bit values, exponents are 4
+ record.body.m_lsb = mValue & 0xFF;
+
+ uint8_t mBitSign = (mValue < 0) ? 1 : 0;
+ uint8_t mBitNine = (mValue & 0x0100) >> 8;
+
+ // move the smallest bit of the MSB into place (bit 9)
+ // the MSbs are bits 7:8 in m_msb_and_tolerance
+ record.body.m_msb_and_tolerance = (mBitSign << 7) | (mBitNine << 6);
+
+ record.body.b_lsb = bValue & 0xFF;
+
+ uint8_t bBitSign = (bValue < 0) ? 1 : 0;
+ uint8_t bBitNine = (bValue & 0x0100) >> 8;
+
+ // move the smallest bit of the MSB into place (bit 9)
+ // the MSbs are bits 7:8 in b_msb_and_accuracy_lsb
+ record.body.b_msb_and_accuracy_lsb = (bBitSign << 7) | (bBitNine << 6);
+
+ uint8_t rExpSign = (rExp < 0) ? 1 : 0;
+ uint8_t rExpBits = rExp & 0x07;
+
+ uint8_t bExpSign = (bExp < 0) ? 1 : 0;
+ uint8_t bExpBits = bExp & 0x07;
+
+ // move rExp and bExp into place
+ record.body.r_b_exponents =
+ (rExpSign << 7) | (rExpBits << 4) | (bExpSign << 3) | bExpBits;
+
+ // Set the analog reading byte interpretation accordingly
+ record.body.sensor_units_1 = (bSigned ? 1 : 0) << 7;
+
+ // TODO(): Perhaps care about Tolerance, Accuracy, and so on
+ // These seem redundant, but derivable from the above 5 attributes
+ // Original comment said "todo fill out rest of units"
+
+ // populate sensor name from path
+ std::string name;
+ size_t nameStart = path.rfind("/");
+ if (nameStart != std::string::npos)
+ {
+ name = path.substr(nameStart + 1, std::string::npos - nameStart);
+ }
+
+ std::replace(name.begin(), name.end(), '_', ' ');
+ if (name.size() > FULL_RECORD_ID_STR_MAX_LENGTH)
+ {
+ // try to not truncate by replacing common words
+ constexpr std::array<std::pair<const char*, const char*>, 2>
+ replaceWords = {std::make_pair("Output", "Out"),
+ std::make_pair("Input", "In")};
+ for (const auto& [find, replace] : replaceWords)
+ {
+ boost::replace_all(name, find, replace);
+ }
+
+ name.resize(FULL_RECORD_ID_STR_MAX_LENGTH);
+ }
+ record.body.id_string_info = name.size();
+ std::strncpy(record.body.id_string, name.c_str(),
+ sizeof(record.body.id_string));
+
+ IPMIThresholds thresholdData;
+ try
+ {
+ thresholdData = getIPMIThresholds(sensorMap);
+ }
+ catch (std::exception&)
+ {
+ return GENERAL_ERROR;
+ }
+
+ if (thresholdData.criticalHigh)
+ {
+ record.body.upper_critical_threshold = *thresholdData.criticalHigh;
+ record.body.supported_deassertions[1] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::criticalThreshold);
+ record.body.supported_deassertions[1] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::upperCriticalGoingHigh);
+ record.body.supported_assertions[1] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::upperCriticalGoingHigh);
+ record.body.discrete_reading_setting_mask[0] |=
+ static_cast<uint8_t>(IPMISensorReadingByte3::upperCritical);
+ }
+ if (thresholdData.warningHigh)
+ {
+ record.body.upper_noncritical_threshold =
+ *thresholdData.warningHigh;
+ record.body.supported_deassertions[1] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::nonCriticalThreshold);
+ record.body.supported_deassertions[0] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::upperNonCriticalGoingHigh);
+ record.body.supported_assertions[0] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::upperNonCriticalGoingHigh);
+ record.body.discrete_reading_setting_mask[0] |=
+ static_cast<uint8_t>(IPMISensorReadingByte3::upperNonCritical);
+ }
+ if (thresholdData.criticalLow)
+ {
+ record.body.lower_critical_threshold = *thresholdData.criticalLow;
+ record.body.supported_assertions[1] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::criticalThreshold);
+ record.body.supported_deassertions[0] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::lowerCriticalGoingLow);
+ record.body.supported_assertions[0] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::lowerCriticalGoingLow);
+ record.body.discrete_reading_setting_mask[0] |=
+ static_cast<uint8_t>(IPMISensorReadingByte3::lowerCritical);
+ }
+ if (thresholdData.warningLow)
+ {
+ record.body.lower_noncritical_threshold = *thresholdData.warningLow;
+ record.body.supported_assertions[1] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::nonCriticalThreshold);
+ record.body.supported_deassertions[0] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::lowerNonCriticalGoingLow);
+ record.body.supported_assertions[0] |= static_cast<uint8_t>(
+ IPMISensorEventEnableThresholds::lowerNonCriticalGoingLow);
+ record.body.discrete_reading_setting_mask[0] |=
+ static_cast<uint8_t>(IPMISensorReadingByte3::lowerNonCritical);
+ }
+
+ // everything that is readable is setable
+ record.body.discrete_reading_setting_mask[1] =
+ record.body.discrete_reading_setting_mask[0];
+
+ // insert the record into the map
+ std::vector<uint8_t> sdr;
+ sdr.insert(sdr.end(), (uint8_t*)&record,
+ ((uint8_t*)&record) + sizeof(record));
+ sensorDataRecords.insert_or_assign(recordID, sdr);
+ recordID++;
+ }
+
+ size_t nonSensorRecCount = fruCount + ipmi::storage::type12Count +
+ ipmi::storage::nmDiscoverySDRCount;
+ size_t type12End = fruCount + ipmi::storage::type12Count;
+ do
+ {
+ size_t fruIndex = recordID - sensorTree.size();
+
+ if (fruIndex >= type12End)
+ {
+ // NM discovery SDR
+ size_t nmDiscoveryIndex = fruIndex - type12End;
+ if (nmDiscoveryIndex >= ipmi::storage::nmDiscoverySDRCount)
+ {
+ return GENERAL_ERROR;
+ }
+
+ std::vector<uint8_t> record =
+ ipmi::storage::getNMDiscoverySDR(nmDiscoveryIndex, recordID);
+ sensorDataRecords.insert_or_assign(recordID, record);
+ }
+ else if (fruIndex >= fruCount)
+ {
+ // handle type 12 hardcoded records
+ size_t type12Index = fruIndex - fruCount;
+ if (type12Index >= ipmi::storage::type12Count)
+ {
+ return GENERAL_ERROR;
+ }
+ std::vector<uint8_t> record =
+ ipmi::storage::getType12SDRs(type12Index, recordID);
+ sensorDataRecords.insert_or_assign(recordID, record);
+ }
+ else
+ {
+ // handle fru records
+ get_sdr::SensorDataFruRecord data;
+ ret = ipmi::storage::getFruSdrs(ctx, fruIndex, data);
+ if (ret != IPMI_CC_OK)
+ {
+ return GENERAL_ERROR;
+ }
+ get_sdr::header::set_record_id(
+ recordID,
+ reinterpret_cast<get_sdr::SensorDataRecordHeader*>(&data));
+
+ std::vector<uint8_t> record;
+ record.insert(record.end(), (uint8_t*)&data,
+ ((uint8_t*)&data) + sizeof(data));
+ sensorDataRecords.insert_or_assign(recordID, record);
+ }
+ recordID++;
+ } while (--nonSensorRecCount);
+ return 0;
+}
+
+/** @brief implements the get SDR Info command
+ * @param count - Operation
+ *
+ * @returns IPMI completion code plus response data
+ * - sdrCount - sensor/SDR count
+ * - lunsAndDynamicPopulation - static/Dynamic sensor population flag
+ */
+static ipmi::RspType<uint8_t, // respcount
+ uint8_t, // dynamic population flags
+ uint32_t // last time a sensor was added
+ >
+ ipmiSensorGetDeviceSdrInfo(ipmi::Context::ptr ctx,
+ std::optional<uint8_t> count)
+{
+ uint8_t sdrCount = 0;
+ // Sensors are dynamically allocated, and there is at least one LUN
+ uint8_t lunsAndDynamicPopulation = 0x80;
+ constexpr uint8_t getSdrCount = 0x01;
+ constexpr uint8_t getSensorCount = 0x00;
+
+ if (!getSensorSubtree(sensorTree) || sensorTree.empty())
+ {
+ return ipmi::responseResponseError();
+ }
+
+ if (sensorDataRecords.empty() && getSensorDataRecords(ctx))
+ {
+ return ipmi::responseResponseError();
+ }
+
+ uint16_t numSensors = sensorTree.size();
+ if (count.value_or(0) == getSdrCount)
+ {
+ // Count the number of Type 1 SDR entries assigned to the LUN
+ for (auto sdr : sensorDataRecords)
+ {
+ get_sdr::SensorDataRecordHeader* hdr =
+ reinterpret_cast<get_sdr::SensorDataRecordHeader*>(
+ sdr.second.data());
+ if (hdr->record_type == get_sdr::SENSOR_DATA_FULL_RECORD)
+ {
+ get_sdr::SensorDataFullRecord* record =
+ reinterpret_cast<get_sdr::SensorDataFullRecord*>(
+ sdr.second.data());
+ if (ctx->lun == record->key.owner_lun)
+ {
+ sdrCount++;
+ }
+ }
+ }
+ }
+ else if (count.value_or(0) == getSensorCount)
+ {
+ // Return the number of sensors attached to the LUN
+ if ((ctx->lun == 0) && (numSensors > 0))
+ {
+ sdrCount =
+ (numSensors > maxSensorsPerLUN) ? maxSensorsPerLUN : numSensors;
+ }
+ else if ((ctx->lun == 1) && (numSensors > maxSensorsPerLUN))
+ {
+ sdrCount = (numSensors > (2 * maxSensorsPerLUN))
+ ? maxSensorsPerLUN
+ : (numSensors - maxSensorsPerLUN) & maxSensorsPerLUN;
+ }
+ else if (ctx->lun == 3)
+ {
+ if (numSensors <= maxIPMISensors)
+ {
+ sdrCount =
+ (numSensors - (2 * maxSensorsPerLUN)) & maxSensorsPerLUN;
+ }
+ else
+ {
+ // error
+ throw std::out_of_range(
+ "Maximum number of IPMI sensors exceeded.");
+ }
+ }
+ }
+ else
+ {
+ return ipmi::responseInvalidFieldRequest();
+ }
+
+ // Get Sensor count. This returns the number of sensors
+ if (numSensors > 0)
+ {
+ lunsAndDynamicPopulation |= 1;
+ }
+ if (numSensors > maxSensorsPerLUN)
+ {
+ lunsAndDynamicPopulation |= 2;
+ }
+ if (numSensors >= (maxSensorsPerLUN * 2))
+ {
+ lunsAndDynamicPopulation |= 8;
+ }
+ if (numSensors > maxIPMISensors)
+ {
+ // error
+ throw std::out_of_range("Maximum number of IPMI sensors exceeded.");
+ }
+
+ return ipmi::responseSuccess(sdrCount, lunsAndDynamicPopulation,
+ sdrLastAdd);
+}
+
/* end sensor commands */
/* storage commands */
@@ -1165,8 +1590,6 @@
ipmiStorageGetSDR(ipmi::Context::ptr ctx, uint16_t reservationID,
uint16_t recordID, uint8_t offset, uint8_t bytesToRead)
{
- constexpr uint16_t lastRecordIndex = 0xFFFF;
-
// reservation required for partial reads with non zero offset into
// record
if ((sdrReservationID == 0 || reservationID != sdrReservationID) && offset)
@@ -1174,6 +1597,11 @@
return ipmi::responseInvalidReservationId();
}
+ if (sensorDataRecords.empty() && getSensorDataRecords(ctx))
+ {
+ return ipmi::responseResponseError();
+ }
+
if (sensorTree.empty() && !getSensorSubtree(sensorTree))
{
return ipmi::responseResponseError();
@@ -1198,319 +1626,19 @@
return ipmi::responseInvalidFieldRequest();
}
- uint16_t nextRecordId = lastRecord > recordID ? recordID + 1 : 0XFFFF;
-
- if (recordID >= sensorTree.size())
+ get_sdr::SensorDataRecordHeader* hdr =
+ reinterpret_cast<get_sdr::SensorDataRecordHeader*>(
+ sensorDataRecords[recordID].data());
+ size_t sdrLength =
+ sizeof(get_sdr::SensorDataRecordHeader) + hdr->record_length;
+ if (sdrLength < (offset + bytesToRead))
{
- std::vector<uint8_t> recordData;
- size_t fruIndex = recordID - sensorTree.size();
- size_t type12End = fruCount + ipmi::storage::type12Count;
-
- if (fruIndex >= type12End)
- {
- // NM discovery SDR
- size_t nmDiscoveryIndex = fruIndex - type12End;
- if (nmDiscoveryIndex >= ipmi::storage::nmDiscoverySDRCount ||
- offset > sizeof(NMDiscoveryRecord))
- {
- return ipmi::responseInvalidFieldRequest();
- }
-
- std::vector<uint8_t> record =
- ipmi::storage::getNMDiscoverySDR(nmDiscoveryIndex, recordID);
- if (record.size() < (offset + bytesToRead))
- {
- bytesToRead = record.size() - offset;
- }
- recordData.insert(recordData.end(), record.begin() + offset,
- record.begin() + offset + bytesToRead);
- }
- else if (fruIndex >= fruCount)
- {
- // handle type 12 hardcoded records
- size_t type12Index = fruIndex - fruCount;
- if (type12Index >= ipmi::storage::type12Count ||
- offset > sizeof(Type12Record))
- {
- return ipmi::responseInvalidFieldRequest();
- }
- std::vector<uint8_t> record =
- ipmi::storage::getType12SDRs(type12Index, recordID);
- if (record.size() < (offset + bytesToRead))
- {
- bytesToRead = record.size() - offset;
- }
-
- recordData.insert(recordData.end(), record.begin() + offset,
- record.begin() + offset + bytesToRead);
- }
- else
- {
- // handle fru records
- get_sdr::SensorDataFruRecord data;
- if (offset > sizeof(data))
- {
- return ipmi::responseInvalidFieldRequest();
- }
- ret = ipmi::storage::getFruSdrs(ctx, fruIndex, data);
- if (ret != IPMI_CC_OK)
- {
- return ipmi::response(ret);
- }
- data.header.record_id_msb = recordID << 8;
- data.header.record_id_lsb = recordID & 0xFF;
- if (sizeof(data) < (offset + bytesToRead))
- {
- bytesToRead = sizeof(data) - offset;
- }
-
- uint8_t* respStart = reinterpret_cast<uint8_t*>(&data) + offset;
- recordData.insert(recordData.end(), respStart,
- respStart + bytesToRead);
- }
-
- return ipmi::responseSuccess(nextRecordId, recordData);
+ bytesToRead = sdrLength - offset;
}
- std::string connection;
- std::string path;
- uint16_t sensorIndex = recordID;
- for (const auto& sensor : sensorTree)
- {
- if (sensorIndex-- == 0)
- {
- if (!sensor.second.size())
- {
- return ipmi::responseResponseError();
- }
- connection = sensor.second.begin()->first;
- path = sensor.first;
- break;
- }
- }
-
- SensorMap sensorMap;
- if (!getSensorMap(ctx->yield, connection, path, sensorMap))
- {
- return ipmi::responseResponseError();
- }
- uint8_t sensornumber = (recordID & 0xFF);
- get_sdr::SensorDataFullRecord record = {0};
-
- record.header.record_id_msb = recordID << 8;
- record.header.record_id_lsb = recordID & 0xFF;
- record.header.sdr_version = ipmiSdrVersion;
- record.header.record_type = get_sdr::SENSOR_DATA_FULL_RECORD;
- record.header.record_length = sizeof(get_sdr::SensorDataFullRecord) -
- sizeof(get_sdr::SensorDataRecordHeader);
- record.key.owner_id = 0x20;
- record.key.owner_lun = 0x0;
- record.key.sensor_number = sensornumber;
-
- record.body.sensor_capabilities = 0x68; // auto rearm - todo hysteresis
- record.body.sensor_type = getSensorTypeFromPath(path);
- std::string type = getSensorTypeStringFromPath(path);
- auto typeCstr = type.c_str();
- auto findUnits = sensorUnits.find(typeCstr);
- if (findUnits != sensorUnits.end())
- {
- record.body.sensor_units_2_base =
- static_cast<uint8_t>(findUnits->second);
- } // else default 0x0 unspecified
-
- record.body.event_reading_type = getSensorEventTypeFromPath(path);
-
- auto sensorObject = sensorMap.find("xyz.openbmc_project.Sensor.Value");
- if (sensorObject == sensorMap.end())
- {
- return ipmi::responseResponseError();
- }
-
- uint8_t entityId = 0;
- uint8_t entityInstance = 0x01;
-
- // follow the association chain to get the parent board's entityid and
- // entityInstance
- updateIpmiFromAssociation(path, sensorMap, entityId, entityInstance);
-
- record.body.entity_id = entityId;
- record.body.entity_instance = entityInstance;
-
- auto maxObject = sensorObject->second.find("MaxValue");
- auto minObject = sensorObject->second.find("MinValue");
-
- // If min and/or max are left unpopulated,
- // then default to what a signed byte would be, namely (-128,127) range.
- auto max = static_cast<double>(std::numeric_limits<int8_t>::max());
- auto min = static_cast<double>(std::numeric_limits<int8_t>::lowest());
- if (maxObject != sensorObject->second.end())
- {
- max = std::visit(VariantToDoubleVisitor(), maxObject->second);
- }
-
- if (minObject != sensorObject->second.end())
- {
- min = std::visit(VariantToDoubleVisitor(), minObject->second);
- }
-
- int16_t mValue = 0;
- int8_t rExp = 0;
- int16_t bValue = 0;
- int8_t bExp = 0;
- bool bSigned = false;
-
- if (!getSensorAttributes(max, min, mValue, rExp, bValue, bExp, bSigned))
- {
- return ipmi::responseResponseError();
- }
-
- // The record.body is a struct SensorDataFullRecordBody
- // from sensorhandler.hpp in phosphor-ipmi-host.
- // The meaning of these bits appears to come from
- // table 43.1 of the IPMI spec.
- // The above 5 sensor attributes are stuffed in as follows:
- // Byte 21 = AA000000 = analog interpretation, 10 signed, 00 unsigned
- // Byte 22-24 are for other purposes
- // Byte 25 = MMMMMMMM = LSB of M
- // Byte 26 = MMTTTTTT = MSB of M (signed), and Tolerance
- // Byte 27 = BBBBBBBB = LSB of B
- // Byte 28 = BBAAAAAA = MSB of B (signed), and LSB of Accuracy
- // Byte 29 = AAAAEE00 = MSB of Accuracy, exponent of Accuracy
- // Byte 30 = RRRRBBBB = rExp (signed), bExp (signed)
-
- // apply M, B, and exponents, M and B are 10 bit values, exponents are 4
- record.body.m_lsb = mValue & 0xFF;
-
- uint8_t mBitSign = (mValue < 0) ? 1 : 0;
- uint8_t mBitNine = (mValue & 0x0100) >> 8;
-
- // move the smallest bit of the MSB into place (bit 9)
- // the MSbs are bits 7:8 in m_msb_and_tolerance
- record.body.m_msb_and_tolerance = (mBitSign << 7) | (mBitNine << 6);
-
- record.body.b_lsb = bValue & 0xFF;
-
- uint8_t bBitSign = (bValue < 0) ? 1 : 0;
- uint8_t bBitNine = (bValue & 0x0100) >> 8;
-
- // move the smallest bit of the MSB into place (bit 9)
- // the MSbs are bits 7:8 in b_msb_and_accuracy_lsb
- record.body.b_msb_and_accuracy_lsb = (bBitSign << 7) | (bBitNine << 6);
-
- uint8_t rExpSign = (rExp < 0) ? 1 : 0;
- uint8_t rExpBits = rExp & 0x07;
-
- uint8_t bExpSign = (bExp < 0) ? 1 : 0;
- uint8_t bExpBits = bExp & 0x07;
-
- // move rExp and bExp into place
- record.body.r_b_exponents =
- (rExpSign << 7) | (rExpBits << 4) | (bExpSign << 3) | bExpBits;
-
- // Set the analog reading byte interpretation accordingly
- record.body.sensor_units_1 = (bSigned ? 1 : 0) << 7;
-
- // TODO(): Perhaps care about Tolerance, Accuracy, and so on
- // These seem redundant, but derivable from the above 5 attributes
- // Original comment said "todo fill out rest of units"
-
- // populate sensor name from path
- std::string name;
- size_t nameStart = path.rfind("/");
- if (nameStart != std::string::npos)
- {
- name = path.substr(nameStart + 1, std::string::npos - nameStart);
- }
-
- std::replace(name.begin(), name.end(), '_', ' ');
- if (name.size() > FULL_RECORD_ID_STR_MAX_LENGTH)
- {
- // try to not truncate by replacing common words
- constexpr std::array<std::pair<const char*, const char*>, 2>
- replaceWords = {std::make_pair("Output", "Out"),
- std::make_pair("Input", "In")};
- for (const auto& [find, replace] : replaceWords)
- {
- boost::replace_all(name, find, replace);
- }
-
- name.resize(FULL_RECORD_ID_STR_MAX_LENGTH);
- }
- record.body.id_string_info = name.size();
- std::strncpy(record.body.id_string, name.c_str(),
- sizeof(record.body.id_string));
-
- IPMIThresholds thresholdData;
- try
- {
- thresholdData = getIPMIThresholds(sensorMap);
- }
- catch (std::exception&)
- {
- return ipmi::responseResponseError();
- }
-
- if (thresholdData.criticalHigh)
- {
- record.body.upper_critical_threshold = *thresholdData.criticalHigh;
- record.body.supported_deassertions[1] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::criticalThreshold);
- record.body.supported_deassertions[1] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::upperCriticalGoingHigh);
- record.body.supported_assertions[1] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::upperCriticalGoingHigh);
- record.body.discrete_reading_setting_mask[0] |=
- static_cast<uint8_t>(IPMISensorReadingByte3::upperCritical);
- }
- if (thresholdData.warningHigh)
- {
- record.body.upper_noncritical_threshold = *thresholdData.warningHigh;
- record.body.supported_deassertions[1] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::nonCriticalThreshold);
- record.body.supported_deassertions[0] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::upperNonCriticalGoingHigh);
- record.body.supported_assertions[0] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::upperNonCriticalGoingHigh);
- record.body.discrete_reading_setting_mask[0] |=
- static_cast<uint8_t>(IPMISensorReadingByte3::upperNonCritical);
- }
- if (thresholdData.criticalLow)
- {
- record.body.lower_critical_threshold = *thresholdData.criticalLow;
- record.body.supported_assertions[1] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::criticalThreshold);
- record.body.supported_deassertions[0] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::lowerCriticalGoingLow);
- record.body.supported_assertions[0] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::lowerCriticalGoingLow);
- record.body.discrete_reading_setting_mask[0] |=
- static_cast<uint8_t>(IPMISensorReadingByte3::lowerCritical);
- }
- if (thresholdData.warningLow)
- {
- record.body.lower_noncritical_threshold = *thresholdData.warningLow;
- record.body.supported_assertions[1] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::nonCriticalThreshold);
- record.body.supported_deassertions[0] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::lowerNonCriticalGoingLow);
- record.body.supported_assertions[0] |= static_cast<uint8_t>(
- IPMISensorEventEnableThresholds::lowerNonCriticalGoingLow);
- record.body.discrete_reading_setting_mask[0] |=
- static_cast<uint8_t>(IPMISensorReadingByte3::lowerNonCritical);
- }
-
- // everything that is readable is setable
- record.body.discrete_reading_setting_mask[1] =
- record.body.discrete_reading_setting_mask[0];
-
- if (sizeof(get_sdr::SensorDataFullRecord) < (offset + bytesToRead))
- {
- bytesToRead = sizeof(get_sdr::SensorDataFullRecord) - offset;
- }
-
- uint8_t* respStart = reinterpret_cast<uint8_t*>(&record) + offset;
+ uint8_t* respStart = reinterpret_cast<uint8_t*>(hdr) + offset;
std::vector<uint8_t> recordData(respStart, respStart + bytesToRead);
-
+ uint16_t nextRecordId = lastRecord > recordID ? recordID + 1 : 0XFFFF;
return ipmi::responseSuccess(nextRecordId, recordData);
}
/* end storage commands */
@@ -1557,6 +1685,11 @@
ipmi::Privilege::User,
ipmiStorageGetSDRRepositoryInfo);
+ // <Get Device SDR Info>
+ ipmi::registerHandler(ipmi::prioOpenBmcBase, ipmi::netFnSensor,
+ ipmi::sensor_event::cmdGetDeviceSdrInfo,
+ ipmi::Privilege::User, ipmiSensorGetDeviceSdrInfo);
+
// <Get SDR Allocation Info>
ipmi::registerHandler(ipmi::prioOemBase, ipmi::netFnStorage,
ipmi::storage::cmdGetSdrRepositoryAllocInfo,
diff --git a/src/storagecommands.cpp b/src/storagecommands.cpp
index c2c1236..f1b98e0 100644
--- a/src/storagecommands.cpp
+++ b/src/storagecommands.cpp
@@ -1020,6 +1020,7 @@
uint16_t generatorID = 0;
uint8_t sensorType = 0;
+ uint16_t sensorAndLun = 0;
uint8_t sensorNum = 0xFF;
uint7_t eventType = 0;
bool eventDir = 0;
@@ -1042,7 +1043,9 @@
// Get the sensor type, sensor number, and event type for the sensor
sensorType = getSensorTypeFromPath(sensorPath);
- sensorNum = getSensorNumberFromPath(sensorPath);
+ sensorAndLun = getSensorNumberFromPath(sensorPath);
+ sensorNum = static_cast<uint8_t>(sensorAndLun);
+ generatorID |= sensorAndLun >> 8;
eventType = getSensorEventTypeFromPath(sensorPath);
// Get the event direction