mu2e_artdaq_core  v1_02_11
 All Classes Functions
mu2eFragmentWriter.hh
1 #ifndef mu2e_artdaq_core_Overlays_mu2eFragmentWriter_hh
2 #define mu2e_artdaq_core_Overlays_mu2eFragmentWriter_hh
3 
5 // mu2eFragmentWriter
6 //
7 // Class derived from mu2eFragment which allows writes to the data (for
8 // simulation purposes). Note that for this reason it contains
9 // non-const members which hide the const members in its parent class,
10 // mu2eFragment, including its reference to the artdaq::Fragment
11 // object, artdaq_Fragment_, as well as its functions pointing to the
12 // beginning and end of ADC values in the fragment, dataBegin() and
13 // dataEnd()
14 //
16 
17 #include "artdaq-core/Data/Fragment.hh"
18 #include "mu2e-artdaq-core/Overlays/mu2eFragment.hh"
19 
20 #include <iostream>
21 
22 #include "tracemf.h"
23 
24 namespace mu2e {
25 class mu2eFragmentWriter;
26 }
27 
29  public:
30  mu2eFragmentWriter(artdaq::Fragment &f);
31 
32  // These functions form overload sets with const functions from
33  // mu2e::DTCFragment
34 
35  Header::data_t *dataBegin();
36  Header::data_t *dataAt(size_t index);
37  Header::data_t *dataEnd();
38  Header::data_t *dataAtBytes(size_t offset);
39 
40  // We'll need to hide the const version of header in DTCFragment in
41  // order to be able to perform writes
42 
43  Header *header_() {
44  assert(artdaq_Fragment_.dataSize() >= words_to_frag_words_(Header::size_words));
45  return reinterpret_cast<Header *>(&*artdaq_Fragment_.dataBegin());
46  }
47 
48  void set_hdr_fragment_type(Header::data_t type) { header_()->fragment_type = type; }
49 
50  void addSpace(size_t bytes);
51  void endSubEvt(size_t bytes);
52 
53  private:
54  // Note that this non-const reference hides the const reference in the base class
55  artdaq::Fragment &artdaq_Fragment_;
56  static size_t words_to_frag_words_(size_t nWords);
57 };
58 
59 // The constructor will expect the artdaq::Fragment object it's been
60 // passed to contain the artdaq::Fragment header + the
61 // DTCFragment::Metadata object, otherwise it throws
62 
63 mu2e::mu2eFragmentWriter::mu2eFragmentWriter(artdaq::Fragment &f) : mu2eFragment(f), artdaq_Fragment_(f) {
64  // If this assert doesn't hold, then can't call
65  // "words_to_frag_words_" below, translating between the
66  // DTCFragment's standard data type size and the
67  // artdaq::Fragment's data type size, on the Metadata object
68 
69  TLOG_ARB(TLVL_DEBUG, "mu2eFragmentWriter") << "mu2eFragmentWriter Constructor";
70 
71  assert(sizeof(Metadata::data_t) == sizeof(Header::data_t));
72 
73  if (artdaq_Fragment_.size() !=
74  artdaq::detail::RawFragmentHeader::num_words() + words_to_frag_words_(Metadata::size_words)) {
75  std::cerr << "artdaq_Fragment size: " << artdaq_Fragment_.size() << std::endl;
76  std::cerr << "Expected size: "
77  << artdaq::detail::RawFragmentHeader::num_words() + words_to_frag_words_(Metadata::size_words)
78  << std::endl;
79 
80  throw cet::exception(
81  "mu2eFragmentWriter: Raw artdaq::Fragment object size suggests it does not consist of its own header + the "
82  "mu2eFragment::Metadata object");
83  }
84 
85  // Allocate space for the header
86  artdaq_Fragment_.resize(words_to_frag_words_(Header::size_words));
87  header_()->block_count = 0;
88  memset((void *)&(header_()->index[0]), 0, sizeof(size_t) * mu2e::BLOCK_COUNT_MAX);
89 }
90 
91 inline mu2e::mu2eFragmentWriter::Header::data_t *mu2e::mu2eFragmentWriter::dataBegin() {
92  assert(artdaq_Fragment_.dataSize() >= words_to_frag_words_(Header::size_words));
93  return reinterpret_cast<Header::data_t *>(header_() + 1);
94 }
95 
96 inline mu2e::mu2eFragmentWriter::Header::data_t *mu2e::mu2eFragmentWriter::dataAt(size_t index) {
97  if (index == 0) return dataBegin();
98  auto block = header_()->index[index - 1] / sizeof(Header::data_t);
99  return reinterpret_cast<Header::data_t *>(dataBegin() + block);
100 }
101 
102 inline mu2e::mu2eFragmentWriter::Header::data_t *mu2e::mu2eFragmentWriter::dataEnd() {
103  return dataAt(hdr_block_count());
104 }
105 
106 inline mu2e::mu2eFragmentWriter::Header::data_t *mu2e::mu2eFragmentWriter::dataAtBytes(size_t offset) {
107  return dataBegin() + (offset / sizeof(Header::data_t));
108 }
109 
110 inline size_t mu2e::mu2eFragmentWriter::words_to_frag_words_(size_t nWords) {
111  size_t mod = nWords % words_per_frag_word_();
112  return mod ? nWords / words_per_frag_word_() + 1 : nWords / words_per_frag_word_();
113 }
114 
115 void mu2e::mu2eFragmentWriter::addSpace(size_t bytes) {
116  TLOG_ARB(10, "mu2eFragmentWriter") << "addSpace: START bytes=" << bytes;
117  auto currSize = sizeof(artdaq::Fragment::value_type) * artdaq_Fragment_.size();
118  TLOG_ARB(10, "mu2eFragmentWriter") << "addSpace: Resizing fragment: additional bytes requested: " << bytes
119  << ", size of fragment: " << currSize;
120  artdaq_Fragment_.resizeBytes(bytes + currSize);
121 }
122 
123 void mu2e::mu2eFragmentWriter::endSubEvt(size_t bytes) {
124  TLOG_ARB(11, "mu2eFragmentWriter") << "endSubEvt START bytes=" << bytes;
125  header_()->index[hdr_block_count()] = blockOffset(hdr_block_count()) + bytes;
126  header_()->block_count++;
127  TLOG_ARB(11, "mu2eFragmentWriter") << "endSubEvt END";
128 }
129 
130 #endif /* mu2e_artdaq_core_Overlays_mu2eFragmentWriter_hh */