cu: Enhance common type cause

Author: FabianEckermann

include/srsran/cu_cp/cu_cp_types.h

@@ -279,7 +279,7 @@ struct cu_cp_associated_qos_flow {
 };
 struct cu_cp_qos_flow_with_cause_item {
   qos_flow_id_t qos_flow_id = qos_flow_id_t::invalid;
-  cause_t       cause       = cause_t::nulltype;
+  cause_t       cause;
 };
 
 using cu_cp_qos_flow_failed_to_setup_item = cu_cp_qos_flow_with_cause_item;
@@ -303,7 +303,7 @@ struct cu_cp_pdu_session_res_setup_response_item {
 };
 
 struct cu_cp_pdu_session_resource_setup_unsuccessful_transfer {
-  cause_t                      cause = cause_t::nulltype;
+  cause_t                      cause;
   optional<crit_diagnostics_t> crit_diagnostics;
 };
 
@@ -319,7 +319,7 @@ struct cu_cp_pdu_session_resource_setup_response {
 };
 
 struct cu_cp_pdu_session_res_release_cmd_transfer {
-  cause_t cause = cause_t::nulltype;
+  cause_t cause;
 };
 
 struct cu_cp_pdu_session_res_to_release_item_rel_cmd {
@@ -431,13 +431,13 @@ struct cu_cp_pdu_session_resource_modify_response {
 
 struct cu_cp_ngap_ue_context_release_command {
   ue_index_t ue_index = ue_index_t::invalid;
-  cause_t    cause    = cause_t::nulltype;
+  cause_t    cause;
 };
 
 struct cu_cp_ue_context_release_request {
   ue_index_t                    ue_index = ue_index_t::invalid;
   std::vector<pdu_session_id_t> pdu_session_res_list_cxt_rel_req;
-  cause_t                       cause = cause_t::nulltype;
+  cause_t                       cause;
 };
 
 struct cu_cp_recommended_cell_item {

include/srsran/ngap/ngap_handover.h

@@ -150,7 +150,7 @@ struct ngap_handover_resource_allocation_response {
   ngap_target_ngran_node_to_source_ngran_node_transparent_container target_to_source_transparent_container;
 
   // handover request failure
-  cause_t cause = cause_t::nulltype;
+  cause_t cause;
 
   // common
   optional<crit_diagnostics_t> crit_diagnostics;

include/srsran/ran/cause.h

@@ -10,16 +10,81 @@
 
 #pragma once
 
+#include "srsran/adt/variant.h"
+
 namespace srsran {
 
-enum class cause_t : uint8_t {
-  radio_network = 0,
-  transport     = 1,
-  nas           = 2,
-  protocol      = 3,
-  misc          = 4,
-  choice_exts   = 5,
-  nulltype      = 6
+enum class cause_radio_network_t : uint8_t {
+  unspecified = 0,
+  txnrelocoverall_expiry,
+  successful_ho,
+  release_due_to_ngran_generated_reason,
+  release_due_to_5gc_generated_reason,
+  ho_cancelled,
+  partial_ho,
+  ho_fail_in_target_5_gc_ngran_node_or_target_sys,
+  ho_target_not_allowed,
+  tngrelocoverall_expiry,
+  tngrelocprep_expiry,
+  cell_not_available,
+  unknown_target_id,
+  no_radio_res_available_in_target_cell,
+  unknown_local_ue_ngap_id,
+  inconsistent_remote_ue_ngap_id,
+  ho_desirable_for_radio_reason,
+  time_crit_ho,
+  res_optim_ho,
+  reduce_load_in_serving_cell,
+  user_inactivity,
+  radio_conn_with_ue_lost,
+  radio_res_not_available,
+  invalid_qos_combination,
+  fail_in_radio_interface_proc,
+  interaction_with_other_proc,
+  unknown_pdu_session_id,
+  unkown_qos_flow_id,
+  multiple_pdu_session_id_instances,
+  multiple_qos_flow_id_instances,
+  encryption_and_or_integrity_protection_algorithms_not_supported,
+  ng_intra_sys_ho_triggered,
+  ng_inter_sys_ho_triggered,
+  xn_ho_triggered,
+  not_supported_5qi_value,
+  ue_context_transfer,
+  ims_voice_eps_fallback_or_rat_fallback_triggered,
+  up_integrity_protection_not_possible,
+  up_confidentiality_protection_not_possible,
+  slice_not_supported,
+  ue_in_rrc_inactive_state_not_reachable,
+  redirection,
+  res_not_available_for_the_slice,
+  ue_max_integrity_protected_data_rate_reason,
+  release_due_to_cn_detected_mob
+};
+
+enum class cause_transport_t : uint8_t { transport_res_unavailable = 0, unspecified };
+
+enum class cause_nas_t : uint8_t { normal_release = 0, authentication_fail, deregister, unspecified };
+
+enum class cause_protocol_t : uint8_t {
+  transfer_syntax_error = 0,
+  abstract_syntax_error_reject,
+  abstract_syntax_error_ignore_and_notify,
+  msg_not_compatible_with_receiver_state,
+  semantic_error,
+  abstract_syntax_error_falsely_constructed_msg,
+  unspecified
+};
+
+enum class cause_misc_t : uint8_t {
+  ctrl_processing_overload = 0,
+  not_enough_user_plane_processing_res,
+  hardware_fail,
+  om_intervention,
+  unknown_plmn_or_sn_pn,
+  unspecified
 };
 
+using cause_t = variant<cause_radio_network_t, cause_transport_t, cause_nas_t, cause_protocol_t, cause_misc_t>;
+
 } // namespace srsran

include/srsran/rrc/rrc_ue.h

@@ -143,7 +143,7 @@ class rrc_ue_reestablishment_proc_notifier
 
 struct rrc_ue_context_release_command {
   ue_index_t         ue_index = ue_index_t::invalid;
-  cause_t            cause    = cause_t::nulltype;
+  cause_t            cause;
   byte_buffer        rrc_release_pdu;
   optional<srb_id_t> srb_id;
 };

lib/cu_cp/du_processor/du_processor_impl.cpp

@@ -77,7 +77,7 @@ void du_processor_impl::handle_f1_setup_request(const f1ap_f1_setup_request& req
   // Reject request without served cells
   if (request.gnb_du_served_cells_list.size() == 0) {
     logger.error("Not handling F1 setup without served cells");
-    send_f1_setup_failure(cause_t::radio_network);
+    send_f1_setup_failure(cause_radio_network_t::unspecified);
     return;
   }
 
@@ -90,7 +90,7 @@ void du_processor_impl::handle_f1_setup_request(const f1ap_f1_setup_request& req
   // Forward serving cell list to RRC DU
   // TODO: How to handle missing optional freq and timing in meas timing config?
   if (!rrc_du_adapter.on_new_served_cell_list(request.gnb_du_served_cells_list)) {
-    send_f1_setup_failure(cause_t::protocol);
+    send_f1_setup_failure(cause_protocol_t::unspecified);
     return;
   }
 
@@ -101,35 +101,35 @@ void du_processor_impl::handle_f1_setup_request(const f1ap_f1_setup_request& req
 
     if (du_cell.cell_index == du_cell_index_t::invalid) {
       logger.error("Not handling F1 setup, maximum number of DU cells reached");
-      send_f1_setup_failure(cause_t::radio_network);
+      send_f1_setup_failure(cause_radio_network_t::unspecified);
       return;
     }
 
     du_cell.cgi = served_cell.served_cell_info.nr_cgi;
     if (not srsran::config_helpers::is_valid(du_cell.cgi)) {
       logger.error("Not handling F1 setup, invalid CGI for cell {}", du_cell.cell_index);
-      send_f1_setup_failure(cause_t::radio_network);
+      send_f1_setup_failure(cause_radio_network_t::unspecified);
       return;
     }
 
     du_cell.pci = served_cell.served_cell_info.nr_pci;
     if (not srsran::config_helpers::is_valid(du_cell.pci)) {
       logger.error("Not handling F1 setup, invalid PCI for cell {}", du_cell.pci);
-      send_f1_setup_failure(cause_t::radio_network);
+      send_f1_setup_failure(cause_radio_network_t::unspecified);
       return;
     }
 
     if (not served_cell.served_cell_info.five_gs_tac.has_value()) {
       logger.error("Not handling F1 setup, missing TAC for cell {}", du_cell.cell_index);
-      send_f1_setup_failure(cause_t::radio_network);
+      send_f1_setup_failure(cause_radio_network_t::unspecified);
       return;
     } else {
       du_cell.tac = served_cell.served_cell_info.five_gs_tac.value();
     }
 
     if (not served_cell.gnb_du_sys_info.has_value()) {
       logger.error("Not handling served cells without system information");
-      send_f1_setup_failure(cause_t::radio_network);
+      send_f1_setup_failure(cause_radio_network_t::unspecified);
       return;
     } else {
       // Store and unpack system information
@@ -539,7 +539,7 @@ void du_processor_impl::handle_inactivity_notification(const cu_cp_inactivity_no
   if (msg.ue_inactive) {
     cu_cp_ue_context_release_request req;
     req.ue_index = msg.ue_index;
-    req.cause    = cause_t::radio_network;
+    req.cause    = cause_radio_network_t::unspecified;
 
     // Add PDU Session IDs
     auto& up_resource_manager            = ue->get_up_resource_manager();

lib/cu_cp/routines/mobility/inter_cu_handover_target_routine.cpp

@@ -11,6 +11,7 @@
 #include "inter_cu_handover_target_routine.h"
 #include "../pdu_session_routine_helpers.h"
 #include "srsran/ngap/ngap_handover.h"
+#include "srsran/ran/cause.h"
 
 using namespace srsran;
 using namespace srs_cu_cp;
@@ -338,7 +339,7 @@ inter_cu_handover_target_routine::generate_handover_resource_allocation_response
 
       // ngap_ho_res_alloc_unsuccessful_transfer
       // cause
-      failed_item.unsuccessful_transfer.cause = cause_t::protocol;
+      failed_item.unsuccessful_transfer.cause = cause_protocol_t::unspecified;
 
       response.pdu_session_res_failed_to_setup_list_ho_ack.emplace(failed_item.pdu_session_id, failed_item);
     }
@@ -347,7 +348,7 @@ inter_cu_handover_target_routine::generate_handover_resource_allocation_response
   } else {
     response.success  = false;
     response.ue_index = request.ue_index;
-    response.cause    = cause_t::protocol;
+    response.cause    = cause_protocol_t::unspecified;
   }
 
   return response;

lib/cu_cp/routines/mobility/inter_du_handover_routine.cpp

@@ -109,7 +109,7 @@ void inter_du_handover_routine::operator()(coro_context<async_task<cu_cp_inter_d
 
       {
         ue_context_release_cmd.ue_index = target_ue_context_setup_response.ue_index;
-        ue_context_release_cmd.cause    = cause_t::radio_network;
+        ue_context_release_cmd.cause    = cause_radio_network_t::unspecified;
         CORO_AWAIT_VALUE(ue_context_release_result,
                          target_du_f1ap_ue_ctxt_notifier.on_ue_context_release_command(ue_context_release_cmd));
 
@@ -155,7 +155,7 @@ void inter_du_handover_routine::operator()(coro_context<async_task<cu_cp_inter_d
   // Remove UE context in source DU.
   {
     ue_context_release_cmd.ue_index = source_ue->get_ue_index();
-    ue_context_release_cmd.cause    = cause_t::radio_network;
+    ue_context_release_cmd.cause    = cause_radio_network_t::unspecified;
     CORO_AWAIT_VALUE(ue_context_release_result,
                      source_du_f1ap_ue_ctxt_notifier.on_ue_context_release_command(ue_context_release_cmd));
 

lib/cu_cp/routines/pdu_session_resource_modification_routine.cpp

@@ -135,7 +135,7 @@ void fill_modify_failed_list(cu_cp_pdu_session_resource_modify_response&      re
   for (const auto& item : modify_request.pdu_session_res_modify_items) {
     cu_cp_pdu_session_resource_failed_to_modify_item failed_item;
     failed_item.pdu_session_id              = item.pdu_session_id;
-    failed_item.unsuccessful_transfer.cause = cause_t::misc;
+    failed_item.unsuccessful_transfer.cause = cause_misc_t::unspecified;
     response_msg.pdu_session_res_failed_to_modify_list.emplace(failed_item.pdu_session_id, failed_item);
   }
 }
@@ -272,7 +272,7 @@ void mark_all_sessions_as_failed(cu_cp_pdu_session_resource_modify_response&
   for (const auto& modify_item : modify_request.pdu_session_res_modify_items) {
     cu_cp_pdu_session_resource_failed_to_modify_item failed_item;
     failed_item.pdu_session_id              = modify_item.pdu_session_id;
-    failed_item.unsuccessful_transfer.cause = cause_t::radio_network;
+    failed_item.unsuccessful_transfer.cause = cause_radio_network_t::unspecified;
     response_msg.pdu_session_res_failed_to_modify_list.emplace(failed_item.pdu_session_id, failed_item);
   }
 }
@@ -293,7 +293,7 @@ pdu_session_resource_modification_routine::generate_pdu_session_resource_modify_
     for (const auto& psi : next_config.pdu_sessions_failed_to_modify_list) {
       cu_cp_pdu_session_resource_failed_to_modify_item failed_item;
       failed_item.pdu_session_id              = psi;
-      failed_item.unsuccessful_transfer.cause = cause_t::radio_network;
+      failed_item.unsuccessful_transfer.cause = cause_radio_network_t::unspecified;
       response_msg.pdu_session_res_failed_to_modify_list.emplace(failed_item.pdu_session_id, failed_item);
     }
   } else {

lib/cu_cp/routines/pdu_session_resource_release_routine.cpp

@@ -71,7 +71,7 @@ void pdu_session_resource_release_routine::operator()(
   if (next_config.context_removal_required) {
     // Remove bearer context.
     bearer_context_release_command.ue_index = release_cmd.ue_index;
-    bearer_context_release_command.cause    = cause_t::radio_network;
+    bearer_context_release_command.cause    = cause_radio_network_t::unspecified;
 
     CORO_AWAIT(e1ap_ctrl_notifier.on_bearer_context_release_command(bearer_context_release_command));
 
@@ -108,7 +108,7 @@ async_task<void> pdu_session_resource_release_routine::request_context_release()
 
     cu_cp_ue_context_release_request ue_context_release_request;
     ue_context_release_request.ue_index = release_cmd.ue_index;
-    ue_context_release_request.cause    = cause_t::radio_network;
+    ue_context_release_request.cause    = cause_radio_network_t::unknown_pdu_session_id;
     ngap_ctrl_notifier.on_ue_context_release_request(ue_context_release_request);
 
     CORO_RETURN();

lib/cu_cp/routines/pdu_session_resource_setup_routine.cpp

@@ -301,7 +301,7 @@ void fill_setup_failed_list(cu_cp_pdu_session_resource_setup_response&      resp
   for (const auto& item : setup_msg.pdu_session_res_setup_items) {
     cu_cp_pdu_session_res_setup_failed_item failed_item;
     failed_item.pdu_session_id              = item.pdu_session_id;
-    failed_item.unsuccessful_transfer.cause = cause_t::misc;
+    failed_item.unsuccessful_transfer.cause = cause_misc_t::unspecified;
     response_msg.pdu_session_res_failed_to_setup_items.emplace(failed_item.pdu_session_id, failed_item);
   }
 }
@@ -383,7 +383,7 @@ pdu_session_resource_setup_routine::handle_pdu_session_resource_setup_result(boo
   } else {
     logger.error("ue={}: \"{}\" failed.", setup_msg.ue_index, name());
 
-    mark_all_sessions_as_failed(response_msg, setup_msg, cause_t::radio_network);
+    mark_all_sessions_as_failed(response_msg, setup_msg, cause_radio_network_t::unspecified);
   }
 
   return response_msg;