Merge pull request #18 from sy-c/master

readout - minor upgrade

Author: sy-c

README.md

@@ -1 +1,4 @@
+This is the O2 Readout package.
+The documentation is in [the doc directory](doc/README.md)
+
 [![JIRA](https://img.shields.io/badge/JIRA-Report%20issue-blue.svg)](https://alice.its.cern.ch/jira/secure/CreateIssue.jspa?pid=11201&issuetype=1)

readout.cfg

@@ -132,8 +132,13 @@ monitoringURI=infologger://
 [consumer-rec]
 consumerType=fileRecorder
 enabled=0
+# the fileName value defines the path of the file to be created
+# it may include some runtime variables:
+# ${XYZ} -> get variable XYZ from environment
+# %t -> unix timestamp (seconds since epoch)
+# %T -> formatted date/time string, in the form YYYY_MM_DD__h_m_s__
 fileName=/tmp/data.raw
-
+  
 
 
 # push to fairMQ device

src/ConsumerFileRecorder.cxx

@@ -1,20 +1,18 @@
 #include "Consumer.h"
 #include "ReadoutUtils.h"
-
+#include <iomanip>
 
 class ConsumerFileRecorder: public Consumer {
   public: 
+  
   ConsumerFileRecorder(ConfigFile &cfg, std::string cfgEntryPoint):Consumer(cfg,cfgEntryPoint) {
     counterBytesTotal=0;
     fp=NULL;
 
     fileName=cfg.getValue<std::string>(cfgEntryPoint + ".fileName");
     if (fileName.length()>0) {
-      theLog.log("Recording to %s",fileName.c_str());
-      fp=fopen(fileName.c_str(),"wb");
-      if (fp==NULL) {
-        theLog.log("Failed to create file");
-      }
+      theLog.log("Recording path = %s",fileName.c_str());
+      createFile();
     }
     if (fp==NULL) {
       theLog.log("Recording disabled");
@@ -34,6 +32,86 @@ class ConsumerFileRecorder: public Consumer {
     closeRecordingFile();
   }
 
+  int createFile() {
+    // create the file name according to specified path
+    
+    // parse the string, and subst variables:
+    // ${XXX} -> get variable XXX from environment
+    // %t -> unix timestamp (seconds since epoch)
+    // %T -> formatted date/time
+    
+    std::string newFileName;
+    
+    int parseError=0;
+    for (std::string::iterator it=fileName.begin();it!=fileName.end();++it) {
+      // subst environment variable
+      if (*it=='$') {
+        ++it;
+        int varNameComplete=0;
+        if (it!=fileName.end()) {
+          if (*it=='{') {
+            std::string varName;
+
+            for (++it;it!=fileName.end();++it) {
+              if (*it=='}') {
+                varNameComplete=1;
+                break;
+              } else {
+                varName+=*it;
+              }
+            }
+            if (varNameComplete) {
+              const char *val=getenv(varName.c_str());
+              if (val!=nullptr) {
+                newFileName+=val;
+                //theLog.log((varName + " = " + val).c_str());
+              }
+            }
+          }
+        }
+        if (!varNameComplete) {
+          parseError++;
+        }
+      } else if (*it=='%') {
+        // escape characters
+        ++it;
+        if (it!=fileName.end()) {
+          if (*it=='t') {
+            newFileName+=std::to_string(std::time(nullptr));
+          } else if (*it=='T') {
+            std::time_t t = std::time(nullptr);
+            std::tm tm = *std::localtime(&t);
+            std::stringstream buffer;
+            buffer << std::put_time(&tm, "%Y_%m_%d__%H_%M_%S__");
+            newFileName+=buffer.str();
+          } else {
+            parseError++;
+          }
+        } else {
+          parseError++;
+        }      
+      } else {
+        // normal char - copy it
+        newFileName+=*it;
+      }   
+      if (parseError) {
+        break;
+      }
+    }  
+    if (parseError) {
+      theLog.log("Failed to parse recording file path");
+      return -1;
+    }
+    theLog.log(("Opening file for writing: " + newFileName).c_str());
+    
+    fp=fopen(newFileName.c_str(),"wb");
+    if (fp==NULL) {
+      theLog.log("Failed to create file");
+      return -1;
+    }
+    return 0;
+  }
+  
   // fwrite function with partial write auto-retry
   int writeToFile(FILE *fp, void *data, size_t numberOfBytes) {
     unsigned char *buffer=(unsigned char *)data;

src/ReadoutEquipmentRORC.cxx

@@ -156,7 +156,10 @@ ReadoutEquipmentRORC::ReadoutEquipmentRORC(ConfigFile &cfg, std::string name) :
       params.setGeneratorLoopback(AliceO2::roc::LoopbackMode::fromString(cfgGeneratorLoopback));
       params.setGeneratorPattern(AliceO2::roc::GeneratorPattern::fromString(cfgGeneratorPattern));
       params.setGeneratorRandomSizeEnabled(cfgGeneratorRandomSizeEnabled);
-    }    
+    } else {
+      // for some unknown reason, one has to explicitely disable the loopback when not using the generator
+      params.setGeneratorLoopback(AliceO2::roc::LoopbackMode::None);
+    }   
 
     // card readout mode : experimental, not needed
     // params.setReadoutMode(AliceO2::roc::ReadoutMode::fromString(cfgReadoutMode));