TriggerGenericMaker.hpp

Go to the documentation of this file.

 
#ifndef TRIGGER_SRC_TRIGGER_TRIGGERGENERICMAKER_HPP_
#define TRIGGER_SRC_TRIGGER_TRIGGERGENERICMAKER_HPP_
 
#include "trigger/Issues.hpp"
#include "trigger/Set.hpp"
#include "trigger/TimeSliceInputBuffer.hpp"
#include "trigger/TimeSliceOutputBuffer.hpp"
#include "trigger/triggergenericmakerinfo/InfoNljs.hpp"
 
#include "appfwk/DAQModule.hpp"
#include "daqdataformats/SourceID.hpp"
#include "dfmessages/Types.hpp"
#include "iomanager/IOManager.hpp"
#include "iomanager/Receiver.hpp"
#include "iomanager/Sender.hpp"
#include "logging/Logging.hpp"
#include "trgdataformats/Types.hpp"
#include "utilities/WorkerThread.hpp"
 
#include <algorithm>
#include <memory>
#include <string>
#include <vector>
 
namespace dunedaq::trigger {
 
// Forward declare the class encapsulating partial specifications of do_work
template<class IN, class OUT, class MAKER>
class TriggerGenericWorker;
 
// This template class reads IN items from queues, passes them to MAKER objects,
// and writes the resulting OUT objects to another queue. The behavior of
// passing IN objects to the MAKER and creating OUT objects from the MAKER is
// encapsulated by TriggerGenericWorker<IN,OUT,MAKER> templates, defined later
// in this file
template<class IN, class OUT, class MAKER>
class TriggerGenericMaker : public dunedaq::appfwk::DAQModule
{
  friend class TriggerGenericWorker<IN, OUT, MAKER>;
 
public:
  explicit TriggerGenericMaker(const std::string& name)
    : DAQModule(name)
    , m_thread(std::bind(&TriggerGenericMaker::do_work, this, std::placeholders::_1))
    , m_received_count(0)
    , m_sent_count(0)
    , m_run_number(0)
    , m_input_queue(nullptr)
    , m_output_queue(nullptr)
    , m_queue_timeout(100)
    , m_algorithm_name("[uninitialized]")
    , m_sourceid(dunedaq::daqdataformats::SourceID::s_invalid_id)
    , m_buffer_time(0)
    , m_window_time(625000)
    , worker(*this) // should be last; may use other members
  {
    register_command("start", &TriggerGenericMaker::do_start);
    register_command("stop", &TriggerGenericMaker::do_stop);
    register_command("conf", &TriggerGenericMaker::do_configure);
    register_command("scrap", &TriggerGenericMaker::do_scrap);
  }
 
  virtual ~TriggerGenericMaker() {}
 
  TriggerGenericMaker(const TriggerGenericMaker&) = delete;
  TriggerGenericMaker& operator=(const TriggerGenericMaker&) = delete;
  TriggerGenericMaker(TriggerGenericMaker&&) = delete;
  TriggerGenericMaker& operator=(TriggerGenericMaker&&) = delete;
 
  // void init(const CommandData_t& obj) override
  //{
  //   // TODO: Reimplement as OKS
  //   //m_input_queue = get_iom_receiver<IN>(appfwk::connection_uid(obj, "input"));
  //   //m_output_queue = get_iom_sender<OUT>(appfwk::connection_uid(obj, "output"));
  // }
 
  void get_info(opmonlib::InfoCollector& ci, int /*level*/) override
  {
    triggergenericmakerinfo::Info i;
 
    i.received_count = m_received_count.load();
    i.sent_count = m_sent_count.load();
    if (m_maker) {
      i.data_vs_system_ms = m_maker->m_data_vs_system_time;
    } else
      i.data_vs_system_ms = 0;
 
    ci.add(i);
  }
 
protected:
  void set_algorithm_name(const std::string& name) { m_algorithm_name = name; }
 
  // Only applies to makers that output Set<B>
  void set_sourceid(uint32_t element_id) // NOLINT(build/unsigned)
  {
    m_sourceid = element_id;
  }
 
  // Only applies to makers that output Set<B>
  void set_windowing(daqdataformats::timestamp_t window_time, daqdataformats::timestamp_t buffer_time)
  {
    m_window_time = window_time;
    m_buffer_time = buffer_time;
  }
 
private:
  dunedaq::utilities::WorkerThread m_thread;
 
