LDMX Software
MultiSampleECONDEventPacket.cxx
1#include "Packing/MultiSampleECONDEventPacket.h"
2
3#include <algorithm>
4
5#include "Packing/Utility/Hex.h"
6
8
9namespace packing {
10
12 int select_econd_id)
13 : n_links_{n_links}, select_econd_id_{select_econd_id} {}
14
18
20 return std::any_of(corruption_.begin(), corruption_.end(),
21 [](bool c) { return c; });
22}
23
24std::size_t MultiSampleECONDEventPacket::resync(std::span<const uint32_t> frame,
25 std::size_t start,
26 std::size_t i_sample) const {
27 DAQSampleHeader header;
28 for (std::size_t i{start}; i < frame.size(); i++) {
29 header.from(frame[i]);
30 if (header.version_ == DAQSampleHeader::VERSION and
31 header.isEndingTrailer()) {
32 return i;
33 }
34 if (DAQSampleHeader::isValid(frame[i]) and header.i_l1a_ == i_sample and
35 (econd_id_ < 0 or
36 header.econd_id_ == static_cast<uint32_t>(econd_id_))) {
37 return i;
38 }
39 }
40 return frame.size();
41}
42
43void MultiSampleECONDEventPacket::from(std::span<const uint32_t> frame) {
44 corruption_.fill(false);
45 i_soi_ = 0;
50 headers_.clear();
51 samples_.clear();
52
53 bool found_soi{false};
54 std::size_t offset{0};
55 DAQSampleHeader header;
56 while (offset < frame.size()) {
57 header.from(frame[offset]);
58 if (header.version_ == DAQSampleHeader::VERSION and
59 header.isEndingTrailer()) {
61 ldmx_log(trace) << "Last sample packet found at offset = " << offset
62 << " (frame.size() = " << frame.size() << ")";
63 offset++;
64 break;
65 }
66
67 // merged frame: skip the samples of the other ECONDs by their length
68 if (select_econd_id_ >= 0 and DAQSampleHeader::isValid(frame[offset]) and
69 header.econd_id_ != static_cast<uint32_t>(select_econd_id_)) {
71 offset += 1 + header.econd_len_;
72 continue;
73 }
74
75 bool valid =
76 DAQSampleHeader::isValid(frame[offset]) and
77 (econd_id_ < 0 or header.econd_id_ == static_cast<uint32_t>(econd_id_));
78 if (not valid) {
79 if (DAQSampleHeader::isValid(frame[offset])) {
81 }
82 auto next = resync(frame, offset + 1, samples_.size());
83 ldmx_log(debug) << Hex(frame[offset])
84 << " is not a capture header, skipping "
85 << (next - offset) << " words";
86 corruption_[RESYNC] = true;
87 n_skipped_words_ += next - offset;
88 if (next == frame.size()) {
89 corruption_[LOST_SYNC] = true;
90 }
91 offset = next;
92 continue;
93 }
94
95 if (econd_id_ < 0) econd_id_ = header.econd_id_;
96 ldmx_log(trace) << Hex(frame[offset]) << " -> " << header;
97
98 // header decoded, shift offset
99 offset++;
100
101 std::size_t i_sample{samples_.size()};
102 if (i_sample != header.i_l1a_) {
103 ldmx_log(debug) << "mismatch between transmitted index " << header.i_l1a_
104 << " and unpacking index for sample " << i_sample;
106 }
107
108 if (header.is_soi_ and not found_soi) {
109 i_soi_ = i_sample;
110 found_soi = true;
111 }
112
113 std::size_t len{header.econd_len_};
114 if (offset + len > frame.size()) {
115 ldmx_log(debug) << "capture header length " << len << " goes past the "
116 << "end of the frame by " << (offset + len - frame.size())
117 << " words";
119 len = frame.size() - offset;
120 }
121
122 headers_.push_back(header);
123 samples_.emplace_back(n_links_);
124 samples_.back().from(frame.subspan(offset, len));
125 offset += len;
126 }
127
128 if (trailer_n_samples_ < 0) {
129 corruption_[NO_TRAILER] = true;
130 } else if (static_cast<std::size_t>(trailer_n_samples_) !=
131 samples_.size() + n_other_samples_) {
132 // the trailer of a merged frame counts the samples of all ECONDs
133 ldmx_log(debug) << "trailer says " << trailer_n_samples_
134 << " samples but found " << samples_.size() << " + "
135 << n_other_samples_ << " from other ECONDs";
137 }
138
139 // only zero padding is expected after the trailer
140 if (std::any_of(frame.begin() + offset, frame.end(),
141 [](uint32_t w) { return w != 0; })) {
142 ldmx_log(debug) << "non-zero words after the ending trailer";
143 corruption_[EXTRA_WORDS] = true;
144 }
145
146 if (not samples_.empty() and not found_soi) {
147 corruption_[NO_SOI] = true;
148 }
149}
150
151} // namespace packing
Single ECON-D event packet.
const ECONDEventPacket & soi() const
get the sample of interest
int n_links_
number of links connected to the ECOND
MultiSampleECONDEventPacket(int n_links, int select_econd_id=-1)
constructor defining how many links are connected to this ECOND
std::size_t n_other_samples_
samples from other ECONDs skipped in a merged frame
int trailer_n_samples_
number of samples written in the trailer (-1 if no trailer)
int select_econd_id_
ECOND to unpack from a merged frame (-1 if not selecting)
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
std::size_t i_soi_
index of the sample of interest (SOI)
bool isCorrupt() const
any of the frame-level corruption flags are set
int econd_id_
ID for this econ from the first capture header (-1 if none)
void from(std::span< const uint32_t > frame)
unpack the given frame into this structure
std::vector< ECONDEventPacket > samples_
samples from ECOND stored in order of transmission
@ NO_TRAILER
the frame ended without the ending trailer
@ RESYNC
a capture header was missing, words were skipped to find the next
@ NO_SOI
no sample flagged as the sample of interest
@ TRUNCATED_FRAME
capture header length goes past the end of the frame
@ LOST_SYNC
no further capture header or trailer found, rest of frame dropped
@ SAMPLE_INDEX_MISMATCH
sample index in capture header does not match its position
@ TRAILER_COUNT_MISMATCH
number of samples in the trailer does not match the number found
@ EXTRA_WORDS
non-zero words after the ending trailer
@ ECON_ID_MISMATCH
ECON ID changed within the frame.
std::vector< DAQSampleHeader > headers_
capture headers stored in order of transmission
std::size_t n_skipped_words_
number of words skipped while searching for capture headers
std::array< bool, N_CORRUPTION > corruption_
corruption flags indexed by Corruption
The capture header that the DAQ firmware inserts before each ECON-D event packet (one per sample) and...
uint32_t version_
format version
bool is_soi_
is this the sample of interest?
bool isEndingTrailer() const
A special form of this DAQ header is used to signal the end of a multi-sample sequence.
uint32_t i_l1a_
index of this sample within the event
void from(uint32_t word)
decode a DAQSampleHeader from the input word
uint32_t econd_id_
configured ID of the ECON
static const uint32_t VERSION
expected format version
uint32_t econd_len_
length of the ECON-D packet following this header in 32b words
static bool isValid(uint32_t word)
check if the decoded word looks like a capture header
static uint32_t trailerNumSamples(uint32_t word)
number of samples written in the ending trailer