TimingHardwareManagerBase.hpp

Go to the documentation of this file.

 
#ifndef TIMINGLIBS_SRC_TIMINGHARDWAREMANAGER_HPP_
#define TIMINGLIBS_SRC_TIMINGHARDWAREMANAGER_HPP_
 
#include "InfoGatherer.hpp"
#include "timinglibs/TimingHardwareInterface.hpp"
#include "timinglibs/TimingIssues.hpp"
#include "timinglibs/timingcmd/Nljs.hpp"
#include "timinglibs/timingcmd/Structs.hpp"
#include "timinglibs/timingcmd/msgp.hpp"
 
#include "appfwk/DAQModule.hpp"
#include "ers/Issue.hpp"
#include "iomanager/Receiver.hpp"
#include "logging/Logging.hpp"
 
#include "timinglibs/dal/TimingHardwareManagerConf.hpp"
#include "confmodel/Connection.hpp"
 
#include "timing/TimingNode.hpp"
#include "timing/EndpointDesignInterface.hpp"
#include "timing/HSIDesignInterface.hpp"
#include "timing/MasterDesignInterface.hpp"
#include "timing/TopDesignInterface.hpp"
 
#include "uhal/ConnectionManager.hpp"
#include "utilities/WorkerThread.hpp"
 
#include <map>
#include <memory>
#include <regex>
#include <string>
#include <vector>
 
namespace dunedaq {
namespace timinglibs {
 
class TimingHardwareManagerBase : public dunedaq::appfwk::DAQModule, public timinglibs::TimingHardwareInterface
{
public:
  explicit TimingHardwareManagerBase(const std::string& name);
 
  TimingHardwareManagerBase(const TimingHardwareManagerBase&) = delete; 
  TimingHardwareManagerBase& operator=(const TimingHardwareManagerBase&) =
    delete;                                                
  TimingHardwareManagerBase(TimingHardwareManagerBase&&) = delete; 
  TimingHardwareManagerBase& operator=(TimingHardwareManagerBase&&) = delete; 
  virtual ~TimingHardwareManagerBase() {}
  
  void init(std::shared_ptr<appfwk::ConfigurationManager> mcfg) override;
  virtual void conf(const nlohmann::json& data);
 
protected:
  // Commands
  //  virtual void do_configure(const nlohmann::json&);
  //  virtual void do_start(const nlohmann::json&);
  //  virtual void do_stop(const nlohmann::json&);
  virtual void do_scrap(const nlohmann::json&);
 
 
  virtual void process_hardware_command(timingcmd::TimingHwCmd& timing_hw_cmd);
 
  // Configuration
  std::string m_hw_cmd_connection;
  using source_t = dunedaq::iomanager::ReceiverConcept<timingcmd::TimingHwCmd>;
  std::shared_ptr<source_t> m_hw_command_receiver;
 
  // hardware polling intervals [us]
  // TODO change to duration::milliseconds
  uint m_gather_interval;
  uint m_gather_interval_debug;
 
  // uhal members
  std::map<std::string, std::unique_ptr<uhal::HwInterface>> m_hw_device_map;
  std::mutex m_hw_device_map_mutex;
 
  // managed timing devices
  std::string m_monitored_device_name_master;
  std::map<uint, std::string> m_monitored_device_names_fanout;
  std::string m_monitored_device_name_endpoint;
  std::string m_monitored_device_name_hsi;
 
  virtual void register_common_hw_commands_for_design() = 0;
  virtual void register_master_hw_commands_for_design() = 0;
  virtual void register_endpoint_hw_commands_for_design() = 0;
  virtual void register_hsi_hw_commands_for_design() = 0;
 
  // retrieve top level/design object for a timing device
  template<class TIMING_DEV>
  TIMING_DEV get_timing_device(const std::string& device_name);
  const timing::TimingNode* get_timing_device_plain(const std::string& device_name);
 
  // timing hw cmds stuff
  std::map<timingcmd::TimingHwCmdId, std::function<void(const timingcmd::TimingHwCmd&)>> m_timing_hw_cmd_map_;
 
  template<typename Child>
  void register_timing_hw_command(const std::string& hw_cmd_id, void (Child::*f)(const timingcmd::TimingHwCmd&));
 
  // timing common commands
  void io_reset(const timingcmd::TimingHwCmd& hw_cmd);
  void print_status(const timingcmd::TimingHwCmd& hw_cmd);
 
  // timing master commands
  void set_timestamp(const timingcmd::TimingHwCmd& hw_cmd);
  void set_endpoint_delay(const timingcmd::TimingHwCmd& hw_cmd);
  void send_fl_cmd(const timingcmd::TimingHwCmd& hw_cmd);
  void master_endpoint_scan(const timingcmd::TimingHwCmd& hw_cmd);
 
  // timing partition commands
  virtual void partition_configure(const timingcmd::TimingHwCmd& hw_cmd) = 0;
 
  // timing endpoint commands
  void endpoint_enable(const timingcmd::TimingHwCmd& hw_cmd);
  void endpoint_disable(const timingcmd::TimingHwCmd& hw_cmd);
  void endpoint_reset(const timingcmd::TimingHwCmd& hw_cmd);
 
  // hsi
  void hsi_reset(const timingcmd::TimingHwCmd& hw_cmd);
  void hsi_configure(const timingcmd::TimingHwCmd& hw_cmd);
  void hsi_start(const timingcmd::TimingHwCmd& hw_cmd);
  void hsi_stop(const timingcmd::TimingHwCmd& hw_cmd);
  void hsi_print_status(const timingcmd::TimingHwCmd& hw_cmd);
 
  // opmon stuff
  std::atomic<uint64_t> m_received_hw_commands_counter; // NOLINT(build/unsigned)
  std::atomic<uint64_t> m_accepted_hw_commands_counter; // NOLINT(build/unsigned)
  std::atomic<uint64_t> m_rejected_hw_commands_counter; // NOLINT(build/unsigned)
  std::atomic<uint64_t> m_failed_hw_commands_counter;   // NOLINT(build/unsigned)
 
  // monitoring
  std::map<std::string, std::unique_ptr<InfoGatherer>> m_info_gatherers;
 
  void register_info_gatherer(uint gather_interval, const std::string& device_name, int op_mon_level);
  void gather_monitor_data(InfoGatherer& gatherer);
 
  virtual void start_hw_mon_gathering(const std::string& device_name = "");
  virtual void stop_hw_mon_gathering(const std::string& device_name = "");
  virtual std::vector<std::string> check_hw_mon_gatherer_is_running(const std::string& device_name);
 
  std::mutex m_command_threads_map_mutex;
  std::map<std::string, std::unique_ptr<std::thread>> m_command_threads;
  std::mutex master_sfp_mutex;
  virtual void perform_endpoint_scan(const timingcmd::TimingHwCmd& hw_cmd);
  virtual void clean_endpoint_scan_threads();
  std::unique_ptr<dunedaq::utilities::ReusableThread> m_endpoint_scan_threads_clean_up_thread;
  std::atomic<bool> m_run_endpoint_scan_cleanup_thread;
  const timinglibs::dal::TimingHardwareManagerConf* m_params;
  std::map<uint,int> m_monitored_endpoints_round_trip_times;
};
 
} // namespace timinglibs
} // namespace dunedaq
 
#include "detail/TimingHardwareManagerBase.hxx"
 
#endif // TIMINGLIBS_SRC_TIMINGHARDWAREMANAGER_HPP_
 
// Local Variables:
// c-basic-offset: 2
// End: