xref: /openbmc/pldm/pldmd/pldmd.cpp (revision f47694ff)
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 
158     bool verbose = false;
159     static struct option long_options[] = {
160         {"verbose", required_argument, 0, 'v'}, {0, 0, 0, 0}};
161 
162     auto argflag = getopt_long(argc, argv, "v:", long_options, nullptr);
163     switch (argflag)
164     {
165         case 'v':
166             switch (std::stoi(optarg))
167             {
168                 case 0:
169                     verbose = false;
170                     break;
171                 case 1:
172                     verbose = true;
173                     break;
174                 default:
175                     optionUsage();
176                     exit(EXIT_FAILURE);
177             }
178             break;
179         case -1:
180             break;
181         default:
182             exit(EXIT_FAILURE);
183     }
184 
185     /* Create local socket. */
186     int returnCode = 0;
187     int sockfd = socket(AF_UNIX, SOCK_SEQPACKET, 0);
188     if (-1 == sockfd)
189     {
190         returnCode = -errno;
191         std::cerr << "Failed to create the socket, RC= " << returnCode << "\n";
192         exit(EXIT_FAILURE);
193     }
194     socklen_t optlen;
195     int currentSendbuffSize;
196 
197     // Get Current send buffer size
198     optlen = sizeof(currentSendbuffSize);
199 
200     int res = getsockopt(sockfd, SOL_SOCKET, SO_SNDBUF, &currentSendbuffSize,
201                          &optlen);
202     if (res == -1)
203     {
204         std::cerr << "Error in obtaining the default send buffer size, Error : "
205                   << strerror(errno) << std::endl;
206     }
207     auto event = Event::get_default();
208     auto& bus = pldm::utils::DBusHandler::getBus();
209     sdbusplus::server::manager::manager objManager(
210         bus, "/xyz/openbmc_project/software");
211     dbus_api::Requester dbusImplReq(bus, "/xyz/openbmc_project/pldm");
212 
213     Invoker invoker{};
214     requester::Handler<requester::Request> reqHandler(
215         sockfd, event, dbusImplReq, currentSendbuffSize, verbose);
216 
217 #ifdef LIBPLDMRESPONDER
218     using namespace pldm::state_sensor;
219     dbus_api::Host dbusImplHost(bus, "/xyz/openbmc_project/pldm");
220     std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> pdrRepo(
221         pldm_pdr_init(), pldm_pdr_destroy);
222     std::unique_ptr<pldm_entity_association_tree,
223                     decltype(&pldm_entity_association_tree_destroy)>
224         entityTree(pldm_entity_association_tree_init(),
225                    pldm_entity_association_tree_destroy);
226     std::unique_ptr<pldm_entity_association_tree,
227                     decltype(&pldm_entity_association_tree_destroy)>
228         bmcEntityTree(pldm_entity_association_tree_init(),
229                       pldm_entity_association_tree_destroy);
230     std::shared_ptr<HostPDRHandler> hostPDRHandler;
231     std::unique_ptr<pldm::host_effecters::HostEffecterParser>
232         hostEffecterParser;
233     std::unique_ptr<DbusToPLDMEvent> dbusToPLDMEventHandler;
234     DBusHandler dbusHandler;
235     auto hostEID = pldm::utils::readHostEID();
236     if (hostEID)
237     {
238         hostPDRHandler = std::make_shared<HostPDRHandler>(
239             sockfd, hostEID, event, pdrRepo.get(), EVENTS_JSONS_DIR,
240             entityTree.get(), bmcEntityTree.get(), dbusImplReq, &reqHandler);
241         // HostFirmware interface needs access to hostPDR to know if host
242         // is running
243         dbusImplHost.setHostPdrObj(hostPDRHandler);
244 
245         hostEffecterParser =
246             std::make_unique<pldm::host_effecters::HostEffecterParser>(
247                 &dbusImplReq, sockfd, pdrRepo.get(), &dbusHandler,
248                 HOST_JSONS_DIR, &reqHandler);
249         dbusToPLDMEventHandler = std::make_unique<DbusToPLDMEvent>(
250             sockfd, hostEID, dbusImplReq, &reqHandler);
251     }
252     std::unique_ptr<oem_platform::Handler> oemPlatformHandler{};
253 
254 #ifdef OEM_IBM
255     std::unique_ptr<pldm::responder::CodeUpdate> codeUpdate =
256         std::make_unique<pldm::responder::CodeUpdate>(&dbusHandler);
257     codeUpdate->clearDirPath(LID_STAGING_DIR);
258     oemPlatformHandler = std::make_unique<oem_ibm_platform::Handler>(
259         &dbusHandler, codeUpdate.get(), sockfd, hostEID, dbusImplReq, event,
260         &reqHandler);
261     codeUpdate->setOemPlatformHandler(oemPlatformHandler.get());
262     invoker.registerHandler(PLDM_OEM, std::make_unique<oem_ibm::Handler>(
263                                           oemPlatformHandler.get(), sockfd,
264                                           hostEID, &dbusImplReq, &reqHandler));
265 #endif
266     invoker.registerHandler(
267         PLDM_BIOS, std::make_unique<bios::Handler>(sockfd, hostEID,
268                                                    &dbusImplReq, &reqHandler));
269     auto fruHandler = std::make_unique<fru::Handler>(
270         FRU_JSONS_DIR, FRU_MASTER_JSON, pdrRepo.get(), entityTree.get(),
271         bmcEntityTree.get());
272     // FRU table is built lazily when a FRU command or Get PDR command is
273     // handled. To enable building FRU table, the FRU handler is passed to the
274     // Platform handler.
275     auto platformHandler = std::make_unique<platform::Handler>(
276         &dbusHandler, PDR_JSONS_DIR, pdrRepo.get(), hostPDRHandler.get(),
277         dbusToPLDMEventHandler.get(), fruHandler.get(),
278         oemPlatformHandler.get(), event, true);
279 #ifdef OEM_IBM
280     pldm::responder::oem_ibm_platform::Handler* oemIbmPlatformHandler =
281         dynamic_cast<pldm::responder::oem_ibm_platform::Handler*>(
282             oemPlatformHandler.get());
283     oemIbmPlatformHandler->setPlatformHandler(platformHandler.get());
284 #endif
285 
286     invoker.registerHandler(PLDM_PLATFORM, std::move(platformHandler));
287     invoker.registerHandler(
288         PLDM_BASE,
289         std::make_unique<base::Handler>(hostEID, dbusImplReq, event,
290                                         oemPlatformHandler.get(), &reqHandler));
291     invoker.registerHandler(PLDM_FRU, std::move(fruHandler));
292     dbus_api::Pdr dbusImplPdr(bus, "/xyz/openbmc_project/pldm", pdrRepo.get());
293     sdbusplus::xyz::openbmc_project::PLDM::server::Event dbusImplEvent(
294         bus, "/xyz/openbmc_project/pldm");
295 
296 #endif
297 
298     pldm::utils::CustomFD socketFd(sockfd);
299 
300     struct sockaddr_un addr
301     {};
302     addr.sun_family = AF_UNIX;
303     const char path[] = "\0mctp-mux";
304     memcpy(addr.sun_path, path, sizeof(path) - 1);
305     int result = connect(socketFd(), reinterpret_cast<struct sockaddr*>(&addr),
306                          sizeof(path) + sizeof(addr.sun_family) - 1);
307     if (-1 == result)
308     {
309         returnCode = -errno;
310         std::cerr << "Failed to connect to the socket, RC= " << returnCode
311                   << "\n";
312         exit(EXIT_FAILURE);
313     }
314 
315     result = write(socketFd(), &MCTP_MSG_TYPE_PLDM, sizeof(MCTP_MSG_TYPE_PLDM));
316     if (-1 == result)
317     {
318         returnCode = -errno;
319         std::cerr << "Failed to send message type as pldm to mctp, RC= "
320                   << returnCode << "\n";
321         exit(EXIT_FAILURE);
322     }
323 
324     std::unique_ptr<fw_update::Manager> fwManager =
325         std::make_unique<fw_update::Manager>(event, reqHandler, dbusImplReq);
326     std::unique_ptr<MctpDiscovery> mctpDiscoveryHandler =
327         std::make_unique<MctpDiscovery>(bus, fwManager.get());
328 
329     auto callback = [verbose, &invoker, &reqHandler, currentSendbuffSize,
330                      &fwManager](IO& io, int fd, uint32_t revents) mutable {
331         if (!(revents & EPOLLIN))
332         {
333             return;
334         }
335 
336         // Outgoing message.
337         struct iovec iov[2]{};
338 
339         // This structure contains the parameter information for the response
340         // message.
341         struct msghdr msg
342         {};
343 
344         int returnCode = 0;
345         ssize_t peekedLength = recv(fd, nullptr, 0, MSG_PEEK | MSG_TRUNC);
346         if (0 == peekedLength)
347         {
348             // MCTP daemon has closed the socket this daemon is connected to.
349             // This may or may not be an error scenario, in either case the
350             // recovery mechanism for this daemon is to restart, and hence exit
351             // the event loop, that will cause this daemon to exit with a
352             // failure code.
353             io.get_event().exit(0);
354         }
355         else if (peekedLength <= -1)
356         {
357             returnCode = -errno;
358             std::cerr << "recv system call failed, RC= " << returnCode << "\n";
359         }
360         else
361         {
362             std::vector<uint8_t> requestMsg(peekedLength);
363             auto recvDataLength = recv(
364                 fd, static_cast<void*>(requestMsg.data()), peekedLength, 0);
365             if (recvDataLength == peekedLength)
366             {
367                 FlightRecorder::GetInstance().saveRecord(requestMsg, false);
368                 if (verbose)
369                 {
370                     printBuffer(Rx, requestMsg);
371                 }
372 
373                 if (MCTP_MSG_TYPE_PLDM != requestMsg[1])
374                 {
375                     // Skip this message and continue.
376                 }
377                 else
378                 {
379                     // process message and send response
380                     auto response = processRxMsg(requestMsg, invoker,
381                                                  reqHandler, fwManager.get());
382                     if (response.has_value())
383                     {
384                         FlightRecorder::GetInstance().saveRecord(*response,
385                                                                  true);
386                         if (verbose)
387                         {
388                             printBuffer(Tx, *response);
389                         }
390 
391                         iov[0].iov_base = &requestMsg[0];
392                         iov[0].iov_len =
393                             sizeof(requestMsg[0]) + sizeof(requestMsg[1]);
394                         iov[1].iov_base = (*response).data();
395                         iov[1].iov_len = (*response).size();
396 
397                         msg.msg_iov = iov;
398                         msg.msg_iovlen = sizeof(iov) / sizeof(iov[0]);
399                         if (currentSendbuffSize >= 0 &&
400                             (size_t)currentSendbuffSize < (*response).size())
401                         {
402                             int oldBuffSize = currentSendbuffSize;
403                             currentSendbuffSize = (*response).size();
404                             int res = setsockopt(fd, SOL_SOCKET, SO_SNDBUF,
405                                                  &currentSendbuffSize,
406                                                  sizeof(currentSendbuffSize));
407                             if (res == -1)
408                             {
409                                 std::cerr
410                                     << "Responder : Failed to set the new send buffer size [bytes] : "
411                                     << currentSendbuffSize
412                                     << " from current size [bytes] : "
413                                     << oldBuffSize
414                                     << ", Error : " << strerror(errno)
415                                     << std::endl;
416                                 return;
417                             }
418                         }
419 
420                         int result = sendmsg(fd, &msg, 0);
421                         if (-1 == result)
422                         {
423                             returnCode = -errno;
424                             std::cerr << "sendto system call failed, RC= "
425                                       << returnCode << "\n";
426                         }
427                     }
428                 }
429             }
430             else
431             {
432                 std::cerr
433                     << "Failure to read peeked length packet. peekedLength= "
434                     << peekedLength << " recvDataLength=" << recvDataLength
435                     << "\n";
436             }
437         }
438     };
439 
440     bus.attach_event(event.get(), SD_EVENT_PRIORITY_NORMAL);
441     bus.request_name("xyz.openbmc_project.PLDM");
442     IO io(event, socketFd(), EPOLLIN, std::move(callback));
443 #ifdef LIBPLDMRESPONDER
444     if (hostPDRHandler)
445     {
446         hostPDRHandler->setHostFirmwareCondition();
447     }
448 #endif
449     stdplus::signal::block(SIGUSR1);
450     sdeventplus::source::Signal sigUsr1(
451         event, SIGUSR1, std::bind_front(&interruptFlightRecorderCallBack));
452     returnCode = event.loop();
453 
454     if (shutdown(sockfd, SHUT_RDWR))
455     {
456         std::perror("Failed to shutdown the socket");
457     }
458     if (returnCode)
459     {
460         exit(EXIT_FAILURE);
461     }
462 
463     exit(EXIT_SUCCESS);
464 }
465