added equipment.autoTimeframeId

Author: sy-c

doc/configurationParameters.md

@@ -130,6 +130,7 @@ The parameters related to 3rd-party libraries are described here for convenience
 | consumer-zmq-* | maxRate | int| 0 | Maximum number of pages to publish per second. The associated memory copy has an impact on cpu load, so this should be limited when one does not use all the data (eg for eventDump). |
 | consumer-zmq-* | pagesPerBurst | int | 1 | Number of consecutive pages guaranteed to be part of each publish sequence. The maxRate limit is checked at the end of each burst. |
 | consumer-zmq-* | zmqOptions | string |  | Additional ZMQ options, as a comma-separated list of key=value pairs. Possible keys: ZMQ_CONFLATE, ZMQ_IO_THREADS, ZMQ_LINGER, ZMQ_SNDBUF, ZMQ_SNDHWM, ZMQ_SNDTIMEO. |
+| equipment-* | autoTimeframeId | int | 0 | When set, timeframe IDs are generated incrementally instead of being computed from trigger orbit counters. Useful to replay files with unordered / gap between TF. BC still used to detect boundaries between TFs. |
 | equipment-* | blockAlign | bytes | 2M | Alignment of the beginning of the big memory block from which the pool is created. Pool will start at a multiple of this value. Each page will then begin at a multiple of memoryPoolPageSize from the beginning of big block. |
 | equipment-* | consoleStatsUpdateTime | double | 0 | If set, number of seconds between printing statistics on console. |
 | equipment-* | ctpMode | int | 0 | If set, the detector field (CTP run mask) is checked. Incoming data is discarded until a new bit is set, and discarded again after this bit is unset. Automatically implies rdhCheckDetectorField=1 and rdhCheckDetectorField=1. |

doc/releaseNotes.md

@@ -575,4 +575,5 @@ This file describes the main feature changes for each readout.exe released versi
 - When running from the command line, the environment variable O2_RUN can be used to set the run number. It is set to 0 by default, i.e. undefined run number.
 - Updated configuration parameters:
   - added readout.numberOfRuns: in standalone mode, number of START/STOP cycles to execute (used for testing).
-  - added readout.tfRateLimitMode: can be set to 1 to use number of TF instead of computed TF id. Useful when replaying files with jumps in TF ids.
+  - added readout.tfRateLimitMode: can be set to 1 to use number of TF instead of computed TF id for rate throttling. Useful when replaying files with jumps in TF ids. (not needed with autoTimeframeId)
+  - added equipment.autoTimeframeId: to force incremental timeframe IDs. Useful when replaying files with jumps in TF ids. BC still used to detect boundaries between TFs.

src/ReadoutEquipment.cxx

@@ -166,6 +166,9 @@ ReadoutEquipment::ReadoutEquipment(ConfigFile& cfg, std::string cfgEntryPoint, b
     cfg.getOptionalValue<int>(cfgEntryPoint + ".TFperiod", cfgTFperiod);
     timeframePeriodOrbits = cfgTFperiod;
 
+    // configuration parameter: | equipment-* | autoTimeframeId | int | 0 | When set, timeframe IDs are generated incrementally instead of being computed from trigger orbit counters. Useful to replay files with unordered / gap between TF. BC still used to detect boundaries between TFs. |
+    cfg.getOptionalValue<int>(cfgEntryPoint + ".autoTimeframeId", cfgAutoTimeframeId, 0);
+
     if (!cfgRdhUseFirstInPageEnabled) {
       usingSoftwareClock = true; // if RDH disabled, use internal clock for TF id
     }
@@ -174,7 +177,11 @@ ReadoutEquipment::ReadoutEquipment(ConfigFile& cfg, std::string cfgEntryPoint, b
       timeframeRate = LHCOrbitRate * 1.0 / timeframePeriodOrbits; // timeframe rate, in Hz
       theLog.log(LogInfoDevel_(3002), "Timeframe IDs generated by software, %.2lf Hz", timeframeRate);
     } else {
-      theLog.log(LogInfoDevel_(3002), "Timeframe IDs generated from RDH trigger counters");
+      if (cfgAutoTimeframeId) {
+        theLog.log(LogInfoDevel_(3002), "Timeframe IDs generated incrementally with boundaries detected from RDH trigger counters");
+      } else {
+        theLog.log(LogInfoDevel_(3002), "Timeframe IDs generated from RDH trigger counters");
+      }
     }
   }
 
