xref: /openbmc/pldm/pldmd/pldmd.cpp (revision 339bed32)
1 
2 #include "common/flight_recorder.hpp"
3 #include "common/instance_id.hpp"
4 #include "common/transport.hpp"
5 #include "common/utils.hpp"
6 #include "dbus_impl_requester.hpp"
7 #include "fw-update/manager.hpp"
8 #include "invoker.hpp"
9 #include "platform-mc/manager.hpp"
10 #include "requester/handler.hpp"
11 #include "requester/mctp_endpoint_discovery.hpp"
12 #include "requester/request.hpp"
13 
14 #include <err.h>
15 #include <getopt.h>
16 #include <libpldm/base.h>
17 #include <libpldm/bios.h>
18 #include <libpldm/pdr.h>
19 #include <libpldm/platform.h>
20 #include <libpldm/transport.h>
21 #include <poll.h>
22 #include <stdlib.h>
23 #include <sys/socket.h>
24 #include <sys/types.h>
25 #include <sys/un.h>
26 #include <unistd.h>
27 
28 #include <phosphor-logging/lg2.hpp>
29 #include <sdeventplus/event.hpp>
30 #include <sdeventplus/source/io.hpp>
31 #include <sdeventplus/source/signal.hpp>
32 #include <stdplus/signal.hpp>
33 
34 #include <cstdio>
35 #include <cstring>
36 #include <fstream>
37 #include <iomanip>
38 #include <iterator>
39 #include <memory>
40 #include <ranges>
41 #include <sstream>
42 #include <stdexcept>
43 #include <string>
44 #include <vector>
45 
46 PHOSPHOR_LOG2_USING;
47 
48 #ifdef LIBPLDMRESPONDER
49 #include "dbus_impl_pdr.hpp"
50 #include "host-bmc/dbus_to_event_handler.hpp"
51 #include "host-bmc/dbus_to_host_effecters.hpp"
52 #include "host-bmc/host_condition.hpp"
53 #include "host-bmc/host_pdr_handler.hpp"
54 #include "libpldmresponder/base.hpp"
55 #include "libpldmresponder/bios.hpp"
56 #include "libpldmresponder/fru.hpp"
57 #include "libpldmresponder/oem_handler.hpp"
58 #include "libpldmresponder/platform.hpp"
59 #include "libpldmresponder/platform_config.hpp"
60 #include "xyz/openbmc_project/PLDM/Event/server.hpp"
61 #endif
62 
63 #ifdef OEM_IBM
64 #include "oem_ibm.hpp"
65 #endif
66 
67 constexpr const char* PLDMService = "xyz.openbmc_project.PLDM";
68 
69 using namespace pldm;
70 using namespace sdeventplus;
71 using namespace sdeventplus::source;
72 using namespace pldm::responder;
73 using namespace pldm::utils;
74 using sdeventplus::source::Signal;
75 using namespace pldm::flightrecorder;
76 
77 void interruptFlightRecorderCallBack(Signal& /*signal*/,
78                                      const struct signalfd_siginfo*)
79 {
80     error("Received SIGUR1(10) Signal interrupt");
81     // obtain the flight recorder instance and dump the recorder
82     FlightRecorder::GetInstance().playRecorder();
83 }
84 
85 void requestPLDMServiceName()
86 {
87     try
88     {
89         auto& bus = pldm::utils::DBusHandler::getBus();
90         bus.request_name(PLDMService);
91     }
92     catch (const sdbusplus::exception_t& e)
93     {
94         error("Failed to request D-Bus name {NAME} with error {ERROR}.", "NAME",
95               PLDMService, "ERROR", e);
96     }
97 }
98 
99 static std::optional<Response>
100     processRxMsg(const std::vector<uint8_t>& requestMsg, Invoker& invoker,
101                  requester::Handler<requester::Request>& handler,
102                  fw_update::Manager* fwManager, pldm_tid_t tid)
103 {
104     uint8_t eid = tid;
105 
106     pldm_header_info hdrFields{};
107     auto hdr = reinterpret_cast<const pldm_msg_hdr*>(requestMsg.data());
108     if (PLDM_SUCCESS != unpack_pldm_header(hdr, &hdrFields))
109     {
110         error("Empty PLDM request header");
111         return std::nullopt;
112     }
113 
114     if (PLDM_RESPONSE != hdrFields.msg_type)
115     {
116         Response response;
117         auto request = reinterpret_cast<const pldm_msg*>(hdr);
118         size_t requestLen = requestMsg.size() - sizeof(struct pldm_msg_hdr);
119         try
120         {
121             if (hdrFields.pldm_type != PLDM_FWUP)
122             {
123                 response = invoker.handle(tid, hdrFields.pldm_type,
124                                           hdrFields.command, request,
125                                           requestLen);
126             }
127             else
128             {
129                 response = fwManager->handleRequest(eid, hdrFields.command,
130                                                     request, requestLen);
131             }
132         }
133         catch (const std::out_of_range& e)
134         {
135             uint8_t completion_code = PLDM_ERROR_UNSUPPORTED_PLDM_CMD;
136             response.resize(sizeof(pldm_msg_hdr));
137             auto responseHdr = reinterpret_cast<pldm_msg_hdr*>(response.data());
138             pldm_header_info header{};
139             header.msg_type = PLDM_RESPONSE;
140             header.instance = hdrFields.instance;
141             header.pldm_type = hdrFields.pldm_type;
142             header.command = hdrFields.command;
143             if (PLDM_SUCCESS != pack_pldm_header(&header, responseHdr))
144             {
145                 error(
146                     "Failed to add response header for processing Rx, error - {ERROR}",
147                     "ERROR", e);
148                 return std::nullopt;
149             }
150             response.insert(response.end(), completion_code);
151         }
152         return response;
153     }
154     else if (PLDM_RESPONSE == hdrFields.msg_type)
155     {
156         auto response = reinterpret_cast<const pldm_msg*>(hdr);
157         size_t responseLen = requestMsg.size() - sizeof(struct pldm_msg_hdr);
158         handler.handleResponse(eid, hdrFields.instance, hdrFields.pldm_type,
159                                hdrFields.command, response, responseLen);
160     }
161     return std::nullopt;
162 }
163 
164 void optionUsage(void)
165 {
166     info("Usage: pldmd [options]");
167     info("Options:");
168     info(" [--verbose] - would enable verbosity");
169 }
170 
171 int main(int argc, char** argv)
172 {
173     bool verbose = false;
174     static struct option long_options[] = {{"verbose", no_argument, 0, 'v'},
175                                            {0, 0, 0, 0}};
176 
177     auto argflag = getopt_long(argc, argv, "v", long_options, nullptr);
178     switch (argflag)
179     {
180         case 'v':
181             verbose = true;
182             break;
183         case -1:
184             break;
185         default:
186             optionUsage();
187             exit(EXIT_FAILURE);
188     }
189     // Setup PLDM requester transport
190     auto hostEID = pldm::utils::readHostEID();
191     /* To maintain current behaviour until we have the infrastructure to find
192      * and use the correct TIDs */
193     pldm_tid_t TID = hostEID;
194     PldmTransport pldmTransport{};
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 
200     InstanceIdDb instanceIdDb;
201     dbus_api::Requester dbusImplReq(bus, "/xyz/openbmc_project/pldm",
202                                     instanceIdDb);
203     sdbusplus::server::manager_t inventoryManager(
204         bus, "/xyz/openbmc_project/inventory");
205 
206     Invoker invoker{};
207     requester::Handler<requester::Request> reqHandler(&pldmTransport, event,
208                                                       instanceIdDb, verbose);
209 
210 #ifdef LIBPLDMRESPONDER
211     using namespace pldm::state_sensor;
212     dbus_api::Host dbusImplHost(bus, "/xyz/openbmc_project/pldm");
213     std::unique_ptr<pldm_pdr, decltype(&pldm_pdr_destroy)> pdrRepo(
214         pldm_pdr_init(), pldm_pdr_destroy);
215     if (!pdrRepo)
216     {
217         throw std::runtime_error("Failed to instantiate PDR repository");
218     }
219     std::unique_ptr<pldm_entity_association_tree,
220                     decltype(&pldm_entity_association_tree_destroy)>
221         entityTree(pldm_entity_association_tree_init(),
222                    pldm_entity_association_tree_destroy);
223     if (!entityTree)
224     {
225         throw std::runtime_error(
226             "Failed to instantiate general PDR entity association tree");
227     }
228     std::unique_ptr<pldm_entity_association_tree,
229                     decltype(&pldm_entity_association_tree_destroy)>
230         bmcEntityTree(pldm_entity_association_tree_init(),
231                       pldm_entity_association_tree_destroy);
232     if (!bmcEntityTree)
233     {
234         throw std::runtime_error(
235             "Failed to instantiate BMC PDR entity association tree");
236     }
237     std::shared_ptr<HostPDRHandler> hostPDRHandler;
238     std::unique_ptr<pldm::host_effecters::HostEffecterParser>
239         hostEffecterParser;
240     std::unique_ptr<DbusToPLDMEvent> dbusToPLDMEventHandler;
241     DBusHandler dbusHandler;
242     std::unique_ptr<platform_config::Handler> platformConfigHandler{};
243     platformConfigHandler =
244         std::make_unique<platform_config::Handler>(PDR_JSONS_DIR);
245 
246     if (hostEID)
247     {
248         hostPDRHandler = std::make_shared<HostPDRHandler>(
249             pldmTransport.getEventSource(), hostEID, event, pdrRepo.get(),
250             EVENTS_JSONS_DIR, entityTree.get(), bmcEntityTree.get(),
251             instanceIdDb, &reqHandler);
252 
253         // HostFirmware interface needs access to hostPDR to know if host
254         // is running
255         dbusImplHost.setHostPdrObj(hostPDRHandler);
256 
257         hostEffecterParser =
258             std::make_unique<pldm::host_effecters::HostEffecterParser>(
259                 &instanceIdDb, pldmTransport.getEventSource(), pdrRepo.get(),
260                 &dbusHandler, HOST_JSONS_DIR, &reqHandler);
261         dbusToPLDMEventHandler = std::make_unique<DbusToPLDMEvent>(
262             pldmTransport.getEventSource(), hostEID, instanceIdDb, &reqHandler);
263     }
264 
265     auto fruHandler = std::make_unique<fru::Handler>(
266         FRU_JSONS_DIR, FRU_MASTER_JSON, pdrRepo.get(), entityTree.get(),
267         bmcEntityTree.get());
268 
269     // FRU table is built lazily when a FRU command or Get PDR command is
270     // handled. To enable building FRU table, the FRU handler is passed to the
271     // Platform handler.
272     auto platformHandler = std::make_unique<platform::Handler>(
273         &dbusHandler, hostEID, &instanceIdDb, PDR_JSONS_DIR, pdrRepo.get(),
274         hostPDRHandler.get(), dbusToPLDMEventHandler.get(), fruHandler.get(),
275         platformConfigHandler.get(), &reqHandler, event, true);
276 
277     auto biosHandler = std::make_unique<bios::Handler>(
278         pldmTransport.getEventSource(), hostEID, &instanceIdDb, &reqHandler,
279         platformConfigHandler.get(), requestPLDMServiceName);
280 
281     auto baseHandler = std::make_unique<base::Handler>(event);
282 
283 #ifdef OEM_IBM
284     pldm::oem_ibm::OemIBM oemIBM(&dbusHandler, pldmTransport.getEventSource(),
285                                  hostEID, pdrRepo.get(), instanceIdDb, event,
286                                  invoker, hostPDRHandler.get(),
287                                  platformHandler.get(), fruHandler.get(),
288                                  baseHandler.get(), &reqHandler);
289 #endif
290 
291     invoker.registerHandler(PLDM_BIOS, std::move(biosHandler));
292     invoker.registerHandler(PLDM_PLATFORM, std::move(platformHandler));
293     invoker.registerHandler(PLDM_FRU, std::move(fruHandler));
294     invoker.registerHandler(PLDM_BASE, std::move(baseHandler));
295 
296     dbus_api::Pdr dbusImplPdr(bus, "/xyz/openbmc_project/pldm", pdrRepo.get());
297     sdbusplus::xyz::openbmc_project::PLDM::server::Event dbusImplEvent(
298         bus, "/xyz/openbmc_project/pldm");
299 
300 #endif
301 
302     std::unique_ptr<fw_update::Manager> fwManager =
303         std::make_unique<fw_update::Manager>(event, reqHandler, instanceIdDb);
304     std::unique_ptr<platform_mc::Manager> platformManager =
305         std::make_unique<platform_mc::Manager>(event, reqHandler, instanceIdDb);
306     std::unique_ptr<MctpDiscovery> mctpDiscoveryHandler =
307         std::make_unique<MctpDiscovery>(
308             bus, std::initializer_list<MctpDiscoveryHandlerIntf*>{
309                      fwManager.get(), platformManager.get()});
310     auto callback = [verbose, &invoker, &reqHandler, &fwManager, &pldmTransport,
311                      TID](IO& io, int fd, uint32_t revents) mutable {
312         if (!(revents & EPOLLIN))
313         {
314             return;
315         }
316         if (fd < 0)
317         {
318             return;
319         }
320 
321         int returnCode = 0;
322         void* requestMsg;
323         size_t recvDataLength;
324         returnCode = pldmTransport.recvMsg(TID, requestMsg, recvDataLength);
325 
326         if (returnCode == PLDM_REQUESTER_SUCCESS)
327         {
328             std::vector<uint8_t> requestMsgVec(
329                 static_cast<uint8_t*>(requestMsg),
330                 static_cast<uint8_t*>(requestMsg) + recvDataLength);
331             FlightRecorder::GetInstance().saveRecord(requestMsgVec, false);
332             if (verbose)
333             {
334                 printBuffer(Rx, requestMsgVec);
335             }
336             // process message and send response
337             auto response = processRxMsg(requestMsgVec, invoker, reqHandler,
338                                          fwManager.get(), TID);
339             if (response.has_value())
340             {
341                 FlightRecorder::GetInstance().saveRecord(*response, true);
342                 if (verbose)
343                 {
344                     printBuffer(Tx, *response);
345                 }
346 
347                 returnCode = pldmTransport.sendMsg(TID, (*response).data(),
348                                                    (*response).size());
349                 if (returnCode != PLDM_REQUESTER_SUCCESS)
350                 {
351                     warning(
352                         "Failed to send pldmTransport message for TID '{TID}', response code '{RETURN_CODE}'",
353                         "TID", TID, "RETURN_CODE", returnCode);
354                 }
355             }
356         }
357         // TODO check that we get here if mctp-demux dies?
358         else if (returnCode == PLDM_REQUESTER_RECV_FAIL)
359         {
360             // MCTP daemon has closed the socket this daemon is connected to.
361             // This may or may not be an error scenario, in either case the
362             // recovery mechanism for this daemon is to restart, and hence exit
363             // the event loop, that will cause this daemon to exit with a
364             // failure code.
365             error(
366                 "MCTP daemon closed the socket, IO exiting with response code '{RC}'",
367                 "RC", returnCode);
368             io.get_event().exit(0);
369         }
370         else
371         {
372             warning(
373                 "Failed to receive PLDM request for pldmTransport, response code '{RETURN_CODE}'",
374                 "RETURN_CODE", returnCode);
375         }
376         /* Free requestMsg after using */
377         free(requestMsg);
378     };
379 
380     bus.attach_event(event.get(), SD_EVENT_PRIORITY_NORMAL);
381 #ifndef SYSTEM_SPECIFIC_BIOS_JSON
382     try
383     {
384         bus.request_name(PLDMService);
385     }
386     catch (const sdbusplus::exception_t& e)
387     {
388         error("Failed to request D-Bus name {NAME} with error {ERROR}.", "NAME",
389               PLDMService, "ERROR", e);
390     }
391 #endif
392     IO io(event, pldmTransport.getEventSource(), EPOLLIN, std::move(callback));
393 #ifdef LIBPLDMRESPONDER
394     if (hostPDRHandler)
395     {
396         hostPDRHandler->setHostFirmwareCondition();
397     }
398 #endif
399     stdplus::signal::block(SIGUSR1);
400     sdeventplus::source::Signal sigUsr1(
401         event, SIGUSR1, std::bind_front(&interruptFlightRecorderCallBack));
402     int returnCode = event.loop();
403     if (returnCode)
404     {
405         exit(EXIT_FAILURE);
406     }
407 
408     exit(EXIT_SUCCESS);
409 }
410