config: added YAML writter to the gNB appplication configuration

Author: AlaiaL

apps/gnb/CMakeLists.txt

@@ -11,6 +11,7 @@ add_executable(gnb
         gnb_appconfig_cli11_schema.cpp
         gnb_appconfig_validators.cpp
         gnb_appconfig_translators.cpp
+        gnb_appconfig_yaml_writer.cpp
         adapters/e2_gateway_remote_connector.cpp
         )
 

apps/gnb/gnb.cpp

@@ -45,6 +45,8 @@
 
 // Include ThreadSanitizer (TSAN) options if thread sanitization is enabled.
 // This include is not unused - it helps prevent false alarms from the thread sanitizer.
+#include "gnb_appconfig_yaml_writer.h"
+
 #include "srsran/support/tsan_options.h"
 
 #include "apps/units/cu_cp/cu_cp_config_translators.h"
@@ -249,6 +251,7 @@ int main(int argc, char** argv)
 
     config_logger.debug("NOW IT GOES THE MANUAL CONFIG");
     YAML::Node node;
+    fill_gnb_appconfig_in_yaml_schema(node, gnb_cfg);
     fill_cu_up_config_in_yaml_schema(node, cu_up_config);
     fill_cu_cp_config_in_yaml_schema(node, cu_cp_config);
     fill_dynamic_du_unit_config_in_yaml_schema(node, du_unit_cfg);

apps/gnb/gnb_appconfig_yaml_writer.cpp

@@ -0,0 +1,93 @@
+/*
+ *
+ * Copyright 2021-2024 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#include "gnb_appconfig_yaml_writer.h"
+#include "apps/services/logger/logger_appconfig_yaml_writer.h"
+#include "gnb_appconfig.h"
+
+using namespace srsran;
+
+static void fill_gnb_appconfig_metrics_section(YAML::Node node, const metrics_appconfig& config)
+{
+  node["pdcp_report_period"]       = config.pdcp.report_period;
+  node["enable_json_metrics"]      = config.enable_json_metrics;
+  node["addr"]                     = config.addr;
+  node["port"]                     = config.port;
+  node["autostart_stdout_metrics"] = config.autostart_stdout_metrics;
+  node["stdout_metrics_period"]    = config.stdout_metrics_period;
+}
+
+static void fill_gnb_appconfig_e2_section(YAML::Node node, const e2_appconfig& config)
+{
+  node["enable_du_e2"]           = config.enable_du_e2;
+  node["addr"]                   = config.ip_addr;
+  node["port"]                   = config.port;
+  node["bind_addr"]              = config.bind_addr;
+  node["sctp_rto_initial"]       = config.sctp_rto_initial;
+  node["sctp_rto_min"]           = config.sctp_rto_min;
+  node["sctp_rto_max"]           = config.sctp_rto_max;
+  node["sctp_init_max_attempts"] = config.sctp_init_max_attempts;
+  node["sctp_max_init_timeo"]    = config.sctp_max_init_timeo;
+  node["e2sm_kpm_enabled"]       = config.e2sm_kpm_enabled;
+  node["e2sm_rc_enabled"]        = config.e2sm_rc_enabled;
+}
+
+static void fill_gnb_appconfig_hal_section(YAML::Node node, const std::optional<hal_appconfig>& config)
+{
+  if (!config.has_value()) {
+    return;
+  }
+  YAML::Node hal_node  = node["hal"];
+  hal_node["eal_args"] = config.value().eal_args;
+}
+
+static void fill_gnb_appconfig_expert_execution_section(YAML::Node node, const expert_execution_appconfig& config)
+{
+  {
+    YAML::Node affinities_node = node["affinities"];
+
+    if (config.affinities.isolated_cpus.has_value()) {
+      affinities_node["isolated_cpus"] =
+          fmt::format("{:,}", span<const size_t>(config.affinities.isolated_cpus.value().get_cpu_ids()));
+    }
+
+    if (config.affinities.low_priority_cpu_cfg.mask.any()) {
+      affinities_node["l2_cell_cpus"] =
+          fmt::format("{:,}", span<const size_t>(config.affinities.low_priority_cpu_cfg.mask.get_cpu_ids()));
+    }
+    affinities_node["low_priority_pinning"] = to_string(config.affinities.low_priority_cpu_cfg.pinning_policy);
+  }
+
+  {
+    YAML::Node threads_node           = node["threads"];
+    YAML::Node non_rt_node            = threads_node["non_rt"];
+    non_rt_node["nof_non_rt_threads"] = config.threads.non_rt_threads.nof_non_rt_threads;
+  }
+}
+
+static void fill_gnb_appconfig_buffer_pool_section(YAML::Node node, const buffer_pool_appconfig& config)
+{
+  node["nof_segments"] = config.nof_segments;
+  node["segment_size"] = config.segment_size;
+}
+
+void srsran::fill_gnb_appconfig_in_yaml_schema(YAML::Node& node, const gnb_appconfig& config)
+{
+  node["gnb_id"]            = config.gnb_id.id;
+  node["gnb_id_bit_length"] = static_cast<unsigned>(config.gnb_id.bit_length);
+  node["ran_node_name"]     = config.ran_node_name;
+
+  fill_logger_appconfig_in_yaml_schema(node, config.log_cfg);
+  fill_gnb_appconfig_metrics_section(node["metrics"], config.metrics_cfg);
+  fill_gnb_appconfig_e2_section(node["e2"], config.e2_cfg);
+  fill_gnb_appconfig_hal_section(node, config.hal_config);
+  fill_gnb_appconfig_expert_execution_section(node["expert_execution"], config.expert_execution_cfg);
+  fill_gnb_appconfig_buffer_pool_section(node["buffer_pool"], config.buffer_pool_config);
+}

apps/gnb/gnb_appconfig_yaml_writer.h

@@ -0,0 +1,22 @@
+/*
+ *
+ * Copyright 2021-2024 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#pragma once
+
+#include <yaml-cpp/yaml.h>
+
+namespace srsran {
+
+struct gnb_appconfig;
+
+/// Fills the given node with the gNB application configuration values.
+void fill_gnb_appconfig_in_yaml_schema(YAML::Node& node, const gnb_appconfig& config);
+
+} // namespace srsran

apps/services/logger/CMakeLists.txt

@@ -7,8 +7,9 @@
 #
 
 set(SOURCES
-       logger_appconfig_cli11_schema.cpp
-        logger_appconfig_validator.cpp)
+        logger_appconfig_cli11_schema.cpp
+        logger_appconfig_validator.cpp
+        logger_appconfig_yaml_writer.cpp)
 
 add_library(srsran_logger_app_service STATIC ${SOURCES})
 target_include_directories(srsran_logger_app_service PRIVATE ${CMAKE_SOURCE_DIR})

apps/services/logger/logger_appconfig_yaml_writer.cpp

@@ -0,0 +1,29 @@
+/*
+ *
+ * Copyright 2021-2024 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#include "logger_appconfig_yaml_writer.h"
+#include "logger_appconfig.h"
+
+using namespace srsran;
+
+void srsran::fill_logger_appconfig_in_yaml_schema(YAML::Node& node, const logger_appconfig& config)
+{
+  YAML::Node log_node       = node["log"];
+  log_node["filename"]      = config.filename;
+  log_node["lib_level"]     = srslog::basic_level_to_string(config.lib_level);
+  log_node["e2ap_level"]    = srslog::basic_level_to_string(config.e2ap_level);
+  log_node["config_level"]  = srslog::basic_level_to_string(config.config_level);
+  log_node["metrics_level"] = srslog::basic_level_to_string(config.metrics_level);
+  log_node["hex_max_size"]  = config.hex_max_size;
+
+  if (!config.tracing_filename.empty()) {
+    log_node["tracing_filename"] = config.tracing_filename;
+  }
+}

apps/services/logger/logger_appconfig_yaml_writer.h

@@ -0,0 +1,22 @@
+/*
+ *
+ * Copyright 2021-2024 Software Radio Systems Limited
+ *
+ * By using this file, you agree to the terms and conditions set
+ * forth in the LICENSE file which can be found at the top level of
+ * the distribution.
+ *
+ */
+
+#pragma once
+
+#include <yaml-cpp/yaml.h>
+
+namespace srsran {
+
+struct logger_appconfig;
+
+/// Fills the given node with the logger application configuration values.
+void fill_logger_appconfig_in_yaml_schema(YAML::Node& node, const logger_appconfig& config);
+
+} // namespace srsran

