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