Line data Source code
1 : ////////////////////////////////////////////////////////////////////////
2 : // 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.
10 : ////////////////////////////////////////////////////////////////////////
11 :
12 : #include "TRACE/tracemf.h"
13 : #define TRACE_NAME "genToArt"
14 :
15 : #include "artdaq-core/Data/Fragment.hh"
16 : #include "artdaq-core/Data/detail/RawFragmentHeader.hh"
17 : #include "artdaq-core/Plugins/FragmentGenerator.hh"
18 : #include "artdaq-core/Plugins/makeFragmentGenerator.hh"
19 : #include "artdaq-core/Utilities/SimpleLookupPolicy.hh"
20 : #include "artdaq/DAQrate/SharedMemoryEventManager.hh"
21 : #include "artdaq/Generators/CommandableFragmentGenerator.hh"
22 : #include "canvas/Utilities/Exception.h"
23 : #include "cetlib/container_algorithms.h"
24 : #include "fhiclcpp/ParameterSet.h"
25 :
26 : #include <boost/program_options.hpp>
27 :
28 : #include <deque>
29 : #include <iostream>
30 : #include <map>
31 : #include <memory>
32 : #include <string>
33 : #include <utility>
34 :
35 : namespace bpo = boost::program_options;
36 :
37 : namespace {
38 : /**
39 : * \brief Process the command line
40 : * \param argc Number of arguments
41 : * \param argv Array of arguments as strings
42 : * \param[out] vm Output boost::program_options::variables_map
43 : * \return 0 if success, -1 if excpetion, 1 if help was requested, and 2 if missing required arguments
44 : */
45 3 : int process_cmd_line(int argc, char** argv,
46 : bpo::variables_map& vm)
47 : {
48 3 : std::ostringstream descstr;
49 : descstr << *argv
50 3 : << " <-c <config-file>> <other-options> [<source-file>]+";
51 3 : bpo::options_description desc(descstr.str());
52 3 : desc.add_options()("config,c", bpo::value<std::string>(), "Configuration file.")("help,h", "produce help message");
53 : try
54 : {
55 3 : bpo::store(bpo::command_line_parser(argc, argv).options(desc).run(), vm);
56 3 : bpo::notify(vm);
57 : }
58 0 : catch (bpo::error const& e)
59 : {
60 0 : TLOG(TLVL_ERROR) << "Exception from command line processing in " << *argv
61 0 : << ": " << e.what();
62 0 : return -1;
63 0 : }
64 9 : if (vm.count("help") != 0u)
65 : {
66 0 : std::cout << desc << std::endl;
67 0 : return 1;
68 : }
69 9 : if (vm.count("config") == 0u)
70 : {
71 0 : TLOG(TLVL_ERROR) << "Exception from command line processing in " << *argv
72 0 : << ": no configuration file given.\n"
73 0 : << "For usage and an options list, please do '"
74 0 : << *argv << " --help"
75 0 : << "'.";
76 0 : return 2;
77 : }
78 3 : return 0;
79 3 : }
80 :
81 : /**
82 : * \brief ThrottledGenerator: ensure that we only get one fragment per type
83 : * at a time from the generator.
84 : */
85 : class ThrottledGenerator
86 : {
87 : public:
88 : /**
89 : * \brief ThrottledGenerator Constructor
90 : * \param generator Name of the generator plugin to load
91 : * \param ps ParameterSet for configuring the FragmentGenerator
92 : */
93 : ThrottledGenerator(std::string const& generator,
94 : fhicl::ParameterSet const& ps);
95 :
96 : /**
97 : * \brief Get the next fragment from the generator
98 : * \param[out] newFrags New Fragment objects are added to this list
99 : * \return Whether there is more data forthcoming
100 : */
101 : bool getNext(artdaq::FragmentPtrs& newFrags);
102 :
103 : /**
104 : * \brief Get the number of Fragment IDs handled by this generator
105 : * \return
106 : */
107 : size_t numFragIDs() const;
108 :
109 : /**
110 : * \brief Send start signal to FragmentGenerator, if it's a CommandableFragmentGenerator
111 : * \param run Run number to pass to StartCmd
112 : * \param timeout Timeout to pass to StartCmd
113 : * \param timestamp Timestamp to pass to StartCmd
114 : */
115 3 : void start(int run, uint64_t timeout, uint64_t timestamp) const
116 : {
117 3 : auto gen_ptr = dynamic_cast<artdaq::CommandableFragmentGenerator*>(generator_.get());
118 3 : if (gen_ptr != nullptr)
119 : {
120 1 : gen_ptr->StartCmd(run, timeout, timestamp);
121 : }
122 3 : }
123 : /**
124 : * \brief Send stop signal to FragmentGenerator, if it's a CommandableFragmentGenerator
125 : * \param timeout Timeout to pass to StopCmd
126 : * \param timestamp Timestamp to pass to StopCmd
127 : */
128 3 : void stop(uint64_t timeout, uint64_t timestamp) const
129 : {
130 3 : auto gen_ptr = dynamic_cast<artdaq::CommandableFragmentGenerator*>(generator_.get());
131 3 : if (gen_ptr != nullptr)
132 : {
133 1 : gen_ptr->StopCmd(timeout, timestamp);
134 : }
135 3 : }
136 :
137 : private:
138 : bool generateFragments_();
139 :
140 : std::unique_ptr<artdaq::FragmentGenerator> generator_;
141 : size_t const numFragIDs_;
142 : std::map<artdaq::Fragment::fragment_id_t,
143 : std::deque<artdaq::FragmentPtr>>
144 : frags_;
145 : };
146 :
147 3 : ThrottledGenerator::
148 : ThrottledGenerator(std::string const& generator,
149 3 : fhicl::ParameterSet const& ps)
150 3 : : generator_(artdaq::makeFragmentGenerator(generator, ps))
151 3 : , numFragIDs_(generator_->fragmentIDs().size())
152 :
153 : {
154 3 : assert(generator_);
155 3 : }
156 :
157 60 : bool ThrottledGenerator::
158 : getNext(artdaq::FragmentPtrs& newFrags)
159 : {
160 60 : if ((!frags_.empty()) && (!frags_.begin()->second.empty()))
161 : { // Something stored.
162 100 : for (auto& fQp : frags_)
163 : {
164 70 : assert(fQp.second.size());
165 70 : newFrags.emplace_back(std::move(fQp.second.front()));
166 70 : fQp.second.pop_front();
167 : }
168 : }
169 : else
170 : { // Need fresh fragments.
171 30 : return generateFragments_() && getNext(newFrags);
172 : }
173 30 : return true;
174 : }
175 :
176 30 : bool ThrottledGenerator::
177 : generateFragments_()
178 : {
179 30 : artdaq::FragmentPtrs incomingFrags;
180 30 : bool result{false};
181 60 : while ((result = generator_->getNext(incomingFrags)) &&
182 30 : incomingFrags.empty())
183 : {
184 : }
185 100 : for (auto&& frag : incomingFrags)
186 : {
187 70 : frags_[frag->fragmentID()].emplace_back(std::move(frag));
188 : }
189 30 : return result;
190 30 : }
191 :
192 : size_t
193 3 : ThrottledGenerator::
194 : numFragIDs() const
195 : {
196 3 : return numFragIDs_;
197 : }
198 :
199 : // artdaq::FragmentGenerator &
200 : // ThrottledGenerator::
201 : // generator() const
202 : // {
203 : // return *generator_;
204 : // }
205 :
206 : /**
207 : * \brief Run the test, instantiating configured generators and an EventStore
208 : * \param pset ParameterSet used to configure genToArt
209 : * \return Art return code, of 15 if EventStore::endOfData fails
210 : *
211 : * \verbatim
212 : * genToArt accepts the following Parameters:
213 : * "reset_sequenceID" (Default: true): Set the sequence IDs on generated Fragment objects to the expected value
214 : * "genToArt" (REQUIRED): FHiCL table containing genToArt parameters
215 : * "fragment_receivers" (REQUIRED): List of FHiCL tables configuring the Fragment receivers
216 : * Each table should contain parameter "generator", the FragmentGenerator plugin to load, and any other parameters that generator requires
217 : * "event_builder" (Default: {}): ParameterSet for EventStore. See documentation for configuration parameters.
218 : * "run_number" (REQUIRED): Run number to use
219 : * "events_to_generate" (Default: -1): Number of events to generate
220 : *
221 : * \endverbatim
222 : */
223 3 : int process_data(fhicl::ParameterSet const& pset)
224 : {
225 3 : auto const gta_pset = pset.get<fhicl::ParameterSet>("genToArt");
226 :
227 : // Make the generators based on the configuration.
228 3 : std::vector<ThrottledGenerator> generators;
229 :
230 3 : auto const fr_pset = gta_pset.get<std::vector<fhicl::ParameterSet>>("fragment_receivers");
231 3 : generators.reserve(fr_pset.size());
232 6 : for (auto const& gen_ps : fr_pset)
233 : {
234 6 : generators.emplace_back(gen_ps.get<std::string>("generator"),
235 : gen_ps);
236 : }
237 :
238 3 : artdaq::FragmentPtrs frags;
239 9 : auto eb_pset = gta_pset.get<fhicl::ParameterSet>("event_builder", {});
240 3 : size_t expected_frags_per_event = 0;
241 6 : for (auto& gen : generators)
242 : {
243 3 : gen.start(1000, 0, 0);
244 3 : expected_frags_per_event += gen.numFragIDs();
245 : }
246 3 : eb_pset.put_or_replace<size_t>("expected_fragments_per_event", expected_frags_per_event);
247 :
248 3 : artdaq::SharedMemoryEventManager store(eb_pset, pset);
249 6 : store.startRun(gta_pset.get<int>("run_number", 1000));
250 :
251 : auto const events_to_generate =
252 6 : gta_pset.get<artdaq::Fragment::sequence_id_t>("events_to_generate", 0xFFFFFFFFFFFFFFFF);
253 6 : auto const reset_sequenceID = pset.get<bool>("reset_sequenceID", true);
254 3 : bool done = false;
255 33 : for (artdaq::Fragment::sequence_id_t event_count = 1;
256 33 : (events_to_generate == 0xFFFFFFFFFFFFFFFF || event_count <= events_to_generate) && (!done);
257 : ++event_count)
258 : {
259 60 : for (auto& gen : generators)
260 : {
261 30 : done |= !gen.getNext(frags);
262 : }
263 60 : TLOG(TLVL_DEBUG + 33) << "There are " << frags.size() << " Fragments in event " << event_count << ".";
264 30 : artdaq::Fragment::sequence_id_t current_sequence_id = -1;
265 100 : for (auto& val : frags)
266 : {
267 70 : if (reset_sequenceID)
268 : {
269 140 : TLOG(TLVL_DEBUG + 32) << "Setting fragment sequence id to " << event_count;
270 70 : val->setSequenceID(event_count);
271 : }
272 70 : if (current_sequence_id ==
273 : static_cast<artdaq::Fragment::sequence_id_t>(-1))
274 : {
275 30 : current_sequence_id = val->sequenceID();
276 : }
277 40 : else if (val->sequenceID() != current_sequence_id)
278 : {
279 0 : throw art::Exception(art::errors::DataCorruption) // NOLINT(cert-err60-cpp)
280 : << "Data corruption: apparently related fragments have "
281 : << " different sequence IDs: "
282 0 : << val->sequenceID()
283 : << " and "
284 : << current_sequence_id
285 0 : << ".\n";
286 : }
287 :
288 70 : auto start_time = std::chrono::steady_clock::now();
289 70 : bool sts = false;
290 70 : auto loop_count = 0;
291 140 : while (!sts)
292 : {
293 70 : artdaq::FragmentPtr tempFrag;
294 70 : sts = store.AddFragment(std::move(val), 1000000, tempFrag);
295 70 : if (!sts && event_count <= 10 && loop_count > 100)
296 : {
297 0 : TLOG(TLVL_ERROR) << "Fragment was not added after " << artdaq::TimeUtils::GetElapsedTime(start_time) << " s. Check art thread status!";
298 0 : store.endOfData();
299 0 : exit(1);
300 : }
301 70 : val = std::move(tempFrag);
302 70 : if (!sts)
303 : {
304 0 : loop_count++;
305 0 : usleep(10000);
306 : }
307 70 : }
308 : }
309 30 : frags.clear();
310 60 : TLOG(TLVL_DEBUG + 33) << "Event " << event_count << " END";
311 : }
312 6 : for (auto& gen : generators)
313 : {
314 3 : gen.stop(0, 0);
315 : }
316 :
317 3 : bool endSucceeded = store.endOfData();
318 3 : if (endSucceeded)
319 : {
320 3 : return 0;
321 : }
322 :
323 0 : return 15;
324 3 : }
325 : } // namespace
326 :
327 3 : int main(int argc, char* argv[])
328 : try
329 : {
330 3 : artdaq::configureMessageFacility("genToArt");
331 : // Command line handling.
332 3 : bpo::variables_map vm;
333 3 : auto result = process_cmd_line(argc, argv, vm);
334 3 : if (result != 0)
335 : {
336 0 : return (result);
337 : }
338 : // Read FHiCL configuration file.
339 3 : if (getenv("FHICL_FILE_PATH") == nullptr)
340 : {
341 0 : TLOG(TLVL_ERROR)
342 0 : << "INFO: environment variable FHICL_FILE_PATH was not set. Using \".\"\n";
343 0 : setenv("FHICL_FILE_PATH", ".", 0);
344 : }
345 6 : artdaq::SimpleLookupPolicy lookup_policy("FHICL_FILE_PATH");
346 3 : auto pset = fhicl::ParameterSet::make(vm["config"].as<std::string>(), lookup_policy);
347 3 : return process_data(pset);
348 3 : }
349 0 : catch (std::exception& x)
350 : {
351 0 : TLOG(TLVL_ERROR) << "Exception (type std::exception) caught in genToArt: " << x.what() << '\n';
352 0 : return 1;
353 0 : }
354 0 : catch (...)
355 : {
356 0 : return -1;
357 0 : }
|
