artdaq_core  v3_06_01
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 <cmath>
7 #include <cstddef>
8 #include <cstdint>
9 #include <cstring>
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 
67 bool fragmentSequenceIDCompare(const Fragment& i, const Fragment& j);
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 std::make_unique<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 std::make_unique<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& metadata);
415 
423  template<class T>
424  void updateMetadata(const T& metadata);
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); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
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); // NOLINT(cppcoreguidelines-pro-type-reinterpret-cast)
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 
743 #endif
744 
745 private:
746  template<typename T>
747  static std::size_t validatedMetadataSize_();
748 
749  void updateFragmentHeaderWC_();
750 
751  DATAVEC_T vals_;
752 
753 #if HIDE_FROM_ROOT
754 
755  detail::RawFragmentHeader* fragmentHeaderPtr();
756 
757 #endif
758 };
759 
760 #if HIDE_FROM_ROOT
761 
762 // http://stackoverflow.com/questions/33939687
763 // This should generate an exception if artdaq::Fragment is not move-constructible
764 inline artdaq::Fragment::Fragment(artdaq::Fragment&&) noexcept = default;
765 inline artdaq::Fragment& artdaq::Fragment::operator=(artdaq::Fragment&&) noexcept = default;
766 
767 inline bool constexpr artdaq::Fragment::
768  isUserFragmentType(type_t fragmentType)
769 {
770  return fragmentType >= detail::RawFragmentHeader::FIRST_USER_TYPE &&
771  fragmentType <= detail::RawFragmentHeader::LAST_USER_TYPE;
772 }
773 
774 inline bool constexpr artdaq::Fragment::
776 {
777  return fragmentType >= detail::RawFragmentHeader::FIRST_SYSTEM_TYPE;
778 }
779 
780 template<typename T>
781 std::size_t
782 artdaq::Fragment::
783  validatedMetadataSize_()
784 {
785  // Make sure a size_t is big enough to hold the maximum metadata
786  // size. This *should* always be true, but it is a compile-time check
787  // and therefore cheap.
788  static_assert(sizeof(size_t) >=
789  sizeof(decltype(std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max())),
790  "metadata_word_count_t is too big!");
791 
792  static size_t constexpr max_md_wc =
793  std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max();
794  size_t requested_md_wc =
795  std::ceil(sizeof(T) / static_cast<double>(sizeof(artdaq::RawDataType)));
796  if (requested_md_wc > max_md_wc)
797  {
798  throw cet::exception("InvalidRequest") // NOLINT(cert-err60-cpp)
799  << "The requested metadata structure is too large: "
800  << "requested word count = " << requested_md_wc
801  << ", maximum word count = " << max_md_wc;
802  }
803  return requested_md_wc;
804 }
805 
806 template<class T>
808  Fragment(std::size_t payload_size, sequence_id_t sequence_id,
809  fragment_id_t fragment_id,
810  type_t type, const T& metadata, timestamp_t timestamp)
811  : vals_((artdaq::detail::RawFragmentHeader::num_words() + // Header
812  validatedMetadataSize_<T>() + // Metadata
813  payload_size) // User data
814  )
815 {
816  TRACEN("Fragment", 50, "Fragment ctor num_word()=%zu MetadataSize_=%zu payload_size=%zu", artdaq::detail::RawFragmentHeader::num_words(), validatedMetadataSize_<T>(), payload_size); // NOLINT
817  // vals ctor w/o init val is used; make sure header is ALL initialized.
818  for (iterator ii = vals_.begin();
819  ii != (vals_.begin() + detail::RawFragmentHeader::num_words()); ++ii)
820  {
821  *ii = -1;
822  }
823  fragmentHeaderPtr()->version = detail::RawFragmentHeader::CurrentVersion;
824  updateFragmentHeaderWC_();
825  fragmentHeaderPtr()->sequence_id = sequence_id;
826  fragmentHeaderPtr()->fragment_id = fragment_id;
827  fragmentHeaderPtr()->timestamp = timestamp;
828  fragmentHeaderPtr()->type = type;
829 
830  fragmentHeaderPtr()->touch();
831 
832  fragmentHeaderPtr()->metadata_word_count =
833  vals_.size() -
834  (headerSizeWords() + payload_size);
835 
836  memcpy(metadataAddress(), &metadata, sizeof(T));
837 }
838 
839 inline std::size_t
841 {
842  return fragmentHeader().word_count;
843 }
844 
847 {
848  auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
849  return hdr->version;
850 }
851 
854 {
855  return static_cast<type_t>(fragmentHeader().type);
856 }
857 
858 inline std::string
860 {
861  return std::to_string(type()) + (isSystemFragmentType(type()) ? " (" + detail::RawFragmentHeader::SystemTypeToString(type()) + ")" : "");
862 }
863 
866 {
867  return fragmentHeader().sequence_id;
868 }
869 
872 {
873  return fragmentHeader().fragment_id;
874 }
875 
878 {
879  return fragmentHeader().timestamp;
880 }
881 
882 inline void
884 {
885  fragmentHeaderPtr()->setUserType(static_cast<uint8_t>(type));
886 }
887 
888 inline void
890 {
891  fragmentHeaderPtr()->setSystemType(static_cast<uint8_t>(type));
892 }
893 
894 inline void
896 {
897  assert(sequence_id <= detail::RawFragmentHeader::InvalidSequenceID);
898  fragmentHeaderPtr()->sequence_id = sequence_id;
899 }
900 
901 inline void
903 {
904  fragmentHeaderPtr()->fragment_id = fragment_id;
905 }
906 
907 inline void
909 {
910  fragmentHeaderPtr()->timestamp = timestamp;
911 }
912 
914 {
915  fragmentHeaderPtr()->touch();
916 }
917 
918 inline struct timespec artdaq::Fragment::atime() const
919 {
920  return fragmentHeader().atime();
921 }
922 
923 inline struct timespec artdaq::Fragment::getLatency(bool touch)
924 {
925  return fragmentHeaderPtr()->getLatency(touch);
926 }
927 
928 inline void
929 artdaq::Fragment::updateFragmentHeaderWC_()
930 {
931  // Make sure vals_.size() fits inside 32 bits. Left-shift here should
932  // match bitfield size of word_count in RawFragmentHeader.
933  assert(vals_.size() < (1ULL << 32));
934  TRACEN("Fragment", 50, "Fragment::updateFragmentHeaderWC_ adjusting fragmentHeader()->word_count from %u to %zu", (unsigned)(fragmentHeaderPtr()->word_count), vals_.size()); // NOLINT
935  fragmentHeaderPtr()->word_count = vals_.size();
936 }
937 
938 inline std::size_t
940 {
941  return vals_.size() - headerSizeWords() -
942  fragmentHeader().metadata_word_count;
943 }
944 
945 inline bool
947 {
948  return fragmentHeader().metadata_word_count != 0;
949 }
950 
951 template<class T>
953 {
954  if (fragmentHeader().metadata_word_count == 0)
955  {
956  throw cet::exception("InvalidRequest") // NOLINT(cert-err60-cpp)
957  << "No metadata has been stored in this Fragment.";
958  }
959 
960  return reinterpret_cast_checked<T*>(&vals_[headerSizeWords()]);
961 }
962 
963 template<class T>
964 T const*
966 {
967  if (fragmentHeader().metadata_word_count == 0)
968  {
969  throw cet::exception("InvalidRequest") // NOLINT(cert-err60-cpp)
970  << "No metadata has been stored in this Fragment.";
971  }
972  return reinterpret_cast_checked<T const*>(&vals_[headerSizeWords()]);
973 }
974 
975 template<class T>
976 void artdaq::Fragment::setMetadata(const T& metadata)
977 {
978  if (fragmentHeader().metadata_word_count != 0)
979  {
980  throw cet::exception("InvalidRequest") // NOLINT(cert-err60-cpp)
981  << "Metadata has already been stored in this Fragment.";
982  }
983  auto const mdSize = validatedMetadataSize_<T>();
984  vals_.insert(dataBegin(), mdSize, 0);
985  updateFragmentHeaderWC_();
986  fragmentHeaderPtr()->metadata_word_count = mdSize;
987 
988  memcpy(metadataAddress(), &metadata, sizeof(T));
989 }
990 
991 template<class T>
992 void artdaq::Fragment::updateMetadata(const T& metadata)
993 {
994  if (fragmentHeader().metadata_word_count == 0)
995  {
996  throw cet::exception("InvalidRequest") // NOLINT(cert-err60-cpp)
997  << "No metadata in fragment; please use Fragment::setMetadata instead of Fragment::updateMetadata";
998  }
999 
1000  auto const mdSize = validatedMetadataSize_<T>();
1001 
1002  if (fragmentHeader().metadata_word_count != mdSize)
1003  {
1004  throw cet::exception("InvalidRequest") // NOLINT(cert-err60-cpp)
1005  << "Mismatch between type of metadata struct passed to updateMetadata and existing metadata struct";
1006  }
1007 
1008  memcpy(metadataAddress(), &metadata, sizeof(T));
1009 }
1010 
1011 inline void
1013 {
1014  vals_.resize(sz + fragmentHeaderPtr()->metadata_word_count +
1015  headerSizeWords());
1016  updateFragmentHeaderWC_();
1017 }
1018 
1019 inline void
1021 {
1022  vals_.resize(sz + fragmentHeaderPtr()->metadata_word_count +
1023  headerSizeWords(),
1024  v);
1025  updateFragmentHeaderWC_();
1026 }
1027 
1028 inline void
1029 artdaq::Fragment::resizeBytes(std::size_t szbytes)
1030 {
1031  RawDataType nwords = ceil(szbytes / static_cast<double>(sizeof(RawDataType)));
1032  resize(nwords);
1033 }
1034 
1035 inline void
1036 artdaq::Fragment::resizeBytesWithCushion(std::size_t szbytes, double growthFactor)
1037 {
1038  RawDataType nwords = ceil(szbytes / static_cast<double>(sizeof(RawDataType)));
1039  vals_.resizeWithCushion(nwords + fragmentHeaderPtr()->metadata_word_count +
1040  headerSizeWords(),
1041  growthFactor);
1042  updateFragmentHeaderWC_();
1043 }
1044 
1045 inline void
1046 artdaq::Fragment::resizeBytes(std::size_t szbytes, byte_t v)
1047 {
1048  RawDataType defaultval;
1049  auto ptr = reinterpret_cast_checked<byte_t*>(&defaultval);
1050 
1051  for (uint8_t i = 0; i < sizeof(RawDataType); ++i)
1052  {
1053  *ptr = v;
1054  ptr++; // NOLINT(cppcoreguidelines-pro-bounds-pointer-arithmetic)
1055  }
1056 
1057  RawDataType nwords = ceil(szbytes / static_cast<double>(sizeof(RawDataType)));
1058 
1059  resize(nwords, defaultval);
1060 }
1061 
1062 inline void
1064 {
1065  vals_.resize(fragmentHeaderPtr()->word_count);
1066  updateFragmentHeaderWC_();
1067 }
1068 
1071 {
1072  return vals_.begin() + headerSizeWords() +
1073  fragmentHeader().metadata_word_count;
1074 }
1075 
1078 {
1079  return vals_.end();
1080 }
1081 
1084 {
1085  return vals_.begin();
1086 }
1087 
1090 {
1091  return vals_.begin() + headerSizeWords() +
1092  fragmentHeader().metadata_word_count;
1093 }
1094 
1097 {
1098  return vals_.end();
1099 }
1100 
1103 {
1104  return vals_.begin();
1105 }
1106 
1107 inline void
1109 {
1110  vals_.erase(dataBegin(), dataEnd());
1111  updateFragmentHeaderWC_();
1112 }
1113 
1114 inline bool
1116 {
1117  return (vals_.size() - headerSizeWords() -
1118  fragmentHeader().metadata_word_count) == 0;
1119 }
1120 
1121 inline void
1123 {
1124  vals_.reserve(cap + headerSizeWords() +
1125  fragmentHeader().metadata_word_count);
1126 }
1127 
1128 inline void
1130 {
1131  vals_.swap(other.vals_);
1132 }
1133 
1134 inline artdaq::RawDataType*
1136 {
1137  return &vals_[0] + headerSizeWords() + // NOLINT(cppcoreguidelines-pro-bounds-pointer-arithmetic)
1138  fragmentHeader().metadata_word_count;
1139 }
1140 
1141 inline artdaq::RawDataType*
1143 {
1144  if (fragmentHeader().metadata_word_count == 0)
1145  {
1146  throw cet::exception("InvalidRequest") // NOLINT(cert-err60-cpp)
1147  << "No metadata has been stored in this Fragment.";
1148  }
1149  return &vals_[0] + headerSizeWords(); // NOLINT(cppcoreguidelines-pro-bounds-pointer-arithmetic)
1150 }
1151 
1152 inline artdaq::RawDataType*
1154 {
1155  return &vals_[0];
1156 }
1157 
1158 inline size_t
1160 {
1161  auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
1162  if (hdr->version != detail::RawFragmentHeader::CurrentVersion)
1163  {
1164  switch (hdr->version)
1165  {
1166  case 0xFFFF:
1167  TLOG(51, "Fragment") << "Cannot get header size of InvalidVersion Fragment";
1168  break;
1169  case 0:
1170  {
1171  TLOG(52, "Fragment") << "Getting size of RawFragmentHeaderV0";
1172  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 const*>(&vals_[0]);
1173  return old_hdr->num_words();
1174  break;
1175  }
1176  case 1:
1177  {
1178  TLOG(52, "Fragment") << "Getting size of RawFragmentHeaderV1";
1179  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV1 const*>(&vals_[0]);
1180  return old_hdr->num_words();
1181  break;
1182  }
1183  default:
1184  throw cet::exception("Fragment") << "A Fragment with an unknown version (" << std::to_string(hdr->version) << ") was received!"; // NOLINT(cert-err60-cpp)
1185  break;
1186  }
1187  }
1188  return hdr->num_words();
1189 }
1190 
1192 artdaq::Fragment::fragmentHeaderPtr()
1193 {
1194  auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader*>(&vals_[0]);
1195  if (hdr->version != detail::RawFragmentHeader::CurrentVersion)
1196  {
1197  switch (hdr->version)
1198  {
1199  case 0xFFFF:
1200  TLOG(51, "Fragment") << "Not upgrading InvalidVersion Fragment";
1201  break;
1202  case 0:
1203  {
1204  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV0 (non const)";
1205  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0*>(&vals_[0]);
1206  auto new_hdr = old_hdr->upgrade();
1207 
1208  auto szDiff = hdr->num_words() - old_hdr->num_words();
1209  if (szDiff > 0)
1210  {
1211  vals_.insert(vals_.begin(), szDiff, 0);
1212  new_hdr.word_count = vals_.size();
1213  }
1214  memcpy(&vals_[0], &new_hdr, hdr->num_words() * sizeof(RawDataType));
1215  hdr = reinterpret_cast_checked<detail::RawFragmentHeader*>(&vals_[0]); // Update hdr in case vals_->insert call invalidated pointers
1216  break;
1217  }
1218  case 1:
1219  {
1220  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV1 (non const)";
1221  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV1*>(&vals_[0]);
1222  auto new_hdr = old_hdr->upgrade();
1223 
1224  auto szDiff = hdr->num_words() - old_hdr->num_words();
1225  if (szDiff > 0)
1226  {
1227  vals_.insert(vals_.begin(), szDiff, 0);
1228  new_hdr.word_count = vals_.size();
1229  }
1230  memcpy(&vals_[0], &new_hdr, hdr->num_words() * sizeof(RawDataType));
1231  hdr = reinterpret_cast_checked<detail::RawFragmentHeader*>(&vals_[0]); // Update hdr in case vals_->insert call invalidated pointers
1232  break;
1233  }
1234  default:
1235  throw cet::exception("Fragment") << "A Fragment with an unknown version (" << std::to_string(hdr->version) << ") was received!"; // NOLINT(cert-err60-cpp)
1236  break;
1237  }
1238  }
1239  return hdr;
1240 }
1241 
1244 {
1245  auto hdr = *reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
1246  if (hdr.version != detail::RawFragmentHeader::CurrentVersion)
1247  {
1248  switch (hdr.version)
1249  {
1250  case 0xFFFF:
1251  TLOG(51, "Fragment") << "Not upgrading InvalidVersion Fragment";
1252  break;
1253  case 0:
1254  {
1255  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV0 (const)";
1256  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 const*>(&vals_[0]);
1257  hdr = old_hdr->upgrade();
1258 
1259  break;
1260  }
1261  case 1:
1262  {
1263  TLOG(52, "Fragment") << "Upgrading RawFragmentHeaderV1 (const)";
1264  auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV1 const*>(&vals_[0]);
1265  hdr = old_hdr->upgrade();
1266 
1267  break;
1268  }
1269  default:
1270  throw cet::exception("Fragment") << "A Fragment with an unknown version (" << std::to_string(hdr.version) << ") was received!"; // NOLINT(cert-err60-cpp)
1271  break;
1272  }
1273  }
1274  return hdr;
1275 }
1276 
1277 inline void
1278 swap(artdaq::Fragment& x, artdaq::Fragment& y) noexcept
1279 {
1280  x.swap(y);
1281 }
1282 
1283 inline std::ostream&
1284 artdaq::operator<<(std::ostream& os, artdaq::Fragment const& f)
1285 {
1286  f.print(os);
1287  return os;
1288 }
1289 #endif /* HIDE_FROM_ROOT */
1290 
1291 #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:1122
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:895
void setSystemType(type_t stype)
Sets the type of the Fragment, checking that it is a valid system type.
Definition: Fragment.hh:889
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:840
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
static constexpr type_t EmptyFragmentType
Copy EmptyFragmentType from RawFragmentHeader.
Definition: Fragment.hh:155
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:918
static constexpr bool isUserFragmentType(type_t fragmentType)
Returns whether the given type is in the range of user types.
Definition: Fragment.hh:768
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:1029
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:865
timestamp_t timestamp() const
Timestamp of the Fragment, from the Fragment header.
Definition: Fragment.hh:877
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:1012
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:1063
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:389
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
void setMetadata(const T &metadata)
Set the metadata in the Fragment to the contents of the specified structure. This throws an exception...
Definition: Fragment.hh:976
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:923
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:908
iterator headerBegin()
Return an iterator to the beginning of the header (should be used for serialization only: use setters...
Definition: Fragment.hh:1083
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:1070
bool empty()
Determines if the Fragment contains no data.
Definition: Fragment.hh:1115
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:883
void touch()
Update the access time of the Fragment.
Definition: Fragment.hh:913
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
void updateMetadata(const T &metadata)
Updates existing metadata with a new metadata object.
Definition: Fragment.hh:992
std::ostream & operator<<(std::ostream &os, Fragment const &f)
Prints the given Fragment to the stream.
Definition: Fragment.hh:1284
void swap(QuickVec &other) noexcept
Exchanges references to two QuickVec objects.
Definition: QuickVec.hh:538
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:853
RawDataType * dataAddress()
Returns a RawDataType pointer to the beginning of the payload.
Definition: Fragment.hh:1135
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 an unsigned long long) is the basic unit of data representation within art...
T * metadata()
Return a pointer to the metadata. This throws an exception if the Fragment contains no metadata...
Definition: Fragment.hh:952
iterator dataEnd()
Return an iterator to the end of the data payload.
Definition: Fragment.hh:1077
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:859
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:1142
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:1159
void clear()
Removes all elements from the payload section of the Fragment.
Definition: Fragment.hh:1108
static constexpr bool isSystemFragmentType(type_t fragmentType)
Returns whether the given type is in the range of system types.
Definition: Fragment.hh:775
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:946
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:902
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:1129
static constexpr type_t EndOfSubrunFragmentType
Copy EndOfSubrunFragmentType from RawFragmentHeader.
Definition: Fragment.hh:152
bool fragmentSequenceIDCompare(const Fragment &i, const Fragment &j)
Comparator for Fragment objects, based on their sequence_id.
Definition: Fragment.cc:8
detail::RawFragmentHeader const fragmentHeader() const
Get a copy of the RawFragmentHeader from this Fragment.
Definition: Fragment.hh:1243
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:1036
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:939
iterator begin()
Gets an iterator to the beginning of the QuickVec.
Definition: QuickVec.hh:395
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:871
RawDataType * headerAddress()
Gets the address of the header.
Definition: Fragment.hh:1153
version_t version() const
Version of the Fragment, from the Fragment header.
Definition: Fragment.hh:846