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/file_io.h>
12 #include <libpldm/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 does not exist, path = {FILE_PATH}", "FILE_PATH",
121               path.string());
122         encode_rw_file_memory_resp(instanceId, command, PLDM_ERROR, 0,
123                                    responsePtr);
124         return response;
125     }
126     pldm::utils::CustomFD fd(file);
127 
128     while (length > dma::maxSize)
129     {
130         auto rc = intf->transferDataHost(fd(), offset, dma::maxSize, address,
131                                          upstream);
132         if (rc < 0)
133         {
134             encode_rw_file_memory_resp(instanceId, command, PLDM_ERROR, 0,
135                                        responsePtr);
136             return response;
137         }
138 
139         offset += dma::maxSize;
140         length -= dma::maxSize;
141         address += dma::maxSize;
142     }
143 
144     auto rc = intf->transferDataHost(fd(), offset, length, address, upstream);
145     if (rc < 0)
146     {
147         encode_rw_file_memory_resp(instanceId, command, PLDM_ERROR, 0,
148                                    responsePtr);
149         return response;
150     }
151 
152     encode_rw_file_memory_resp(instanceId, command, PLDM_SUCCESS, origLength,
153                                responsePtr);
154     return response;
155 }
156 
157 } // namespace dma
158 
159 namespace oem_ibm
160 {
161 static constexpr auto dumpObjPath = "/xyz/openbmc_project/dump/resource/entry/";
162 static constexpr auto resDumpEntry = "com.ibm.Dump.Entry.Resource";
163 
164 static constexpr auto certObjPath = "/xyz/openbmc_project/certs/ca/";
165 static constexpr auto certAuthority =
166     "xyz.openbmc_project.PLDM.Provider.Certs.Authority.CSR";
167 class Handler : public CmdHandler
168 {
169   public:
170     Handler(oem_platform::Handler* oemPlatformHandler, int hostSockFd,
171             uint8_t hostEid, pldm::InstanceIdDb* instanceIdDb,
172             pldm::requester::Handler<pldm::requester::Request>* handler) :
173         oemPlatformHandler(oemPlatformHandler),
174         hostSockFd(hostSockFd), hostEid(hostEid), instanceIdDb(instanceIdDb),
175         handler(handler)
176     {
177         handlers.emplace(PLDM_READ_FILE_INTO_MEMORY,
178                          [this](const pldm_msg* request, size_t payloadLength) {
179             return this->readFileIntoMemory(request, payloadLength);
180         });
181         handlers.emplace(PLDM_WRITE_FILE_FROM_MEMORY,
182                          [this](const pldm_msg* request, size_t payloadLength) {
183             return this->writeFileFromMemory(request, payloadLength);
184         });
185         handlers.emplace(PLDM_WRITE_FILE_BY_TYPE_FROM_MEMORY,
186                          [this](const pldm_msg* request, size_t payloadLength) {
187             return this->writeFileByTypeFromMemory(request, payloadLength);
188         });
189         handlers.emplace(PLDM_READ_FILE_BY_TYPE_INTO_MEMORY,
190                          [this](const pldm_msg* request, size_t payloadLength) {
191             return this->readFileByTypeIntoMemory(request, payloadLength);
192         });
193         handlers.emplace(PLDM_READ_FILE_BY_TYPE,
194                          [this](const pldm_msg* request, size_t payloadLength) {
195             return this->readFileByType(request, payloadLength);
196         });
197         handlers.emplace(PLDM_WRITE_FILE_BY_TYPE,
198                          [this](const pldm_msg* request, size_t payloadLength) {
199             return this->writeFileByType(request, payloadLength);
200         });
201         handlers.emplace(PLDM_GET_FILE_TABLE,
202                          [this](const pldm_msg* request, size_t payloadLength) {
203             return this->getFileTable(request, payloadLength);
204         });
205         handlers.emplace(PLDM_READ_FILE,
206                          [this](const pldm_msg* request, size_t payloadLength) {
207             return this->readFile(request, payloadLength);
208         });
209         handlers.emplace(PLDM_WRITE_FILE,
210                          [this](const pldm_msg* request, size_t payloadLength) {
211             return this->writeFile(request, payloadLength);
212         });
213         handlers.emplace(PLDM_FILE_ACK,
214                          [this](const pldm_msg* request, size_t payloadLength) {
215             return this->fileAck(request, payloadLength);
216         });
217         handlers.emplace(PLDM_HOST_GET_ALERT_STATUS,
218                          [this](const pldm_msg* request, size_t payloadLength) {
219             return this->getAlertStatus(request, payloadLength);
220         });
221         handlers.emplace(PLDM_NEW_FILE_AVAILABLE,
222                          [this](const pldm_msg* request, size_t payloadLength) {
223             return this->newFileAvailable(request, payloadLength);
224         });
225 
226         resDumpMatcher = std::make_unique<sdbusplus::bus::match_t>(
227             pldm::utils::DBusHandler::getBus(),
228             sdbusplus::bus::match::rules::interfacesAdded() +
229                 sdbusplus::bus::match::rules::argNpath(0, dumpObjPath),
230             [this, hostSockFd, hostEid, instanceIdDb,
231              handler](sdbusplus::message_t& msg) {
232             std::map<std::string,
233                      std::map<std::string, std::variant<std::string, uint32_t>>>
234                 interfaces;
235             sdbusplus::message::object_path path;
236             msg.read(path, interfaces);
237             std::string vspstring;
238             std::string password;
239 
240             for (auto& interface : interfaces)
241             {
242                 if (interface.first == resDumpEntry)
243                 {
244                     for (const auto& property : interface.second)
245                     {
246                         if (property.first == "VSPString")
247                         {
248                             vspstring = std::get<std::string>(property.second);
249                         }
250                         else if (property.first == "Password")
251                         {
252                             password = std::get<std::string>(property.second);
253                         }
254                     }
255                     dbusToFileHandlers
256                         .emplace_back(
257                             std::make_unique<
258                                 pldm::requester::oem_ibm::DbusToFileHandler>(
259                                 hostSockFd, hostEid, instanceIdDb, path,
260                                 handler))
261                         ->processNewResourceDump(vspstring, password);
262                     break;
263                 }
264             }
265             });
266         vmiCertMatcher = std::make_unique<sdbusplus::bus::match_t>(
267             pldm::utils::DBusHandler::getBus(),
268             sdbusplus::bus::match::rules::interfacesAdded() +
269                 sdbusplus::bus::match::rules::argNpath(0, certObjPath),
270             [this, hostSockFd, hostEid, instanceIdDb,
271              handler](sdbusplus::message_t& msg) {
272             std::map<std::string,
273                      std::map<std::string, std::variant<std::string, uint32_t>>>
274                 interfaces;
275             sdbusplus::message::object_path path;
276             msg.read(path, interfaces);
277             std::string csr;
278 
279             for (auto& interface : interfaces)
280             {
281                 if (interface.first == certAuthority)
282                 {
283                     for (const auto& property : interface.second)
284                     {
285                         if (property.first == "CSR")
286                         {
287                             csr = std::get<std::string>(property.second);
288                             auto fileHandle =
289                                 sdbusplus::message::object_path(path)
290                                     .filename();
291 
292                             dbusToFileHandlers
293                                 .emplace_back(
294                                     std::make_unique<pldm::requester::oem_ibm::
295                                                          DbusToFileHandler>(
296                                         hostSockFd, hostEid, instanceIdDb, path,
297                                         handler))
298                                 ->newCsrFileAvailable(csr, fileHandle);
299                             break;
300                         }
301                     }
302                     break;
303                 }
304             }
305             });
306     }
307 
308     /** @brief Handler for readFileIntoMemory command
309      *
310      *  @param[in] request - pointer to PLDM request payload
311      *  @param[in] payloadLength - length of the message
312      *
313      *  @return PLDM response message
314      */
315     Response readFileIntoMemory(const pldm_msg* request, size_t payloadLength);
316 
317     /** @brief Handler for writeFileIntoMemory 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 writeFileFromMemory(const pldm_msg* request, size_t payloadLength);
325 
326     /** @brief Handler for writeFileByTypeFromMemory 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 
334     Response writeFileByTypeFromMemory(const pldm_msg* request,
335                                        size_t payloadLength);
336 
337     /** @brief Handler for readFileByTypeIntoMemory command
338      *
339      *  @param[in] request - pointer to PLDM request payload
340      *  @param[in] payloadLength - length of the message
341      *
342      *  @return PLDM response message
343      */
344     Response readFileByTypeIntoMemory(const pldm_msg* request,
345                                       size_t payloadLength);
346 
347     /** @brief Handler for writeFileByType command
348      *
349      *  @param[in] request - pointer to PLDM request payload
350      *  @param[in] payloadLength - length of the message
351      *
352      *  @return PLDM response message
353      */
354     Response readFileByType(const pldm_msg* request, size_t payloadLength);
355 
356     Response writeFileByType(const pldm_msg* request, size_t payloadLength);
357 
358     /** @brief Handler for GetFileTable command
359      *
360      *  @param[in] request - pointer to PLDM request payload
361      *  @param[in] payloadLength - length of the message payload
362      *
363      *  @return PLDM response message
364      */
365     Response getFileTable(const pldm_msg* request, size_t payloadLength);
366 
367     /** @brief Handler for readFile command
368      *
369      *  @param[in] request - PLDM request msg
370      *  @param[in] payloadLength - length of the message payload
371      *
372      *  @return PLDM response message
373      */
374     Response readFile(const pldm_msg* request, size_t payloadLength);
375 
376     /** @brief Handler for writeFile 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 writeFile(const pldm_msg* request, size_t payloadLength);
384 
385     Response fileAck(const pldm_msg* request, size_t payloadLength);
386 
387     /** @brief Handler for getAlertStatus command
388      *
389      *  @param[in] request - PLDM request msg
390      *  @param[in] payloadLength - length of the message payload
391      *
392      *  @return PLDM response message
393      */
394     Response getAlertStatus(const pldm_msg* request, size_t payloadLength);
395 
396     /** @brief Handler for newFileAvailable 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 newFileAvailable(const pldm_msg* request, size_t payloadLength);
404 
405   private:
406     oem_platform::Handler* oemPlatformHandler;
407     int hostSockFd;
408     uint8_t hostEid;
409     pldm::InstanceIdDb* instanceIdDb;
410     using DBusInterfaceAdded = std::vector<std::pair<
411         std::string,
412         std::vector<std::pair<std::string, std::variant<std::string>>>>>;
413     std::unique_ptr<pldm::requester::oem_ibm::DbusToFileHandler>
414         dbusToFileHandler; //!< pointer to send request to Host
415     std::unique_ptr<sdbusplus::bus::match_t>
416         resDumpMatcher;    //!< Pointer to capture the interface added signal
417                            //!< for new resource dump
418     std::unique_ptr<sdbusplus::bus::match_t>
419         vmiCertMatcher;    //!< Pointer to capture the interface added signal
420                            //!< for new csr string
421     /** @brief PLDM request handler */
422     pldm::requester::Handler<pldm::requester::Request>* handler;
423     std::vector<std::unique_ptr<pldm::requester::oem_ibm::DbusToFileHandler>>
424         dbusToFileHandlers;
425 };
426 
427 } // namespace oem_ibm
428 } // namespace responder
429 } // namespace pldm
430