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