apps/units/flexible_du/du_high/du_high_config_yaml_writer.cpp

@@ -747,10 +747,8 @@ static YAML::Node build_du_high_testmode_section(const du_high_unit_test_mode_co
   return node;
 }
 
-static YAML::Node build_du_high_e2_section(const du_high_unit_e2_config& config)
+static void fill_du_high_e2_section(YAML::Node node, const du_high_unit_e2_config& config)
 {
-  YAML::Node node;
-
   node["enable_du_e2"]           = config.enable_du_e2;
   node["addr"]                   = config.ip_addr;
   node["port"]                   = config.port;
@@ -762,8 +760,6 @@ static YAML::Node build_du_high_e2_section(const du_high_unit_e2_config& config)
   node["sctp_max_init_timeo"]    = config.sctp_max_init_timeo;
   node["e2sm_kpm_enabled"]       = config.e2sm_kpm_enabled;
   node["e2sm_rc_enabled"]        = config.e2sm_rc_enabled;
-
-  return node;
 }
 
 void srsran::fill_du_high_config_in_yaml_schema(YAML::Node& node, const du_high_unit_config& config)
@@ -775,8 +771,8 @@ void srsran::fill_du_high_config_in_yaml_schema(YAML::Node& node, const du_high_
   fill_du_high_log_section(node["log"], config.loggers);
   fill_du_high_metrics_section(node["metrics"], config.metrics);
   fill_du_high_pcap_section(node["pcap"], config.pcaps);
+  fill_du_high_e2_section(node["e2"], config.e2_cfg);
   node["du"] = build_du_section(config);
-  node["e2"] = build_du_high_e2_section(config.e2_cfg);
   if (config.ntn_cfg) {
     node["ntn"] = build_du_high_ntn_section(config.ntn_cfg.value());
   }