Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 1 | #include "file_io_by_type.hpp" |
| 2 | |
Deepak Kodihalli | d130e1a | 2020-06-17 05:55:32 -0500 | [diff] [blame] | 3 | #include "common/utils.hpp" |
Sampa Misra | d823cc0 | 2020-03-24 04:53:20 -0500 | [diff] [blame] | 4 | #include "file_io_type_cert.hpp" |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 5 | #include "file_io_type_dump.hpp" |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 6 | #include "file_io_type_lid.hpp" |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 7 | #include "file_io_type_pel.hpp" |
Manojkiran Eda | d94bb83 | 2021-02-17 11:40:22 +0530 | [diff] [blame] | 8 | #include "file_io_type_progress_src.hpp" |
Varsha Kaverappa | e1874e8 | 2023-05-02 09:53:24 -0500 | [diff] [blame] | 9 | #include "file_io_type_vpd.hpp" |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 10 | #include "xyz/openbmc_project/Common/error.hpp" |
| 11 | |
George Liu | c453e16 | 2022-12-21 17:16:23 +0800 | [diff] [blame] | 12 | #include <libpldm/base.h> |
| 13 | #include <libpldm/file_io.h> |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 14 | #include <stdint.h> |
| 15 | #include <unistd.h> |
| 16 | |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 17 | #include <phosphor-logging/lg2.hpp> |
George Liu | 6492f52 | 2020-06-16 10:34:05 +0800 | [diff] [blame] | 18 | #include <xyz/openbmc_project/Logging/Entry/server.hpp> |
| 19 | |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 20 | #include <exception> |
| 21 | #include <filesystem> |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 22 | #include <fstream> |
Sampa Misra | aa8ae72 | 2019-12-12 03:20:40 -0600 | [diff] [blame] | 23 | #include <iostream> |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 24 | #include <vector> |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 25 | |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 26 | PHOSPHOR_LOG2_USING; |
| 27 | |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 28 | namespace pldm |
| 29 | { |
| 30 | namespace responder |
| 31 | { |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 32 | using namespace sdbusplus::xyz::openbmc_project::Common::Error; |
| 33 | |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 34 | int FileHandler::transferFileData(int32_t fd, bool upstream, uint32_t offset, |
| 35 | uint32_t& length, uint64_t address) |
| 36 | { |
| 37 | dma::DMA xdmaInterface; |
| 38 | while (length > dma::maxSize) |
| 39 | { |
| 40 | auto rc = xdmaInterface.transferDataHost(fd, offset, dma::maxSize, |
| 41 | address, upstream); |
| 42 | if (rc < 0) |
| 43 | { |
| 44 | return PLDM_ERROR; |
| 45 | } |
| 46 | offset += dma::maxSize; |
| 47 | length -= dma::maxSize; |
| 48 | address += dma::maxSize; |
| 49 | } |
Patrick Williams | 6da4f91 | 2023-05-10 07:50:53 -0500 | [diff] [blame] | 50 | auto rc = xdmaInterface.transferDataHost(fd, offset, length, address, |
| 51 | upstream); |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 52 | return rc < 0 ? PLDM_ERROR : PLDM_SUCCESS; |
| 53 | } |
| 54 | |
Ravi Teja | ce1c96f | 2020-10-05 23:13:01 -0500 | [diff] [blame] | 55 | int FileHandler::transferFileDataToSocket(int32_t fd, uint32_t& length, |
| 56 | uint64_t address) |
| 57 | { |
| 58 | dma::DMA xdmaInterface; |
| 59 | while (length > dma::maxSize) |
| 60 | { |
Patrick Williams | 6da4f91 | 2023-05-10 07:50:53 -0500 | [diff] [blame] | 61 | auto rc = xdmaInterface.transferHostDataToSocket(fd, dma::maxSize, |
| 62 | address); |
Ravi Teja | ce1c96f | 2020-10-05 23:13:01 -0500 | [diff] [blame] | 63 | if (rc < 0) |
| 64 | { |
| 65 | return PLDM_ERROR; |
| 66 | } |
| 67 | length -= dma::maxSize; |
| 68 | address += dma::maxSize; |
| 69 | } |
| 70 | auto rc = xdmaInterface.transferHostDataToSocket(fd, length, address); |
| 71 | return rc < 0 ? PLDM_ERROR : PLDM_SUCCESS; |
| 72 | } |
| 73 | |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 74 | int FileHandler::transferFileData(const fs::path& path, bool upstream, |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 75 | uint32_t offset, uint32_t& length, |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 76 | uint64_t address) |
| 77 | { |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 78 | bool fileExists = false; |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 79 | if (upstream) |
| 80 | { |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 81 | fileExists = fs::exists(path); |
| 82 | if (!fileExists) |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 83 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 84 | error("File does not exist. PATH={FILE_PATH}", "FILE_PATH", |
| 85 | path.c_str()); |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 86 | return PLDM_INVALID_FILE_HANDLE; |
| 87 | } |
| 88 | |
| 89 | size_t fileSize = fs::file_size(path); |
| 90 | if (offset >= fileSize) |
| 91 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 92 | error( |
Sagar Srinivas | 8225792 | 2023-07-10 08:12:22 -0500 | [diff] [blame] | 93 | "Offset exceeds file size, OFFSET={OFFSET} FILE_SIZE={FILE_SIZE}, FILE_HANDLE={FILE_HANDLE}", |
| 94 | "OFFSET", offset, "FILE_SIZE", fileSize, "FILE_HANDLE", |
| 95 | fileHandle); |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 96 | return PLDM_DATA_OUT_OF_RANGE; |
| 97 | } |
| 98 | if (offset + length > fileSize) |
| 99 | { |
| 100 | length = fileSize - offset; |
| 101 | } |
| 102 | } |
| 103 | |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 104 | int flags{}; |
| 105 | if (upstream) |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 106 | { |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 107 | flags = O_RDONLY; |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 108 | } |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 109 | else if (fileExists) |
| 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 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 120 | error("File does not exist, PATH = {FILE_PATH}", "FILE_PATH", |
| 121 | path.string()); |
Deepak Kodihalli | 15211b4 | 2019-12-14 02:24:49 -0600 | [diff] [blame] | 122 | return PLDM_ERROR; |
| 123 | } |
| 124 | utils::CustomFD fd(file); |
| 125 | |
| 126 | return transferFileData(fd(), upstream, offset, length, address); |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 127 | } |
| 128 | |
| 129 | std::unique_ptr<FileHandler> getHandlerByType(uint16_t fileType, |
| 130 | uint32_t fileHandle) |
| 131 | { |
| 132 | switch (fileType) |
| 133 | { |
| 134 | case PLDM_FILE_TYPE_PEL: |
| 135 | { |
| 136 | return std::make_unique<PelHandler>(fileHandle); |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 137 | } |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 138 | case PLDM_FILE_TYPE_LID_PERM: |
| 139 | { |
| 140 | return std::make_unique<LidHandler>(fileHandle, true); |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 141 | } |
| 142 | case PLDM_FILE_TYPE_LID_TEMP: |
| 143 | { |
| 144 | return std::make_unique<LidHandler>(fileHandle, false); |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 145 | } |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 146 | case PLDM_FILE_TYPE_LID_MARKER: |
| 147 | { |
| 148 | return std::make_unique<LidHandler>(fileHandle, false, |
| 149 | PLDM_FILE_TYPE_LID_MARKER); |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 150 | } |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 151 | case PLDM_FILE_TYPE_DUMP: |
Jayashankar Padath | db12436 | 2021-01-28 21:12:34 -0600 | [diff] [blame] | 152 | case PLDM_FILE_TYPE_RESOURCE_DUMP_PARMS: |
| 153 | case PLDM_FILE_TYPE_RESOURCE_DUMP: |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 154 | { |
Jayashankar Padath | db12436 | 2021-01-28 21:12:34 -0600 | [diff] [blame] | 155 | return std::make_unique<DumpHandler>(fileHandle, fileType); |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 156 | } |
Sampa Misra | d823cc0 | 2020-03-24 04:53:20 -0500 | [diff] [blame] | 157 | case PLDM_FILE_TYPE_CERT_SIGNING_REQUEST: |
| 158 | case PLDM_FILE_TYPE_SIGNED_CERT: |
| 159 | case PLDM_FILE_TYPE_ROOT_CERT: |
| 160 | { |
| 161 | return std::make_unique<CertHandler>(fileHandle, fileType); |
Sampa Misra | d823cc0 | 2020-03-24 04:53:20 -0500 | [diff] [blame] | 162 | } |
Manojkiran Eda | d94bb83 | 2021-02-17 11:40:22 +0530 | [diff] [blame] | 163 | case PLDM_FILE_TYPE_PROGRESS_SRC: |
| 164 | { |
| 165 | return std::make_unique<ProgressCodeHandler>(fileHandle); |
| 166 | } |
Manojkiran Eda | 6d1ee4f | 2022-09-10 04:21:31 -0500 | [diff] [blame] | 167 | case PLDM_FILE_TYPE_LID_RUNNING: |
| 168 | { |
| 169 | return std::make_unique<LidHandler>(fileHandle, false, |
| 170 | PLDM_FILE_TYPE_LID_RUNNING); |
| 171 | } |
Varsha Kaverappa | e1874e8 | 2023-05-02 09:53:24 -0500 | [diff] [blame] | 172 | case PLDM_FILE_TYPE_PSPD_VPD_PDD_KEYWORD: |
| 173 | { |
| 174 | return std::make_unique<keywordHandler>(fileHandle, fileType); |
| 175 | } |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 176 | default: |
| 177 | { |
Sampa Misra | aa8ae72 | 2019-12-12 03:20:40 -0600 | [diff] [blame] | 178 | throw InternalFailure(); |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 179 | break; |
| 180 | } |
| 181 | } |
| 182 | return nullptr; |
| 183 | } |
| 184 | |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 185 | int FileHandler::readFile(const std::string& filePath, uint32_t offset, |
| 186 | uint32_t& length, Response& response) |
| 187 | { |
| 188 | if (!fs::exists(filePath)) |
| 189 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 190 | error("File does not exist, HANDLE={FILE_HANDLE} PATH={FILE_PATH}", |
| 191 | "FILE_HANDLE", fileHandle, "FILE_PATH", filePath.c_str()); |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 192 | return PLDM_INVALID_FILE_HANDLE; |
| 193 | } |
| 194 | |
| 195 | size_t fileSize = fs::file_size(filePath); |
| 196 | if (offset >= fileSize) |
| 197 | { |
Sagar Srinivas | 8225792 | 2023-07-10 08:12:22 -0500 | [diff] [blame] | 198 | error( |
| 199 | "Offset exceeds file size, OFFSET={OFFSET} FILE_SIZE={FILE_SIZE} FILE_HANDLE={FILE_HANDLE}", |
| 200 | "OFFSET", offset, "FILE_SIZE", fileSize, "FILE_HANDLE", fileHandle); |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 201 | return PLDM_DATA_OUT_OF_RANGE; |
| 202 | } |
| 203 | |
| 204 | if (offset + length > fileSize) |
| 205 | { |
| 206 | length = fileSize - offset; |
| 207 | } |
| 208 | |
| 209 | size_t currSize = response.size(); |
| 210 | response.resize(currSize + length); |
| 211 | auto filePos = reinterpret_cast<char*>(response.data()); |
| 212 | filePos += currSize; |
| 213 | std::ifstream stream(filePath, std::ios::in | std::ios::binary); |
| 214 | if (stream) |
| 215 | { |
| 216 | stream.seekg(offset); |
| 217 | stream.read(filePos, length); |
| 218 | return PLDM_SUCCESS; |
| 219 | } |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 220 | error("Unable to read file, FILE={FILE_PATH}", "FILE_PATH", |
| 221 | filePath.c_str()); |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 222 | return PLDM_ERROR; |
| 223 | } |
| 224 | |
Sampa Misra | 854e61f | 2019-08-22 04:36:47 -0500 | [diff] [blame] | 225 | } // namespace responder |
| 226 | } // namespace pldm |