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