DAPHNEFrameProcessor.cpp

Go to the documentation of this file.

 
#include "fdreadoutlibs/daphne/DAPHNEFrameProcessor.hpp"
#include "fddetdataformats/DAPHNEFrame.hpp"
#include "trgdataformats/TriggerPrimitive.hpp"
 
#include "confmodel/GeoId.hpp"
 
#include <atomic>
#include <functional>
#include <memory>
#include <string>
 
using dunedaq::datahandlinglibs::logging::TLVL_BOOKKEEPING;
using dunedaq::datahandlinglibs::logging::TLVL_FRAME_RECEIVED;
 
DUNE_DAQ_TYPESTRING(dunedaq::trigger::TriggerPrimitiveTypeAdapter, "TriggerPrimitive")
DUNE_DAQ_TYPESTRING(std::vector<dunedaq::trigger::TriggerPrimitiveTypeAdapter>, "TriggerPrimitiveVector")
 
namespace dunedaq {
namespace fdreadoutlibs {
 
void
DAPHNEFrameProcessor::conf(const appmodel::DataHandlerModule* conf)
{
  TLOG() << "Looking for TP sink...";
 
  for (auto output : conf->get_outputs()) {
    TLOG() << "On outputs... (" << output->UID() << "," << output->get_data_type() << ")";
    try {
      if (output->get_data_type() == "TriggerPrimitiveVector") {
        TLOG() << "Found TP sink.";
        m_tp_sink = get_iom_sender<std::vector<trigger::TriggerPrimitiveTypeAdapter>>(output->UID());
        TLOG() << " SINK INITIALIZED for TriggerPrimitives with UID : " << output->UID();
      }
    } catch (const ers::Issue& excpt) {
      ers::error(datahandlinglibs::ResourceQueueError(ERS_HERE, "tp", "DefaultRequestHandlerModel", excpt));
    }
  }
 
  TLOG() << "Registering processing tasks...";
  inherited::add_preprocess_task(std::bind(&DAPHNEFrameProcessor::timestamp_check, this, std::placeholders::_1));
 
  auto dp = conf->get_module_configuration()->get_data_processor();
  if (dp == nullptr) {
    TLOG() << " PDS Data processor does not exist.";
  } else {
    auto proc_conf = dp->cast<appmodel::PDSRawDataProcessor>();
    if (proc_conf == nullptr) {
      TLOG() << "PDS RawDataProcessor does not exist.";
    } else {
      m_def_adc_intg_thresh = proc_conf->get_default_adc_intg_thresh();
 
      auto geo_id = conf->get_geo_id();
      if (geo_id != nullptr) {
        m_det_id = geo_id->get_detector_id();
        m_crate_id = geo_id->get_crate_id();
        m_slot_id = geo_id->get_slot_id();
        m_stream_id = geo_id->get_stream_id();
      }
 
      m_channel_map = dunedaq::detchannelmaps::make_pds_map(proc_conf->get_channel_map());
      const std::vector<unsigned int> channel_mask_vec = proc_conf->get_channel_mask();
 
      for (int chan = 0; chan < 48; chan++) { // 40 physical PDS channel 8 not. 0->7 contain light info, 8,9, additional
                                              // info. 10-17 light, 18,19 not etc...
        trgdataformats::channel_t off_channel = m_channel_map->get_offline_channel_from_det_crate_slot_stream_chan(
          m_det_id, m_crate_id, m_slot_id, m_stream_id, chan);
        if (std::find(channel_mask_vec.begin(), channel_mask_vec.end(), off_channel) != channel_mask_vec.end())
          m_channel_mask_set.insert(
            off_channel); // m_channel_mask will be a vector fille with random chanel which need to be masked.
      }
 
      if (m_post_processing_enabled) {
        // Extract TPs back as a pre-processing task, due to LatencyBuffer post-proc issues using SkipList.
        inherited::add_preprocess_task(std::bind(&DAPHNEFrameProcessor::extract_tps, this, std::placeholders::_1));
      }
    }
  }
 
  TLOG() << "Calling parent conf.";
  inherited::conf(conf);
}
 
void
DAPHNEFrameProcessor::start(const appfwk::DAQModule::CommandData_t& args)
{
  // Reset timestamp check
  m_previous_ts = 0;
  m_current_ts = 0;
  m_first_ts_missmatch = true;
  m_ts_error_ctr = 0;
 
  // Reset stats
  m_t0 = std::chrono::high_resolution_clock::now();
  m_num_new_tps.exchange(0);
 
  inherited::start(args);
}
void
DAPHNEFrameProcessor::stop(const appfwk::DAQModule::CommandData_t& args)
{
  inherited::stop(args);
}

void
DAPHNEFrameProcessor::timestamp_check(frameptr fp)
{
  // Let Source Emulator deal with this
  /*
    // If EMU data, emulate perfectly incrementing timestamp
    if (inherited::m_emulator_mode) { // emulate perfectly incrementing timestamp
      // RS warning : not fixed rate!
      if (m_first_ts_fake) {
        fp->fake_timestamps(m_previous_ts, 16);
        m_first_ts_fake = false;
      } else {
        fp->fake_timestamps(m_previous_ts + 192, 16);
      }
    }*/
 
  // FIXME: This is a temporary fix to avoid frames with unphysical timestamp set to the far future to interfere with
  // the operations of the LB.
  // These frames are effectively "corrupted" or "invalid frames" and hould be handled as such.
 
  auto df_ptr = reinterpret_cast<dunedaq::fddetdataformats::DAPHNEFrame*>(fp);
 
  for (size_t i = 0; i < fp->get_num_frames(); ++i) {
 
    if (df_ptr[i].get_timestamp() > 0xFFFFFFFFFFFF0000 || df_ptr[i].get_timestamp() < 0xFFFF) {
      ers::warning(PDSUnphysicalFrameTimestamp(ERS_HERE, df_ptr[i].get_timestamp(), df_ptr[i].get_channel(), i));
      df_ptr[i].set_timestamp(0);
    }
  }
 
  // Acquire timestamp
  m_current_ts = fp->get_timestamp();
  uint64_t k_clock_frequency = 62500000; // NOLINT(build/unsigned)
  TLOG_DEBUG(TLVL_FRAME_RECEIVED) << "Received DAPHNE frame timestamp value of " << m_current_ts << " ticks (..."
                                  << std::fixed << std::setprecision(8)
                                  << (static_cast<double>(m_current_ts % (k_clock_frequency * 1000)) /
                                      static_cast<double>(k_clock_frequency))
                                  << " sec)"; // NOLINT
 
  if (m_ts_error_ctr > 1000) {
    if (!m_problem_reported) {
      std::cout << "*** Data Integrity ERROR *** Timestamp continuity is completely broken! "
                << "Something is wrong with the FE source or with the configuration!\n";
      m_problem_reported = true;
    }
  }
 
  m_previous_ts = m_current_ts;
  m_last_processed_daq_ts = m_current_ts;
}

void
DAPHNEFrameProcessor::frame_error_check(frameptr /*fp*/)
{
  // check error fields
}
 
void
DAPHNEFrameProcessor::extract_tps(constframeptr fp)
{
 
  if (!fp || fp == nullptr) {
    return;
  }
 
  auto nonconstframeptr = const_cast<frameptr>(fp);
  auto df_ptr = reinterpret_cast<dunedaq::fddetdataformats::DAPHNEFrame*>((uint8_t*)nonconstframeptr); // NOLINT
  std::vector<trigger::TriggerPrimitiveTypeAdapter> ttpp;
 
  for (size_t i = 0; i < fp->get_num_frames(); i++) {
    for (size_t j = 0; j < fddetdataformats::DAPHNEFrame::PeakDescriptorData::max_peaks; j++) {
      if (df_ptr[i].peaks_data.is_found(j)) {
        int ch = m_channel_map->get_offline_channel_from_det_crate_slot_stream_chan(df_ptr[i].daq_header.det_id,
                                                                                    df_ptr[i].daq_header.crate_id,
                                                                                    df_ptr[i].daq_header.slot_id,
                                                                                    df_ptr[i].daq_header.link_id,
                                                                                    df_ptr[i].get_channel());
        if (std::binary_search(m_channel_mask_set.begin(), m_channel_mask_set.end(), ch))
          continue;
        if (df_ptr[i].peaks_data.get_adc_integral(j) < m_def_adc_intg_thresh)
          continue;
 
        trigger::TriggerPrimitiveTypeAdapter tpa;
        tpa.tp = peak_to_tp(df_ptr[i], j); // this is the trigger primitive
        // check for timestamps that are due to frame timestamps ~ ts=0, and ignore these peaks
        if (tpa.tp.time_start > 0xFFFFFFFFFFFF0000 || tpa.tp.time_start < 0xFFFF) {
          ers::warning(PDSPeakIgnored(ERS_HERE, tpa.tp.time_start, tpa.tp.channel, i, j));
          continue;
        }
 
        tpa.tp.detid = df_ptr->daq_header.det_id;
        ttpp.push_back(tpa);
      }
    }
  }
 
  int num_new_tps = ttpp.size();
  if (num_new_tps > 0) {
 
    const auto s_ts_begin = ttpp.front().tp.time_start;
    const auto channel_begin = ttpp.front().tp.channel;
    const auto s_ts_end = ttpp.back().tp.time_start;
    const auto channel_end = ttpp.back().tp.channel;
 
    if (!m_tp_sink->try_send(std::move(ttpp), iomanager::Sender::s_no_block)) {
      ers::warning(FailedToSendTPVector(ERS_HERE, s_ts_begin, channel_begin, s_ts_end, channel_end));
      m_tps_send_failed += num_new_tps;
    } else {
      m_num_new_tps += num_new_tps;
    }
  }
 
  return;
}
 
dunedaq::trgdataformats::TriggerPrimitive
DAPHNEFrameProcessor::peak_to_tp(dunedaq::fddetdataformats::DAPHNEFrame& frame, int i)
{
  dunedaq::trgdataformats::TriggerPrimitive tp;
  // TODO: add check on peak presence
  tp.time_start = frame.get_timestamp() + frame.peaks_data.get_sample_start(i);
  tp.samples_to_peak = frame.peaks_data.get_sample_max(i);
  tp.samples_over_threshold = frame.peaks_data.get_samples_over_baseline(i);
  // FIXME : hard-coded channel map
  // WARNING: slot ids in DAPHNEs are all 0!
  tp.channel = m_channel_map->get_offline_channel_from_det_crate_slot_stream_chan(frame.daq_header.det_id,
                                                                                  frame.daq_header.crate_id,
                                                                                  frame.daq_header.slot_id,
                                                                                  frame.daq_header.link_id,
                                                                                  frame.get_channel());
  tp.adc_integral = frame.peaks_data.get_adc_integral(i);
  tp.adc_peak = frame.peaks_data.get_adc_max(i);
  tp.detid = dunedaq::trgdataformats::TypeDefaults::s_invalid_detid;
  return tp;
}
 
void
DAPHNEFrameProcessor::generate_opmon_data()
{
 
  // right now, just fill some basic tp info...
  if (m_post_processing_enabled) {
    auto now = std::chrono::high_resolution_clock::now();
    int num_new_tps = m_num_new_tps.exchange(0);
    int new_tps_suppressed_too_long = 0; // not relevant for PDS TPs
    int new_tps_send_failed = m_tps_send_failed.exchange(0);
    double seconds = std::chrono::duration_cast<std::chrono::microseconds>(now - m_t0).count() / 1000000.;
    TLOG_DEBUG(TLVL_BOOKKEEPING) << "TP rate: " << std::to_string(num_new_tps / seconds / 1000.) << " [kHz]";
    TLOG_DEBUG(TLVL_BOOKKEEPING) << "Total new TPs: " << num_new_tps;
 
    datahandlinglibs::opmon::HitFindingInfo tp_info;
    tp_info.set_rate_tp_hits(num_new_tps / seconds / 1000.);
 
    tp_info.set_num_tps_sent(num_new_tps);
    tp_info.set_num_tps_suppressed_too_long(new_tps_suppressed_too_long);
    tp_info.set_num_tps_send_failed(new_tps_send_failed);
 
    publish(std::move(tp_info));
 
    m_t0 = now;
  }
 
  inherited::generate_opmon_data();
}
 
} // namespace fdreadoutlibs
} // namespace dunedaq