packing::MultiSampleECONDEventPacket Class Reference

Unpack an event that has potentially more than one sample collected from a single ECOND. More...

#include <MultiSampleECONDEventPacket.h>

Public Types
enum	Corruption : std::size_t {   RESYNC = 0 , LOST_SYNC = 1 , NO_TRAILER = 2 , TRAILER_COUNT_MISMATCH = 3 ,   ECON_ID_MISMATCH = 4 , SAMPLE_INDEX_MISMATCH = 5 , TRUNCATED_FRAME = 6 , EXTRA_WORDS = 7 ,   NO_SOI = 8 , N_CORRUPTION = 9 }
	index of frame-level corruption flags More...

Public Member Functions
	MultiSampleECONDEventPacket (int n_links)
	constructor defining how many links are connected to this ECOND
const ECONDEventPacket &	soi () const
	get the sample of interest
bool	isCorrupt () const
	any of the frame-level corruption flags are set
void	from (std::span< const uint32_t > frame)
	unpack the given frame into this structure

Public Attributes
std::array< bool, N_CORRUPTION >	corruption_ {}
	corruption flags indexed by Corruption
std::size_t	i_soi_ {0}
	index of the sample of interest (SOI)
int	econd_id_ {-1}
	ID for this econ from the first capture header (-1 if none)
int	trailer_n_samples_ {-1}
	number of samples written in the trailer (-1 if no trailer)
std::size_t	n_skipped_words_ {0}
	number of words skipped while searching for capture headers
std::vector< DAQSampleHeader >	headers_
	capture headers stored in order of transmission
std::vector< ECONDEventPacket >	samples_
	samples from ECOND stored in order of transmission

Private Member Functions
std::size_t	resync (std::span< const uint32_t > frame, std::size_t start, std::size_t i_sample) const
	find the next capture header for sample i_sample or the trailer
	enableLogging ("MultiSampleECONDEventPacket")
	handle to logging source

Private Attributes
int	n_links_
	number of links connected to the ECOND

Detailed Description

Unpack an event that has potentially more than one sample collected from a single ECOND.

The frame is what SingleSubsystemUnpacker puts on the event bus (the data after the LDMX RoR header) as 32-bit words: for each sample a DAQSampleHeader followed by the ECON-D packet, then the DAQSampleHeader::endingTrailer and zero padding.

Corrupted ECON-D packets are flagged in their ECONDEventPacket and we move on to the next capture header using the length. If the word at that position is not a capture header, we search forward for the capture header of the next sample (or the trailer) and count the skipped words.

See also

ECONDEventPacket for how a single sample from a single ECOND is unpacked.

Note

Ported from pflib::packing::MultiSampleECONDEventPacket.

Definition at line 29 of file MultiSampleECONDEventPacket.h.

Member Enumeration Documentation

Corruption

enum packing::MultiSampleECONDEventPacket::Corruption : std::size_t

index of frame-level corruption flags

Enumerator
RESYNC	a capture header was missing, words were skipped to find the next
LOST_SYNC	no further capture header or trailer found, rest of frame dropped
NO_TRAILER	the frame ended without the ending trailer
TRAILER_COUNT_MISMATCH	number of samples in the trailer does not match the number found
ECON_ID_MISMATCH	ECON ID changed within the frame.
SAMPLE_INDEX_MISMATCH	sample index in capture header does not match its position
TRUNCATED_FRAME	capture header length goes past the end of the frame
EXTRA_WORDS	non-zero words after the ending trailer
NO_SOI	no sample flagged as the sample of interest
N_CORRUPTION	number of corruption flags

Definition at line 32 of file MultiSampleECONDEventPacket.h.

                  : std::size_t {
    RESYNC = 0,
    LOST_SYNC = 1,
    NO_TRAILER = 2,
    TRAILER_COUNT_MISMATCH = 3,
    ECON_ID_MISMATCH = 4,
    SAMPLE_INDEX_MISMATCH = 5,
    TRUNCATED_FRAME = 6,
    EXTRA_WORDS = 7,
    NO_SOI = 8,
    N_CORRUPTION = 9
  };

Constructor & Destructor Documentation

MultiSampleECONDEventPacket()

packing::MultiSampleECONDEventPacket::MultiSampleECONDEventPacket ( int n_links )

explicit

constructor defining how many links are connected to this ECOND

