cu-cp: rename cu-cp ue manager allocate_new_ue_index and add_ue methods for clarity

Author: frankist

include/srsran/cu_cp/ue_manager.h

@@ -106,6 +106,9 @@ class common_ue_manager
   /// \param[in] c_rnti The RNTI of the UE.
   virtual ue_index_t get_ue_index(pci_t pci, rnti_t c_rnti) = 0;
 
+  /// \brief Allocate and return the UE index of a new UE.
+  virtual ue_index_t add_ue(du_index_t du_index) = 0;
+
   /// \brief Remove the UE context with the given UE index.
   /// \param[in] ue_index Index of the UE to be removed.
   virtual void remove_ue(ue_index_t ue_index) = 0;
@@ -121,9 +124,6 @@ class du_processor_ue_manager : public common_ue_manager
 public:
   virtual ~du_processor_ue_manager() = default;
 
-  /// \brief Allocate and return the UE index of a new UE.
-  virtual ue_index_t allocate_new_ue_index(du_index_t du_index) = 0;
-
   /// \brief Find the UE with the given UE index. Note that this will not check if a DU context exists.
   /// \param[in] ue_index Index of the UE to be found.
   /// \return Pointer to the UE if found, nullptr otherwise.
@@ -136,7 +136,7 @@ class du_processor_ue_manager : public common_ue_manager
   /// \param[in] pci PCI of the cell that the UE is connected to.
   /// \param[in] rnti RNTI of the UE to be added.
   /// \return Pointer to the newly added DU UE if successful, nullptr otherwise.
-  virtual du_ue* add_ue(ue_index_t ue_index, gnb_du_id_t du_id, pci_t pci, rnti_t rnti) = 0;
+  virtual du_ue* set_ue_du_context(ue_index_t ue_index, gnb_du_id_t du_id, pci_t pci, rnti_t rnti) = 0;
 
   /// \brief Find the DU UE with the given UE index.
   /// \param[in] ue_index Index of the UE to be found.
@@ -177,10 +177,10 @@ class ngap_ue_manager : public common_ue_manager
   /// \param[in] rrc_ue_ctrl_notifier RRC UE control notifier for the UE.
   /// \param[in] du_processor_ctrl_notifier DU processor control notifier for the UE.
   /// \return Pointer to the NGAP UE if found, nullptr otherwise.
-  virtual ngap_ue* add_ue(ue_index_t                          ue_index,
-                          ngap_rrc_ue_pdu_notifier&           rrc_ue_pdu_notifier,
-                          ngap_rrc_ue_control_notifier&       rrc_ue_ctrl_notifier,
-                          ngap_du_processor_control_notifier& du_processor_ctrl_notifier) = 0;
+  virtual ngap_ue* set_ue_ng_context(ue_index_t                          ue_index,
+                                     ngap_rrc_ue_pdu_notifier&           rrc_ue_pdu_notifier,
+                                     ngap_rrc_ue_control_notifier&       rrc_ue_ctrl_notifier,
+                                     ngap_du_processor_control_notifier& du_processor_ctrl_notifier) = 0;
 
   /// \brief Find the NGAP UE with the given UE index.
   /// \param[in] ue_index Index of the UE to be found.

lib/cu_cp/cu_cp_impl.cpp

@@ -340,10 +340,10 @@ bool cu_cp_impl::handle_new_ngap_ue(ue_index_t ue_index)
     return false;
   }
 
-  return ue_mng.add_ue(ue_index,
-                       ue_mng.get_ngap_rrc_ue_adapter(ue_index),
-                       ue_mng.get_ngap_rrc_ue_adapter(ue_index),
-                       ngap_du_processor_ctrl_notifiers.at(get_du_index_from_ue_index(ue_index)));
+  return ue_mng.set_ue_ng_context(ue_index,
+                                  ue_mng.get_ngap_rrc_ue_adapter(ue_index),
+                                  ue_mng.get_ngap_rrc_ue_adapter(ue_index),
+                                  ngap_du_processor_ctrl_notifiers.at(get_du_index_from_ue_index(ue_index)));
 }
 
 void cu_cp_impl::on_statistics_report_timer_expired()

lib/cu_cp/du_processor/du_processor_impl.cpp

