artdaq  v3_00_01
BoardReaderCore.hh
1 #ifndef artdaq_Application_MPI2_BoardReaderCore_hh
2 #define artdaq_Application_MPI2_BoardReaderCore_hh
3 
4 #include <string>
5 
6 #include "artdaq/Application/CommandableFragmentGenerator.hh"
7 #include "artdaq/Application/Commandable.hh"
8 #include "fhiclcpp/ParameterSet.h"
9 #include "canvas/Persistency/Provenance/RunID.h"
10 #include "artdaq/DAQrate/DataSenderManager.hh"
11 #include "artdaq/Application/StatisticsHelper.hh"
12 #include "artdaq-utilities/Plugins/MetricManager.hh"
13 
14 namespace artdaq
15 {
16  class BoardReaderCore;
17 }
18 
24 {
25 public:
26  static const std::string FRAGMENTS_PROCESSED_STAT_KEY;
27  static const std::string INPUT_WAIT_STAT_KEY;
28  static const std::string BRSYNC_WAIT_STAT_KEY;
29  static const std::string OUTPUT_WAIT_STAT_KEY;
30  static const std::string FRAGMENTS_PER_READ_STAT_KEY;
31 
38  BoardReaderCore(Commandable& parent_application, int rank,
39  std::string name);
40 
44  BoardReaderCore(BoardReaderCore const&) = delete;
45 
49  virtual ~BoardReaderCore();
50 
55  BoardReaderCore& operator=(BoardReaderCore const&) = delete;
56 
74  bool initialize(fhicl::ParameterSet const& pset, uint64_t, uint64_t);
75 
83  bool start(art::RunID id, uint64_t timeout, uint64_t timestamp);
84 
91  bool stop(uint64_t timeout, uint64_t timestamp);
92 
99  bool pause(uint64_t timeout, uint64_t timestamp);
100 
107  bool resume(uint64_t timeout, uint64_t timestamp);
108 
113  bool shutdown(uint64_t);
114 
120  bool soft_initialize(fhicl::ParameterSet const& pset, uint64_t, uint64_t);
121 
127  bool reinitialize(fhicl::ParameterSet const& pset, uint64_t, uint64_t);
128 
135  void process_fragments();
136 
145  std::string report(std::string const& which) const;
146 
151  static DataSenderManager* GetDataSenderManagerPtr() { return sender_ptr_.get(); }
152 
153  size_t GetFragmentsProcessed() { return fragment_count_; }
154 private:
155  Commandable& parent_application_;
156  //MPI_Comm local_group_comm_;
157  std::unique_ptr<CommandableFragmentGenerator> generator_ptr_;
158  art::RunID run_id_;
159  std::string name_;
160 
161  fhicl::ParameterSet data_pset_;
162  int rt_priority_;
163  bool skip_seqId_test_;
164 
165  /* ELF 5/10/2017 Removing in favor of DataReceiverManager source suppression logic
166  int mpi_sync_fragment_interval_;
167  double mpi_sync_wait_threshold_fraction_;
168  int mpi_sync_wait_threshold_count_;
169  size_t mpi_sync_wait_interval_usec_;
170  int mpi_sync_wait_log_level_;
171  int mpi_sync_wait_log_interval_sec_;
172  */
173  static std::unique_ptr<artdaq::DataSenderManager> sender_ptr_;
174 
175  size_t fragment_count_;
176  artdaq::Fragment::sequence_id_t prev_seq_id_;
177  std::atomic<bool> stop_requested_;
178  std::atomic<bool> pause_requested_;
179 
180  // attributes and methods for statistics gathering & reporting
181  artdaq::StatisticsHelper statsHelper_;
182 
183  std::string buildStatisticsString_();
184 
185  artdaq::MetricManager metricMan_;
186 
187  void sendMetrics_();
188 };
189 
190 #endif /* artdaq_Application_MPI2_BoardReaderCore_hh */
This class manages MonitoredQuantity instances for the *Core classes.
BoardReaderCore(Commandable &parent_application, int rank, std::string name)
BoardReaderCore Constructor.
Commandable is the base class for all artdaq components which implement the artdaq state machine...
Definition: Commandable.hh:20
Sends Fragment objects using TransferInterface plugins. Uses Routing Tables if confgiured, otherwise will Round-Robin Fragments to the destinations.
static DataSenderManager * GetDataSenderManagerPtr()
Gets a handle to the DataSenderManager.
static const std::string FRAGMENTS_PROCESSED_STAT_KEY
Key for the Fragments Processed MonitoredQuantity.
static const std::string INPUT_WAIT_STAT_KEY
Key for the Input Wait MonitoredQuantity.
bool stop(uint64_t timeout, uint64_t timestamp)
Stop the BoardReader, and the CommandableFragmentGenerator.
BoardReaderCore implements the state machine for the BoardReader artdaq application. It contains a CommandableFragmentGenerator, which generates Fragments which are then sent to a DataSenderManager by BoardReaderCore.
virtual ~BoardReaderCore()
BoardReaderCore Destructor.
bool reinitialize(fhicl::ParameterSet const &pset, uint64_t, uint64_t)
Reinitialize the BoardReader. No-Op.
bool soft_initialize(fhicl::ParameterSet const &pset, uint64_t, uint64_t)
Soft-Initialize the BoardReader. No-Op.
static const std::string BRSYNC_WAIT_STAT_KEY
Key for the Sync Wait MonitoredQuantity.
static const std::string FRAGMENTS_PER_READ_STAT_KEY
Key for the Fragments Per Read MonitoredQuantity.
static const std::string OUTPUT_WAIT_STAT_KEY
Key for the Output Wait MonitoredQuantity.
bool initialize(fhicl::ParameterSet const &pset, uint64_t, uint64_t)
Initialize the BoardReaderCore.
std::string report(std::string const &which) const
Send a report on a given run-time quantity.
void process_fragments()
Main working loop of the BoardReaderCore.
bool start(art::RunID id, uint64_t timeout, uint64_t timestamp)
Start the BoardReader, and the CommandableFragmentGenerator.
bool resume(uint64_t timeout, uint64_t timestamp)
Resume the BoardReader, and the CommandableFragmentGenerator.
bool pause(uint64_t timeout, uint64_t timestamp)
Pause the BoardReader, and the CommandableFragmentGenerator.
bool shutdown(uint64_t)
Shutdown the BoardReader, and the CommandableFragmentGenerator.
BoardReaderCore & operator=(BoardReaderCore const &)=delete
Copy Assignment Operator is deleted.