Merge pull request #267 from sy-c/master

v2.21.5

Author: sy-c

doc/configurationParameters.md

@@ -199,6 +199,7 @@ The parameters related to 3rd-party libraries are described here for convenience
 | readout | aggregatorSliceTimeout | double | 0 | When set, slices (groups) of pages are flushed if not updated after given timeout (otherwise closed only on beginning of next TF, or on stop). |
 | readout | aggregatorStfTimeout | double | 0 | When set, subtimeframes are buffered until timeout (otherwise, sent immediately and independently for each data source). |
 | readout | customCommands | string | | List of key=value pairs defining some custom shell commands to be executed at before/after state change commands. |
+| readout | defaults | string |  | If set, the corresponding configuration URI is loaded and merged with current readout configuration. Existing parameters in current config are NOT overwritten. |
 | readout | disableAggregatorSlicing | int | 0 | When set, the aggregator slicing is disabled, data pages are passed through without grouping/slicing. |
 | readout | disableTimeframes | int | 0 | When set, all timeframe related features are disabled (this may supersede other config parameters). |
 | readout | exitTimeout | double | -1 | Time in seconds after which the program exits automatically. -1 for unlimited. |

doc/releaseNotes.md

@@ -593,3 +593,7 @@ This file describes the main feature changes for each readout.exe released versi
 - Updated configuration parameters:
   - consumer-fileRecorder-*.filesMax: if negative value, the files are written round-robin indefinitely. For example, if value is -4, there will be files 001 to 004 used as circular buffer. This implies limits are defined with the other parameters (e.g. maximum size, number of tf, or pages).
 - Log messages cosmetics: details in orbits warning, special chars in RDH errors.
+
+## v2.21.5 - 13/10/2023
+- Updated configuration parameters:
+  - added readout.defaults: if set, the corresponding configuration URI is loaded and merged with current readout configuration. Existing parameters in current config are NOT overwritten. Useful to put in a single place settings which are shared by many configs.

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.21.4"
+#define READOUT_VERSION "2.21.5"
 

src/mainReadout.cxx

@@ -723,6 +723,47 @@ int Readout::_init(int argc, char* argv[])
 
 //#include <boost/property_tree/json_parser.hpp>
 