  using metric_counter_type = decltype(triggergenericmakerinfo::Info::received_count);
  std::atomic<metric_counter_type> m_received_count;
  std::atomic<metric_counter_type> m_sent_count;
  dfmessages::run_number_t m_run_number;
 
  using source_t = dunedaq::iomanager::ReceiverConcept<IN>;
  std::shared_ptr<source_t> m_input_queue;
 
  using sink_t = dunedaq::iomanager::SenderConcept<OUT>;
  std::shared_ptr<sink_t> m_output_queue;
 
  std::chrono::milliseconds m_queue_timeout;
 
  std::string m_algorithm_name;
 
  uint32_t m_sourceid; // NOLINT(build/unsigned)
 
  daqdataformats::timestamp_t m_buffer_time;
  daqdataformats::timestamp_t m_window_time;
 
  std::unique_ptr<MAKER> m_maker;
  nlohmann::json m_maker_conf;
 
  TriggerGenericWorker<IN, OUT, MAKER> worker;
 
  // This should return a unique_ptr to the MAKER created from conf command arguments.
  // Should also call set_algorithm_name and set_geoid/set_windowing (if desired)
  virtual std::unique_ptr<MAKER> make_maker(const nlohmann::json& obj) = 0;
 
  void do_start(const CommandData_t& startobj)
  {
    m_received_count = 0;
    m_sent_count = 0;
    m_maker = make_maker(m_maker_conf);
    worker.reconfigure();
    m_thread.start_working_thread(get_name());
    m_run_number = startobj.value<dunedaq::daqdataformats::run_number_t>("run", 0);
  }
 
  void do_stop(const CommandData_t& /*obj*/) { m_thread.stop_working_thread(); }
 
  void do_configure(const CommandData_t& obj)
  {
    // P. Rodrigues 2022-07-13
    // We stash the config here and don't actually create the maker
    // algorithm until start time, so that the algorithm doesn't
    // persist between runs and hold onto its state from the previous
    // run
    m_maker_conf = obj;
 
    // worker should be notified that configuration potentially changed
    worker.reconfigure();
  }
 
  void do_scrap(const CommandData_t& obj)
  {
    m_input_queue.reset();
    m_output_queue.reset();
    m_maker.reset();
    m_maker_conf.clear();
  }
 
  void do_work(std::atomic<bool>& m_running_flag)
  {
    // Loop until a stop is received
    while (m_running_flag.load()) {
      // While there are items in the input queue, continue draining even if
      // the running_flag is false, but stop _immediately_ when input is empty
      IN in;
      while (receive(in)) {
        if (m_running_flag.load()) {
          worker.process(in);
        }
      }
    }
    // P. Rodrigues 2022-06-01. The argument here is whether to drop
    // buffered outputs. We choose 'true' because some significant
    // time can pass between the last input sent by readout and when
    // we receive a stop. (This happens because stop is sent serially
    // to readout units before trigger, and each RU takes ~1s to
    // stop). So by the time we receive a stop command, our buffered
    // outputs are stale and will cause tardy warnings from the zipper
    // downstream
    worker.drain(true);
    TLOG() << get_name() << ": Exiting do_work() method for run " << m_run_number << ", received " << m_received_count
           << " inputs (" << worker.get_low_level_input_count() << " sub-inputs) and successfully sent " << m_sent_count
           << " outputs. ";
    worker.reset();
  }
 
  bool receive(IN& in)
  {
    try {
      in = m_input_queue->receive(m_queue_timeout);
    } catch (const dunedaq::iomanager::TimeoutExpired& excpt) {
      // it is perfectly reasonable that there might be no data in the queue
      // some fraction of the times that we check, so we just continue on and try again
      return false;
    }
    ++m_received_count;
    return true;
  }
 
  bool send(OUT&& out)
  {
    try {
      m_output_queue->send(std::move(out), m_queue_timeout);
    } catch (const dunedaq::iomanager::TimeoutExpired& excpt) {
      ers::warning(excpt);
      return false;
    }
    ++m_sent_count;
    return true;
  }
};
 
// To handle the different unpacking schemes implied by different templates,
// do_work is broken out into its own template class that is a friend of
// TriggerGenericMaker. C++ still does not support partial specification of a
// single method in a template class, so this approach is the least redundant
// way to achieve that functionality
 
// The base template assumes the MAKER has an operator() with the signature
// operator()(IN, std::vector<OUT>)
template<class IN, class OUT, class MAKER>
class TriggerGenericWorker
{
public:
  explicit TriggerGenericWorker(TriggerGenericMaker<IN, OUT, MAKER>& parent)
    : m_parent(parent)
    , m_low_level_input_count(0)
  {
  }
 
