| #include "config.h" |
| |
| #include "softoff.hpp" |
| |
| #include "common/utils.hpp" |
| |
| #include <libpldm/entity.h> |
| #include <libpldm/platform.h> |
| #include <libpldm/pldm.h> |
| #include <libpldm/state_set.h> |
| |
| #include <sdbusplus/bus.hpp> |
| #include <sdeventplus/clock.hpp> |
| #include <sdeventplus/exception.hpp> |
| #include <sdeventplus/source/io.hpp> |
| #include <sdeventplus/source/time.hpp> |
| |
| #include <array> |
| #include <iostream> |
| |
| namespace pldm |
| { |
| |
| using namespace sdeventplus; |
| using namespace sdeventplus::source; |
| constexpr auto clockId = sdeventplus::ClockId::RealTime; |
| using Clock = Clock<clockId>; |
| using Timer = Time<clockId>; |
| |
| constexpr pldm::pdr::TerminusID TID = 0; // TID will be implemented later. |
| namespace sdbusRule = sdbusplus::bus::match::rules; |
| |
| SoftPowerOff::SoftPowerOff(sdbusplus::bus_t& bus, sd_event* event) : |
| bus(bus), timer(event) |
| { |
| getHostState(); |
| if (hasError || completed) |
| { |
| return; |
| } |
| |
| auto rc = getEffecterID(); |
| if (completed) |
| { |
| std::cerr |
| << "pldm-softpoweroff: effecter to initiate softoff not found \n"; |
| return; |
| } |
| else if (rc != PLDM_SUCCESS) |
| { |
| hasError = true; |
| return; |
| } |
| |
| rc = getSensorInfo(); |
| if (rc != PLDM_SUCCESS) |
| { |
| std::cerr << "Message get Sensor PDRs error. PLDM error code = " |
| << std::hex << std::showbase << rc << "\n"; |
| hasError = true; |
| return; |
| } |
| |
| // Matches on the pldm StateSensorEvent signal |
| pldmEventSignal = std::make_unique<sdbusplus::bus::match_t>( |
| bus, |
| sdbusRule::type::signal() + sdbusRule::member("StateSensorEvent") + |
| sdbusRule::path("/xyz/openbmc_project/pldm") + |
| sdbusRule::interface("xyz.openbmc_project.PLDM.Event"), |
| std::bind(std::mem_fn(&SoftPowerOff::hostSoftOffComplete), this, |
| std::placeholders::_1)); |
| } |
| |
| int SoftPowerOff::getHostState() |
| { |
| try |
| { |
| pldm::utils::PropertyValue propertyValue = |
| pldm::utils::DBusHandler().getDbusPropertyVariant( |
| "/xyz/openbmc_project/state/host0", "CurrentHostState", |
| "xyz.openbmc_project.State.Host"); |
| |
| if ((std::get<std::string>(propertyValue) != |
| "xyz.openbmc_project.State.Host.HostState.Running") && |
| (std::get<std::string>(propertyValue) != |
| "xyz.openbmc_project.State.Host.HostState.TransitioningToOff")) |
| { |
| // Host state is not "Running", this app should return success |
| completed = true; |
| return PLDM_SUCCESS; |
| } |
| } |
| catch (const std::exception& e) |
| { |
| std::cerr << "PLDM host soft off: Can't get current host state.\n"; |
| hasError = true; |
| return PLDM_ERROR; |
| } |
| |
| return PLDM_SUCCESS; |
| } |
| |
| void SoftPowerOff::hostSoftOffComplete(sdbusplus::message_t& msg) |
| { |
| pldm::pdr::TerminusID msgTID; |
| pldm::pdr::SensorID msgSensorID; |
| pldm::pdr::SensorOffset msgSensorOffset; |
| pldm::pdr::EventState msgEventState; |
| pldm::pdr::EventState msgPreviousEventState; |
| |
| // Read the msg and populate each variable |
| msg.read(msgTID, msgSensorID, msgSensorOffset, msgEventState, |
| msgPreviousEventState); |
| |
| if (msgSensorID == sensorID && msgSensorOffset == sensorOffset && |
| msgEventState == PLDM_SW_TERM_GRACEFUL_SHUTDOWN) |
| { |
| // Receive Graceful shutdown completion event message. Disable the timer |
| auto rc = timer.stop(); |
| if (rc < 0) |
| { |
| std::cerr << "PLDM soft off: Failure to STOP the timer. ERRNO=" |
| << rc << "\n"; |
| } |
| |
| // This marks the completion of pldm soft power off. |
| completed = true; |
| } |
| } |
| |
| int SoftPowerOff::getEffecterID() |
| { |
| auto& bus = pldm::utils::DBusHandler::getBus(); |
| |
| // VMM is a logical entity, so the bit 15 in entity type is set. |
| pdr::EntityType entityType = PLDM_ENTITY_VIRTUAL_MACHINE_MANAGER | 0x8000; |
| |
| try |
| { |
| std::vector<std::vector<uint8_t>> VMMResponse{}; |
| auto VMMMethod = bus.new_method_call( |
| "xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm", |
| "xyz.openbmc_project.PLDM.PDR", "FindStateEffecterPDR"); |
| VMMMethod.append(TID, entityType, |
| (uint16_t)PLDM_STATE_SET_SW_TERMINATION_STATUS); |
| |
| auto VMMResponseMsg = bus.call(VMMMethod); |
| |
| VMMResponseMsg.read(VMMResponse); |
| if (VMMResponse.size() != 0) |
| { |
| for (auto& rep : VMMResponse) |
| { |
| auto VMMPdr = |
| reinterpret_cast<pldm_state_effecter_pdr*>(rep.data()); |
| effecterID = VMMPdr->effecter_id; |
| } |
| } |
| else |
| { |
| VMMPdrExist = false; |
| } |
| } |
| catch (const sdbusplus::exception_t& e) |
| { |
| std::cerr << "PLDM soft off: Error get VMM PDR,ERROR=" << e.what() |
| << "\n"; |
| VMMPdrExist = false; |
| } |
| |
| if (VMMPdrExist) |
| { |
| return PLDM_SUCCESS; |
| } |
| |
| // If the Virtual Machine Manager PDRs doesn't exist, go find the System |
| // Firmware PDRs. |
| // System Firmware is a logical entity, so the bit 15 in entity type is set |
| entityType = PLDM_ENTITY_SYS_FIRMWARE | 0x8000; |
| try |
| { |
| std::vector<std::vector<uint8_t>> sysFwResponse{}; |
| auto sysFwMethod = bus.new_method_call( |
| "xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm", |
| "xyz.openbmc_project.PLDM.PDR", "FindStateEffecterPDR"); |
| sysFwMethod.append(TID, entityType, |
| (uint16_t)PLDM_STATE_SET_SW_TERMINATION_STATUS); |
| |
| auto sysFwResponseMsg = bus.call(sysFwMethod); |
| |
| sysFwResponseMsg.read(sysFwResponse); |
| |
| if (sysFwResponse.size() == 0) |
| { |
| std::cerr |
| << "No effecter ID has been found that matches the criteria" |
| << "\n"; |
| return PLDM_ERROR; |
| } |
| |
| for (auto& rep : sysFwResponse) |
| { |
| auto sysFwPdr = |
| reinterpret_cast<pldm_state_effecter_pdr*>(rep.data()); |
| effecterID = sysFwPdr->effecter_id; |
| } |
| } |
| catch (const sdbusplus::exception_t& e) |
| { |
| std::cerr << "PLDM soft off: Error get system firmware PDR,ERROR=" |
| << e.what() << "\n"; |
| completed = true; |
| return PLDM_ERROR; |
| } |
| |
| return PLDM_SUCCESS; |
| } |
| |
| int SoftPowerOff::getSensorInfo() |
| { |
| pldm::pdr::EntityType entityType; |
| |
| entityType = VMMPdrExist ? PLDM_ENTITY_VIRTUAL_MACHINE_MANAGER |
| : PLDM_ENTITY_SYS_FIRMWARE; |
| |
| // The Virtual machine manager/System firmware is logical entity, so bit 15 |
| // need to be set. |
| entityType = entityType | 0x8000; |
| |
| try |
| { |
| auto& bus = pldm::utils::DBusHandler::getBus(); |
| std::vector<std::vector<uint8_t>> Response{}; |
| auto method = bus.new_method_call( |
| "xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm", |
| "xyz.openbmc_project.PLDM.PDR", "FindStateSensorPDR"); |
| method.append(TID, entityType, |
| (uint16_t)PLDM_STATE_SET_SW_TERMINATION_STATUS); |
| |
| auto ResponseMsg = bus.call(method); |
| |
| ResponseMsg.read(Response); |
| |
| if (Response.size() == 0) |
| { |
| std::cerr |
| << "No sensor PDR has been found that matches the criteria" |
| << "\n"; |
| return PLDM_ERROR; |
| } |
| |
| pldm_state_sensor_pdr* pdr; |
| for (auto& rep : Response) |
| { |
| pdr = reinterpret_cast<pldm_state_sensor_pdr*>(rep.data()); |
| if (!pdr) |
| { |
| std::cerr << "Failed to get state sensor PDR.\n"; |
| return PLDM_ERROR; |
| } |
| } |
| |
| sensorID = pdr->sensor_id; |
| |
| auto compositeSensorCount = pdr->composite_sensor_count; |
| auto possibleStatesStart = pdr->possible_states; |
| |
| for (auto offset = 0; offset < compositeSensorCount; offset++) |
| { |
| auto possibleStates = |
| reinterpret_cast<state_sensor_possible_states*>( |
| possibleStatesStart); |
| auto setId = possibleStates->state_set_id; |
| auto possibleStateSize = possibleStates->possible_states_size; |
| |
| if (setId == PLDM_STATE_SET_SW_TERMINATION_STATUS) |
| { |
| sensorOffset = offset; |
| break; |
| } |
| possibleStatesStart += |
| possibleStateSize + sizeof(setId) + sizeof(possibleStateSize); |
| } |
| } |
| catch (const sdbusplus::exception_t& e) |
| { |
| std::cerr << "PLDM soft off: Error get State Sensor PDR,ERROR=" |
| << e.what() << "\n"; |
| return PLDM_ERROR; |
| } |
| |
| return PLDM_SUCCESS; |
| } |
| |
| int SoftPowerOff::hostSoftOff(sdeventplus::Event& event) |
| { |
| constexpr uint8_t effecterCount = 1; |
| uint8_t mctpEID; |
| uint8_t instanceID; |
| |
| mctpEID = pldm::utils::readHostEID(); |
| |
| // Get instanceID |
| try |
| { |
| auto& bus = pldm::utils::DBusHandler::getBus(); |
| auto method = bus.new_method_call( |
| "xyz.openbmc_project.PLDM", "/xyz/openbmc_project/pldm", |
| "xyz.openbmc_project.PLDM.Requester", "GetInstanceId"); |
| method.append(mctpEID); |
| |
| auto ResponseMsg = bus.call(method); |
| |
| ResponseMsg.read(instanceID); |
| } |
| catch (const sdbusplus::exception_t& e) |
| { |
| std::cerr << "PLDM soft off: Error get instanceID,ERROR=" << e.what() |
| << "\n"; |
| return PLDM_ERROR; |
| } |
| |
| std::array<uint8_t, sizeof(pldm_msg_hdr) + sizeof(effecterID) + |
| sizeof(effecterCount) + |
| sizeof(set_effecter_state_field)> |
| requestMsg{}; |
| auto request = reinterpret_cast<pldm_msg*>(requestMsg.data()); |
| set_effecter_state_field stateField{ |
| PLDM_REQUEST_SET, PLDM_SW_TERM_GRACEFUL_SHUTDOWN_REQUESTED}; |
| auto rc = encode_set_state_effecter_states_req( |
| instanceID, effecterID, effecterCount, &stateField, request); |
| if (rc != PLDM_SUCCESS) |
| { |
| std::cerr << "Message encode failure. PLDM error code = " << std::hex |
| << std::showbase << rc << "\n"; |
| return PLDM_ERROR; |
| } |
| |
| // Open connection to MCTP socket |
| int fd = pldm_open(); |
| if (-1 == fd) |
| { |
| std::cerr << "Failed to connect to mctp demux daemon" |
| << "\n"; |
| return PLDM_ERROR; |
| } |
| |
| // Add a timer to the event loop, default 30s. |
| auto timerCallback = [=, this](Timer& /*source*/, |
| Timer::TimePoint /*time*/) { |
| if (!responseReceived) |
| { |
| std::cerr |
| << "PLDM soft off: ERROR! Can't get the response for the PLDM request msg. Time out!\n" |
| << "Exit the pldm-softpoweroff\n"; |
| exit(-1); |
| } |
| return; |
| }; |
| Timer time(event, (Clock(event).now() + std::chrono::seconds{30}), |
| std::chrono::seconds{1}, std::move(timerCallback)); |
| |
| // Add a callback to handle EPOLLIN on fd |
| auto callback = [=, this](IO& io, int fd, uint32_t revents) { |
| if (!(revents & EPOLLIN)) |
| { |
| return; |
| } |
| |
| uint8_t* responseMsg = nullptr; |
| size_t responseMsgSize{}; |
| |
| auto rc = pldm_recv(mctpEID, fd, request->hdr.instance_id, &responseMsg, |
| &responseMsgSize); |
| if (rc) |
| { |
| std::cerr << "Soft off: failed to recv pldm data. PLDM RC = " << rc |
| << "\n"; |
| return; |
| } |
| |
| 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) |
| { |
| std::cerr << "Getting the wrong response. PLDM RC = " |
| << (unsigned)response->payload[0] << "\n"; |
| exit(-1); |
| } |
| |
| responseReceived = true; |
| |
| // Start Timer |
| using namespace std::chrono; |
| auto timeMicroseconds = |
| duration_cast<microseconds>(seconds(SOFTOFF_TIMEOUT_SECONDS)); |
| |
| auto ret = startTimer(timeMicroseconds); |
| if (ret < 0) |
| { |
| std::cerr << "Failure to start Host soft off wait timer, ERRNO = " |
| << ret << "Exit the pldm-softpoweroff\n"; |
| exit(-1); |
| } |
| else |
| { |
| std::cerr |
| << "Timer started waiting for host soft off, TIMEOUT_IN_SEC = " |
| << SOFTOFF_TIMEOUT_SECONDS << "\n"; |
| } |
| return; |
| }; |
| IO io(event, fd, EPOLLIN, std::move(callback)); |
| |
| // Send PLDM Request message - pldm_send doesn't wait for response |
| rc = pldm_send(mctpEID, fd, requestMsg.data(), requestMsg.size()); |
| if (0 > rc) |
| { |
| std::cerr << "Failed to send message/receive response. RC = " << rc |
| << ", errno = " << errno << "\n"; |
| return PLDM_ERROR; |
| } |
| |
| // Time out or soft off complete |
| while (!isCompleted() && !isTimerExpired()) |
| { |
| try |
| { |
| event.run(std::nullopt); |
| } |
| catch (const sdeventplus::SdEventError& e) |
| { |
| std::cerr |
| << "PLDM host soft off: Failure in processing request.ERROR= " |
| << e.what() << "\n"; |
| return PLDM_ERROR; |
| } |
| } |
| |
| return PLDM_SUCCESS; |
| } |
| |
| int SoftPowerOff::startTimer(const std::chrono::microseconds& usec) |
| { |
| return timer.start(usec); |
| } |
| } // namespace pldm |