pldm.cpp - openbmc/openpower-occ-control - Gitiles

 #include "pldm.hpp"

 #include "file.hpp"

 #include <fmt/core.h>
 #include <libpldm/entity.h>
 #include <libpldm/platform.h>
 #include <libpldm/state_set.h>
 #include <libpldm/state_set_oem_ibm.h>

 #include <phosphor-logging/log.hpp>
 #include <sdbusplus/bus.hpp>
 #include <sdeventplus/clock.hpp>
 #include <sdeventplus/exception.hpp>
 #include <sdeventplus/source/io.hpp>
 #include <sdeventplus/source/time.hpp>

 #include <algorithm>

 namespace pldm
 {

 using namespace phosphor::logging;

 using namespace sdeventplus;
 using namespace sdeventplus::source;
 constexpr auto clockId = sdeventplus::ClockId::RealTime;
 using Clock = sdeventplus::Clock<clockId>;
 using Timer = Time<clockId>;

 void Interface::fetchSensorInfo(uint16_t stateSetId,
                                 SensorToInstance& sensorInstanceMap,
                                 SensorOffset& sensorOffset)
 {
     PdrList pdrs{};
     static bool tracedError = false;

     auto& bus = open_power::occ::utils::getBus();
     try
     {
         auto method = bus.new_method_call(
             "xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm",
             "xyz.openbmc_project.PLDM.PDR", "FindStateSensorPDR");
         method.append(tid, static_cast<uint16_t>(PLDM_ENTITY_PROC), stateSetId);

         auto responseMsg = bus.call(method);
         responseMsg.read(pdrs);
     }
     catch (const sdbusplus::exception::exception& e)
     {
         if (!tracedError)
         {
             log<level::ERR>(
                 fmt::format(
                     "fetchSensorInfo: Failed to find stateSetID:{} PDR: {}",
                     stateSetId, e.what())
                     .c_str());
             tracedError = true;
         }
     }

     if (pdrs.empty())
     {
         if (!tracedError)
         {
             log<level::ERR>(
                 fmt::format(
                     "fetchSensorInfo: state sensor PDRs ({}) not present",
                     stateSetId)
                     .c_str());
             tracedError = true;
         }
         return;
     }

     // Found PDR
     if (tracedError)
     {
         log<level::INFO>(
             fmt::format("fetchSensorInfo: found {} PDRs", pdrs.size()).c_str());
         tracedError = false;
     }

     bool offsetFound = false;
     auto stateSensorPDR =
         reinterpret_cast<const pldm_state_sensor_pdr*>(pdrs.front().data());
     auto possibleStatesPtr = stateSensorPDR->possible_states;
     for (auto offset = 0; offset < stateSensorPDR->composite_sensor_count;
          offset++)
     {
         auto possibleStates =
             reinterpret_cast<const state_sensor_possible_states*>(
                 possibleStatesPtr);

         if (possibleStates->state_set_id == stateSetId)
         {
             sensorOffset = offset;
             offsetFound = true;
             break;
         }
         possibleStatesPtr += sizeof(possibleStates->state_set_id) +
                              sizeof(possibleStates->possible_states_size) +
                              possibleStates->possible_states_size;
     }

     if (!offsetFound)
     {
         log<level::ERR>("pldm: state sensor PDR not found");
         return;
     }

     // To order SensorID based on the EntityInstance.
     // Note that when a proc is on a DCM, the PDRs for these sensors
     // could have the same instance IDs but different container IDs.
     std::map<uint32_t, SensorID> entityInstMap{};
     for (auto& pdr : pdrs)
     {
         auto pdrPtr =
             reinterpret_cast<const pldm_state_sensor_pdr*>(pdr.data());
         uint32_t key = (static_cast<uint32_t>(pdrPtr->container_id) << 16) |
                        static_cast<uint32_t>(pdrPtr->entity_instance);
         entityInstMap.emplace(key, static_cast<SensorID>(pdrPtr->sensor_id));
     }

     open_power::occ::instanceID count = start;
     for (auto const& pair : entityInstMap)
     {
         sensorInstanceMap.emplace(pair.second, count);
         count++;
     }
 }

 void Interface::sensorEvent(sdbusplus::message::message& msg)
 {
     if (!isOCCSensorCacheValid())
     {
         fetchSensorInfo(PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS,
                         sensorToOCCInstance, OCCSensorOffset);
     }

     if (sensorToSBEInstance.empty())
     {
         fetchSensorInfo(PLDM_OEM_IBM_SBE_HRESET_STATE, sensorToSBEInstance,
                         SBESensorOffset);
     }

     TerminusID tid{};
     SensorID sensorId{};
     SensorOffset msgSensorOffset{};
     EventState eventState{};
     EventState previousEventState{};

     msg.read(tid, sensorId, msgSensorOffset, eventState, previousEventState);

     if (msgSensorOffset == OCCSensorOffset)
     {
         auto sensorEntry = sensorToOCCInstance.find(sensorId);

         if (sensorEntry != sensorToOCCInstance.end())
         {
             if (eventState ==
                 static_cast<EventState>(
                     PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_IN_SERVICE))
             {
                 log<level::INFO>(
                     fmt::format("PLDM: OCC{} is RUNNING", sensorEntry->second)
                         .c_str());
                 callBack(sensorEntry->second, true);
             }
             else if (eventState ==
                      static_cast<EventState>(
                          PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPED))
             {
                 log<level::INFO>(fmt::format("PLDM: OCC{} has now STOPPED",
                                              sensorEntry->second)
                                      .c_str());
                 callBack(sensorEntry->second, false);
             }
             else if (eventState ==
                      static_cast<EventState>(
                          PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_DORMANT))
             {
                 log<level::INFO>(
                     fmt::format(
                         "PLDM: OCC{} has now STOPPED and system is in SAFE MODE",
                         sensorEntry->second)
                         .c_str());
                 callBack(sensorEntry->second, false);
             }
             else
             {
                 log<level::INFO>(
                     fmt::format("PLDM: Unexpected PLDM state {} for OCC{}",
                                 eventState, sensorEntry->second)
                         .c_str());
             }

             return;
         }
     }

     if (msgSensorOffset == SBESensorOffset)
     {
         auto sensorEntry = sensorToSBEInstance.find(sensorId);

         if (sensorEntry != sensorToSBEInstance.end())
         {
             if (eventState == static_cast<EventState>(SBE_HRESET_NOT_READY))
             {
                 log<level::INFO>(
                     fmt::format("pldm: HRESET is NOT READY (OCC{})",
                                 sensorEntry->second)
                         .c_str());
             }
             else if (eventState == static_cast<EventState>(SBE_HRESET_READY))
             {
                 sbeCallBack(sensorEntry->second, true);
             }
             else if (eventState == static_cast<EventState>(SBE_HRESET_FAILED))
             {
                 sbeCallBack(sensorEntry->second, false);
             }
         }
     }
 }

 void Interface::hostStateEvent(sdbusplus::message::message& msg)
 {
     std::map<std::string, std::variant<std::string>> properties{};
     std::string interface;
     msg.read(interface, properties);
     const auto stateEntry = properties.find("CurrentHostState");
     if (stateEntry != properties.end())
     {
         auto stateEntryValue = stateEntry->second;
         auto propVal = std::get<std::string>(stateEntryValue);
         if (propVal == "xyz.openbmc_project.State.Host.HostState.Off")
         {
             clearData();
         }
     }
 }

 void Interface::clearData()
 {
     sensorToOCCInstance.clear();
     occInstanceToEffecter.clear();

     sensorToSBEInstance.clear();
     sbeInstanceToEffecter.clear();
 }

 void Interface::fetchEffecterInfo(uint16_t stateSetId,
                                   InstanceToEffecter& instanceToEffecterMap,
                                   CompositeEffecterCount& effecterCount,
                                   uint8_t& stateIdPos)
 {
     PdrList pdrs{};

     auto& bus = open_power::occ::utils::getBus();
     try
     {
         auto method = bus.new_method_call(
             "xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm",
             "xyz.openbmc_project.PLDM.PDR", "FindStateEffecterPDR");
         method.append(tid, static_cast<uint16_t>(PLDM_ENTITY_PROC), stateSetId);

         auto responseMsg = bus.call(method);
         responseMsg.read(pdrs);
     }
     catch (const sdbusplus::exception::exception& e)
     {
         log<level::ERR>("pldm: Failed to fetch the state effecter PDRs",
                         entry("ERROR=%s", e.what()));
     }

     if (!pdrs.size())
     {
         log<level::ERR>("pldm: state effecter PDRs not present");
         return;
     }

     bool offsetFound = false;
     auto stateEffecterPDR =
         reinterpret_cast<const pldm_state_effecter_pdr*>(pdrs.front().data());
     auto possibleStatesPtr = stateEffecterPDR->possible_states;
     for (auto offset = 0; offset < stateEffecterPDR->composite_effecter_count;
          offset++)
     {
         auto possibleStates =
             reinterpret_cast<const state_effecter_possible_states*>(
                 possibleStatesPtr);

         if (possibleStates->state_set_id == stateSetId)
         {
             stateIdPos = offset;
             effecterCount = stateEffecterPDR->composite_effecter_count;
             offsetFound = true;
             break;
         }
         possibleStatesPtr += sizeof(possibleStates->state_set_id) +
                              sizeof(possibleStates->possible_states_size) +
                              possibleStates->possible_states_size;
     }

     if (!offsetFound)
     {
         return;
     }

     std::map<uint32_t, EffecterID> entityInstMap{};
     for (auto& pdr : pdrs)
     {
         auto pdrPtr =
             reinterpret_cast<const pldm_state_effecter_pdr*>(pdr.data());
         uint32_t key = (static_cast<uint32_t>(pdrPtr->container_id) << 16) |
                        static_cast<uint32_t>(pdrPtr->entity_instance);
         entityInstMap.emplace(key, static_cast<SensorID>(pdrPtr->effecter_id));
     }

     open_power::occ::instanceID position = start;
     for (auto const& pair : entityInstMap)
     {
         instanceToEffecterMap.emplace(position, pair.second);
         position++;
     }
 }

 std::vector<uint8_t>
     Interface::prepareSetEffecterReq(uint8_t instanceId, EffecterID effecterId,
                                      CompositeEffecterCount effecterCount,
                                      uint8_t stateIdPos, uint8_t stateSetValue)
 {
     std::vector<uint8_t> request(
         sizeof(pldm_msg_hdr) + sizeof(effecterId) + sizeof(effecterCount) +
         (effecterCount * sizeof(set_effecter_state_field)));
     auto requestMsg = reinterpret_cast<pldm_msg*>(request.data());
     std::vector<set_effecter_state_field> stateField;

     for (uint8_t effecterPos = 0; effecterPos < effecterCount; effecterPos++)
     {
         if (effecterPos == stateIdPos)
         {
             stateField.emplace_back(
                 set_effecter_state_field{PLDM_REQUEST_SET, stateSetValue});
         }
         else
         {
             stateField.emplace_back(
                 set_effecter_state_field{PLDM_NO_CHANGE, 0});
         }
     }
     auto rc = encode_set_state_effecter_states_req(
         instanceId, effecterId, effecterCount, stateField.data(), requestMsg);
     if (rc != PLDM_SUCCESS)
     {
         log<level::ERR>("encode set effecter states request returned error ",
                         entry("RC=%d", rc));
         request.clear();
     }
     return request;
 }

 void Interface::resetOCC(open_power::occ::instanceID occInstanceId)
 {
     if (open_power::occ::utils::isHostRunning())
     {
         if (!isPDREffecterCacheValid())
         {
             fetchEffecterInfo(PLDM_STATE_SET_BOOT_RESTART_CAUSE,
                               occInstanceToEffecter, OCCEffecterCount,
                               bootRestartPosition);
         }

         // Find the matching effecter for the OCC instance
         auto effecterEntry = occInstanceToEffecter.find(occInstanceId);
         if (effecterEntry == occInstanceToEffecter.end())
         {
             log<level::ERR>(
                 fmt::format(
                     "pldm: Failed to find a matching effecter for OCC instance {}",
                     occInstanceId)
                     .c_str());

             return;
         }

         if (!getMctpInstanceId(mctpInstance))
         {
             return;
         }

         // Prepare the SetStateEffecterStates request to reset the OCC
         auto request = prepareSetEffecterReq(
             mctpInstance, effecterEntry->second, OCCEffecterCount,
             bootRestartPosition, PLDM_STATE_SET_BOOT_RESTART_CAUSE_WARM_RESET);

         if (request.empty())
         {
             log<level::ERR>(
                 "pldm: SetStateEffecterStates OCC reset request empty");
             return;
         }

         // Send request to reset the OCCs/PM Complex (ignore response)
         sendPldm(request, occInstanceId, false);
     }
     else
     {
         log<level::ERR>(
             fmt::format("resetOCC: HOST is not running (OCC{})", occInstanceId)
                 .c_str());
         clearData();
     }
 }

 void Interface::sendHRESET(open_power::occ::instanceID sbeInstanceId)
 {
     if (open_power::occ::utils::isHostRunning())
     {
         if (sbeInstanceToEffecter.empty())
         {
             fetchEffecterInfo(PLDM_OEM_IBM_SBE_MAINTENANCE_STATE,
                               sbeInstanceToEffecter, SBEEffecterCount,
                               sbeMaintenanceStatePosition);
         }

         auto effecterEntry = sbeInstanceToEffecter.find(sbeInstanceId);
         if (effecterEntry == sbeInstanceToEffecter.end())
         {
             log<level::ERR>(
                 "pldm: Failed to find a matching effecter for SBE instance",
                 entry("SBE=%d", sbeInstanceId));
             return;
         }

         if (!getMctpInstanceId(mctpInstance))
         {
             return;
         }

         // Prepare the SetStateEffecterStates request to HRESET the SBE
         auto request = prepareSetEffecterReq(
             mctpInstance, effecterEntry->second, SBEEffecterCount,
             sbeMaintenanceStatePosition, SBE_RETRY_REQUIRED);

         if (request.empty())
         {
             log<level::ERR>(
                 "pldm: SetStateEffecterStates HRESET request empty");
             return;
         }

         // Send request to issue HRESET of SBE (ignore response)
         sendPldm(request, sbeInstanceId, false);
     }
     else
     {
         log<level::ERR>(fmt::format("sendHRESET: HOST is not running (OCC{})",
                                     sbeInstanceId)
                             .c_str());
         clearData();
     }
 }

 bool Interface::getMctpInstanceId(uint8_t& instanceId)
 {
     auto& bus = open_power::occ::utils::getBus();
     try
     {
         auto method = bus.new_method_call(
             "xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm",
             "xyz.openbmc_project.PLDM.Requester", "GetInstanceId");
         method.append(mctpEid);
         auto reply = bus.call(method);
         reply.read(instanceId);
     }
     catch (const sdbusplus::exception::exception& e)
     {
         log<level::ERR>("pldm: GetInstanceId returned error",
                         entry("ERROR=%s", e.what()));
         return false;
     }

     return true;
 }

 void Interface::sendPldm(const std::vector<uint8_t>& request,
                          const uint8_t instance, const bool rspExpected)
 {
     // Connect to MCTP scoket
     pldmFd = pldm_open();
     auto openErrno = errno;
     if (pldmFd == PLDM_REQUESTER_OPEN_FAIL)
     {
         log<level::ERR>(
             fmt::format(
                 "sendPldm: Failed to connect to MCTP socket, errno={}/{}",
                 openErrno, strerror(openErrno))
                 .c_str());
         return;
     }

     // Send the PLDM request message to HBRT
     if (rspExpected)
     {
         // Register callback when response is available
         registerPldmRspCallback();

         // Send PLDM request
         log<level::INFO>(
             fmt::format(
                 "sendPldm: calling pldm_send(OCC{}, instance:{}, {} bytes)",
                 instance, mctpInstance, request.size())
                 .c_str());
         pldmResponseReceived = false;
         pldmResponseTimeout = false;
         pldmResponseOcc = instance;
         auto pldmRc =
             pldm_send(mctpEid, pldmFd, request.data(), request.size());
         auto sendErrno = errno;
         if (pldmRc != PLDM_REQUESTER_SUCCESS)
         {
             log<level::ERR>(
                 fmt::format(
                     "sendPldm: pldm_send failed with rc={} and errno={}/{}",
                     pldmRc, sendErrno, strerror(sendErrno))
                     .c_str());
             pldmClose();
             return;
         }

         // start timer waiting for the response
         using namespace std::literals::chrono_literals;
         pldmRspTimer.restartOnce(10s);

         // Wait for response/timeout
     }
     else // not expecting the response
     {
         log<level::INFO>(
             fmt::format(
                 "sendPldm: calling pldm_send(mctpID:{}, fd:{}, {} bytes) for OCC{}",
                 mctpEid, pldmFd, request.size(), instance)
                 .c_str());
         auto rc = pldm_send(mctpEid, pldmFd, request.data(), request.size());
         auto sendErrno = errno;
         if (rc)
         {
             log<level::ERR>(
                 fmt::format(
                     "sendPldm: pldm_send(mctpID:{}, fd:{}, {} bytes) failed with rc={} and errno={}/{}",
                     mctpEid, pldmFd, request.size(), rc, sendErrno,
                     strerror(sendErrno))
                     .c_str());
         }
         pldmClose();
     }
 }

 // Attaches the FD to event loop and registers the callback handler
 void Interface::registerPldmRspCallback()
 {
     decltype(eventSource.get()) sourcePtr = nullptr;
     auto rc = sd_event_add_io(event.get(), &sourcePtr, pldmFd, EPOLLIN,
                               pldmRspCallback, this);
     if (rc < 0)
     {
         log<level::ERR>(
             fmt::format(
                 "registerPldmRspCallback: sd_event_add_io: Error({})={} : fd={}",
                 rc, strerror(-rc), pldmFd)
                 .c_str());
     }
     else
     {
         // puts sourcePtr in the event source.
         eventSource.reset(sourcePtr);
     }
 }

 // Add a timer to the event loop, default 30s.
 void Interface::pldmRspExpired()
 {
     if (!pldmResponseReceived)
     {
         log<level::ERR>(
             fmt::format(
                 "pldmRspExpired: timerCallback - timeout waiting for pldm response for OCC{}",
                 pldmResponseOcc)
                 .c_str());
         pldmResponseTimeout = true;
         if (pldmFd)
         {
             pldmClose();
         }
     }
     return;
 };

 void Interface::pldmClose()
 {
     if (pldmRspTimer.isEnabled())
     {
         // stop PLDM response timer
         pldmRspTimer.setEnabled(false);
     }
     close(pldmFd);
     pldmFd = -1;
     eventSource.reset();
 }

 int Interface::pldmRspCallback(sd_event_source* /*es*/, int fd,
                                uint32_t revents, void* userData)
 {
     if (!(revents & EPOLLIN))
     {
         log<level::INFO>(
             fmt::format("pldmRspCallback - revents={:08X}", revents).c_str());
         return -1;
     }

     auto pldmIface = static_cast<Interface*>(userData);

     uint8_t* responseMsg = nullptr;
     size_t responseMsgSize{};

     log<level::INFO>(
         fmt::format("pldmRspCallback: calling pldm_recv() instance:{}",
                     pldmIface->mctpInstance)
             .c_str());
     auto rc = pldm_recv(mctpEid, fd, pldmIface->mctpInstance, &responseMsg,
                         &responseMsgSize);
     int lastErrno = errno;
     if (rc)
     {
         log<level::ERR>(
             fmt::format(
                 "pldmRspCallback: pldm_recv failed with rc={}, errno={}/{}", rc,
                 lastErrno, strerror(lastErrno))
                 .c_str());
         return -1;
     }
     log<level::INFO>(
         fmt::format("pldmRspCallback: pldm_recv() rsp was {} bytes",
                     responseMsgSize)
             .c_str());

     if (pldmIface->pldmRspTimer.isEnabled())
     {
         // stop PLDM response timer
         pldmIface->pldmRspTimer.setEnabled(false);
     }

     // Set pointer to autodelete
     std::unique_ptr<uint8_t, decltype(std::free)*> responseMsgPtr{responseMsg,
                                                                   std::free};

     // We've got the response meant for the PLDM request msg that was
     // sent out
     // io.set_enabled(Enabled::Off);
     auto response = reinterpret_cast<pldm_msg*>(responseMsgPtr.get());
     if (response->payload[0] != PLDM_SUCCESS)
     {
         log<level::ERR>(
             fmt::format("pldmRspCallback: payload[0] was not success: {}",
                         response->payload[0])
                 .c_str());
         pldmIface->pldmClose();
         return -1;
     }

     // Decode the response
     uint8_t compCode = 0, sensorCount = 1;
     get_sensor_state_field field[6];
     responseMsgSize -= sizeof(pldm_msg_hdr);
     auto msgRc = decode_get_state_sensor_readings_resp(
         response, responseMsgSize, &compCode, &sensorCount, field);
     if ((msgRc != PLDM_SUCCESS) || (compCode != PLDM_SUCCESS))
     {
         log<level::ERR>(
             fmt::format(
                 "pldmRspCallback: decode_get_state_sensor_readings failed with rc={} and compCode={}",
                 msgRc, compCode)
                 .c_str());
         pldmIface->pldmClose();
         return -1;
     }

     pldmIface->pldmClose();

     const uint8_t instance = pldmIface->pldmResponseOcc;
     const uint8_t occSensorState = field[0].present_state;
     pldmIface->pldmResponseReceived = true;

     if (occSensorState == PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_IN_SERVICE)
     {
         log<level::INFO>(
             fmt::format("pldmRspCallback: OCC{} is RUNNING", instance).c_str());
         pldmIface->callBack(instance, true);
     }
     else
     {
         log<level::INFO>(
             fmt::format("pldmRspCallback: OCC{} is not running (state:{})",
                         instance, occSensorState)
                 .c_str());
         pldmIface->callBack(instance, false);
     }

     return 0;
 };

 std::vector<uint8_t> Interface::encodeGetStateSensorRequest(uint8_t instance,
                                                             uint16_t sensorId)
 {
     bitfield8_t sRearm = {0};
     const size_t msgSize =
         sizeof(pldm_msg_hdr) + PLDM_GET_STATE_SENSOR_READINGS_REQ_BYTES;
     std::vector<uint8_t> request(msgSize);
     auto msg = reinterpret_cast<pldm_msg*>(request.data());
     auto msgRc = encode_get_state_sensor_readings_req(mctpInstance, sensorId,
                                                       sRearm, 0, msg);
     if (msgRc != PLDM_SUCCESS)
     {
         log<level::ERR>(
             fmt::format(
                 "encodeGetStateSensorRequest: Failed to encode sensorId:0x{:08X} for OCC{} (rc={})",
                 sensorId, instance, msgRc)
                 .c_str());
     }
     return request;
 }

 // Initiate query of the specified OCC Active Sensor
 void Interface::checkActiveSensor(uint8_t instance)
 {
     static bool tracedOnce = false;
     if (pldmFd > 0)
     {
         if (!tracedOnce)
         {
             log<level::ERR>(
                 fmt::format(
                     "checkActiveSensor: already waiting on OCC{} (fd={})",
                     pldmResponseOcc, pldmFd)
                     .c_str());
             tracedOnce = true;
         }
         return;
     }
     tracedOnce = false;

     if (!isOCCSensorCacheValid())
     {
         fetchSensorInfo(PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS,
                         sensorToOCCInstance, OCCSensorOffset);
     }

     // look up sensor id (key) based on instance
     auto entry = std::find_if(
         sensorToOCCInstance.begin(), sensorToOCCInstance.end(),
         [instance](const auto& entry) { return instance == entry.second; });
     if (entry != sensorToOCCInstance.end())
     {
         // Query the OCC Active Sensor state for this instance
         // SensorID sID = entry->first;
         log<level::INFO>(
             fmt::format("checkActiveSensor: OCC{} / sensorID: 0x{:04X}",
                         instance, entry->first)
                 .c_str());

         if (!getMctpInstanceId(mctpInstance))
         {
             log<level::ERR>("checkActiveSensor: failed to getMctpInstanceId");
             return;
         }

         // Encode GetStateSensorReadings PLDM message
         auto request = encodeGetStateSensorRequest(instance, entry->first);
         if (request.empty())
         {
             return;
         }

         // Send request to PLDM and setup callback for response
         sendPldm(request, instance, true);
     }
     else
     {
         log<level::ERR>(
             fmt::format(
                 "checkActiveSensor: Unable to find PLDM sensor for OCC{}",
                 instance)
                 .c_str());
     }
 }

 } // namespace pldm
	#include "pldm.hpp"

	#include "file.hpp"

	#include <fmt/core.h>
	#include <libpldm/entity.h>
	#include <libpldm/platform.h>
	#include <libpldm/state_set.h>
	#include <libpldm/state_set_oem_ibm.h>

	#include <phosphor-logging/log.hpp>
	#include <sdbusplus/bus.hpp>
	#include <sdeventplus/clock.hpp>
	#include <sdeventplus/exception.hpp>
	#include <sdeventplus/source/io.hpp>
	#include <sdeventplus/source/time.hpp>

	#include <algorithm>

	namespace pldm
	{

	using namespace phosphor::logging;

	using namespace sdeventplus;
	using namespace sdeventplus::source;
	constexpr auto clockId = sdeventplus::ClockId::RealTime;
	using Clock = sdeventplus::Clock<clockId>;
	using Timer = Time<clockId>;

	void Interface::fetchSensorInfo(uint16_t stateSetId,
	SensorToInstance& sensorInstanceMap,
	SensorOffset& sensorOffset)
	{
	PdrList pdrs{};
	static bool tracedError = false;

	auto& bus = open_power::occ::utils::getBus();
	try
	{
	auto method = bus.new_method_call(
	"xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm",
	"xyz.openbmc_project.PLDM.PDR", "FindStateSensorPDR");
	method.append(tid, static_cast<uint16_t>(PLDM_ENTITY_PROC), stateSetId);

	auto responseMsg = bus.call(method);
	responseMsg.read(pdrs);
	}
	catch (const sdbusplus::exception::exception& e)
	{
	if (!tracedError)
	{
	log<level::ERR>(
	fmt::format(
	"fetchSensorInfo: Failed to find stateSetID:{} PDR: {}",
	stateSetId, e.what())
	.c_str());
	tracedError = true;
	}
	}

	if (pdrs.empty())
	{
	if (!tracedError)
	{
	log<level::ERR>(
	fmt::format(
	"fetchSensorInfo: state sensor PDRs ({}) not present",
	stateSetId)
	.c_str());
	tracedError = true;
	}
	return;
	}

	// Found PDR
	if (tracedError)
	{
	log<level::INFO>(
	fmt::format("fetchSensorInfo: found {} PDRs", pdrs.size()).c_str());
	tracedError = false;
	}

	bool offsetFound = false;
	auto stateSensorPDR =
	reinterpret_cast<const pldm_state_sensor_pdr*>(pdrs.front().data());
	auto possibleStatesPtr = stateSensorPDR->possible_states;
	for (auto offset = 0; offset < stateSensorPDR->composite_sensor_count;
	offset++)
	{
	auto possibleStates =
	reinterpret_cast<const state_sensor_possible_states*>(
	possibleStatesPtr);

	if (possibleStates->state_set_id == stateSetId)
	{
	sensorOffset = offset;
	offsetFound = true;
	break;
	}
	possibleStatesPtr += sizeof(possibleStates->state_set_id) +
	sizeof(possibleStates->possible_states_size) +
	possibleStates->possible_states_size;
	}

	if (!offsetFound)
	{
	log<level::ERR>("pldm: state sensor PDR not found");
	return;
	}

	// To order SensorID based on the EntityInstance.
	// Note that when a proc is on a DCM, the PDRs for these sensors
	// could have the same instance IDs but different container IDs.
	std::map<uint32_t, SensorID> entityInstMap{};
	for (auto& pdr : pdrs)
	{
	auto pdrPtr =
	reinterpret_cast<const pldm_state_sensor_pdr*>(pdr.data());
	uint32_t key = (static_cast<uint32_t>(pdrPtr->container_id) << 16) \|
	static_cast<uint32_t>(pdrPtr->entity_instance);
	entityInstMap.emplace(key, static_cast<SensorID>(pdrPtr->sensor_id));
	}

	open_power::occ::instanceID count = start;
	for (auto const& pair : entityInstMap)
	{
	sensorInstanceMap.emplace(pair.second, count);
	count++;
	}
	}

	void Interface::sensorEvent(sdbusplus::message::message& msg)
	{
	if (!isOCCSensorCacheValid())
	{
	fetchSensorInfo(PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS,
	sensorToOCCInstance, OCCSensorOffset);
	}

	if (sensorToSBEInstance.empty())
	{
	fetchSensorInfo(PLDM_OEM_IBM_SBE_HRESET_STATE, sensorToSBEInstance,
	SBESensorOffset);
	}

	TerminusID tid{};
	SensorID sensorId{};
	SensorOffset msgSensorOffset{};
	EventState eventState{};
	EventState previousEventState{};

	msg.read(tid, sensorId, msgSensorOffset, eventState, previousEventState);

	if (msgSensorOffset == OCCSensorOffset)
	{
	auto sensorEntry = sensorToOCCInstance.find(sensorId);

	if (sensorEntry != sensorToOCCInstance.end())
	{
	if (eventState ==
	static_cast<EventState>(
	PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_IN_SERVICE))
	{
	log<level::INFO>(
	fmt::format("PLDM: OCC{} is RUNNING", sensorEntry->second)
	.c_str());
	callBack(sensorEntry->second, true);
	}
	else if (eventState ==
	static_cast<EventState>(
	PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_STOPPED))
	{
	log<level::INFO>(fmt::format("PLDM: OCC{} has now STOPPED",
	sensorEntry->second)
	.c_str());
	callBack(sensorEntry->second, false);
	}
	else if (eventState ==
	static_cast<EventState>(
	PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_DORMANT))
	{
	log<level::INFO>(
	fmt::format(
	"PLDM: OCC{} has now STOPPED and system is in SAFE MODE",
	sensorEntry->second)
	.c_str());
	callBack(sensorEntry->second, false);
	}
	else
	{
	log<level::INFO>(
	fmt::format("PLDM: Unexpected PLDM state {} for OCC{}",
	eventState, sensorEntry->second)
	.c_str());
	}

	return;
	}
	}

	if (msgSensorOffset == SBESensorOffset)
	{
	auto sensorEntry = sensorToSBEInstance.find(sensorId);

	if (sensorEntry != sensorToSBEInstance.end())
	{
	if (eventState == static_cast<EventState>(SBE_HRESET_NOT_READY))
	{
	log<level::INFO>(
	fmt::format("pldm: HRESET is NOT READY (OCC{})",
	sensorEntry->second)
	.c_str());
	}
	else if (eventState == static_cast<EventState>(SBE_HRESET_READY))
	{
	sbeCallBack(sensorEntry->second, true);
	}
	else if (eventState == static_cast<EventState>(SBE_HRESET_FAILED))
	{
	sbeCallBack(sensorEntry->second, false);
	}
	}
	}
	}

	void Interface::hostStateEvent(sdbusplus::message::message& msg)
	{
	std::map<std::string, std::variant<std::string>> properties{};
	std::string interface;
	msg.read(interface, properties);
	const auto stateEntry = properties.find("CurrentHostState");
	if (stateEntry != properties.end())
	{
	auto stateEntryValue = stateEntry->second;
	auto propVal = std::get<std::string>(stateEntryValue);
	if (propVal == "xyz.openbmc_project.State.Host.HostState.Off")
	{
	clearData();
	}
	}
	}

	void Interface::clearData()
	{
	sensorToOCCInstance.clear();
	occInstanceToEffecter.clear();

	sensorToSBEInstance.clear();
	sbeInstanceToEffecter.clear();
	}

	void Interface::fetchEffecterInfo(uint16_t stateSetId,
	InstanceToEffecter& instanceToEffecterMap,
	CompositeEffecterCount& effecterCount,
	uint8_t& stateIdPos)
	{
	PdrList pdrs{};

	auto& bus = open_power::occ::utils::getBus();
	try
	{
	auto method = bus.new_method_call(
	"xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm",
	"xyz.openbmc_project.PLDM.PDR", "FindStateEffecterPDR");
	method.append(tid, static_cast<uint16_t>(PLDM_ENTITY_PROC), stateSetId);

	auto responseMsg = bus.call(method);
	responseMsg.read(pdrs);
	}
	catch (const sdbusplus::exception::exception& e)
	{
	log<level::ERR>("pldm: Failed to fetch the state effecter PDRs",
	entry("ERROR=%s", e.what()));
	}

	if (!pdrs.size())
	{
	log<level::ERR>("pldm: state effecter PDRs not present");
	return;
	}

	bool offsetFound = false;
	auto stateEffecterPDR =
	reinterpret_cast<const pldm_state_effecter_pdr*>(pdrs.front().data());
	auto possibleStatesPtr = stateEffecterPDR->possible_states;
	for (auto offset = 0; offset < stateEffecterPDR->composite_effecter_count;
	offset++)
	{
	auto possibleStates =
	reinterpret_cast<const state_effecter_possible_states*>(
	possibleStatesPtr);

	if (possibleStates->state_set_id == stateSetId)
	{
	stateIdPos = offset;
	effecterCount = stateEffecterPDR->composite_effecter_count;
	offsetFound = true;
	break;
	}
	possibleStatesPtr += sizeof(possibleStates->state_set_id) +
	sizeof(possibleStates->possible_states_size) +
	possibleStates->possible_states_size;
	}

	if (!offsetFound)
	{
	return;
	}

	std::map<uint32_t, EffecterID> entityInstMap{};
	for (auto& pdr : pdrs)
	{
	auto pdrPtr =
	reinterpret_cast<const pldm_state_effecter_pdr*>(pdr.data());
	uint32_t key = (static_cast<uint32_t>(pdrPtr->container_id) << 16) \|
	static_cast<uint32_t>(pdrPtr->entity_instance);
	entityInstMap.emplace(key, static_cast<SensorID>(pdrPtr->effecter_id));
	}

	open_power::occ::instanceID position = start;
	for (auto const& pair : entityInstMap)
	{
	instanceToEffecterMap.emplace(position, pair.second);
	position++;
	}
	}

	std::vector<uint8_t>
	Interface::prepareSetEffecterReq(uint8_t instanceId, EffecterID effecterId,
	CompositeEffecterCount effecterCount,
	uint8_t stateIdPos, uint8_t stateSetValue)
	{
	std::vector<uint8_t> request(
	sizeof(pldm_msg_hdr) + sizeof(effecterId) + sizeof(effecterCount) +
	(effecterCount * sizeof(set_effecter_state_field)));
	auto requestMsg = reinterpret_cast<pldm_msg*>(request.data());
	std::vector<set_effecter_state_field> stateField;

	for (uint8_t effecterPos = 0; effecterPos < effecterCount; effecterPos++)
	{
	if (effecterPos == stateIdPos)
	{
	stateField.emplace_back(
	set_effecter_state_field{PLDM_REQUEST_SET, stateSetValue});
	}
	else
	{
	stateField.emplace_back(
	set_effecter_state_field{PLDM_NO_CHANGE, 0});
	}
	}
	auto rc = encode_set_state_effecter_states_req(
	instanceId, effecterId, effecterCount, stateField.data(), requestMsg);
	if (rc != PLDM_SUCCESS)
	{
	log<level::ERR>("encode set effecter states request returned error ",
	entry("RC=%d", rc));
	request.clear();
	}
	return request;
	}

	void Interface::resetOCC(open_power::occ::instanceID occInstanceId)
	{
	if (open_power::occ::utils::isHostRunning())
	{
	if (!isPDREffecterCacheValid())
	{
	fetchEffecterInfo(PLDM_STATE_SET_BOOT_RESTART_CAUSE,
	occInstanceToEffecter, OCCEffecterCount,
	bootRestartPosition);
	}

	// Find the matching effecter for the OCC instance
	auto effecterEntry = occInstanceToEffecter.find(occInstanceId);
	if (effecterEntry == occInstanceToEffecter.end())
	{
	log<level::ERR>(
	fmt::format(
	"pldm: Failed to find a matching effecter for OCC instance {}",
	occInstanceId)
	.c_str());

	return;
	}

	if (!getMctpInstanceId(mctpInstance))
	{
	return;
	}

	// Prepare the SetStateEffecterStates request to reset the OCC
	auto request = prepareSetEffecterReq(
	mctpInstance, effecterEntry->second, OCCEffecterCount,
	bootRestartPosition, PLDM_STATE_SET_BOOT_RESTART_CAUSE_WARM_RESET);

	if (request.empty())
	{
	log<level::ERR>(
	"pldm: SetStateEffecterStates OCC reset request empty");
	return;
	}

	// Send request to reset the OCCs/PM Complex (ignore response)
	sendPldm(request, occInstanceId, false);
	}
	else
	{
	log<level::ERR>(
	fmt::format("resetOCC: HOST is not running (OCC{})", occInstanceId)
	.c_str());
	clearData();
	}
	}

	void Interface::sendHRESET(open_power::occ::instanceID sbeInstanceId)
	{
	if (open_power::occ::utils::isHostRunning())
	{
	if (sbeInstanceToEffecter.empty())
	{
	fetchEffecterInfo(PLDM_OEM_IBM_SBE_MAINTENANCE_STATE,
	sbeInstanceToEffecter, SBEEffecterCount,
	sbeMaintenanceStatePosition);
	}

	auto effecterEntry = sbeInstanceToEffecter.find(sbeInstanceId);
	if (effecterEntry == sbeInstanceToEffecter.end())
	{
	log<level::ERR>(
	"pldm: Failed to find a matching effecter for SBE instance",
	entry("SBE=%d", sbeInstanceId));
	return;
	}

	if (!getMctpInstanceId(mctpInstance))
	{
	return;
	}

	// Prepare the SetStateEffecterStates request to HRESET the SBE
	auto request = prepareSetEffecterReq(
	mctpInstance, effecterEntry->second, SBEEffecterCount,
	sbeMaintenanceStatePosition, SBE_RETRY_REQUIRED);

	if (request.empty())
	{
	log<level::ERR>(
	"pldm: SetStateEffecterStates HRESET request empty");
	return;
	}

	// Send request to issue HRESET of SBE (ignore response)
	sendPldm(request, sbeInstanceId, false);
	}
	else
	{
	log<level::ERR>(fmt::format("sendHRESET: HOST is not running (OCC{})",
	sbeInstanceId)
	.c_str());
	clearData();
	}
	}

	bool Interface::getMctpInstanceId(uint8_t& instanceId)
	{
	auto& bus = open_power::occ::utils::getBus();
	try
	{
	auto method = bus.new_method_call(
	"xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm",
	"xyz.openbmc_project.PLDM.Requester", "GetInstanceId");
	method.append(mctpEid);
	auto reply = bus.call(method);
	reply.read(instanceId);
	}
	catch (const sdbusplus::exception::exception& e)
	{
	log<level::ERR>("pldm: GetInstanceId returned error",
	entry("ERROR=%s", e.what()));
	return false;
	}

	return true;
	}

	void Interface::sendPldm(const std::vector<uint8_t>& request,
	const uint8_t instance, const bool rspExpected)
	{
	// Connect to MCTP scoket
	pldmFd = pldm_open();
	auto openErrno = errno;
	if (pldmFd == PLDM_REQUESTER_OPEN_FAIL)
	{
	log<level::ERR>(
	fmt::format(
	"sendPldm: Failed to connect to MCTP socket, errno={}/{}",
	openErrno, strerror(openErrno))
	.c_str());
	return;
	}

	// Send the PLDM request message to HBRT
	if (rspExpected)
	{
	// Register callback when response is available
	registerPldmRspCallback();

	// Send PLDM request
	log<level::INFO>(
	fmt::format(
	"sendPldm: calling pldm_send(OCC{}, instance:{}, {} bytes)",
	instance, mctpInstance, request.size())
	.c_str());
	pldmResponseReceived = false;
	pldmResponseTimeout = false;
	pldmResponseOcc = instance;
	auto pldmRc =
	pldm_send(mctpEid, pldmFd, request.data(), request.size());
	auto sendErrno = errno;
	if (pldmRc != PLDM_REQUESTER_SUCCESS)
	{
	log<level::ERR>(
	fmt::format(
	"sendPldm: pldm_send failed with rc={} and errno={}/{}",
	pldmRc, sendErrno, strerror(sendErrno))
	.c_str());
	pldmClose();
	return;
	}

	// start timer waiting for the response
	using namespace std::literals::chrono_literals;
	pldmRspTimer.restartOnce(10s);

	// Wait for response/timeout
	}
	else // not expecting the response
	{
	log<level::INFO>(
	fmt::format(
	"sendPldm: calling pldm_send(mctpID:{}, fd:{}, {} bytes) for OCC{}",
	mctpEid, pldmFd, request.size(), instance)
	.c_str());
	auto rc = pldm_send(mctpEid, pldmFd, request.data(), request.size());
	auto sendErrno = errno;
	if (rc)
	{
	log<level::ERR>(
	fmt::format(
	"sendPldm: pldm_send(mctpID:{}, fd:{}, {} bytes) failed with rc={} and errno={}/{}",
	mctpEid, pldmFd, request.size(), rc, sendErrno,
	strerror(sendErrno))
	.c_str());
	}
	pldmClose();
	}
	}

	// Attaches the FD to event loop and registers the callback handler
	void Interface::registerPldmRspCallback()
	{
	decltype(eventSource.get()) sourcePtr = nullptr;
	auto rc = sd_event_add_io(event.get(), &sourcePtr, pldmFd, EPOLLIN,
	pldmRspCallback, this);
	if (rc < 0)
	{
	log<level::ERR>(
	fmt::format(
	"registerPldmRspCallback: sd_event_add_io: Error({})={} : fd={}",
	rc, strerror(-rc), pldmFd)
	.c_str());
	}
	else
	{
	// puts sourcePtr in the event source.
	eventSource.reset(sourcePtr);
	}
	}

	// Add a timer to the event loop, default 30s.
	void Interface::pldmRspExpired()
	{
	if (!pldmResponseReceived)
	{
	log<level::ERR>(
	fmt::format(
	"pldmRspExpired: timerCallback - timeout waiting for pldm response for OCC{}",
	pldmResponseOcc)
	.c_str());
	pldmResponseTimeout = true;
	if (pldmFd)
	{
	pldmClose();
	}
	}
	return;
	};

	void Interface::pldmClose()
	{
	if (pldmRspTimer.isEnabled())
	{
	// stop PLDM response timer
	pldmRspTimer.setEnabled(false);
	}
	close(pldmFd);
	pldmFd = -1;
	eventSource.reset();
	}

	int Interface::pldmRspCallback(sd_event_source* /es/, int fd,
	uint32_t revents, void* userData)
	{
	if (!(revents & EPOLLIN))
	{
	log<level::INFO>(
	fmt::format("pldmRspCallback - revents={:08X}", revents).c_str());
	return -1;
	}

	auto pldmIface = static_cast<Interface*>(userData);

	uint8_t* responseMsg = nullptr;
	size_t responseMsgSize{};

	log<level::INFO>(
	fmt::format("pldmRspCallback: calling pldm_recv() instance:{}",
	pldmIface->mctpInstance)
	.c_str());
	auto rc = pldm_recv(mctpEid, fd, pldmIface->mctpInstance, &responseMsg,
	&responseMsgSize);
	int lastErrno = errno;
	if (rc)
	{
	log<level::ERR>(
	fmt::format(
	"pldmRspCallback: pldm_recv failed with rc={}, errno={}/{}", rc,
	lastErrno, strerror(lastErrno))
	.c_str());
	return -1;
	}
	log<level::INFO>(
	fmt::format("pldmRspCallback: pldm_recv() rsp was {} bytes",
	responseMsgSize)
	.c_str());

	if (pldmIface->pldmRspTimer.isEnabled())
	{
	// stop PLDM response timer
	pldmIface->pldmRspTimer.setEnabled(false);
	}

	// Set pointer to autodelete
	std::unique_ptr<uint8_t, decltype(std::free)*> responseMsgPtr{responseMsg,
	std::free};

	// We've got the response meant for the PLDM request msg that was
	// sent out
	// io.set_enabled(Enabled::Off);
	auto response = reinterpret_cast<pldm_msg*>(responseMsgPtr.get());
	if (response->payload[0] != PLDM_SUCCESS)
	{
	log<level::ERR>(
	fmt::format("pldmRspCallback: payload[0] was not success: {}",
	response->payload[0])
	.c_str());
	pldmIface->pldmClose();
	return -1;
	}

	// Decode the response
	uint8_t compCode = 0, sensorCount = 1;
	get_sensor_state_field field[6];
	responseMsgSize -= sizeof(pldm_msg_hdr);
	auto msgRc = decode_get_state_sensor_readings_resp(
	response, responseMsgSize, &compCode, &sensorCount, field);
	if ((msgRc != PLDM_SUCCESS) \|\| (compCode != PLDM_SUCCESS))
	{
	log<level::ERR>(
	fmt::format(
	"pldmRspCallback: decode_get_state_sensor_readings failed with rc={} and compCode={}",
	msgRc, compCode)
	.c_str());
	pldmIface->pldmClose();
	return -1;
	}

	pldmIface->pldmClose();

	const uint8_t instance = pldmIface->pldmResponseOcc;
	const uint8_t occSensorState = field[0].present_state;
	pldmIface->pldmResponseReceived = true;

	if (occSensorState == PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS_IN_SERVICE)
	{
	log<level::INFO>(
	fmt::format("pldmRspCallback: OCC{} is RUNNING", instance).c_str());
	pldmIface->callBack(instance, true);
	}
	else
	{
	log<level::INFO>(
	fmt::format("pldmRspCallback: OCC{} is not running (state:{})",
	instance, occSensorState)
	.c_str());
	pldmIface->callBack(instance, false);
	}

	return 0;
	};

	std::vector<uint8_t> Interface::encodeGetStateSensorRequest(uint8_t instance,
	uint16_t sensorId)
	{
	bitfield8_t sRearm = {0};
	const size_t msgSize =
	sizeof(pldm_msg_hdr) + PLDM_GET_STATE_SENSOR_READINGS_REQ_BYTES;
	std::vector<uint8_t> request(msgSize);
	auto msg = reinterpret_cast<pldm_msg*>(request.data());
	auto msgRc = encode_get_state_sensor_readings_req(mctpInstance, sensorId,
	sRearm, 0, msg);
	if (msgRc != PLDM_SUCCESS)
	{
	log<level::ERR>(
	fmt::format(
	"encodeGetStateSensorRequest: Failed to encode sensorId:0x{:08X} for OCC{} (rc={})",
	sensorId, instance, msgRc)
	.c_str());
	}
	return request;
	}

	// Initiate query of the specified OCC Active Sensor
	void Interface::checkActiveSensor(uint8_t instance)
	{
	static bool tracedOnce = false;
	if (pldmFd > 0)
	{
	if (!tracedOnce)
	{
	log<level::ERR>(
	fmt::format(
	"checkActiveSensor: already waiting on OCC{} (fd={})",
	pldmResponseOcc, pldmFd)
	.c_str());
	tracedOnce = true;
	}
	return;
	}
	tracedOnce = false;

	if (!isOCCSensorCacheValid())
	{
	fetchSensorInfo(PLDM_STATE_SET_OPERATIONAL_RUNNING_STATUS,
	sensorToOCCInstance, OCCSensorOffset);
	}

	// look up sensor id (key) based on instance
	auto entry = std::find_if(
	sensorToOCCInstance.begin(), sensorToOCCInstance.end(),
	[instance](const auto& entry) { return instance == entry.second; });
	if (entry != sensorToOCCInstance.end())
	{
	// Query the OCC Active Sensor state for this instance
	// SensorID sID = entry->first;
	log<level::INFO>(
	fmt::format("checkActiveSensor: OCC{} / sensorID: 0x{:04X}",
	instance, entry->first)
	.c_str());

	if (!getMctpInstanceId(mctpInstance))
	{
	log<level::ERR>("checkActiveSensor: failed to getMctpInstanceId");
	return;
	}

	// Encode GetStateSensorReadings PLDM message
	auto request = encodeGetStateSensorRequest(instance, entry->first);
	if (request.empty())
	{
	return;
	}

	// Send request to PLDM and setup callback for response
	sendPldm(request, instance, true);
	}
	else
	{
	log<level::ERR>(
	fmt::format(
	"checkActiveSensor: Unable to find PLDM sensor for OCC{}",
	instance)
	.c_str());
	}
	}

	} // namespace pldm