Definition at line 11 of file MultiSampleECONDEventPacket.cxx.

    : n_links_{n_links} {}

Member Function Documentation

from()

void packing::MultiSampleECONDEventPacket::from

(

std::span< const uint32_t >

frame

)

unpack the given frame into this structure

Definition at line 42 of file MultiSampleECONDEventPacket.cxx.

                                                                    {
  corruption_.fill(false);
  i_soi_ = 0;
  econd_id_ = -1;
  trailer_n_samples_ = -1;
  n_skipped_words_ = 0;
  headers_.clear();
  samples_.clear();
 
  bool found_soi{false};
  std::size_t offset{0};
  DAQSampleHeader header;
  while (offset < frame.size()) {
    header.from(frame[offset]);
    if (header.version_ == DAQSampleHeader::VERSION and
        header.isEndingTrailer()) {
      trailer_n_samples_ = DAQSampleHeader::trailerNumSamples(frame[offset]);
      ldmx_log(trace) << "Last sample packet found at offset = " << offset
                      << " (frame.size() = " << frame.size() << ")";
      offset++;
      break;
    }
 
    bool valid =
        DAQSampleHeader::isValid(frame[offset]) and
        (econd_id_ < 0 or header.econd_id_ == static_cast<uint32_t>(econd_id_));
    if (not valid) {
      if (DAQSampleHeader::isValid(frame[offset])) {
        corruption_[ECON_ID_MISMATCH] = true;
      }
      auto next = resync(frame, offset + 1, samples_.size());
      ldmx_log(debug) << Hex(frame[offset])
                      << " is not a capture header, skipping "
                      << (next - offset) << " words";
      corruption_[RESYNC] = true;
      n_skipped_words_ += next - offset;
      if (next == frame.size()) {
        corruption_[LOST_SYNC] = true;
      }
      offset = next;
      continue;
    }
 
    if (econd_id_ < 0) econd_id_ = header.econd_id_;
    ldmx_log(trace) << Hex(frame[offset]) << " -> " << header;
 
    // header decoded, shift offset
    offset++;
 
    std::size_t i_sample{samples_.size()};
    if (i_sample != header.i_l1a_) {
      ldmx_log(debug) << "mismatch between transmitted index " << header.i_l1a_
                      << " and unpacking index for sample " << i_sample;
      corruption_[SAMPLE_INDEX_MISMATCH] = true;
    }
 
    if (header.is_soi_ and not found_soi) {
      i_soi_ = i_sample;
      found_soi = true;
    }
 
    std::size_t len{header.econd_len_};
    if (offset + len > frame.size()) {
      ldmx_log(debug) << "capture header length " << len << " goes past the "
                      << "end of the frame by " << (offset + len - frame.size())
                      << " words";
      corruption_[TRUNCATED_FRAME] = true;
      len = frame.size() - offset;
    }
 
    headers_.push_back(header);
    samples_.emplace_back(n_links_);
    samples_.back().from(frame.subspan(offset, len));
    offset += len;
  }
 
  if (trailer_n_samples_ < 0) {
    corruption_[NO_TRAILER] = true;
  } else if (static_cast<std::size_t>(trailer_n_samples_) != samples_.size()) {
    ldmx_log(debug) << "trailer says " << trailer_n_samples_
                    << " samples but found " << samples_.size();
    corruption_[TRAILER_COUNT_MISMATCH] = true;
  }
 
  // only zero padding is expected after the trailer
  if (std::any_of(frame.begin() + offset, frame.end(),
                  [](uint32_t w) { return w != 0; })) {
    ldmx_log(debug) << "non-zero words after the ending trailer";
    corruption_[EXTRA_WORDS] = true;
  }
 
  if (not samples_.empty() and not found_soi) {
    corruption_[NO_SOI] = true;
  }
}

References corruption_, ECON_ID_MISMATCH, packing::DAQSampleHeader::econd_id_, econd_id_, packing::DAQSampleHeader::econd_len_, EXTRA_WORDS, packing::DAQSampleHeader::from(), headers_, packing::DAQSampleHeader::i_l1a_, i_soi_, packing::DAQSampleHeader::is_soi_, packing::DAQSampleHeader::isEndingTrailer(), packing::DAQSampleHeader::isValid(), LOST_SYNC, n_links_, n_skipped_words_, NO_SOI, NO_TRAILER, RESYNC, resync(), SAMPLE_INDEX_MISMATCH, samples_, TRAILER_COUNT_MISMATCH, trailer_n_samples_, packing::DAQSampleHeader::trailerNumSamples(), TRUNCATED_FRAME, packing::DAQSampleHeader::VERSION, and packing::DAQSampleHeader::version_.

