Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 3 | #include "file_io_by_type.hpp" |
| 4 | |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 5 | #include <phosphor-logging/lg2.hpp> |
| 6 | |
Adriana Kobylak | 6876f12 | 2019-12-12 09:49:56 -0600 | [diff] [blame] | 7 | #include <filesystem> |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 8 | #include <sstream> |
| 9 | #include <string> |
| 10 | |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 11 | PHOSPHOR_LOG2_USING; |
| 12 | |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 13 | namespace pldm |
| 14 | { |
| 15 | namespace responder |
| 16 | { |
| 17 | |
Adriana Kobylak | 6876f12 | 2019-12-12 09:49:56 -0600 | [diff] [blame] | 18 | namespace fs = std::filesystem; |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 19 | |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 20 | using MarkerLIDremainingSize = uint64_t; |
| 21 | |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 22 | /** @class LidHandler |
| 23 | * |
| 24 | * @brief Inherits and implements FileHandler. This class is used |
| 25 | * to read/write LIDs. |
| 26 | */ |
| 27 | class LidHandler : public FileHandler |
| 28 | { |
| 29 | public: |
| 30 | /** @brief LidHandler constructor |
| 31 | */ |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 32 | LidHandler(uint32_t fileHandle, bool permSide, uint8_t lidType = 0) : |
| 33 | FileHandler(fileHandle), lidType(lidType) |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 34 | { |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 35 | sideToRead = permSide ? Pside : Tside; |
| 36 | isPatchDir = false; |
Adriana Kobylak | 76f820c | 2020-07-16 11:02:03 -0500 | [diff] [blame] | 37 | std::string dir = permSide ? LID_ALTERNATE_DIR : LID_RUNNING_DIR; |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 38 | std::stringstream stream; |
| 39 | stream << std::hex << fileHandle; |
Adriana Kobylak | 6876f12 | 2019-12-12 09:49:56 -0600 | [diff] [blame] | 40 | auto lidName = stream.str() + ".lid"; |
Patrick Williams | 6da4f91 | 2023-05-10 07:50:53 -0500 | [diff] [blame] | 41 | std::string patchDir = permSide ? LID_ALTERNATE_PATCH_DIR |
| 42 | : LID_RUNNING_PATCH_DIR; |
Deepak Kodihalli | 09b017b | 2020-08-26 07:37:32 -0500 | [diff] [blame] | 43 | auto patch = fs::path(patchDir) / lidName; |
| 44 | if (fs::is_regular_file(patch)) |
Adriana Kobylak | 6876f12 | 2019-12-12 09:49:56 -0600 | [diff] [blame] | 45 | { |
| 46 | lidPath = patch; |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 47 | isPatchDir = true; |
Adriana Kobylak | 6876f12 | 2019-12-12 09:49:56 -0600 | [diff] [blame] | 48 | } |
| 49 | else |
| 50 | { |
| 51 | lidPath = std::move(dir) + '/' + lidName; |
| 52 | } |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 53 | } |
| 54 | |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 55 | /** @brief Method to construct the LID path based on current boot side |
| 56 | * @param[in] oemPlatformHandler - OEM platform handler |
| 57 | * @return bool - true if a new path is constructed |
| 58 | */ |
| 59 | bool constructLIDPath(oem_platform::Handler* oemPlatformHandler) |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 60 | { |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 61 | if (oemPlatformHandler != nullptr) |
| 62 | { |
| 63 | pldm::responder::oem_ibm_platform::Handler* oemIbmPlatformHandler = |
| 64 | dynamic_cast<pldm::responder::oem_ibm_platform::Handler*>( |
| 65 | oemPlatformHandler); |
| 66 | std::string dir = LID_ALTERNATE_DIR; |
| 67 | if (isPatchDir) |
| 68 | { |
| 69 | dir = LID_ALTERNATE_PATCH_DIR; |
| 70 | } |
| 71 | if (oemIbmPlatformHandler->codeUpdate->fetchCurrentBootSide() == |
| 72 | sideToRead) |
| 73 | { |
| 74 | if (isPatchDir) |
| 75 | { |
| 76 | dir = LID_RUNNING_PATCH_DIR; |
| 77 | } |
| 78 | else |
| 79 | { |
| 80 | dir = LID_RUNNING_DIR; |
| 81 | } |
| 82 | } |
| 83 | else if (oemIbmPlatformHandler->codeUpdate |
| 84 | ->isCodeUpdateInProgress()) |
| 85 | { |
| 86 | return false; |
| 87 | } |
| 88 | |
| 89 | std::stringstream stream; |
| 90 | stream << std::hex << fileHandle; |
| 91 | auto lidName = stream.str() + ".lid"; |
| 92 | lidPath = std::move(dir) + '/' + lidName; |
| 93 | } |
| 94 | return true; |
| 95 | } |
| 96 | |
| 97 | virtual int writeFromMemory(uint32_t offset, uint32_t length, |
| 98 | uint64_t address, |
| 99 | oem_platform::Handler* oemPlatformHandler) |
| 100 | { |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 101 | int rc = PLDM_SUCCESS; |
| 102 | bool codeUpdateInProgress = false; |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 103 | if (oemPlatformHandler != nullptr) |
| 104 | { |
| 105 | pldm::responder::oem_ibm_platform::Handler* oemIbmPlatformHandler = |
| 106 | dynamic_cast<pldm::responder::oem_ibm_platform::Handler*>( |
| 107 | oemPlatformHandler); |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 108 | codeUpdateInProgress = |
| 109 | oemIbmPlatformHandler->codeUpdate->isCodeUpdateInProgress(); |
| 110 | if (codeUpdateInProgress || lidType == PLDM_FILE_TYPE_LID_MARKER) |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 111 | { |
| 112 | std::string dir = LID_STAGING_DIR; |
| 113 | std::stringstream stream; |
| 114 | stream << std::hex << fileHandle; |
| 115 | auto lidName = stream.str() + ".lid"; |
| 116 | lidPath = std::move(dir) + '/' + lidName; |
| 117 | } |
| 118 | } |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 119 | bool fileExists = fs::exists(lidPath); |
| 120 | int flags{}; |
| 121 | if (fileExists) |
| 122 | { |
| 123 | flags = O_RDWR; |
| 124 | } |
| 125 | else |
| 126 | { |
| 127 | flags = O_WRONLY | O_CREAT | O_TRUNC | O_SYNC; |
| 128 | } |
Sagar Srinivas | 9a64b4a | 2021-02-09 07:55:38 -0600 | [diff] [blame] | 129 | auto fd = open(lidPath.c_str(), flags, S_IRUSR); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 130 | if (fd == -1) |
| 131 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 132 | error("Could not open file for writing {LID_PATH}", "LID_PATH", |
| 133 | lidPath.c_str()); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 134 | return PLDM_ERROR; |
| 135 | } |
| 136 | close(fd); |
| 137 | |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 138 | rc = transferFileData(lidPath, false, offset, length, address); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 139 | if (rc != PLDM_SUCCESS) |
| 140 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 141 | error("writeFileFromMemory failed with rc= {RC}", "RC", rc); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 142 | return rc; |
| 143 | } |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 144 | if (lidType == PLDM_FILE_TYPE_LID_MARKER) |
| 145 | { |
| 146 | markerLIDremainingSize -= length; |
| 147 | if (markerLIDremainingSize == 0) |
| 148 | { |
| 149 | pldm::responder::oem_ibm_platform::Handler* |
| 150 | oemIbmPlatformHandler = dynamic_cast< |
| 151 | pldm::responder::oem_ibm_platform::Handler*>( |
| 152 | oemPlatformHandler); |
| 153 | auto sensorId = |
| 154 | oemIbmPlatformHandler->codeUpdate->getMarkerLidSensor(); |
| 155 | using namespace pldm::responder::oem_ibm_platform; |
| 156 | oemIbmPlatformHandler->sendStateSensorEvent( |
| 157 | sensorId, PLDM_STATE_SENSOR_STATE, 0, VALID, VALID); |
| 158 | // rc = validate api; |
| 159 | rc = PLDM_SUCCESS; |
| 160 | } |
| 161 | } |
| 162 | else if (codeUpdateInProgress) |
| 163 | { |
| 164 | rc = processCodeUpdateLid(lidPath); |
| 165 | } |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 166 | return rc; |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 167 | } |
| 168 | |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 169 | virtual int readIntoMemory(uint32_t offset, uint32_t& length, |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 170 | uint64_t address, |
| 171 | oem_platform::Handler* oemPlatformHandler) |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 172 | { |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 173 | if (constructLIDPath(oemPlatformHandler)) |
| 174 | { |
| 175 | return transferFileData(lidPath, true, offset, length, address); |
| 176 | } |
| 177 | return PLDM_ERROR; |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 178 | } |
| 179 | |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 180 | virtual int write(const char* buffer, uint32_t offset, uint32_t& length, |
| 181 | oem_platform::Handler* oemPlatformHandler) |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 182 | { |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 183 | int rc = PLDM_SUCCESS; |
| 184 | bool codeUpdateInProgress = false; |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 185 | if (oemPlatformHandler != nullptr) |
| 186 | { |
| 187 | pldm::responder::oem_ibm_platform::Handler* oemIbmPlatformHandler = |
| 188 | dynamic_cast<pldm::responder::oem_ibm_platform::Handler*>( |
| 189 | oemPlatformHandler); |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 190 | codeUpdateInProgress = |
| 191 | oemIbmPlatformHandler->codeUpdate->isCodeUpdateInProgress(); |
| 192 | if (codeUpdateInProgress || lidType == PLDM_FILE_TYPE_LID_MARKER) |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 193 | { |
| 194 | std::string dir = LID_STAGING_DIR; |
| 195 | std::stringstream stream; |
| 196 | stream << std::hex << fileHandle; |
| 197 | auto lidName = stream.str() + ".lid"; |
| 198 | lidPath = std::move(dir) + '/' + lidName; |
| 199 | } |
| 200 | } |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 201 | bool fileExists = fs::exists(lidPath); |
| 202 | int flags{}; |
| 203 | if (fileExists) |
| 204 | { |
| 205 | flags = O_RDWR; |
| 206 | size_t fileSize = fs::file_size(lidPath); |
| 207 | if (offset > fileSize) |
| 208 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 209 | error( |
Sagar Srinivas | 8225792 | 2023-07-10 08:12:22 -0500 | [diff] [blame] | 210 | "Offset exceeds file size, OFFSET={OFFSET} FILE_SIZE={FILE_SIZE} FILE_HANDLE{FILE_HANDLE}", |
| 211 | "OFFSET", offset, "FILE_SIZE", fileSize, "FILE_HANDLE", |
| 212 | fileHandle); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 213 | return PLDM_DATA_OUT_OF_RANGE; |
| 214 | } |
| 215 | } |
| 216 | else |
| 217 | { |
| 218 | flags = O_WRONLY | O_CREAT | O_TRUNC | O_SYNC; |
| 219 | if (offset > 0) |
| 220 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 221 | error("Offset is non zero in a new file"); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 222 | return PLDM_DATA_OUT_OF_RANGE; |
| 223 | } |
| 224 | } |
Sagar Srinivas | 9a64b4a | 2021-02-09 07:55:38 -0600 | [diff] [blame] | 225 | auto fd = open(lidPath.c_str(), flags, S_IRUSR); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 226 | if (fd == -1) |
| 227 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 228 | error("could not open file {LID_PATH}", "LID_PATH", |
| 229 | lidPath.c_str()); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 230 | return PLDM_ERROR; |
| 231 | } |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 232 | rc = lseek(fd, offset, SEEK_SET); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 233 | if (rc == -1) |
| 234 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 235 | error("lseek failed, ERROR={ERR}, OFFSET={OFFSET}", "ERR", errno, |
| 236 | "OFFSET", offset); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 237 | return PLDM_ERROR; |
| 238 | } |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 239 | rc = ::write(fd, buffer, length); |
| 240 | if (rc == -1) |
| 241 | { |
Riya Dixit | 49cfb13 | 2023-03-02 04:26:53 -0600 | [diff] [blame] | 242 | error( |
| 243 | "file write failed, ERROR={ERR}, LENGTH={LEN}, OFFSET={OFFSET}", |
| 244 | "ERR", errno, "LEN", length, "OFFSET", offset); |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 245 | return PLDM_ERROR; |
| 246 | } |
Pavithra Barithaya | 303387e | 2021-03-18 23:35:42 -0500 | [diff] [blame] | 247 | else if (rc == static_cast<int>(length)) |
| 248 | { |
| 249 | rc = PLDM_SUCCESS; |
| 250 | } |
| 251 | else if (rc < static_cast<int>(length)) |
| 252 | { |
| 253 | rc = PLDM_ERROR; |
| 254 | } |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 255 | close(fd); |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 256 | |
| 257 | if (lidType == PLDM_FILE_TYPE_LID_MARKER) |
| 258 | { |
| 259 | markerLIDremainingSize -= length; |
| 260 | if (markerLIDremainingSize == 0) |
| 261 | { |
| 262 | pldm::responder::oem_ibm_platform::Handler* |
| 263 | oemIbmPlatformHandler = dynamic_cast< |
| 264 | pldm::responder::oem_ibm_platform::Handler*>( |
| 265 | oemPlatformHandler); |
| 266 | auto sensorId = |
| 267 | oemIbmPlatformHandler->codeUpdate->getMarkerLidSensor(); |
| 268 | using namespace pldm::responder::oem_ibm_platform; |
| 269 | oemIbmPlatformHandler->sendStateSensorEvent( |
| 270 | sensorId, PLDM_STATE_SENSOR_STATE, 0, VALID, VALID); |
| 271 | // validate api |
| 272 | rc = PLDM_SUCCESS; |
| 273 | } |
| 274 | } |
| 275 | else if (codeUpdateInProgress) |
| 276 | { |
| 277 | rc = processCodeUpdateLid(lidPath); |
| 278 | } |
| 279 | |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 280 | return rc; |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 281 | } |
| 282 | |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 283 | virtual int read(uint32_t offset, uint32_t& length, Response& response, |
| 284 | oem_platform::Handler* oemPlatformHandler) |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 285 | { |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 286 | if (constructLIDPath(oemPlatformHandler)) |
| 287 | { |
| 288 | return readFile(lidPath, offset, length, response); |
| 289 | } |
| 290 | return PLDM_ERROR; |
Deepak Kodihalli | 75e02f8 | 2019-11-20 02:51:05 -0600 | [diff] [blame] | 291 | } |
| 292 | |
Deepak Kodihalli | 2da1bfe | 2019-12-14 08:28:09 -0600 | [diff] [blame] | 293 | virtual int fileAck(uint8_t /*fileStatus*/) |
| 294 | { |
| 295 | return PLDM_ERROR_UNSUPPORTED_PLDM_CMD; |
| 296 | } |
| 297 | |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 298 | virtual int newFileAvailable(uint64_t length) |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 299 | |
| 300 | { |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 301 | if (lidType == PLDM_FILE_TYPE_LID_MARKER) |
| 302 | { |
| 303 | markerLIDremainingSize = length; |
| 304 | return PLDM_SUCCESS; |
| 305 | } |
Sampa Misra | 1896716 | 2020-01-14 02:31:41 -0600 | [diff] [blame] | 306 | return PLDM_ERROR_UNSUPPORTED_PLDM_CMD; |
| 307 | } |
| 308 | |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 309 | /** @brief LidHandler destructor |
| 310 | */ |
Patrick Williams | 6da4f91 | 2023-05-10 07:50:53 -0500 | [diff] [blame] | 311 | ~LidHandler() {} |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 312 | |
| 313 | protected: |
| 314 | std::string lidPath; |
Sampa Misra | 6950850 | 2020-09-08 00:08:21 -0500 | [diff] [blame] | 315 | std::string sideToRead; |
| 316 | bool isPatchDir; |
Sampa Misra | 3a0e3b9 | 2020-10-21 05:58:00 -0500 | [diff] [blame] | 317 | static inline MarkerLIDremainingSize markerLIDremainingSize; |
| 318 | uint8_t lidType; |
Deepak Kodihalli | f6d3a83 | 2019-11-19 07:00:29 -0600 | [diff] [blame] | 319 | }; |
| 320 | |
| 321 | } // namespace responder |
| 322 | } // namespace pldm |