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