artdaq_core  v3_01_05
RawFragmentHeader.hh
1 #ifndef artdaq_core_Data_detail_RawFragmentHeader_hh
2 #define artdaq_core_Data_detail_RawFragmentHeader_hh
3 // detail::RawFragmentHeader is an overlay that provides the user's view
4 // of the data contained within a Fragment. It is intended to be hidden
5 // from the user of Fragment, as an implementation detail. The interface
6 // of Fragment is intended to be used to access the data.
7 
8 //#include <cstddef>
9 #include "artdaq-core/Data/dictionarycontrol.hh"
10 #include "cetlib/exception.h"
11 #include <map>
12 
13 extern "C"
14 {
15 #include <stdint.h>
16 }
17 
18 namespace artdaq
19 {
20  namespace detail
21  {
22  struct RawFragmentHeader;
23  }
24 }
25 
34 {
38  typedef unsigned long long RawDataType;
39 
40 #if HIDE_FROM_ROOT
41  typedef uint16_t version_t;
42  typedef uint64_t sequence_id_t;
43  typedef uint8_t type_t;
44  typedef uint16_t fragment_id_t;
45  typedef uint8_t metadata_word_count_t;
46  typedef uint64_t timestamp_t;
47 
48  // define special values for type_t
49  static constexpr type_t INVALID_TYPE = 0;
50  static constexpr type_t FIRST_USER_TYPE = 1;
51  static constexpr type_t LAST_USER_TYPE = 224;
52  static constexpr type_t FIRST_SYSTEM_TYPE = 225;
53  static constexpr type_t LAST_SYSTEM_TYPE = 255;
56  static constexpr type_t DataFragmentType = FIRST_SYSTEM_TYPE + 1;
57  static constexpr type_t InitFragmentType = FIRST_SYSTEM_TYPE + 2;
61  static constexpr type_t EmptyFragmentType = FIRST_SYSTEM_TYPE + 6;
63 
68  static std::map<type_t, std::string> MakeSystemTypeMap()
69  {
70  return std::map<type_t, std::string>{
71  { type_t(DataFragmentType), "Data"},
72  { type_t(EmptyFragmentType), "Empty" },
73  { 232, "Container" }
74  };
75  }
76 
81  static std::map<type_t, std::string> MakeVerboseSystemTypeMap()
82  {
83  return std::map<type_t, std::string>{
84  { type_t(EndOfDataFragmentType), "EndOfData" },
85  { type_t(DataFragmentType), "Data" },
86  { type_t(InitFragmentType), "Init" },
87  { type_t(EndOfRunFragmentType), "EndOfRun" },
88  { type_t(EndOfSubrunFragmentType), "EndOfSubrun" },
89  { type_t(ShutdownFragmentType),"Shutdown" },
90  { type_t(EmptyFragmentType), "Empty" },
91  { type_t(ContainerFragmentType), "Container" }
92  };
93  }
94 
100  static std::string SystemTypeToString(type_t type) {
101  switch (type) {
102  case INVALID_TYPE:
103  return "INVALID";
105  return "EndOfData";
106  case DataFragmentType:
107  return "Data";
108  case InitFragmentType:
109  return "Init";
111  return "EndOfRun";
113  return "EndOfSubrun";
115  return "Shutdown";
116  case EmptyFragmentType:
117  return "Empty";
119  return "Container";
120  }
121  return "Unknown";
122  }
123 
124  // Each of the following invalid values is chosen based on the
125  // size of the bitfield in which the corresponding data are
126  // encoded; if any of the sizes are changed, the corresponding
127  // values must be updated.
128  static const version_t InvalidVersion = 0xFFFF;
129  static const version_t CurrentVersion = 0x1;
130  static const sequence_id_t InvalidSequenceID = 0xFFFFFFFFFFFF;
131  static const fragment_id_t InvalidFragmentID = 0xFFFF;
132  static const timestamp_t InvalidTimestamp = 0xFFFFFFFFFFFFFFFF;
133 
138 
142 
143 
144  // ****************************************************
145  // New fields MUST be added to the END of this list!!!
146  // ****************************************************
147 
152  static constexpr std::size_t num_words();
153 
159  void setUserType(uint8_t utype);
160 
166  void setSystemType(uint8_t stype);
167 
168 #endif /* HIDE_FROM_ROOT */
169 };
170 
171 #if HIDE_FROM_ROOT
172 inline
173 constexpr
174 std::size_t
176 {
177  return sizeof(detail::RawFragmentHeader) / sizeof(RawDataType);
178 }
179 
180 
181 // Compile-time check that the assumption made in num_words() above is
182 // actually true.
186  "sizeof(RawFragmentHeader) is not an integer "
187  "multiple of sizeof(RawDataType)!");
188 
189 inline
190 void
192 {
193  if (utype < FIRST_USER_TYPE || utype > LAST_USER_TYPE)
194  {
195  throw cet::exception("InvalidValue")
196  << "RawFragmentHeader user types must be in the range of "
197  << ((int)FIRST_USER_TYPE) << " to " << ((int)LAST_USER_TYPE)
198  << " (bad type is " << ((int)utype) << ").";
199  }
200  type = utype;
201 }
202 
203 inline
204 void
206 {
207  if (stype < FIRST_SYSTEM_TYPE /*|| stype > LAST_SYSTEM_TYPE*/)
208  {
209  throw cet::exception("InvalidValue")
210  << "RawFragmentHeader system types must be in the range of "
211  << ((int)FIRST_SYSTEM_TYPE) << " to " << ((int)LAST_SYSTEM_TYPE);
212  }
213  type = stype;
214 }
215 #endif
216 
217 #endif /* artdaq_core_Data_detail_RawFragmentHeader_hh */
RawDataType metadata_word_count
The number of RawDataType words in the user-defined metadata.
RawDataType word_count
number of RawDataType words in this Fragment
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.
RawDataType type
The type of the fragment, either system or user-defined.
uint8_t type_t
type field is 8 bits
static std::map< type_t, std::string > MakeSystemTypeMap()
Returns a map of the most-commonly used system types.
void setSystemType(uint8_t stype)
Sets the type field to the specified system type.
static constexpr std::size_t num_words()
Returns the number of RawDataType words present in the header.
static constexpr type_t DataFragmentType
This Fragment holds data. Used for RawEvent Fragments sent from the EventBuilder to the Aggregator...
The RawFragmentHeader class contains the basic fields used by artdaq for routing Fragment objects thr...
RawDataType timestamp
The 64-bit timestamp field is the output of a user-defined clock used for building time-correlated ev...
static constexpr type_t InvalidFragmentType
Marks a Fragment as Invalid.
RawDataType sequence_id
The 48-bit sequence_id uniquely identifies events within the artdaq system.
RawDataType version
The version of the fragment. Currently always InvalidVersion.
static constexpr type_t ShutdownFragmentType
This Fragment indicates a system shutdown to art
static constexpr type_t LAST_USER_TYPE
The last user-accessible type (types above this number are system types.
RawDataType fragment_id
The fragment_id uniquely identifies a particular piece of hardware within the artdaq system...
static const version_t InvalidVersion
The version field is currently 16-bits.
void setUserType(uint8_t utype)
Sets the type field to the specified user type.
uint64_t timestamp_t
timestamp field is 32 bits
static constexpr type_t EmptyFragmentType
This Fragment contains no data and serves as a placeholder for when no data from a FragmentGenerator ...
static constexpr type_t FIRST_USER_TYPE
The first user-accessible type.
static std::map< type_t, std::string > MakeVerboseSystemTypeMap()
Returns a map of all system types.
static const timestamp_t InvalidTimestamp
The timestamp field is currently 32-bits.
unsigned long long RawDataType
The RawDataType (currently a 64-bit integer) is the basic unit of data representation within artdaq ...
uint64_t sequence_id_t
sequence_id field is 48 bits
static const fragment_id_t InvalidFragmentID
The fragment_id field is currently 16-bits.
static const version_t CurrentVersion
The CurrentVersion field should be incremented whenever the RawFragmentHeader changes.
static constexpr type_t ContainerFragmentType
This Fragment is a ContainerFragment and analysis code should unpack it.
static constexpr type_t EndOfDataFragmentType
This Fragment indicates the end of data to art
static std::string SystemTypeToString(type_t type)
Print a system type&#39;s string name.
uint16_t version_t
version field is 16 bits
static constexpr type_t LAST_SYSTEM_TYPE
The last system type.
static constexpr type_t EndOfSubrunFragmentType
This Fragment indicates the end of a subrun to art
uint16_t fragment_id_t
fragment_id field is 16 bits
static constexpr type_t EndOfRunFragmentType
This Fragment indicates the end of a run to art
uint8_t metadata_word_count_t
metadata_word_count field is 8 bits
static constexpr type_t InitFragmentType
This Fragment holds the necessary data for initializing art
static constexpr type_t INVALID_TYPE
Marks a Fragment as Invalid.