added readout.disableTimeframes

Author: sy-c

doc/releaseNotes.md

@@ -354,3 +354,7 @@ This file describes the main feature changes for each readout.exe released versi
 - equipment-cruemulator: TF id extracted from trigger counters (single timer source for improved coherency).
 - Memory allocation policy updated: all readout memory is locked (RAM only, can not be swapped). A warning is reported if not.
 - consumer-FMQchannel: checks are done before FMQ shared memory region is created, to avoid going in a state with over-committed memory (no checks done in FMQ library about the validity of the region created, which can cause severe crash when trying to access it). Both /proc/meminfo (MemFree) and /dev/shm (if using shmem transport type) should report enough available memory before proceeding. Memory is also immediately locked and zeroed to avoid later crashes.
+
+## Next version
+- Updated configuration parameters:
+  - added readout.disableTimefarmes:  when set, all timeframe-related features are disabled (STF slicing, TF rate limits, etc). All data are tagged with TF id = 0. To be used for some calibration runs not using a central trigger clock.

src/ReadoutEquipment.cxx

@@ -100,6 +100,10 @@ ReadoutEquipment::ReadoutEquipment(ConfigFile& cfg, std::string cfgEntryPoint, b
   cfgTfRateLimit = 0;
   cfg.getOptionalValue<double>("readout.tfRateLimit", cfgTfRateLimit);
 
+  // get TF disable flag from toplevel config
+  cfgDisableTimeframes = 0;
+  cfg.getOptionalValue<int>("readout.disableTimeframes", cfgDisableTimeframes);
+
   // log config summary
   theLog.log(LogInfoDevel_(3002), "Equipment %s: from config [%s], max rate=%lf Hz, idleSleepTime=%d us, outputFifoSize=%d", name.c_str(), cfgEntryPoint.c_str(), readoutRate, cfgIdleSleepTime, cfgOutputFifoSize);
   theLog.log(LogInfoDevel_(3008), "Equipment %s: requesting memory pool %d pages x %d bytes from bank '%s', block aligned @ 0x%X, 1st page offset @ 0x%X", name.c_str(), (int)memoryPoolNumberOfPages, (int)memoryPoolPageSize, memoryBankName.c_str(), (int)cfgBlockAlign, (int)cfgFirstPageOffset);
@@ -120,22 +124,24 @@ ReadoutEquipment::ReadoutEquipment(ConfigFile& cfg, std::string cfgEntryPoint, b
   cfg.getOptionalValue<int>(cfgEntryPoint + ".rdhUseFirstInPageEnabled", cfgRdhUseFirstInPageEnabled);
   theLog.log(LogInfoDevel_(3002), "RDH settings: rdhCheckEnabled=%d rdhDumpEnabled=%d rdhDumpErrorEnabled=%d rdhDumpWarningEnabled=%d rdhUseFirstInPageEnabled=%d", cfgRdhCheckEnabled, cfgRdhDumpEnabled, cfgRdhDumpErrorEnabled, cfgRdhDumpWarningEnabled, cfgRdhUseFirstInPageEnabled);
 
-  // configuration parameter: | equipment-* | TFperiod | int | 256 | Duration of a timeframe, in number of LHC orbits. |
-  int cfgTFperiod = 256;
-  cfg.getOptionalValue<int>(cfgEntryPoint + ".TFperiod", cfgTFperiod);
-  timeframePeriodOrbits = cfgTFperiod;
+  if (!cfgDisableTimeframes) {
+    // configuration parameter: | equipment-* | TFperiod | int | 256 | Duration of a timeframe, in number of LHC orbits. |
+    int cfgTFperiod = 256;
+    cfg.getOptionalValue<int>(cfgEntryPoint + ".TFperiod", cfgTFperiod);
+    timeframePeriodOrbits = cfgTFperiod;
 
-  if (!cfgRdhUseFirstInPageEnabled) {
-    usingSoftwareClock = true; // if RDH disabled, use internal clock for TF id
-  }
-  theLog.log(LogInfoDevel_(3002), "Timeframe length = %d orbits", (int)timeframePeriodOrbits);
-  if (usingSoftwareClock) {
-    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 (!cfgRdhUseFirstInPageEnabled) {
+      usingSoftwareClock = true; // if RDH disabled, use internal clock for TF id
+    }
+    theLog.log(LogInfoDevel_(3002), "Timeframe length = %d orbits", (int)timeframePeriodOrbits);
+    if (usingSoftwareClock) {
+      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");
+    }
   }
-
+  
   // init stats
   equipmentStats.resize(EquipmentStatsIndexes::maxIndex);
   equipmentStatsLast.resize(EquipmentStatsIndexes::maxIndex);
@@ -346,9 +352,14 @@ Thread::CallbackResult ReadoutEquipment::threadCallback(void* arg)
 	ptr->currentBlockId++; // don't start from 0
 	nextBlock->getData()->header.blockId = ptr->currentBlockId;
 
-	// tag data with (dummy) timeframeid, if none set
-	if (nextBlock->getData()->header.timeframeId == undefinedTimeframeId) {
-          nextBlock->getData()->header.timeframeId = ptr->getCurrentTimeframe();
+	if (ptr->cfgDisableTimeframes) {
+	  // disable TF id
+          nextBlock->getData()->header.timeframeId = undefinedTimeframeId;
+	} else {
+	  // tag data with (dummy) timeframeid, if none set
+	  if (nextBlock->getData()->header.timeframeId == undefinedTimeframeId) {
+            nextBlock->getData()->header.timeframeId = ptr->getCurrentTimeframe();
+	  }
 	}
 
 	// tag data with run number
@@ -647,14 +658,16 @@ int ReadoutEquipment::processRdh(DataBlockContainerReference& block)
       }
 
       // check no timeframe overlap in page
-      if (((blockHeader.timeframeOrbitFirst < blockHeader.timeframeOrbitLast) && ((h.getTriggerOrbit() < blockHeader.timeframeOrbitFirst) || (h.getTriggerOrbit() > blockHeader.timeframeOrbitLast))) || ((blockHeader.timeframeOrbitFirst > blockHeader.timeframeOrbitLast) && ((h.getTriggerOrbit() < blockHeader.timeframeOrbitFirst) && (h.getTriggerOrbit() > blockHeader.timeframeOrbitLast)))) {
-        if (cfgRdhDumpErrorEnabled) {
-          theLog.log(logRdhErrorsToken, "Equipment %d RDH #%d @ 0x%X : TimeFrame ID change in page not allowed : orbit 0x%08X not in range [0x%08X,0x%08X]", id, rdhIndexInPage, (unsigned int)pageOffset, (int)h.getTriggerOrbit(), (int)blockHeader.timeframeOrbitFirst, (int)blockHeader.timeframeOrbitLast);
-        }
-        statsRdhCheckStreamErr++;
-        break; // stop checking this page
+      if (!cfgDisableTimeframes) {
+	if (((blockHeader.timeframeOrbitFirst < blockHeader.timeframeOrbitLast) && ((h.getTriggerOrbit() < blockHeader.timeframeOrbitFirst) || (h.getTriggerOrbit() > blockHeader.timeframeOrbitLast))) || ((blockHeader.timeframeOrbitFirst > blockHeader.timeframeOrbitLast) && ((h.getTriggerOrbit() < blockHeader.timeframeOrbitFirst) && (h.getTriggerOrbit() > blockHeader.timeframeOrbitLast)))) {
+          if (cfgRdhDumpErrorEnabled) {
+            theLog.log(logRdhErrorsToken, "Equipment %d RDH #%d @ 0x%X : TimeFrame ID change in page not allowed : orbit 0x%08X not in range [0x%08X,0x%08X]", id, rdhIndexInPage, (unsigned int)pageOffset, (int)h.getTriggerOrbit(), (int)blockHeader.timeframeOrbitFirst, (int)blockHeader.timeframeOrbitLast);
+          }
+          statsRdhCheckStreamErr++;
+          break; // stop checking this page
+	}
       }
-
+      
       /*
       // check packetCounter is contiguous
       if (cfgRdhCheckPacketCounterContiguous) {

src/ReadoutEquipment.h

@@ -155,6 +155,7 @@ class ReadoutEquipment
   int cfgRdhUseFirstInPageEnabled = 0; // flag to enable reading of first RDH in page to populate readout headers
   //int cfgRdhCheckPacketCounterContiguous = 1; // flag to enable checking if RDH packetCounter value contiguous (done link-by-link)
   double cfgTfRateLimit = 0;           // TF rate limit, to throttle data readout
+  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)
 

src/mainReadout.cxx

@@ -143,6 +143,7 @@ class Readout
   // configuration parameters
   double cfgExitTimeout;
   double cfgFlushEquipmentTimeout;
+  int cfgDisableTimeframes;
   int cfgDisableAggregatorSlicing;
   double cfgAggregatorSliceTimeout;
   double cfgAggregatorStfTimeout;
@@ -468,10 +469,21 @@ int Readout::configure(const boost::property_tree::ptree& properties)
   // configuration parameter: | readout | tfRateLimit | double | 0 | When set, the output is limited to a given timeframe rate. |
   cfgTfRateLimit = 0;
   cfg.getOptionalValue<double>("readout.tfRateLimit", cfgTfRateLimit);
+
+  // configuration parameter: | readout | disableTimeframes | int | 0 | When set, all timeframe related features are disabled (this may supersede other config parameters). |
+  cfgDisableTimeframes = 0;
+  cfg.getOptionalValue<int>("readout.disableTimeframes", cfgDisableTimeframes);
+  if (cfgDisableTimeframes) {
+    cfgDisableAggregatorSlicing = 1;
+    cfgTfRateLimit = 0;
+    theLog.log(LogInfoDevel, "Timeframes disabled");
+  }
+
   if (cfgTfRateLimit > 0) {
     theLog.log(LogInfoDevel, "Timeframe rate limit = % .2lf Hz", cfgTfRateLimit);
   }
 
+
   // configuration parameter: | readout | logbookEnabled | int | 0 | When set, the logbook is enabled and populated with readout stats at runtime. |
   cfgLogbookEnabled = 0;
   cfg.getOptionalValue<int>("readout.logbookEnabled", cfgLogbookEnabled);
@@ -828,15 +840,16 @@ int Readout::start()
   if (cfgDisableAggregatorSlicing) {
     theLog.log(LogInfoDevel, "Aggregator slicing disabled");
     agg->disableSlicing = 1;
-  }
-  if (cfgAggregatorSliceTimeout > 0) {
-    theLog.log(LogInfoDevel, "Aggregator slice timeout = %.2lf seconds", cfgAggregatorSliceTimeout);
-    agg->cfgSliceTimeout = cfgAggregatorSliceTimeout;
-  }
-  if (cfgAggregatorStfTimeout > 0) {
-    theLog.log(LogInfoDevel, "Aggregator subtimeframe timeout = %.2lf seconds", cfgAggregatorStfTimeout);
-    agg->cfgStfTimeout = cfgAggregatorStfTimeout;
-    agg->enableStfBuilding = 1;
+  } else {
+    if (cfgAggregatorSliceTimeout > 0) {
+      theLog.log(LogInfoDevel, "Aggregator slice timeout = %.2lf seconds", cfgAggregatorSliceTimeout);
+      agg->cfgSliceTimeout = cfgAggregatorSliceTimeout;
+    }
+    if (cfgAggregatorStfTimeout > 0) {
+      theLog.log(LogInfoDevel, "Aggregator subtimeframe timeout = %.2lf seconds", cfgAggregatorStfTimeout);
+      agg->cfgStfTimeout = cfgAggregatorStfTimeout;
+      agg->enableStfBuilding = 1;
+    }
   }
 
   agg->start();