-
Notifications
You must be signed in to change notification settings - Fork 490
Expand file tree
/
Copy pathPageParser.h
More file actions
498 lines (446 loc) · 14.3 KB
/
PageParser.h
File metadata and controls
498 lines (446 loc) · 14.3 KB
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
#ifndef ALGORITHM_PAGEPARSER_H
#define ALGORITHM_PAGEPARSER_H
/// @file PageParser.h
/// @author Matthias Richter
/// @since 2017-09-27
/// @brief Parser for a set of data objects in consecutive memory pages.
#include <functional>
#include <vector>
#include <cassert>
#include <type_traits>
#include <stdexcept>
namespace o2
{
namespace algorithm
{
namespace pageparser
{
// a function to extract the number of elements from the group type
// this is the version for all but integral types
template <typename T>
typename std::enable_if<std::is_void<T>::value, size_t>::type
extractNElements(T* v)
{
return 0;
}
// the specialization for integral types
template <typename T>
typename std::enable_if<std::is_integral<T>::value, T>::type
extractNElements(T* v)
{
return *v;
}
template <typename GroupT>
using DefaultGetNElementsFctT = size_t (*)(const GroupT*);
// the default function to extract the number of elements in a group
// where the group header is a single integral type holding number of
// elements
auto defaultGetNElementsFct = [](const auto* groupdata) {
using ReturnType = size_t;
using T = typename std::remove_pointer<decltype(groupdata)>::type;
// this default function is only for integral types
static_assert(std::is_integral<T>::value || std::is_void<T>::value,
"A function for extracting the number of elements from the "
"group header must be specified for non-trivial types");
// the default function for trivial integral types means there
// is exactly one number holding the size
return static_cast<ReturnType>(extractNElements(groupdata));
};
template <typename T>
T* alloc()
{
return new T;
}
template <>
void* alloc<void>()
{
return nullptr;
}
template <typename T>
void free(T* ptr)
{
if (ptr) {
delete ptr;
}
}
template <>
void free<void>(void*)
{
}
template <typename T>
size_t sizeofGroupHeader()
{
return sizeof(T);
}
template <>
size_t sizeofGroupHeader<void>()
{
return 0;
}
template <typename T>
void set(T* h, size_t v)
{
*h = v;
}
template <>
void set<void>(void*, size_t)
{
}
} // namespace pageparser
/**
* @class PageParser
* Parser for a set of data objects in consecutive memory pages.
*
* All memory pages have a fixed size and start with a page header.
* Depending on the page size and size of the data object, some
* objects can be split at the page boundary and have the page header
* embedded.
*
* The class iterator can be used to iterate over the data objects
* transparently.
*
* In addition data elements can be grouped. In that case a group
* header comes immediately after the first page header. The header
* has to store the number of elements which follow, a getter function
* has to be provided to retrieve the number from the header.
*
* In the most simple case, the group header consists of just one
* element of arbitrary integral type, the parser implements a default
* getter function to retrieve that number. The parser can be invoked
* by simply specifying an integral type as GroupT template parameter.
*
* Multiple blocks of grouped data elements can be in the group, a block
* can wrap over page boundery. A new block of grouped elements can
* however only start in a new page right after the page header.
*
* Usage: ungrouped elements
* RawParser<PageHeaderType, N, ElementType> RawParser;
* RawParser parser(ptr, size);
* for (auto element : parser) {
* // do something with element
* }
*
* Usage: grouped elements
* RawParser<PageHeaderType, N, ElementType, int> RawParser;
* RawParser parser(ptr, size);
* for (auto element : parser) {
* // do something with element
* }
*/
template <typename PageHeaderT,
size_t PageSize,
typename ElementT,
typename GroupT = void,
typename GetNElementsFctT = pageparser::DefaultGetNElementsFctT<GroupT>>
class PageParser
{
public:
using PageHeaderType = PageHeaderT;
using BufferType = unsigned char;
using value_type = ElementT;
using GroupType = GroupT;
using GetNElements = GetNElementsFctT;
static const size_t page_size = PageSize;
// at the moment an object can only be split among two pages
static_assert(PageSize >= sizeof(PageHeaderType) + sizeof(value_type),
"Page Header and at least one element have to fit into page");
// switches for the copy method, used to skip ill-formed expressions
using TargetInPageBuffer = std::true_type;
using SourceInPageBuffer = std::false_type;
PageParser() = delete;
template <typename T>
PageParser(T* buffer, size_t size,
GetNElements getNElementsFct = pageparser::defaultGetNElementsFct)
: mBuffer(nullptr), mBufferIsConst(std::is_const<T>::value), mSize(size), mGetNElementsFct(getNElementsFct), mNPages(size > 0 ? ((size - 1) / page_size) + 1 : 0), mGroupHeader(pageparser::alloc<GroupType>())
{
static_assert(sizeof(T) == sizeof(BufferType),
"buffer required to be byte-type");
// the buffer pointer is stored non-const, a runtime check ensures
// that iterator write works only for non-const buffers
mBuffer = const_cast<BufferType*>(buffer);
}
~PageParser()
{
pageparser::free(mGroupHeader);
}
template <typename T>
class Iterator
{
public:
using ParentType = PageParser;
using SelfType = Iterator;
using iterator_category = std::forward_iterator_tag;
using value_type = T;
using reference = T&;
using pointer = T*;
using difference_type = std::ptrdiff_t;
using ElementType = typename std::remove_const<value_type>::type;
Iterator() = delete;
Iterator(ParentType const* parent, size_t position = 0)
: mParent(parent)
{
mPosition = position;
size_t argument = mPosition;
if (!mParent->getElement(argument, mElement)) {
// eof, both mPosition and mNextPosition point to buffer end
mPosition = argument;
}
mNextPosition = argument;
backup();
}
~Iterator()
{
sync();
}
// prefix increment
SelfType& operator++()
{
sync();
mPosition = mNextPosition;
size_t argument = mPosition;
if (!mParent->getElement(argument, mElement)) {
// eof, both mPosition and mNextPosition point to buffer end
mPosition = argument;
}
mNextPosition = argument;
backup();
return *this;
}
// postfix increment
SelfType operator++(int /*unused*/)
{
SelfType copy(*this);
operator++();
return copy;
}
// return reference
reference operator*()
{
return mElement;
}
// comparison
bool operator==(const SelfType& rh) const
{
return mPosition == rh.mPosition;
}
// comparison
bool operator!=(const SelfType& rh) const
{
return mPosition != rh.mPosition;
}
const GroupType* getGroupHeader() const
{
return mParent->getGroupHeader();
}
private:
// sync method for non-const iterator
template <typename U = void>
typename std::enable_if<!std::is_const<value_type>::value, U>::type sync()
{
if (std::memcmp(&mElement, &mBackup, sizeof(value_type)) != 0) {
// mElement is changed, sync to buffer
mParent->setElement(mPosition, mElement);
}
}
// overload for const_iterator, empty function body
template <typename U = void>
typename std::enable_if<std::is_const<value_type>::value, U>::type sync()
{
}
// backup for non-const iterator
template <typename U = void>
typename std::enable_if<!std::is_const<value_type>::value, U>::type backup()
{
mBackup = mElement;
}
// overload for const_iterator, empty function body
template <typename U = void>
typename std::enable_if<std::is_const<value_type>::value, U>::type backup()
{
}
int mPosition;
int mNextPosition;
ParentType const* mParent;
ElementType mElement;
ElementType mBackup;
};
/// set an object at position
size_t setElement(size_t position, const value_type& element) const
{
// write functionality not yet implemented for grouped elements
assert(std::is_void<GroupType>::value);
// check if we are at the end
if (position >= mSize) {
assert(position == mSize);
return mSize;
}
// check if there is space for one element
if (position + sizeof(value_type) > mSize) {
// format error, probably throw exception
return mSize;
}
auto source = reinterpret_cast<const BufferType*>(&element);
auto target = mBuffer + position;
return position + copy<TargetInPageBuffer>(source, target, page_size - (position % page_size));
}
template <typename T>
size_t readGroupHeader(size_t position, T* groupHeader) const
{
assert((position % page_size) == sizeof(PageHeaderType));
if (std::is_void<T>::value) {
return 0;
}
memcpy(groupHeader, mBuffer + position, pageparser::sizeofGroupHeader<T>());
return mGetNElementsFct(groupHeader);
}
/// retrieve an object at position
bool getElement(size_t& position, value_type& element) const
{
// check if we are at the end
if (position >= mSize) {
assert(position == mSize);
position = mSize;
return false;
}
// handle group if defined
if (!std::is_void<GroupType>::value) {
if (mNGroupElements == 0) {
// new group has to be read from the buffer
do {
if ((position % page_size) == 0) {
position += sizeof(PageHeaderType);
}
if ((position % page_size) != sizeof(PageHeaderType)) {
// forward to the next page
position += page_size - (position % page_size) + sizeof(PageHeaderType);
if (position > mSize) {
//this is probably a valid condition as the group header can just
//indicate zero clusters
//throw std::runtime_error("");
position = mSize;
return false;
}
}
const_cast<PageParser*>(this)->mNGroupElements = readGroupHeader(position, mGroupHeader);
position += pageparser::sizeofGroupHeader<GroupType>();
} while (mNGroupElements == 0);
size_t nPages = 0;
size_t required = pageparser::sizeofGroupHeader<GroupType>() + mNGroupElements * sizeof(value_type);
do {
// the block of elements can go beyond the current page, find out
// how many additional pages are required
required += sizeof(PageHeaderType);
++nPages;
} while (required > nPages * page_size);
required -= sizeof(PageHeaderType) + pageparser::sizeofGroupHeader<GroupType>();
if (position + required > mSize) {
throw std::runtime_error(
"format error: the number of group elements "
"does not fit into the remaining buffer");
}
}
// now we will read one element
const_cast<PageParser*>(this)->mNGroupElements -= 1;
;
}
// check if there is space for one element
if (position + sizeof(value_type) > mSize) {
// FIXME: not sure if this is considered an error condition if
// no groups are used, i.e. the buffer should have the correct size
// and no extra space after the last element
position = mSize;
return false;
}
auto source = mBuffer + position;
auto target = reinterpret_cast<BufferType*>(&element);
position += copy<SourceInPageBuffer>(source, target, page_size - (position % page_size));
return true;
}
// copy data, depending on compile time switch, either source or target
// pointer are treated as pointer in the raw page, i.e. can be additionally
// incremented by the page header
template <typename SwitchT>
size_t copy(const BufferType* source, BufferType* target, size_t pageCapacity) const
{
size_t position = 0;
auto copySize = sizeof(value_type);
// choose which of the pointers needs additional PageHeader offsets
auto pageOffsetTarget = SwitchT::value ? &target : const_cast<BufferType**>(&source);
if (pageCapacity == page_size) {
// skip the page header at beginning of page
position += sizeof(PageHeaderType);
pageCapacity -= sizeof(PageHeaderType);
*pageOffsetTarget += sizeof(PageHeaderType);
}
if (copySize > pageCapacity) {
// object is split at the page boundary, copy the part
// in the current page first
copySize = pageCapacity;
}
if (copySize > 0) {
memcpy(target, source, copySize);
position += copySize;
source += copySize;
target += copySize;
}
copySize = sizeof(value_type) - copySize;
if (copySize > 0) {
// skip page header at beginning of new page and copy
// remaining part of the element
position += sizeof(PageHeaderType);
*pageOffsetTarget += sizeof(PageHeaderType);
memcpy(target, source, copySize);
position += copySize;
}
return position;
}
const GroupType getGroupHeader() const
{
return mGroupHeader;
}
using iterator = Iterator<value_type>;
using const_iterator = Iterator<const value_type>;
const_iterator begin() const
{
return const_iterator(this, 0);
}
const_iterator end() const
{
return const_iterator(this, mSize);
}
iterator begin()
{
if (mBufferIsConst) {
// did not find a way to do this at compile time in the constructor,
// probably one needs to make the buffer type a template parameter
// to the class
throw std::runtime_error("the underlying buffer is not writeable");
}
return iterator(this, 0);
}
iterator end()
{
return iterator(this, mSize);
}
private:
BufferType* mBuffer = nullptr;
bool mBufferIsConst = false;
size_t mSize = 0;
GetNElements mGetNElementsFct = nullptr;
size_t mNPages = 0;
GroupType* mGroupHeader = nullptr;
size_t mNGroupElements = 0;
};
} // namespace algorithm
} // namespace o2
#endif