sched: add unittest for separate PUCCH cfgs

Signed-off-by: Carlo Galiotto <[email protected]>

Author: carlo-gal

lib/scheduler/pucch_scheduling/pucch_resource_manager.cpp

@@ -46,8 +46,8 @@ pucch_resource_manager::pucch_resource_manager()
 {
   auto reset_slot_record = [](rnti_pucch_res_id_slot_record& res_counter) {
     for (auto& ue_rec : res_counter.ues_using_pucch_res) {
-      ue_rec.rnti   = INVALID_RNTI;
-      ue_rec.format = pucch_format::NOF_FORMATS;
+      ue_rec.rnti           = INVALID_RNTI;
+      ue_rec.resource_usage = pucch_resource_usage::NOT_USED;
     }
     for (auto& res : res_counter.used_common_resources) {
       res = false;
@@ -68,8 +68,8 @@ void pucch_resource_manager::slot_indication(slot_point slot_tx)
   rnti_pucch_res_id_slot_record& res_counter = get_slot_resource_counter(last_sl_ind - 1);
 
   for (auto& ue_rec : res_counter.ues_using_pucch_res) {
-    ue_rec.rnti   = INVALID_RNTI;
-    ue_rec.format = pucch_format::NOF_FORMATS;
+    ue_rec.rnti           = INVALID_RNTI;
+    ue_rec.resource_usage = pucch_resource_usage::NOT_USED;
   }
   for (auto& res : res_counter.used_common_resources) {
     res = false;
@@ -114,23 +114,36 @@ const pucch_resource* pucch_resource_manager::reserve_specific_format2_res(slot_
 
   // Get resource list of wanted slot.
   rnti_pucch_res_id_slot_record& res_counter = get_slot_resource_counter(slot_harq);
-
+  // Retrieve the PUCCH resource set.
   const auto& ue_res_id_set_for_harq_f2 = pucch_cfg.pucch_res_set[PUCCH_HARQ_F2_RES_SET_ID].pucch_res_id_list;
 
+  // Make sure the resource indicator points to a valid resource.
   if (res_indicator >= ue_res_id_set_for_harq_f2.size()) {
     return nullptr;
   }
 
+  // Get PUCCH resource ID from the PUCCH resource set.
   const unsigned pucch_res_id = ue_res_id_set_for_harq_f2[res_indicator];
-
-  const auto& pucch_res_list    = pucch_cfg.pucch_res_list;
+  // Get the PUCCH resource tracker in the PUCCH resource manager.
   auto&       pucch_res_tracker = res_counter.ues_using_pucch_res[pucch_res_id];
+  const auto& pucch_res_list    = pucch_cfg.pucch_res_list;
 
+  // Check first if the wanted PUCCH resource is available.
   if (pucch_res_tracker.rnti == INVALID_RNTI) {
-    pucch_res_tracker.rnti   = crnti;
-    pucch_res_tracker.format = pucch_format::FORMAT_2;
-    return &pucch_res_list[pucch_res_id];
+    // Search for the PUCCH resource with the correct PUCCH resource ID from the PUCCH resource list.
+    const auto* res_cfg =
+        std::find_if(pucch_res_list.begin(), pucch_res_list.end(), [pucch_res_id](const pucch_resource& res) {
+          return res.res_id == pucch_res_id;
+        });
+
+    // If the PUCCH res with correct ID is found, then allocate it to the user.
+    if (res_cfg != pucch_res_list.end()) {
+      pucch_res_tracker.rnti           = crnti;
+      pucch_res_tracker.resource_usage = pucch_resource_usage::HARQ_F2;
+      return &(*res_cfg);
+    }
   }
+
   return nullptr;
 }
 
@@ -141,18 +154,35 @@ const pucch_resource* pucch_resource_manager::reserve_csi_resource(slot_point
   srsran_sanity_check(slot_csi < last_sl_ind + RES_MANAGER_RING_BUFFER_SIZE,
                       "PUCCH being allocated to far into the future");
 
-  const int csi_pucch_res_idx = get_pucch_res_idx_for_csi(ue_cell_cfg);
-  if (csi_pucch_res_idx < 0) {
+  // Get CSI specific PUCCH resource ID from the CSI meas config.
+  const int csi_pucch_res_idx_int = get_pucch_res_idx_for_csi(ue_cell_cfg);
+  if (csi_pucch_res_idx_int < 0) {
     return nullptr;
   }
+  const unsigned csi_pucch_res_idx = static_cast<unsigned>(csi_pucch_res_idx_int);
+
+  // Get resource list of wanted slot.
   auto& slot_record = get_slot_resource_counter(slot_csi);
   if (slot_record.ues_using_pucch_res[csi_pucch_res_idx].rnti != INVALID_RNTI) {
     return nullptr;
   }
 
-  slot_record.ues_using_pucch_res[csi_pucch_res_idx].rnti   = crnti;
-  slot_record.ues_using_pucch_res[csi_pucch_res_idx].format = pucch_format::FORMAT_2;
-  return &ue_cell_cfg.cfg_dedicated().ul_config.value().init_ul_bwp.pucch_cfg.value().pucch_res_list[csi_pucch_res_idx];
+  const auto& pucch_res_list =
+      ue_cell_cfg.cfg_dedicated().ul_config.value().init_ul_bwp.pucch_cfg.value().pucch_res_list;
+  // Search for the PUCCH resource with the correct PUCCH resource ID from the PUCCH resource list.
+  const auto* res_cfg =
+      std::find_if(pucch_res_list.begin(), pucch_res_list.end(), [csi_pucch_res_idx](const pucch_resource& res) {
+        return res.res_id == csi_pucch_res_idx;
+      });
+
+  // If the PUCCH res with correct ID is found, then allocate it to the user.
+  if (res_cfg != pucch_res_list.end()) {
+    slot_record.ues_using_pucch_res[csi_pucch_res_idx].rnti           = crnti;
+    slot_record.ues_using_pucch_res[csi_pucch_res_idx].resource_usage = pucch_resource_usage::CSI;
+    return &(*res_cfg);
+  }
+
+  return nullptr;
 };
 
 const pucch_resource*
@@ -170,9 +200,21 @@ pucch_resource_manager::reserve_sr_res_available(slot_point slot_sr, rnti_t crnt
     return nullptr;
   }
 
-  slot_record.ues_using_pucch_res[sr_pucch_res_id].rnti   = crnti;
-  slot_record.ues_using_pucch_res[sr_pucch_res_id].format = pucch_format::FORMAT_2;
-  return &pucch_cfg.pucch_res_list[sr_pucch_res_id];
+  const auto& pucch_res_list = pucch_cfg.pucch_res_list;
+  // Search for the PUCCH resource with the correct PUCCH resource ID from the PUCCH resource list.
+  const auto* res_cfg =
+      std::find_if(pucch_res_list.begin(), pucch_res_list.end(), [sr_pucch_res_id](const pucch_resource& res) {
+        return res.res_id == sr_pucch_res_id;
+      });
+
+  // If the PUCCH res with correct ID is found, then allocate it to the user.
+  if (res_cfg != pucch_res_list.end()) {
+    slot_record.ues_using_pucch_res[sr_pucch_res_id].rnti           = crnti;
+    slot_record.ues_using_pucch_res[sr_pucch_res_id].resource_usage = pucch_resource_usage::SR;
+    return &(*res_cfg);
+  }
+
+  return nullptr;
 };
 
 bool pucch_resource_manager::release_harq_f1_resource(slot_point slot_harq, rnti_t crnti, const pucch_config& pucch_cfg)
@@ -200,8 +242,8 @@ bool pucch_resource_manager::release_sr_resource(slot_point slot_sr, rnti_t crnt
     return false;
   }
 
-  slot_record.ues_using_pucch_res[sr_pucch_res_id].rnti   = INVALID_RNTI;
-  slot_record.ues_using_pucch_res[sr_pucch_res_id].format = pucch_format::NOF_FORMATS;
+  slot_record.ues_using_pucch_res[sr_pucch_res_id].rnti           = INVALID_RNTI;
+  slot_record.ues_using_pucch_res[sr_pucch_res_id].resource_usage = pucch_resource_usage::NOT_USED;
   return true;
 }
 
@@ -214,7 +256,7 @@ bool pucch_resource_manager::release_csi_resource(slot_point                   s
 
   auto& slot_record = get_slot_resource_counter(slot_sr);
 
-  // We assume each UE only has 1 SR Resource Config configured.
+  // We assume each UE only has 1 CSI Resource Config configured.
   const int csi_pucch_res_idx = get_pucch_res_idx_for_csi(ue_cell_cfg);
   if (csi_pucch_res_idx < 0) {
     return false;
@@ -223,8 +265,8 @@ bool pucch_resource_manager::release_csi_resource(slot_point                   s
     return false;
   }
 
-  slot_record.ues_using_pucch_res[csi_pucch_res_idx].rnti   = INVALID_RNTI;
-  slot_record.ues_using_pucch_res[csi_pucch_res_idx].format = pucch_format::NOF_FORMATS;
+  slot_record.ues_using_pucch_res[csi_pucch_res_idx].rnti           = INVALID_RNTI;
+  slot_record.ues_using_pucch_res[csi_pucch_res_idx].resource_usage = pucch_resource_usage::NOT_USED;
   return true;
 }
 
@@ -247,19 +289,31 @@ const pucch_resource* pucch_resource_manager::fetch_csi_pucch_res_config(slot_po
 
   rnti_pucch_res_id_slot_record& slot_record = get_slot_resource_counter(slot_tx);
 
-  // We assume each UE only has 1 SR Resource Config configured.
-  const int csi_pucch_res_idx = get_pucch_res_idx_for_csi(ue_cell_cfg);
-  if (csi_pucch_res_idx < 0) {
+  const int csi_pucch_res_idx_int = get_pucch_res_idx_for_csi(ue_cell_cfg);
+  if (csi_pucch_res_idx_int < 0) {
     return nullptr;
   }
 
+  const unsigned csi_pucch_res_idx = static_cast<unsigned>(csi_pucch_res_idx_int);
   if (slot_record.ues_using_pucch_res[csi_pucch_res_idx].rnti != crnti) {
     return nullptr;
   }
 
-  const pucch_config& pucch_cfg = ue_cell_cfg.cfg_dedicated().ul_config.value().init_ul_bwp.pucch_cfg.value();
+  const auto& pucch_res_list =
+      ue_cell_cfg.cfg_dedicated().ul_config.value().init_ul_bwp.pucch_cfg.value().pucch_res_list;
 
-  return &pucch_cfg.pucch_res_list[csi_pucch_res_idx];
+  // Search for the PUCCH resource with the correct PUCCH resource ID from the PUCCH resource list.
+  const auto* res_cfg =
+      std::find_if(pucch_res_list.begin(), pucch_res_list.end(), [csi_pucch_res_idx](const pucch_resource& res) {
+        return res.res_id == csi_pucch_res_idx;
+      });
+
+  // If the PUCCH res with correct ID is found, then return it to the user.
+  if (res_cfg != pucch_res_list.end()) {
+    return &(*res_cfg);
+  }
+
+  return nullptr;
 }
 
 pucch_harq_resource_alloc_record pucch_resource_manager::reserve_next_harq_res_available(slot_point          slot_harq,
@@ -284,27 +338,33 @@ pucch_harq_resource_alloc_record pucch_resource_manager::reserve_next_harq_res_a
   unsigned               ue_first_f1_res_id     = ue_res_id_set_for_harq.front();
   span<resource_tracker> slot_ue_res_array(&slot_res_array[ue_first_f1_res_id], slot_res_array.size());
 
+  // Check first if there is any PUCCH resource is available.
   auto* available_resource = std::find_if(slot_ue_res_array.begin(),
                                           slot_ue_res_array.end(),
                                           [](const resource_tracker res) { return res.rnti == INVALID_RNTI; });
 
   const auto& pucch_res_list = pucch_cfg.pucch_res_list;
 
+  // If there is an available resource, try to allocate it.
   if (available_resource != slot_ue_res_array.end() and
       static_cast<unsigned>(available_resource - slot_ue_res_array.begin()) <
           pucch_cfg.pucch_res_set[res_set_idx].pucch_res_id_list.size()) {
+    // Get the PUCCH resource indicator from the available resource position within the span.
     const unsigned pucch_res_indicator = static_cast<unsigned>(available_resource - slot_ue_res_array.begin());
-
+    // Get the PUCCH resource ID from the PUCCH resource indicator and the PUCCH resource set.
     const unsigned pucch_res_idx_from_list = ue_res_id_set_for_harq[pucch_res_indicator];
 
+    // Search for the PUCCH resource with the correct PUCCH resource ID from the PUCCH resource list.
     const auto* res_cfg = std::find_if(
         pucch_res_list.begin(), pucch_res_list.end(), [pucch_res_idx_from_list](const pucch_resource& res) {
           return res.res_id == pucch_res_idx_from_list;
         });
 
+    // If so, allocate it.
     if (res_cfg != pucch_res_list.end()) {
-      available_resource->rnti   = crnti;
-      available_resource->format = format;
+      available_resource->rnti = crnti;
+      available_resource->resource_usage =
+          format == pucch_format::FORMAT_1 ? pucch_resource_usage::HARQ_F1 : pucch_resource_usage::HARQ_F2;
       return pucch_harq_resource_alloc_record{.pucch_res = &(*res_cfg), .pucch_res_indicator = pucch_res_indicator};
     }
   }
@@ -327,20 +387,24 @@ bool pucch_resource_manager::release_harq_resource(slot_point          slot_harq
   auto& slot_res_array = res_counter.ues_using_pucch_res;
 
   const unsigned res_set_idx = format == pucch_format::FORMAT_1 ? PUCCH_HARQ_F1_RES_SET_ID : PUCCH_HARQ_F2_RES_SET_ID;
+  const pucch_resource_usage res_usage =
+      format == pucch_format::FORMAT_1 ? pucch_resource_usage::HARQ_F1 : pucch_resource_usage::HARQ_F2;
 
   // Get the span over the array of resources for the specific UE.
   const auto&            ue_res_id_set_for_harq = pucch_cfg.pucch_res_set[res_set_idx].pucch_res_id_list;
   unsigned               ue_first_f1_res_id     = ue_res_id_set_for_harq.front();
   span<resource_tracker> slot_ue_res_array(&slot_res_array[ue_first_f1_res_id], slot_res_array.size());
 
-  auto* target_res = std::find_if(slot_ue_res_array.begin(),
-                                  slot_ue_res_array.end(),
-                                  [crnti](const resource_tracker res) { return res.rnti == crnti; });
+  // Check first if the target PUCCH resource (given the CRNTI and usage) exists within the resource tracker.
+  auto* target_res =
+      std::find_if(slot_ue_res_array.begin(), slot_ue_res_array.end(), [crnti, res_usage](const resource_tracker res) {
+        return res.rnti == crnti and res.resource_usage == res_usage;
+      });
 
   // If the resources was found, then release it (i.e., remove the C-RNTI of the user allocated to it).
   if (target_res != slot_ue_res_array.end()) {
-    target_res->rnti   = INVALID_RNTI;
-    target_res->format = pucch_format::NOF_FORMATS;
+    target_res->rnti           = INVALID_RNTI;
+    target_res->resource_usage = pucch_resource_usage::NOT_USED;
     return true;
   }
 
@@ -363,19 +427,23 @@ int pucch_resource_manager::fetch_pucch_res_indic(slot_point          slot_tx,
   auto& slot_res_array = res_counter.ues_using_pucch_res;
 
   const unsigned res_set_idx = format == pucch_format::FORMAT_1 ? PUCCH_HARQ_F1_RES_SET_ID : PUCCH_HARQ_F2_RES_SET_ID;
+  const pucch_resource_usage res_usage =
+      format == pucch_format::FORMAT_1 ? pucch_resource_usage::HARQ_F1 : pucch_resource_usage::HARQ_F2;
 
   // Get the span over the array of resources for the specific UE.
   const auto&            ue_res_id_set_for_harq = pucch_cfg.pucch_res_set[res_set_idx].pucch_res_id_list;
   unsigned               ue_first_f1_res_id     = ue_res_id_set_for_harq.front();
   span<resource_tracker> slot_ue_res_array(&slot_res_array[ue_first_f1_res_id], slot_res_array.size());
 
-  auto ue_resource =
-      std::find_if(slot_ue_res_array.begin(),
-                   slot_ue_res_array.end(),
-                   [target_rnti = crnti](const resource_tracker res) { return res.rnti == target_rnti; });
+  // Check first if the target PUCCH resource (given the CRNTI and usage) exists within the resource tracker.
+  auto* ue_resource = std::find_if(
+      slot_ue_res_array.begin(), slot_ue_res_array.end(), [target_rnti = crnti, res_usage](const resource_tracker res) {
+        return res.rnti == target_rnti and res.resource_usage == res_usage;
+      });
 
   if (ue_resource != slot_ue_res_array.end() and static_cast<unsigned>(ue_resource - slot_ue_res_array.begin()) <
                                                      pucch_cfg.pucch_res_set[res_set_idx].pucch_res_id_list.size()) {
+    // Get the PUCCH resource indicator from the available resource position within the span.
     return static_cast<unsigned>(ue_resource - slot_ue_res_array.begin());
   }