1 #pragma once
2 
3 #include "common/utils.hpp"
4 #include "oem/ibm/requester/dbus_to_file_handler.hpp"
5 #include "oem_ibm_handler.hpp"
6 #include "pldmd/handler.hpp"
7 #include "requester/handler.hpp"
8 
9 #include <fcntl.h>
10 #include <libpldm/base.h>
11 #include <libpldm/oem/ibm/file_io.h>
12 #include <libpldm/oem/ibm/host.h>
13 #include <stdint.h>
14 #include <sys/stat.h>
15 #include <sys/types.h>
16 #include <unistd.h>
17 
18 #include <phosphor-logging/lg2.hpp>
19 
20 #include <filesystem>
21 #include <iostream>
22 #include <vector>
23 
24 PHOSPHOR_LOG2_USING;
25 
26 namespace pldm
27 {
28 namespace responder
29 {
30 namespace dma
31 {
32 // The minimum data size of dma transfer in bytes
33 constexpr uint32_t minSize = 16;
34 
35 constexpr size_t maxSize = DMA_MAXSIZE;
36 
37 namespace fs = std::filesystem;
38 
39 /**
40  * @class DMA
41  *
42  * Expose API to initiate transfer of data by DMA
43  *
44  * This class only exposes the public API transferDataHost to transfer data
45  * between BMC and host using DMA. This allows for mocking the transferDataHost
46  * for unit testing purposes.
47  */
48 class DMA
49 {
50   public:
51     /** @brief API to transfer data between BMC and host using DMA
52      *
53      * @param[in] path     - pathname of the file to transfer data from or to
54      * @param[in] offset   - offset in the file
55      * @param[in] length   - length of the data to transfer
56      * @param[in] address  - DMA address on the host
57      * @param[in] upstream - indicates direction of the transfer; true indicates
58      *                       transfer to the host
59      *
60      * @return returns 0 on success, negative errno on failure
61      */
62     int transferDataHost(int fd, uint32_t offset, uint32_t length,
63                          uint64_t address, bool upstream);
64 
65     /** @brief API to transfer data on to unix socket from host using DMA
66      *
67      * @param[in] path     - pathname of the file to transfer data from or to
68      * @param[in] length   - length of the data to transfer
69      * @param[in] address  - DMA address on the host
70      *
71      * @return returns 0 on success, negative errno on failure
72      */
73     int transferHostDataToSocket(int fd, uint32_t length, uint64_t address);
74 };
75 
76 /** @brief Transfer the data between BMC and host using DMA.
77  *
78  *  There is a max size for each DMA operation, transferAll API abstracts this
79  *  and the requested length is broken down into multiple DMA operations if the
80  *  length exceed max size.
81  *
82  * @tparam[in] T - DMA interface type
83  * @param[in] intf - interface passed to invoke DMA transfer
84  * @param[in] command  - PLDM command
85  * @param[in] path     - pathname of the file to transfer data from or to
86  * @param[in] offset   - offset in the file
87  * @param[in] length   - length of the data to transfer
88  * @param[in] address  - DMA address on the host
89  * @param[in] upstream - indicates direction of the transfer; true indicates
90  *                       transfer to the host
91  * @param[in] instanceId - Message's instance id
92  * @return PLDM response message
93  */
94 
95 template <class DMAInterface>
96 Response transferAll(DMAInterface* intf, uint8_t command, fs::path& path,
97                      uint32_t offset, uint32_t length, uint64_t address,
98                      bool upstream, uint8_t instanceId)
99 {
100     uint32_t origLength = length;
101     Response response(sizeof(pldm_msg_hdr) + PLDM_RW_FILE_MEM_RESP_BYTES, 0);
102     auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
103 
104     int flags{};
105     if (upstream)
106     {
107         flags = O_RDONLY;
108     }
109     else if (fs::exists(path))
110     {
111         flags = O_RDWR;
112     }
113     else
114     {
115         flags = O_WRONLY;
116     }
117     int file = open(path.string().c_str(), flags);
118     if (file == -1)
119     {
120         error("File at path '{PATH}' does not exist", "PATH", path);
121         encode_rw_file_memory_resp(instanceId, command, PLDM_ERROR, 0,
122                                    responsePtr);
123         return response;
124     }
125     pldm::utils::CustomFD fd(file);
126 
127     while (length > dma::maxSize)
128     {
129         auto rc = intf->transferDataHost(fd(), offset, dma::maxSize, address,
130                                          upstream);
131         if (rc < 0)
132         {
133             encode_rw_file_memory_resp(instanceId, command, PLDM_ERROR, 0,
134                                        responsePtr);
135             return response;
136         }
137 
138         offset += dma::maxSize;
139         length -= dma::maxSize;
140         address += dma::maxSize;
141     }
142 
143     auto rc = intf->transferDataHost(fd(), offset, length, address, upstream);
144     if (rc < 0)
145     {
146         encode_rw_file_memory_resp(instanceId, command, PLDM_ERROR, 0,
147                                    responsePtr);
148         return response;
149     }
150 
151     encode_rw_file_memory_resp(instanceId, command, PLDM_SUCCESS, origLength,
152                                responsePtr);
153     return response;
154 }
155 
156 } // namespace dma
157 
158 namespace oem_ibm
159 {
160 static constexpr auto dumpObjPath = "/xyz/openbmc_project/dump/resource/entry/";
161 static constexpr auto resDumpEntry = "com.ibm.Dump.Entry.Resource";
162 
163 static constexpr auto certObjPath = "/xyz/openbmc_project/certs/ca/";
164 static constexpr auto certAuthority =
165     "xyz.openbmc_project.PLDM.Provider.Certs.Authority.CSR";
166 class Handler : public CmdHandler
167 {
168   public:
169     Handler(oem_platform::Handler* oemPlatformHandler, int hostSockFd,
170             uint8_t hostEid, pldm::InstanceIdDb* instanceIdDb,
171             pldm::requester::Handler<pldm::requester::Request>* handler) :
172         oemPlatformHandler(oemPlatformHandler)
173     {
174         handlers.emplace(
175             PLDM_READ_FILE_INTO_MEMORY,
176             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
177             return this->readFileIntoMemory(request, payloadLength);
178         });
179         handlers.emplace(
180             PLDM_WRITE_FILE_FROM_MEMORY,
181             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
182             return this->writeFileFromMemory(request, payloadLength);
183         });
184         handlers.emplace(
185             PLDM_WRITE_FILE_BY_TYPE_FROM_MEMORY,
186             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
187             return this->writeFileByTypeFromMemory(request, payloadLength);
188         });
189         handlers.emplace(
190             PLDM_READ_FILE_BY_TYPE_INTO_MEMORY,
191             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
192             return this->readFileByTypeIntoMemory(request, payloadLength);
193         });
194         handlers.emplace(
195             PLDM_READ_FILE_BY_TYPE,
196             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
197             return this->readFileByType(request, payloadLength);
198         });
199         handlers.emplace(
200             PLDM_WRITE_FILE_BY_TYPE,
201             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
202             return this->writeFileByType(request, payloadLength);
203         });
204         handlers.emplace(
205             PLDM_GET_FILE_TABLE,
206             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
207             return this->getFileTable(request, payloadLength);
208         });
209         handlers.emplace(
210             PLDM_READ_FILE,
211             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
212             return this->readFile(request, payloadLength);
213         });
214         handlers.emplace(
215             PLDM_WRITE_FILE,
216             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
217             return this->writeFile(request, payloadLength);
218         });
219         handlers.emplace(
220             PLDM_FILE_ACK,
221             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
222             return this->fileAck(request, payloadLength);
223         });
224         handlers.emplace(
225             PLDM_HOST_GET_ALERT_STATUS,
226             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
227             return this->getAlertStatus(request, payloadLength);
228         });
229         handlers.emplace(
230             PLDM_NEW_FILE_AVAILABLE,
231             [this](pldm_tid_t, const pldm_msg* request, size_t payloadLength) {
232             return this->newFileAvailable(request, payloadLength);
233         });
234 
235         resDumpMatcher = std::make_unique<sdbusplus::bus::match_t>(
236             pldm::utils::DBusHandler::getBus(),
237             sdbusplus::bus::match::rules::interfacesAdded() +
238                 sdbusplus::bus::match::rules::argNpath(0, dumpObjPath),
239             [this, hostSockFd, hostEid, instanceIdDb,
240              handler](sdbusplus::message_t& msg) {
241             std::map<std::string,
242                      std::map<std::string, std::variant<std::string, uint32_t>>>
243                 interfaces;
244             sdbusplus::message::object_path path;
245             msg.read(path, interfaces);
246             std::string vspstring;
247             std::string password;
248 
249             for (const auto& interface : interfaces)
250             {
251                 if (interface.first == resDumpEntry)
252                 {
253                     for (const auto& property : interface.second)
254                     {
255                         if (property.first == "VSPString")
256                         {
257                             vspstring = std::get<std::string>(property.second);
258                         }
259                         else if (property.first == "Password")
260                         {
261                             password = std::get<std::string>(property.second);
262                         }
263                     }
264                     dbusToFileHandlers
265                         .emplace_back(
266                             std::make_unique<
267                                 pldm::requester::oem_ibm::DbusToFileHandler>(
268                                 hostSockFd, hostEid, instanceIdDb, path,
269                                 handler))
270                         ->processNewResourceDump(vspstring, password);
271                     break;
272                 }
273             }
274         });
275         vmiCertMatcher = std::make_unique<sdbusplus::bus::match_t>(
276             pldm::utils::DBusHandler::getBus(),
277             sdbusplus::bus::match::rules::interfacesAdded() +
278                 sdbusplus::bus::match::rules::argNpath(0, certObjPath),
279             [this, hostSockFd, hostEid, instanceIdDb,
280              handler](sdbusplus::message_t& msg) {
281             std::map<std::string,
282                      std::map<std::string, std::variant<std::string, uint32_t>>>
283                 interfaces;
284             sdbusplus::message::object_path path;
285             msg.read(path, interfaces);
286             std::string csr;
287 
288             for (const auto& interface : interfaces)
289             {
290                 if (interface.first == certAuthority)
291                 {
292                     for (const auto& property : interface.second)
293                     {
294                         if (property.first == "CSR")
295                         {
296                             csr = std::get<std::string>(property.second);
297                             auto fileHandle =
298                                 sdbusplus::message::object_path(path)
299                                     .filename();
300 
301                             dbusToFileHandlers
302                                 .emplace_back(
303                                     std::make_unique<pldm::requester::oem_ibm::
304                                                          DbusToFileHandler>(
305                                         hostSockFd, hostEid, instanceIdDb, path,
306                                         handler))
307                                 ->newCsrFileAvailable(csr, fileHandle);
308                             break;
309                         }
310                     }
311                     break;
312                 }
313             }
314         });
315     }
316 
317     /** @brief Handler for readFileIntoMemory command
318      *
319      *  @param[in] request - pointer to PLDM request payload
320      *  @param[in] payloadLength - length of the message
321      *
322      *  @return PLDM response message
323      */
324     Response readFileIntoMemory(const pldm_msg* request, size_t payloadLength);
325 
326     /** @brief Handler for writeFileIntoMemory command
327      *
328      *  @param[in] request - pointer to PLDM request payload
329      *  @param[in] payloadLength - length of the message
330      *
331      *  @return PLDM response message
332      */
333     Response writeFileFromMemory(const pldm_msg* request, size_t payloadLength);
334 
335     /** @brief Handler for writeFileByTypeFromMemory command
336      *
337      *  @param[in] request - pointer to PLDM request payload
338      *  @param[in] payloadLength - length of the message
339      *
340      *  @return PLDM response message
341      */
342 
343     Response writeFileByTypeFromMemory(const pldm_msg* request,
344                                        size_t payloadLength);
345 
346     /** @brief Handler for readFileByTypeIntoMemory command
347      *
348      *  @param[in] request - pointer to PLDM request payload
349      *  @param[in] payloadLength - length of the message
350      *
351      *  @return PLDM response message
352      */
353     Response readFileByTypeIntoMemory(const pldm_msg* request,
354                                       size_t payloadLength);
355 
356     /** @brief Handler for writeFileByType command
357      *
358      *  @param[in] request - pointer to PLDM request payload
359      *  @param[in] payloadLength - length of the message
360      *
361      *  @return PLDM response message
362      */
363     Response readFileByType(const pldm_msg* request, size_t payloadLength);
364 
365     Response writeFileByType(const pldm_msg* request, size_t payloadLength);
366 
367     /** @brief Handler for GetFileTable command
368      *
369      *  @param[in] request - pointer to PLDM request payload
370      *  @param[in] payloadLength - length of the message payload
371      *
372      *  @return PLDM response message
373      */
374     Response getFileTable(const pldm_msg* request, size_t payloadLength);
375 
376     /** @brief Handler for readFile command
377      *
378      *  @param[in] request - PLDM request msg
379      *  @param[in] payloadLength - length of the message payload
380      *
381      *  @return PLDM response message
382      */
383     Response readFile(const pldm_msg* request, size_t payloadLength);
384 
385     /** @brief Handler for writeFile command
386      *
387      *  @param[in] request - PLDM request msg
388      *  @param[in] payloadLength - length of the message payload
389      *
390      *  @return PLDM response message
391      */
392     Response writeFile(const pldm_msg* request, size_t payloadLength);
393 
394     Response fileAck(const pldm_msg* request, size_t payloadLength);
395 
396     /** @brief Handler for getAlertStatus command
397      *
398      *  @param[in] request - PLDM request msg
399      *  @param[in] payloadLength - length of the message payload
400      *
401      *  @return PLDM response message
402      */
403     Response getAlertStatus(const pldm_msg* request, size_t payloadLength);
404 
405     /** @brief Handler for newFileAvailable command
406      *
407      *  @param[in] request - PLDM request msg
408      *  @param[in] payloadLength - length of the message payload
409      *
410      *  @return PLDM response message
411      */
412     Response newFileAvailable(const pldm_msg* request, size_t payloadLength);
413 
414   private:
415     oem_platform::Handler* oemPlatformHandler;
416     using DBusInterfaceAdded = std::vector<std::pair<
417         std::string,
418         std::vector<std::pair<std::string, std::variant<std::string>>>>>;
419     std::unique_ptr<pldm::requester::oem_ibm::DbusToFileHandler>
420         dbusToFileHandler; //!< pointer to send request to Host
421     std::unique_ptr<sdbusplus::bus::match_t>
422         resDumpMatcher;    //!< Pointer to capture the interface added signal
423                            //!< for new resource dump
424     std::unique_ptr<sdbusplus::bus::match_t>
425         vmiCertMatcher;    //!< Pointer to capture the interface added signal
426                            //!< for new csr string
427     /** @brief PLDM request handler */
428     std::vector<std::unique_ptr<pldm::requester::oem_ibm::DbusToFileHandler>>
429         dbusToFileHandlers;
430 };
431 
432 } // namespace oem_ibm
433 } // namespace responder
434 } // namespace pldm
435