isCorrupt()

bool packing::MultiSampleECONDEventPacket::isCorrupt

(

)

const

any of the frame-level corruption flags are set

Definition at line 18 of file MultiSampleECONDEventPacket.cxx.

                                                  {
  return std::any_of(corruption_.begin(), corruption_.end(),
                     [](bool c) { return c; });
}

References corruption_.

resync()

std::size_t packing::MultiSampleECONDEventPacket::resync ( std::span< const uint32_t > frame, std::size_t start, std::size_t i_sample ) const

private

find the next capture header for sample i_sample or the trailer

Definition at line 23 of file MultiSampleECONDEventPacket.cxx.

                                                                          {
  DAQSampleHeader header;
  for (std::size_t i{start}; i < frame.size(); i++) {
    header.from(frame[i]);
    if (header.version_ == DAQSampleHeader::VERSION and
        header.isEndingTrailer()) {
      return i;
    }
    if (DAQSampleHeader::isValid(frame[i]) and header.i_l1a_ == i_sample and
        (econd_id_ < 0 or
         header.econd_id_ == static_cast<uint32_t>(econd_id_))) {
      return i;
    }
  }
  return frame.size();
}

References packing::DAQSampleHeader::econd_id_, econd_id_, packing::DAQSampleHeader::from(), packing::DAQSampleHeader::i_l1a_, packing::DAQSampleHeader::isEndingTrailer(), packing::DAQSampleHeader::isValid(), packing::DAQSampleHeader::VERSION, and packing::DAQSampleHeader::version_.

Referenced by from().

soi()

const ECONDEventPacket & packing::MultiSampleECONDEventPacket::soi

(

)

const

get the sample of interest

Definition at line 14 of file MultiSampleECONDEventPacket.cxx.

                                                               {
  return samples_.at(i_soi_);
}

References i_soi_, and samples_.

Member Data Documentation

corruption_

std::array<bool, N_CORRUPTION> packing::MultiSampleECONDEventPacket::corruption_ {}

corruption flags indexed by Corruption

Definition at line 56 of file MultiSampleECONDEventPacket.h.

{};

Referenced by from(), and isCorrupt().

econd_id_

int packing::MultiSampleECONDEventPacket::econd_id_ {-1}

ID for this econ from the first capture header (-1 if none)

Definition at line 60 of file MultiSampleECONDEventPacket.h.

{-1};

Referenced by from(), and resync().

headers_

std::vector<DAQSampleHeader> packing::MultiSampleECONDEventPacket::headers_

capture headers stored in order of transmission

Definition at line 66 of file MultiSampleECONDEventPacket.h.

Referenced by from().

i_soi_

std::size_t packing::MultiSampleECONDEventPacket::i_soi_ {0}

index of the sample of interest (SOI)

Definition at line 58 of file MultiSampleECONDEventPacket.h.

{0};

Referenced by from(), and soi().

n_links_

int packing::MultiSampleECONDEventPacket::n_links_

private

number of links connected to the ECOND

Definition at line 88 of file MultiSampleECONDEventPacket.h.

Referenced by from().

n_skipped_words_

std::size_t packing::MultiSampleECONDEventPacket::n_skipped_words_ {0}

number of words skipped while searching for capture headers

Definition at line 64 of file MultiSampleECONDEventPacket.h.

{0};

Referenced by from().

samples_

std::vector<ECONDEventPacket> packing::MultiSampleECONDEventPacket::samples_

samples from ECOND stored in order of transmission

Definition at line 68 of file MultiSampleECONDEventPacket.h.

Referenced by from(), and soi().

trailer_n_samples_

int packing::MultiSampleECONDEventPacket::trailer_n_samples_ {-1}

number of samples written in the trailer (-1 if no trailer)

Definition at line 62 of file MultiSampleECONDEventPacket.h.

{-1};

Referenced by from().

---

The documentation for this class was generated from the following files:

• Packing/include/Packing/MultiSampleECONDEventPacket.h
• Packing/src/Packing/MultiSampleECONDEventPacket.cxx