1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
#pragma once
#include <arpa/inet.h>
#include <byteswap.h>
#include <cassert>
#include <cstring>
#include <memory>
#include <string>
#include <vector>
namespace openpower
{
namespace pels
{
namespace detail
{
/**
* @brief A host-to-network implementation for uint64_t
*
* @param[in] value - the value to convert to
* @return uint64_t - the byteswapped value
*/
inline uint64_t htonll(uint64_t value)
{
return bswap_64(value);
}
/**
* @brief A network-to-host implementation for uint64_t
*
* @param[in] value - the value to convert to
* @return uint64_t - the byteswapped value
*/
inline uint64_t ntohll(uint64_t value)
{
return bswap_64(value);
}
} // namespace detail
/**
* @class Stream
*
* This class is used for getting data types into and out of a vector<uint8_t>
* that contains data in network byte (big endian) ordering.
*/
class Stream
{
public:
Stream() = delete;
~Stream() = default;
Stream(const Stream&) = default;
Stream& operator=(const Stream&) = default;
Stream(Stream&&) = default;
Stream& operator=(Stream&&) = default;
/**
* @brief Constructor
*
* @param[in] data - the vector of data
*/
explicit Stream(std::vector<uint8_t>& data) : _data(data), _offset(0)
{
}
/**
* @brief Constructor
*
* @param[in] data - the vector of data
* @param[in] offset - the starting offset
*/
Stream(std::vector<uint8_t>& data, std::size_t offset) :
_data(data), _offset(offset)
{
if (_offset >= _data.size())
{
throw std::out_of_range("Offset out of range");
}
}
/**
* @brief Extraction operator for a uint8_t
*
* @param[out] value - filled in with the value
* @return Stream&
*/
Stream& operator>>(uint8_t& value)
{
read(&value, 1);
return *this;
}
/**
* @brief Extraction operator for a char
*
* @param[out] value -filled in with the value
* @return Stream&
*/
Stream& operator>>(char& value)
{
read(&value, 1);
return *this;
}
/**
* @brief Extraction operator for a uint16_t
*
* @param[out] value -filled in with the value
* @return Stream&
*/
Stream& operator>>(uint16_t& value)
{
read(&value, 2);
value = htons(value);
return *this;
}
/**
* @brief Extraction operator for a uint32_t
*
* @param[out] value -filled in with the value
* @return Stream&
*/
Stream& operator>>(uint32_t& value)
{
read(&value, 4);
value = htonl(value);
return *this;
}
/**
* @brief Extraction operator for a uint64_t
*
* @param[out] value -filled in with the value
* @return Stream&
*/
Stream& operator>>(uint64_t& value)
{
read(&value, 8);
value = detail::htonll(value);
return *this;
}
/**
* @brief Extraction operator for a std::vector<uint8_t>
*
* The vector's size is the amount extracted.
*
* @param[out] value - filled in with the value
* @return Stream&
*/
Stream& operator>>(std::vector<uint8_t>& value)
{
if (!value.empty())
{
read(value.data(), value.size());
}
return *this;
}
/**
* @brief Extraction operator for a std::vector<char>
*
* The vector's size is the amount extracted.
*
* @param[out] value - filled in with the value
* @return Stream&
*/
Stream& operator>>(std::vector<char>& value)
{
if (!value.empty())
{
read(value.data(), value.size());
}
return *this;
}
/**
* @brief Insert operator for a uint8_t
*
* @param[in] value - the value to write to the stream
* @return Stream&
*/
Stream& operator<<(uint8_t value)
{
write(&value, 1);
return *this;
}
/**
* @brief Insert operator for a char
*
* @param[in] value - the value to write to the stream
* @return Stream&
*/
Stream& operator<<(char value)
{
write(&value, 1);
return *this;
}
/**
* @brief Insert operator for a uint16_t
*
* @param[in] value - the value to write to the stream
* @return Stream&
*/
Stream& operator<<(uint16_t value)
{
uint16_t data = ntohs(value);
write(&data, 2);
return *this;
}
/**
* @brief Insert operator for a uint32_t
*
* @param[in] value - the value to write to the stream
* @return Stream&
*/
Stream& operator<<(uint32_t value)
{
uint32_t data = ntohl(value);
write(&data, 4);
return *this;
}
/**
* @brief Insert operator for a uint64_t
*
* @param[in] value - the value to write to the stream
* @return Stream&
*/
Stream& operator<<(uint64_t value)
{
uint64_t data = detail::ntohll(value);
write(&data, 8);
return *this;
}
/**
* @brief Insert operator for a std::vector<uint8_t>
*
* The full vector is written to the stream.
*
* @param[in] value - the value to write to the stream
* @return Stream&
*/
Stream& operator<<(const std::vector<uint8_t>& value)
{
if (!value.empty())
{
write(value.data(), value.size());
}
return *this;
}
/**
* @brief Insert operator for a std::vector<char>
*
* The full vector is written to the stream.
*
* @param[in] value - the value to write to the stream
* @return Stream&
*/
Stream& operator<<(const std::vector<char>& value)
{
if (!value.empty())
{
write(value.data(), value.size());
}
return *this;
}
/**
* @brief Sets the offset of the stream
*
* @param[in] newOffset - the new offset
*/
void offset(std::size_t newOffset)
{
if (newOffset >= _data.size())
{
throw std::out_of_range("new offset out of range");
}
_offset = newOffset;
}
/**
* @brief Returns the current offset of the stream
*
* @return size_t - the offset
*/
std::size_t offset() const
{
return _offset;
}
/**
* @brief Returns the remaining bytes left between the current offset
* and the data size.
*
* @return size_t - the remaining size
*/
std::size_t remaining() const
{
assert(_data.size() >= _offset);
return _data.size() - _offset;
}
/**
* @brief Reads a specified number of bytes out of a stream
*
* @param[out] out - filled in with the data
* @param[in] size - the size to read
*/
void read(void* out, std::size_t size)
{
rangeCheck(size);
memcpy(out, &_data[_offset], size);
_offset += size;
}
/**
* @brief Writes a specified number of bytes into the stream
*
* @param[in] in - the data to write
* @param[in] size - the size to write
*/
void write(const void* in, std::size_t size)
{
size_t newSize = _offset + size;
if (newSize > _data.size())
{
_data.resize(newSize, 0);
}
memcpy(&_data[_offset], in, size);
_offset += size;
}
private:
/**
* @brief Throws an exception if the size passed in plus the current
* offset is bigger than the current data size.
* @param[in] size - the size to check
*/
void rangeCheck(std::size_t size)
{
if (_offset + size > _data.size())
{
std::string msg{"Attempted stream overflow: offset "};
msg += std::to_string(_offset) + " buffer size " +
std::to_string(_data.size()) + " op size " +
std::to_string(size);
throw std::out_of_range(msg.c_str());
}
}
/**
* @brief The data that the stream accesses.
*/
std::vector<uint8_t>& _data;
/**
* @brief The current offset of the stream.
*/
std::size_t _offset;
};
} // namespace pels
} // namespace openpower
|
