artdaq_demo_hdf5  v1_03_00
HDFFileReader.hh
1 #ifndef artdaq_ArtModules_detail_HDFFileReader_hh
2 #define artdaq_ArtModules_detail_HDFFileReader_hh
3 
4 #include "artdaq/DAQdata/Globals.hh"
5 
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"
13 
14 #include "art/Framework/Core/Frameworkfwd.h"
15 
16 #include "art/Framework/Core/FileBlock.h"
17 #include "art/Framework/Core/ProductRegistryHelper.h"
18 #include "art/Framework/IO/Sources/SourceHelper.h"
19 #include "art/Framework/IO/Sources/put_product_in_principal.h"
20 #include "art/Framework/Principal/EventPrincipal.h"
21 #include "art/Framework/Principal/RunPrincipal.h"
22 #include "art/Framework/Principal/SubRunPrincipal.h"
23 #include "art/Framework/Services/Registry/ServiceHandle.h"
24 #include "canvas/Persistency/Provenance/FileFormatVersion.h"
25 #include "fhiclcpp/ParameterSet.h"
26 
27 #include <sys/time.h>
28 #include <map>
29 #include <string>
30 
31 namespace artdaq {
32 namespace detail {
33 
38 {
42  HDFFileReader(HDFFileReader const&) = delete;
43 
48  HDFFileReader& operator=(HDFFileReader const&) = delete;
52  HDFFileReader(HDFFileReader&&) = delete;
53 
59 
60  art::SourceHelper const& pmaker;
61  std::string pretend_module_name;
63  size_t bytesRead;
64  std::chrono::steady_clock::time_point last_read_time;
65  unsigned readNext_calls_;
66  std::unique_ptr<artdaq::hdf5::FragmentDataset> inputFile_;
67 
80  HDFFileReader(fhicl::ParameterSet const& ps,
81  art::ProductRegistryHelper& help,
82  art::SourceHelper const& pm)
83  : pmaker(pm)
84  , pretend_module_name(ps.get<std::string>("raw_data_label", "daq"))
85  , shutdownMsgReceived(false)
86  , bytesRead(0)
87  , last_read_time(std::chrono::steady_clock::now())
88  , readNext_calls_(0)
89  {
90 #if 0
91  volatile bool keep_looping = true;
92  while (keep_looping)
93  {
94  usleep(10000);
95  }
96 #endif
97  art::ServiceHandle<ArtdaqFragmentNamingServiceInterface> translator;
98  inputFile_ = artdaq::hdf5::MakeDatasetPlugin(ps, "dataset");
99 
100  help.reconstitutes<Fragments, art::InEvent>(pretend_module_name, translator->GetUnidentifiedInstanceName());
101 
102  // Workaround for #22979
103  help.reconstitutes<Fragments, art::InRun>(pretend_module_name, translator->GetUnidentifiedInstanceName());
104  help.reconstitutes<Fragments, art::InSubRun>(pretend_module_name, translator->GetUnidentifiedInstanceName());
105 
106  try
107  {
108  if (metricMan)
109  {
110  metricMan->initialize(ps.get<fhicl::ParameterSet>("metrics", fhicl::ParameterSet()), "art");
111  metricMan->do_start();
112  }
113  }
114  catch (...)
115  {
116  artdaq::ExceptionHandler(artdaq::ExceptionHandlerRethrow::no, "Error loading metrics in HDFFileReader()");
117  }
118 
119  std::set<std::string> instance_names = translator->GetAllProductInstanceNames();
120  for (const auto& set_iter : instance_names)
121  {
122  help.reconstitutes<Fragments, art::InEvent>(pretend_module_name, set_iter);
123  }
124 
125  TLOG_INFO("HDFFileReader") << "HDFFileReader initialized with ParameterSet: " << ps.to_string();
126  }
127 
131  virtual ~HDFFileReader() {}
132 
137 
142  void readFile(std::string const&, art::FileBlock*& fb)
143  {
144  TLOG_ARB(5, "HDFFileReader") << "readFile enter/start";
145  fb = new art::FileBlock(art::FileFormatVersion(1, "RawEvent2011"), "nothing");
146  }
147 
152  bool hasMoreData() const
153  {
154  TLOG(TLVL_DEBUG, "HDFFileReader") << "hasMoreData returning " << std::boolalpha << !shutdownMsgReceived;
155  return (!shutdownMsgReceived);
156  }
157 
168  bool readNext(art::RunPrincipal* const& inR, art::SubRunPrincipal* const& inSR, art::RunPrincipal*& outR,
169  art::SubRunPrincipal*& outSR, art::EventPrincipal*& outE)
170  {
171  TLOG_DEBUG("HDFFileReader") << "readNext BEGIN";
172  art::ServiceHandle<ArtdaqFragmentNamingServiceInterface> translator;
173 
174  // Establish default 'results'
175  outR = nullptr;
176  outSR = nullptr;
177  outE = nullptr;
178  // Try to get an event from the queue. We'll continuously loop, either until:
179  // 1) we have read a RawEvent off the queue, or
180  // 2) we have timed out, AND we are told the when we timeout we
181  // should stop.
182  // In any case, if we time out, we emit an informational message.
183 
185  {
186  TLOG_INFO("HDFFileReader") << "Shutdown Message received, returning false (should exit art)";
187  return false;
188  }
189 
190  auto read_start_time = std::chrono::steady_clock::now();
191 
192  std::unordered_map<artdaq::Fragment::type_t, std::unique_ptr<artdaq::Fragments>> eventMap = inputFile_->readNextEvent();
193  if (eventMap.empty())
194  {
195  TLOG_ERROR("HDFFileReader") << "No data received, either because of incompatible plugin or end of file. Returning false (should exit art)";
196  shutdownMsgReceived = true;
197  return false;
198  }
199 
200  auto got_event_time = std::chrono::steady_clock::now();
201  auto firstFragmentType = eventMap.begin()->first;
202  TLOG_DEBUG("HDFFileReader") << "First Fragment type is " << static_cast<int>(firstFragmentType) << " ("
203  << translator->GetInstanceNameForType(firstFragmentType) << ")";
204  // We return false, indicating we're done reading, if:
205  // 1) we did not obtain an event, because we timed out and were
206  // configured NOT to keep trying after a timeout, or
207  // 2) the event we read was the end-of-data marker: a null
208  // pointer
209  if (firstFragmentType == Fragment::EndOfDataFragmentType)
210  {
211  TLOG_DEBUG("HDFFileReader") << "Received shutdown message, returning false";
212  shutdownMsgReceived = true;
213  return false;
214  }
215 
216  auto evtHeader = inputFile_->getEventHeader(eventMap.begin()->second->at(0).sequenceID());
217  if (evtHeader == nullptr)
218  {
219  TLOG_DEBUG("HDFFileReader") << "Did not receive Event Header for sequence ID " << eventMap.begin()->second->at(0).sequenceID() << ", skipping event";
220  return true;
221  }
222  else
223  {
224  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;
225  }
226  // Check the number of fragments in the RawEvent. If we have a single
227  // fragment and that fragment is marked as EndRun or EndSubrun we'll create
228  // the special principals for that.
229  art::Timestamp currentTime = 0;
230 #if 0
231  art::TimeValue_t lo_res_time = time(0);
232  TLOG_ARB(15, "HDFFileReader") << "lo_res_time = " << lo_res_time;
233  currentTime = ((lo_res_time & 0xffffffff) << 32);
234 #endif
235  timespec hi_res_time;
236  int retcode = clock_gettime(CLOCK_REALTIME, &hi_res_time);
237  TLOG_ARB(15, "HDFFileReader") << "hi_res_time tv_sec = " << hi_res_time.tv_sec
238  << " tv_nsec = " << hi_res_time.tv_nsec << " (retcode = " << retcode << ")";
239  if (retcode == 0)
240  {
241  currentTime = ((hi_res_time.tv_sec & 0xffffffff) << 32) | (hi_res_time.tv_nsec & 0xffffffff);
242  }
243  else
244  {
245  TLOG_ERROR("HDFFileReader")
246  << "Unable to fetch a high-resolution time with clock_gettime for art::Event Timestamp. "
247  << "The art::Event Timestamp will be zero for event " << evtHeader->event_id;
248  }
249 
250  // make new run if inR is 0 or if the run has changed
251  if (inR == nullptr || inR->run() != evtHeader->run_id)
252  {
253  outR = pmaker.makeRunPrincipal(evtHeader->run_id, currentTime);
254  }
255 
256  if (firstFragmentType == Fragment::EndOfRunFragmentType)
257  {
258  art::EventID const evid(art::EventID::flushEvent());
259  outR = pmaker.makeRunPrincipal(evid.runID(), currentTime);
260  outSR = pmaker.makeSubRunPrincipal(evid.subRunID(), currentTime);
261  outE = pmaker.makeEventPrincipal(evid, currentTime);
262  return true;
263  }
264  else if (firstFragmentType == Fragment::EndOfSubrunFragmentType)
265  {
266  // Check if inR == 0 or is a new run
267  if (inR == nullptr || inR->run() != evtHeader->run_id)
268  {
269  outSR = pmaker.makeSubRunPrincipal(evtHeader->run_id, evtHeader->subrun_id, currentTime);
270 
271  art::EventID const evid(art::EventID::flushEvent(outSR->subRunID()));
272 
273  outE = pmaker.makeEventPrincipal(evid, currentTime);
274  }
275  else
276  {
277  // If the previous subrun was neither 0 nor flush and was identical with the current
278  // subrun, then it must have been associated with a data event. In that case, we need
279  // to generate a flush event with a valid run but flush subrun and event number in order
280  // to end the subrun.
281 
282  if (inSR != nullptr && !inSR->subRunID().isFlush() && inSR->subRun() == evtHeader->subrun_id)
283 
284  {
285  art::EventID const evid(art::EventID::flushEvent(inR->runID()));
286 
287  outSR = pmaker.makeSubRunPrincipal(evid.subRunID(), currentTime);
288  outE = pmaker.makeEventPrincipal(evid, currentTime);
289  // If this is either a new or another empty subrun, then generate a flush event with
290  // valid run and subrun numbers but flush event number
291  //} else if(inSR==0 || inSR->id().isFlush()){
292  }
293  else
294  {
295  outSR = pmaker.makeSubRunPrincipal(evtHeader->run_id, evtHeader->subrun_id, currentTime);
296 
297  art::EventID const evid(art::EventID::flushEvent(outSR->subRunID()));
298 
299  outE = pmaker.makeEventPrincipal(evid, currentTime);
300  // Possible error condition
301  //} else {
302  }
303  outR = nullptr;
304  }
305  // outputFileCloseNeeded = true;
306  return true;
307  }
308 
309  // make new subrun if inSR is 0 or if the subrun has changed
310  art::SubRunID subrun_check(evtHeader->run_id, evtHeader->subrun_id);
311 
312  if (inSR == nullptr || subrun_check != inSR->subRunID())
313  {
314 
315  outSR = pmaker.makeSubRunPrincipal(evtHeader->run_id, evtHeader->subrun_id, currentTime);
316  }
317  outE = pmaker.makeEventPrincipal(evtHeader->run_id, evtHeader->subrun_id, evtHeader->event_id, currentTime);
318 
319  // insert the Fragments of each type into the EventPrincipal
320  for (auto& fragmentTypePair : eventMap)
321  {
322  auto type_code = fragmentTypePair.first;
323  TLOG_TRACE("HDFFileReader") << "Before GetFragmentsByType call, type is " << static_cast<int>(type_code);
324  TLOG_TRACE("HDFFileReader") << "After GetFragmentsByType call, number of fragments is " << fragmentTypePair.second->size();
325 
326  std::unordered_map<std::string, std::unique_ptr<Fragments>> derived_fragments;
327  for (auto& frag : *fragmentTypePair.second)
328  {
329  bytesRead += frag.sizeBytes();
330 
331  std::pair<bool, std::string> instance_name_result =
332  translator->GetInstanceNameForFragment(frag);
333  std::string label = instance_name_result.second;
334  if (!instance_name_result.first)
335  {
336  TLOG_WARNING("HDFFileReader")
337  << "UnknownFragmentType: The product instance name mapping for fragment type \"" << static_cast<int>(type_code)
338  << "\" is not known. Fragments of this "
339  << "type will be stored in the event with an instance name of \"" << label << "\".";
340  }
341  if (!derived_fragments.count(label))
342  {
343  derived_fragments[label] = std::make_unique<Fragments>();
344  }
345  auto fragSize = frag.size();
346  TLOG_TRACE("HDFFileReader") << "Moving Fragment with size " << fragSize << " from type map (type=" << type_code << ") to derived map label=" << label;
347  derived_fragments[label]->emplace_back(std::move(frag));
348  }
349  TLOG_TRACE("HDFFileReader") << "Placing derived fragments in outE";
350  for (auto& type : derived_fragments)
351  {
352  put_product_in_principal(std::move(type.second),
353  *outE,
355  type.first);
356  }
357  }
358  TLOG_TRACE("HDFFileReader") << "After putting fragments in event";
359 
360  auto read_finish_time = std::chrono::steady_clock::now();
361  TLOG_ARB(10, "HDFFileReader") << "readNext: bytesRead=" << bytesRead << " metricMan=" << static_cast<void*>(metricMan.get());
362  if (metricMan)
363  {
364  metricMan->sendMetric("Avg Processing Time", artdaq::TimeUtils::GetElapsedTime(last_read_time, read_start_time),
365  "s", 2, MetricMode::Average);
366  metricMan->sendMetric("Avg Input Wait Time", artdaq::TimeUtils::GetElapsedTime(read_start_time, got_event_time),
367  "s", 3, MetricMode::Average);
368  metricMan->sendMetric("Avg Read Time", artdaq::TimeUtils::GetElapsedTime(got_event_time, read_finish_time), "s",
369  3, MetricMode::Average);
370  metricMan->sendMetric("bytesRead", bytesRead, "B", 3, MetricMode::LastPoint);
371  }
372 
373  TLOG_TRACE("HDFFileReader") << "Returning from readNext";
374  last_read_time = std::chrono::steady_clock::now();
375  return true;
376  }
377 };
378 } // namespace detail
379 } // namespace artdaq
380 
381 #endif /* artdaq_ArtModules_detail_HDFFileReader_hh */
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.