e2,du: renaming rrm structs, adding explanatory comments

Author: yagoda

include/srsran/du_manager/du_configurator.h

@@ -17,9 +17,12 @@
 namespace srsran {
 
 struct control_config_params {
+  // sets the number of HARQ processes to be used.
   optional<unsigned>               num_harq_processes;
+  // sets the number of HARQ retransmissions to be used.
   optional<unsigned>               num_harq_retransmissions;
-  optional<RRM_policy_ratio_group> rrm_policy_ratio_group;
+  // set the radio resource management policy.
+  optional<rrm_policy_ratio_group> rrm_policy_group;
 };
 
 struct du_mac_sched_control_config {

include/srsran/ran/rrm.h

@@ -13,16 +13,20 @@
 #include "srsran/ran/s_nssai.h"
 
 namespace srsran {
-
-struct RRM_policy_member {
+/// O-RAN.WG3.E2SM-RC-R003-v3.00 Section 8.4.3.6
+struct rrm_policy_member {
   std::string plmn_id;
   s_nssai_t   s_nssai;
 };
 
-struct RRM_policy_ratio_group {
-  RRM_policy_member pol_member;
+struct rrm_policy_ratio_group {
+  // used to identify the group to which the policy is applied.
+  rrm_policy_member pol_member;
+  // sets the minimum percentage of PRBs to be allocated to this group.
   int               min_PRB_policy_ratio;
+  // sets the maximum percentage of PRBs to be allocated to this group.
   int               max_PRB_policy_ratio;
+  // sets the percentage of PRBs to be allocated to this group.
   int               ded_PRB_policy_ratio;
 };
 

include/srsran/scheduler/scheduler_configurator.h

@@ -109,7 +109,7 @@ struct sched_ue_resource_alloc_config {
   /// Maximum PUSCH HARQ retransmissions.
   unsigned max_pusch_harq_retxs = 4;
   // RRM policy for the UE.
-  RRM_policy_ratio_group rrm_policy_ratio_group;
+  rrm_policy_ratio_group rrm_policy_group;
 };
 
 /// QoS and slicing information associated with a DRB provided to the scheduler.

lib/du_manager/procedures/du_ue_ric_configuration_procedure.cpp

@@ -76,13 +76,12 @@ async_task<mac_ue_reconfiguration_response> du_ue_ric_configuration_procedure::h
   auto& res_alloc_cfg = mac_request.sched_cfg.res_alloc_cfg.value();
   // for now take first parameter set, in future we will have to support multiple parameter sets for different slices.
   control_config_params  req   = request.param_list[0];
-  RRM_policy_ratio_group dummy = {};
-  res_alloc_cfg.rrm_policy_ratio_group =
-      req.rrm_policy_ratio_group.has_value() ? req.rrm_policy_ratio_group.value() : dummy;
+  rrm_policy_ratio_group dummy   = {};
+  res_alloc_cfg.rrm_policy_group = req.rrm_policy_group.has_value() ? req.rrm_policy_group.value() : dummy;
   // TODO remove when RRM group support is added to scheduler.
   res_alloc_cfg.pdsch_grant_size_limits = {
-      req.rrm_policy_ratio_group.has_value() ? req.rrm_policy_ratio_group.value().min_PRB_policy_ratio : 0,
-      req.rrm_policy_ratio_group.has_value() ? req.rrm_policy_ratio_group.value().max_PRB_policy_ratio : MAX_NOF_PRBS};
+      req.rrm_policy_group.has_value() ? req.rrm_policy_group.value().min_PRB_policy_ratio : 0,
+      req.rrm_policy_group.has_value() ? req.rrm_policy_group.value().max_PRB_policy_ratio : MAX_NOF_PRBS};
 
   res_alloc_cfg.max_pdsch_harq_retxs = req.num_harq_retransmissions.has_value()
                                            ? req.num_harq_retransmissions.value()

lib/e2/e2sm/e2sm_rc/e2sm_rc_control_action_du_executor.cpp

@@ -101,72 +101,72 @@ void e2sm_rc_control_action_2_6_du_executor::parse_action_ran_parameter_value(co
                                                                               uint64_t                     ue_id,
                                                                               du_mac_sched_control_config& ctrl_cfg)
 {
-  if (ran_param_id == 6) {
+  if (action_params[ran_param_id] == "PLMN Identity") {
     control_config_params cur_control_params = {};
-    cur_control_params.rrm_policy_ratio_group.emplace();
-    cur_control_params.rrm_policy_ratio_group.value().pol_member.plmn_id.append(
+    cur_control_params.rrm_policy_group.emplace();
+    cur_control_params.rrm_policy_group.value().pol_member.plmn_id.append(
         ran_param.ran_p_choice_elem_false().ran_param_value.value_oct_s().to_string());
     ctrl_cfg.param_list.push_back(cur_control_params);
   } else if (ran_param_id == 8) {
     if (ctrl_cfg.param_list.size()) {
-      if (ctrl_cfg.param_list.back().rrm_policy_ratio_group.value().pol_member.s_nssai.sst) {
+      if (ctrl_cfg.param_list.back().rrm_policy_group.value().pol_member.s_nssai.sst) {
         control_config_params cur_control_params = {};
-        cur_control_params.rrm_policy_ratio_group.emplace();
+        cur_control_params.rrm_policy_group.emplace();
         cur_control_params = ctrl_cfg.param_list.back();
-        cur_control_params.rrm_policy_ratio_group.value().pol_member.s_nssai.sst =
+        cur_control_params.rrm_policy_group.value().pol_member.s_nssai.sst =
             ran_param.ran_p_choice_elem_false().ran_param_value.value_oct_s().to_number();
         ctrl_cfg.param_list.push_back(cur_control_params);
       } else {
-        ctrl_cfg.param_list.back().rrm_policy_ratio_group.value().pol_member.s_nssai.sst =
+        ctrl_cfg.param_list.back().rrm_policy_group.value().pol_member.s_nssai.sst =
             ran_param.ran_p_choice_elem_false().ran_param_value.value_oct_s().to_number();
       }
     }
   } else if (ran_param_id == 9) {
     if (ctrl_cfg.param_list.size()) {
-      if (ctrl_cfg.param_list.back().rrm_policy_ratio_group.value().pol_member.s_nssai.sd.has_value()) {
+      if (ctrl_cfg.param_list.back().rrm_policy_group.value().pol_member.s_nssai.sd.has_value()) {
         control_config_params cur_control_params = {};
-        cur_control_params.rrm_policy_ratio_group.emplace();
+        cur_control_params.rrm_policy_group.emplace();
         cur_control_params = ctrl_cfg.param_list.back();
-        cur_control_params.rrm_policy_ratio_group.value().pol_member.s_nssai.sd.emplace();
-        cur_control_params.rrm_policy_ratio_group.value().pol_member.s_nssai.sd =
+        cur_control_params.rrm_policy_group.value().pol_member.s_nssai.sd.emplace();
+        cur_control_params.rrm_policy_group.value().pol_member.s_nssai.sd =
             ran_param.ran_p_choice_elem_false().ran_param_value.value_oct_s().to_number();
         ctrl_cfg.param_list.push_back(cur_control_params);
       } else {
-        ctrl_cfg.param_list.back().rrm_policy_ratio_group.value().pol_member.s_nssai.sd.emplace();
-        ctrl_cfg.param_list.back().rrm_policy_ratio_group.value().pol_member.s_nssai.sd =
+        ctrl_cfg.param_list.back().rrm_policy_group.value().pol_member.s_nssai.sd.emplace();
+        ctrl_cfg.param_list.back().rrm_policy_group.value().pol_member.s_nssai.sd =
             ran_param.ran_p_choice_elem_false().ran_param_value.value_oct_s().to_number();
       }
     }
   } else if (ran_param_id == 10) {
     if (ctrl_cfg.param_list.size()) {
-      if (!ctrl_cfg.param_list.back().rrm_policy_ratio_group.has_value()) {
-        ctrl_cfg.param_list.back().rrm_policy_ratio_group.emplace();
+      if (!ctrl_cfg.param_list.back().rrm_policy_group.has_value()) {
+        ctrl_cfg.param_list.back().rrm_policy_group.emplace();
       }
-      ctrl_cfg.param_list.back().rrm_policy_ratio_group.value().min_PRB_policy_ratio =
+      ctrl_cfg.param_list.back().rrm_policy_group.value().min_PRB_policy_ratio =
           ran_param.ran_p_choice_elem_false().ran_param_value.value_int();
     } else {
       control_config_params cur_control_params = {};
-      cur_control_params.rrm_policy_ratio_group.emplace();
-      cur_control_params.rrm_policy_ratio_group.value().min_PRB_policy_ratio =
+      cur_control_params.rrm_policy_group.emplace();
+      cur_control_params.rrm_policy_group.value().min_PRB_policy_ratio =
           ran_param.ran_p_choice_elem_false().ran_param_value.value_int();
       ctrl_cfg.param_list.push_back(cur_control_params);
     }
   } else if (ran_param_id == 11) {
     if (ctrl_cfg.param_list.size()) {
-      if (!ctrl_cfg.param_list.back().rrm_policy_ratio_group.has_value()) {
-        ctrl_cfg.param_list.back().rrm_policy_ratio_group.emplace();
+      if (!ctrl_cfg.param_list.back().rrm_policy_group.has_value()) {
+        ctrl_cfg.param_list.back().rrm_policy_group.emplace();
       }
-      ctrl_cfg.param_list.back().rrm_policy_ratio_group.value().max_PRB_policy_ratio =
+      ctrl_cfg.param_list.back().rrm_policy_group.value().max_PRB_policy_ratio =
           ran_param.ran_p_choice_elem_false().ran_param_value.value_int();
     } else {
       control_config_params cur_control_params = {};
-      cur_control_params.rrm_policy_ratio_group.emplace();
-      cur_control_params.rrm_policy_ratio_group.value().max_PRB_policy_ratio =
+      cur_control_params.rrm_policy_group.emplace();
+      cur_control_params.rrm_policy_group.value().max_PRB_policy_ratio =
           ran_param.ran_p_choice_elem_false().ran_param_value.value_int();
       ctrl_cfg.param_list.push_back(cur_control_params);
     }
   } else {
-    logger.error("Unknown RAN parameter ID %d", ran_param_id);
+    logger.error("Unknown RAN parameter ID {}", ran_param_id);
     return;
   }
 }
@@ -247,17 +247,17 @@ e2sm_ric_control_response e2sm_rc_control_action_2_6_du_executor::convert_to_e2s
 
   // TODO: fill outcome properly
   control_config_params req = du_config_req_.param_list[0];
-  if (req.rrm_policy_ratio_group.has_value()) {
+  if (req.rrm_policy_group.has_value()) {
     e2sm_rc_ctrl_outcome_format1_item_s min_prb_outcome;
     min_prb_outcome.ran_param_id                    = 10;
-    min_prb_outcome.ran_param_value.set_value_int() = req.rrm_policy_ratio_group.value().min_PRB_policy_ratio;
+    min_prb_outcome.ran_param_value.set_value_int() = req.rrm_policy_group.value().min_PRB_policy_ratio;
     ctrl_outcome.ran_p_list.push_back(min_prb_outcome);
   }
 
-  if (req.rrm_policy_ratio_group.has_value()) {
+  if (req.rrm_policy_group.has_value()) {
     e2sm_rc_ctrl_outcome_format1_item_s max_prb_outcome;
     max_prb_outcome.ran_param_id                    = 11;
-    max_prb_outcome.ran_param_value.set_value_int() = req.rrm_policy_ratio_group.value().max_PRB_policy_ratio;
+    max_prb_outcome.ran_param_value.set_value_int() = req.rrm_policy_group.value().max_PRB_policy_ratio;
     ctrl_outcome.ran_p_list.push_back(max_prb_outcome);
   }
 

tests/unittests/du_manager/procedures/du_ue_ric_configuration_procedure_test.cpp

@@ -46,7 +46,7 @@ TEST_F(du_ue_ric_config_tester,
        when_new_ric_config_is_started_then_du_manager_starts_mac_config_and_waits_for_mac_response)
 {
   std::vector<control_config_params> param_list;
-  RRM_policy_ratio_group             pol;
+  rrm_policy_ratio_group             pol;
   pol.max_PRB_policy_ratio = 10;
   pol.min_PRB_policy_ratio = 5;
   param_list.emplace_back(control_config_params{nullopt, nullopt, pol});
@@ -66,7 +66,7 @@ TEST_F(du_ue_ric_config_tester,
 TEST_F(du_ue_ric_config_tester, when_mac_finished_configuration_then_procedure_finishes)
 {
   std::vector<control_config_params> param_list;
-  RRM_policy_ratio_group             pol;
+  rrm_policy_ratio_group             pol;
   param_list.emplace_back(control_config_params{nullopt, nullopt, pol});
   start_procedure(du_mac_sched_control_config{(uint64_t)test_ue->f1ap_ue_id, param_list});
 
@@ -92,7 +92,7 @@ TEST_F(du_ue_ric_config_tester,
 
   // Start RIC UE config.
   std::vector<control_config_params> param_list;
-  RRM_policy_ratio_group             pol;
+  rrm_policy_ratio_group             pol;
   param_list.emplace_back(control_config_params{nullopt, nullopt, pol});
   start_procedure(du_mac_sched_control_config{(uint64_t)test_ue->f1ap_ue_id, param_list});