#include "inband_code_update.hpp" #include "libpldmresponder/pdr.hpp" #include "oem_ibm_handler.hpp" #include "xyz/openbmc_project/Common/error.hpp" #include #include #include #include #include #include #include PHOSPHOR_LOG2_USING; namespace pldm { using namespace utils; namespace responder { using namespace oem_ibm_platform; /** @brief Directory where the lid files without a header are stored */ auto lidDirPath = fs::path(LID_STAGING_DIR) / "lid"; /** @brief Directory where the image files are stored as they are built */ auto imageDirPath = fs::path(LID_STAGING_DIR) / "image"; /** @brief Directory where the code update tarball files are stored */ auto updateDirPath = fs::path(LID_STAGING_DIR) / "update"; /** @brief The file name of the code update tarball */ constexpr auto tarImageName = "image.tar"; /** @brief The file name of the hostfw image */ constexpr auto hostfwImageName = "image-hostfw"; /** @brief The path to the code update tarball file */ auto tarImagePath = fs::path(imageDirPath) / tarImageName; /** @brief The path to the hostfw image */ auto hostfwImagePath = fs::path(imageDirPath) / hostfwImageName; /** @brief The path to the tarball file expected by the phosphor software * manager */ auto updateImagePath = fs::path("/tmp/images") / tarImageName; std::string CodeUpdate::fetchCurrentBootSide() { return currBootSide; } std::string CodeUpdate::fetchNextBootSide() { return nextBootSide; } int CodeUpdate::setCurrentBootSide(const std::string& currSide) { currBootSide = currSide; return PLDM_SUCCESS; } int CodeUpdate::setNextBootSide(const std::string& nextSide) { nextBootSide = nextSide; std::string objPath{}; if (nextBootSide == currBootSide) { objPath = runningVersion; } else { objPath = nonRunningVersion; } if (objPath.empty()) { error("no nonRunningVersion present"); return PLDM_PLATFORM_INVALID_STATE_VALUE; } pldm::utils::DBusMapping dbusMapping{objPath, redundancyIntf, "Priority", "uint8_t"}; uint8_t val = 0; pldm::utils::PropertyValue value = static_cast(val); try { dBusIntf->setDbusProperty(dbusMapping, value); } catch (const std::exception& e) { error( "failed to set the next boot side to {OBJ_PATH} ERROR={ERR_EXCEP}", "OBJ_PATH", objPath.c_str(), "ERR_EXCEP", e.what()); return PLDM_ERROR; } return PLDM_SUCCESS; } int CodeUpdate::setRequestedApplyTime() { int rc = PLDM_SUCCESS; pldm::utils::PropertyValue value = "xyz.openbmc_project.Software.ApplyTime.RequestedApplyTimes.OnReset"; DBusMapping dbusMapping; dbusMapping.objectPath = "/xyz/openbmc_project/software/apply_time"; dbusMapping.interface = "xyz.openbmc_project.Software.ApplyTime"; dbusMapping.propertyName = "RequestedApplyTime"; dbusMapping.propertyType = "string"; try { pldm::utils::DBusHandler().setDbusProperty(dbusMapping, value); } catch (const std::exception& e) { error("Failed To set RequestedApplyTime property ERROR={ERR_EXCEP}", "ERR_EXCEP", e.what()); rc = PLDM_ERROR; } return rc; } int CodeUpdate::setRequestedActivation() { int rc = PLDM_SUCCESS; pldm::utils::PropertyValue value = "xyz.openbmc_project.Software.Activation.RequestedActivations.Active"; DBusMapping dbusMapping; dbusMapping.objectPath = newImageId; dbusMapping.interface = "xyz.openbmc_project.Software.Activation"; dbusMapping.propertyName = "RequestedActivation"; dbusMapping.propertyType = "string"; try { pldm::utils::DBusHandler().setDbusProperty(dbusMapping, value); } catch (const std::exception& e) { error("Failed To set RequestedActivation property ERROR={ERR_EXCEP}", "ERR_EXCEP", e.what()); rc = PLDM_ERROR; } return rc; } void CodeUpdate::setVersions() { static constexpr auto mapperService = "xyz.openbmc_project.ObjectMapper"; static constexpr auto functionalObjPath = "/xyz/openbmc_project/software/functional"; static constexpr auto activeObjPath = "/xyz/openbmc_project/software/active"; static constexpr auto propIntf = "org.freedesktop.DBus.Properties"; auto& bus = dBusIntf->getBus(); try { auto method = bus.new_method_call(mapperService, functionalObjPath, propIntf, "Get"); method.append("xyz.openbmc_project.Association", "endpoints"); std::variant> paths; auto reply = bus.call(method); reply.read(paths); runningVersion = std::get>(paths)[0]; auto method1 = bus.new_method_call(mapperService, activeObjPath, propIntf, "Get"); method1.append("xyz.openbmc_project.Association", "endpoints"); auto reply1 = bus.call(method1); reply1.read(paths); for (const auto& path : std::get>(paths)) { if (path != runningVersion) { nonRunningVersion = path; break; } } } catch (const std::exception& e) { error( "failed to make a d-bus call to Object Mapper Association, ERROR={ERR_EXCEP}", "ERR_EXCEP", e.what()); return; } using namespace sdbusplus::bus::match::rules; captureNextBootSideChange.push_back( std::make_unique( pldm::utils::DBusHandler::getBus(), propertiesChanged(runningVersion, redundancyIntf), [this](sdbusplus::message_t& msg) { DbusChangedProps props; std::string iface; msg.read(iface, props); processPriorityChangeNotification(props); })); fwUpdateMatcher.push_back(std::make_unique( pldm::utils::DBusHandler::getBus(), "interface='org.freedesktop.DBus.ObjectManager',type='signal'," "member='InterfacesAdded',path='/xyz/openbmc_project/software'", [this](sdbusplus::message_t& msg) { DBusInterfaceAdded interfaces; sdbusplus::message::object_path path; msg.read(path, interfaces); for (auto& interface : interfaces) { if (interface.first == "xyz.openbmc_project.Software.Activation") { auto imageInterface = "xyz.openbmc_project.Software.Activation"; auto imageObjPath = path.str.c_str(); try { auto propVal = dBusIntf->getDbusPropertyVariant( imageObjPath, "Activation", imageInterface); const auto& imageProp = std::get(propVal); if (imageProp == "xyz.openbmc_project.Software." "Activation.Activations.Ready" && isCodeUpdateInProgress()) { newImageId = path.str; if (!imageActivationMatch) { imageActivationMatch = std::make_unique< sdbusplus::bus::match_t>( pldm::utils::DBusHandler::getBus(), propertiesChanged(newImageId, "xyz.openbmc_project." "Software.Activation"), [this](sdbusplus::message_t& msg) { DbusChangedProps props; std::string iface; msg.read(iface, props); const auto itr = props.find("Activation"); if (itr != props.end()) { PropertyValue value = itr->second; auto propVal = std::get(value); if (propVal == "xyz.openbmc_project.Software." "Activation.Activations.Active") { CodeUpdateState state = CodeUpdateState::END; setCodeUpdateProgress(false); auto sensorId = getFirmwareUpdateSensor(); sendStateSensorEvent( sensorId, PLDM_STATE_SENSOR_STATE, 0, uint8_t(state), uint8_t(CodeUpdateState:: START)); newImageId.clear(); } else if (propVal == "xyz.openbmc_project." "Software.Activation." "Activations.Failed" || propVal == "xyz.openbmc_" "project.Software." "Activation." "Activations." "Invalid") { CodeUpdateState state = CodeUpdateState::FAIL; setCodeUpdateProgress(false); auto sensorId = getFirmwareUpdateSensor(); sendStateSensorEvent( sensorId, PLDM_STATE_SENSOR_STATE, 0, uint8_t(state), uint8_t(CodeUpdateState:: START)); newImageId.clear(); } } }); } auto rc = setRequestedActivation(); if (rc != PLDM_SUCCESS) { CodeUpdateState state = CodeUpdateState::FAIL; setCodeUpdateProgress(false); auto sensorId = getFirmwareUpdateSensor(); sendStateSensorEvent( sensorId, PLDM_STATE_SENSOR_STATE, 0, uint8_t(state), uint8_t(CodeUpdateState::START)); error("could not set RequestedActivation"); } break; } } catch (const sdbusplus::exception_t& e) { error( "Error in getting Activation status,ERROR= {ERR_EXCEP}, INTERFACE={IMG_INTERFACE}, OBJECT PATH={OBJ_PATH}", "ERR_EXCEP", e.what(), "IMG_INTERFACE", imageInterface, "OBJ_PATH", imageObjPath); } } } })); } void CodeUpdate::processPriorityChangeNotification( const DbusChangedProps& chProperties) { static constexpr auto propName = "Priority"; const auto it = chProperties.find(propName); if (it == chProperties.end()) { return; } uint8_t newVal = std::get(it->second); nextBootSide = (newVal == 0) ? currBootSide : ((currBootSide == Tside) ? Pside : Tside); } void CodeUpdate::setOemPlatformHandler( pldm::responder::oem_platform::Handler* handler) { oemPlatformHandler = handler; } void CodeUpdate::clearDirPath(const std::string& dirPath) { if (!fs::is_directory(dirPath)) { error("The directory does not exist, dirPath = {DIR_PATH}", "DIR_PATH", dirPath.c_str()); return; } for (const auto& iter : fs::directory_iterator(dirPath)) { fs::remove_all(iter); } } void CodeUpdate::sendStateSensorEvent( uint16_t sensorId, enum sensor_event_class_states sensorEventClass, uint8_t sensorOffset, uint8_t eventState, uint8_t prevEventState) { pldm::responder::oem_ibm_platform::Handler* oemIbmPlatformHandler = dynamic_cast( oemPlatformHandler); oemIbmPlatformHandler->sendStateSensorEvent( sensorId, sensorEventClass, sensorOffset, eventState, prevEventState); } void CodeUpdate::deleteImage() { static constexpr auto UPDATER_SERVICE = "xyz.openbmc_project.Software.BMC.Updater"; static constexpr auto SW_OBJ_PATH = "/xyz/openbmc_project/software"; static constexpr auto DELETE_INTF = "xyz.openbmc_project.Collection.DeleteAll"; auto& bus = dBusIntf->getBus(); try { auto method = bus.new_method_call(UPDATER_SERVICE, SW_OBJ_PATH, DELETE_INTF, "DeleteAll"); bus.call_noreply(method); } catch (const std::exception& e) { error("Failed to delete image, ERROR={ERR_EXCEP}", "ERR_EXCEP", e.what()); return; } } uint8_t fetchBootSide(uint16_t entityInstance, CodeUpdate* codeUpdate) { uint8_t sensorOpState = tSideNum; if (entityInstance == 0) { auto currSide = codeUpdate->fetchCurrentBootSide(); if (currSide == Pside) { sensorOpState = pSideNum; } } else if (entityInstance == 1) { auto nextSide = codeUpdate->fetchNextBootSide(); if (nextSide == Pside) { sensorOpState = pSideNum; } } else { sensorOpState = PLDM_SENSOR_UNKNOWN; } return sensorOpState; } int setBootSide(uint16_t entityInstance, uint8_t currState, const std::vector& stateField, CodeUpdate* codeUpdate) { int rc = PLDM_SUCCESS; auto side = (stateField[currState].effecter_state == pSideNum) ? "P" : "T"; if (entityInstance == 0) { rc = codeUpdate->setCurrentBootSide(side); } else if (entityInstance == 1) { rc = codeUpdate->setNextBootSide(side); } else { rc = PLDM_PLATFORM_INVALID_STATE_VALUE; } return rc; } template int executeCmd(T const&... t) { std::stringstream cmd; ((cmd << t << " "), ...) << std::endl; FILE* pipe = popen(cmd.str().c_str(), "r"); if (!pipe) { throw std::runtime_error("popen() failed!"); } int rc = pclose(pipe); if (WEXITSTATUS(rc)) { std::cerr << "Error executing: "; ((std::cerr << " " << t), ...); std::cerr << "\n"; return -1; } return 0; } int processCodeUpdateLid(const std::string& filePath) { struct LidHeader { uint16_t magicNumber; uint16_t headerVersion; uint32_t lidNumber; uint32_t lidDate; uint16_t lidTime; uint16_t lidClass; uint32_t lidCrc; uint32_t lidSize; uint32_t headerSize; }; LidHeader header; std::ifstream ifs(filePath, std::ios::in | std::ios::binary); if (!ifs) { error("ifstream open error: {DIR_PATH}", "DIR_PATH", filePath.c_str()); return PLDM_ERROR; } ifs.seekg(0); ifs.read(reinterpret_cast(&header), sizeof(header)); // File size should be the value of lid size minus the header size auto fileSize = fs::file_size(filePath); fileSize -= htonl(header.headerSize); if (fileSize < htonl(header.lidSize)) { // File is not completely written yet ifs.close(); return PLDM_SUCCESS; } constexpr auto magicNumber = 0x0222; if (htons(header.magicNumber) != magicNumber) { error("Invalid magic number: {DIR_PATH}", "DIR_PATH", filePath.c_str()); ifs.close(); return PLDM_ERROR; } fs::create_directories(imageDirPath); fs::create_directories(lidDirPath); constexpr auto bmcClass = 0x2000; if (htons(header.lidClass) == bmcClass) { // Skip the header and concatenate the BMC LIDs into a tar file std::ofstream ofs(tarImagePath, std::ios::out | std::ios::binary | std::ios::app); ifs.seekg(htonl(header.headerSize)); ofs << ifs.rdbuf(); ofs.flush(); ofs.close(); } else { std::stringstream lidFileName; lidFileName << std::hex << htonl(header.lidNumber) << ".lid"; auto lidNoHeaderPath = fs::path(lidDirPath) / lidFileName.str(); std::ofstream ofs(lidNoHeaderPath, std::ios::out | std::ios::binary | std::ios::trunc); ifs.seekg(htonl(header.headerSize)); ofs << ifs.rdbuf(); ofs.flush(); ofs.close(); } ifs.close(); fs::remove(filePath); return PLDM_SUCCESS; } int CodeUpdate::assembleCodeUpdateImage() { pid_t pid = fork(); if (pid == 0) { pid_t nextPid = fork(); if (nextPid == 0) { // Create the hostfw squashfs image from the LID files without // header auto rc = executeCmd("/usr/sbin/mksquashfs", lidDirPath.c_str(), hostfwImagePath.c_str(), "-all-root", "-no-recovery"); if (rc < 0) { error("Error occurred during the mksqusquashfs call"); setCodeUpdateProgress(false); auto sensorId = getFirmwareUpdateSensor(); sendStateSensorEvent(sensorId, PLDM_STATE_SENSOR_STATE, 0, uint8_t(CodeUpdateState::FAIL), uint8_t(CodeUpdateState::START)); exit(EXIT_FAILURE); } fs::create_directories(updateDirPath); // Extract the BMC tarball content rc = executeCmd("/bin/tar", "-xf", tarImagePath.c_str(), "-C", updateDirPath); if (rc < 0) { setCodeUpdateProgress(false); auto sensorId = getFirmwareUpdateSensor(); sendStateSensorEvent(sensorId, PLDM_STATE_SENSOR_STATE, 0, uint8_t(CodeUpdateState::FAIL), uint8_t(CodeUpdateState::START)); exit(EXIT_FAILURE); } // Add the hostfw image to the directory where the contents were // extracted fs::copy_file(hostfwImagePath, fs::path(updateDirPath) / hostfwImageName, fs::copy_options::overwrite_existing); // Remove the tarball file, then re-generate it with so that the // hostfw image becomes part of the tarball fs::remove(tarImagePath); rc = executeCmd("/bin/tar", "-cf", tarImagePath, ".", "-C", updateDirPath); if (rc < 0) { error("Error occurred during the generation of the tarball"); setCodeUpdateProgress(false); auto sensorId = getFirmwareUpdateSensor(); sendStateSensorEvent(sensorId, PLDM_STATE_SENSOR_STATE, 0, uint8_t(CodeUpdateState::FAIL), uint8_t(CodeUpdateState::START)); exit(EXIT_FAILURE); } // Copy the tarball to the update directory to trigger the phosphor // software manager to create a version interface fs::copy_file(tarImagePath, updateImagePath, fs::copy_options::overwrite_existing); // Cleanup fs::remove_all(updateDirPath); fs::remove_all(lidDirPath); fs::remove_all(imageDirPath); exit(EXIT_SUCCESS); } else if (nextPid < 0) { error("Error occurred during fork. ERROR={ERR}", "ERR", errno); exit(EXIT_FAILURE); } // Do nothing as parent. When parent exits, child will be reparented // under init and be reaped properly. exit(0); } else if (pid > 0) { int status; if (waitpid(pid, &status, 0) < 0) { error("Error occurred during waitpid. ERROR={ERR}", "ERR", errno); return PLDM_ERROR; } else if (WEXITSTATUS(status) != 0) { error( "Failed to execute the assembling of the image. STATUS={IMG_STATUS}", "IMG_STATUS", status); return PLDM_ERROR; } } else { error("Error occurred during fork. ERROR={ERR}", "ERR", errno); return PLDM_ERROR; } return PLDM_SUCCESS; } } // namespace responder } // namespace pldm