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