artdaq_core  v3_05_07
ContainerFragment.hh
1 #ifndef artdaq_core_Data_ContainerFragment_hh
2 #define artdaq_core_Data_ContainerFragment_hh
3 
4 #include "artdaq-core/Data/Fragment.hh"
5 #include "cetlib_except/exception.h"
6 
7 //#include <ostream>
8 //#include <vector>
9 
10 // Implementation of "ContainerFragment", an artdaq::Fragment overlay class
11 
12 namespace artdaq {
13 class ContainerFragment;
14 }
15 
20 {
21 public:
23  static constexpr uint8_t CURRENT_VERSION = 1;
25  static constexpr size_t CONTAINER_MAGIC = 0x00BADDEED5B1BEE5;
26 
30  struct MetadataV0
31  {
35  static constexpr int CONTAINER_FRAGMENT_COUNT_MAX = 100;
36 
37  typedef uint8_t data_t;
38  typedef uint64_t count_t;
39 
43 
46 
48  static size_t const size_words = 8ul + CONTAINER_FRAGMENT_COUNT_MAX * sizeof(size_t) / sizeof(data_t); // Units of Header::data_t
49  };
50  static_assert(sizeof(MetadataV0) == MetadataV0::size_words * sizeof(MetadataV0::data_t), "ContainerFragment::MetadataV0 size changed");
51 
55  struct Metadata
56  {
57  typedef uint8_t data_t;
58  typedef uint64_t count_t;
59 
67  count_t unused : 32;
68 
69  uint64_t index_offset;
70 
72  static size_t const size_words = 16ul; // Units of Header::data_t
73  };
74  static_assert(sizeof(Metadata) == Metadata::size_words * sizeof(Metadata::data_t), "ContainerFragment::Metadata size changed");
75 
81  Metadata const* UpgradeMetadata(MetadataV0 const* in) const
82  {
83  TLOG(TLVL_DEBUG, "ContainerFragment") << "Upgrading ContainerFragment::MetadataV0 into new ContainerFragment::Metadata";
84  assert(in->block_count < std::numeric_limits<Metadata::count_t>::max());
85  metadata_alloc_ = true;
86  Metadata md;
87  md.block_count = in->block_count;
89  md.has_index = 0;
90  md.missing_data = in->missing_data;
91  md.version = 0;
92  index_ptr_ = in->index;
93  metadata_ = new Metadata(md);
94  return metadata_;
95  }
96 
103  explicit ContainerFragment(Fragment const& f)
104  : artdaq_Fragment_(f), index_ptr_(nullptr), index_alloc_(false), metadata_(nullptr), metadata_alloc_(false) {}
105 
106  virtual ~ContainerFragment()
107  {
108  if (index_alloc_)
109  {
110  delete[] index_ptr_;
111  }
112  if (metadata_alloc_)
113  {
114  delete metadata_;
115  }
116  }
117 
122  Metadata const* metadata() const
123  {
124  if (metadata_alloc_) return metadata_;
125 
126  if (artdaq_Fragment_.sizeBytes() - artdaq_Fragment_.dataSizeBytes() - artdaq_Fragment_.headerSizeBytes() == sizeof(MetadataV0))
127  {
128  return UpgradeMetadata(artdaq_Fragment_.metadata<MetadataV0>());
129  }
130 
131  return artdaq_Fragment_.metadata<Metadata>();
132  }
133 
148  bool missing_data() const { return static_cast<bool>(metadata()->missing_data); }
149 
154  void const* dataBegin() const
155  {
156  return reinterpret_cast<void const*>(&*artdaq_Fragment_.dataBegin());
157  }
158 
163  void const* dataEnd() const
164  {
165  return reinterpret_cast<void const*>(reinterpret_cast<uint8_t const*>(dataBegin()) + lastFragmentIndex());
166  }
167 
174  FragmentPtr at(size_t index) const
175  {
176  if (index >= block_count() || block_count() == 0)
177  {
178  throw cet::exception("ArgumentOutOfRange") << "Buffer overrun detected! ContainerFragment::at was asked for a non-existent Fragment!";
179  }
180  // Subtract RawFragmentHeader::num_words here as Fragment consturctor will allocate n + detail::RawFragmentHeader::num_words(), and we want fragSize to be allocated.
182  memcpy(frag->headerAddress(), reinterpret_cast<uint8_t const*>(dataBegin()) + fragmentIndex(index), fragSize(index));
183  return frag;
184  }
185 
192  size_t fragSize(size_t index) const
193  {
194  if (index >= block_count() || block_count() == 0)
195  {
196  throw cet::exception("ArgumentOutOfRange") << "Buffer overrun detected! ContainerFragment::fragSize was asked for a non-existent Fragment!";
197  }
198  auto end = fragmentIndex(index + 1);
199  if (index == 0) return end;
200  return end - fragmentIndex(index);
201  }
202 
209  FragmentPtr operator[](size_t index) const
210  {
211  return this->at(index);
212  }
213 
220  size_t fragmentIndex(size_t index) const
221  {
222  if (index > block_count())
223  {
224  throw cet::exception("ArgumentOutOfRange") << "Buffer overrun detected! ContainerFragment::fragmentIndex was asked for a non-existent Fragment!";
225  }
226  if (index == 0) { return 0; }
227 
228  auto index_ptr = get_index_();
229 
230  return index_ptr[index - 1];
231  }
232 
237  size_t lastFragmentIndex() const
238  {
239  return fragmentIndex(block_count());
240  }
241 
242 protected:
247  static constexpr size_t words_per_frag_word_()
248  {
249  return sizeof(Fragment::value_type) / sizeof(Metadata::data_t);
250  }
251 
256  const size_t* create_index_() const
257  {
258  TLOG(TLVL_TRACE, "ContainerFragment") << "Creating new index for ContainerFragment";
259  auto tmp = new size_t[metadata()->block_count + 1];
260 
261  auto current = reinterpret_cast<uint8_t const*>(artdaq_Fragment_.dataBegin());
262  size_t offset = 0;
263  for (int ii = 0; ii < metadata()->block_count; ++ii)
264  {
265  auto this_size = reinterpret_cast<const detail::RawFragmentHeader*>(current)->word_count * sizeof(RawDataType);
266  offset += this_size;
267  tmp[ii] = offset;
268  current += this_size;
269  }
271  return tmp;
272  }
273 
278  void reset_index_ptr_() const
279  {
280  TLOG(TLVL_TRACE, "ContainerFragment") << "Request to reset index_ptr recieved. has_index=" << metadata()->has_index << ", Check word = " << std::hex
281  << *(reinterpret_cast<size_t const*>(artdaq_Fragment_.dataBeginBytes() + metadata()->index_offset) + metadata()->block_count);
282  if (metadata()->has_index && *(reinterpret_cast<size_t const*>(artdaq_Fragment_.dataBeginBytes() + metadata()->index_offset) + metadata()->block_count) == CONTAINER_MAGIC)
283  {
284  TLOG(TLVL_TRACE, "ContainerFragment") << "Setting index_ptr to found valid index";
285  index_ptr_ = reinterpret_cast<size_t const*>(artdaq_Fragment_.dataBeginBytes() + metadata()->index_offset);
286  }
287  else
288  {
289  TLOG(TLVL_TRACE, "ContainerFragment") << "Index invalid or not found, allocating new index";
290  if (index_alloc_)
291  {
292  delete[] index_ptr_;
293  }
294 
295  index_alloc_ = true;
296  index_ptr_ = create_index_();
297  }
298  }
299 
304  const size_t* get_index_() const
305  {
306  if (index_ptr_ != nullptr) return index_ptr_;
307 
309 
310  return index_ptr_;
311  }
312 
313 private:
314  Fragment const& artdaq_Fragment_;
315 
316  mutable const size_t* index_ptr_;
317  mutable bool index_alloc_;
318  mutable const Metadata* metadata_;
319  mutable bool metadata_alloc_;
320 };
321 
322 #endif /* artdaq_core_Data_ContainerFragment_hh */
std::unique_ptr< Fragment > FragmentPtr
A std::unique_ptr to a Fragment object.
Definition: Fragment.hh:54
static constexpr size_t words_per_frag_word_()
Gets the ratio between the fundamental data storage type and the representation within the Fragment...
uint8_t data_t
Basic unit of data-retrieval.
static size_t const size_words
Size of the Metadata object.
size_t fragmentIndex(size_t index) const
Get the offset of a Fragment within the ContainerFragment.
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:374
uint64_t count_t
Size of block_count variables.
void reset_index_ptr_() const
Reset the index pointer, creating a new index if necessary. ContainerFragmentLoader uses this functio...
std::size_t sizeBytes() const
Size of vals_ vector ( header + (optional) metadata + payload) in bytes.
Definition: Fragment.hh:360
byte_t * dataBeginBytes()
Return Fragment::byte_t* pointing at the beginning of the payload.
Definition: Fragment.hh:551
static constexpr std::size_t num_words()
Returns the number of RawDataType words present in the header.
The RawFragmentHeader class contains the basic fields used by artdaq for routing Fragment objects thr...
detail::RawFragmentHeader::type_t type_t
typedef for type_t from RawFragmentHeader
Definition: Fragment.hh:137
bool missing_data() const
Gets the flag if the ContainerFragment knows that it is missing data.
Metadata const * UpgradeMetadata(MetadataV0 const *in) const
Upgrade the Metadata of a fixed-size ContainerFragment to the new standard.
count_t has_index
Whether the ContainerFragment has an index at the end of the payload.
Fragment::type_t fragment_type() const
Get the Fragment::type_t of stored Fragment objects.
static constexpr size_t CONTAINER_MAGIC
Marker word used in index.
size_t index[CONTAINER_FRAGMENT_COUNT_MAX]
Offset of each Fragment within the ContainerFragment.
count_t fragment_type
The Fragment::type_t of stored Fragment objects.
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.
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:1056
QuickVec< RawDataType >::value_type value_type
Alias value_type type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:185
const size_t * get_index_() const
Get a pointer to the index.
void const * dataBegin() const
Gets the start of the data.
Contains the information necessary for retrieving Fragment objects from the ContainerFragment.
void const * dataEnd() const
Gets the last Fragment in the ContainerFragment.
count_t missing_data
Flag if the ContainerFragment knows that it is missing data.
ContainerFragment(Fragment const &f)
const size_t * create_index_() const
Create an index for the currently-contained Fragments.
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.
Metadata::count_t block_count() const
Gets the number of fragments stored in the ContainerFragment.
T * metadata()
Return a pointer to the metadata. This throws an exception if the Fragment contains no metadata...
Definition: Fragment.hh:938
static constexpr uint8_t CURRENT_VERSION
The current version of the ContainerFragmentHeader.
Metadata const * metadata() const
const getter function for the Metadata
detail::RawFragmentHeader::RawDataType RawDataType
The RawDataType (currently a 64-bit integer) is the basic unit of data representation within artdaq ...
Definition: Fragment.hh:40
count_t block_count
The number of Fragment objects stored in the ContainerFragment.
FragmentPtr operator[](size_t index) const
Alias to ContainerFragment::at()
count_t version
Version number of ContainerFragment.
uint64_t count_t
Size of block_count variables.
A Fragment contains the data from one piece of the DAQ system for one event The artdaq::Fragment is t...
Definition: Fragment.hh:85
FragmentPtr at(size_t index) const
Gets a specific Fragment from the ContainerFragment.
static size_t const size_words
Size of the Metadata object.
static constexpr int CONTAINER_FRAGMENT_COUNT_MAX
The maximum capacity of the ContainerFragment (in fragments)
size_t fragSize(size_t index) const
Gets the size of the Fragment at the specified location in the ContainerFragment, in bytes...
uint64_t index_offset
Index starts this many bytes after the beginning of the payload (is also the total size of contained ...
uint8_t data_t
Basic unit of data-retrieval.