artdaq  v3_09_00
genToArt.cc
1 // genToArt
3 //
4 // This application is intended to invoke a configurable set of fragment
5 // generators, and funnel the result to an invocation of art. This is
6 // not an MPI application (see caveat below), so is not intended for
7 // high performance production DAQ scenarios -- for that, see the pmt
8 // application driver and its associated applcations boardreader and
9 // eventbuilder.
11 
12 #define TRACE_NAME "genToArt"
13 
14 #include "art/Framework/Art/artapp.h"
15 #include "artdaq-core/Core/SimpleMemoryReader.hh"
16 #include "artdaq-core/Data/Fragment.hh"
17 #include "artdaq-core/Data/detail/RawFragmentHeader.hh"
18 #include "artdaq-core/Generators/FragmentGenerator.hh"
19 #include "artdaq-core/Generators/makeFragmentGenerator.hh"
20 #include "artdaq-core/Utilities/SimpleLookupPolicy.hh"
21 #include "artdaq/DAQdata/GenericFragmentSimulator.hh"
22 #include "artdaq/DAQrate/SharedMemoryEventManager.hh"
23 #include "artdaq/Generators/CommandableFragmentGenerator.hh"
24 #include "canvas/Utilities/Exception.h"
25 #include "cetlib/container_algorithms.h"
26 #include "fhiclcpp/ParameterSet.h"
27 #include "fhiclcpp/make_ParameterSet.h"
28 
29 #include <boost/program_options.hpp>
30 
31 #include <deque>
32 #include <iostream>
33 #include <map>
34 #include <memory>
35 #include <string>
36 #include <utility>
37 
38 namespace bpo = boost::program_options;
39 
40 namespace {
48 int process_cmd_line(int argc, char** argv,
49  bpo::variables_map& vm)
50 {
51  std::ostringstream descstr;
52  descstr << *argv
53  << " <-c <config-file>> <other-options> [<source-file>]+";
54  bpo::options_description desc(descstr.str());
55  desc.add_options()("config,c", bpo::value<std::string>(), "Configuration file.")("help,h", "produce help message");
56  try
57  {
58  bpo::store(bpo::command_line_parser(argc, argv).options(desc).run(), vm);
59  bpo::notify(vm);
60  }
61  catch (bpo::error const& e)
62  {
63  TLOG(TLVL_ERROR) << "Exception from command line processing in " << *argv
64  << ": " << e.what();
65  return -1;
66  }
67  if (vm.count("help") != 0u)
68  {
69  std::cout << desc << std::endl;
70  return 1;
71  }
72  if (vm.count("config") == 0u)
73  {
74  TLOG(TLVL_ERROR) << "Exception from command line processing in " << *argv
75  << ": no configuration file given.\n"
76  << "For usage and an options list, please do '"
77  << *argv << " --help"
78  << "'.";
79  return 2;
80  }
81  return 0;
82 }
83 
89 {
90 public:
96  ThrottledGenerator(std::string const& generator,
97  fhicl::ParameterSet const& ps);
98 
104  bool getNext(artdaq::FragmentPtrs& newFrags);
105 
110  size_t numFragIDs() const;
111 
118  void start(int run, uint64_t timeout, uint64_t timestamp) const
119  {
120  auto gen_ptr = dynamic_cast<artdaq::CommandableFragmentGenerator*>(generator_.get());
121  if (gen_ptr != nullptr)
122  {
123  gen_ptr->StartCmd(run, timeout, timestamp);
124  }
125  }
131  void stop(uint64_t timeout, uint64_t timestamp) const
132  {
133  auto gen_ptr = dynamic_cast<artdaq::CommandableFragmentGenerator*>(generator_.get());
134  if (gen_ptr != nullptr)
135  {
136  gen_ptr->StopCmd(timeout, timestamp);
137  }
138  }
139 
140 private:
141  bool generateFragments_();
142 
143  std::unique_ptr<artdaq::FragmentGenerator> generator_;
144  size_t const numFragIDs_;
145  std::map<artdaq::Fragment::fragment_id_t,
146  std::deque<artdaq::FragmentPtr>>
147  frags_;
148 };
149 
150 ThrottledGenerator::
151  ThrottledGenerator(std::string const& generator,
152  fhicl::ParameterSet const& ps)
153  : generator_(artdaq::makeFragmentGenerator(generator, ps))
154  , numFragIDs_(generator_->fragmentIDs().size())
155 
156 {
157  assert(generator_);
158 }
159 
161  getNext(artdaq::FragmentPtrs& newFrags)
162 {
163  if ((!frags_.empty()) && (!frags_.begin()->second.empty()))
164  { // Something stored.
165  for (auto& fQp : frags_)
166  {
167  assert(fQp.second.size());
168  newFrags.emplace_back(std::move(fQp.second.front()));
169  fQp.second.pop_front();
170  }
171  }
172  else
173  { // Need fresh fragments.
174  return generateFragments_() && getNext(newFrags);
175  }
176  return true;
177 }
178 
179 bool ThrottledGenerator::
180  generateFragments_()
181 {
182  artdaq::FragmentPtrs incomingFrags;
183  bool result{false};
184  while ((result = generator_->getNext(incomingFrags)) &&
185  incomingFrags.empty())
186  {
187  }
188  for (auto&& frag : incomingFrags)
189  {
190  frags_[frag->fragmentID()].emplace_back(std::move(frag));
191  }
192  return result;
193 }
194 
195 size_t
197  numFragIDs() const
198 {
199  return numFragIDs_;
200 }
201 
202 // artdaq::FragmentGenerator &
203 // ThrottledGenerator::
204 // generator() const
205 // {
206 // return *generator_;
207 // }
208 
226 int process_data(fhicl::ParameterSet const& pset)
227 {
228  auto const gta_pset = pset.get<fhicl::ParameterSet>("genToArt");
229 
230  // Make the generators based on the configuration.
231  std::vector<ThrottledGenerator> generators;
232 
233  auto const fr_pset = gta_pset.get<std::vector<fhicl::ParameterSet>>("fragment_receivers");
234  generators.reserve(fr_pset.size());
235  for (auto const& gen_ps : fr_pset)
236  {
237  generators.emplace_back(gen_ps.get<std::string>("generator"),
238  gen_ps);
239  }
240 
241  artdaq::FragmentPtrs frags;
242  auto eb_pset = gta_pset.get<fhicl::ParameterSet>("event_builder", {});
243  size_t expected_frags_per_event = 0;
244  for (auto& gen : generators)
245  {
246  gen.start(1000, 0, 0);
247  expected_frags_per_event += gen.numFragIDs();
248  }
249  eb_pset.put_or_replace<size_t>("expected_fragments_per_event", expected_frags_per_event);
250 
251  artdaq::SharedMemoryEventManager store(eb_pset, pset);
252  store.startRun(gta_pset.get<int>("run_number", 1000));
253 
254  auto const events_to_generate =
255  gta_pset.get<artdaq::Fragment::sequence_id_t>("events_to_generate", 0xFFFFFFFFFFFFFFFF);
256  auto const reset_sequenceID = pset.get<bool>("reset_sequenceID", true);
257  bool done = false;
258  for (artdaq::Fragment::sequence_id_t event_count = 1;
259  (events_to_generate == 0xFFFFFFFFFFFFFFFF || event_count <= events_to_generate) && (!done);
260  ++event_count)
261  {
262  for (auto& gen : generators)
263  {
264  done |= !gen.getNext(frags);
265  }
266  TLOG(TLVL_TRACE) << "There are " << frags.size() << " Fragments in event " << event_count << ".";
267  artdaq::Fragment::sequence_id_t current_sequence_id = -1;
268  for (auto& val : frags)
269  {
270  if (reset_sequenceID)
271  {
272  TLOG(TLVL_DEBUG) << "Setting fragment sequence id to " << event_count;
273  val->setSequenceID(event_count);
274  }
275  if (current_sequence_id ==
276  static_cast<artdaq::Fragment::sequence_id_t>(-1))
277  {
278  current_sequence_id = val->sequenceID();
279  }
280  else if (val->sequenceID() != current_sequence_id)
281  {
282  throw art::Exception(art::errors::DataCorruption) // NOLINT(cert-err60-cpp)
283  << "Data corruption: apparently related fragments have "
284  << " different sequence IDs: "
285  << val->sequenceID()
286  << " and "
287  << current_sequence_id
288  << ".\n";
289  }
290 
291  auto start_time = std::chrono::steady_clock::now();
292  bool sts = false;
293  auto loop_count = 0;
294  while (!sts)
295  {
296  artdaq::FragmentPtr tempFrag;
297  sts = store.AddFragment(std::move(val), 1000000, tempFrag);
298  if (!sts && event_count <= 10 && loop_count > 100)
299  {
300  TLOG(TLVL_ERROR) << "Fragment was not added after " << artdaq::TimeUtils::GetElapsedTime(start_time) << " s. Check art thread status!";
301  store.endOfData();
302  exit(1);
303  }
304  val = std::move(tempFrag);
305  if (!sts)
306  {
307  loop_count++;
308  usleep(10000);
309  }
310  }
311  }
312  frags.clear();
313  TLOG(TLVL_TRACE) << "Event " << event_count << " END";
314  }
315  for (auto& gen : generators)
316  {
317  gen.stop(0, 0);
318  }
319 
320  bool endSucceeded = store.endOfData();
321  if (endSucceeded)
322  {
323  return 0;
324  }
325 
326  return 15;
327 }
328 } // namespace
329 
330 int main(int argc, char* argv[])
331 try
332 {
333  artdaq::configureMessageFacility("genToArt");
334  // Command line handling.
335  bpo::variables_map vm;
336  auto result = process_cmd_line(argc, argv, vm);
337  if (result != 0)
338  {
339  return (result);
340  }
341  // Read FHiCL configuration file.
342  fhicl::ParameterSet pset;
343  if (getenv("FHICL_FILE_PATH") == nullptr)
344  {
345  TLOG(TLVL_ERROR)
346  << "INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
347  setenv("FHICL_FILE_PATH", ".", 0);
348  }
349  artdaq::SimpleLookupPolicy lookup_policy("FHICL_FILE_PATH");
350  make_ParameterSet(vm["config"].as<std::string>(), lookup_policy, pset);
351  return process_data(pset);
352 }
353 catch (std::exception& x)
354 {
355  TLOG(TLVL_ERROR) << "Exception (type std::exception) caught in genToArt: " << x.what() << '\n';
356  return 1;
357 }
358 catch (...)
359 {
360  return -1;
361 }
void start(int run, uint64_t timeout, uint64_t timestamp) const
Send start signal to FragmentGenerator, if it&#39;s a CommandableFragmentGenerator.
Definition: genToArt.cc:118
The SharedMemoryEventManager is a SharedMemoryManger which tracks events as they are built...
void StopCmd(uint64_t timeout, uint64_t timestamp)
Stop the CommandableFragmentGenerator.
void StartCmd(int run, uint64_t timeout, uint64_t timestamp)
Start the CommandableFragmentGenerator.
int process_cmd_line(int argc, char **argv, bpo::variables_map &vm)
Process the command line.
Definition: genToArt.cc:48
bool getNext(artdaq::FragmentPtrs &newFrags)
Get the next fragment from the generator.
Definition: genToArt.cc:161
CommandableFragmentGenerator is a FragmentGenerator-derived abstract class that defines the interface...
int process_data(fhicl::ParameterSet const &pset)
Run the test, instantiating configured generators and an EventStore.
Definition: genToArt.cc:226
void stop(uint64_t timeout, uint64_t timestamp) const
Send stop signal to FragmentGenerator, if it&#39;s a CommandableFragmentGenerator.
Definition: genToArt.cc:131
size_t numFragIDs() const
Get the number of Fragment IDs handled by this generator.
Definition: genToArt.cc:197
ThrottledGenerator: ensure that we only get one fragment per type at a time from the generator...
Definition: genToArt.cc:88