Merge pull request #289 from sy-c/master

v2.27.2

Author: sy-c

CMakeLists.txt

@@ -258,6 +258,7 @@ add_library(
         ${SOURCE_DIR}/MemoryBank.cxx
         ${SOURCE_DIR}/MemoryBankManager.cxx
         ${SOURCE_DIR}/MemoryPagesPool.cxx
+	${SOURCE_DIR}/ReadoutMonitoringQueue.cxx
 	$<$<BOOL:${ZMQ_FOUND}>:${SOURCE_DIR}/ZmqServer.cxx>
 	$<$<BOOL:${ZMQ_FOUND}>:${SOURCE_DIR}/ZmqClient.cxx>
 )

doc/configurationParameters.md

@@ -161,7 +161,7 @@ The parameters related to 3rd-party libraries are described here for convenience
 | equipment-* | saveErrorPagesMax | int | 0 | If set, pages found with data error are saved to disk up to given maximum. |
 | equipment-* | saveErrorPagesPath | string |  | Path where to save data pages with errors (when feature enabled). |
 | equipment-* | stopOnError | int | 0 | If 1, readout will stop automatically on equipment error. |
-| equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. |
+| equipment-* | TFperiod | int | 32 | Duration of a timeframe, in number of LHC orbits. |
 | equipment-* | verbose | int | 0 | If set, extra debug messages may be logged. |
 | equipment-cruemulator-* | cruBlockSize | int | 8192 | Size of a RDH block. |
 | equipment-cruemulator-* | cruId | int | 0 | CRU Id, used for CRU Id field in RDH. |
@@ -194,6 +194,7 @@ The parameters related to 3rd-party libraries are described here for convenience
 | equipment-rorc-* | firmwareCheckEnabled | int | 1 | If set, RORC driver checks compatibility with detected firmware. Use 0 to bypass this check (eg new fw version not yet recognized by ReadoutCard version). |
 | equipment-rorc-* | firmwareVersionsAllowed | string | | Comma-separated list of ROC firmware versions allowed (6-digit hash). If empty, all are allowed. |
 | equipment-rorc-* | firmwareVersionsDenied | string | e4a5a46e | Comma-separated list of ROC firmware versions denied  (6-digit hash), i.e. which would cause configuration to abort. |
+| equipment-rorc-* | monitorFirstOrbitEnabled | int | 0 | If set, enable monitoring of RORC first orbit. |
 | equipment-zmq-* | address | string | | Address of remote server to connect, eg tcp://remoteHost:12345. |
 | equipment-zmq-* | mode | string | stream | Possible values: stream (1 input ZMQ message = 1 output data page), snapshot (last ZMQ message = one output data page per TF). |
 | equipment-zmq-* | timeframeClientUrl | string | | The address to be used to retrieve current timeframe. When set, data is published only once for each TF id published by remote server. |

doc/releaseNotes.md

@@ -655,3 +655,9 @@ This file describes the main feature changes for each readout.exe released versi
 
 ## v2.27.1 - 12/02/2025
 - Path of configuration file from which defaults are loaded on startup has been changed to /etc/o2.d/readout/readout-defaults.cfg (it was in /etc/o2.d before, now changing to standard subdirectory location).
+
+## v2.27.2 - 19/03/2025
+- Updated configuration parameters:
+  - equipment.TFperiod is now set to 32 by default, instead of 128 previously. This is the duration of a timeframe, in number of LHC orbits. The new value corresponds to what is used in production.
+  - equipment-rorc-*: added parameter monitorFirstOrbitEnabled, to enable reporting to monitoring system the metric "readout.RORCfirstOrbit" on startup, as retrieved from CRU firmware. This is to be used on CTP FLP to detect possibly wrong orbit. A return value of 0xFFFFFFFF indicates the value could not be retrieved.
+- ConsumerStats: added an internal queue to allow pushing spontaneous monitoring measurements (compared to periodic ones) from any readout module.

src/ConsumerStats.cxx

@@ -23,6 +23,7 @@
 #include "DataSet.h"
 #include "ReadoutUtils.h"
 #include "ReadoutStats.h"
+#include "ReadoutMonitoringQueue.h"
 
 using namespace o2::monitoring;
 
@@ -182,6 +183,12 @@ class ConsumerStats : public Consumer
 	  sendMetricNoException(Metric{"readout.bufferUsage"}.addValue((int)(r*100), "value").addValue(b, "bytes").addTag(tags::Key::ID, i));
 	}
       }
+
+      // publish measurements stored in monitoring queue
+      auto ff = [&] (const ReadoutMonitoringMetric &m) -> void {
+        sendMetricNoException(Metric{m.value, m.name}.addTag(tags::Key::ID, m.tag));
+      };
+      gReadoutMonitoringQueue.execute(ff);
     }
 
 #ifdef WITH_ZMQ

src/ReadoutEquipment.cxx

