artdaq_core  v3_05_10
Fragment.hh
1 #ifndef artdaq_core_Data_Fragment_hh
2 #define artdaq_core_Data_Fragment_hh
3 
4 #include <algorithm>
5 //#include <cassert>
6 #include <stdint.h>
7 #include <string.h>
8 #include <cmath>
9 #include <cstddef>
10 #include <iosfwd>
11 #include <iterator>
12 #include <list>
13 #include <map>
14 #include <memory>
15 #include <vector>
16 
17 #include <iostream>
18 #include "artdaq-core/Core/QuickVec.hh"
19 #include "artdaq-core/Data/detail/RawFragmentHeader.hh"
20 #include "artdaq-core/Data/detail/RawFragmentHeaderV0.hh"
21 #include "artdaq-core/Data/detail/RawFragmentHeaderV1.hh"
22 #include "artdaq-core/Data/dictionarycontrol.hh"
23 #if HIDE_FROM_ROOT
24 #include "trace.h" // TRACE
25 #endif
26 
30 namespace artdaq {
31 #define DATAVEC_T QuickVec<RawDataType>
32 //#define DATAVEC_T std::vector<RawDataType>
33 
41 
42 class Fragment;
46 typedef std::vector<Fragment> Fragments;
47 
54 typedef std::unique_ptr<Fragment> FragmentPtr;
55 
59 typedef std::list<FragmentPtr> FragmentPtrs;
60 
68 
75 std::ostream& operator<<(std::ostream& os, Fragment const& f);
76 } // namespace artdaq
77 
86 {
87 public:
91  Fragment();
92 
100  typedef uint8_t byte_t;
101 
102  // Hide most things from ROOT.
103 #if HIDE_FROM_ROOT
104 
105  // http://stackoverflow.com/questions/33939687
106  // This should generate an exception if artdaq::Fragment is not move-constructible
111  Fragment(const Fragment&) = default;
119  Fragment(Fragment&&) noexcept;
125  Fragment& operator=(const Fragment&) = default;
134  Fragment& operator=(Fragment&&) noexcept;
135 
136  typedef detail::RawFragmentHeader::version_t version_t;
137  typedef detail::RawFragmentHeader::type_t type_t;
138  typedef detail::RawFragmentHeader::sequence_id_t sequence_id_t;
139  typedef detail::RawFragmentHeader::fragment_id_t fragment_id_t;
140  typedef detail::RawFragmentHeader::timestamp_t timestamp_t;
141 
142  static constexpr version_t InvalidVersion = detail::RawFragmentHeader::InvalidVersion;
143  static constexpr sequence_id_t InvalidSequenceID = detail::RawFragmentHeader::InvalidSequenceID;
144  static constexpr fragment_id_t InvalidFragmentID = detail::RawFragmentHeader::InvalidFragmentID;
145  static constexpr timestamp_t InvalidTimestamp = detail::RawFragmentHeader::InvalidTimestamp;
146 
147  static constexpr type_t InvalidFragmentType = detail::RawFragmentHeader::InvalidFragmentType;
148  static constexpr type_t EndOfDataFragmentType = detail::RawFragmentHeader::EndOfDataFragmentType;
149  static constexpr type_t DataFragmentType = detail::RawFragmentHeader::DataFragmentType;
150  static constexpr type_t InitFragmentType = detail::RawFragmentHeader::InitFragmentType;
151  static constexpr type_t EndOfRunFragmentType = detail::RawFragmentHeader::EndOfRunFragmentType;
152  static constexpr type_t EndOfSubrunFragmentType = detail::RawFragmentHeader::EndOfSubrunFragmentType;
153  static constexpr type_t ShutdownFragmentType = detail::RawFragmentHeader::ShutdownFragmentType;
154  static constexpr type_t FirstUserFragmentType = detail::RawFragmentHeader::FIRST_USER_TYPE;
155  static constexpr type_t EmptyFragmentType = detail::RawFragmentHeader::EmptyFragmentType;
156  static constexpr type_t ContainerFragmentType = detail::RawFragmentHeader::ContainerFragmentType;
157  static constexpr type_t ErrorFragmentType = detail::RawFragmentHeader::ErrorFragmentType;
158 
164  static constexpr bool isUserFragmentType(type_t fragmentType);
165 
171  static constexpr bool isSystemFragmentType(type_t fragmentType);
172 
177  static std::map<type_t, std::string> MakeSystemTypeMap()
178  {
180  }
181 
182  typedef DATAVEC_T::reference reference;
183  typedef DATAVEC_T::iterator iterator;
184  typedef DATAVEC_T::const_iterator const_iterator;
185  typedef DATAVEC_T::value_type value_type;
186  typedef DATAVEC_T::difference_type difference_type;
187  typedef DATAVEC_T::size_type size_type;
188 
194  explicit Fragment(std::size_t n);
195 
202  static FragmentPtr FragmentBytes(std::size_t nbytes)
203  {
204  RawDataType nwords = ceil(nbytes / static_cast<double>(sizeof(RawDataType)));
205  return FragmentPtr(new Fragment(nwords));
206  }
207 
218  template<class T>
219  Fragment(std::size_t payload_size, sequence_id_t sequence_id,
220  fragment_id_t fragment_id, type_t type, const T& metadata,
222 
236  template<class T>
237  static FragmentPtr FragmentBytes(std::size_t payload_size_in_bytes,
238  sequence_id_t sequence_id,
239  fragment_id_t fragment_id,
240  type_t type, const T& metadata,
242  {
243  RawDataType nwords = ceil(payload_size_in_bytes /
244  static_cast<double>(sizeof(RawDataType)));
245  return FragmentPtr(new Fragment(nwords, sequence_id, fragment_id, type, metadata, timestamp));
246  }
247 
256  fragment_id_t fragID,
259 
264  void print(std::ostream& os) const;
265 
270  std::size_t size() const;
271 
276  version_t version() const;
277 
282  type_t type() const;
283 
288  std::string typeString() const;
289 
294  sequence_id_t sequenceID() const;
295 
300  fragment_id_t fragmentID() const;
301 
306  timestamp_t timestamp() const;
307 
312  void setUserType(type_t utype);
313 
318  void setSystemType(type_t stype);
319 
324  void setSequenceID(sequence_id_t sequence_id);
325 
330  void setFragmentID(fragment_id_t fragment_id);
331 
337 
341  void touch();
342 
347  struct timespec atime() const;
348 
354  struct timespec getLatency(bool touch);
355 
360  std::size_t sizeBytes() const { return sizeof(RawDataType) * size(); }
361 
367  std::size_t dataSize() const;
368 
374  std::size_t dataSizeBytes() const
375  {
376  return sizeof(RawDataType) * dataSize();
377  }
378 
383  bool hasMetadata() const;
384 
392  template<class T>
393  T* metadata();
394 
402  template<class T>
403  T const* metadata() const;
404 
413  template<class T>
414  void setMetadata(const T& md);
415 
423  template<class T>
424  void updateMetadata(const T& md);
425 
430  void resize(std::size_t sz);
431 
437  void resize(std::size_t sz, RawDataType val);
438 
445  void resizeBytes(std::size_t szbytes);
446 
455  void resizeBytesWithCushion(std::size_t szbytes, double growthFactor = 1.3);
456 
464  void resizeBytes(std::size_t szbytes, byte_t val);
465 
469  void autoResize();
470 
476 
481  iterator dataEnd();
482 
502  template<typename T>
504  {
505  T newpointer = reinterpret_cast<T>(in);
506 
507  if (static_cast<const void*>(newpointer) != static_cast<const void*>(in))
508  {
509  throw cet::exception("Error in Fragment.hh: reinterpret_cast failed to return expected address-- please contact John Freeman at jcfree@fnal.gov");
510  }
511 
512  return newpointer;
513  }
514 
530  template<typename T>
532  {
533  T newpointer = reinterpret_cast<T>(in);
534 
535  if (static_cast<void*>(newpointer) != static_cast<void*>(in))
536  {
537  throw cet::exception("Error in Fragment.hh: reinterpret_cast failed to return expected address-- please contact John Freeman at jcfree@fnal.gov");
538  }
539 
540  return newpointer;
541  }
542 
551  byte_t* dataBeginBytes() { return reinterpret_cast_checked<byte_t*>(&*dataBegin()); }
552 
561  byte_t* dataEndBytes() { return reinterpret_cast_checked<byte_t*>(&*dataEnd()); }
562 
569 
574  byte_t* headerBeginBytes() { return reinterpret_cast_checked<byte_t*>(&*headerBegin()); }
575 
580  const_iterator dataBegin() const;
581 
586  const_iterator dataEnd() const;
587 
596  const byte_t* dataBeginBytes() const
597  {
598  return reinterpret_cast_checked<const byte_t*>(&*dataBegin());
599  }
600 
609  const byte_t* dataEndBytes() const
610  {
611  return reinterpret_cast_checked<const byte_t*>(&*dataEnd());
612  }
613 
619  const_iterator headerBegin() const; // See note for non-const, above.
620 
625  const byte_t* headerBeginBytes() const
626  {
627  return reinterpret_cast_checked<const byte_t*>(&*headerBegin());
628  }
629 
634  size_t headerSizeWords() const;
635 
640  size_t headerSizeBytes() const { return sizeof(RawDataType) * headerSizeWords(); }
641 
645  void clear();
646 
651  bool empty();
652 
657  void reserve(std::size_t cap);
658 
663  void swap(Fragment& other) noexcept;
664 
671  void swap(DATAVEC_T& other) noexcept { vals_.swap(other); };
672 
678 
691 
697  static FragmentPtr eodFrag(size_t nFragsToExpect);
698 
710  template<class InputIterator>
712  fragment_id_t fragID,
713  InputIterator i,
714  InputIterator e)
715  {
716  FragmentPtr result(new Fragment(sequenceID, fragID));
717  result->vals_.reserve(std::distance(i, e) + detail::RawFragmentHeader::num_words());
718  std::copy(i, e, std::back_inserter(result->vals_));
719  result->updateFragmentHeaderWC_();
720  return result;
721  }
722 
733  fragment_id_t fragID,
734  RawDataType const* dataPtr,
735  size_t dataSize,
737 #endif
738 
739 private:
740  template<typename T>
741  static std::size_t validatedMetadataSize_();
742 
743  void updateFragmentHeaderWC_();
744 
745  DATAVEC_T vals_;
746 
747 #if HIDE_FROM_ROOT
748 
749  detail::RawFragmentHeader* fragmentHeaderPtr();
750 
751  detail::RawFragmentHeader const fragmentHeader() const;
752 #endif
753 };
754 
755 #if HIDE_FROM_ROOT
756 
757 // http://stackoverflow.com/questions/33939687
758 // This should generate an exception if artdaq::Fragment is not move-constructible
759 inline artdaq::Fragment::Fragment(artdaq::Fragment&&) noexcept = default;
760 inline artdaq::Fragment& artdaq::Fragment::operator=(artdaq::Fragment&&) noexcept = default;
761 
762 inline bool constexpr artdaq::Fragment::
763  isUserFragmentType(type_t fragmentType)
764 {
765  return fragmentType >= detail::RawFragmentHeader::FIRST_USER_TYPE &&
766  fragmentType <= detail::RawFragmentHeader::LAST_USER_TYPE;
767 }
768 
769 inline bool constexpr artdaq::Fragment::
771 {
772  return fragmentType >= detail::RawFragmentHeader::FIRST_SYSTEM_TYPE;
773 }
774 
775 template<typename T>
776 std::size_t
777 artdaq::Fragment::
778  validatedMetadataSize_()
779 {
780  // Make sure a size_t is big enough to hold the maximum metadata
781  // size. This *should* always be true, but it is a compile-time check
782  // and therefore cheap.
783  static_assert(sizeof(size_t) >=
784  sizeof(decltype(std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max())),
785  "metadata_word_count_t is too big!");
786 
787  static size_t constexpr max_md_wc =
788  std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max();
789  size_t requested_md_wc =
790  std::ceil(sizeof(T) / static_cast<double>(sizeof(artdaq::RawDataType)));
791  if (requested_md_wc > max_md_wc)
792  {
793  throw cet::exception("InvalidRequest")
794  << "The requested metadata structure is too large: "
795  << "requested word count = " << requested_md_wc
796  << ", maximum word count = " << max_md_wc;
797  }
798  return requested_md_wc;
799 }
800 
801 template<class T>
803  Fragment(std::size_t payload_size, sequence_id_t sequence_id,
804  fragment_id_t fragment_id,
805  type_t type, const T& metadata, timestamp_t timestamp)
806  : vals_((artdaq::detail::RawFragmentHeader::num_words() + // Header
807  validatedMetadataSize_<T>() + // Metadata
808  payload_size) // User data
809  )
810 {
811  TRACEN("Fragment", 50, "Fragment ctor num_word()=%zu MetadataSize_=%zu payload_size=%zu", artdaq::detail::RawFragmentHeader::num_words(), validatedMetadataSize_<T>(), payload_size);
812  // vals ctor w/o init val is used; make sure header is ALL initialized.
813  for (iterator ii = vals_.begin();
814  ii != (vals_.begin() + detail::RawFragmentHeader::num_words()); ++ii)
815  {
816  *ii = -1;
817  }
818  fragmentHeaderPtr()->version = detail::RawFragmentHeader::CurrentVersion;
819  updateFragmentHeaderWC_();
820  fragmentHeaderPtr()->sequence_id = sequence_id;
821  fragmentHeaderPtr()->fragment_id = fragment_id;
822  fragmentHeaderPtr()->timestamp = timestamp;
823  fragmentHeaderPtr()->type = type;
824 
825  fragmentHeaderPtr()->touch();
826 
827  fragmentHeaderPtr()->metadata_word_count =
828  vals_.size() -
829  (headerSizeWords() + payload_size);
830 
831  memcpy(metadataAddress(), &metadata, sizeof(T));
832 }
833 
834 inline std::size_t
836 {
837  return fragmentHeader().word_count;
838 }
839 
842 {
843  auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
844  return hdr->version;
845 }
846 
849 {
850  return static_cast<type_t>(fragmentHeader().type);
851 }
852 
853 inline std::string
855 {
856  return std::to_string(type()) + (isSystemFragmentType(type()) ? " (" + detail::RawFragmentHeader::SystemTypeToString(type()) + ")" : "");
857 }
858 
861 {
862  return fragmentHeader().sequence_id;
863 }
864 
867 {
868  return fragmentHeader().fragment_id;
869 }
870 
873 {
874  return fragmentHeader().timestamp;
875 }
876 
877 inline void
879 {
880  fragmentHeaderPtr()->setUserType(static_cast<uint8_t>(type));
881 }
882 
883 inline void
885 {
886  fragmentHeaderPtr()->setSystemType(static_cast<uint8_t>(type));
887 }
888 
889 inline void
891 {
892  assert(sequence_id <= detail::RawFragmentHeader::InvalidSequenceID);
893  fragmentHeaderPtr()->sequence_id = sequence_id;
894 }
895 
896 inline void
898 {
899  fragmentHeaderPtr()->fragment_id = fragment_id;
900 }
901 
902 inline void
904 {
905  fragmentHeaderPtr()->timestamp = timestamp;
906 }
907 
909 {
910  fragmentHeaderPtr()->touch();
911 }
912 
913 inline struct timespec artdaq::Fragment::atime() const
914 {
915  return fragmentHeader().atime();
916 }
917 
918 inline struct timespec artdaq::Fragment::getLatency(bool touch)
919 {
920  return fragmentHeaderPtr()->getLatency(touch);
921 }
922 
923 inline void
924 artdaq::Fragment::updateFragmentHeaderWC_()
925 {
926  // Make sure vals_.size() fits inside 32 bits. Left-shift here should
927  // match bitfield size of word_count in RawFragmentHeader.
928  assert(vals_.size() < (1ULL << 32));
929  TRACEN("Fragment", 50, "Fragment::updateFragmentHeaderWC_ adjusting fragmentHeader()->word_count from %u to %zu", (unsigned)(fragmentHeaderPtr()->word_count), vals_.size());
930  fragmentHeaderPtr()->word_count = vals_.size();
931 }
932 
933 inline std::size_t
935 {
936  return vals_.size() - headerSizeWords() -
937  fragmentHeader().metadata_word_count;
938 }
939 
940 inline bool
942 {
943  return fragmentHeader().metadata_word_count != 0;
944 }
945 
946 template<class T>
948 {
949  if (fragmentHeader().metadata_word_count == 0)
950  {
951  throw cet::exception("InvalidRequest")
952  << "No metadata has been stored in this Fragment.";
953  }
954 
955  return reinterpret_cast_checked<T*>(&vals_[headerSizeWords()]);
956 }
957 
958 template<class T>
959 T const*
961 {
962  if (fragmentHeader().metadata_word_count == 0)
963  {
964  throw cet::exception("InvalidRequest")
965  << "No metadata has been stored in this Fragment.";
966  }
967  return reinterpret_cast_checked<T const*>(&vals_[headerSizeWords()]);
968 }
969 
970 template<class T>
971 void artdaq::Fragment::setMetadata(const T& metadata)
972 {
973  if (fragmentHeader().metadata_word_count != 0)
974  {
975  throw cet::exception("InvalidRequest")
976  << "Metadata has already been stored in this Fragment.";
977  }
978  auto const mdSize = validatedMetadataSize_<T>();
979  vals_.insert(dataBegin(), mdSize, 0);
980  updateFragmentHeaderWC_();
981  fragmentHeaderPtr()->metadata_word_count = mdSize;
982 
983  memcpy(metadataAddress(), &metadata, sizeof(T));
984 }
985 
986 template<class T>
987 void artdaq::Fragment::updateMetadata(const T& metadata)
988 {
989  if (fragmentHeader().metadata_word_count == 0)
990  {
991  throw cet::exception("InvalidRequest")
992  << "No metadata in fragment; please use Fragment::setMetadata instead of Fragment::updateMetadata";
993  }
994 
995  auto const mdSize = validatedMetadataSize_<T>();
996 
997  if (fragmentHeader().metadata_word_count != mdSize)
998  {
999  throw cet::exception("InvalidRequest")
1000  << "Mismatch between type of metadata struct passed to updateMetadata and existing metadata struct";
1001  }
1002 
1003  memcpy(metadataAddress(), &metadata, sizeof(T));
1004 }
1005 
1006 inline void
1008 {
1009  vals_.resize(sz + fragmentHeaderPtr()->metadata_word_count +
1010  headerSizeWords());
1011  updateFragmentHeaderWC_();
1012 }
1013 
1014 inline void
1016 {
1017  vals_.resize(sz + fragmentHeaderPtr()->metadata_word_count +
1018  headerSizeWords(),
1019  v);
1020  updateFragmentHeaderWC_();
1021 }
1022 
1023 inline void
1024 artdaq::Fragment::resizeBytes(std::size_t szbytes)
1025 {
1026  RawDataType nwords = ceil(szbytes / static_cast<double>(sizeof(RawDataType)));
1027  resize(nwords);
1028 }
1029 
1030 inline void
1031 artdaq::Fragment::resizeBytesWithCushion(std::size_t szbytes, double growthFactor)
1032 {
1033  RawDataType nwords = ceil(szbytes / static_cast<double>(sizeof(RawDataType)));
1034  vals_.resizeWithCushion(nwords + fragmentHeaderPtr()->metadata_word_count +
1035  headerSizeWords(),
1036  growthFactor);
1037  updateFragmentHeaderWC_();
1038 }
1039 
1040 inline void
1041 artdaq::Fragment::resizeBytes(std::size_t szbytes, byte_t v)
1042 {
1043  RawDataType defaultval;
1044  byte_t* ptr = reinterpret_cast_checked<byte_t*>(&defaultval);
1045 
1046  for (uint8_t i = 0; i < sizeof(RawDataType); ++i)
1047  {
1048  *ptr = v;
1049  ptr++;
1050  }
1051 
1052  RawDataType nwords = ceil(szbytes / static_cast<double>(sizeof(RawDataType)));
1053 
1054  resize(nwords, defaultval);
1055 }
1056 
1057 inline void
1059 {
1060  vals_.resize(fragmentHeaderPtr()->word_count);
1061  updateFragmentHeaderWC_();
1062 }
1063 
1066 {
1067  return vals_.begin() + headerSizeWords() +
1068  fragmentHeader().metadata_word_count;
1069 }
1070 
1073 {
1074  return vals_.end();
1075 }
1076 
1079 {
1080  return vals_.begin();
1081 }
1082 
1085 {
1086  return vals_.begin() + headerSizeWords() +
1087  fragmentHeader().metadata_word_count;
1088 }
1089 
1092 {
1093  return vals_.end();
1094 }
1095 
1098 {
1099  return vals_.begin();
1100 }
1101 
1102 inline void
1104 {
1105  vals_.erase(dataBegin(), dataEnd());
1106  updateFragmentHeaderWC_();
1107 }
1108 
1109 inline bool
1111 {
1112  return (vals_.size() - headerSizeWords() -
1113  fragmentHeader().metadata_word_count) == 0;
1114 }
1115 
1116 inline void
1118 {
1119  vals_.reserve(cap + headerSizeWords() +
1120  fragmentHeader().metadata_word_count);
1121 }
1122 
1123 inline void
1125 {
1126  vals_.swap(other.vals_);
1127 }
1128 
1129 inline artdaq::RawDataType*
1131 {
1132  return &vals_[0] + headerSizeWords() +
1133  fragmentHeader().metadata_word_count;
1134 }
1135 
1136 inline artdaq::RawDataType*
1138 {
1139  if (fragmentHeader().metadata_word_count == 0)
1140  {
1141  throw cet::exception("InvalidRequest")
1142  << "No metadata has been stored in this Fragment.";
1143  }
1144  return &vals_[0] + headerSizeWords();
1145 }
1146 
1147 inline artdaq::RawDataType*
1149 {
1150  return &vals_[0];
1151 }
1152 
1153 inline size_t
1155 {
1156  auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
1157  if (hdr->version != detail::RawFragmentHeader::CurrentVersion)
1158  {
1159  switch (hdr->version)
1160  {
1161  case 0xFFFF:
1162  TLOG(51, "Fragment") << "Cannot get header size of InvalidVersion Fragment";
1163  break;
1164  case 0:
1165  {
1166  TLOG(52, "Fragment") << "Getting size of RawFragmentHeaderV0";
1167  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 const*>(&vals_[0]);
1168  return old_hdr->num_words();
1169  break;
1170  }
1171  case 1:
1172  {
1173  TLOG(52, "Fragment") << "Getting size of RawFragmentHeaderV1";
1174  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV1 const*>(&vals_[0]);
1175  return old_hdr->num_words();
1176  break;
1177  }
1178  default:
1179  throw cet::exception("Fragment") << "A Fragment with an unknown version (" << std::to_string(hdr->version) << ") was received!";
1180  break;
1181  }
1182  }
1183  return hdr->num_words();
1184 }
1185 
1187 artdaq::Fragment::fragmentHeaderPtr()
1188 {
1189  auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader*>(&vals_[0]);
1190  if (hdr->version != detail::RawFragmentHeader::CurrentVersion)
1191  {
1192  switch (hdr->version)
1193  {
1194  case 0xFFFF:
1195  TLOG(51, "Fragment") << "Not upgrading InvalidVersion Fragment";
1196  break;
1197  case 0:
1198  {
1199  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV0 (non const)";
1200  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0*>(&vals_[0]);
1201  auto new_hdr = old_hdr->upgrade();
1202 
1203  auto szDiff = hdr->num_words() - old_hdr->num_words();
1204  if (szDiff > 0)
1205  {
1206  vals_.insert(vals_.begin(), szDiff, 0);
1207  new_hdr.word_count = vals_.size();
1208  }
1209  memcpy(&vals_[0], &new_hdr, hdr->num_words() * sizeof(RawDataType));
1210  hdr = reinterpret_cast_checked<detail::RawFragmentHeader*>(&vals_[0]); // Update hdr in case vals_->insert call invalidated pointers
1211  break;
1212  }
1213  case 1:
1214  {
1215  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV1 (non const)";
1216  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV1*>(&vals_[0]);
1217  auto new_hdr = old_hdr->upgrade();
1218 
1219  auto szDiff = hdr->num_words() - old_hdr->num_words();
1220  if (szDiff > 0)
1221  {
1222  vals_.insert(vals_.begin(), szDiff, 0);
1223  new_hdr.word_count = vals_.size();
1224  }
1225  memcpy(&vals_[0], &new_hdr, hdr->num_words() * sizeof(RawDataType));
1226  hdr = reinterpret_cast_checked<detail::RawFragmentHeader*>(&vals_[0]); // Update hdr in case vals_->insert call invalidated pointers
1227  break;
1228  }
1229  default:
1230  throw cet::exception("Fragment") << "A Fragment with an unknown version (" << std::to_string(hdr->version) << ") was received!";
1231  break;
1232  }
1233  }
1234  return hdr;
1235 }
1236 
1238 artdaq::Fragment::fragmentHeader() const
1239 {
1240  auto hdr = *reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
1241  if (hdr.version != detail::RawFragmentHeader::CurrentVersion)
1242  {
1243  switch (hdr.version)
1244  {
1245  case 0xFFFF:
1246  TLOG(51, "Fragment") << "Not upgrading InvalidVersion Fragment";
1247  break;
1248  case 0:
1249  {
1250  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV0 (const)";
1251  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 const*>(&vals_[0]);
1252  hdr = old_hdr->upgrade();
1253 
1254  break;
1255  }
1256  case 1:
1257  {
1258  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV1 (const)";
1259  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV1 const*>(&vals_[0]);
1260  hdr = old_hdr->upgrade();
1261 
1262  break;
1263  }
1264  default:
1265  throw cet::exception("Fragment") << "A Fragment with an unknown version (" << std::to_string(hdr.version) << ") was received!";
1266  break;
1267  }
1268  }
1269  return hdr;
1270 }
1271 
1272 inline void
1273 swap(artdaq::Fragment& x, artdaq::Fragment& y) noexcept
1274 {
1275  x.swap(y);
1276 }
1277 
1278 inline std::ostream&
1279 artdaq::operator<<(std::ostream& os, artdaq::Fragment const& f)
1280 {
1281  f.print(os);
1282  return os;
1283 }
1284 #endif /* HIDE_FROM_ROOT */
1285 
1286 #endif /* artdaq_core_Data_Fragment_hh */
std::unique_ptr< Fragment > FragmentPtr
A std::unique_ptr to a Fragment object.
Definition: Fragment.hh:54
void reserve(std::size_t cap)
Reserves enough memory to hold cap RawDataType words in the Fragment payload.
Definition: Fragment.hh:1117
detail::RawFragmentHeader::timestamp_t timestamp_t
typedef for timestamp_t from RawFragmentHeader
Definition: Fragment.hh:140
RawDataType metadata_word_count
The number of RawDataType words in the user-defined metadata.
static const sequence_id_t InvalidSequenceID
The sequence_id field is currently 48-bits.
static constexpr type_t FIRST_SYSTEM_TYPE
The first system type.
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
RawDataType type
The type of the fragment, either system or user-defined.
static constexpr type_t InvalidFragmentType
Copy InvalidFragmentType from RawFragmentHeader.
Definition: Fragment.hh:147
T reinterpret_cast_checked(const RawDataType *in) const
Wrapper around reinterpret_cast.
Definition: Fragment.hh:503
QuickVec< RawDataType >::difference_type difference_type
Alias difference_type type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:186
void setSequenceID(sequence_id_t sequence_id)
Sets the Sequence ID of the Fragment.
Definition: Fragment.hh:890
void setSystemType(type_t stype)
Sets the type of the Fragment, checking that it is a valid system type.
Definition: Fragment.hh:884
static std::map< type_t, std::string > MakeSystemTypeMap()
Returns a map of the most-commonly used system types.
std::vector< Fragment > Fragments
A std::vector of Fragment objects.
Definition: Fragment.hh:42
std::size_t size() const
Gets the size of the Fragment, from the Fragment header.
Definition: Fragment.hh:835
static constexpr type_t EndOfDataFragmentType
Copy EndOfDataFragmentType from RawFragmentHeader.
Definition: Fragment.hh:148
static constexpr timestamp_t InvalidTimestamp
Copy InvalidTimestamp from RawFragmentHeader.
Definition: Fragment.hh:145
void updateMetadata(const T &md)
Updates existing metadata with a new metadata object.
Definition: Fragment.hh:987
static constexpr type_t EmptyFragmentType
Copy EmptyFragmentType from RawFragmentHeader.
Definition: Fragment.hh:155
bool fragmentSequenceIDCompare(Fragment i, Fragment j)
Comparator for Fragment objects, based on their sequence_id.
Definition: Fragment.cc:8
const byte_t * dataEndBytes() const
Return const Fragment::byte_t* pointing at the end of the payload.
Definition: Fragment.hh:609
struct timespec atime() const
Get the last access time of the Fragment.
Definition: Fragment.hh:913
static constexpr bool isUserFragmentType(type_t fragmentType)
Returns whether the given type is in the range of user types.
Definition: Fragment.hh:763
detail::RawFragmentHeader::fragment_id_t fragment_id_t
typedef for fragment_id_t from RawFragmentHeader
Definition: Fragment.hh:139
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
void resizeBytes(std::size_t szbytes)
Resize the data payload to hold szbytes bytes (padded by the 8-byte RawDataTypes, so...
Definition: Fragment.hh:1024
static FragmentPtr dataFrag(sequence_id_t sequenceID, fragment_id_t fragID, InputIterator i, InputIterator e)
Creates a Fragment, copying data from given location. 12-Apr-2013, KAB - this method is deprecated...
Definition: Fragment.hh:711
RawDataType timestamp
The 64-bit timestamp field is the output of a user-defined clock used for building time-correlated ev...
RawDataType sequence_id
The 48-bit sequence_id uniquely identifies events within the artdaq system.
sequence_id_t sequenceID() const
Sequence ID of the Fragment, from the Fragment header.
Definition: Fragment.hh:860
timestamp_t timestamp() const
Timestamp of the Fragment, from the Fragment header.
Definition: Fragment.hh:872
static constexpr type_t DataFragmentType
Copy DataFragmentType from RawFragmentHeader.
Definition: Fragment.hh:149
QuickVec< RawDataType >::const_iterator const_iterator
Alias const_iterator type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:184
uint8_t byte_t
For byte representation.
Definition: Fragment.hh:100
void resize(std::size_t sz)
Resize the data payload to hold sz RawDataType words.
Definition: Fragment.hh:1007
RawDataType version
The version of the fragment.
void autoResize()
Resize the fragment to hold the number of words indicated by the header.
Definition: Fragment.hh:1058
static constexpr type_t EndOfRunFragmentType
Copy EndOfRunFragmentType from RawFragmentHeader.
Definition: Fragment.hh:151
static constexpr fragment_id_t InvalidFragmentID
Copy InvalidFragmentID from RawFragmentHeader.
Definition: Fragment.hh:144
RawDataType fragment_id
The fragment_id uniquely identifies a particular piece of hardware within the artdaq system...
size_t size() const
Accesses the current size of the QuickVec.
Definition: QuickVec.hh:387
static constexpr type_t InitFragmentType
Copy InitFragmentType from RawFragmentHeader.
Definition: Fragment.hh:150
QuickVec< RawDataType >::reference reference
Alias reference type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:182
byte_t * headerBeginBytes()
Return a Fragment::byte_t pointer pointing to the beginning of the header.
Definition: Fragment.hh:574
static FragmentPtr FragmentBytes(std::size_t payload_size_in_bytes, sequence_id_t sequence_id, fragment_id_t fragment_id, type_t type, const T &metadata, timestamp_t timestamp=Fragment::InvalidTimestamp)
Create a Fragment with the given header values. Uses static factory function instead of constructor t...
Definition: Fragment.hh:237
static constexpr type_t ErrorFragmentType
Copy ErrorFragmentType from RawFragmentHeader.
Definition: Fragment.hh:157
void touch()
Update the atime fields of the RawFragmentHeader to current time.
struct timespec getLatency(bool touch)
Get the difference between the current time and the last access time of the Fragment.
Definition: Fragment.hh:918
detail::RawFragmentHeader::version_t version_t
typedef for version_t from RawFragmentHeader
Definition: Fragment.hh:136
void setTimestamp(timestamp_t timestamp)
Sets the Timestamp of the Fragment.
Definition: Fragment.hh:903
iterator headerBegin()
Return an iterator to the beginning of the header (should be used for serialization only: use setters...
Definition: Fragment.hh:1078
T reinterpret_cast_checked(RawDataType *in)
Wrapper around reinterpret_cast.
Definition: Fragment.hh:531
byte_t * dataEndBytes()
Return Fragment::byte_t* pointing at the end of the payload.
Definition: Fragment.hh:561
static constexpr version_t InvalidVersion
Copy InvalidVersion from RawFragmentHeader.
Definition: Fragment.hh:142
iterator dataBegin()
Return an iterator to the beginning of the data payload (after header and metadata) ...
Definition: Fragment.hh:1065
bool empty()
Determines if the Fragment contains no data.
Definition: Fragment.hh:1110
static constexpr sequence_id_t InvalidSequenceID
Copy InvalidSequenceID from RawFragmentHeader.
Definition: Fragment.hh:143
QuickVec< RawDataType >::value_type value_type
Alias value_type type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:185
static FragmentPtr eodFrag(size_t nFragsToExpect)
Creates an EndOfData Fragment.
Definition: Fragment.cc:77
void setUserType(type_t utype)
Sets the type of the Fragment, checking that it is a valid user type.
Definition: Fragment.hh:878
void touch()
Update the access time of the Fragment.
Definition: Fragment.hh:908
static constexpr type_t ContainerFragmentType
Copy ContainerFragmentType from RawFragmentHeader.
Definition: Fragment.hh:156
static std::map< type_t, std::string > MakeSystemTypeMap()
Returns a map of the most commonly-used system types.
Definition: Fragment.hh:177
std::ostream & operator<<(std::ostream &os, Fragment const &f)
Prints the given Fragment to the stream.
Definition: Fragment.hh:1279
void swap(QuickVec &other) noexcept
Exchanges references to two QuickVec objects.
Definition: QuickVec.hh:528
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:971
const byte_t * dataBeginBytes() const
Return const Fragment::byte_t* pointing at the beginning of the payload.
Definition: Fragment.hh:596
type_t type() const
Type of the Fragment, from the Fragment header.
Definition: Fragment.hh:848
RawDataType * dataAddress()
Returns a RawDataType pointer to the beginning of the payload.
Definition: Fragment.hh:1130
void print(std::ostream &os) const
Print out summary information for this Fragment to the given stream.
Definition: Fragment.cc:68
unsigned long long RawDataType
The RawDataType (currently a 64-bit integer) is the basic unit of data representation within artdaq ...
T * metadata()
Return a pointer to the metadata. This throws an exception if the Fragment contains no metadata...
Definition: Fragment.hh:947
iterator dataEnd()
Return an iterator to the end of the data payload.
Definition: Fragment.hh:1072
static FragmentPtr FragmentBytes(std::size_t nbytes)
Create a Fragment using a static factory function rather than a constructor to allow for the function...
Definition: Fragment.hh:202
static constexpr type_t ShutdownFragmentType
Copy ShutdownFragmentType from RawFragmentHeader.
Definition: Fragment.hh:153
static constexpr type_t FirstUserFragmentType
Copy FIRST_USER_TYPE from RawFragmentHeader.
Definition: Fragment.hh:154
std::string typeString() const
Print the type of the Fragment.
Definition: Fragment.hh:854
detail::RawFragmentHeader::RawDataType RawDataType
The RawDataType (currently a 64-bit integer) is the basic unit of data representation within artdaq ...
Definition: Fragment.hh:40
RawDataType * metadataAddress()
Get the address of the metadata. For internal use only, use metadata() instead.
Definition: Fragment.hh:1137
size_t headerSizeBytes() const
Get the size of this Fragment&#39;s header, in bytes.
Definition: Fragment.hh:640
std::list< FragmentPtr > FragmentPtrs
A std::list of FragmentPtrs.
Definition: Fragment.hh:59
Fragment()
Create a Fragment with all header values zeroed.
Definition: Fragment.cc:13
size_t headerSizeWords() const
Get the size of this Fragment&#39;s header, in RawDataType words.
Definition: Fragment.hh:1154
void clear()
Removes all elements from the payload section of the Fragment.
Definition: Fragment.hh:1103
static constexpr bool isSystemFragmentType(type_t fragmentType)
Returns whether the given type is in the range of system types.
Definition: Fragment.hh:770
static const version_t CurrentVersion
The CurrentVersion field should be incremented whenever the RawFragmentHeader changes.
QuickVec< RawDataType >::iterator iterator
Alias iterator type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:183
bool hasMetadata() const
Test whether this Fragment has metadata.
Definition: Fragment.hh:941
QuickVec< RawDataType >::size_type size_type
Alias size_type type from QuickVec&lt;RawDataType&gt;
Definition: Fragment.hh:187
const byte_t * headerBeginBytes() const
Return a const Fragment::byte_t pointer pointing to the beginning of the header.
Definition: Fragment.hh:625
static std::string SystemTypeToString(type_t type)
Print a system type&#39;s string name.
void setFragmentID(fragment_id_t fragment_id)
Sets the Fragment ID of the Fragment.
Definition: Fragment.hh:897
A Fragment contains the data from one piece of the DAQ system for one event The artdaq::Fragment is t...
Definition: Fragment.hh:85
void swap(Fragment &other) noexcept
Swaps two Fragment objects.
Definition: Fragment.hh:1124
static constexpr type_t EndOfSubrunFragmentType
Copy EndOfSubrunFragmentType from RawFragmentHeader.
Definition: Fragment.hh:152
void resizeBytesWithCushion(std::size_t szbytes, double growthFactor=1.3)
Resize the data payload to hold szbytes bytes (padded by the 8-byte RawDataTypes, so...
Definition: Fragment.hh:1031
std::size_t dataSize() const
Return the number of RawDataType words in the data payload. This does not include the number of words...
Definition: Fragment.hh:934
iterator begin()
Gets an iterator to the beginning of the QuickVec.
Definition: QuickVec.hh:393
void swap(QuickVec< RawDataType > &other) noexcept
Swaps two Fragment data vectors.
Definition: Fragment.hh:671
detail::RawFragmentHeader::sequence_id_t sequence_id_t
typedef for sequence_id_t from RawFragmentHeader
Definition: Fragment.hh:138
fragment_id_t fragmentID() const
Fragment ID of the Fragment, from the Fragment header.
Definition: Fragment.hh:866
RawDataType * headerAddress()
Gets the address of the header.
Definition: Fragment.hh:1148
version_t version() const
Version of the Fragment, from the Fragment header.
Definition: Fragment.hh:841