blob: 730e75b6eeb07530387ba698b0f981885742e230 [file] [log] [blame]
Andrew Jeffery4fe996c2018-02-27 12:16:48 +10301/* SPDX-License-Identifier: Apache-2.0 */
2/* Copyright (C) 2018 IBM Corp. */
Deepak Kodihalli393821d2017-04-28 04:44:38 -05003#pragma once
4
5#include <vector>
6#include <memory>
7#include <numeric>
8#include <experimental/filesystem>
Andrew Jeffery7f9c3432018-03-01 12:07:13 +10309#include "common.h"
Deepak Kodihalli393821d2017-04-28 04:44:38 -050010#include "pnor_partition_defs.h"
11
12namespace openpower
13{
14namespace virtual_pnor
15{
16
17namespace fs = std::experimental::filesystem;
18
19using PartitionTable = std::vector<uint8_t>;
20using checksum_t = uint32_t;
21
22/** @brief Convert the input partition table to big endian.
23 *
24 * @param[in] src - reference to the pnor partition table
25 *
26 * @returns converted partition table
27 */
28PartitionTable endianFixup(const PartitionTable& src);
29
Andrew Jefferyd394a782018-02-21 16:16:14 +103030/** @brief Parse a ToC line (entry) into the corresponding FFS partition
31 * object.
32 *
33 * @param[in] line - The ToC line to parse
34 * @param[in] blockSize - The flash block size in bytes
35 * @param[out] part - The partition object to populate with the information
36 * parsed from the provided ToC line
37 *
Andrew Jefferyf96bd162018-02-26 13:05:00 +103038 * Throws: MalformedTocEntry, InvalidTocEntry
Andrew Jefferyd394a782018-02-21 16:16:14 +103039 */
Andrew Jefferyf96bd162018-02-26 13:05:00 +103040void parseTocLine(const std::string& line, size_t blockSize,
Andrew Jefferyd394a782018-02-21 16:16:14 +103041 pnor_partition& part);
42
Deepak Kodihalli393821d2017-04-28 04:44:38 -050043namespace details
44{
45
46/** @brief Compute XOR-based checksum, by XORing consecutive words
47 * in the input data. Input must be aligned to word boundary.
48 *
49 * @param[in] data - input data on which checksum is computed
50 *
51 * @returns computed checksum
52 */
Andrew Jefferyf34db312018-03-09 15:27:03 +103053template <class T> checksum_t checksum(const T& data)
Deepak Kodihalli393821d2017-04-28 04:44:38 -050054{
55 static_assert(sizeof(decltype(data)) % sizeof(checksum_t) == 0,
56 "sizeof(data) is not aligned to sizeof(checksum_t) boundary");
57
58 auto begin = reinterpret_cast<const checksum_t*>(&data);
59 auto end = begin + (sizeof(decltype(data)) / sizeof(checksum_t));
60
61 return std::accumulate(begin, end, 0, std::bit_xor<checksum_t>());
62}
63
64} // namespace details
65
66namespace partition
67{
68
69/** @class Table
70 * @brief Generates virtual PNOR partition table.
71 *
72 * Generates virtual PNOR partition table upon construction. Reads
73 * the PNOR information generated by this tool :
74 * github.com/openbmc/openpower-pnor-code-mgmt/blob/master/generate-squashfs,
75 * which generates a minimalistic table-of-contents (toc) file and
76 * individual files to represent various partitions that are of interest -
77 * these help form the "virtual" PNOR, which is typically a subset of the full
78 * PNOR image.
79 * These files are stored in a well-known location on the PNOR.
80 * Based on this information, this class prepares the partition table whose
81 * structure is as outlined in pnor_partition.h.
82 *
83 * The virtual PNOR supports 4KB erase blocks - partitions must be aligned to
84 * this size.
85 */
86class Table
87{
Andrew Jefferyf34db312018-03-09 15:27:03 +103088 public:
89 /** @brief Constructor accepting the path of the directory
90 * that houses the PNOR partition files.
91 *
92 * @param[in] directory - path of the directory housing PNOR partitions
93 * @param[in] blockSize - PNOR block size, in bytes. See
94 * open-power/hostboot/blob/master/src/usr/pnor/ffs.h for
95 * the PNOR FFS structure.
96 * @param[in] pnorSize - PNOR size, in bytes
Andrew Jefferyf96bd162018-02-26 13:05:00 +103097 *
98 * Throws MalformedTocEntry, InvalidTocEntry
Andrew Jefferyf34db312018-03-09 15:27:03 +103099 */
100 Table(fs::path&& directory, size_t blockSize, size_t pnorSize);
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500101
Andrew Jefferyf34db312018-03-09 15:27:03 +1030102 Table(const Table&) = delete;
103 Table& operator=(const Table&) = delete;
104 Table(Table&&) = delete;
105 Table& operator=(Table&&) = delete;
106 ~Table() = default;
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500107
Andrew Jeffery7f9c3432018-03-01 12:07:13 +1030108 /** @brief Return the exact size of partition table in bytes
Andrew Jefferyf34db312018-03-09 15:27:03 +1030109 *
Andrew Jeffery7f9c3432018-03-01 12:07:13 +1030110 * @returns size_t - size of partition table in bytes
Andrew Jefferyf34db312018-03-09 15:27:03 +1030111 */
112 size_t size() const
113 {
Andrew Jeffery7f9c3432018-03-01 12:07:13 +1030114 return szBytes;
115 }
116
117 /** @brief Return aligned size of partition table in bytes
118 *
119 * The value returned will be greater-than or equal to size(), and
120 * aligned to blockSize.
121 *
122 * @returns size_t - capacity of partition table in bytes
123 */
124 size_t capacity() const
125 {
126 return align_up(szBytes, blockSize);
127 }
128
129 /** @brief Return the size of partition table in blocks
130 *
131 * @returns size_t - size of partition table in blocks
132 */
133 size_t blocks() const
134 {
135 return capacity() / blockSize;
Andrew Jefferyf34db312018-03-09 15:27:03 +1030136 }
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500137
Andrew Jefferyf34db312018-03-09 15:27:03 +1030138 /** @brief Return a partition table having byte-ordering
139 * that the host expects.
140 *
141 * The host needs the partion table in big-endian.
142 *
143 * @returns const reference to host partition table.
144 */
145 const pnor_partition_table& getHostTable() const
146 {
147 return *(reinterpret_cast<const pnor_partition_table*>(hostTbl.data()));
148 }
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500149
Andrew Jefferyf34db312018-03-09 15:27:03 +1030150 /** @brief Return a little-endian partition table
151 *
152 * @returns const reference to native partition table
153 */
154 const pnor_partition_table& getNativeTable() const
155 {
156 return *(reinterpret_cast<const pnor_partition_table*>(tbl.data()));
157 }
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500158
Andrew Jefferyf34db312018-03-09 15:27:03 +1030159 /** @brief Return partition corresponding to PNOR offset, the offset
160 * is within returned partition.
161 *
162 * @param[in] offset - PNOR offset in bytes
163 *
164 * @returns const reference to pnor_partition, if found, else an
165 * exception will be thrown.
166 */
167 const pnor_partition& partition(size_t offset) const;
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500168
Andrew Jefferyf34db312018-03-09 15:27:03 +1030169 /** @brief Return partition corresponding to input partition name.
170 *
171 * @param[in] name - PNOR partition name
172 *
173 * @returns const reference to pnor_partition, if found, else an
174 * exception will be thrown.
175 */
176 const pnor_partition& partition(const std::string& name) const;
Deepak Kodihalli8a899692017-07-11 23:17:19 -0500177
Andrew Jefferyf34db312018-03-09 15:27:03 +1030178 private:
179 /** @brief Prepares a vector of PNOR partition structures.
Andrew Jefferyf96bd162018-02-26 13:05:00 +1030180 *
181 * Throws: MalformedTocEntry, InvalidTocEntry
Andrew Jefferyf34db312018-03-09 15:27:03 +1030182 */
183 void preparePartitions();
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500184
Andrew Jefferyf34db312018-03-09 15:27:03 +1030185 /** @brief Prepares the PNOR header.
186 */
187 void prepareHeader();
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500188
Andrew Jefferyf34db312018-03-09 15:27:03 +1030189 /** @brief Allocate memory to hold the partion table. Determine the
190 * amount needed based on the partition files in the toc file.
191 *
192 * @param[in] tocFile - Table of contents file path.
193 */
194 void allocateMemory(const fs::path& tocFile);
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500195
Andrew Jefferyf34db312018-03-09 15:27:03 +1030196 /** @brief Return a little-endian partition table
197 *
198 * @returns reference to native partition table
199 */
200 pnor_partition_table& getNativeTable()
201 {
202 return *(reinterpret_cast<pnor_partition_table*>(tbl.data()));
203 }
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500204
Andrew Jefferyf34db312018-03-09 15:27:03 +1030205 /** @brief Size of the PNOR partition table -
206 * sizeof(pnor_partition_table) +
207 * (no. of partitions * sizeof(pnor_partition)),
Andrew Jefferyf34db312018-03-09 15:27:03 +1030208 */
Andrew Jeffery7f9c3432018-03-01 12:07:13 +1030209 size_t szBytes;
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500210
Andrew Jefferyf34db312018-03-09 15:27:03 +1030211 /** @brief Partition table */
212 PartitionTable tbl;
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500213
Andrew Jefferyf34db312018-03-09 15:27:03 +1030214 /** @brief Partition table with host byte ordering */
215 PartitionTable hostTbl;
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500216
Andrew Jefferyf34db312018-03-09 15:27:03 +1030217 /** @brief Directory housing generated PNOR partition files */
218 fs::path directory;
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500219
Andrew Jefferyf34db312018-03-09 15:27:03 +1030220 /** @brief Number of partitions */
221 size_t numParts;
Deepak Kodihallid1d79302017-07-11 23:01:39 -0500222
Andrew Jefferyf34db312018-03-09 15:27:03 +1030223 /** @brief PNOR block size, in bytes */
224 size_t blockSize;
Deepak Kodihallid1d79302017-07-11 23:01:39 -0500225
Andrew Jefferyf34db312018-03-09 15:27:03 +1030226 /** @brief PNOR size, in bytes */
227 size_t pnorSize;
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500228};
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500229} // namespace partition
Andrew Jefferyf96bd162018-02-26 13:05:00 +1030230
231/** @brief An exception type storing a reason string.
232 *
233 * This looks a lot like how std::runtime_error might be implemented however
234 * we want to avoid extending it, as exceptions extending ReasonedError have
235 * an expectation of being handled (can be predicted and are inside the scope
236 * of the program).
237 *
238 * From std::runtime_error documentation[1]:
239 *
240 * > Defines a type of object to be thrown as exception. It reports errors
241 * > that are due to events beyond the scope of the program and can not be
242 * > easily predicted.
243 *
244 * [1] http://en.cppreference.com/w/cpp/error/runtime_error
245 *
246 * We need to keep the inheritance hierarchy separate: This avoids the
247 * introduction of code that overzealously catches std::runtime_error to
248 * handle exceptions that would otherwise derive ReasonedError, and in the
249 * process swallows genuine runtime failures.
250 */
251class ReasonedError : public std::exception
252{
253 public:
254 ReasonedError(const std::string&& what) : _what(what)
255 {
256 }
257 const char* what() const noexcept
258 {
259 return _what.c_str();
260 };
261
262 private:
263 const std::string _what;
264};
265
266/** @brief Base exception type for errors related to ToC entry parsing.
267 *
268 * Callers of parseTocEntry() may not be concerned with the specifics and
269 * rather just want to extract and log what().
270 */
271class TocEntryError : public ReasonedError
272{
273 public:
274 TocEntryError(const std::string&& reason) : ReasonedError(std::move(reason))
275 {
276 }
277};
278
279/** @brief The exception thrown on finding a syntax error in the ToC entry
280 *
281 * If the syntax is wrong, or expected values are missing, the ToC entry is
282 * malformed
283 */
284class MalformedTocEntry : public TocEntryError
285{
286 public:
287 MalformedTocEntry(const std::string&& reason) :
288 TocEntryError(std::move(reason))
289 {
290 }
291};
292
293/** @brief The exception thrown on finding a semantic error in the ToC entry
294 *
295 * If the syntax of the ToC entry is correct but the semantics are broken,
296 * then we have an invalid ToC entry.
297 */
298class InvalidTocEntry : public TocEntryError
299{
300 public:
301 InvalidTocEntry(const std::string&& reason) :
302 TocEntryError(std::move(reason))
303 {
304 }
305};
306
Deepak Kodihalli393821d2017-04-28 04:44:38 -0500307} // namespace virtual_pnor
308} // namespace openpower
Andrew Jeffery2ceba892018-02-28 17:44:54 +1030309
310struct vpnor_partition_table
311{
312 openpower::virtual_pnor::partition::Table* table;
313};