blob: 4547d6438882ec4d4e732c45262873dea1f232a5 [file] [log] [blame]
Andrew Jeffery4fe996c2018-02-27 12:16:48 +10301// SPDX-License-Identifier: Apache-2.0
2// Copyright (C) 2018 IBM Corp.
Andrew Jeffery71eaa732018-08-08 16:44:24 +09303extern "C" {
Evan Lojewskif1e547c2019-03-14 14:34:33 +10304#include "mboxd.h"
Andrew Jeffery71eaa732018-08-08 16:44:24 +09305}
6
William A. Kennington IIId5f1d402018-10-11 13:55:04 -07007#include "config.h"
8
Andrew Jefferyfb01e142019-03-18 13:17:08 +10309#include "vpnor/partition.hpp"
Andrew Jefferyde08ca22019-03-18 13:23:46 +103010#include "vpnor/table.hpp"
Ratan Guptac0ef9872017-06-06 14:31:37 +053011#include "xyz/openbmc_project/Common/error.hpp"
Ratan Guptac0ef9872017-06-06 14:31:37 +053012
Andrew Jefferyad343102018-02-28 00:35:50 +103013#include <assert.h>
Andrew Jeffery1a3f8432018-03-02 10:18:02 +103014#include <fcntl.h>
Ratan Guptac0ef9872017-06-06 14:31:37 +053015#include <stdint.h>
16#include <stdlib.h>
Ratan Guptac0ef9872017-06-06 14:31:37 +053017#include <sys/ioctl.h>
18#include <sys/mman.h>
William A. Kennington IIId5f1d402018-10-11 13:55:04 -070019#include <sys/types.h>
20#include <syslog.h>
Andrew Jeffery1a3f8432018-03-02 10:18:02 +103021#include <unistd.h>
Ratan Guptac0ef9872017-06-06 14:31:37 +053022
Ratan Guptac0ef9872017-06-06 14:31:37 +053023#include <exception>
Ratan Guptac0ef9872017-06-06 14:31:37 +053024#include <iostream>
William A. Kennington IIId5f1d402018-10-11 13:55:04 -070025#include <phosphor-logging/elog-errors.hpp>
26#include <phosphor-logging/log.hpp>
27#include <stdexcept>
28#include <string>
29
30#include "common.h"
Andrew Jefferyf4bc3352019-03-18 12:09:48 +103031#include "vpnor/backend.h"
Ratan Guptac0ef9872017-06-06 14:31:37 +053032
33namespace openpower
34{
35namespace virtual_pnor
36{
37
Andrew Jefferyad343102018-02-28 00:35:50 +103038namespace fs = std::experimental::filesystem;
Ratan Guptac0ef9872017-06-06 14:31:37 +053039
Andrew Jefferyad343102018-02-28 00:35:50 +103040fs::path Request::getPartitionFilePath(int flags)
Ratan Guptac0ef9872017-06-06 14:31:37 +053041{
Evan Lojewskif1e547c2019-03-14 14:34:33 +103042 struct vpnor_data* priv = (struct vpnor_data*)backend->priv;
43
Adriana Kobylakc71dfd72017-07-22 11:10:43 -050044 // Check if partition exists in patch location
Evan Lojewskif1e547c2019-03-14 14:34:33 +103045 auto dst = fs::path(priv->paths.patch_loc) / partition.data.name;
Andrew Jefferyad343102018-02-28 00:35:50 +103046 if (fs::is_regular_file(dst))
Adriana Kobylakc71dfd72017-07-22 11:10:43 -050047 {
Andrew Jefferyad343102018-02-28 00:35:50 +103048 return dst;
Adriana Kobylakc71dfd72017-07-22 11:10:43 -050049 }
50
Andrew Jefferyad343102018-02-28 00:35:50 +103051 switch (partition.data.user.data[1] &
Ratan Guptac0ef9872017-06-06 14:31:37 +053052 (PARTITION_PRESERVED | PARTITION_READONLY))
53 {
54 case PARTITION_PRESERVED:
Evan Lojewskif1e547c2019-03-14 14:34:33 +103055 dst = priv->paths.prsv_loc;
Ratan Guptac0ef9872017-06-06 14:31:37 +053056 break;
57
58 case PARTITION_READONLY:
Evan Lojewskif1e547c2019-03-14 14:34:33 +103059 dst = priv->paths.ro_loc;
Ratan Guptac0ef9872017-06-06 14:31:37 +053060 break;
61
62 default:
Evan Lojewskif1e547c2019-03-14 14:34:33 +103063 dst = priv->paths.rw_loc;
Ratan Guptac0ef9872017-06-06 14:31:37 +053064 }
Andrew Jefferyad343102018-02-28 00:35:50 +103065 dst /= partition.data.name;
Ratan Guptac0ef9872017-06-06 14:31:37 +053066
Andrew Jefferyad343102018-02-28 00:35:50 +103067 if (fs::exists(dst))
Ratan Guptac0ef9872017-06-06 14:31:37 +053068 {
Andrew Jefferyad343102018-02-28 00:35:50 +103069 return dst;
Ratan Guptac0ef9872017-06-06 14:31:37 +053070 }
Andrew Jefferyad343102018-02-28 00:35:50 +103071
72 if (flags == O_RDONLY)
Ratan Guptac0ef9872017-06-06 14:31:37 +053073 {
Evan Lojewskif1e547c2019-03-14 14:34:33 +103074 dst = fs::path(priv->paths.ro_loc) / partition.data.name;
Andrew Jefferyad343102018-02-28 00:35:50 +103075 assert(fs::exists(dst));
76 return dst;
Ratan Guptac0ef9872017-06-06 14:31:37 +053077 }
78
Andrew Jefferyad343102018-02-28 00:35:50 +103079 assert(flags == O_RDWR);
Evan Lojewskif1e547c2019-03-14 14:34:33 +103080 auto src = fs::path(priv->paths.ro_loc) / partition.data.name;
Andrew Jefferyad343102018-02-28 00:35:50 +103081 assert(fs::exists(src));
Ratan Guptac0ef9872017-06-06 14:31:37 +053082
Andrew Jefferye8a79ff2018-02-27 10:56:32 +103083 MSG_DBG("RWRequest: Didn't find '%s' under '%s', copying from '%s'\n",
Andrew Jefferyad343102018-02-28 00:35:50 +103084 partition.data.name, dst.c_str(), src.c_str());
Andrew Jefferye8a79ff2018-02-27 10:56:32 +103085
Evan Lojewskif1e547c2019-03-14 14:34:33 +103086 dst = priv->paths.rw_loc;
Andrew Jefferyad343102018-02-28 00:35:50 +103087 if (partition.data.user.data[1] & PARTITION_PRESERVED)
Ratan Guptac0ef9872017-06-06 14:31:37 +053088 {
Evan Lojewskif1e547c2019-03-14 14:34:33 +103089 dst = priv->paths.prsv_loc;
Ratan Guptac0ef9872017-06-06 14:31:37 +053090 }
91
Andrew Jefferyad343102018-02-28 00:35:50 +103092 dst /= partition.data.name;
93 fs::copy_file(src, dst);
Adriana Kobylak0acc6692019-10-09 13:05:34 -050094 fs::permissions(dst, fs::perms::add_perms | fs::perms::owner_write);
Ratan Guptac0ef9872017-06-06 14:31:37 +053095
Andrew Jefferyad343102018-02-28 00:35:50 +103096 return dst;
97}
98
Andrew Jeffery1a3f8432018-03-02 10:18:02 +103099size_t Request::clamp(size_t len)
100{
101 size_t maxAccess = offset + len;
Evan Lojewskif1e547c2019-03-14 14:34:33 +1030102 size_t partSize = partition.data.size << backend->block_size_shift;
Andrew Jeffery1a3f8432018-03-02 10:18:02 +1030103 return std::min(maxAccess, partSize) - offset;
104}
105
Andrew Jefferye2744c02020-01-28 15:08:13 +1030106/* Perform reads and writes for an entire buffer's worth of data
107 *
108 * Post-condition: All bytes read or written, or an error has occurred
109 *
110 * Yields 0 if the entire buffer was processed, otherwise -1
111 */
112#define fd_process_all(fn, fd, src, len) \
113 ({ \
114 size_t __len = len; \
115 ssize_t __accessed = 0; \
116 do \
117 { \
118 __len -= __accessed; \
119 __accessed = TEMP_FAILURE_RETRY(fn(fd, src, __len)); \
120 } while (__len > 0 && __accessed > 0); \
121 __len ? -1 : 0; \
122 })
123
124ssize_t Request::read(void* dst, size_t len)
Andrew Jeffery1a3f8432018-03-02 10:18:02 +1030125{
Andrew Jefferye2744c02020-01-28 15:08:13 +1030126 len = clamp(len);
127
128 fs::path path = getPartitionFilePath(O_RDONLY);
129
130 MSG_INFO("Fulfilling read request against %s at offset 0x%zx into %p "
131 "for %zu\n",
132 path.c_str(), offset, dst, len);
133
Andrew Jeffery1a3f8432018-03-02 10:18:02 +1030134 size_t fileSize = fs::file_size(path);
Andrew Jeffery1a3f8432018-03-02 10:18:02 +1030135
Andrew Jefferye2744c02020-01-28 15:08:13 +1030136 int fd = ::open(path.c_str(), O_RDONLY);
Andrew Jefferyad343102018-02-28 00:35:50 +1030137 if (fd == -1)
138 {
Andrew Jeffery974507e2018-04-30 15:33:55 +0930139 MSG_ERR("Failed to open backing file at '%s': %d\n", path.c_str(),
140 errno);
Andrew Jefferyad343102018-02-28 00:35:50 +1030141 throw std::system_error(errno, std::system_category());
142 }
143
Andrew Jefferye2744c02020-01-28 15:08:13 +1030144 int rc = lseek(fd, offset, SEEK_SET);
145 if (rc < 0)
Andrew Jefferycc650612018-08-30 12:17:59 +0930146 {
Andrew Jefferye2744c02020-01-28 15:08:13 +1030147 MSG_ERR("Failed to seek to %zu in %s (%zu bytes): %d\n", offset,
Andrew Jeffery1a3f8432018-03-02 10:18:02 +1030148 path.c_str(), fileSize, errno);
Andrew Jefferyad343102018-02-28 00:35:50 +1030149 throw std::system_error(errno, std::system_category());
150 }
151
Andrew Jefferye2744c02020-01-28 15:08:13 +1030152 auto access_len = std::min(len, fileSize - offset);
153 rc = fd_process_all(::read, fd, dst, access_len);
154 if (rc < 0)
Andrew Jefferyad343102018-02-28 00:35:50 +1030155 {
Andrew Jefferye2744c02020-01-28 15:08:13 +1030156 MSG_ERR("Requested %zu bytes but failed to read %zu from %s (%zu) at "
157 "%zu: %d\n",
158 len, access_len, path.c_str(), fileSize, offset, errno);
159 throw std::system_error(errno, std::system_category());
Andrew Jefferyad343102018-02-28 00:35:50 +1030160 }
Andrew Jefferye2744c02020-01-28 15:08:13 +1030161
162 /* Set any remaining buffer space to the erased state */
163 memset((char*)dst + access_len, 0xff, len - access_len);
164
165 close(fd);
166
167 return len;
168}
169
170ssize_t Request::write(void* dst, size_t len)
171{
172 if (len != clamp(len))
Andrew Jefferyad343102018-02-28 00:35:50 +1030173 {
Andrew Jefferye2744c02020-01-28 15:08:13 +1030174 std::stringstream err;
175 err << "Request size 0x" << std::hex << len << " from offset 0x"
176 << std::hex << offset << " exceeds the partition size 0x"
177 << std::hex << (partition.data.size << backend->block_size_shift);
178 throw OutOfBoundsOffset(err.str());
Andrew Jefferyad343102018-02-28 00:35:50 +1030179 }
Andrew Jefferye2744c02020-01-28 15:08:13 +1030180
181 /* Ensure file is at least the size of the maximum access */
182 fs::path path = getPartitionFilePath(O_RDWR);
183
184 MSG_INFO("Fulfilling write request against %s at offset 0x%zx from %p "
185 "for %zu\n",
186 path.c_str(), offset, dst, len);
187
188 int fd = ::open(path.c_str(), O_RDWR);
189 if (fd == -1)
190 {
191 MSG_ERR("Failed to open backing file at '%s': %d\n", path.c_str(),
192 errno);
193 throw std::system_error(errno, std::system_category());
194 }
195
196 int rc = lseek(fd, offset, SEEK_SET);
197 if (rc < 0)
198 {
199 MSG_ERR("Failed to seek to %zu in %s: %d\n", offset, path.c_str(),
200 errno);
201 throw std::system_error(errno, std::system_category());
202 }
203
204 rc = fd_process_all(::write, fd, dst, len);
205 if (rc < 0)
206 {
207 MSG_ERR("Failed to write %zu bytes to %s at %zu: %d\n", len,
208 path.c_str(), offset, errno);
209 throw std::system_error(errno, std::system_category());
210 }
211 backend_set_bytemap(backend, base + offset, len, FLASH_DIRTY);
212
Andrew Jefferyad343102018-02-28 00:35:50 +1030213 close(fd);
214
215 return len;
Ratan Guptac0ef9872017-06-06 14:31:37 +0530216}
217
Andrew Jefferyf34db312018-03-09 15:27:03 +1030218} // namespace virtual_pnor
219} // namespace openpower