@@ -174,7 +174,7 @@ du_setup_result du_processor_impl::handle_du_setup_request(const du_setup_reques
 
 ue_index_t du_processor_impl::allocate_new_ue_index()
 {
-  return ue_manager.allocate_new_ue_index(context.du_index);
+  return ue_manager.add_ue(context.du_index);
 }
 
 du_cell_index_t du_processor_impl::find_cell(uint64_t packed_nr_cell_id)
@@ -270,7 +270,7 @@ cu_cp_ue_creation_response du_processor_impl::handle_ue_creation_request(const c
   }
 
   // Create new UE context
-  du_ue* ue = ue_manager.add_ue(ue_index, context.id, pci, msg.c_rnti);
+  du_ue* ue = ue_manager.set_ue_du_context(ue_index, context.id, pci, msg.c_rnti);
   if (ue == nullptr) {
     logger.warning("ue={}: Could not create UE context", ue_index);
     return {};

lib/cu_cp/routines/mobility/inter_du_handover_routine.cpp

@@ -86,7 +86,7 @@ void inter_du_handover_routine::operator()(coro_context<async_task<cu_cp_inter_d
 
   {
     // Allocate UE index at target DU
-    target_ue_context_setup_request.ue_index = ue_manager.allocate_new_ue_index(command.target_du_index);
+    target_ue_context_setup_request.ue_index = ue_manager.add_ue(command.target_du_index);
     if (target_ue_context_setup_request.ue_index == ue_index_t::invalid) {
       logger.warning("ue={}: \"{}\" failed to allocate UE index at target DU", command.source_ue_index, name());
       CORO_EARLY_RETURN(response_msg);

lib/cu_cp/ue_manager/ue_manager_impl.cpp

@@ -75,15 +75,17 @@ void ue_manager::remove_ue(ue_index_t ue_index)
 
 // du_processor_ue_manager
 
-ue_index_t ue_manager::allocate_new_ue_index(du_index_t du_index)
+ue_index_t ue_manager::add_ue(du_index_t du_index)
 {
   if (ues.size() == ue_config.max_nof_supported_ues) {
+    logger.warning("CU-CP UE creation Failed. Cause: Maximum number of UEs {} supported by the CU-CP has been reached",
+                   ue_config.max_nof_supported_ues);
     return ue_index_t::invalid;
   }
 
   ue_index_t new_ue_index = get_next_ue_index(du_index);
   if (new_ue_index == ue_index_t::invalid) {
-    logger.warning("No free UE index available");
+    logger.warning("CU-CP UE creation Failed. Cause: No free UE index available");
     return ue_index_t::invalid;
   }
 
@@ -95,7 +97,7 @@ ue_index_t ue_manager::allocate_new_ue_index(du_index_t du_index)
               std::forward_as_tuple(new_ue_index),
               std::forward_as_tuple(new_ue_index, up_config, std::move(ue_sched)));
 
-  logger.debug("ue={}: Allocated new UE index", new_ue_index);
+  logger.info("ue={}: Created new CU-CP UE", new_ue_index);
 
   return new_ue_index;
 }
@@ -108,7 +110,7 @@ du_ue* ue_manager::find_ue(ue_index_t ue_index)
   return nullptr;
 }
 
-du_ue* ue_manager::add_ue(ue_index_t ue_index, gnb_du_id_t du_id, pci_t pci, rnti_t rnti)
+du_ue* ue_manager::set_ue_du_context(ue_index_t ue_index, gnb_du_id_t du_id, pci_t pci, rnti_t rnti)
 {
   srsran_assert(ue_index != ue_index_t::invalid, "Invalid ue_index={}", ue_index);
   srsran_assert(pci != INVALID_PCI, "Invalid pci={}", pci);
@@ -147,10 +149,10 @@ du_ue* ue_manager::find_du_ue(ue_index_t ue_index)
 
 // ngap_ue_manager
 
-ngap_ue* ue_manager::add_ue(ue_index_t                          ue_index,
-                            ngap_rrc_ue_pdu_notifier&           rrc_ue_pdu_notifier_,
-                            ngap_rrc_ue_control_notifier&       rrc_ue_ctrl_notifier_,
-                            ngap_du_processor_control_notifier& du_processor_ctrl_notifier_)
+ngap_ue* ue_manager::set_ue_ng_context(ue_index_t                          ue_index,
+                                       ngap_rrc_ue_pdu_notifier&           rrc_ue_pdu_notifier_,
+                                       ngap_rrc_ue_control_notifier&       rrc_ue_ctrl_notifier_,
+                                       ngap_du_processor_control_notifier& du_processor_ctrl_notifier_)
 {
   srsran_assert(ue_index != ue_index_t::invalid, "Invalid ue_index={}", ue_index);
 

lib/cu_cp/ue_manager/ue_manager_impl.h

@@ -251,15 +251,17 @@ class ue_manager : public du_processor_ue_manager, public ngap_ue_manager, publi
 
   // du_processor_ue_manager
 
-  /// \brief Allocate and return the UE index of a new UE.
-  ue_index_t allocate_new_ue_index(du_index_t du_index) override;
+  /// \brief Allocate resources for the UE in the CU-CP.
+  ///
+  /// \return ue_index of the created UE or ue_index_t::invalid in case of failure.
+  ue_index_t add_ue(du_index_t du_index) override;
 
   /// \brief Find the UE with the given UE index. Note that this will not check if a DU context exists.
   /// \param[in] ue_index Index of the UE to be found.
   /// \return Pointer to the UE if found, nullptr otherwise.
   du_ue* find_ue(ue_index_t ue_index) override;
 
-  du_ue* add_ue(ue_index_t ue_index, gnb_du_id_t du_id, pci_t pci, rnti_t rnti) override;
+  du_ue* set_ue_du_context(ue_index_t ue_index, gnb_du_id_t du_id, pci_t pci, rnti_t rnti) override;
 
   /// \brief Find the UE with the given UE index, thats DU context is set up.
   /// \param[in] ue_index Index of the UE to be found.
@@ -290,10 +292,10 @@ class ue_manager : public du_processor_ue_manager, public ngap_ue_manager, publi
   /// \param[in] rrc_ue_ctrl_notifier RRC UE control notifier for the UE.
   /// \param[in] du_processor_ctrl_notifier DU processor control notifier for the UE.
   /// \return Pointer to the NGAP UE if found, nullptr otherwise.
-  ngap_ue* add_ue(ue_index_t                          ue_index,
-                  ngap_rrc_ue_pdu_notifier&           rrc_ue_pdu_notifier_,
-                  ngap_rrc_ue_control_notifier&       rrc_ue_ctrl_notifier_,
-                  ngap_du_processor_control_notifier& du_processor_ctrl_notifier_) override;
+  ngap_ue* set_ue_ng_context(ue_index_t                          ue_index,
+                             ngap_rrc_ue_pdu_notifier&           rrc_ue_pdu_notifier_,
+                             ngap_rrc_ue_control_notifier&       rrc_ue_ctrl_notifier_,
+                             ngap_du_processor_control_notifier& du_processor_ctrl_notifier_) override;
 
   /// \brief Find the NGAP UE with the given UE index.
   /// \param[in] ue_index Index of the UE to be found.

tests/unittests/cu_cp/du_processor/ue_context_release_routine_test.cpp

@@ -32,8 +32,8 @@ class ue_context_release_test : public du_processor_routine_manager_test
 
   ue_index_t add_ue(pci_t pci, rnti_t c_rnti)
   {
-    ue_index_t ue_index = ue_mng.allocate_new_ue_index(du_index_t::min);
-    du_ue*     ue       = ue_mng.add_ue(ue_index, int_to_gnb_du_id(0), pci, c_rnti);
+    ue_index_t ue_index = ue_mng.add_ue(du_index_t::min);
+    du_ue*     ue       = ue_mng.set_ue_du_context(ue_index, int_to_gnb_du_id(0), pci, c_rnti);
     // Set parameters from creation message
     ue->set_pcell_index(du_cell_index_t::min);
     ue->set_rrc_ue_notifier(rrc_ue_ctrl_notifier);

tests/unittests/cu_cp/mobility/handover_reconfiguration_routine_test.cpp

@@ -25,14 +25,14 @@ class handover_reconfiguration_routine_test : public mobility_test
 
   void create_ues(bool procedure_outcome, unsigned transaction_id_)
   {
-    ue_index_t source_ue_index = get_ue_manager()->allocate_new_ue_index(source_du_index);
-    source_ue = get_ue_manager()->add_ue(source_ue_index, int_to_gnb_du_id(0), source_pci, source_rnti);
+    ue_index_t source_ue_index = get_ue_manager()->add_ue(source_du_index);
+    source_ue = get_ue_manager()->set_ue_du_context(source_ue_index, int_to_gnb_du_id(0), source_pci, source_rnti);
     ASSERT_NE(source_ue, nullptr);
     source_rrc_ue_notifier.set_transaction_id(transaction_id_);
     source_ue->set_rrc_ue_notifier(source_rrc_ue_notifier);
 
-    ue_index_t target_ue_index = get_ue_manager()->allocate_new_ue_index(target_du_index);
-    target_ue = get_ue_manager()->add_ue(target_ue_index, int_to_gnb_du_id(0), target_pci, target_rnti);
+    ue_index_t target_ue_index = get_ue_manager()->add_ue(target_du_index);
+    target_ue = get_ue_manager()->set_ue_du_context(target_ue_index, int_to_gnb_du_id(0), target_pci, target_rnti);
     ASSERT_NE(target_ue, nullptr);
     target_rrc_ue_notifier.set_rrc_reconfiguration_outcome(procedure_outcome);
     target_ue->set_rrc_ue_notifier(target_rrc_ue_notifier);