-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathSubTimeFrameDataModel.h
More file actions
497 lines (397 loc) · 14.7 KB
/
SubTimeFrameDataModel.h
File metadata and controls
497 lines (397 loc) · 14.7 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
// Copyright 2019-2022 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.
/// \author Gvozden Nešković, Frankfurt Institute for Advanced Studies and Goethe University Frankfurt
#ifndef ALICEO2_SUBTIMEFRAME_DATAMODEL_H_
#define ALICEO2_SUBTIMEFRAME_DATAMODEL_H_
#include "Utilities.h"
#include "DataModelUtils.h"
#include "ReadoutDataModel.h"
#include <Headers/DataHeader.h>
#include <vector>
#include <map>
#include <unordered_set>
#include <stdexcept>
#include <functional>
namespace std
{
template <>
struct hash<o2::header::DataDescription> {
typedef o2::header::DataDescription argument_type;
typedef std::uint64_t result_type;
result_type operator()(argument_type const& a) const noexcept
{
static_assert(sizeof(o2::header::DataDescription::ItgType) == sizeof(uint64_t) &&
sizeof(o2::header::DataDescription) == 16,
"DataDescription must be 16B long (uint64_t itg[2])");
return std::hash<o2::header::DataDescription::ItgType>{}(a.itg[0]) ^
std::hash<o2::header::DataDescription::ItgType>{}(a.itg[1]);
}
};
template <>
struct hash<o2::header::DataOrigin> {
typedef o2::header::DataOrigin argument_type;
typedef std::uint32_t result_type;
result_type operator()(argument_type const& a) const noexcept
{
static_assert(sizeof(o2::header::DataOrigin::ItgType) == sizeof(uint32_t) &&
sizeof(o2::header::DataOrigin) == 4,
"DataOrigin must be 4B long (uint32_t itg[1])");
return std::hash<o2::header::DataOrigin::ItgType>{}(a.itg[0]);
}
};
template <>
struct hash<o2::header::DataIdentifier> {
typedef o2::header::DataIdentifier argument_type;
typedef std::uint64_t result_type;
result_type operator()(argument_type const& a) const noexcept
{
return std::hash<o2::header::DataDescription>{}(a.dataDescription) ^
std::hash<o2::header::DataOrigin>{}(a.dataOrigin);
}
};
} //namespace std
namespace o2::DataDistribution
{
namespace o2hdr = o2::header;
namespace impl
{
static inline o2hdr::DataIdentifier getDataIdentifier(const o2hdr::DataHeader& pDataHdr)
{
o2hdr::DataIdentifier lRetId;
lRetId.dataDescription = pDataHdr.dataDescription;
lRetId.dataOrigin = pDataHdr.dataOrigin;
return lRetId;
}
}
static constexpr o2hdr::DataDescription gDataDescSubTimeFrame{ "DISTSUBTIMEFRAME" };
struct EquipmentIdentifier {
o2hdr::DataDescription mDataDescription; /* 2 x uint64_t */
o2hdr::DataHeader::SubSpecificationType mSubSpecification; /* uint32_t */
o2hdr::DataOrigin mDataOrigin; /* 1 x uint32_t */
EquipmentIdentifier() = delete;
EquipmentIdentifier(const o2hdr::DataDescription& pDataDesc,
const o2hdr::DataOrigin& pDataOrig,
const o2hdr::DataHeader::SubSpecificationType& pSubSpec) noexcept
: mDataDescription(pDataDesc),
mSubSpecification(pSubSpec),
mDataOrigin(pDataOrig)
{
}
EquipmentIdentifier(const o2hdr::DataIdentifier& pDataId,
const o2hdr::DataHeader::SubSpecificationType& pSubSpec) noexcept
: EquipmentIdentifier(pDataId.dataDescription, pDataId.dataOrigin, pSubSpec)
{
}
EquipmentIdentifier(const EquipmentIdentifier& pEid) noexcept
: EquipmentIdentifier(pEid.mDataDescription, pEid.mDataOrigin, pEid.mSubSpecification)
{
}
EquipmentIdentifier(const o2hdr::DataHeader& pDh) noexcept
: EquipmentIdentifier(pDh.dataDescription, pDh.dataOrigin, pDh.subSpecification)
{
}
operator o2hdr::DataIdentifier() const noexcept
{
o2hdr::DataIdentifier lRetId;
lRetId.dataDescription = mDataDescription;
lRetId.dataOrigin = mDataOrigin;
return lRetId;
}
bool operator<(const EquipmentIdentifier& other) const noexcept
{
if (mDataDescription < other.mDataDescription) {
return true;
}
if (mDataDescription == other.mDataDescription && mDataOrigin < other.mDataOrigin) {
return true;
}
if (mDataDescription == other.mDataDescription && mDataOrigin == other.mDataOrigin &&
mSubSpecification < other.mSubSpecification) {
return true;
}
return false;
}
bool operator==(const EquipmentIdentifier& other) const noexcept
{
if (mDataDescription == other.mDataDescription &&
mSubSpecification == other.mSubSpecification &&
mDataOrigin == other.mDataOrigin)
return true;
else
return false;
}
bool operator!=(const EquipmentIdentifier& other) const noexcept
{
return !(*this == other);
}
const std::string info() const
{
return fmt::format("{}/{}/{}",
mDataOrigin.as<std::string>(),
mDataDescription.as<std::string>(),
mSubSpecification);
}
};
////////////////////////////////////////////////////////////////////////////////
/// Visitor friends
////////////////////////////////////////////////////////////////////////////////
#define DECLARE_STF_FRIENDS \
friend class SubTimeFrameReadoutBuilder; \
friend class SubTimeFrameFileBuilder; \
friend class TimeFrameBuilder; \
friend class SubTimeFrameCopyBuilder; \
friend class SubTimeFrameFileWriter; \
friend class SubTimeFrameFileReader; \
friend class StfToDplAdapter; \
friend class DplToStfAdapter; \
friend class IovSerializer; \
friend class IovDeserializer; \
friend class StfSenderOutputUCX;
////////////////////////////////////////////////////////////////////////////////
/// SubTimeFrame
////////////////////////////////////////////////////////////////////////////////
using TimeFrameIdType = std::uint64_t;
using SubTimeFrameIdType = TimeFrameIdType;
static constexpr TimeFrameIdType sInvalidTimeFrameId = TimeFrameIdType(-1);
class SubTimeFrame : public IDataModelObject
{
DECLARE_STF_FRIENDS
struct StfData {
StfData() = delete;
StfData(std::unique_ptr<fair::mq::Message> &&pHdr, std::unique_ptr<fair::mq::Message> &&pData)
: mHeader(std::move(pHdr)), mData(std::move(pData)) { }
std::unique_ptr<fair::mq::Message> mHeader;
std::unique_ptr<fair::mq::Message> mData;
inline const o2hdr::DataHeader* getDataHeader() const
{
if (!mHeader) {
return nullptr;
}
// this is fine since we created the DataHeader there
return reinterpret_cast<o2hdr::DataHeader*>(mHeader->GetData());
}
};
struct StfMessage {
StfMessage() = delete;
StfMessage(std::unique_ptr<fair::mq::Message> &&pHeader)
: mHeader(std::move(pHeader))
{
assert(mHeader);
}
std::unique_ptr<fair::mq::Message> mHeader;
std::vector<std::unique_ptr<fair::mq::Message>> mDataParts;
inline o2hdr::DataHeader* getDataHeaderMutable() {
if (!mHeader) {
return nullptr;
}
// this is fine since we created the DataHeader there
return reinterpret_cast<o2hdr::DataHeader*>(mHeader->GetData());
}
inline o2hdr::DataHeader getDataHeaderCopy() const
{
return *reinterpret_cast<o2hdr::DataHeader*>(mHeader->GetData());
}
inline void setTfCounter_RunNumber(const std::uint32_t pTfCounter, const std::uint32_t pRunNumber) {
// can be removed if redundant
if (!mHeader) {
return;
}
// DataHeader must be first in the stack
o2hdr::DataHeader *lDataHdr = reinterpret_cast<o2hdr::DataHeader*>(mHeader->GetData());
lDataHdr->tfCounter = pTfCounter;
lDataHdr->runNumber = pRunNumber;
}
inline void setFirstOrbit(const std::uint32_t pFirstOrbit)
{
// Redundant headers can be removed
if (!mHeader) {
return;
}
// DataHeader must be first in the stack
o2hdr::DataHeader *lDataHdr = reinterpret_cast<o2hdr::DataHeader*>(mHeader->GetData());
lDataHdr->firstTForbit = pFirstOrbit;
}
};
// we SHOULD be able to get away with this
// make sure the vector has sufficient initial capacity
struct StfDataVectorT : public std::vector<StfMessage> {
StfDataVectorT() : std::vector<StfMessage>() { reserve(512); }
StfDataVectorT(const StfDataVectorT&) = delete;
StfDataVectorT(StfDataVectorT&&) = default;
};
public:
SubTimeFrame(TimeFrameIdType pStfId);
//SubTimeFrame() = default;
virtual ~SubTimeFrame() = default;
// no copy
SubTimeFrame(const SubTimeFrame&) = delete;
SubTimeFrame& operator=(const SubTimeFrame&) = delete;
// default move
SubTimeFrame(SubTimeFrame&& a) = default;
SubTimeFrame& operator=(SubTimeFrame&& a) = default;
// adopt all data from another STF
void mergeStf(std::unique_ptr<SubTimeFrame> pStf, const std::string &mStfSenderId);
// get data size (not including o2 headers)
std::uint64_t getDataSize() const { updateStf(); return mDataSize; }
std::vector<EquipmentIdentifier> getEquipmentIdentifiers() const;
struct Header {
static constexpr std::uint64_t sInvalidTimeMs = std::numeric_limits<std::uint64_t>::max();
TimeFrameIdType mId = sInvalidTimeFrameId;
std::uint32_t mFirstOrbit = std::numeric_limits<std::uint32_t>::max();
std::uint32_t mRunNumber = 0;
enum Origin {
eInvalid = -1,
eReadout = 1,
eReadoutTopology, // MFT/ITS topology run
eNull // TODO: remove after DD v1.4
} mOrigin = eInvalid;
std::uint64_t mCreationTimeMs = sInvalidTimeMs; // miliseconds since unix epoch
Header() = default;
explicit Header(TimeFrameIdType pId)
: mId(pId) { }
};
const Header& header() const { return mHeader; }
TimeFrameIdType id() const { return mHeader.mId; }
Header::Origin origin() const { return mHeader.mOrigin; }
void setOrigin(const Header::Origin pOrig) {
if (mHeader.mOrigin == Header::Origin::eInvalid) {
mHeader.mOrigin = pOrig;
}
}
void clear() { mData.clear(); mDataUpdated = false; }
// NOTE: method declared const to work with const visitors, manipulated fields are mutable
void updateStf() const;
protected:
void accept(ISubTimeFrameVisitor& v, void *p = nullptr) override { updateStf(); v.visit(*this, p); }
void accept(ISubTimeFrameConstVisitor& v, void *p = nullptr) const override { updateStf(); v.visit(*this, p); }
private:
using StfDataVector = StfDataVectorT; // vector with more capacity on creation
using StfSubSpecMap = std::unordered_map<o2hdr::DataHeader::SubSpecificationType, StfDataVector>;
using StfDataIdentMap = std::unordered_map<o2hdr::DataIdentifier, StfSubSpecMap>;
///
/// Fields
///
Header mHeader;
mutable StfDataIdentMap mData;
mutable std::uint64_t mDataSize = 0;
///
/// internal: do lazy accounting. Must be invalidated every time StubTimeFrame is changed
///
mutable bool mDataUpdated = false;
public:
void updateId(const std::uint64_t pNewId) {
if (pNewId > 0) {
mHeader.mId = pNewId;
mDataUpdated = false;
}
}
void updateFirstOrbit(const std::uint32_t pOrbit) {
if (pOrbit < mHeader.mFirstOrbit) {
mHeader.mFirstOrbit = pOrbit;
mDataUpdated = false;
}
}
void updateRunNumber(const std::uint32_t pRunNum) {
if (mHeader.mRunNumber != pRunNum) {
mHeader.mRunNumber = pRunNum;
mDataUpdated = false;
}
}
void updateCreationTimeMs() {
mHeader.mCreationTimeMs = std::chrono::time_point_cast<std::chrono::milliseconds>(std::chrono::system_clock::now()).time_since_epoch().count();
}
void updateCreationTimeMs(const std::uint64_t pTimeMs) {
mHeader.mCreationTimeMs = pTimeMs;
}
private:
///
/// helper methods
///
inline bool stfDataExists(const o2hdr::DataIdentifier &pDataId, const o2::header::DataHeader::SubSpecificationType pSubSpec)
{
const auto lDataIt = mData.find(pDataId);
if (lDataIt == mData.end()) {
return false;
}
if (lDataIt->second.count(pSubSpec) > 0) {
return true;
}
return false;
}
// This is only to be used with the data building from readout
// in this case, only a single split-payload will be present in the data vector
// If any other header is provided, it can be discarded
inline auto addStfDataReadout(const o2hdr::DataIdentifier &pDataId, const o2::header::DataHeader::SubSpecificationType pSubSpec, StfData&& pStfData)
{
auto &lDataVec = mData[pDataId][pSubSpec];
if (lDataVec.empty()) {
assert(pStfData.mHeader);
lDataVec.emplace_back(StfMessage(std::move(pStfData.mHeader)));
}
if (!lDataVec.empty()) {
// remove the header
pStfData.mHeader = nullptr;
}
auto &lNewMsg = lDataVec.back();
lNewMsg.mDataParts.reserve(512); // usually HBFs
lNewMsg.mDataParts.emplace_back(std::move(pStfData.mData));
mDataUpdated = false;
return &(lNewMsg.mDataParts);
}
// optimized version without vector lookup
inline void addStfDataReadout(std::vector<fair::mq::MessagePtr> *pInVector, fair::mq::MessagePtr &&pData)
{
if (!pInVector || pInVector->empty()) {
EDDLOG("BUG: addStfDataAppend: No header message.");
return;
}
pInVector->emplace_back(std::move(pData));
mDataUpdated = false;
}
// Start a new single or split-payload message
// e.g. when deserializing a channel or a file
inline auto addStfDataStart(const o2hdr::DataIdentifier &pDataId, const o2::header::DataHeader::SubSpecificationType pSubSpec, StfData&& pStfData)
{
auto &lDataVec = mData[pDataId][pSubSpec];
auto &lNewMsg = lDataVec.emplace_back(StfMessage(std::move(pStfData.mHeader)));
lNewMsg.mDataParts.reserve(512);
lNewMsg.mDataParts.emplace_back(std::move(pStfData.mData));
mDataUpdated = false;
return &(lNewMsg.mDataParts);
}
// Append a split-payload message
// e.g. when deserializing a channel or a file
inline void addStfDataAppend(std::vector<fair::mq::MessagePtr> *pInVector, fair::mq::MessagePtr &&pData)
{
if (!pInVector || pInVector->empty()) {
EDDLOG("BUG: addStfDataAppend: No header message");
return;
}
pInVector->emplace_back(std::move(pData));
mDataUpdated = false;
}
};
} /* o2::DataDistribution */
namespace std
{
template <>
struct hash<o2::DataDistribution::EquipmentIdentifier> {
typedef o2::DataDistribution::EquipmentIdentifier argument_type;
typedef std::uint64_t result_type;
result_type operator()(argument_type const& a) const noexcept
{
return std::hash<o2::header::DataDescription>{}(a.mDataDescription) ^
(std::hash<o2::header::DataOrigin>{}(a.mDataOrigin) << 1) ^
a.mSubSpecification;
}
};
} //namespace std
#endif /* ALICEO2_SUBTIMEFRAME_DATAMODEL_H_ */