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"
27 # define DATAVEC_T QuickVec<RawDataType>
259 void print(std::ostream& os)
const;
265 std::size_t
size()
const;
402 void resize(std::size_t sz);
464 template <
typename T>
467 T newpointer =
reinterpret_cast<T
>(in);
469 if (static_cast<const void*>(newpointer) !=
static_cast<const void*
>(in))
471 throw cet::exception(
"Error in Fragment.hh: reinterpret_cast failed to return expected address-- please contact John Freeman at jcfree@fnal.gov");
492 template <
typename T>
495 T newpointer =
reinterpret_cast<T
>(in);
497 if (static_cast<void*>(newpointer) !=
static_cast<void*
>(in))
499 throw cet::exception(
"Error in Fragment.hh: reinterpret_cast failed to return expected address-- please contact John Freeman at jcfree@fnal.gov");
560 return reinterpret_cast_checked<const byte_t*>(&*
dataBegin());
573 return reinterpret_cast_checked<const byte_t*>(&*
dataEnd());
589 return reinterpret_cast_checked<const byte_t*>(&*
headerBegin());
621 void swap(DATAVEC_T& other) noexcept { vals_.
swap(other); };
667 std::copy(i, e, std::back_inserter(result->vals_));
688 template <
typename T>
689 static std::size_t validatedMetadataSize_();
691 void updateFragmentHeaderWC_();
708 inline artdaq::Fragment& artdaq::Fragment::operator=(artdaq::Fragment&&) noexcept = default;
716 return fragmentType >= detail::RawFragmentHeader::FIRST_USER_TYPE &&
717 fragmentType <= detail::RawFragmentHeader::LAST_USER_TYPE;
729 template <
typename T>
732 validatedMetadataSize_()
737 static_assert(
sizeof(
size_t) >=
738 sizeof(decltype(std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max())),
739 "metadata_word_count_t is too big!");
741 static size_t constexpr max_md_wc =
742 std::numeric_limits<detail::RawFragmentHeader::metadata_word_count_t>::max();
743 size_t requested_md_wc =
745 if (requested_md_wc > max_md_wc)
747 throw cet::exception(
"InvalidRequest")
748 <<
"The requested metadata structure is too large: "
749 <<
"requested word count = " << requested_md_wc
750 <<
", maximum word count = " << max_md_wc;
752 return requested_md_wc;
760 vals_((artdaq::detail::RawFragmentHeader::num_words() +
761 validatedMetadataSize_<T>() +
765 TRACE( 50,
"Fragment ctor num_word()=%zu MetadataSize_=%zu payload_size=%zu"
773 updateFragmentHeaderWC_();
781 (fragmentHeader()->
num_words() + payload_size);
790 return fragmentHeader()->word_count;
797 return fragmentHeader()->version;
804 return static_cast<type_t>(fragmentHeader()->type);
811 return fragmentHeader()->sequence_id;
818 return fragmentHeader()->fragment_id;
825 return fragmentHeader()->timestamp;
832 fragmentHeader()->setUserType(static_cast<uint8_t>(type));
839 fragmentHeader()->setSystemType(static_cast<uint8_t>(type));
847 fragmentHeader()->sequence_id = sequence_id;
854 fragmentHeader()->fragment_id = fragment_id;
861 fragmentHeader()->timestamp = timestamp;
866 artdaq::Fragment::updateFragmentHeaderWC_()
870 assert(vals_.size() < (1ULL << 32));
871 TRACE( 50,
"Fragment::updateFragmentHeaderWC_ adjusting fragmentHeader()->word_count from %u to %zu", (
unsigned)(fragmentHeader()->word_count), vals_.size() );
872 fragmentHeader()->word_count = vals_.size();
879 return vals_.size() - fragmentHeader()->num_words() -
880 fragmentHeader()->metadata_word_count;
887 return fragmentHeader()->metadata_word_count != 0;
894 if (fragmentHeader()->metadata_word_count == 0)
896 throw cet::exception(
"InvalidRequest")
897 <<
"No metadata has been stored in this Fragment.";
900 return reinterpret_cast_checked<T *>
901 (&vals_[fragmentHeader()->num_words()]);
908 if (fragmentHeader()->metadata_word_count == 0)
910 throw cet::exception(
"InvalidRequest")
911 <<
"No metadata has been stored in this Fragment.";
913 return reinterpret_cast_checked<T const *>
914 (&vals_[fragmentHeader()->num_words()]);
921 if (fragmentHeader()->metadata_word_count != 0)
923 throw cet::exception(
"InvalidRequest")
924 <<
"Metadata has already been stored in this Fragment.";
926 auto const mdSize = validatedMetadataSize_<T>();
927 vals_.insert(dataBegin(), mdSize, 0);
928 updateFragmentHeaderWC_();
929 fragmentHeader()->metadata_word_count = mdSize;
931 memcpy(metadataAddress(), &metadata,
sizeof(T));
938 if (fragmentHeader()->metadata_word_count == 0)
940 throw cet::exception(
"InvalidRequest")
941 <<
"No metadata in fragment; please use Fragment::setMetadata instead of Fragment::updateMetadata";
944 auto const mdSize = validatedMetadataSize_<T>();
946 if (fragmentHeader()->metadata_word_count != mdSize)
948 throw cet::exception(
"InvalidRequest")
949 <<
"Mismatch between type of metadata struct passed to updateMetadata and existing metadata struct";
952 memcpy(metadataAddress(), &metadata,
sizeof(T));
958 vals_.resize(sz + fragmentHeader()->metadata_word_count +
959 fragmentHeader()->num_words());
960 updateFragmentHeaderWC_();
967 vals_.resize(sz + fragmentHeader()->metadata_word_count +
968 fragmentHeader()->num_words(), v);
969 updateFragmentHeaderWC_();
984 byte_t* ptr = reinterpret_cast_checked<byte_t*>(&defaultval);
994 resize(nwords, defaultval);
1002 vals_.resize(fragmentHeader()->word_count);
1003 updateFragmentHeaderWC_();
1010 return vals_.begin() + fragmentHeader()->num_words() +
1011 fragmentHeader()->metadata_word_count;
1025 return vals_.begin();
1032 return vals_.begin() + fragmentHeader()->num_words() +
1033 fragmentHeader()->metadata_word_count;
1047 return vals_.begin();
1055 vals_.erase(dataBegin(), dataEnd());
1056 updateFragmentHeaderWC_();
1063 return (vals_.size() - fragmentHeader()->num_words() -
1064 fragmentHeader()->metadata_word_count) == 0;
1071 vals_.reserve(cap + fragmentHeader()->num_words() +
1072 fragmentHeader()->metadata_word_count);
1079 vals_.swap(other.vals_);
1086 return &vals_[0] + fragmentHeader()->num_words() +
1087 fragmentHeader()->metadata_word_count;
1094 if (fragmentHeader()->metadata_word_count == 0)
1096 throw cet::exception(
"InvalidRequest")
1097 <<
"No metadata has been stored in this Fragment.";
1099 return &vals_[0] + fragmentHeader()->num_words();
1111 artdaq::Fragment::fragmentHeader()
1113 auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader *>(&vals_[0]);
1116 switch (hdr->version)
1123 std::cout <<
"Upgrading RawFragmentHeaderV0 (non const)" << std::endl;
1124 auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 *>(&vals_[0]);
1125 auto new_hdr = old_hdr->upgrade();
1127 auto szDiff = hdr->
num_words() - old_hdr->num_words();
1128 if (szDiff > 0) vals_.insert(vals_.begin(), szDiff, 0);
1129 memcpy(&vals_[0], &new_hdr, hdr->num_words() *
sizeof(
RawDataType));
1133 throw cet::exception(
"Fragment") <<
"A Fragment with an unknown version (" << std::to_string(hdr->version) <<
") was received!";
1142 artdaq::Fragment::fragmentHeader()
const
1144 auto hdr = reinterpret_cast_checked<detail::RawFragmentHeader const*>(&vals_[0]);
1147 switch (hdr->version)
1154 std::cout <<
"Upgrading RawFragmentHeaderV0 (const)" << std::endl;
1155 auto old_hdr = reinterpret_cast_checked<detail::RawFragmentHeaderV0 const*>(&vals_[0]);
1156 auto new_hdr = old_hdr->upgrade();
1158 auto szDiff = hdr->
num_words() - old_hdr->num_words();
1159 auto vals_nc =
const_cast<DATAVEC_T*
>(&vals_);
1160 if (szDiff > 0) vals_nc->insert(vals_nc->begin(), szDiff, 0);
1161 memcpy(&(*vals_nc)[0], &new_hdr, hdr->num_words() *
sizeof(
RawDataType));
1165 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...
iterator begin()
Gets an iterator to the beginning of the QuickVec.
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.