+// dump boost ptree on stdout
+void printTree (boost::property_tree::ptree &pt, int level) {
+  if (pt.empty()) {
+    std::cerr << "\""<< pt.data()<< "\"";
+  }
+
+  else {
+    if (level) std::cerr << std::endl;
+    std::cerr << std::string(level*2, ' ') << "{" << std::endl;
+    for (boost::property_tree::ptree::iterator pos = pt.begin(); pos != pt.end();) {
+      std::cerr << std::string((level+1)*2, ' ') << "\"" << pos->first << "\": ";
+      printTree(pos->second, level + 1);
+      ++pos;
+      if (pos != pt.end()) {
+        std::cerr << ",";
+      }
+      std::cerr << std::endl;
+    }
+   std::cerr << std::string(level*2, ' ') << " }";
+  }
+  return;
+}
+
+// merge content of boost ptree pt2 into pt1
+// existing nodes are NOT overwritten
+void mergeTree (boost::property_tree::ptree &pt1, boost::property_tree::ptree &pt2) {
+  // iterate each node in pt2
+  for (boost::property_tree::ptree::iterator pos = pt2.begin(); pos != pt2.end(); ++pos) {
+    auto nodeName = pos->first;
+    // is there a key match in pt1 ?
+    auto sub1 = pt1.get_child_optional(nodeName);
+    if (!sub1) {
+      // no match, insert
+      pt1.put_child(nodeName, pos->second);
+    } else {
+      // match, merge subtrees
+      mergeTree(sub1.get(), pos->second);
+    }
+  }
+}
+
 int Readout::_configure(const boost::property_tree::ptree& properties)
 {
   theLog.log(LogInfoSupport_(3005), "Readout executing CONFIGURE");
@@ -735,31 +776,58 @@ int Readout::_configure(const boost::property_tree::ptree& properties)
 
   // load configuration file
   theLog.log(LogInfoSupport, "Reading configuration from %s %s", cfgFileURI, cfgFileEntryPoint);
-  try {
-    // check URI prefix
-    if (!strncmp(cfgFileURI, "file:", 5)) {
-      // let's use the 'Common' config file library
-      cfg.load(cfgFileURI);
-    } else {
-// otherwise use the Configuration module, if available
-#ifdef WITH_CONFIG
-      try {
-        std::unique_ptr<o2::configuration::ConfigurationInterface> conf = o2::configuration::ConfigurationFactory::getConfiguration(cfgFileURI);
-        boost::property_tree::ptree t = conf->getRecursive(cfgFileEntryPoint);
-        cfg.load(t);
-        // cfg.print();
-      } catch (std::exception& e) {
-        throw std::string(e.what());
+
+  auto loadConfig = [] (const char* cfgFileURI, const char *cfgFileEntryPoint, ConfigFile &cfg) {
+    try {
+      // check URI prefix
+      if (!strncmp(cfgFileURI, "file:", 5)) {
+        // let's use the 'Common' config file library
+        cfg.load(cfgFileURI);
+      } else {
+        // otherwise use the Configuration module, if available
+        #ifdef WITH_CONFIG
+          try {
+            std::unique_ptr<o2::configuration::ConfigurationInterface> conf = o2::configuration::ConfigurationFactory::getConfiguration(cfgFileURI);
+            boost::property_tree::ptree t = conf->getRecursive(cfgFileEntryPoint);
+            cfg.load(t);
+            // cfg.print();
+          } catch (std::exception& e) {
+            throw std::string(e.what());
+          }
+        #else
+          throw std::string("This type of URI is not supported");
+        #endif
       }
-#else
-      throw std::string("This type of URI is not supported");
-#endif
+    } catch (std::string err) {
+      theLog.log(LogErrorSupport_(3100), "Failed to read config: %s", err.c_str());
+      return -1;
     }
-  } catch (std::string err) {
-    theLog.log(LogErrorSupport_(3100), "Failed to read config: %s", err.c_str());
+    return 0;
+  };
+
+  if (loadConfig(cfgFileURI, cfgFileEntryPoint, cfg)) {
     return -1;
   }
 
+  //printTree(cfg.get(),0);
+
+  // configuration parameter: | readout | defaults | string |  | If set, the corresponding configuration URI is loaded and merged with current readout configuration. Existing parameters in current config are NOT overwritten. |
+
+  // try to load extra defaults, if defined, and merge
+  std::string cfgDefaultsPath = "";
+  if (cfg.getOptionalValue<std::string>("readout.defaults", cfgDefaultsPath) == 0) {
+    ConfigFile cfgDefaults;
+    theLog.log(LogInfoDevel, "Reading configuration defaults from %s %s", cfgDefaultsPath.c_str(), cfgFileEntryPoint);
+    if (loadConfig(cfgDefaultsPath.c_str(), cfgFileEntryPoint, cfgDefaults) == 0) {
+      //printTree(cfgDefaults.get(),0);
+      // merge trees: defaults values used if not defined already
+      mergeTree(cfg.get(), cfgDefaults.get());
+      //printTree(cfg.get(),0);
+    } else {
+     return -1;
+    }
+  }
+
   // TODO
   // save config somewhere ?
 

src/readoutConfigEditor.tcl

@@ -145,6 +145,7 @@ set configurationParametersDescriptor {
 | readout | aggregatorSliceTimeout | double | 0 | When set, slices (groups) of pages are flushed if not updated after given timeout (otherwise closed only on beginning of next TF, or on stop). |
 | readout | aggregatorStfTimeout | double | 0 | When set, subtimeframes are buffered until timeout (otherwise, sent immediately and independently for each data source). |
 | readout | customCommands | string | | List of key=value pairs defining some custom shell commands to be executed at before/after state change commands. |
+| readout | defaults | string |  | If set, the corresponding configuration URI is loaded and merged with current readout configuration. Existing parameters in current config are NOT overwritten. |
 | readout | disableAggregatorSlicing | int | 0 | When set, the aggregator slicing is disabled, data pages are passed through without grouping/slicing. |
 | readout | disableTimeframes | int | 0 | When set, all timeframe related features are disabled (this may supersede other config parameters). |
 | readout | exitTimeout | double | -1 | Time in seconds after which the program exits automatically. -1 for unlimited. |