2 #define TRACE_NAME "HighFiveGroupedDataset"
3 #define TLVL_INSERTONE 6
4 #define TLVL_INSERTHEADER 7
5 #define TLVL_WRITEFRAGMENT 8
6 #define TLVL_WRITEFRAGMENT_V 9
7 #define TLVL_READNEXTEVENT 10
8 #define TLVL_READNEXTEVENT_V 11
9 #define TLVL_READFRAGMENT 12
10 #define TLVL_READFRAGMENT_V 13
11 #define TLVL_GETEVENTHEADER 14
14 #include <unordered_map>
15 #include "artdaq-core/Data/ContainerFragmentLoader.hh"
16 #include "artdaq-demo-hdf5/HDF5/FragmentDataset.hh"
17 #include "artdaq-demo-hdf5/HDF5/highFive/HighFive/include/highfive/H5File.hpp"
51 void insertOne(artdaq::Fragment
const& frag)
override;
56 void insertMany(artdaq::Fragments
const& frags)
override;
63 void insertHeader(artdaq::detail::RawEventHeader
const& hdr)
override;
68 std::unordered_map<artdaq::Fragment::type_t, std::unique_ptr<artdaq::Fragments>>
readNextEvent()
override;
74 std::unique_ptr<artdaq::detail::RawEventHeader>
getEventHeader(artdaq::Fragment::sequence_id_t
const& seqID)
override;
82 std::unique_ptr<HighFive::File> file_;
84 HighFive::DataSetCreateProps fragmentCProps_;
85 HighFive::DataSetAccessProps fragmentAProps_;
87 void writeFragment_(HighFive::Group& group, artdaq::Fragment
const& frag);
88 artdaq::FragmentPtr readFragment_(HighFive::DataSet
const& dataset);
94 :
FragmentDataset(ps, ps.get<std::string>(
"mode",
"write")), file_(nullptr), eventIndex_(0)
96 TLOG(TLVL_DEBUG) <<
"HighFiveGroupedDataset CONSTRUCTOR BEGIN";
97 if (
mode_ == FragmentDatasetMode::Read)
99 file_ = std::make_unique<HighFive::File>(ps.get<std::string>(
"fileName"), HighFive::File::ReadOnly);
103 file_ = std::make_unique<HighFive::File>(ps.get<std::string>(
"fileName"), HighFive::File::OpenOrCreate | HighFive::File::Truncate);
106 TLOG(TLVL_DEBUG) <<
"HighFiveGroupedDataset CONSTRUCTOR END";
111 TLOG(TLVL_DEBUG) <<
"~HighFiveGroupedDataset Begin/End ";
117 TLOG(TLVL_TRACE) <<
"insertOne BEGIN";
118 if (!file_->exist(std::to_string(frag.sequenceID())))
120 TLOG(TLVL_INSERTONE) <<
"insertOne: Creating group for sequence ID " << frag.sequenceID();
121 file_->createGroup(std::to_string(frag.sequenceID()));
123 auto eventGroup = file_->getGroup(std::to_string(frag.sequenceID()));
125 if (frag.type() == Fragment::ContainerFragmentType)
127 TLOG(TLVL_INSERTONE) <<
"insertOne: Processing ContainerFragment";
128 ContainerFragment cf(frag);
129 if (cf.block_count() > 0)
131 TLOG(TLVL_INSERTONE) <<
"insertOne: Getting Fragment type name";
132 auto fragPtr = cf.at(0);
133 auto typeName = nameHelper_->GetInstanceNameForFragment(*fragPtr).second;
135 if (!eventGroup.exist(typeName))
137 TLOG(TLVL_INSERTONE) <<
"insertOne: Creating group for type " << typeName;
138 eventGroup.createGroup(typeName);
141 TLOG(TLVL_INSERTONE) <<
"insertOne: Creating group and setting attributes";
142 auto typeGroup = eventGroup.getGroup(typeName);
143 auto containerGroup = typeGroup.createGroup(
"Container_" + std::to_string(frag.fragmentID()));
144 containerGroup.createAttribute(
"version", frag.version());
145 containerGroup.createAttribute(
"type", frag.type());
146 containerGroup.createAttribute(
"sequence_id", frag.sequenceID());
147 containerGroup.createAttribute(
"fragment_id", frag.fragmentID());
148 containerGroup.createAttribute(
"timestamp", frag.timestamp());
150 containerGroup.createAttribute(
"container_block_count", cf.block_count());
151 containerGroup.createAttribute(
"container_fragment_type", cf.fragment_type());
152 containerGroup.createAttribute(
"container_version", cf.metadata()->version);
153 containerGroup.createAttribute(
"container_missing_data", cf.missing_data());
155 TLOG(TLVL_INSERTONE) <<
"insertOne: Writing Container contained Fragments";
156 for (
size_t ii = 0; ii < cf.block_count(); ++ii)
162 writeFragment_(containerGroup, *fragPtr);
167 TLOG(TLVL_INSERTONE) <<
"insertOne: Writing Empty Container Fragment as standard Fragment";
168 auto typeName = nameHelper_->GetInstanceNameForFragment(frag).second;
169 if (!eventGroup.exist(typeName))
171 TLOG(TLVL_INSERTONE) <<
"insertOne: Creating group for type " << typeName;
172 eventGroup.createGroup(typeName);
174 auto typeGroup = eventGroup.getGroup(typeName);
176 writeFragment_(typeGroup, frag);
181 TLOG(TLVL_INSERTONE) <<
"insertOne: Writing non-Container Fragment";
182 auto typeName = nameHelper_->GetInstanceNameForFragment(frag).second;
183 if (!eventGroup.exist(typeName))
185 TLOG(TLVL_INSERTONE) <<
"insertOne: Creating group for type " << typeName;
186 eventGroup.createGroup(typeName);
188 auto typeGroup = eventGroup.getGroup(typeName);
190 writeFragment_(typeGroup, frag);
192 TLOG(TLVL_TRACE) <<
"insertOne END";
197 TLOG(TLVL_TRACE) <<
"insertMany BEGIN";
198 for (
auto& f : fs) insertOne(f);
199 TLOG(TLVL_TRACE) <<
"insertMany END";
204 TLOG(TLVL_TRACE) <<
"insertHeader BEGIN";
205 if (!file_->exist(std::to_string(hdr.sequence_id)))
207 TLOG(TLVL_INSERTHEADER) <<
"insertHeader: Creating group for event " << hdr.sequence_id;
208 file_->createGroup(std::to_string(hdr.sequence_id));
210 auto eventGroup = file_->getGroup(std::to_string(hdr.sequence_id));
211 eventGroup.createAttribute(
"run_id", hdr.run_id);
212 eventGroup.createAttribute(
"subrun_id", hdr.subrun_id);
213 eventGroup.createAttribute(
"event_id", hdr.event_id);
214 eventGroup.createAttribute(
"timestamp", hdr.timestamp);
215 eventGroup.createAttribute(
"is_complete", hdr.is_complete);
216 TLOG(TLVL_TRACE) <<
"insertHeader END";
221 TLOG(TLVL_DEBUG) <<
"readNextEvent BEGIN";
222 std::unordered_map<artdaq::Fragment::type_t, std::unique_ptr<artdaq::Fragments>> output;
224 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Finding next event group in file";
225 auto groupNames = file_->listObjectNames();
226 while (eventIndex_ < groupNames.size() && file_->getObjectType(groupNames[eventIndex_]) != HighFive::ObjectType::Group)
231 if (groupNames.size() <= eventIndex_)
233 TLOG(TLVL_INFO) <<
"readNextEvent: No more events in file!";
237 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Getting event group " << groupNames[eventIndex_];
238 auto event_group = file_->getGroup(groupNames[eventIndex_]);
239 auto fragment_type_names = event_group.listObjectNames();
241 for (
auto& fragment_type : fragment_type_names)
243 if (event_group.getObjectType(fragment_type) != HighFive::ObjectType::Group)
247 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Reading Fragment type " << fragment_type;
248 auto type_group = event_group.getGroup(fragment_type);
249 auto fragment_names = type_group.listObjectNames();
251 for (
auto& fragment_name : fragment_names)
253 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Reading Fragment " << fragment_name;
254 auto node_type = type_group.getObjectType(fragment_name);
255 if (node_type == HighFive::ObjectType::Group)
257 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Fragment " << fragment_name <<
" is a Container";
258 auto container_group = type_group.getGroup(fragment_name);
259 Fragment::type_t type;
260 container_group.getAttribute(
"type").read<Fragment::type_t>(type);
261 Fragment::sequence_id_t seqID;
262 container_group.getAttribute(
"sequence_id").read(seqID);
263 Fragment::timestamp_t timestamp;
264 container_group.getAttribute(
"timestamp").read(timestamp);
265 Fragment::fragment_id_t fragID;
266 container_group.getAttribute(
"fragment_id").read(fragID);
267 if (output.count(type) == 0u)
269 output[type] = std::make_unique<Fragments>();
271 output[type]->emplace_back(seqID, fragID);
272 output[type]->back().setTimestamp(timestamp);
273 output[type]->back().setSystemType(type);
275 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Creating ContainerFragmentLoader for reading Container Fragments";
276 ContainerFragmentLoader cfl(output[type]->back());
278 Fragment::type_t container_fragment_type;
280 container_group.getAttribute(
"container_fragment_type").read(container_fragment_type);
281 container_group.getAttribute(
"container_missing_data").read(missing_data);
283 cfl.set_fragment_type(container_fragment_type);
284 cfl.set_missing_data(missing_data != 0);
286 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Reading ContainerFragment Fragments";
287 auto fragments = container_group.listObjectNames();
288 for (
auto& fragname : fragments)
290 if (container_group.getObjectType(fragname) != HighFive::ObjectType::Dataset)
294 TLOG(TLVL_READNEXTEVENT_V) <<
"readNextEvent: Calling readFragment_ BEGIN";
295 auto frag = readFragment_(container_group.getDataSet(fragname, fragmentAProps_));
296 TLOG(TLVL_READNEXTEVENT_V) <<
"readNextEvent: Calling readFragment_ END";
298 TLOG(TLVL_READNEXTEVENT_V) <<
"readNextEvent: Calling addFragment BEGIN";
299 cfl.addFragment(frag);
300 TLOG(TLVL_READNEXTEVENT_V) <<
"readNextEvent: addFragment END";
303 else if (node_type == HighFive::ObjectType::Dataset)
305 TLOG(TLVL_READNEXTEVENT_V) <<
"readNextEvent: Calling readFragment_ BEGIN";
306 auto frag = readFragment_(type_group.getDataSet(fragment_name, fragmentAProps_));
307 TLOG(TLVL_READNEXTEVENT_V) <<
"readNextEvent: Calling readFragment_ END";
309 TLOG(TLVL_READNEXTEVENT) <<
"readNextEvent: Adding Fragment to output";
310 if (output.count(frag->type()) == 0u)
312 output[frag->type()] = std::make_unique<artdaq::Fragments>();
314 output[frag->type()]->push_back(*frag.release());
322 <<
"readNextEvent END output.size() = " << output.size();
328 TLOG(TLVL_TRACE) <<
"GetEventHeader BEGIN seqID=" << seqID;
329 if (!file_->exist(std::to_string(seqID)))
331 TLOG(TLVL_ERROR) <<
"Sequence ID " << seqID <<
" not found in input file!";
334 auto seqIDGroup = file_->getGroup(std::to_string(seqID));
336 uint32_t runID, subrunID, eventID;
338 seqIDGroup.getAttribute(
"run_id").read(runID);
339 seqIDGroup.getAttribute(
"subrun_id").read(subrunID);
340 seqIDGroup.getAttribute(
"event_id").read(eventID);
341 seqIDGroup.getAttribute(
"timestamp").read(timestamp);
343 TLOG(TLVL_GETEVENTHEADER) <<
"Creating EventHeader with runID " << runID <<
", subrunID " << subrunID <<
", eventID " << eventID <<
" (seqID " << seqID <<
")";
344 artdaq::detail::RawEventHeader hdr(runID, subrunID, eventID, seqID, timestamp);
345 seqIDGroup.getAttribute(
"is_complete").read(hdr.is_complete);
347 TLOG(TLVL_TRACE) <<
"GetEventHeader END";
348 return std::make_unique<artdaq::detail::RawEventHeader>(hdr);
351 void artdaq::hdf5::HighFiveGroupedDataset::writeFragment_(HighFive::Group& group, artdaq::Fragment
const& frag)
353 TLOG(TLVL_TRACE) <<
"writeFragment_ BEGIN";
355 auto datasetNameBase =
"Fragment_" + std::to_string(frag.fragmentID());
356 auto datasetName = datasetNameBase +
";1";
358 while (group.exist(datasetName))
360 TLOG(TLVL_WRITEFRAGMENT) <<
"writeFragment_: Duplicate Fragment ID " << frag.fragmentID() <<
" detected. If this is a ContainerFragment, this is expected, otherwise check configuration!";
361 datasetName = datasetNameBase +
";" + std::to_string(counter);
365 TLOG(TLVL_WRITEFRAGMENT) <<
"writeFragment_: Creating DataSpace";
366 HighFive::DataSpace fragmentSpace = HighFive::DataSpace({frag.size() - frag.headerSizeWords(), 1});
367 auto fragDset = group.createDataSet<RawDataType>(datasetName, fragmentSpace, fragmentCProps_, fragmentAProps_);
369 TLOG(TLVL_WRITEFRAGMENT) <<
"writeFragment_: Creating Attributes from Fragment Header";
370 auto fragHdr = frag.fragmentHeader();
371 fragDset.createAttribute(
"word_count", fragHdr.word_count);
372 fragDset.createAttribute(
"fragment_data_size", frag.size() - frag.headerSizeWords());
373 fragDset.createAttribute(
"version", fragHdr.version);
374 fragDset.createAttribute(
"type", fragHdr.type);
375 fragDset.createAttribute(
"metadata_word_count", fragHdr.metadata_word_count);
377 fragDset.createAttribute(
"sequence_id", fragHdr.sequence_id);
378 fragDset.createAttribute(
"fragment_id", fragHdr.fragment_id);
380 fragDset.createAttribute(
"timestamp", fragHdr.timestamp);
382 fragDset.createAttribute(
"valid", fragHdr.valid);
383 fragDset.createAttribute(
"complete", fragHdr.complete);
384 fragDset.createAttribute(
"atime_ns", fragHdr.atime_ns);
385 fragDset.createAttribute(
"atime_s", fragHdr.atime_s);
387 TLOG(TLVL_WRITEFRAGMENT_V) <<
"writeFragment_: Writing Fragment payload START";
388 fragDset.write(frag.headerBegin() + frag.headerSizeWords());
389 TLOG(TLVL_WRITEFRAGMENT_V) <<
"writeFragment_: Writing Fragment payload DONE";
390 TLOG(TLVL_TRACE) <<
"writeFragment_ END";
393 artdaq::FragmentPtr artdaq::hdf5::HighFiveGroupedDataset::readFragment_(HighFive::DataSet
const& dataset)
395 TLOG(TLVL_TRACE) <<
"readFragment_ BEGIN";
397 dataset.getAttribute(
"fragment_data_size").read(fragSize);
398 TLOG(TLVL_READFRAGMENT) <<
"readFragment_: Fragment size " << fragSize <<
", dataset size " << dataset.getDimensions()[0];
400 artdaq::FragmentPtr frag(
new Fragment(fragSize));
402 artdaq::Fragment::type_t type;
403 size_t metadata_size;
404 artdaq::Fragment::sequence_id_t seqID;
405 artdaq::Fragment::fragment_id_t fragID;
406 artdaq::Fragment::timestamp_t timestamp;
407 int valid, complete, atime_ns, atime_s;
409 TLOG(TLVL_READFRAGMENT) <<
"readFragment_: Reading Fragment header fields from dataset attributes";
410 dataset.getAttribute(
"type").read(type);
411 dataset.getAttribute(
"metadata_word_count").read(metadata_size);
413 dataset.getAttribute(
"sequence_id").read(seqID);
414 dataset.getAttribute(
"fragment_id").read(fragID);
416 dataset.getAttribute(
"timestamp").read(timestamp);
418 dataset.getAttribute(
"valid").read(valid);
419 dataset.getAttribute(
"complete").read(complete);
420 dataset.getAttribute(
"atime_ns").read(atime_ns);
421 dataset.getAttribute(
"atime_s").read(atime_s);
423 auto fragHdr = frag->fragmentHeader();
425 fragHdr.metadata_word_count = metadata_size;
427 fragHdr.sequence_id = seqID;
428 fragHdr.fragment_id = fragID;
430 fragHdr.timestamp = timestamp;
432 fragHdr.valid = valid;
433 fragHdr.complete = complete;
434 fragHdr.atime_ns = atime_ns;
435 fragHdr.atime_s = atime_s;
437 TLOG(TLVL_READFRAGMENT) <<
"readFragment_: Copying header into Fragment";
438 memcpy(frag->headerAddress(), &fragHdr,
sizeof(fragHdr));
440 TLOG(TLVL_READFRAGMENT_V) <<
"readFragment_: Reading payload data into Fragment BEGIN";
441 dataset.read(frag->headerAddress() + frag->headerSizeWords());
442 TLOG(TLVL_READFRAGMENT_V) <<
"readFragment_: Reading payload data into Fragment END";
444 TLOG(TLVL_TRACE) <<
"readFragment_ END";
std::unordered_map< artdaq::Fragment::type_t, std::unique_ptr< artdaq::Fragments > > readNextEvent() override
Read the next event from the Dataset (HDF5 file)
std::unique_ptr< artdaq::detail::RawEventHeader > getEventHeader(artdaq::Fragment::sequence_id_t const &seqID) override
Read a RawEventHeader from the Dataset (HDF5 file)
A FragmentDataset implementation which produces files where each event is a Group, and each Fragment_id_t within the group is either a dataset or a group if it is a ContainerFragment.
void insertOne(artdaq::Fragment const &frag) override
Insert a Fragment into the Dataset (write it to the HDF5 file)
HighFiveGroupedDataset(fhicl::ParameterSet const &ps)
HighFiveGroupedDataset Constructor.
~HighFiveGroupedDataset() noexceptoverride
HighFiveGroupedDataset Destructor.
void insertHeader(artdaq::detail::RawEventHeader const &hdr) override
Insert a RawEventHeader into the Dataset (write it to the HDF5 file)
FragmentDatasetMode mode_
Mode of this FragmentDataset, either FragmentDatasetMode::Write or FragmentDatasetMode::Read.
Base class that defines methods for reading and writing to HDF5 files via various implementation plug...
void insertMany(artdaq::Fragments const &frags) override
Insert several Fragments into the Dataset (write them to the HDF5 file)