1 #ifndef artdaq_ArtModules_detail_HDFFileReader_hh
2 #define artdaq_ArtModules_detail_HDFFileReader_hh
4 #include "artdaq/DAQdata/Globals.hh"
6 #include "artdaq-core/Data/ContainerFragment.hh"
7 #include "artdaq-core/Data/Fragment.hh"
8 #include "artdaq-core/Data/RawEvent.hh"
9 #include "artdaq-core/Utilities/ExceptionHandler.hh"
10 #include "artdaq-core/Utilities/TimeUtils.hh"
11 #include "artdaq-demo-hdf5/HDF5/MakeDatasetPlugin.hh"
12 #include "artdaq/ArtModules/ArtdaqFragmentNamingService.h"
14 #include "art/Framework/Core/FileBlock.h"
15 #include "art/Framework/Core/ProductRegistryHelper.h"
16 #include "art/Framework/IO/Sources/SourceHelper.h"
17 #include "art/Framework/IO/Sources/put_product_in_principal.h"
18 #include "art/Framework/Principal/EventPrincipal.h"
19 #include "art/Framework/Principal/RunPrincipal.h"
20 #include "art/Framework/Principal/SubRunPrincipal.h"
21 #include "art/Framework/Services/Registry/ServiceHandle.h"
22 #include "canvas/Persistency/Provenance/FileFormatVersion.h"
23 #include "fhiclcpp/ParameterSet.h"
64 std::unique_ptr<artdaq::hdf5::FragmentDataset>
inputFile_;
79 art::ProductRegistryHelper& help,
80 art::SourceHelper
const& pm)
89 volatile bool keep_looping =
true;
95 art::ServiceHandle<ArtdaqFragmentNamingServiceInterface> translator;
96 inputFile_ = artdaq::hdf5::MakeDatasetPlugin(ps,
"dataset");
98 help.reconstitutes<Fragments, art::InEvent>(
pretend_module_name, translator->GetUnidentifiedInstanceName());
101 help.reconstitutes<Fragments, art::InRun>(
pretend_module_name, translator->GetUnidentifiedInstanceName());
102 help.reconstitutes<Fragments, art::InSubRun>(
pretend_module_name, translator->GetUnidentifiedInstanceName());
108 metricMan->initialize(ps.get<fhicl::ParameterSet>(
"metrics", fhicl::ParameterSet()),
"art");
109 metricMan->do_start();
114 artdaq::ExceptionHandler(artdaq::ExceptionHandlerRethrow::no,
"Error loading metrics in HDFFileReader()");
117 std::set<std::string> instance_names = translator->GetAllProductInstanceNames();
118 for (
const auto& set_iter : instance_names)
123 TLOG_INFO(
"HDFFileReader") <<
"HDFFileReader initialized with ParameterSet: " << ps.to_string();
140 void readFile(std::string
const&, art::FileBlock*& fb)
142 TLOG_ARB(5,
"HDFFileReader") <<
"readFile enter/start";
143 fb =
new art::FileBlock(art::FileFormatVersion(1,
"RawEvent2011"),
"nothing");
152 TLOG(TLVL_DEBUG,
"HDFFileReader") <<
"hasMoreData returning " << std::boolalpha << !
shutdownMsgReceived;
166 bool readNext(art::RunPrincipal*
const& inR, art::SubRunPrincipal*
const& inSR, art::RunPrincipal*& outR,
167 art::SubRunPrincipal*& outSR, art::EventPrincipal*& outE)
169 TLOG_DEBUG(
"HDFFileReader") <<
"readNext BEGIN";
170 art::ServiceHandle<ArtdaqFragmentNamingServiceInterface> translator;
184 TLOG_INFO(
"HDFFileReader") <<
"Shutdown Message received, returning false (should exit art)";
188 auto read_start_time = std::chrono::steady_clock::now();
190 std::unordered_map<artdaq::Fragment::type_t, std::unique_ptr<artdaq::Fragments>> eventMap =
inputFile_->readNextEvent();
191 if (eventMap.empty())
193 TLOG_ERROR(
"HDFFileReader") <<
"No data received, either because of incompatible plugin or end of file. Returning false (should exit art)";
198 auto got_event_time = std::chrono::steady_clock::now();
199 auto firstFragmentType = eventMap.begin()->first;
200 TLOG_DEBUG(
"HDFFileReader") <<
"First Fragment type is " <<
static_cast<int>(firstFragmentType) <<
" ("
201 << translator->GetInstanceNameForType(firstFragmentType) <<
")";
207 if (firstFragmentType == Fragment::EndOfDataFragmentType)
209 TLOG_DEBUG(
"HDFFileReader") <<
"Received shutdown message, returning false";
214 auto evtHeader =
inputFile_->getEventHeader(eventMap.begin()->second->at(0).sequenceID());
215 if (evtHeader ==
nullptr)
217 TLOG_DEBUG(
"HDFFileReader") <<
"Did not receive Event Header for sequence ID " << eventMap.begin()->second->at(0).sequenceID() <<
", skipping event";
222 TLOG_TRACE(
"HDFFileReader") <<
"EventHeader has Run " << evtHeader->run_id <<
", SubRun " << evtHeader->subrun_id <<
", Event " << evtHeader->event_id <<
", SeqID " << evtHeader->sequence_id <<
", IsComplete " << evtHeader->is_complete;
227 art::Timestamp currentTime = 0;
229 art::TimeValue_t lo_res_time = time(0);
230 TLOG_ARB(15,
"HDFFileReader") <<
"lo_res_time = " << lo_res_time;
231 currentTime = ((lo_res_time & 0xffffffff) << 32);
233 timespec hi_res_time;
234 int retcode = clock_gettime(CLOCK_REALTIME, &hi_res_time);
235 TLOG_ARB(15,
"HDFFileReader") <<
"hi_res_time tv_sec = " << hi_res_time.tv_sec
236 <<
" tv_nsec = " << hi_res_time.tv_nsec <<
" (retcode = " << retcode <<
")";
239 currentTime = ((hi_res_time.tv_sec & 0xffffffff) << 32) | (hi_res_time.tv_nsec & 0xffffffff);
243 TLOG_ERROR(
"HDFFileReader")
244 <<
"Unable to fetch a high-resolution time with clock_gettime for art::Event Timestamp. "
245 <<
"The art::Event Timestamp will be zero for event " << evtHeader->event_id;
249 if (inR ==
nullptr || inR->run() != evtHeader->run_id)
251 outR =
pmaker.makeRunPrincipal(evtHeader->run_id, currentTime);
254 if (firstFragmentType == Fragment::EndOfRunFragmentType)
256 art::EventID
const evid(art::EventID::flushEvent());
257 outR =
pmaker.makeRunPrincipal(evid.runID(), currentTime);
258 outSR =
pmaker.makeSubRunPrincipal(evid.subRunID(), currentTime);
259 outE =
pmaker.makeEventPrincipal(evid, currentTime);
262 else if (firstFragmentType == Fragment::EndOfSubrunFragmentType)
265 if (inR ==
nullptr || inR->run() != evtHeader->run_id)
267 outSR =
pmaker.makeSubRunPrincipal(evtHeader->run_id, evtHeader->subrun_id, currentTime);
269 art::EventID
const evid(art::EventID::flushEvent(outSR->subRunID()));
271 outE =
pmaker.makeEventPrincipal(evid, currentTime);
280 if (inSR !=
nullptr && !inSR->subRunID().isFlush() && inSR->subRun() == evtHeader->subrun_id)
283 art::EventID
const evid(art::EventID::flushEvent(inR->runID()));
285 outSR =
pmaker.makeSubRunPrincipal(evid.subRunID(), currentTime);
286 outE =
pmaker.makeEventPrincipal(evid, currentTime);
293 outSR =
pmaker.makeSubRunPrincipal(evtHeader->run_id, evtHeader->subrun_id, currentTime);
295 art::EventID
const evid(art::EventID::flushEvent(outSR->subRunID()));
297 outE =
pmaker.makeEventPrincipal(evid, currentTime);
308 art::SubRunID subrun_check(evtHeader->run_id, evtHeader->subrun_id);
310 if (inSR ==
nullptr || subrun_check != inSR->subRunID())
313 outSR =
pmaker.makeSubRunPrincipal(evtHeader->run_id, evtHeader->subrun_id, currentTime);
315 outE =
pmaker.makeEventPrincipal(evtHeader->run_id, evtHeader->subrun_id, evtHeader->event_id, currentTime);
318 for (
auto& fragmentTypePair : eventMap)
320 auto type_code = fragmentTypePair.first;
321 TLOG_TRACE(
"HDFFileReader") <<
"Before GetFragmentsByType call, type is " <<
static_cast<int>(type_code);
322 TLOG_TRACE(
"HDFFileReader") <<
"After GetFragmentsByType call, number of fragments is " << fragmentTypePair.second->size();
324 std::unordered_map<std::string, std::unique_ptr<Fragments>> derived_fragments;
325 for (
auto& frag : *fragmentTypePair.second)
329 std::pair<bool, std::string> instance_name_result =
330 translator->GetInstanceNameForFragment(frag);
331 std::string label = instance_name_result.second;
332 if (!instance_name_result.first)
334 TLOG_WARNING(
"HDFFileReader")
335 <<
"UnknownFragmentType: The product instance name mapping for fragment type \"" <<
static_cast<int>(type_code)
336 <<
"\" is not known. Fragments of this "
337 <<
"type will be stored in the event with an instance name of \"" << label <<
"\".";
339 if (!derived_fragments.count(label))
341 derived_fragments[label] = std::make_unique<Fragments>();
343 auto fragSize = frag.size();
344 TLOG_TRACE(
"HDFFileReader") <<
"Moving Fragment with size " << fragSize <<
" from type map (type=" << type_code <<
") to derived map label=" << label;
345 derived_fragments[label]->emplace_back(std::move(frag));
347 TLOG_TRACE(
"HDFFileReader") <<
"Placing derived fragments in outE";
348 for (
auto& type : derived_fragments)
350 put_product_in_principal(std::move(type.second),
356 TLOG_TRACE(
"HDFFileReader") <<
"After putting fragments in event";
358 auto read_finish_time = std::chrono::steady_clock::now();
359 TLOG_ARB(10,
"HDFFileReader") <<
"readNext: bytesRead=" <<
bytesRead <<
" metricMan=" <<
static_cast<void*
>(metricMan.get());
362 metricMan->sendMetric(
"Avg Processing Time", artdaq::TimeUtils::GetElapsedTime(
last_read_time, read_start_time),
363 "s", 2, MetricMode::Average);
364 metricMan->sendMetric(
"Avg Input Wait Time", artdaq::TimeUtils::GetElapsedTime(read_start_time, got_event_time),
365 "s", 3, MetricMode::Average);
366 metricMan->sendMetric(
"Avg Read Time", artdaq::TimeUtils::GetElapsedTime(got_event_time, read_finish_time),
"s",
367 3, MetricMode::Average);
368 metricMan->sendMetric(
"bytesRead",
bytesRead,
"B", 3, MetricMode::LastPoint);
371 TLOG_TRACE(
"HDFFileReader") <<
"Returning from readNext";
The HDFFileReader is a class which implements the methods needed by art::Source.
art::SourceHelper const & pmaker
An art::SourceHelper instance.
bool readNext(art::RunPrincipal *const &inR, art::SubRunPrincipal *const &inSR, art::RunPrincipal *&outR, art::SubRunPrincipal *&outSR, art::EventPrincipal *&outE)
Dequeue a RawEvent and declare its Fragment contents to art, creating Run, SubRun, and EventPrincipal objects as necessary.
HDFFileReader(HDFFileReader const &)=delete
Copy Constructor is deleted.
std::string pretend_module_name
The module name to store data under.
HDFFileReader(fhicl::ParameterSet const &ps, art::ProductRegistryHelper &help, art::SourceHelper const &pm)
HDFFileReader Constructor.
HDFFileReader & operator=(HDFFileReader const &)=delete
Copy Assignment operator is deleted.
bool shutdownMsgReceived
Whether a shutdown message has been received.
void readFile(std::string const &, art::FileBlock *&fb)
Emulate opening a file.
std::unique_ptr< artdaq::hdf5::FragmentDataset > inputFile_
The Dataset plugin which this input source will be reading from.
virtual ~HDFFileReader()
HDFFileReader destructor.
size_t bytesRead
running total of number of bytes received
unsigned readNext_calls_
The number of times readNext has been called.
void closeCurrentFile()
Emulate closing a file. No-Op.
std::chrono::steady_clock::time_point last_read_time
Time last read was completed.
bool hasMoreData() const
Whether more data is expected from the HDFFileReader.