Add ever-incrementing TF counter and runNumber to DataHeader

shahor02 · shahor02 · commit 6b9838339c7a · 2020-07-08T01:28:26.000+02:00
The DataHeader::firstTForbit will not be unique when the same TFs are replayed in loop,
this counter will resolve the ambiguity.
runNumber is needed for conversion of firstTForbit to abs. timestamp
diff --git a/DataFormats/Headers/include/Headers/DataHeader.h b/DataFormats/Headers/include/Headers/DataHeader.h
@@ -666,9 +666,11 @@ struct DataHeader : public BaseHeader {
   using SplitPayloadPartsType = uint32_t;
   using PayloadSizeType = uint64_t;
   using TForbitType = uint32_t;
+  using TFCounterType = uint32_t;
+  using RunNumberType = uint32_t;
 
   //static data for this header type/version
-  static constexpr uint32_t sVersion{2};
+  static constexpr uint32_t sVersion{3};
   static constexpr o2::header::HeaderType sHeaderType{String2<uint64_t>("DataHead")};
   static constexpr o2::header::SerializationMethod sSerializationMethod{gSerializationMethodNone};
 
@@ -711,10 +713,20 @@ struct DataHeader : public BaseHeader {
   //___NEW STUFF GOES BELOW
 
   ///
-  /// first orbit of time frame as unique identifier within the run
+  /// first orbit of time frame, since v2
   ///
   TForbitType firstTForbit;
 
+  ///
+  /// ever incrementing TF counter, allows to disentangle even TFs with same firstTForbit in case of replay, since v3
+  ///
+  TFCounterType tfCounter;
+
+  ///
+  /// run number TF belongs to, since v3
+  ///
+  RunNumberType runNumber;
+
   //___the functions:
   //__________________________________________________________________________________________________
   constexpr DataHeader()
@@ -726,7 +738,9 @@ struct DataHeader : public BaseHeader {
       subSpecification(0),
       splitPayloadIndex(0),
       payloadSize(0),
-      firstTForbit{0}
+      firstTForbit{0},
+      tfCounter(0),
+      runNumber(0)
   {
   }
 
@@ -740,7 +754,9 @@ struct DataHeader : public BaseHeader {
       subSpecification(subspec),
       splitPayloadIndex(0),
       payloadSize(size),
-      firstTForbit{0}
+      firstTForbit{0},
+      tfCounter(0),
+      runNumber(0)
   {
   }
 
@@ -754,7 +770,9 @@ struct DataHeader : public BaseHeader {
       subSpecification(subspec),
       splitPayloadIndex(partIndex),
       payloadSize(size),
-      firstTForbit{0}
+      firstTForbit{0},
+      tfCounter(0),
+      runNumber(0)
   {
   }
 
@@ -808,8 +826,8 @@ static_assert(sizeof(BaseHeader) == 32,
               "BaseHeader struct must be of size 32");
 static_assert(sizeof(DataOrigin) == 4,
               "DataOrigin struct must be of size 4");
-static_assert(sizeof(DataHeader) == 88,
-              "DataHeader struct must be of size 88");
+static_assert(sizeof(DataHeader) == 96,
+              "DataHeader struct must be of size 96");
 static_assert(gSizeMagicString == sizeof(BaseHeader::magicStringInt),
               "Size mismatch in magic string union");
 static_assert(sizeof(BaseHeader::sMagicString) == sizeof(BaseHeader::magicStringInt),
diff --git a/DataFormats/Headers/src/DataHeader.cxx b/DataFormats/Headers/src/DataHeader.cxx
@@ -54,13 +54,16 @@ void o2::header::BaseHeader::throwInconsistentStackError() const
 //__________________________________________________________________________________________________
 void o2::header::DataHeader::print() const
 {
-  printf("Data header version %i, flags: %i\n", headerVersion, flags);
+  printf("Data header version %u, flags: %u\n", headerVersion, flags);
   printf("  origin       : %s\n", dataOrigin.str);
   printf("  serialization: %s\n", payloadSerializationMethod.str);
   printf("  description  : %s\n", dataDescription.str);
   printf("  sub spec.    : %llu\n", (long long unsigned int)subSpecification);
-  printf("  header size  : %i\n", headerSize);
+  printf("  header size  : %d\n", headerSize);
   printf("  payloadSize  : %llu\n", (long long unsigned int)payloadSize);
+  printf("  firstTFOrbit : %u\n", firstTForbit);
+  printf("  tfCounter    : %u\n", tfCounter);
+  printf("  runNumber    : %u\n", runNumber);
 }
 
 //__________________________________________________________________________________________________
diff --git a/DataFormats/Headers/test/testDataHeader.cxx b/DataFormats/Headers/test/testDataHeader.cxx
@@ -236,9 +236,9 @@ BOOST_AUTO_TEST_CASE(DataHeader_test)
               << "size " << std::setw(2) << sizeof(dh.payloadSize) << " at " << (char*)(&dh.payloadSize) - (char*)(&dh) << std::endl;
   }
 
-  // DataHeader must have size 88
-  static_assert(sizeof(DataHeader) == 88,
-                "DataHeader struct must be of size 88");
+  // DataHeader must have size 96
+  static_assert(sizeof(DataHeader) == 96,
+                "DataHeader struct must be of size 96");
   DataHeader dh2;
   BOOST_CHECK(dh == dh2);
   DataHeader dh3{gDataDescriptionInvalid, gDataOriginInvalid, DataHeader::SubSpecificationType{0}, 0};
