artdaq_core  v3_01_04
ContainerFragmentLoader.hh
1 #ifndef artdaq_core_Data_ContainerFragmentLoader_hh
2 #define artdaq_core_Data_ContainerFragmentLoader_hh
3 
5 // ContainerFragmentLoader
6 //
7 // This class gives write access to a ContainerFragment. It should be
8 // used when multiple fragments are generated by one BoardReader for a
9 // single event.
10 //
12 
13 #include "artdaq-core/Data/Fragment.hh"
14 #include "artdaq-core/Data/ContainerFragment.hh"
15 #include "tracemf.h"
16 
17 #include <iostream>
18 
19 #undef TRACE_NAME
20 #define TRACE_NAME "ContainerFragmentLoader"
21 
22 namespace artdaq
23 {
24  class ContainerFragmentLoader;
25 }
26 
27 
32 {
33 public:
34 
35 
42  explicit ContainerFragmentLoader(Fragment& f, Fragment::type_t expectedFragmentType);
43 
44  // ReSharper disable once CppMemberFunctionMayBeConst
50  {
51  assert(artdaq_Fragment_.hasMetadata());
52  return reinterpret_cast<Metadata *>(&*artdaq_Fragment_.metadataAddress());
53  }
54 
60  {
61  metadata()->fragment_type = type;
62  }
63 
72  void set_missing_data(bool isDataMissing)
73  {
74  metadata()->missing_data = isDataMissing;
75  }
76 
82  void addFragment(artdaq::Fragment& frag);
83 
88  void addFragment(artdaq::FragmentPtr& frag);
89 
95 
96 private:
97  // Note that this non-const reference hides the const reference in the base class
98  artdaq::Fragment& artdaq_Fragment_;
99 
100  static size_t words_to_frag_words_(size_t nWords);
101 
102  void addSpace_(size_t bytes);
103 
104  uint8_t* dataBegin_() { return reinterpret_cast<uint8_t*>(&*artdaq_Fragment_.dataBegin()); }
105  void* dataEnd_() { return reinterpret_cast<void*>(dataBegin_() + lastFragmentIndex()); }
106 };
107 
108 inline artdaq::ContainerFragmentLoader::ContainerFragmentLoader(artdaq::Fragment& f, artdaq::Fragment::type_t expectedFragmentType = Fragment::EmptyFragmentType) :
110  , artdaq_Fragment_(f)
111 {
113  Metadata m;
114  m.block_count = 0;
115  m.fragment_type = expectedFragmentType;
116  m.missing_data = false;
117  for (int ii = 0; ii < CONTAINER_FRAGMENT_COUNT_MAX; ++ii)
118  {
119  m.index[ii] = 0;
120  }
121  artdaq_Fragment_.setMetadata<Metadata>(m);
122 
123  if (artdaq_Fragment_.size() !=
125  words_to_frag_words_(Metadata::size_words))
126  {
127  TLOG(TLVL_ERROR) << "ContainerFragmentLoader: Raw artdaq::Fragment object size suggests it does not consist of its own header + the ContainerFragment::Metadata object" << TLOG_ENDL;
128  TLOG(TLVL_ERROR) << "artdaq_Fragment size: " << artdaq_Fragment_.size() << ", Expected size: " << artdaq::detail::RawFragmentHeader::num_words() + words_to_frag_words_(Metadata::size_words) << TLOG_ENDL;
129 
130  throw cet::exception("InvalidFragment") << "ContainerFragmentLoader: Raw artdaq::Fragment object size suggests it does not consist of its own header + the ContainerFragment::Metadata object";
131  }
132 }
133 
134 inline size_t artdaq::ContainerFragmentLoader::words_to_frag_words_(size_t nWords)
135 {
136  size_t mod = nWords % words_per_frag_word_();
137  return mod ?
138  nWords / words_per_frag_word_() + 1 :
139  nWords / words_per_frag_word_();
140 }
141 
142 inline void artdaq::ContainerFragmentLoader::addSpace_(size_t bytes)
143 {
144  auto currSize = sizeof(artdaq::Fragment::value_type) * artdaq_Fragment_.dataSize(); // Resize takes into account header and metadata size
145  artdaq_Fragment_.resizeBytes(bytes + currSize);
146  TLOG(4) << "addSpace_: dataEnd_ is now at " << (void*)dataEnd_();
147 }
148 
150 {
151  if (metadata()->block_count >= CONTAINER_FRAGMENT_COUNT_MAX)
152  {
153  TLOG(TLVL_ERROR) << "addFragment: Fragment is full, cannot add more fragments!" << TLOG_ENDL;
154  throw cet::exception("ContainerFull") << "ContainerFragmentLoader::addFragment: Fragment is full, cannot add more fragments!";
155  }
156 
157  TLOG(4) << "addFragment: Adding Fragment with payload size " << frag.dataSizeBytes() << " to Container";
158  if (metadata()->fragment_type == Fragment::EmptyFragmentType) metadata()->fragment_type = frag.type();
159  else if (frag.type() != metadata()->fragment_type)
160  {
161  TLOG(TLVL_ERROR) << "addFragment: Trying to add a fragment of different type than what's already been added!" << TLOG_ENDL;
162  throw cet::exception("WrongFragmentType") << "ContainerFragmentLoader::addFragment: Trying to add a fragment of different type than what's already been added!";
163  }
164  TLOG(4) << "addFragment: Payload Size is " << artdaq_Fragment_.dataSizeBytes() << ", lastFragmentIndex is " << lastFragmentIndex() << ", and frag.size is " << frag.sizeBytes();
165  if (artdaq_Fragment_.dataSizeBytes() < lastFragmentIndex() + frag.sizeBytes())
166  {
167  addSpace_(frag.sizeBytes());
168  }
169  frag.setSequenceID(artdaq_Fragment_.sequenceID());
170  TLOG(4) << "addFragment, copying " << frag.sizeBytes() << " bytes from " << (void*)frag.headerAddress() << " to " << (void*)dataEnd_();
171  memcpy(dataEnd_(), frag.headerAddress(), frag.sizeBytes());
172  metadata()->index[block_count()] = lastFragmentIndex() + frag.sizeBytes();
173  metadata()->block_count++;
174 }
175 
177 {
178  addFragment(*frag);
179 }
180 
182 {
183  for (auto& frag : frags)
184  {
185  addFragment((*frag));
186  }
187 }
188 
189 #endif /* artdaq_core_Data_ContainerFragmentLoader_hh */
std::unique_ptr< Fragment > FragmentPtr
A std::unique_ptr to a Fragment object.
Definition: Fragment.hh:53
static size_t const size_words
Size of the Metadata object.
The artdaq::ContainerFragment class represents a Fragment which contains other Fragments.
std::size_t dataSizeBytes() const
Return the number of bytes in the data payload. This does not include the number of bytes in the head...
Definition: Fragment.hh:355
void setSequenceID(sequence_id_t sequence_id)
Sets the Sequence ID of the Fragment.
Definition: Fragment.hh:861
void setSystemType(type_t stype)
Sets the type of the Fragment, checking that it is a valid system type.
Definition: Fragment.hh:854
std::size_t size() const
Gets the size of the Fragment, from the Fragment header.
Definition: Fragment.hh:798
void set_fragment_type(Fragment::type_t type)
Sets the type of Fragment which this ContainerFragment should contain.
A Read-Write version of the ContainerFragment, used for filling ContainerFragment objects with other ...
static constexpr type_t EmptyFragmentType
Copy EmptyFragmentType from RawFragmentHeader.
Definition: Fragment.hh:154
std::size_t sizeBytes() const
Size of vals_ vector ( header + (optional) metadata + payload) in bytes.
Definition: Fragment.hh:340
static constexpr std::size_t num_words()
Returns the number of RawDataType words present in the header.
detail::RawFragmentHeader::type_t type_t
typedef for type_t from RawFragmentHeader
Definition: Fragment.hh:136
static const int CONTAINER_FRAGMENT_COUNT_MAX
The maximum capacity of the ContainerFragment (in fragments)
count_t fragment_type
The Fragment::type_t of stored Fragment objects.
size_t lastFragmentIndex() const
Returns the offset of the last Fragment in the ContainerFragment.
Metadata * metadata()
Get the ContainerFragment metadata (includes information about the location of Fragment objects withi...
void addFragment(artdaq::Fragment &frag)
Add a Fragment to the ContainerFragment by reference.
count_t block_count
The number of Fragment objects stored in the ContainerFragment.
iterator dataBegin()
Return an iterator to the beginning of the data payload (after header and metadata) ...
Definition: Fragment.hh:1025
QuickVec< RawDataType >::value_type value_type
Alias value_type type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:183
Contains the information necessary for retrieving Fragment objects from the ContainerFragment.
count_t missing_data
Flag if the ContainerFragment knows that it is missing data.
static constexpr type_t ContainerFragmentType
Copy ContainerFragmentType from RawFragmentHeader.
Definition: Fragment.hh:155
ContainerFragmentLoader(Fragment &f, Fragment::type_t expectedFragmentType)
Constructs the ContainerFragmentLoader.
void setMetadata(const T &md)
Set the metadata in the Fragment to the contents of the specified structure. This throws an exception...
Definition: Fragment.hh:936
type_t type() const
Type of the Fragment, from the Fragment header.
Definition: Fragment.hh:812
RawDataType * metadataAddress()
Get the address of the metadata. For internal use only, use metadata() instead.
Definition: Fragment.hh:1109
size_t index[CONTAINER_FRAGMENT_COUNT_MAX]
Offset of each Fragment within the ContainerFragment.
std::list< FragmentPtr > FragmentPtrs
A std::list of FragmentPtrs.
Definition: Fragment.hh:58
bool hasMetadata() const
Test whether this Fragment has metadata.
Definition: Fragment.hh:902
A Fragment contains the data from one piece of the DAQ system for one event The artdaq::Fragment is t...
Definition: Fragment.hh:84
void set_missing_data(bool isDataMissing)
Sets the missing_data flag.
void addFragments(artdaq::FragmentPtrs &frags)
Add a collection of Fragment objects to the ContainerFragment.
RawDataType * headerAddress()
Gets the address of the header.
Definition: Fragment.hh:1121