  TriggerGenericMaker<IN, OUT, MAKER>& m_parent;
 
  void reconfigure() {}
 
  void reset() { m_low_level_input_count = 0; }
 
  void process(IN& in)
  {
    ++m_low_level_input_count;
    std::vector<OUT> out_vec; // one input -> many outputs
    try {
      m_parent.m_maker->operator()(in, out_vec);
    } catch (...) { // NOLINT TODO Benjamin Land <BenLand100@github.com> May 28-2021 can we restrict the possible
                    // exceptions triggeralgs might raise?
      ers::fatal(AlgorithmFatalError(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
      return;
    }
 
    while (out_vec.size()) {
      if (!m_parent.send(std::move(out_vec.back()))) {
        ers::error(AlgorithmFailedToSend(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
        // out_vec.back() is dropped
      }
      out_vec.pop_back();
    }
  }
 
  void drain(bool) {}
 
  size_t get_low_level_input_count() { return m_low_level_input_count; }
  size_t m_low_level_input_count;
};
 
// Partial specialization for IN = Set<A>, OUT = Set<B> and assumes the MAKER has:
// operator()(A, std::vector<B>)
template<class A, class B, class MAKER>
class TriggerGenericWorker<Set<A>, Set<B>, MAKER>
{
public: // NOLINT
  explicit TriggerGenericWorker(TriggerGenericMaker<Set<A>, Set<B>, MAKER>& parent)
    : m_parent(parent)
    , m_in_buffer(parent.get_name(), parent.m_algorithm_name)
    , m_out_buffer(parent.get_name(), parent.m_algorithm_name, parent.m_buffer_time)
    , m_low_level_input_count(0)
  {
  }
 
  TriggerGenericMaker<Set<A>, Set<B>, MAKER>& m_parent;
 
  TimeSliceInputBuffer<A> m_in_buffer;
  TimeSliceOutputBuffer<B> m_out_buffer;
 
  daqdataformats::timestamp_t m_prev_start_time = 0;
 
  void reconfigure()
  {
    m_out_buffer.set_window_time(m_parent.m_window_time);
    m_out_buffer.set_buffer_time(m_parent.m_buffer_time);
  }
 
  void reset()
  {
    m_prev_start_time = 0;
    m_out_buffer.reset();
    m_low_level_input_count = 0;
  }
 
  void process_slice(const std::vector<A>& time_slice, std::vector<B>& out_vec)
  {
    // time_slice is a full slice (all Set<A> combined), time ordered, vector of A
    // call operator for each of the objects in the vector
    for (const A& x : time_slice) {
      try {
        m_parent.m_maker->operator()(x, out_vec);
      } catch (...) { // NOLINT TODO Benjamin Land <BenLand100@github.com> May 28-2021 can we restrict the possible
                      // exceptions triggeralgs might raise?
        ers::fatal(AlgorithmFatalError(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
        return;
      }
    }
  }
 
  void process(Set<A>& in)
  {
    std::vector<B> elems; // Bs to buffer for the next window
    switch (in.type) {
      case Set<A>::Type::kPayload: {
        if (m_prev_start_time != 0 && in.start_time < m_prev_start_time) {
          ers::warning(OutOfOrderSets(ERS_HERE, m_parent.get_name(), m_prev_start_time, in.start_time));
        }
        m_prev_start_time = in.start_time;
        std::vector<A> time_slice;
        daqdataformats::timestamp_t start_time, end_time;
        if (!m_in_buffer.buffer(in, time_slice, start_time, end_time)) {
          return; // no complete time slice yet (`in` was part of buffered slice)
        }
        m_low_level_input_count += time_slice.size();
        process_slice(time_slice, elems);
      } break;
      case Set<A>::Type::kHeartbeat: {
        // PAR 2022-04-27 We've got a heartbeat for time T, so we know
        // we won't receive any more inputs for times t < T. Therefore
        // we can flush all items in the input buffer, which have
        // times t < T, because the input is time-ordered. We put the
        // heartbeat in the output buffer, which will handle it
        // appropriately
 
        std::vector<A> time_slice;
        daqdataformats::timestamp_t start_time, end_time;
        if (m_in_buffer.flush(time_slice, start_time, end_time)) {
          if (end_time > in.start_time) {
            // This should never happen, but we check here so we at least get some output if it did
            ers::fatal(OutOfOrderSets(ERS_HERE, m_parent.get_name(), end_time, in.start_time));
          }
          m_low_level_input_count += time_slice.size();
          process_slice(time_slice, elems);
        }
 
        Set<B> heartbeat;
        heartbeat.type = Set<B>::Type::kHeartbeat;
        heartbeat.start_time = in.start_time;
        heartbeat.end_time = in.end_time;
        heartbeat.origin = daqdataformats::SourceID(daqdataformats::SourceID::Subsystem::kTrigger, m_parent.m_sourceid);
 
        TLOG_DEBUG(4) << "Buffering heartbeat with start time " << heartbeat.start_time;
        m_out_buffer.buffer_heartbeat(heartbeat);
 
        // flush the maker
        try {
          // TODO Benjamin Land <BenLand100@github.com> July-14-2021 flushed events go into the buffer... until a window
          // is ready?
          m_parent.m_maker->flush(in.end_time, elems);
        } catch (...) { // NOLINT TODO Benjamin Land <BenLand100@github.com> May-28-2021 can we restrict the possible
                        // exceptions triggeralgs might raise?
          ers::fatal(AlgorithmFatalError(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
          return;
        }
      } break;
      case Set<A>::Type::kUnknown:
        ers::error(UnknownSetError(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
        break;
    }
 
    // add new elements to output buffer
    if (elems.size() > 0) {
      m_out_buffer.buffer(elems);
    }
 
    size_t n_output_windows = 0;
    // emit completed windows
    while (m_out_buffer.ready()) {
      ++n_output_windows;
      Set<B> out;
      m_out_buffer.flush(out);
      out.seqno = m_parent.m_sent_count;
      out.origin = daqdataformats::SourceID(daqdataformats::SourceID::Subsystem::kTrigger, m_parent.m_sourceid);
 
      if (out.type == Set<B>::Type::kHeartbeat) {
        TLOG_DEBUG(4) << "Sending heartbeat with start time " << out.start_time;
        if (!m_parent.send(std::move(out))) {
          ers::error(AlgorithmFailedToSend(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
          // out is dropped
        }
      }
      // Only form and send Set<B> if it has a nonzero number of objects
      else if (out.type == Set<B>::Type::kPayload && out.objects.size() != 0) {
        TLOG_DEBUG(4) << "Output set window ready with start time " << out.start_time << " end time " << out.end_time
                      << " and " << out.objects.size() << " members";
        if (!m_parent.send(std::move(out))) {
          ers::error(AlgorithmFailedToSend(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
          // out is dropped
        }
      }
    }
    TLOG_DEBUG(4) << "process() done. Advanced output buffer by " << n_output_windows << " output windows";
  }
 
  void drain(bool drop)
  {
    // First, send anything in the input buffer to the algorithm, and add any
    // results to output buffer
    std::vector<A> time_slice;
    daqdataformats::timestamp_t start_time, end_time;
    if (m_in_buffer.flush(time_slice, start_time, end_time)) {
      std::vector<B> elems;
      m_low_level_input_count += time_slice.size();
      process_slice(time_slice, elems);
      if (elems.size() > 0) {
        m_out_buffer.buffer(elems);
      }
    }
    // Second, drain the output buffer onto the queue. These may not be "fully
    // formed" windows, but at this point we're getting no more data anyway.
    while (!m_out_buffer.empty()) {
      Set<B> out;
      m_out_buffer.flush(out);
      out.seqno = m_parent.m_sent_count;
      out.origin = daqdataformats::SourceID(daqdataformats::SourceID::Subsystem::kTrigger, m_parent.m_sourceid);
 
      if (out.type == Set<B>::Type::kHeartbeat) {
        if (!drop) {
          if (!m_parent.send(std::move(out))) {
            ers::error(AlgorithmFailedToSend(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
            // out is dropped
          }
        }
      }
      // Only form and send Set<B> if it has a nonzero number of objects
      else if (out.type == Set<B>::Type::kPayload && out.objects.size() != 0) {
        TLOG_DEBUG(1) << "Output set window ready with start time " << out.start_time << " end time " << out.end_time
                      << " and " << out.objects.size() << " members";
        if (!drop) {
          if (!m_parent.send(std::move(out))) {
            ers::error(AlgorithmFailedToSend(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
            // out is dropped
          }
        }
      }
    }
  }
 
  size_t get_low_level_input_count() { return m_low_level_input_count; }
  size_t m_low_level_input_count;
};
 
// Partial specialization for IN = Set<A> and assumes the the MAKER has:
// operator()(A, std::vector<OUT>)
template<class A, class OUT, class MAKER>
class TriggerGenericWorker<Set<A>, OUT, MAKER>
{
public: // NOLINT
  explicit TriggerGenericWorker(TriggerGenericMaker<Set<A>, OUT, MAKER>& parent)
    : m_parent(parent)
    , m_in_buffer(parent.get_name(), parent.m_algorithm_name)
    , m_low_level_input_count(0)
  {
  }
 
  TriggerGenericMaker<Set<A>, OUT, MAKER>& m_parent;
 
  TimeSliceInputBuffer<A> m_in_buffer;
 
  void reconfigure() {}
 
  void reset() { m_low_level_input_count = 0; }
 
  void process_slice(const std::vector<A>& time_slice, std::vector<OUT>& out_vec)
  {
    // time_slice is a full slice (all Set<A> combined), time ordered, vector of A
    // call operator for each of the objects in the vector
    for (const A& x : time_slice) {
      try {
        m_parent.m_maker->operator()(x, out_vec);
      } catch (...) { // NOLINT TODO Benjamin Land <BenLand100@github.com> May 28-2021 can we restrict the possible
                      // exceptions triggeralgs might raise?
        ers::fatal(AlgorithmFatalError(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
        return;
      }
    }
  }
 
  void process(Set<A>& in)
  {
    std::vector<OUT> out_vec; // either a whole time slice, heartbeat flushed, or empty
    switch (in.type) {
      case Set<A>::Type::kPayload: {
        std::vector<A> time_slice;
        daqdataformats::timestamp_t start_time, end_time;
        if (!m_in_buffer.buffer(in, time_slice, start_time, end_time)) {
          return; // no complete time slice yet (`in` was part of buffered slice)
        }
        m_low_level_input_count += time_slice.size();
        process_slice(time_slice, out_vec);
      } break;
      case Set<A>::Type::kHeartbeat:
        // TODO BJL May-28-2021 should anything happen with the heartbeat when OUT is not a Set<T>?
        //
        // PAR 2022-01-21 We've got a heartbeat for time T, so we know
        // we won't receive any more inputs for times t < T. Therefore
        // we can flush all items in the input buffer, which have
        // times t < T, because the input is time-ordered
        try {
          std::vector<A> time_slice;
          daqdataformats::timestamp_t start_time, end_time;
          if (m_in_buffer.flush(time_slice, start_time, end_time)) {
            if (end_time > in.start_time) {
              // This should never happen, but we check here so we at least get some output if it did
              ers::fatal(OutOfOrderSets(ERS_HERE, m_parent.get_name(), end_time, in.start_time));
            }
            m_low_level_input_count += time_slice.size();
            process_slice(time_slice, out_vec);
          }
          m_parent.m_maker->flush(in.end_time, out_vec);
        } catch (...) { // NOLINT TODO Benjamin Land <BenLand100@github.com> May 28-2021 can we restrict the possible
                        // exceptions triggeralgs might raise?
          ers::fatal(AlgorithmFatalError(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
          return;
        }
        break;
      case Set<A>::Type::kUnknown:
        ers::error(UnknownSetError(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
        break;
    }
 
    while (out_vec.size()) {
      if (!m_parent.send(std::move(out_vec.back()))) {
        ers::error(AlgorithmFailedToSend(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
        // out.back() is dropped
      }
      out_vec.pop_back();
    }
  }
 
  void drain(bool drop)
  {
    // Send anything in the input buffer to the algorithm, and put any results
    // on the output queue
    std::vector<A> time_slice;
    daqdataformats::timestamp_t start_time, end_time;
    if (m_in_buffer.flush(time_slice, start_time, end_time)) {
      std::vector<OUT> out_vec;
      m_low_level_input_count += time_slice.size();
      process_slice(time_slice, out_vec);
      while (out_vec.size()) {
        if (!drop) {
          if (!m_parent.send(std::move(out_vec.back()))) {
            ers::error(AlgorithmFailedToSend(ERS_HERE, m_parent.get_name(), m_parent.m_algorithm_name));
            // out.back() is dropped
          }
        }
        out_vec.pop_back();
      }
    }
  }
 
  size_t get_low_level_input_count() { return m_low_level_input_count; }
  size_t m_low_level_input_count;
};
 
} // namespace dunedaq::trigger
 
#endif // TRIGGER_SRC_TRIGGER_TRIGGERGENERICMAKER_HPP_