1 2 #include "common/flight_recorder.hpp" 3 #include "common/instance_id.hpp" 4 #include "common/transport.hpp" 5 #include "common/utils.hpp" 6 #include "dbus_impl_requester.hpp" 7 #include "fw-update/manager.hpp" 8 #include "invoker.hpp" 9 #include "requester/handler.hpp" 10 #include "requester/mctp_endpoint_discovery.hpp" 11 #include "requester/request.hpp" 12 13 #include <err.h> 14 #include <getopt.h> 15 #include <libpldm/base.h> 16 #include <libpldm/bios.h> 17 #include <libpldm/pdr.h> 18 #include <libpldm/platform.h> 19 #include <libpldm/transport.h> 20 #include <poll.h> 21 #include <stdlib.h> 22 #include <sys/socket.h> 23 #include <sys/types.h> 24 #include <sys/un.h> 25 #include <unistd.h> 26 27 #include <phosphor-logging/lg2.hpp> 28 #include <sdeventplus/event.hpp> 29 #include <sdeventplus/source/io.hpp> 30 #include <sdeventplus/source/signal.hpp> 31 #include <stdplus/signal.hpp> 32 33 #include <cstdio> 34 #include <cstring> 35 #include <fstream> 36 #include <iomanip> 37 #include <iostream> 38 #include <iterator> 39 #include <memory> 40 #include <ranges> 41 #include <sstream> 42 #include <stdexcept> 43 #include <string> 44 #include <vector> 45 46 PHOSPHOR_LOG2_USING; 47 48 #ifdef LIBPLDMRESPONDER 49 #include "dbus_impl_pdr.hpp" 50 #include "host-bmc/dbus_to_event_handler.hpp" 51 #include "host-bmc/dbus_to_host_effecters.hpp" 52 #include "host-bmc/host_condition.hpp" 53 #include "host-bmc/host_pdr_handler.hpp" 54 #include "libpldmresponder/base.hpp" 55 #include "libpldmresponder/bios.hpp" 56 #include "libpldmresponder/fru.hpp" 57 #include "libpldmresponder/oem_handler.hpp" 58 #include "libpldmresponder/platform.hpp" 59 #include "xyz/openbmc_project/PLDM/Event/server.hpp" 60 #endif 61 62 #ifdef OEM_IBM 63 #include "libpldmresponder/bios_oem_ibm.hpp" 64 #include "libpldmresponder/file_io.hpp" 65 #include "libpldmresponder/oem_ibm_handler.hpp" 66 #endif 67 68 constexpr uint8_t MCTP_MSG_TYPE_PLDM = 1; 69 70 using namespace pldm; 71 using namespace sdeventplus; 72 using namespace sdeventplus::source; 73 using namespace pldm::responder; 74 using namespace pldm::utils; 75 using sdeventplus::source::Signal; 76 using namespace pldm::flightrecorder; 77 78 void interruptFlightRecorderCallBack(Signal& /*signal*/, 79 const struct signalfd_siginfo*) 80 { 81 error("Received SIGUR1(10) Signal interrupt"); 82 // obtain the flight recorder instance and dump the recorder 83 FlightRecorder::GetInstance().playRecorder(); 84 } 85 86 static std::optional<Response> 87 processRxMsg(const std::vector<uint8_t>& requestMsg, Invoker& invoker, 88 requester::Handler<requester::Request>& handler, 89 fw_update::Manager* fwManager, pldm_tid_t tid) 90 { 91 uint8_t eid = tid; 92 93 pldm_header_info hdrFields{}; 94 auto hdr = reinterpret_cast<const pldm_msg_hdr*>(requestMsg.data()); 95 if (PLDM_SUCCESS != unpack_pldm_header(hdr, &hdrFields)) 96 { 97 error("Empty PLDM request header"); 98 return std::nullopt; 99 } 100 101 if (PLDM_RESPONSE != hdrFields.msg_type) 102 { 103 Response response; 104 auto request = reinterpret_cast<const pldm_msg*>(hdr); 105 size_t requestLen = requestMsg.size() - sizeof(struct pldm_msg_hdr); 106 try 107 { 108 if (hdrFields.pldm_type != PLDM_FWUP) 109 { 110 response = invoker.handle(hdrFields.pldm_type, 111 hdrFields.command, request, 112 requestLen); 113 } 114 else 115 { 116 response = fwManager->handleRequest(eid, hdrFields.command, 117 request, requestLen); 118 } 119 } 120 catch (const std::out_of_range& e) 121 { 122 uint8_t completion_code = PLDM_ERROR_UNSUPPORTED_PLDM_CMD; 123 response.resize(sizeof(pldm_msg_hdr)); 124 auto responseHdr = reinterpret_cast<pldm_msg_hdr*>(response.data()); 125 pldm_header_info header{}; 126 header.msg_type = PLDM_RESPONSE; 127 header.instance = hdrFields.instance; 128 header.pldm_type = hdrFields.pldm_type; 129 header.command = hdrFields.command; 130 if (PLDM_SUCCESS != pack_pldm_header(&header, responseHdr)) 131 { 132 error("Failed adding response header"); 133 return std::nullopt; 134 } 135 response.insert(response.end(), completion_code); 136 } 137 return response; 138 } 139 else if (PLDM_RESPONSE == hdrFields.msg_type) 140 { 141 auto response = reinterpret_cast<const pldm_msg*>(hdr); 142 size_t responseLen = requestMsg.size() - sizeof(struct pldm_msg_hdr); 143 handler.handleResponse(eid, hdrFields.instance, hdrFields.pldm_type, 144 hdrFields.command, response, responseLen); 145 } 146 return std::nullopt; 147 } 148 149 void optionUsage(void) 150 { 151 info("Usage: pldmd [options]"); 152 info("Options:"); 153 info(" [--verbose] - would enable verbosity"); 154 } 155 156 int main(int argc, char** argv) 157 { 158 bool verbose = false; 159 static struct option long_options[] = {{"verbose", no_argument, 0, 'v'}, 160 {0, 0, 0, 0}}; 161 162 auto argflag = getopt_long(argc, argv, "v", long_options, nullptr); 163 switch (argflag) 164 { 165 case 'v': 166 verbose = true; 167 break; 168 case -1: 169 break; 170 default: 171 optionUsage(); 172 exit(EXIT_FAILURE); 173 } 174 175 // Setup PLDM requester transport 176 auto hostEID = pldm::utils::readHostEID(); 177 /* To maintain current behaviour until we have the infrastructure to find 178 * and use the correct TIDs */ 179 pldm_tid_t TID = hostEID; 180 PldmTransport pldmTransport{}; 181 auto event = Event::get_default(); 182 auto& bus = pldm::utils::DBusHandler::getBus(); 183 sdbusplus::server::manager_t objManager(bus, 184 "/xyz/openbmc_project/software"); 185 186 InstanceIdDb instanceIdDb; 187 dbus_api::Requester dbusImplReq(bus, "/xyz/openbmc_project/pldm", 188 instanceIdDb); 189 sdbusplus::server::manager_t inventoryManager( 190 bus, "/xyz/openbmc_project/inventory"); 191 192 Invoker invoker{}; 193 requester::Handler<requester::Request> reqHandler(&pldmTransport, event, 194 instanceIdDb, verbose); 195 196 #ifdef LIBPLDMRESPONDER 197 using namespace pldm::state_sensor; 198 dbus_api::Host dbusImplHost(bus, "/xyz/openbmc_project/pldm"); 199 std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> pdrRepo( 200 pldm_pdr_init(), pldm_pdr_destroy); 201 if (!pdrRepo) 202 { 203 throw std::runtime_error("Failed to instantiate PDR repository"); 204 } 205 std::unique_ptr<pldm_entity_association_tree, 206 decltype(&pldm_entity_association_tree_destroy)> 207 entityTree(pldm_entity_association_tree_init(), 208 pldm_entity_association_tree_destroy); 209 if (!entityTree) 210 { 211 throw std::runtime_error( 212 "Failed to instantiate general PDR entity association tree"); 213 } 214 std::unique_ptr<pldm_entity_association_tree, 215 decltype(&pldm_entity_association_tree_destroy)> 216 bmcEntityTree(pldm_entity_association_tree_init(), 217 pldm_entity_association_tree_destroy); 218 if (!bmcEntityTree) 219 { 220 throw std::runtime_error( 221 "Failed to instantiate BMC PDR entity association tree"); 222 } 223 std::shared_ptr<HostPDRHandler> hostPDRHandler; 224 std::unique_ptr<pldm::host_effecters::HostEffecterParser> 225 hostEffecterParser; 226 std::unique_ptr<DbusToPLDMEvent> dbusToPLDMEventHandler; 227 DBusHandler dbusHandler; 228 if (hostEID) 229 { 230 hostPDRHandler = std::make_shared<HostPDRHandler>( 231 pldmTransport.getEventSource(), hostEID, event, pdrRepo.get(), 232 EVENTS_JSONS_DIR, entityTree.get(), bmcEntityTree.get(), 233 instanceIdDb, &reqHandler); 234 // HostFirmware interface needs access to hostPDR to know if host 235 // is running 236 dbusImplHost.setHostPdrObj(hostPDRHandler); 237 238 hostEffecterParser = 239 std::make_unique<pldm::host_effecters::HostEffecterParser>( 240 &instanceIdDb, pldmTransport.getEventSource(), pdrRepo.get(), 241 &dbusHandler, HOST_JSONS_DIR, &reqHandler); 242 dbusToPLDMEventHandler = std::make_unique<DbusToPLDMEvent>( 243 pldmTransport.getEventSource(), hostEID, instanceIdDb, &reqHandler); 244 } 245 std::unique_ptr<oem_platform::Handler> oemPlatformHandler{}; 246 std::unique_ptr<oem_bios::Handler> oemBiosHandler{}; 247 248 #ifdef OEM_IBM 249 std::unique_ptr<pldm::responder::CodeUpdate> codeUpdate = 250 std::make_unique<pldm::responder::CodeUpdate>(&dbusHandler); 251 codeUpdate->clearDirPath(LID_STAGING_DIR); 252 oemPlatformHandler = std::make_unique<oem_ibm_platform::Handler>( 253 &dbusHandler, codeUpdate.get(), pldmTransport.getEventSource(), hostEID, 254 instanceIdDb, event, &reqHandler); 255 codeUpdate->setOemPlatformHandler(oemPlatformHandler.get()); 256 invoker.registerHandler(PLDM_OEM, std::make_unique<oem_ibm::Handler>( 257 oemPlatformHandler.get(), 258 pldmTransport.getEventSource(), 259 hostEID, &instanceIdDb, &reqHandler)); 260 oemBiosHandler = std::make_unique<oem::ibm::bios::Handler>(&dbusHandler); 261 #endif 262 263 auto biosHandler = std::make_unique<bios::Handler>( 264 pldmTransport.getEventSource(), hostEID, &instanceIdDb, &reqHandler, 265 oemBiosHandler.get()); 266 auto fruHandler = std::make_unique<fru::Handler>( 267 FRU_JSONS_DIR, FRU_MASTER_JSON, pdrRepo.get(), entityTree.get(), 268 bmcEntityTree.get()); 269 // FRU table is built lazily when a FRU command or Get PDR command is 270 // handled. To enable building FRU table, the FRU handler is passed to the 271 // Platform handler. 272 auto platformHandler = std::make_unique<platform::Handler>( 273 &dbusHandler, PDR_JSONS_DIR, pdrRepo.get(), hostPDRHandler.get(), 274 dbusToPLDMEventHandler.get(), fruHandler.get(), 275 oemPlatformHandler.get(), event, true); 276 #ifdef OEM_IBM 277 pldm::responder::oem_ibm_platform::Handler* oemIbmPlatformHandler = 278 dynamic_cast<pldm::responder::oem_ibm_platform::Handler*>( 279 oemPlatformHandler.get()); 280 oemIbmPlatformHandler->setPlatformHandler(platformHandler.get()); 281 #endif 282 283 invoker.registerHandler(PLDM_BIOS, std::move(biosHandler)); 284 invoker.registerHandler(PLDM_PLATFORM, std::move(platformHandler)); 285 invoker.registerHandler( 286 PLDM_BASE, 287 std::make_unique<base::Handler>(hostEID, instanceIdDb, event, 288 oemPlatformHandler.get(), &reqHandler)); 289 invoker.registerHandler(PLDM_FRU, std::move(fruHandler)); 290 dbus_api::Pdr dbusImplPdr(bus, "/xyz/openbmc_project/pldm", pdrRepo.get()); 291 sdbusplus::xyz::openbmc_project::PLDM::server::Event dbusImplEvent( 292 bus, "/xyz/openbmc_project/pldm"); 293 294 #endif 295 296 std::unique_ptr<fw_update::Manager> fwManager = 297 std::make_unique<fw_update::Manager>(event, reqHandler, instanceIdDb); 298 std::unique_ptr<MctpDiscovery> mctpDiscoveryHandler = 299 std::make_unique<MctpDiscovery>(bus, fwManager.get()); 300 auto callback = [verbose, &invoker, &reqHandler, &fwManager, &pldmTransport, 301 TID](IO& io, int fd, uint32_t revents) mutable { 302 if (!(revents & EPOLLIN)) 303 { 304 return; 305 } 306 if (fd < 0) 307 { 308 return; 309 } 310 311 int returnCode = 0; 312 void* requestMsg; 313 size_t recvDataLength; 314 returnCode = pldmTransport.recvMsg(TID, requestMsg, recvDataLength); 315 316 if (returnCode == PLDM_REQUESTER_SUCCESS) 317 { 318 std::vector<uint8_t> requestMsgVec( 319 static_cast<uint8_t*>(requestMsg), 320 static_cast<uint8_t*>(requestMsg) + recvDataLength); 321 FlightRecorder::GetInstance().saveRecord(requestMsgVec, false); 322 if (verbose) 323 { 324 printBuffer(Rx, requestMsgVec); 325 } 326 // process message and send response 327 auto response = processRxMsg(requestMsgVec, invoker, reqHandler, 328 fwManager.get(), TID); 329 if (response.has_value()) 330 { 331 FlightRecorder::GetInstance().saveRecord(*response, true); 332 if (verbose) 333 { 334 printBuffer(Tx, *response); 335 } 336 337 returnCode = pldmTransport.sendMsg(TID, (*response).data(), 338 (*response).size()); 339 if (returnCode != PLDM_REQUESTER_SUCCESS) 340 { 341 warning("Failed to send PLDM response: {RETURN_CODE}", 342 "RETURN_CODE", returnCode); 343 } 344 } 345 } 346 // TODO check that we get here if mctp-demux dies? 347 else if (returnCode == PLDM_REQUESTER_RECV_FAIL) 348 { 349 // MCTP daemon has closed the socket this daemon is connected to. 350 // This may or may not be an error scenario, in either case the 351 // recovery mechanism for this daemon is to restart, and hence exit 352 // the event loop, that will cause this daemon to exit with a 353 // failure code. 354 error("io exiting"); 355 io.get_event().exit(0); 356 } 357 else 358 { 359 warning("Failed to receive PLDM request: {RETURN_CODE}", 360 "RETURN_CODE", returnCode); 361 } 362 }; 363 364 bus.attach_event(event.get(), SD_EVENT_PRIORITY_NORMAL); 365 bus.request_name("xyz.openbmc_project.PLDM"); 366 IO io(event, pldmTransport.getEventSource(), EPOLLIN, std::move(callback)); 367 #ifdef LIBPLDMRESPONDER 368 if (hostPDRHandler) 369 { 370 hostPDRHandler->setHostFirmwareCondition(); 371 } 372 #endif 373 stdplus::signal::block(SIGUSR1); 374 sdeventplus::source::Signal sigUsr1( 375 event, SIGUSR1, std::bind_front(&interruptFlightRecorderCallBack)); 376 int returnCode = event.loop(); 377 if (returnCode) 378 { 379 exit(EXIT_FAILURE); 380 } 381 382 exit(EXIT_SUCCESS); 383 } 384