@@ -465,6 +472,15 @@ Thread::CallbackResult ReadoutEquipment::threadCallback(void* arg)
 	  if (nextBlock->getData()->header.timeframeId == undefinedTimeframeId) {
             nextBlock->getData()->header.timeframeId = ptr->getCurrentTimeframe();
 	  }
+
+          if (ptr->cfgAutoTimeframeId) {
+            uint64_t tfId = nextBlock->getData()->header.timeframeId;
+            if (tfId != ptr->autoTimeframeIdLatestFromBC) {
+              ptr->autoTimeframeIdLatestFromBC = tfId;
+              ptr->autoTimeframeIdCounter++;
+            }
+            nextBlock->getData()->header.timeframeId = ptr->autoTimeframeIdCounter;
+          }
 	}
 
 	// tag data with run number
@@ -614,6 +630,9 @@ void ReadoutEquipment::initCounters()
 
   statsNumberOfTimeframes = 0;
 
+  autoTimeframeIdLatestFromBC = undefinedTimeframeId;
+  autoTimeframeIdCounter = 0;
+
   // reset timeframe clock
   currentTimeframe = undefinedTimeframeId;
   lastTimeframe = undefinedTimeframeId;

src/ReadoutEquipment.h

@@ -184,6 +184,9 @@ class ReadoutEquipment
   int cfgDisableTimeframes = 0;        // When set, all TF features disabled
   RateRegulator TFregulator;           // clock counter for TF rate checks
   DataBlockContainerReference throttlePendingBlock; // in case TF rate limit was reached, a block may be set aside for later (when it belongs to next TF)
+  int cfgAutoTimeframeId = 0; // when set, TFids are generated incrementally instead of taken from RDH BC.
+  uint64_t autoTimeframeIdLatestFromBC = undefinedTimeframeId; // latest TFid (computed from BC)
+  uint64_t autoTimeframeIdCounter = 0; // TFid counter for sequence
 
   bool isRdhEquipment = false; // to be set true for RDH equipments
 

src/readoutConfigEditor.tcl

@@ -76,6 +76,7 @@ set configurationParametersDescriptor {
 | consumer-zmq-* | maxRate | int| 0 | Maximum number of pages to publish per second. The associated memory copy has an impact on cpu load, so this should be limited when one does not use all the data (eg for eventDump). |
 | consumer-zmq-* | pagesPerBurst | int | 1 | Number of consecutive pages guaranteed to be part of each publish sequence. The maxRate limit is checked at the end of each burst. |
 | consumer-zmq-* | zmqOptions | string |  | Additional ZMQ options, as a comma-separated list of key=value pairs. Possible keys: ZMQ_CONFLATE, ZMQ_IO_THREADS, ZMQ_LINGER, ZMQ_SNDBUF, ZMQ_SNDHWM, ZMQ_SNDTIMEO. |
+| equipment-* | autoTimeframeId | int | 0 | When set, timeframe IDs are generated incrementally instead of being computed from trigger orbit counters. Useful to replay files with unordered / gap between TF. BC still used to detect boundaries between TFs. |
 | equipment-* | blockAlign | bytes | 2M | Alignment of the beginning of the big memory block from which the pool is created. Pool will start at a multiple of this value. Each page will then begin at a multiple of memoryPoolPageSize from the beginning of big block. |
 | equipment-* | consoleStatsUpdateTime | double | 0 | If set, number of seconds between printing statistics on console. |
 | equipment-* | ctpMode | int | 0 | If set, the detector field (CTP run mask) is checked. Incoming data is discarded until a new bit is set, and discarded again after this bit is unset. Automatically implies rdhCheckDetectorField=1 and rdhCheckDetectorField=1. |