sched: improve of documentation of slice scheduler and fix minor bugs

Author: frankist

include/srsran/scheduler/config/slice_rrm_policy_config.h

@@ -25,4 +25,4 @@ struct slice_rrm_policy_config {
   unsigned max_prb = MAX_NOF_PRBS;
 };
 
-} // namespace srsran
+} // namespace srsran

lib/scheduler/slicing/ran_slice_candidate.h

@@ -15,6 +15,7 @@
 namespace srsran {
 namespace detail {
 
+/// \brief RAN slice that is the next candidate for allocation in a given slot and cell.
 template <bool IsDl>
 class common_ran_slice_candidate
 {
@@ -38,8 +39,8 @@ class common_ran_slice_candidate
   [[nodiscard]] const slice_rrm_policy_config& cfg() const { return inst->cfg; }
   scheduler_policy&                            policy() { return *inst->policy; }
 
-  bool is_candidate(du_ue_index_t ue_idx) const { return inst->is_candidate(ue_idx); }
-  bool is_candidate(du_ue_index_t ue_idx, lcid_t lcid) const { return inst->is_candidate(ue_idx, lcid); }
+  bool is_candidate(du_ue_index_t ue_idx) const { return inst->contains(ue_idx); }
+  bool is_candidate(du_ue_index_t ue_idx, lcid_t lcid) const { return inst->contains(ue_idx, lcid); }
 
   /// Signal that the allocations for this slice are complete.
   void clear() { inst.reset(); }

lib/scheduler/slicing/ran_slice_id.h

@@ -19,4 +19,4 @@ namespace srsran {
 struct ran_slice_id_tag {};
 using ran_slice_id_t = strong_type<uint8_t, struct ran_slice_id_tag, strong_increment_decrement>;
 
-} // namespace srsran
+} // namespace srsran

lib/scheduler/slicing/ran_slice_instance.cpp

@@ -27,7 +27,7 @@ void ran_slice_instance::slot_indication()
   pusch_stopped  = false;
 }
 
-void ran_slice_instance::set_logical_channel(du_ue_index_t ue_idx, lcid_t lcid)
+void ran_slice_instance::add_logical_channel(du_ue_index_t ue_idx, lcid_t lcid)
 {
   if (not bearers.contains(ue_idx)) {
     bearers.emplace(ue_idx, MAX_NOF_RB_LCIDS);

lib/scheduler/slicing/ran_slice_instance.h

@@ -21,7 +21,8 @@ namespace srsran {
 class ran_slice_instance
 {
 public:
-  constexpr static int skip_slice_prio = std::numeric_limits<int>::min();
+  constexpr static int skip_slice_prio    = std::numeric_limits<int>::min();
+  constexpr static int default_slice_prio = 0;
 
   ran_slice_instance(ran_slice_id_t id_, const cell_configuration& cell_cfg_, const slice_rrm_policy_config& cfg_);
 
@@ -34,15 +35,15 @@ class ran_slice_instance
     if (not active() or pdsch_stopped or cfg.max_prb <= pdsch_rb_count) {
       return skip_slice_prio;
     }
-    return cfg.min_prb > pdsch_rb_count ? cfg.min_prb - pdsch_rb_count : 0;
+    return cfg.min_prb > pdsch_rb_count ? cfg.min_prb - pdsch_rb_count : default_slice_prio;
   }
 
   int get_ul_prio()
   {
     if (not active() or pusch_stopped or cfg.max_prb <= pusch_rb_count) {
       return skip_slice_prio;
     }
-    return cfg.min_prb > pusch_rb_count ? cfg.min_prb - pusch_rb_count : 0;
+    return cfg.min_prb > pusch_rb_count ? cfg.min_prb - pusch_rb_count : default_slice_prio;
   }
 
   /// Save PDSCH grant.
@@ -57,17 +58,19 @@ class ran_slice_instance
   /// Mark the allocation of PUSCH for this slice and the current slot as complete.
   void pusch_completed() { pusch_stopped = true; }
 
-  /// Determine if a UE is a candidate for this slice.
-  bool is_candidate(du_ue_index_t ue_idx) const { return bearers.contains(ue_idx); }
+  /// Determine if at least one bearer of the given UE is currently managed by this slice.
+  bool contains(du_ue_index_t ue_idx) const { return bearers.contains(ue_idx); }
 
-  /// Determine if a (UE, LCID) is a candidate for this slice.
-  bool is_candidate(du_ue_index_t ue_idx, lcid_t lcid) const
-  {
-    return is_candidate(ue_idx) and bearers[ue_idx].test(lcid);
-  }
+  /// Determine if a (UE, LCID) tuple are managed by this slice.
+  bool contains(du_ue_index_t ue_idx, lcid_t lcid) const { return contains(ue_idx) and bearers[ue_idx].test(lcid); }
 
-  void set_logical_channel(du_ue_index_t ue_idx, lcid_t lcid);
+  /// Add a new (UE, LCID) to the list of bearers managed by this slice.
+  void add_logical_channel(du_ue_index_t ue_idx, lcid_t lcid);
+
+  /// Remove a (UE, LCID) from the list of bearers managed by this slice.
   void rem_logical_channel(du_ue_index_t ue_idx, lcid_t lcid);
+
+  /// Remove a UE and all associated LCIDs from the list of bearers managed by this slice.
   void rem_ue(du_ue_index_t ue_idx);
 
   ran_slice_id_t            id;
@@ -88,4 +91,4 @@ class ran_slice_instance
   bool pusch_stopped = false;
 };
 
-} // namespace srsran
+} // namespace srsran

lib/scheduler/slicing/slice_scheduler.cpp

@@ -30,6 +30,7 @@ slice_scheduler::slice_scheduler(const cell_configuration& cell_cfg_, const slic
       create_scheduler_strategy(scheduler_strategy_params{"time_rr", &logger}, cell_cfg.expert_cfg.ue);
   sorted_dl_prios.emplace_back(id_count);
   sorted_ul_prios.emplace_back(id_count);
+  ++id_count;
   // Configured RRM policy members
   for (const slice_rrm_policy_config& rrm : cell_cfg.rrm_policy_members) {
     slices.emplace_back(id_count, cell_cfg, rrm);
@@ -64,7 +65,7 @@ void slice_scheduler::add_ue(du_ue_index_t ue_idx, const ue_configuration& ue_cf
 {
   for (const logical_channel_config& lc_cfg : ue_cfg.logical_channels()) {
     ran_slice_instance& sl_inst = get_slice(lc_cfg.rrm_policy);
-    sl_inst.set_logical_channel(ue_idx, lc_cfg.lcid);
+    sl_inst.add_logical_channel(ue_idx, lc_cfg.lcid);
   }
 }
 
@@ -81,7 +82,7 @@ void slice_scheduler::reconf_ue(du_ue_index_t           ue_idx,
   // Add new bearers.
   for (const logical_channel_config& lc_cfg : next_ue_cfg.logical_channels()) {
     ran_slice_instance& sl_inst = get_slice(lc_cfg.rrm_policy);
-    sl_inst.set_logical_channel(ue_idx, lc_cfg.lcid);
+    sl_inst.add_logical_channel(ue_idx, lc_cfg.lcid);
   }
 }
 

lib/scheduler/slicing/slice_scheduler.h

@@ -64,4 +64,4 @@ class slice_scheduler
   std::vector<slice_prio_context> sorted_ul_prios;
 };
 
-} // namespace srsran
+} // namespace srsran