5namespace fdreadoutlibs {
7using datahandlinglibs::logging::TLVL_BOOKKEEPING;
8using datahandlinglibs::logging::TLVL_TAKE_NOTE;
10template <
class ReadoutTypeAdapter>
12 : datahandlinglibs::TaskRawDataProcessorModel<ReadoutTypeAdapter>(error_registry, processing_enabled)
16template <
class ReadoutTypeAdapter>
21 if (this->m_post_processing_enabled) {
22 m_tps_suppressed_too_long = 0;
23 m_tps_send_failed = 0;
29 m_first_ts_missmatch =
true;
30 m_ts_problem_reported =
false;
31 m_ts_error_state =
false;
34 m_first_seq_id_mismatch =
true;
35 m_seq_id_problem_reported =
false;
36 m_seq_id_error_state =
false;
37 m_seq_id_error_ctr = 0;
41 m_t0 = std::chrono::high_resolution_clock::now();
42 m_num_new_tps.exchange(0);
46 if (m_state_harvester && m_tpg_metric_collect_enabled) {
47 m_state_harvester->start_collection_thread();
49 inherited::start(args);
52template <
class ReadoutTypeAdapter>
56 inherited::stop(args);
57 if (this->m_post_processing_enabled) {
59 if (m_state_harvester) {
60 m_state_harvester->stop_collection_thread();
63 m_tp_generator->configure(m_tpg_configs, m_channel_plane_numbers, ReadoutTypeAdapter::samples_tick_difference);
67template <
class ReadoutTypeAdapter>
72 m_sourceid.subsystem = ReadoutTypeAdapter::subsystem;
74 if (geo_id !=
nullptr) {
75 m_det_id = geo_id->get_detector_id();
76 m_crate_id = geo_id->get_crate_id();
77 m_slot_id = geo_id->get_slot_id();
78 m_stream_id = geo_id->get_stream_id();
82template <
class ReadoutTypeAdapter>
87 if (!m_emulator_mode) {
94template <
class ReadoutTypeAdapter>
98 const std::shared_ptr<detchannelmaps::TPCChannelMap> channel_map = dunedaq::detchannelmaps::make_tpc_map(proc_conf->
get_channel_map());
99 const std::vector<unsigned int> channel_mask_vec = proc_conf->
get_channel_mask();
101 for (
int chan = 0; chan < 64; chan++) {
102 trgdataformats::channel_t off_channel = channel_map->get_offline_channel_from_det_crate_slot_stream_chan(m_det_id, m_crate_id, m_slot_id, m_stream_id, chan);
103 int16_t plane = channel_map->get_plane_from_offline_channel(off_channel);
104 m_channel_plane_numbers.push_back(std::make_pair(off_channel, plane));
109 if (std::find(channel_mask_vec.begin(), channel_mask_vec.end(), off_channel) != channel_mask_vec.end()) {
110 m_channel_mask_set.insert(off_channel);
112 m_channel_plane_map[off_channel] = plane;
113 m_plane_numbers_set.insert(plane);
118template <
class ReadoutTypeAdapter>
124 int plane_number = 0;
127 if (output->get_data_type() ==
"TriggerPrimitiveVector") {
128 if (m_plane_numbers_set.contains(plane_number)) {
134 ers::error(datahandlinglibs::ResourceQueueError(
ERS_HERE,
"tp",
"DefaultRequestHandlerModel", excpt));
139 if (m_plane_numbers_set.size() > m_plane_to_tp_sink_map.size()) {
140 ers::error(DetectorPlaneToTPSinkMismatch(
ERS_HERE, m_plane_numbers_set.size(), m_plane_to_tp_sink_map.size()));
143 m_tp_generator = std::make_unique<tpglibs::TPGenerator>();
147 std::vector<uint16_t> sot_minima{conf_sot_minima->get_sot_minimum_plane0(),
148 conf_sot_minima->get_sot_minimum_plane1(),
149 conf_sot_minima->get_sot_minimum_plane2()};
150 m_tp_generator->set_sot_minima(sot_minima);
152 std::vector<const appmodel::ProcessingStep*> processing_steps = proc_conf->
get_processing_steps();
153 for (
auto step : processing_steps) {
154 m_tpg_configs.push_back(std::make_pair(step->class_name(), step->to_json(
false).back()));
158 m_tp_generator->configure(m_tpg_configs, m_channel_plane_numbers, ReadoutTypeAdapter::samples_tick_difference);
163 m_frame_limit_enabled = m_frame_count_limit > 0;
164 m_tp_limit_enabled = m_tp_count_limit > 0;
166 if (!m_frame_limit_enabled && !m_tp_limit_enabled) {
173 m_tpg_metric_collect_enabled =
false;
174 for (
const auto& name_config : m_tpg_configs) {
175 if (name_config.second.contains(
"metric_collect_toggle_state") &&
176 name_config.second[
"metric_collect_toggle_state"] ==
true) {
177 m_tpg_metric_collect_enabled =
true;
183 if (m_tpg_metric_collect_enabled) {
184 auto processsor_references = m_tp_generator->get_all_processor_references_with_pipeline_index();
186 m_state_harvester = std::make_unique<fdreadoutlibs::TPGInternalStateHarvester>();
188 const uint8_t channels_per_pipeline = 16;
189 const uint8_t pipelines =
static_cast<uint8_t
>(m_channel_plane_numbers.size() / channels_per_pipeline);
191 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"Configuring state harvester with " <<
static_cast<int>(channels_per_pipeline)
192 <<
" channels per pipeline, " <<
static_cast<int>(pipelines) <<
" pipelines, "
193 << processsor_references.size() <<
" processor references";
195 m_state_harvester->update_channel_plane_numbers(m_channel_plane_numbers,
196 channels_per_pipeline, pipelines);
197 m_state_harvester->set_processor_references(processsor_references);
200 m_state_harvester->start_collection_thread();
202 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"State harvester configured and started successfully";
208template <
class ReadoutTypeAdapter>
218 if (proc_conf ==
nullptr) {
223 configure_channel_plane_numbers(proc_conf);
224 configure_find_tps(conf, proc_conf);
227template <
class ReadoutTypeAdapter>
231 configure_source_and_geo_ids(conf);
233 configure_preprocessing(conf);
235 if (this->m_post_processing_enabled) {
236 configure_postprocessing(conf);
239 inherited::conf(conf);
242template <
class ReadoutTypeAdapter>
254template <
class ReadoutTypeAdapter>
258 m_emulator_mode =
false;
259 m_first_frame =
true;
265 m_pattern_generator_previous_ts = 0;
266 m_pattern_generator_current_ts = 0;
268 m_first_ts_missmatch =
true;
269 m_ts_problem_reported =
false;
270 m_ts_error_state =
false;
274 m_previous_seq_id = 0;
275 m_current_seq_id = 0;
277 m_first_seq_id_mismatch =
true;
278 m_seq_id_problem_reported =
false;
279 m_seq_id_error_state =
false;
280 m_seq_id_error_ctr = 0;
281 m_seq_id_min_jump = 0;
282 m_seq_id_max_jump = 0;
287template <
class ReadoutTypeAdapter>
292 m_channel_mask_set.clear();
293 m_plane_numbers_set.clear();
294 m_channel_plane_numbers.clear();
295 m_channel_plane_map.clear();
298 m_tp_generator->reset();
299 m_tpg_configs.clear();
300 m_plane_to_tpa_vector_map.clear();
301 m_plane_to_tp_sink_map.clear();
303 m_frame_limit_enabled =
false;
304 m_tp_limit_enabled =
false;
305 m_current_tp_count = 0;
306 m_tp_count_limit = 0;
307 m_frame_count_at_last_send = 0;
310 m_tpg_metric_collect_enabled =
false;
311 m_metric_collect_opmon_period = 128;
312 m_tp_channel_rate_map.clear();
313 m_num_new_tps.exchange(0);
314 m_tps_suppressed_too_long.exchange(0);
315 m_tps_send_failed.exchange(0);
316 m_frame_counter.exchange(0);
317 m_t0 = std::chrono::high_resolution_clock::now();
320template <
class ReadoutTypeAdapter>
324 scrap_source_and_geo_ids();
325 scrap_preprocessing();
327 if (this->m_post_processing_enabled) {
328 scrap_postprocessing();
331 inherited::scrap(cfg);
335template <
class ReadoutTypeAdapter>
341 info.set_num_seq_id_errors(m_seq_id_error_ctr.load());
342 info.set_min_seq_id_jump(m_seq_id_min_jump.exchange(0));
343 info.set_max_seq_id_jump(m_seq_id_max_jump.exchange(0));
345 info.set_num_ts_errors(m_ts_error_ctr.load());
347 this->publish(std::move(info));
349 this->m_error_registry->log_registered_errors();
351 if (this->m_post_processing_enabled) {
352 auto now = std::chrono::high_resolution_clock::now();
353 int num_new_tps = m_num_new_tps.exchange(0);
354 int num_new_tps_suppressed_too_long = m_tps_suppressed_too_long.exchange(0);
355 int num_new_tps_send_failed = m_tps_send_failed.exchange(0);
356 double seconds = std::chrono::duration_cast<std::chrono::microseconds>(
now - m_t0).count() / 1000000.;
357 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"TP rate: " << std::to_string(num_new_tps / seconds / 1000.) <<
" [kHz]";
358 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"Total new TPs: " << num_new_tps;
367 this->publish(std::move(tp_info));
370 std::vector<std::pair<uint, int>> channel_tp_rate_vec(m_tp_channel_rate_map.begin(), m_tp_channel_rate_map.end());
372 sort(channel_tp_rate_vec.begin(), channel_tp_rate_vec.end(), [](std::pair<uint, int>& a, std::pair<uint, int>& b) { return a.second > b.second; });
375 if (channel_tp_rate_vec.size() != 0) {
376 int top_highest_values = 10;
377 if (channel_tp_rate_vec.size() < 10) {
378 top_highest_values = channel_tp_rate_vec.size();
381 for (
int i = 0; i < top_highest_values; i++) {
385 this->publish(std::move(tpc_info), {{
"channel", std::to_string(channel_tp_rate_vec[i].first)}});
390 for (
auto& el : m_tp_channel_rate_map) {
395 if (m_tpg_metric_collect_enabled && m_state_harvester) {
396 publish_processor_metric_to_opmon();
397 publish_processor_metric_to_opmon_with_aggregation();
401 inherited::generate_opmon_data();
404template <
class ReadoutTypeAdapter>
407 if (!m_state_harvester) {
412 auto metrics = m_state_harvester->get_latest_results();
414 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"Publishing processor metrics for " << metrics.size() <<
" channels";
416 int metrics_published = 0;
419 for (
const auto& [channel, vec] : metrics) {
421 bool has_valid_metrics =
false;
423 for (
const auto& [name, val] : vec) {
424 if (name ==
"pedestal") {
426 has_valid_metrics =
true;
427 }
else if (name ==
"accum") {
429 has_valid_metrics =
true;
433 if (has_valid_metrics) {
434 this->publish(std::move(tpg_proc_info), {{
"channel", std::to_string(channel)}});
439 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"Published " << metrics_published <<
" channel metrics";
442template <
class ReadoutTypeAdapter>
443std::map<int16_t, std::map<std::string, std::tuple<float, int16_t, int16_t, float, dunedaq::trgdataformats::channel_t, dunedaq::trgdataformats::channel_t>>>
446 std::map<int16_t, std::map<std::string, std::tuple<float, int16_t, int16_t, float, dunedaq::trgdataformats::channel_t, dunedaq::trgdataformats::channel_t>>> all_stats;
449 std::map<int16_t, std::map<std::string, std::tuple<size_t, double, double, int16_t, int16_t, dunedaq::trgdataformats::channel_t, dunedaq::trgdataformats::channel_t>>> accumulators;
452 for (
const auto& [channel, vec] : metrics) {
453 if (m_channel_plane_map.empty())
continue;
455 int16_t plane = m_channel_plane_map[channel];
457 for (
const auto& [name, val] : vec) {
458 auto& [count, mean, M2, min, max, min_channel_id, max_channel_id] = accumulators[plane][name];
462 if (count == 1 || val < min) {
464 min_channel_id = channel;
466 if (count == 1 || val > max) {
468 max_channel_id = channel;
478 double delta = val - mean;
479 mean += delta / count;
480 double delta2 = val - mean;
481 M2 += delta * delta2;
487 for (
const auto& [plane, metric_map] : accumulators) {
488 for (
const auto& [metric_name, acc_data] : metric_map) {
489 const auto& [count, mean, M2, min, max, min_channel_id, max_channel_id] = acc_data;
491 if (count == 0)
continue;
497 stddev = std::sqrt(M2 / (count - 1));
500 all_stats[plane][metric_name] = std::make_tuple(
static_cast<float>(mean), min, max, stddev, min_channel_id, max_channel_id);
507template <
class ReadoutTypeAdapter>
510 if (!m_state_harvester) {
515 auto metrics = m_state_harvester->get_latest_results();
518 auto all_stats = calculate_all_metric_summaries_across_planes(metrics);
520 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"Publishing aggregated metrics for " << all_stats.size() <<
" planes";
523 for (
const auto& [plane, metric_map] : all_stats) {
524 for (
const auto& [metric_name, stats] : metric_map) {
525 const auto& [mean, min, max, stddev, min_channel_id, max_channel_id] = stats;
528 info.set_average(mean);
531 info.set_standard_dev(stddev);
532 info.set_max_channel_id(max_channel_id);
533 info.set_min_channel_id(min_channel_id);
534 this->publish(std::move(info), {{
"plane", std::to_string(plane)}, {
"metric", metric_name}});
543template <
class ReadoutTypeAdapter>
549 m_current_seq_id = wfptr->daq_header.seq_id;
552 if (m_first_frame) [[unlikely]] {
553 if (wfptr->daq_header.crate_id != m_crate_id || wfptr->daq_header.slot_id != m_slot_id || wfptr->daq_header.stream_id != m_stream_id) {
554 ers::error(LinkMisconfiguration(
ERS_HERE, wfptr->daq_header.crate_id, wfptr->daq_header.slot_id, wfptr->daq_header.stream_id, m_crate_id, m_slot_id, m_stream_id));
557 m_first_frame =
false;
562 uint16_t expected_seq_id = (m_previous_seq_id + fp->get_num_frames()) & 0xfff;
563 int16_t delta_seq_id = m_current_seq_id-expected_seq_id;
564 if ( delta_seq_id > 0x800) {
565 delta_seq_id -= 0x1000;
566 }
else if ( delta_seq_id < -0x7ff) {
567 delta_seq_id += 0x1000;
570 if (delta_seq_id == 0) {
571 m_seq_id_error_state =
false;
574 ++m_seq_id_error_ctr;
575 m_seq_id_max_jump = std::max(delta_seq_id, m_seq_id_max_jump.load());
576 m_seq_id_min_jump = std::min(delta_seq_id, m_seq_id_min_jump.load());
578 if (m_first_seq_id_mismatch) {
579 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"First sequence id MISMATCH! -> | previous: " << std::to_string(m_previous_seq_id) <<
" current: " + std::to_string(m_current_seq_id);
580 m_first_seq_id_mismatch =
false;
582 if (!m_seq_id_error_state) {
584 m_seq_id_error_state =
true;
589 if (m_seq_id_error_ctr > 1000) {
590 if (!m_seq_id_problem_reported) {
591 TLOG() <<
"*** Data Integrity ERROR *** Sequence ID continuity is completely broken! "
592 <<
"Something is wrong with the FE source or with the configuration!";
593 m_seq_id_problem_reported =
true;
597 m_previous_seq_id = m_current_seq_id;
604template <
class ReadoutTypeAdapter>
609 uint16_t tpceth_tick_difference = ReadoutTypeAdapter::expected_tick_difference;
610 uint16_t tpceth_frame_tick_difference = tpceth_tick_difference * fp->get_num_frames();
613 m_current_ts = wfptr->get_timestamp();
616 if (m_previous_ts > 0 &&
617 m_current_ts - m_previous_ts != tpceth_frame_tick_difference) [[unlikely]] {
619 if (m_first_ts_missmatch) {
620 TLOG_DEBUG(TLVL_BOOKKEEPING) <<
"First timestamp MISMATCH! -> | previous: " << std::to_string(m_previous_ts) <<
" current: " + std::to_string(m_current_ts);
621 m_first_ts_missmatch =
false;
623 if (!m_ts_error_state) {
625 m_ts_error_state =
true;
629 m_ts_error_state =
false;
632 if (m_ts_error_ctr > 1000) {
633 if (!m_ts_problem_reported) {
634 TLOG() <<
"*** Data Integrity ERROR *** Timestamp continuity is completely broken! "
635 <<
"Something is wrong with the FE source or with the configuration!";
636 m_ts_problem_reported =
true;
640 m_previous_ts = m_current_ts;
641 this->m_last_processed_daq_ts = m_current_ts;
647template <
class ReadoutTypeAdapter>
653 auto wfptr =
reinterpret_cast<tpcframeptr>((uint8_t*)fp);
655 std::vector<trgdataformats::TriggerPrimitive> tps = (*m_tp_generator)(wfptr);
657 uint64_t current_frame_count = m_frame_counter.fetch_add(1, std::memory_order_relaxed) + 1;
660 if (m_tpg_metric_collect_enabled && m_state_harvester &&
661 current_frame_count % m_metric_collect_opmon_period == 0) {
662 m_state_harvester->trigger_harvest();
665 for (
const auto& tp : tps) {
667 if (std::binary_search(m_channel_mask_set.begin(), m_channel_mask_set.end(), uint32_t(tp.channel)))
674 m_plane_to_tpa_vector_map[m_channel_plane_map[uint32_t(tp.channel)]].push_back(tpa);
675 m_tp_channel_rate_map[uint32_t(tp.channel)]++;
676 m_current_tp_count++;
679 const bool frame_limit_reached = m_frame_limit_enabled && (current_frame_count - m_frame_count_at_last_send >= m_frame_count_limit);
680 const bool tp_limit_reached = m_tp_limit_enabled && (m_current_tp_count >= m_tp_count_limit);
682 if (frame_limit_reached || tp_limit_reached) [[unlikely]] {
683 m_current_tp_count = 0;
684 m_frame_count_at_last_send = current_frame_count;
685 for (
auto& [plane_num, tpa_vector] : m_plane_to_tpa_vector_map) {
686 int num_new_tps = tpa_vector.size();
687 if (num_new_tps == 0) {
690 const auto ts_begin = tpa_vector.front().tp.time_start;
691 const auto channel_begin = tpa_vector.front().tp.channel;
692 const auto ts_end = tpa_vector.back().tp.time_start;
693 const auto channel_end = tpa_vector.back().tp.channel;
698 m_num_new_tps += num_new_tps;
#define DUNE_DAQ_TYPESTRING(Type, typestring)
Declare the datatype_to_string method for the given type.
const dunedaq::appmodel::DataProcessor * get_data_processor() const
Get "data_processor" relationship value.
const dunedaq::appmodel::DataHandlerConf * get_module_configuration() const
Get "module_configuration" relationship value.
bool get_emulation_mode() const
Get "emulation_mode" attribute value.
uint32_t get_source_id() const
Get "source_id" attribute value.
const dunedaq::confmodel::GeoId * get_geo_id() const
Get "geo_id" relationship value.
const std::vector< uint32_t > & get_channel_mask() const
Get "channel_mask" attribute value. List of channels to be masked from TP generation.
const std::string & get_channel_map() const
Get "channel_map" attribute value.
uint32_t get_frame_count_limit() const
Get "frame_count_limit" attribute value. When this number of frames is reached the TPs are sent to th...
const dunedaq::appmodel::SamplesOverThresholdMinima * get_sot_minima() const
Get "sot_minima" relationship value. TP samples over threshold minimum requirement by plane.
const std::vector< const dunedaq::appmodel::ProcessingStep * > & get_processing_steps() const
Get "processing_steps" relationship value.
uint32_t get_metric_collect_opmon_period() const
Get "metric_collect_opmon_period" attribute value. The rate at which processor metric is polled from ...
uint32_t get_tp_count_limit() const
Get "tp_count_limit" attribute value. When this number of TPs is reached, the TPs are sent to the sin...
const TARGET * cast() const noexcept
Casts object to different class.
const std::vector< const dunedaq::confmodel::Connection * > & get_outputs() const
Get "outputs" relationship value. Output connections from this module.
void set_num_tps_send_failed(::uint64_t value)
void set_num_tps_suppressed_too_long(::uint64_t value)
void set_num_tps_sent(::uint64_t value)
void set_rate_tp_hits(float value)
void set_channel_id(::uint64_t value)
void set_number_of_tps(::uint64_t value)
void set_accum(::int64_t value)
void set_pedestal(::int64_t value)
const ReadoutTypeAdapter * constframeptr
void scrap_postprocessing()
void configure_postprocessing(const appmodel::DataHandlerModule *conf)
void scrap_preprocessing()
ReadoutTypeAdapter::FrameType * tpcframeptr
void configure_channel_plane_numbers(const appmodel::TPCRawDataProcessor *proc_conf)
void stop(const appfwk::DAQModule::CommandData_t &args) override
Stop operation.
void publish_processor_metric_to_opmon()
void configure_find_tps(const appmodel::DataHandlerModule *conf, const appmodel::TPCRawDataProcessor *proc_conf)
void scrap(const appfwk::DAQModule::CommandData_t &cfg) override
Unconfigure.
void scrap_source_and_geo_ids()
void publish_processor_metric_to_opmon_with_aggregation()
void configure_source_and_geo_ids(const appmodel::DataHandlerModule *conf)
void sequence_check(frameptr fp)
std::map< int16_t, std::map< std::string, std::tuple< float, int16_t, int16_t, float, dunedaq::trgdataformats::channel_t, dunedaq::trgdataformats::channel_t > > > calculate_all_metric_summaries_across_planes(const std::unordered_map< dunedaq::trgdataformats::channel_t, std::vector< std::pair< std::string, int16_t > > > &metrics)
ReadoutTypeAdapter * frameptr
void generate_opmon_data() override
void start(const appfwk::DAQModule::CommandData_t &args) override
Start operation.
void configure_preprocessing(const appmodel::DataHandlerModule *conf)
void conf(const appmodel::DataHandlerModule *conf) override
Set the emulator mode, if active, timestamps of processed packets are overwritten with new ones.
void timestamp_check(frameptr fp)
void find_tps(constframeptr fp)
static constexpr timeout_t s_no_block
Base class for any user define issue.
#define TLOG_DEBUG(lvl,...)
static std::shared_ptr< iomanager::SenderConcept< Datatype > > get_iom_sender(iomanager::ConnectionId const &id)
Both frame_count_limit and tp_count_limit were set FailedToSendTPVector
FrameAndTPCountersDisabled
void warning(const Issue &issue)
void error(const Issue &issue)
trgdataformats::TriggerPrimitive tp