added TF id in RDH dump

Author: sy-c

doc/releaseNotes.md

@@ -370,3 +370,4 @@ This file describes the main feature changes for each readout.exe released versi
 - Updated configuration parameters:
   - added equipment-*.saveErrorPagesMax and equipment-*.saveErrorPagesPath to save to disk data pages found with errors (up to given maximum, in given path).
   - equipment-*.rdhDumpWarningEnabled default set to 1 (now that RDH warning messages auto-muted on flood).
+- o2-readout-rawreader: added print of TF id when RDH dump enabled. To enable this feature, one must specify a value for timeframePeriodOrbits (typically 128 or 256) in the command line parameters. TF ids generated are relative to the beginning of the file.

src/RdhUtils.cxx

@@ -19,20 +19,29 @@ void RdhHandle::dumpRdh(long offset, bool singleLine)
 {
   if (singleLine) {
     if (!RdhHeaderPrinted) {
-      printf("    Offset  RDH  Header   Block  Offset System   FEE   CRU  Link         Trigger     Trigger  Pages Stop Packet\n");
-      printf("              v    size    size    next     id    id    id    id       orbit  BC        type  count  bit  count\n");
+      printf("    Offset  RDH  Header   Block  Offset System    FEE   CRU  Link         Trigger     Trigger  Pages Stop Packet");
+      if (tfId) {
+        printf("     TF");
+      }
+      printf("\n");
+
+      printf("              v    size    size    next     id     id    id    id       orbit  BC        type  count  bit  count\n");
       RdhHeaderPrinted = true;
     }
     if (offset == -1) {
       printf("0x%p", (void*)rdhPtr);
     } else {
       printf("0x%08lX", offset);
     }
-    printf("   %02d      %02d %7d %7d  %5d  %4d  %4d  %4d  0x%08X:%03X  0x%08X     %2d   %2d    %03d\n",
+    printf("   %02d      %02d %7d %7d  %5d  %5d  %4d  %4d  0x%08X:%03X  0x%08X     %2d   %2d    %03d",
            (int)getHeaderVersion(), (int)getHeaderSize(), (int)getMemorySize(), (int)getOffsetNextPacket(),
            (int)getSystemId(), (int)getFeeId(), (int)getCruId(), (int)getLinkId(),
            getTriggerOrbit(), getTriggerBC(), (int)getTriggerType(),
            (int)getPagesCounter(), (int)getStopBit(), (int)getPacketCounter());
+    if (tfId) {
+      printf(" %6d", (int)tfId);
+    }
+    printf("\n");
 
   } else {
     if (offset == -1) {

src/RdhUtils.h

@@ -60,8 +60,14 @@ class RdhHandle
   inline uint16_t getCruId() { return (uint16_t)rdhPtr->cruId; }
   inline uint8_t getEndPointId() { return (uint8_t)rdhPtr->dpwId; }
 
+  uint64_t computeTimeframeId(const uint32_t firstTimeframeHbOrbitBegin, const uint32_t timeframePeriodOrbits) {
+    tfId = 1 + (getHbOrbit() - firstTimeframeHbOrbitBegin) / timeframePeriodOrbits;
+    return tfId;
+  }
+
  private:
   o2::Header::RAWDataHeader* rdhPtr; // pointer to RDH in memory
+  uint64_t tfId = 0; // computed timeframeId
 };
 
 // Utility class to access/parse/check the content of a contiguous memory block consisting of RDH+data

src/readRaw.cxx

@@ -40,6 +40,10 @@ int main(int argc, const char* argv[])
   bool checkContinuousTriggerOrder = false;
   bool isAutoPageSize = false; // flag set when no known page size in file
 
+  uint32_t timeframePeriodOrbits = 0;
+  uint32_t firstTimeframeHbOrbitBegin = 0;
+  bool isDefinedFirstTimeframeHbOrbitBegin = 0;
+
   // parse input arguments
   // format is a list of key=value pairs
 
@@ -56,6 +60,7 @@ int main(int argc, const char* argv[])
       "    dumpData=(int) : dump the data pages. If -1, all bytes. Otherwise, the first bytes only, as specified.\n"
       "    dumpDataInline=(int) : if set, each packet raw content is printed (hex dump style).\n"
       "    fileReadVerbose=(int) : if set, more information is printed when reading/decoding file.\n"
+      "    timeframePeriodOrbits=(int) : if set, TF id computed (and printed, when dump enabled) for each RDH. Typically, 128 or 256.\n"
       "    \n",
       argv[0]);
     return -1;
@@ -104,6 +109,8 @@ int main(int argc, const char* argv[])
       fileReadVerbose = std::stoi(value);
     } else if (key == "checkContinuousTriggerOrder") {
       checkContinuousTriggerOrder = std::stoi(value);
+    } else if (key == "timeframePeriodOrbits") {
+      timeframePeriodOrbits = (uint32_t) std::stoi(value);
     } else {
       ERRLOG("unknown option %s\n", key.c_str());
     }
@@ -328,6 +335,16 @@ int main(int argc, const char* argv[])
         RDHBlockCount++;
         RdhHandle h(((uint8_t*)data) + pageOffset);
 
+        // guess TF id
+        if (timeframePeriodOrbits) {
+          if (!isDefinedFirstTimeframeHbOrbitBegin) {
+	    // use first orbit for TF id computation
+	    firstTimeframeHbOrbitBegin = h.getHbOrbit();
+	    isDefinedFirstTimeframeHbOrbitBegin = 1;
+	  }
+	  h.computeTimeframeId(firstTimeframeHbOrbitBegin, timeframePeriodOrbits);
+        }
+
         if (dumpRDH) {
           h.dumpRdh(pageOffset + blockOffset, 1);
         }