blob: b547b5bb4d75fb82b14c994e6fd6ad225dc0c068 [file] [log] [blame]
#include "file_io.hpp"
#include "file_io_by_type.hpp"
#include "file_table.hpp"
#include "utils.hpp"
#include "xyz/openbmc_project/Common/error.hpp"
#include <fcntl.h>
#include <libpldm/base.h>
#include <sys/mman.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>
#include <phosphor-logging/lg2.hpp>
#include <cstring>
#include <fstream>
#include <memory>
PHOSPHOR_LOG2_USING;
namespace pldm
{
using namespace pldm::responder::utils;
using namespace sdbusplus::xyz::openbmc_project::Common::Error;
namespace responder
{
namespace fs = std::filesystem;
namespace dma
{
/** @struct AspeedXdmaOp
*
* Structure representing XDMA operation
*/
struct AspeedXdmaOp
{
uint64_t hostAddr; //!< the DMA address on the host side, configured by
//!< PCI subsystem.
uint32_t len; //!< the size of the transfer in bytes, it should be a
//!< multiple of 16 bytes
uint32_t upstream; //!< boolean indicating the direction of the DMA
//!< operation, true means a transfer from BMC to host.
};
constexpr auto xdmaDev = "/dev/aspeed-xdma";
int DMA::transferHostDataToSocket(int fd, uint32_t length, uint64_t address)
{
static const size_t pageSize = getpagesize();
uint32_t numPages = length / pageSize;
uint32_t pageAlignedLength = numPages * pageSize;
if (length > pageAlignedLength)
{
pageAlignedLength += pageSize;
}
auto mmapCleanup = [pageAlignedLength](void* vgaMem) {
munmap(vgaMem, pageAlignedLength);
};
int dmaFd = -1;
int rc = 0;
dmaFd = open(xdmaDev, O_RDWR);
if (dmaFd < 0)
{
rc = -errno;
error(
"Failed to open the XDMA device for transferring remote terminus data to socket with response code '{RC}'",
"RC", rc);
return rc;
}
pldm::utils::CustomFD xdmaFd(dmaFd);
void* vgaMem;
vgaMem = mmap(nullptr, pageAlignedLength, PROT_READ, MAP_SHARED, xdmaFd(),
0);
if (MAP_FAILED == vgaMem)
{
rc = -errno;
error(
"Failed to mmap the XDMA device for transferring remote terminus data to socket with response code '{RC}'",
"RC", rc);
return rc;
}
std::unique_ptr<void, decltype(mmapCleanup)> vgaMemPtr(vgaMem, mmapCleanup);
AspeedXdmaOp xdmaOp;
xdmaOp.upstream = 0;
xdmaOp.hostAddr = address;
xdmaOp.len = length;
rc = write(xdmaFd(), &xdmaOp, sizeof(xdmaOp));
if (rc < 0)
{
rc = -errno;
error(
"Failed to execute the DMA operation for transfering remote terminus data to socket at address '{ADDRESS}' and length '{LENGTH}' with response code '{RC}'",
"RC", rc, "ADDRESS", address, "LENGTH", length);
return rc;
}
rc = writeToUnixSocket(fd, static_cast<const char*>(vgaMemPtr.get()),
length);
if (rc < 0)
{
rc = -errno;
close(fd);
error(
"Failed to write to Unix socket, closing socket for transfering remote terminus data to socket with response code '{RC}'",
"RC", rc);
return rc;
}
return 0;
}
int DMA::transferDataHost(int fd, uint32_t offset, uint32_t length,
uint64_t address, bool upstream)
{
static const size_t pageSize = getpagesize();
uint32_t numPages = length / pageSize;
uint32_t pageAlignedLength = numPages * pageSize;
if (length > pageAlignedLength)
{
pageAlignedLength += pageSize;
}
int rc = 0;
auto mmapCleanup = [pageAlignedLength, &rc](void* vgaMem) {
if (rc != -EINTR)
{
munmap(vgaMem, pageAlignedLength);
}
else
{
error(
"Received interrupt during DMA transfer for data between BMC and remote terminus. Skipping Unmap.");
}
};
int dmaFd = -1;
dmaFd = open(xdmaDev, O_RDWR);
if (dmaFd < 0)
{
rc = -errno;
error(
"Failed to open the XDMA device for data transfer between BMC and remote terminus with response code '{RC}'",
"RC", rc);
return rc;
}
pldm::utils::CustomFD xdmaFd(dmaFd);
void* vgaMem;
vgaMem = mmap(nullptr, pageAlignedLength, upstream ? PROT_WRITE : PROT_READ,
MAP_SHARED, xdmaFd(), 0);
if (MAP_FAILED == vgaMem)
{
rc = -errno;
error(
"Failed to mmap the XDMA device for data transfer between BMC and remote terminus with response code '{RC}'",
"RC", rc);
return rc;
}
std::unique_ptr<void, decltype(mmapCleanup)> vgaMemPtr(vgaMem, mmapCleanup);
if (upstream)
{
rc = lseek(fd, offset, SEEK_SET);
if (rc == -1)
{
error(
"Failed to transfer data between BMC and remote terminus due to lseek failure with upstream '{UPSTREAM}' at offset '{OFFSET}', error number - {ERROR_NUM}",
"ERROR_NUM", errno, "UPSTREAM", upstream, "OFFSET", offset);
return rc;
}
// Writing to the VGA memory should be aligned at page boundary,
// otherwise write data into a buffer aligned at page boundary and
// then write to the VGA memory.
std::vector<char> buffer{};
buffer.resize(pageAlignedLength);
rc = read(fd, buffer.data(), length);
if (rc == -1)
{
error(
"Failed to transfer data between BMC and remote terminus with file read on upstream '{UPSTREAM}' of length '{LENGTH}' at offset '{OFFSET}' failed, error number - {ERROR_NUM}",
"ERROR_NUM", errno, "UPSTREAM", upstream, "LENGTH", length,
"OFFSET", offset);
return rc;
}
if (rc != static_cast<int>(length))
{
error(
"Failed to transfer data between BMC and remote terminus mismatched for number of characters to read on upstream '{UPSTREAM}' and the length '{LENGTH}' read and count '{RC}'",
"UPSTREAM", upstream, "LENGTH", length, "RC", rc);
return -1;
}
memcpy(static_cast<char*>(vgaMemPtr.get()), buffer.data(),
pageAlignedLength);
}
AspeedXdmaOp xdmaOp;
xdmaOp.upstream = upstream ? 1 : 0;
xdmaOp.hostAddr = address;
xdmaOp.len = length;
rc = write(xdmaFd(), &xdmaOp, sizeof(xdmaOp));
if (rc < 0)
{
rc = -errno;
error(
"Failed to execute the DMA operation on data between BMC and remote terminus for upstream '{UPSTREAM}' of length '{LENGTH}' at address '{ADDRESS}', response code '{RC}'",
"RC", rc, "UPSTREAM", upstream, "ADDRESS", address, "LENGTH",
length);
return rc;
}
if (!upstream)
{
rc = lseek(fd, offset, SEEK_SET);
if (rc == -1)
{
error(
"Failed to transfer data between BMC and remote terminus due to lseek failure '{UPSTREAM}' at offset '{OFFSET}' failed, error number - {ERROR_NUM}",
"ERROR_NUM", errno, "UPSTREAM", upstream, "OFFSET", offset);
return rc;
}
rc = write(fd, static_cast<const char*>(vgaMemPtr.get()), length);
if (rc == -1)
{
error(
"Failed to transfer data between BMC and remote terminus where file write upstream '{UPSTREAM}' of length '{LENGTH}' at offset '{OFFSET}' failed, error number - {ERROR_NUM}",
"ERROR_NUM", errno, "UPSTREAM", upstream, "LENGTH", length,
"OFFSET", offset);
return rc;
}
}
return 0;
}
} // namespace dma
namespace oem_ibm
{
void encodeRWResponseHandler(uint8_t instance_id, uint8_t command,
uint8_t completion_code, uint32_t length,
struct pldm_msg* msg)
{
int rc = encode_rw_file_memory_resp(instance_id, command, completion_code,
length, msg);
if (rc != PLDM_SUCCESS)
{
error(
"Failed to encode response for command {COMMAND}, response code '{RC}'",
"COMMAND", command, "RC", rc);
}
}
void encodeReadResponseHandler(uint8_t instance_id, uint8_t completion_code,
uint32_t length, struct pldm_msg* msg)
{
int rc = encode_read_file_resp(instance_id, completion_code, length, msg);
if (rc != PLDM_SUCCESS)
{
error("Failed to encode read file response, response code '{RC}'", "RC",
rc);
}
}
void encodeWriteResponseHandler(uint8_t instance_id, uint8_t completion_code,
uint32_t length, struct pldm_msg* msg)
{
int rc = encode_write_file_resp(instance_id, completion_code, length, msg);
if (rc != PLDM_SUCCESS)
{
error("Failed to encode write file response, response code '{RC}'",
"RC", rc);
}
}
void encodeGetFileResponseHandler(uint8_t instance_id, uint8_t completion_code,
uint32_t next_transfer_handle,
uint8_t transfer_flag,
const uint8_t* table_data, size_t table_size,
struct pldm_msg* msg)
{
int rc = encode_get_file_table_resp(instance_id, completion_code,
next_transfer_handle, transfer_flag,
table_data, table_size, msg);
if (rc != PLDM_SUCCESS)
{
error("Failed to encode get file table response, response code '{RC}'",
"RC", rc);
}
}
void encodeRWTypeMemoryResponseHandler(uint8_t instance_id, uint8_t command,
uint8_t completion_code, uint32_t length,
struct pldm_msg* msg)
{
int rc = encode_rw_file_by_type_memory_resp(instance_id, command,
completion_code, length, msg);
if (rc != PLDM_SUCCESS)
{
error(
"Failed to encode read/write file by type memory response, response code '{RC}'",
"RC", rc);
}
}
void encodeRWTypeResponseHandler(uint8_t instance_id, uint8_t command,
uint8_t completion_code, uint32_t length,
struct pldm_msg* msg)
{
int rc = encode_rw_file_by_type_resp(instance_id, command, completion_code,
length, msg);
if (rc != PLDM_SUCCESS)
{
error(
"Failed to encode response for command {COMMAND}, response code '{RC}'",
"COMMAND", command, "RC", rc);
}
}
void encodeFileAckResponseHandler(uint8_t instance_id, uint8_t completion_code,
struct pldm_msg* msg)
{
int rc = encode_file_ack_resp(instance_id, completion_code, msg);
if (rc != PLDM_SUCCESS)
{
error("Failed to encode file ack response, response code '{RC}'", "RC",
rc);
}
}
Response Handler::readFileIntoMemory(const pldm_msg* request,
size_t payloadLength)
{
uint32_t fileHandle = 0;
uint32_t offset = 0;
uint32_t length = 0;
uint64_t address = 0;
Response response((sizeof(pldm_msg_hdr) + PLDM_RW_FILE_MEM_RESP_BYTES), 0);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_RW_FILE_MEM_REQ_BYTES)
{
error(
"Failed to read file into memory as payload length '{LENGTH}' not equal to '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH", PLDM_RW_FILE_MEM_REQ_BYTES);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_INTO_MEMORY,
PLDM_ERROR_INVALID_LENGTH, 0, responsePtr);
return response;
}
int responseCode = decode_rw_file_memory_req(
request, payloadLength, &fileHandle, &offset, &length, &address);
if (responseCode != PLDM_SUCCESS)
{
error(
"Failed to decode read file into memory request, response code '{RC}'",
"RC", responseCode);
}
using namespace pldm::filetable;
auto& table = buildFileTable(FILE_TABLE_JSON);
FileEntry value{};
try
{
value = table.at(fileHandle);
}
catch (const std::exception& e)
{
error(
"File handle '{HANDLE}' does not exist in the file table, error - {ERROR}",
"HANDLE", fileHandle, "ERROR", e);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_INTO_MEMORY,
PLDM_INVALID_FILE_HANDLE, 0, responsePtr);
return response;
}
if (!fs::exists(value.fsPath))
{
error("File '{PATH}' and handle '{FILE_HANDLE}' with does not exist",
"PATH", value.fsPath, "FILE_HANDLE", fileHandle);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_INTO_MEMORY,
PLDM_INVALID_FILE_HANDLE, 0, responsePtr);
return response;
}
auto fileSize = fs::file_size(value.fsPath);
if (!fileSize)
{
error(
"Failed to PLDM_READ_FILE_INTO_MEMORY from file {PATH} with size '{SIZE}'",
"PATH", value.fsPath, "SIZE", fileSize);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_INTO_MEMORY,
PLDM_DATA_OUT_OF_RANGE, 0, responsePtr);
return response;
}
if (offset >= fileSize)
{
error(
"Offset '{OFFSET}' exceeds file size '{SIZE}' and file handle '{FILE_HANDLE}'",
"OFFSET", offset, "SIZE", fileSize, "FILE_HANDLE", fileHandle);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_INTO_MEMORY,
PLDM_DATA_OUT_OF_RANGE, 0, responsePtr);
return response;
}
if (offset + length > fileSize)
{
length = fileSize - offset;
}
if (!length || length % dma::minSize)
{
error("Packet length '{LENGTH}' is non multiple of minimum DMA size",
"LENGTH", length);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_INTO_MEMORY,
PLDM_ERROR_INVALID_LENGTH, 0, responsePtr);
return response;
}
using namespace dma;
DMA intf;
return transferAll<DMA>(&intf, PLDM_READ_FILE_INTO_MEMORY, value.fsPath,
offset, length, address, true,
request->hdr.instance_id);
}
Response Handler::writeFileFromMemory(const pldm_msg* request,
size_t payloadLength)
{
uint32_t fileHandle = 0;
uint32_t offset = 0;
uint32_t length = 0;
uint64_t address = 0;
Response response(sizeof(pldm_msg_hdr) + PLDM_RW_FILE_MEM_RESP_BYTES, 0);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_RW_FILE_MEM_REQ_BYTES)
{
error(
"Failed to write file from memory as payload length '{LENGTH}' not equal to '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH", PLDM_RW_FILE_MEM_REQ_BYTES);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_FROM_MEMORY,
PLDM_ERROR_INVALID_LENGTH, 0, responsePtr);
return response;
}
int responseCode = decode_rw_file_memory_req(
request, payloadLength, &fileHandle, &offset, &length, &address);
if (responseCode != PLDM_SUCCESS)
{
error(
"Failed to decode write file from memory request, response code '{RC}'",
"RC", responseCode);
}
if (!length || length % dma::minSize)
{
error("Packet length '{LENGTH}' is non multiple of minimum DMA size",
"LENGTH", length);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_FROM_MEMORY,
PLDM_ERROR_INVALID_LENGTH, 0, responsePtr);
return response;
}
using namespace pldm::filetable;
auto& table = buildFileTable(FILE_TABLE_JSON);
FileEntry value{};
try
{
value = table.at(fileHandle);
}
catch (const std::exception& e)
{
error(
"File handle '{HANDLE}' does not exist in the file table, error - {ERROR}",
"HANDLE", fileHandle, "ERROR", e);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_FROM_MEMORY,
PLDM_INVALID_FILE_HANDLE, 0, responsePtr);
return response;
}
if (!fs::exists(value.fsPath))
{
error("File '{PATH}' does not exist for file handle '{FILE_HANDLE}'",
"PATH", value.fsPath, "FILE_HANDLE", fileHandle);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_FROM_MEMORY,
PLDM_INVALID_FILE_HANDLE, 0, responsePtr);
return response;
}
auto fileSize = fs::file_size(value.fsPath);
if (!fileSize)
{
info(
"File '{PATH}' has size '{SIZE}' for command PLDM_WRITE_FILE_FROM_MEMORY",
"PATH", value.fsPath, "SIZE", fileSize);
}
if (offset >= fileSize)
{
error(
"Offset '{OFFSET}' exceeds file size {SIZE} for file '{PATH} and handle {FILE_HANDLE}",
"OFFSET", offset, "SIZE", fileSize, "PATH", value.fsPath,
"FILE_HANDLE", fileHandle);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_FROM_MEMORY,
PLDM_DATA_OUT_OF_RANGE, 0, responsePtr);
return response;
}
using namespace dma;
DMA intf;
return transferAll<DMA>(&intf, PLDM_WRITE_FILE_FROM_MEMORY, value.fsPath,
offset, length, address, false,
request->hdr.instance_id);
}
Response Handler::getFileTable(const pldm_msg* request, size_t payloadLength)
{
uint32_t transferHandle = 0;
uint8_t transferFlag = 0;
uint8_t tableType = 0;
Response response(sizeof(pldm_msg_hdr) +
PLDM_GET_FILE_TABLE_MIN_RESP_BYTES);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_GET_FILE_TABLE_REQ_BYTES)
{
error(
"Failed to get file table as payload length '{LENGTH}' not equal to required length '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH",
PLDM_GET_FILE_TABLE_REQ_BYTES);
encodeGetFileResponseHandler(request->hdr.instance_id,
PLDM_ERROR_INVALID_LENGTH, 0, 0, nullptr,
0, responsePtr);
return response;
}
auto rc = decode_get_file_table_req(request, payloadLength, &transferHandle,
&transferFlag, &tableType);
if (rc)
{
error("Failed to decode get file table request, response code '{RC}'",
"RC", rc);
encodeGetFileResponseHandler(request->hdr.instance_id, rc, 0, 0,
nullptr, 0, responsePtr);
return response;
}
if (tableType != PLDM_FILE_ATTRIBUTE_TABLE)
{
error(
"Failed to match table type '{TYPE}' with expected table type '{REQ_TYPE}'",
"TYPE", tableType, "REQ_TYPE", PLDM_FILE_ATTRIBUTE_TABLE);
encodeGetFileResponseHandler(request->hdr.instance_id,
PLDM_INVALID_FILE_TABLE_TYPE, 0, 0,
nullptr, 0, responsePtr);
return response;
}
using namespace pldm::filetable;
auto table = buildFileTable(FILE_TABLE_JSON);
auto attrTable = table();
response.resize(response.size() + attrTable.size());
responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (attrTable.empty())
{
error("PLDM file attribute table is empty");
encodeGetFileResponseHandler(request->hdr.instance_id,
PLDM_FILE_TABLE_UNAVAILABLE, 0, 0, nullptr,
0, responsePtr);
return response;
}
encodeGetFileResponseHandler(request->hdr.instance_id, PLDM_SUCCESS, 0,
PLDM_START_AND_END, attrTable.data(),
attrTable.size(), responsePtr);
return response;
}
Response Handler::readFile(const pldm_msg* request, size_t payloadLength)
{
uint32_t fileHandle = 0;
uint32_t offset = 0;
uint32_t length = 0;
Response response(sizeof(pldm_msg_hdr) + PLDM_READ_FILE_RESP_BYTES);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_READ_FILE_REQ_BYTES)
{
error(
"Failed to read file as payload length '{LENGTH}' not equal to '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH", PLDM_READ_FILE_REQ_BYTES);
encodeReadResponseHandler(request->hdr.instance_id,
PLDM_ERROR_INVALID_LENGTH, length,
responsePtr);
return response;
}
auto rc = decode_read_file_req(request, payloadLength, &fileHandle, &offset,
&length);
if (rc)
{
error("Failed to decode read file request, response code '{RC}'", "RC",
rc);
encodeReadResponseHandler(request->hdr.instance_id, rc, 0, responsePtr);
return response;
}
using namespace pldm::filetable;
auto& table = buildFileTable(FILE_TABLE_JSON);
FileEntry value{};
try
{
value = table.at(fileHandle);
}
catch (const std::exception& e)
{
error(
"File handle '{HANDLE}' does not exist in the file table, error - {ERROR}",
"HANDLE", fileHandle, "ERROR", e);
encodeReadResponseHandler(request->hdr.instance_id,
PLDM_INVALID_FILE_HANDLE, length,
responsePtr);
return response;
}
if (!fs::exists(value.fsPath))
{
error("File '{PATH}' and handle {FILE_HANDLE} does not exist", "PATH",
value.fsPath, "FILE_HANDLE", fileHandle);
encodeReadResponseHandler(request->hdr.instance_id,
PLDM_INVALID_FILE_HANDLE, length,
responsePtr);
return response;
}
auto fileSize = fs::file_size(value.fsPath);
if (!fileSize)
{
error("Failed to read file {PATH} with size '{SIZE}'", "PATH",
value.fsPath, "SIZE", fileSize);
encodeRWResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_INTO_MEMORY,
PLDM_DATA_OUT_OF_RANGE, 0, responsePtr);
return response;
}
if (offset >= fileSize)
{
error(
"Offset '{OFFSET}' exceeds file size '{SIZE}' for file '{PATH}' and file handle '{HANDLE}'",
"OFFSET", offset, "SIZE", fileSize, "PATH", value.fsPath, "HANDLE",
fileHandle);
encodeReadResponseHandler(request->hdr.instance_id,
PLDM_DATA_OUT_OF_RANGE, length, responsePtr);
return response;
}
if (offset + length > fileSize)
{
length = fileSize - offset;
}
response.resize(response.size() + length);
responsePtr = reinterpret_cast<pldm_msg*>(response.data());
auto fileDataPos = reinterpret_cast<char*>(responsePtr);
fileDataPos += sizeof(pldm_msg_hdr) + sizeof(uint8_t) + sizeof(length);
std::ifstream stream(value.fsPath, std::ios::in | std::ios::binary);
stream.seekg(offset);
stream.read(fileDataPos, length);
encodeReadResponseHandler(request->hdr.instance_id, PLDM_SUCCESS, length,
responsePtr);
return response;
}
Response Handler::writeFile(const pldm_msg* request, size_t payloadLength)
{
uint32_t fileHandle = 0;
uint32_t offset = 0;
uint32_t length = 0;
size_t fileDataOffset = 0;
Response response(sizeof(pldm_msg_hdr) + PLDM_WRITE_FILE_RESP_BYTES);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength < PLDM_WRITE_FILE_REQ_BYTES)
{
error(
"Failed to write file as payload length '{LENGTH}' less than '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH", PLDM_WRITE_FILE_REQ_BYTES);
encodeWriteResponseHandler(request->hdr.instance_id,
PLDM_ERROR_INVALID_LENGTH, 0, responsePtr);
return response;
}
auto rc = decode_write_file_req(request, payloadLength, &fileHandle,
&offset, &length, &fileDataOffset);
if (rc)
{
error("Failed to decode write file request, response code '{RC}'", "RC",
rc);
encodeWriteResponseHandler(request->hdr.instance_id, rc, 0,
responsePtr);
return response;
}
using namespace pldm::filetable;
auto& table = buildFileTable(FILE_TABLE_JSON);
FileEntry value{};
try
{
value = table.at(fileHandle);
}
catch (const std::exception& e)
{
error(
"File handle '{HANDLE}' does not exist in the file table, error - {ERROR}",
"HANDLE", fileHandle, "ERROR", e);
encodeWriteResponseHandler(request->hdr.instance_id,
PLDM_INVALID_FILE_HANDLE, 0, responsePtr);
return response;
}
if (!fs::exists(value.fsPath))
{
error("File '{PATH}' and handle {FILE_HANDLE} does not exist", "PATH",
value.fsPath, "FILE_HANDLE", fileHandle);
encodeWriteResponseHandler(request->hdr.instance_id,
PLDM_INVALID_FILE_HANDLE, 0, responsePtr);
return response;
}
auto fileSize = fs::file_size(value.fsPath);
if (!fileSize)
{
info("File {PATH} has size '{SIZE}' for write file command", "PATH",
value.fsPath, "SIZE", fileSize);
}
if (offset >= fileSize)
{
error(
"Offset '{OFFSET}' exceeds file size '{SIZE}' for file '{PATH}' and handle {FILE_HANDLE}",
"OFFSET", offset, "SIZE", fileSize, "PATH", value.fsPath,
"FILE_HANDLE", fileHandle);
encodeWriteResponseHandler(request->hdr.instance_id,
PLDM_DATA_OUT_OF_RANGE, 0, responsePtr);
return response;
}
auto fileDataPos = reinterpret_cast<const char*>(request->payload) +
fileDataOffset;
std::ofstream stream(value.fsPath,
std::ios::in | std::ios::out | std::ios::binary);
stream.seekp(offset);
stream.write(fileDataPos, length);
encodeWriteResponseHandler(request->hdr.instance_id, PLDM_SUCCESS, length,
responsePtr);
return response;
}
Response rwFileByTypeIntoMemory(uint8_t cmd, const pldm_msg* request,
size_t payloadLength,
oem_platform::Handler* oemPlatformHandler)
{
Response response(
sizeof(pldm_msg_hdr) + PLDM_RW_FILE_BY_TYPE_MEM_RESP_BYTES, 0);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_RW_FILE_BY_TYPE_MEM_REQ_BYTES)
{
error(
"Failed to read file into memory as payload length '{LENGTH}' not equal to '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH",
PLDM_RW_FILE_BY_TYPE_MEM_REQ_BYTES);
encodeRWTypeMemoryResponseHandler(request->hdr.instance_id, cmd,
PLDM_ERROR_INVALID_LENGTH, 0,
responsePtr);
return response;
}
uint16_t fileType{};
uint32_t fileHandle{};
uint32_t offset{};
uint32_t length{};
uint64_t address{};
auto rc = decode_rw_file_by_type_memory_req(request, payloadLength,
&fileType, &fileHandle, &offset,
&length, &address);
if (rc != PLDM_SUCCESS)
{
error(
"Failed to decode read/write file by type memory request, response code '{RC}'",
"RC", rc);
encodeRWTypeMemoryResponseHandler(request->hdr.instance_id, cmd, rc, 0,
responsePtr);
return response;
}
if (!length || length % dma::minSize)
{
error(
"Packet length '{LENGTH}' is non multiple of minimum DMA size for command {CMD}",
"LENGTH", length, "CMD", cmd);
encodeRWTypeMemoryResponseHandler(request->hdr.instance_id, cmd,
PLDM_ERROR_INVALID_LENGTH, 0,
responsePtr);
return response;
}
std::unique_ptr<FileHandler> handler{};
try
{
handler = getHandlerByType(fileType, fileHandle);
}
catch (const InternalFailure& e)
{
error("Unknown file type '{TYPE}', error - {ERROR} ", "TYPE", fileType,
"ERROR", e);
encodeRWTypeMemoryResponseHandler(request->hdr.instance_id, cmd,
PLDM_INVALID_FILE_TYPE, 0,
responsePtr);
return response;
}
rc = cmd == PLDM_WRITE_FILE_BY_TYPE_FROM_MEMORY
? handler->writeFromMemory(offset, length, address,
oemPlatformHandler)
: handler->readIntoMemory(offset, length, address,
oemPlatformHandler);
encodeRWTypeMemoryResponseHandler(request->hdr.instance_id, cmd, rc, length,
responsePtr);
return response;
}
Response Handler::writeFileByTypeFromMemory(const pldm_msg* request,
size_t payloadLength)
{
return rwFileByTypeIntoMemory(PLDM_WRITE_FILE_BY_TYPE_FROM_MEMORY, request,
payloadLength, oemPlatformHandler);
}
Response Handler::readFileByTypeIntoMemory(const pldm_msg* request,
size_t payloadLength)
{
return rwFileByTypeIntoMemory(PLDM_READ_FILE_BY_TYPE_INTO_MEMORY, request,
payloadLength, oemPlatformHandler);
}
Response Handler::writeFileByType(const pldm_msg* request, size_t payloadLength)
{
Response response(sizeof(pldm_msg_hdr) + PLDM_RW_FILE_BY_TYPE_RESP_BYTES);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength < PLDM_RW_FILE_BY_TYPE_REQ_BYTES)
{
error(
"Failed to write file by type as payload length '{LENGTH}' less than '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH",
PLDM_RW_FILE_BY_TYPE_REQ_BYTES);
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_BY_TYPE,
PLDM_ERROR_INVALID_LENGTH, 0, responsePtr);
return response;
}
uint16_t fileType{};
uint32_t fileHandle{};
uint32_t offset{};
uint32_t length{};
auto rc = decode_rw_file_by_type_req(request, payloadLength, &fileType,
&fileHandle, &offset, &length);
if (rc != PLDM_SUCCESS)
{
error("Failed decoded write file by type request, response code '{RC}'",
"RC", rc);
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_BY_TYPE, rc, 0,
responsePtr);
return response;
}
std::unique_ptr<FileHandler> handler{};
try
{
handler = getHandlerByType(fileType, fileHandle);
}
catch (const InternalFailure& e)
{
error("Unknown file type '{TYPE}', error - {ERROR}", "TYPE", fileType,
"ERROR", e);
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_BY_TYPE,
PLDM_INVALID_FILE_TYPE, 0, responsePtr);
return response;
}
rc = handler->write(reinterpret_cast<const char*>(
request->payload + PLDM_RW_FILE_BY_TYPE_REQ_BYTES),
offset, length, oemPlatformHandler);
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_WRITE_FILE_BY_TYPE, rc, length,
responsePtr);
return response;
}
Response Handler::readFileByType(const pldm_msg* request, size_t payloadLength)
{
Response response(sizeof(pldm_msg_hdr) + PLDM_RW_FILE_BY_TYPE_RESP_BYTES);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_RW_FILE_BY_TYPE_REQ_BYTES)
{
error(
"Failed to read file by type as payload length '{LENGTH}' less than '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH",
PLDM_RW_FILE_BY_TYPE_REQ_BYTES);
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_BY_TYPE,
PLDM_ERROR_INVALID_LENGTH, 0, responsePtr);
return response;
}
uint16_t fileType{};
uint32_t fileHandle{};
uint32_t offset{};
uint32_t length{};
auto rc = decode_rw_file_by_type_req(request, payloadLength, &fileType,
&fileHandle, &offset, &length);
if (rc != PLDM_SUCCESS)
{
error(
"Failed to decode read file by type request, response code '{RC}'",
"RC", rc);
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_BY_TYPE, rc, 0, responsePtr);
return response;
}
std::unique_ptr<FileHandler> handler{};
try
{
handler = getHandlerByType(fileType, fileHandle);
}
catch (const InternalFailure& e)
{
error("Unknown file type '{TYPE}', error - {ERROR}", "TYPE", fileType,
"ERROR", e);
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_BY_TYPE,
PLDM_INVALID_FILE_TYPE, 0, responsePtr);
return response;
}
rc = handler->read(offset, length, response, oemPlatformHandler);
responsePtr = reinterpret_cast<pldm_msg*>(response.data());
encodeRWTypeResponseHandler(request->hdr.instance_id,
PLDM_READ_FILE_BY_TYPE, rc, length,
responsePtr);
return response;
}
Response Handler::fileAck(const pldm_msg* request, size_t payloadLength)
{
Response response(sizeof(pldm_msg_hdr) + PLDM_FILE_ACK_RESP_BYTES);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_FILE_ACK_REQ_BYTES)
{
error(
"Failed to do file ack as payload length '{LENGTH}' is less than '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH", PLDM_FILE_ACK_REQ_BYTES);
encodeFileAckResponseHandler(request->hdr.instance_id,
PLDM_ERROR_INVALID_LENGTH, responsePtr);
return response;
}
uint16_t fileType{};
uint32_t fileHandle{};
uint8_t fileStatus{};
auto rc = decode_file_ack_req(request, payloadLength, &fileType,
&fileHandle, &fileStatus);
if (rc != PLDM_SUCCESS)
{
encodeFileAckResponseHandler(request->hdr.instance_id, rc, responsePtr);
return response;
}
std::unique_ptr<FileHandler> handler{};
try
{
handler = getHandlerByType(fileType, fileHandle);
}
catch (const InternalFailure& e)
{
error("Unknown file type '{TYPE}', error - {ERROR}", "TYPE", fileType,
"ERROR", e);
encodeFileAckResponseHandler(request->hdr.instance_id,
PLDM_INVALID_FILE_TYPE, responsePtr);
return response;
}
rc = handler->fileAck(fileStatus);
encodeFileAckResponseHandler(request->hdr.instance_id, rc, responsePtr);
return response;
}
Response Handler::getAlertStatus(const pldm_msg* request, size_t payloadLength)
{
Response response(sizeof(pldm_msg_hdr) + PLDM_GET_ALERT_STATUS_RESP_BYTES);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
if (payloadLength != PLDM_GET_ALERT_STATUS_REQ_BYTES)
{
error(
"Failed to get alert status as payload length '{LENGTH}' is less than '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH",
PLDM_GET_ALERT_STATUS_REQ_BYTES);
return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
}
uint8_t versionId{};
auto rc = decode_get_alert_status_req(request, payloadLength, &versionId);
if (rc != PLDM_SUCCESS)
{
error("Failed to decode get alert status request, response code '{RC}'",
"RC", rc);
return CmdHandler::ccOnlyResponse(request, rc);
}
if (versionId != 0)
{
error(
"Failed to get alert status due to unsupported version ID '{VERSION}'",
"VERSION", versionId);
return CmdHandler::ccOnlyResponse(request,
PLDM_HOST_UNSUPPORTED_FORMAT_VERSION);
}
constexpr uint32_t rackEntry = 0xFF000030;
constexpr uint32_t priCecNode = 0x00008030;
rc = encode_get_alert_status_resp(request->hdr.instance_id, PLDM_SUCCESS,
rackEntry, priCecNode, responsePtr,
PLDM_GET_ALERT_STATUS_RESP_BYTES);
if (rc != PLDM_SUCCESS)
{
error(
"Failed to encode get alert status response, response code '{RC}'",
"RC", rc);
return CmdHandler::ccOnlyResponse(request, rc);
}
return response;
}
Response Handler::newFileAvailable(const pldm_msg* request,
size_t payloadLength)
{
Response response(sizeof(pldm_msg_hdr) + PLDM_NEW_FILE_RESP_BYTES);
if (payloadLength != PLDM_NEW_FILE_REQ_BYTES)
{
error(
"Failed new file available as payload length '{LENGTH}' is less than '{REQ_LENGTH}'",
"LENGTH", payloadLength, "REQ_LENGTH", PLDM_NEW_FILE_REQ_BYTES);
return CmdHandler::ccOnlyResponse(request, PLDM_ERROR_INVALID_LENGTH);
}
uint16_t fileType{};
uint32_t fileHandle{};
uint64_t length{};
auto rc = decode_new_file_req(request, payloadLength, &fileType,
&fileHandle, &length);
if (rc != PLDM_SUCCESS)
{
error("Failed to decode new file request, response code '{RC}'", "RC",
rc);
return CmdHandler::ccOnlyResponse(request, rc);
}
std::unique_ptr<FileHandler> handler{};
try
{
handler = getHandlerByType(fileType, fileHandle);
}
catch (const InternalFailure& e)
{
error("Unknown file type '{TYPE}', error - {ERROR}", "TYPE", fileType,
"ERROR", e);
return CmdHandler::ccOnlyResponse(request, PLDM_INVALID_FILE_TYPE);
}
rc = handler->newFileAvailable(length);
auto responsePtr = reinterpret_cast<pldm_msg*>(response.data());
int responseCode = encode_new_file_resp(request->hdr.instance_id, rc,
responsePtr);
if (responseCode != PLDM_SUCCESS)
{
error(
"Failed to encode new file available response, response code '{RC}'",
"RC", responseCode);
}
return response;
}
} // namespace oem_ibm
} // namespace responder
} // namespace pldm