@@ -161,8 +161,8 @@ ReadoutEquipment::ReadoutEquipment(ConfigFile& cfg, std::string cfgEntryPoint, b
   cfg.getOptionalValue<int>(cfgEntryPoint + ".verbose", cfgVerbose);
 
   if (!cfgDisableTimeframes) {
-    // configuration parameter: | equipment-* | TFperiod | int | 128 | Duration of a timeframe, in number of LHC orbits. |
-    int cfgTFperiod = 128;
+    // configuration parameter: | equipment-* | TFperiod | int | 32 | Duration of a timeframe, in number of LHC orbits. |
+    int cfgTFperiod = 32;
     cfg.getOptionalValue<int>(cfgEntryPoint + ".TFperiod", cfgTFperiod);
     timeframePeriodOrbits = cfgTFperiod;
 

src/ReadoutEquipment.h

@@ -165,7 +165,7 @@ class ReadoutEquipment
 
   //const unsigned int LHCBunches = 3564;    // number of bunches in LHC
   const unsigned int LHCOrbitRate = 11246; // LHC orbit rate, in Hz. 299792458 / 26659
-  uint32_t timeframePeriodOrbits = 128;    // timeframe interval duration in number of LHC orbits
+  uint32_t timeframePeriodOrbits = 32;     // timeframe interval duration in number of LHC orbits
   double timeframeRate = 0;                // timeframe rate, when generated internally
 
   // RDH-related configuration parameters

src/ReadoutEquipmentRORC.cxx

@@ -26,6 +26,7 @@
 #include "ReadoutEquipment.h"
 #include "ReadoutUtils.h"
 #include "readoutInfoLogger.h"
+#include "ReadoutMonitoringQueue.h"
 
 class ReadoutEquipmentRORC : public ReadoutEquipment
 {
@@ -131,6 +132,10 @@ ReadoutEquipmentRORC::ReadoutEquipmentRORC(ConfigFile& cfg, std::string name) :
     // configuration parameter: | equipment-rorc-* | debugStatsEnabled | int | 0 | If set, enable extra statistics about internal buffers status. (printed to stdout when stopping) |
     cfg.getOptionalValue<int>(name + ".debugStatsEnabled", cfgDebugStatsEnabled);
 
+    // configuration parameter: | equipment-rorc-* | monitorFirstOrbitEnabled | int | 0 | If set, enable monitoring of RORC first orbit. |
+    int cfgMonitorFirstOrbitEnabled = 0;
+    cfg.getOptionalValue<int>(name + ".monitorFirstOrbitEnabled", cfgMonitorFirstOrbitEnabled);
+
     // get readout memory buffer parameters
     // std::string sMemorySize=cfg.getValue<std::string>(name + ".memoryBufferSize");
     // std::string sPageSize=cfg.getValue<std::string>(name + ".memoryPageSize"); long long
@@ -216,6 +221,11 @@ ReadoutEquipmentRORC::ReadoutEquipmentRORC(ConfigFile& cfg, std::string name) :
       BOOST_THROW_EXCEPTION(ReadoutEquipmentRORCException() << ErrorInfo::Message("This firmware version is not allowed"));
     }
 
+    // publish relevant card info
+    if (cfgMonitorFirstOrbitEnabled) {
+      gReadoutMonitoringQueue.push({.name = "readout.RORCfirstOrbit", .tag = id, .value = (uint64_t)channel->getCounterFirstOrbit()});
+    }
+
     // todo: log parameters ?
 
     if (logRocCallsEnable) {

src/ReadoutMonitoringQueue.cxx

@@ -0,0 +1,36 @@
+#include "ReadoutMonitoringQueue.h"
+
+ReadoutMonitoringQueue::ReadoutMonitoringQueue() {
+}
+
+ReadoutMonitoringQueue::~ReadoutMonitoringQueue() {
+}
+  
+void ReadoutMonitoringQueue::push(ReadoutMonitoringMetric m) {
+  std::unique_lock<std::mutex> lock(qMutex);
+  q.push_front(std::move(m));
+}
+
+void ReadoutMonitoringQueue::execute(std::function<void(const ReadoutMonitoringMetric &)> f) {
+  for (;;) {
+    ReadoutMonitoringMetric m;
+    
+    {
+      std::unique_lock<std::mutex> lock(qMutex);
+      if (q.empty()) {
+	break;
+      }
+      m = std::move(q.back());
+      q.pop_back();
+    }
+    
+    f(m);
+  }
+} 
+  
+void ReadoutMonitoringQueue::clear() {
+  std::unique_lock<std::mutex> lock(qMutex);
+  q.clear();
+}
+
+ReadoutMonitoringQueue gReadoutMonitoringQueue;

src/ReadoutMonitoringQueue.h

@@ -0,0 +1,42 @@
+#include <deque>
+#include <mutex>
+#include <string>
+#include <functional>
+
+// a metric to be stored in queue for later processing
+// fields as for o2::monitoring::metric
+struct ReadoutMonitoringMetric {
+  std::string name;
+  unsigned short int tag;
+  uint64_t value;
+};
+
+
+// producer-consumer queue to define and publish metrics
+// typical use:
+// the module that pushes has no access to o2 Monitoring
+// the module that publishes reads from the queue and publish them to o2 Monitoring
+// the class is not aware of o2::monitoring, it's just a transient thread-safe storage
+
+class ReadoutMonitoringQueue {
+  public:
+  
+  ReadoutMonitoringQueue();
+  ~ReadoutMonitoringQueue();
+  
+  // push an element in the queue
+  void push(ReadoutMonitoringMetric);
+  
+  // execute provided functions on all elements in the queue
+  // (and remove them from the queue)
+  void execute(std::function<void(const ReadoutMonitoringMetric &)>); 
+  
+  // remove all elements in queue
+  void clear();
+  
+  private:
+  std::mutex qMutex;
+  std::deque<ReadoutMonitoringMetric> q;
+};
+
+extern ReadoutMonitoringQueue gReadoutMonitoringQueue;

src/ReadoutVersion.h

@@ -9,5 +9,5 @@
 // granted to it by virtue of its status as an Intergovernmental Organization
 // or submit itself to any jurisdiction.
 
-#define READOUT_VERSION "2.27.1"
+#define READOUT_VERSION "2.27.2"