1 #ifndef artdaq_core_Data_Fragment_hh
2 #define artdaq_core_Data_Fragment_hh
16 #include "artdaq-core/Data/detail/RawFragmentHeader.hh"
17 #include "artdaq-core/Data/detail/RawFragmentHeaderV0.hh"
18 #include "artdaq-core/Data/dictionarycontrol.hh"
19 #include "artdaq-core/Core/QuickVec.hh"
26 # define DATAVEC_T QuickVec<RawDataType>
258 void print(std::ostream& os)
const;
264 std::size_t
size()
const;
401 void resize(std::size_t sz);
463 template <
typename T>
466 T newpointer =
reinterpret_cast<T
>(in);
468 if (static_cast<const void*>(newpointer) !=
static_cast<const void*
>(in))
470 throw cet::exception(
"Error in Fragment.hh: reinterpret_cast failed to return expected address-- please contact John Freeman at jcfree@fnal.gov");
491 template <
typename T>
494 T newpointer =
reinterpret_cast<T
>(in);
496 if (static_cast<void*>(newpointer) !=
static_cast<void*
>(in))
498 throw cet::exception(
"Error in Fragment.hh: reinterpret_cast failed to return expected address-- please contact John Freeman at jcfree@fnal.gov");
559 return reinterpret_cast_checked<const byte_t*>(&*
dataBegin());
572 return reinterpret_cast_checked<const byte_t*>(&*
dataEnd());
588 return reinterpret_cast_checked<const byte_t*>(&*
headerBegin());
620 void swap(DATAVEC_T& other) noexcept { vals_.
swap(other); };
666 std::copy(i, e, std::back_inserter(result->vals_));
687 template <
typename T>
688 static std::size_t validatedMetadataSize_();
690 void updateFragmentHeaderWC_();
707 inline artdaq::Fragment& artdaq::Fragment::operator=(artdaq::Fragment&&) noexcept = default;
715 return fragmentType >= detail::RawFragmentHeader::FIRST_USER_TYPE &&
716 fragmentType <= detail::RawFragmentHeader::LAST_USER_TYPE;
728 template <
typename T>
731 validatedMetadataSize_()
736 static_assert(
sizeof(
size_t) >=
737 sizeof(decltype(std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max())),
738 "metadata_word_count_t is too big!");
740 static size_t constexpr max_md_wc =
741 std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max();
742 size_t requested_md_wc =
744 if (requested_md_wc > max_md_wc)
746 throw cet::exception(
"InvalidRequest")
747 <<
"The requested metadata structure is too large: "
748 <<
"requested word count = " << requested_md_wc
749 <<
", maximum word count = " << max_md_wc;
751 return requested_md_wc;
759 vals_((artdaq::detail::RawFragmentHeader::num_words() +
760 validatedMetadataSize_<T>() +
764 updateFragmentHeaderWC_();
773 (fragmentHeader()->
num_words() + payload_size);
782 return fragmentHeader()->word_count;
789 return fragmentHeader()->version;
796 return static_cast<type_t>(fragmentHeader()->type);
803 return fragmentHeader()->sequence_id;
810 return fragmentHeader()->fragment_id;
817 return fragmentHeader()->timestamp;
824 fragmentHeader()->setUserType(static_cast<uint8_t>(type));
831 fragmentHeader()->setSystemType(static_cast<uint8_t>(type));
839 fragmentHeader()->sequence_id = sequence_id;
846 fragmentHeader()->fragment_id = fragment_id;
853 fragmentHeader()->timestamp = timestamp;
858 artdaq::Fragment::updateFragmentHeaderWC_()
862 assert(vals_.size() < (1ULL << 32));
863 fragmentHeader()->word_count = vals_.size();
870 return vals_.size() - fragmentHeader()->num_words() -
871 fragmentHeader()->metadata_word_count;
878 return fragmentHeader()->metadata_word_count != 0;
885 if (fragmentHeader()->metadata_word_count == 0)
887 throw cet::exception(
"InvalidRequest")
888 <<
"No metadata has been stored in this Fragment.";
891 return reinterpret_cast_checked<T *>
892 (&vals_[fragmentHeader()->num_words()]);
899 if (fragmentHeader()->metadata_word_count == 0)
901 throw cet::exception(
"InvalidRequest")
902 <<
"No metadata has been stored in this Fragment.";
904 return reinterpret_cast_checked<T const *>
905 (&vals_[fragmentHeader()->num_words()]);
912 if (fragmentHeader()->metadata_word_count != 0)
914 throw cet::exception(
"InvalidRequest")
915 <<
"Metadata has already been stored in this Fragment.";
917 auto const mdSize = validatedMetadataSize_<T>();
918 vals_.insert(dataBegin(), mdSize, 0);
919 updateFragmentHeaderWC_();
920 fragmentHeader()->metadata_word_count = mdSize;
922 memcpy(metadataAddress(), &metadata,
sizeof(T));
929 if (fragmentHeader()->metadata_word_count == 0)
931 throw cet::exception(
"InvalidRequest")
932 <<
"No metadata in fragment; please use Fragment::setMetadata instead of Fragment::updateMetadata";
935 auto const mdSize = validatedMetadataSize_<T>();
937 if (fragmentHeader()->metadata_word_count != mdSize)
939 throw cet::exception(
"InvalidRequest")
940 <<
"Mismatch between type of metadata struct passed to updateMetadata and existing metadata struct";
943 memcpy(metadataAddress(), &metadata,
sizeof(T));
949 vals_.resize(sz + fragmentHeader()->metadata_word_count +
950 fragmentHeader()->num_words());
951 updateFragmentHeaderWC_();
958 vals_.resize(sz + fragmentHeader()->metadata_word_count +
959 fragmentHeader()->num_words(), v);
960 updateFragmentHeaderWC_();
975 byte_t* ptr = reinterpret_cast_checked<byte_t*>(&defaultval);
985 resize(nwords, defaultval);
993 vals_.resize(fragmentHeader()->word_count);
994 updateFragmentHeaderWC_();
1001 return vals_.begin() + fragmentHeader()->num_words() +
1002 fragmentHeader()->metadata_word_count;
1016 return vals_.begin();
1023 return vals_.begin() + fragmentHeader()->num_words() +
1024 fragmentHeader()->metadata_word_count;
1038 return vals_.begin();
1046 vals_.erase(dataBegin(), dataEnd());
1047 updateFragmentHeaderWC_();
1054 return (vals_.size() - fragmentHeader()->num_words() -
1055 fragmentHeader()->metadata_word_count) == 0;
1062 vals_.reserve(cap + fragmentHeader()->num_words() +
1063 fragmentHeader()->metadata_word_count);
1070 vals_.swap(other.vals_);
1077 return &vals_[0] + fragmentHeader()->num_words() +
1078 fragmentHeader()->metadata_word_count;
1085 if (fragmentHeader()->metadata_word_count == 0)
1087 throw cet::exception(
"InvalidRequest")
1088 <<
"No metadata has been stored in this Fragment.";
1090 return &vals_[0] + fragmentHeader()->num_words();
1102 artdaq::Fragment::fragmentHeader()
1104 auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader *>(&vals_[0]);
1107 switch (hdr->version)
1110 std::cout <<
"Not upgrading InvalidVersion Fragment" << std::endl;
1114 std::cout <<
"Upgrading RawFragmentHeaderV0 (non const)" << std::endl;
1115 auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 *>(&vals_[0]);
1116 auto new_hdr = old_hdr->upgrade();
1118 auto szDiff = hdr->
num_words() - old_hdr->num_words();
1119 if (szDiff > 0) vals_.insert(vals_.begin(), szDiff, 0);
1120 memcpy(&vals_[0], &new_hdr, hdr->num_words() *
sizeof(
RawDataType));
1124 throw cet::exception(
"Fragment") <<
"A Fragment with an unknown version (" << std::to_string(hdr->version) <<
") was received!";
1133 artdaq::Fragment::fragmentHeader()
const
1135 auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
1138 switch (hdr->version)
1141 std::cout <<
"Not upgrading InvalidVersion Fragment" << std::endl;
1145 std::cout <<
"Upgrading RawFragmentHeaderV0 (const)" << std::endl;
1146 auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 const*>(&vals_[0]);
1147 auto new_hdr = old_hdr->upgrade();
1149 auto szDiff = hdr->
num_words() - old_hdr->num_words();
1150 auto vals_nc =
const_cast<DATAVEC_T*
>(&vals_);
1151 if (szDiff > 0) vals_nc->insert(vals_nc->begin(), szDiff, 0);
1152 memcpy(&(*vals_nc)[0], &new_hdr, hdr->num_words() *
sizeof(
RawDataType));
1156 throw cet::exception(
"Fragment") <<
"A Fragment with an unknown version (" << std::to_string(hdr->version) <<
") was received!";
std::unique_ptr< Fragment > FragmentPtr
A std::unique_ptr to a Fragment object.
void reserve(std::size_t cap)
Reserves enough memory to hold cap RawDataType words in the Fragment payload.
detail::RawFragmentHeader::timestamp_t timestamp_t
typedef for timestamp_t from RawFragmentHeader
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...
static constexpr type_t InvalidFragmentType
Copy InvalidFragmentType from RawFragmentHeader.
T reinterpret_cast_checked(const RawDataType *in) const
Wrapper around reinterpret_cast.
QuickVec< RawDataType >::difference_type difference_type
Alias difference_type type from QuickVec<RawDataType>
void setSequenceID(sequence_id_t sequence_id)
Sets the Sequence ID of the Fragment.
void setSystemType(type_t stype)
Sets the type of the Fragment, checking that it is a valid system type.
std::vector< Fragment > Fragments
A std::vector of Fragment objects.
std::size_t size() const
Gets the size of the Fragment, from the Fragment header.
static constexpr type_t EndOfDataFragmentType
Copy EndOfDataFragmentType from RawFragmentHeader.
static constexpr timestamp_t InvalidTimestamp
Copy InvalidTimestamp from RawFragmentHeader.
void updateMetadata(const T &md)
Updates existing metadata with a new metadata object.
static constexpr type_t EmptyFragmentType
Copy EmptyFragmentType from RawFragmentHeader.
bool fragmentSequenceIDCompare(Fragment i, Fragment j)
Comparator for Fragment objects, based on their sequence_id.
const byte_t * dataEndBytes() const
Return const Fragment::byte_t* pointing at the end of the payload.
static constexpr bool isUserFragmentType(type_t fragmentType)
Returns whether the given type is in the range of user types.
detail::RawFragmentHeader::fragment_id_t fragment_id_t
typedef for fragment_id_t from RawFragmentHeader
std::size_t sizeBytes() const
Size of vals_ vector ( header + (optional) metadata + payload) in bytes.
byte_t * dataBeginBytes()
Return Fragment::byte_t* pointing at the beginning of the payload.
detail::RawFragmentHeader::type_t type_t
typedef for type_t from RawFragmentHeader
void resizeBytes(std::size_t szbytes)
Resize the data payload to hold szbytes bytes (padded by the 8-byte RawDataTypes, so...
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...
sequence_id_t sequenceID() const
Sequence ID of the Fragment, from the Fragment header.
timestamp_t timestamp() const
Timestamp of the Fragment, from the Fragment header.
static constexpr type_t DataFragmentType
Copy DataFragmentType from RawFragmentHeader.
QuickVec< RawDataType >::const_iterator const_iterator
Alias const_iterator type from QuickVec<RawDataType>
uint8_t byte_t
For byte representation.
void resize(std::size_t sz)
Resize the data payload to hold sz RawDataType words.
void autoResize()
Resize the fragment to hold the number of words indicated by the header.
static constexpr type_t EndOfRunFragmentType
Copy EndOfRunFragmentType from RawFragmentHeader.
static constexpr fragment_id_t InvalidFragmentID
Copy InvalidFragmentID from RawFragmentHeader.
size_t size() const
Accesses the current size of the QuickVec.
static constexpr type_t InitFragmentType
Copy InitFragmentType from RawFragmentHeader.
QuickVec< RawDataType >::reference reference
Alias reference type from QuickVec<RawDataType>
byte_t * headerBeginBytes()
Return a Fragment::byte_t pointer pointing to the beginning of the header.
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...
detail::RawFragmentHeader::version_t version_t
typedef for version_t from RawFragmentHeader
void setTimestamp(timestamp_t timestamp)
Sets the Timestamp of the Fragment.
iterator headerBegin()
Return an iterator to the beginning of the header (should be used for serialization only: use setters...
T reinterpret_cast_checked(RawDataType *in)
Wrapper around reinterpret_cast.
byte_t * dataEndBytes()
Return Fragment::byte_t* pointing at the end of the payload.
static constexpr version_t InvalidVersion
Copy InvalidVersion from RawFragmentHeader.
iterator dataBegin()
Return an iterator to the beginning of the data payload (after header and metadata) ...
bool empty()
Determines if the Fragment contains no data.
static constexpr sequence_id_t InvalidSequenceID
Copy InvalidSequenceID from RawFragmentHeader.
QuickVec< RawDataType >::value_type value_type
Alias value_type type from QuickVec<RawDataType>
static FragmentPtr eodFrag(size_t nFragsToExpect)
Creates an EndOfData Fragment.
void setUserType(type_t utype)
Sets the type of the Fragment, checking that it is a valid user type.
static constexpr type_t ContainerFragmentType
Copy ContainerFragmentType from RawFragmentHeader.
static std::map< type_t, std::string > MakeSystemTypeMap()
Returns a map of the most commonly-used system types.
std::ostream & operator<<(std::ostream &os, Fragment const &f)
Prints the given Fragment to the stream.
void swap(QuickVec &other) noexcept
Exchanges references to two QuickVec objects.
void setMetadata(const T &md)
Set the metadata in the Fragment to the contents of the specified structure. This throws an exception...
const byte_t * dataBeginBytes() const
Return const Fragment::byte_t* pointing at the beginning of the payload.
type_t type() const
Type of the Fragment, from the Fragment header.
RawDataType * dataAddress()
Returns a RawDataType pointer to the beginning of the payload.
void print(std::ostream &os) const
Print out summary information for this Fragment to the given stream.
T * metadata()
Return a pointer to the metadata. This throws an exception if the Fragment contains no metadata...
iterator dataEnd()
Return an iterator to the end of the data payload.
static FragmentPtr FragmentBytes(std::size_t nbytes)
Create a Fragment using a static factory function rather than a constructor to allow for the function...
static constexpr type_t ShutdownFragmentType
Copy ShutdownFragmentType from RawFragmentHeader.
static constexpr type_t FirstUserFragmentType
Copy FIRST_USER_TYPE from RawFragmentHeader.
detail::RawFragmentHeader::RawDataType RawDataType
The RawDataType (currently a 64-bit integer) is the basic unit of data representation within artdaq ...
RawDataType * metadataAddress()
Get the address of the metadata. For internal use only, use metadata() instead.
std::list< FragmentPtr > FragmentPtrs
A std::list of FragmentPtrs.
Fragment()
Create a Fragment with all header values zeroed.
void clear()
Removes all elements from the payload section of the Fragment.
static constexpr bool isSystemFragmentType(type_t fragmentType)
Returns whether the given type is in the range of system types.
QuickVec< RawDataType >::iterator iterator
Alias iterator type from QuickVec<RawDataType>
bool hasMetadata() const
Test whether this Fragment has metadata.
QuickVec< RawDataType >::size_type size_type
Alias size_type type from QuickVec<RawDataType>
const byte_t * headerBeginBytes() const
Return a const Fragment::byte_t pointer pointing to the beginning of the header.
void setFragmentID(fragment_id_t fragment_id)
Sets the Fragment ID of the Fragment.
A Fragment contains the data from one piece of the DAQ system for one event The artdaq::Fragment is t...
void swap(Fragment &other) noexcept
Swaps two Fragment objects.
static constexpr type_t EndOfSubrunFragmentType
Copy EndOfSubrunFragmentType from RawFragmentHeader.
std::size_t dataSize() const
Return the number of RawDataType words in the data payload. This does not include the number of words...
void swap(QuickVec< RawDataType > &other) noexcept
Swaps two Fragment data vectors.
detail::RawFragmentHeader::sequence_id_t sequence_id_t
typedef for sequence_id_t from RawFragmentHeader
fragment_id_t fragmentID() const
Fragment ID of the Fragment, from the Fragment header.
RawDataType * headerAddress()
Gets the address of the header.
version_t version() const
Version of the Fragment, from the Fragment header.