1 #include "common/flight_recorder.hpp" 2 #include "common/utils.hpp" 3 #include "dbus_impl_requester.hpp" 4 #include "fw-update/manager.hpp" 5 #include "instance_id.hpp" 6 #include "invoker.hpp" 7 #include "requester/handler.hpp" 8 #include "requester/mctp_endpoint_discovery.hpp" 9 #include "requester/request.hpp" 10 11 #include <err.h> 12 #include <getopt.h> 13 #include <libpldm/base.h> 14 #include <libpldm/bios.h> 15 #include <libpldm/pdr.h> 16 #include <libpldm/platform.h> 17 #include <poll.h> 18 #include <stdlib.h> 19 #include <sys/socket.h> 20 #include <sys/types.h> 21 #include <sys/un.h> 22 #include <unistd.h> 23 24 #include <phosphor-logging/lg2.hpp> 25 #include <sdeventplus/event.hpp> 26 #include <sdeventplus/source/io.hpp> 27 #include <sdeventplus/source/signal.hpp> 28 #include <stdplus/signal.hpp> 29 30 #include <cstdio> 31 #include <cstring> 32 #include <fstream> 33 #include <iomanip> 34 #include <iostream> 35 #include <iterator> 36 #include <memory> 37 #include <optional> 38 #include <sstream> 39 #include <stdexcept> 40 #include <string> 41 #include <vector> 42 43 PHOSPHOR_LOG2_USING; 44 45 #ifdef LIBPLDMRESPONDER 46 #include "dbus_impl_pdr.hpp" 47 #include "host-bmc/dbus_to_event_handler.hpp" 48 #include "host-bmc/dbus_to_host_effecters.hpp" 49 #include "host-bmc/host_condition.hpp" 50 #include "host-bmc/host_pdr_handler.hpp" 51 #include "libpldmresponder/base.hpp" 52 #include "libpldmresponder/bios.hpp" 53 #include "libpldmresponder/fru.hpp" 54 #include "libpldmresponder/oem_handler.hpp" 55 #include "libpldmresponder/platform.hpp" 56 #include "xyz/openbmc_project/PLDM/Event/server.hpp" 57 #endif 58 59 #ifdef OEM_IBM 60 #include "libpldmresponder/file_io.hpp" 61 #include "libpldmresponder/oem_ibm_handler.hpp" 62 #endif 63 64 constexpr uint8_t MCTP_MSG_TYPE_PLDM = 1; 65 66 using namespace pldm; 67 using namespace sdeventplus; 68 using namespace sdeventplus::source; 69 using namespace pldm::responder; 70 using namespace pldm::utils; 71 using sdeventplus::source::Signal; 72 using namespace pldm::flightrecorder; 73 74 void interruptFlightRecorderCallBack(Signal& /*signal*/, 75 const struct signalfd_siginfo*) 76 { 77 error("Received SIGUR1(10) Signal interrupt"); 78 // obtain the flight recorder instance and dump the recorder 79 FlightRecorder::GetInstance().playRecorder(); 80 } 81 82 static std::optional<Response> 83 processRxMsg(const std::vector<uint8_t>& requestMsg, Invoker& invoker, 84 requester::Handler<requester::Request>& handler, 85 fw_update::Manager* fwManager) 86 { 87 using type = uint8_t; 88 uint8_t eid = requestMsg[0]; 89 pldm_header_info hdrFields{}; 90 auto hdr = reinterpret_cast<const pldm_msg_hdr*>( 91 requestMsg.data() + sizeof(eid) + sizeof(type)); 92 if (PLDM_SUCCESS != unpack_pldm_header(hdr, &hdrFields)) 93 { 94 error("Empty PLDM request header"); 95 return std::nullopt; 96 } 97 98 if (PLDM_RESPONSE != hdrFields.msg_type) 99 { 100 Response response; 101 auto request = reinterpret_cast<const pldm_msg*>(hdr); 102 size_t requestLen = requestMsg.size() - sizeof(struct pldm_msg_hdr) - 103 sizeof(eid) - sizeof(type); 104 try 105 { 106 if (hdrFields.pldm_type != PLDM_FWUP) 107 { 108 response = invoker.handle(hdrFields.pldm_type, 109 hdrFields.command, request, 110 requestLen); 111 } 112 else 113 { 114 response = fwManager->handleRequest(eid, hdrFields.command, 115 request, requestLen); 116 } 117 } 118 catch (const std::out_of_range& e) 119 { 120 uint8_t completion_code = PLDM_ERROR_UNSUPPORTED_PLDM_CMD; 121 response.resize(sizeof(pldm_msg_hdr)); 122 auto responseHdr = reinterpret_cast<pldm_msg_hdr*>(response.data()); 123 pldm_header_info header{}; 124 header.msg_type = PLDM_RESPONSE; 125 header.instance = hdrFields.instance; 126 header.pldm_type = hdrFields.pldm_type; 127 header.command = hdrFields.command; 128 if (PLDM_SUCCESS != pack_pldm_header(&header, responseHdr)) 129 { 130 error("Failed adding response header"); 131 return std::nullopt; 132 } 133 response.insert(response.end(), completion_code); 134 } 135 return response; 136 } 137 else if (PLDM_RESPONSE == hdrFields.msg_type) 138 { 139 auto response = reinterpret_cast<const pldm_msg*>(hdr); 140 size_t responseLen = requestMsg.size() - sizeof(struct pldm_msg_hdr) - 141 sizeof(eid) - sizeof(type); 142 handler.handleResponse(eid, hdrFields.instance, hdrFields.pldm_type, 143 hdrFields.command, response, responseLen); 144 } 145 return std::nullopt; 146 } 147 148 void optionUsage(void) 149 { 150 error("Usage: pldmd [options]"); 151 error("Options:"); 152 error(" [--verbose] - would enable verbosity"); 153 } 154 155 int main(int argc, char** argv) 156 { 157 bool verbose = false; 158 static struct option long_options[] = {{"verbose", no_argument, 0, 'v'}, 159 {0, 0, 0, 0}}; 160 161 auto argflag = getopt_long(argc, argv, "v", long_options, nullptr); 162 switch (argflag) 163 { 164 case 'v': 165 verbose = true; 166 break; 167 case -1: 168 break; 169 default: 170 optionUsage(); 171 exit(EXIT_FAILURE); 172 } 173 174 /* Create local socket. */ 175 int returnCode = 0; 176 int sockfd = socket(AF_UNIX, SOCK_SEQPACKET, 0); 177 if (-1 == sockfd) 178 { 179 returnCode = -errno; 180 error("Failed to create the socket, RC= {RC}", "RC", returnCode); 181 exit(EXIT_FAILURE); 182 } 183 socklen_t optlen; 184 int currentSendbuffSize; 185 186 // Get Current send buffer size 187 optlen = sizeof(currentSendbuffSize); 188 189 int res = getsockopt(sockfd, SOL_SOCKET, SO_SNDBUF, ¤tSendbuffSize, 190 &optlen); 191 if (res == -1) 192 { 193 error("Error in obtaining the default send buffer size, Error : {ERR}", 194 "ERR", strerror(errno)); 195 } 196 auto event = Event::get_default(); 197 auto& bus = pldm::utils::DBusHandler::getBus(); 198 sdbusplus::server::manager_t objManager(bus, 199 "/xyz/openbmc_project/software"); 200 201 InstanceIdDb instanceIdDb; 202 dbus_api::Requester dbusImplReq(bus, "/xyz/openbmc_project/pldm", 203 instanceIdDb); 204 205 Invoker invoker{}; 206 requester::Handler<requester::Request> reqHandler( 207 sockfd, event, instanceIdDb, currentSendbuffSize, verbose); 208 209 #ifdef LIBPLDMRESPONDER 210 using namespace pldm::state_sensor; 211 dbus_api::Host dbusImplHost(bus, "/xyz/openbmc_project/pldm"); 212 std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> pdrRepo( 213 pldm_pdr_init(), pldm_pdr_destroy); 214 if (!pdrRepo) 215 { 216 throw std::runtime_error("Failed to instantiate PDR repository"); 217 } 218 std::unique_ptr<pldm_entity_association_tree, 219 decltype(&pldm_entity_association_tree_destroy)> 220 entityTree(pldm_entity_association_tree_init(), 221 pldm_entity_association_tree_destroy); 222 if (!entityTree) 223 { 224 throw std::runtime_error( 225 "Failed to instantiate general PDR entity association tree"); 226 } 227 std::unique_ptr<pldm_entity_association_tree, 228 decltype(&pldm_entity_association_tree_destroy)> 229 bmcEntityTree(pldm_entity_association_tree_init(), 230 pldm_entity_association_tree_destroy); 231 if (!bmcEntityTree) 232 { 233 throw std::runtime_error( 234 "Failed to instantiate BMC PDR entity association tree"); 235 } 236 std::shared_ptr<HostPDRHandler> hostPDRHandler; 237 std::unique_ptr<pldm::host_effecters::HostEffecterParser> 238 hostEffecterParser; 239 std::unique_ptr<DbusToPLDMEvent> dbusToPLDMEventHandler; 240 DBusHandler dbusHandler; 241 auto hostEID = pldm::utils::readHostEID(); 242 if (hostEID) 243 { 244 hostPDRHandler = std::make_shared<HostPDRHandler>( 245 sockfd, hostEID, event, pdrRepo.get(), EVENTS_JSONS_DIR, 246 entityTree.get(), bmcEntityTree.get(), instanceIdDb, &reqHandler); 247 // HostFirmware interface needs access to hostPDR to know if host 248 // is running 249 dbusImplHost.setHostPdrObj(hostPDRHandler); 250 251 hostEffecterParser = 252 std::make_unique<pldm::host_effecters::HostEffecterParser>( 253 &instanceIdDb, sockfd, pdrRepo.get(), &dbusHandler, 254 HOST_JSONS_DIR, &reqHandler); 255 dbusToPLDMEventHandler = std::make_unique<DbusToPLDMEvent>( 256 sockfd, hostEID, instanceIdDb, &reqHandler); 257 } 258 std::unique_ptr<oem_platform::Handler> oemPlatformHandler{}; 259 260 #ifdef OEM_IBM 261 std::unique_ptr<pldm::responder::CodeUpdate> codeUpdate = 262 std::make_unique<pldm::responder::CodeUpdate>(&dbusHandler); 263 codeUpdate->clearDirPath(LID_STAGING_DIR); 264 oemPlatformHandler = std::make_unique<oem_ibm_platform::Handler>( 265 &dbusHandler, codeUpdate.get(), sockfd, hostEID, instanceIdDb, event, 266 &reqHandler); 267 codeUpdate->setOemPlatformHandler(oemPlatformHandler.get()); 268 invoker.registerHandler(PLDM_OEM, std::make_unique<oem_ibm::Handler>( 269 oemPlatformHandler.get(), sockfd, 270 hostEID, &instanceIdDb, &reqHandler)); 271 #endif 272 invoker.registerHandler( 273 PLDM_BIOS, std::make_unique<bios::Handler>(sockfd, hostEID, 274 &instanceIdDb, &reqHandler)); 275 auto fruHandler = std::make_unique<fru::Handler>( 276 FRU_JSONS_DIR, FRU_MASTER_JSON, pdrRepo.get(), entityTree.get(), 277 bmcEntityTree.get()); 278 // FRU table is built lazily when a FRU command or Get PDR command is 279 // handled. To enable building FRU table, the FRU handler is passed to the 280 // Platform handler. 281 auto platformHandler = std::make_unique<platform::Handler>( 282 &dbusHandler, PDR_JSONS_DIR, pdrRepo.get(), hostPDRHandler.get(), 283 dbusToPLDMEventHandler.get(), fruHandler.get(), 284 oemPlatformHandler.get(), event, true); 285 #ifdef OEM_IBM 286 pldm::responder::oem_ibm_platform::Handler* oemIbmPlatformHandler = 287 dynamic_cast<pldm::responder::oem_ibm_platform::Handler*>( 288 oemPlatformHandler.get()); 289 oemIbmPlatformHandler->setPlatformHandler(platformHandler.get()); 290 #endif 291 292 invoker.registerHandler(PLDM_PLATFORM, std::move(platformHandler)); 293 invoker.registerHandler( 294 PLDM_BASE, 295 std::make_unique<base::Handler>(hostEID, instanceIdDb, event, 296 oemPlatformHandler.get(), &reqHandler)); 297 invoker.registerHandler(PLDM_FRU, std::move(fruHandler)); 298 dbus_api::Pdr dbusImplPdr(bus, "/xyz/openbmc_project/pldm", pdrRepo.get()); 299 sdbusplus::xyz::openbmc_project::PLDM::server::Event dbusImplEvent( 300 bus, "/xyz/openbmc_project/pldm"); 301 302 #endif 303 304 pldm::utils::CustomFD socketFd(sockfd); 305 306 struct sockaddr_un addr 307 {}; 308 addr.sun_family = AF_UNIX; 309 const char path[] = "\0mctp-mux"; 310 memcpy(addr.sun_path, path, sizeof(path) - 1); 311 int result = connect(socketFd(), reinterpret_cast<struct sockaddr*>(&addr), 312 sizeof(path) + sizeof(addr.sun_family) - 1); 313 if (-1 == result) 314 { 315 returnCode = -errno; 316 error("Failed to connect to the socket, RC= {RC}", "RC", returnCode); 317 exit(EXIT_FAILURE); 318 } 319 320 result = write(socketFd(), &MCTP_MSG_TYPE_PLDM, sizeof(MCTP_MSG_TYPE_PLDM)); 321 if (-1 == result) 322 { 323 returnCode = -errno; 324 error("Failed to send message type as pldm to mctp, RC= {RC}", "RC", 325 returnCode); 326 exit(EXIT_FAILURE); 327 } 328 329 std::unique_ptr<fw_update::Manager> fwManager = 330 std::make_unique<fw_update::Manager>(event, reqHandler, instanceIdDb); 331 std::unique_ptr<MctpDiscovery> mctpDiscoveryHandler = 332 std::make_unique<MctpDiscovery>(bus, fwManager.get()); 333 334 auto callback = [verbose, &invoker, &reqHandler, currentSendbuffSize, 335 &fwManager](IO& io, int fd, uint32_t revents) mutable { 336 if (!(revents & EPOLLIN)) 337 { 338 return; 339 } 340 341 // Outgoing message. 342 struct iovec iov[2]{}; 343 344 // This structure contains the parameter information for the response 345 // message. 346 struct msghdr msg 347 {}; 348 349 int returnCode = 0; 350 ssize_t peekedLength = recv(fd, nullptr, 0, MSG_PEEK | MSG_TRUNC); 351 if (0 == peekedLength) 352 { 353 // MCTP daemon has closed the socket this daemon is connected to. 354 // This may or may not be an error scenario, in either case the 355 // recovery mechanism for this daemon is to restart, and hence exit 356 // the event loop, that will cause this daemon to exit with a 357 // failure code. 358 io.get_event().exit(0); 359 } 360 else if (peekedLength <= -1) 361 { 362 returnCode = -errno; 363 error("recv system call failed, RC= {RC}", "RC", returnCode); 364 } 365 else 366 { 367 std::vector<uint8_t> requestMsg(peekedLength); 368 auto recvDataLength = recv( 369 fd, static_cast<void*>(requestMsg.data()), peekedLength, 0); 370 if (recvDataLength == peekedLength) 371 { 372 FlightRecorder::GetInstance().saveRecord(requestMsg, false); 373 if (verbose) 374 { 375 printBuffer(Rx, requestMsg); 376 } 377 378 if (MCTP_MSG_TYPE_PLDM != requestMsg[1]) 379 { 380 // Skip this message and continue. 381 } 382 else 383 { 384 // process message and send response 385 auto response = processRxMsg(requestMsg, invoker, 386 reqHandler, fwManager.get()); 387 if (response.has_value()) 388 { 389 FlightRecorder::GetInstance().saveRecord(*response, 390 true); 391 if (verbose) 392 { 393 printBuffer(Tx, *response); 394 } 395 396 iov[0].iov_base = &requestMsg[0]; 397 iov[0].iov_len = sizeof(requestMsg[0]) + 398 sizeof(requestMsg[1]); 399 iov[1].iov_base = (*response).data(); 400 iov[1].iov_len = (*response).size(); 401 402 msg.msg_iov = iov; 403 msg.msg_iovlen = sizeof(iov) / sizeof(iov[0]); 404 if (currentSendbuffSize >= 0 && 405 (size_t)currentSendbuffSize < (*response).size()) 406 { 407 int oldBuffSize = currentSendbuffSize; 408 currentSendbuffSize = (*response).size(); 409 int res = setsockopt(fd, SOL_SOCKET, SO_SNDBUF, 410 ¤tSendbuffSize, 411 sizeof(currentSendbuffSize)); 412 if (res == -1) 413 { 414 error( 415 "Responder : Failed to set the new send buffer size [bytes] : {CURR_SND_BUF_SIZE}", 416 "CURR_SND_BUF_SIZE", currentSendbuffSize); 417 error( 418 "from current size [bytes] : {OLD_BUF_SIZE}, Error : {ERR}", 419 "OLD_BUF_SIZE", oldBuffSize, "ERR", 420 strerror(errno)); 421 return; 422 } 423 } 424 425 int result = sendmsg(fd, &msg, 0); 426 if (-1 == result) 427 { 428 returnCode = -errno; 429 error("sendto system call failed, RC= {RC}", "RC", 430 returnCode); 431 } 432 } 433 } 434 } 435 else 436 { 437 error( 438 "Failure to read peeked length packet. peekedLength = {PEEK_LEN}, recvDataLength= {RECV_LEN}", 439 "PEEK_LEN", peekedLength, "RECV_LEN", recvDataLength); 440 } 441 } 442 }; 443 444 bus.attach_event(event.get(), SD_EVENT_PRIORITY_NORMAL); 445 bus.request_name("xyz.openbmc_project.PLDM"); 446 IO io(event, socketFd(), EPOLLIN, std::move(callback)); 447 #ifdef LIBPLDMRESPONDER 448 if (hostPDRHandler) 449 { 450 hostPDRHandler->setHostFirmwareCondition(); 451 } 452 #endif 453 stdplus::signal::block(SIGUSR1); 454 sdeventplus::source::Signal sigUsr1( 455 event, SIGUSR1, std::bind_front(&interruptFlightRecorderCallBack)); 456 returnCode = event.loop(); 457 458 if (shutdown(sockfd, SHUT_RDWR)) 459 { 460 error("Failed to shutdown the socket"); 461 } 462 if (returnCode) 463 { 464 exit(EXIT_FAILURE); 465 } 466 467 exit(EXIT_SUCCESS); 468 } 469