fix(agw): Modified code to port s1ap_state_t structure to protobuf structure,S1apState

Signed-off-by: Rashmi <[email protected]>

Author: rsarwad

lte/gateway/c/core/oai/include/proto_map.hpp

@@ -293,6 +293,35 @@ struct proto_map_s {
     }
     return PROTO_MAP_DUMP_FAIL;
   }
+
+  /***************************************************************************
+  **                                                                        **
+  ** Name:    update_val()                                                  **
+  **                                                                        **
+  ** Description: Takes key and valueP as parameters.If the key exists,     **
+  **              updates the value corresponding to key                    **
+  **              else returns error.                                       **
+  **                                                                        **
+  ***************************************************************************/
+
+  proto_map_rc_t update_val(const keyT key, valueT* valueP) {
+    if (!map) {
+      return PROTO_MAP_NOT_CREATED;
+    }
+    if (map->empty()) {
+      return PROTO_MAP_EMPTY;
+    }
+    if (valueP == nullptr) {
+      return PROTO_MAP_BAD_PARAMETER_VALUE;
+    }
+    auto search_result = map->find(key);
+    if (search_result != map->end()) {
+      (*map)[key] = *valueP;
+      return PROTO_MAP_OK;
+    } else {
+      return PROTO_MAP_KEY_NOT_EXISTS;
+    }
+  }
 };
 
 // Map- Key: uint64_t, Data: uint64_t

lte/gateway/c/core/oai/include/s1ap_state.hpp

@@ -38,14 +38,14 @@ oai::S1apState* get_s1ap_state(bool read_from_db);
 
 void put_s1ap_state(void);
 
-magma::lte::oai::EnbDescription* s1ap_state_get_enb(oai::S1apState* state,
-                                                    sctp_assoc_id_t assoc_id);
+proto_map_rc_t s1ap_state_get_enb(oai::S1apState* state,
+                                  sctp_assoc_id_t assoc_id,
+                                  oai::EnbDescription* enb);
 
-oai::UeDescription* s1ap_state_get_ue_enbid(
-    sctp_assoc_id_t sctp_assoc_id, enb_ue_s1ap_id_t enb_ue_s1ap_id);
+oai::UeDescription* s1ap_state_get_ue_enbid(sctp_assoc_id_t sctp_assoc_id,
+                                            enb_ue_s1ap_id_t enb_ue_s1ap_id);
 
-oai::UeDescription* s1ap_state_get_ue_mmeid(
-    mme_ue_s1ap_id_t mme_ue_s1ap_id);
+oai::UeDescription* s1ap_state_get_ue_mmeid(mme_ue_s1ap_id_t mme_ue_s1ap_id);
 
 oai::UeDescription* s1ap_state_get_ue_imsi(imsi64_t imsi64);
 
@@ -83,13 +83,17 @@ bool s1ap_ue_compare_by_mme_ue_id_cb(__attribute__((unused)) uint64_t keyP,
                                      void* parameterP, void** resultP);
 
 bool s1ap_ue_compare_by_imsi(__attribute__((unused)) uint64_t keyP,
-                             oai::UeDescription* elementP,
-                             void* parameterP, void** resultP);
+                             oai::UeDescription* elementP, void* parameterP,
+                             void** resultP);
 
 void remove_ues_without_imsi_from_ue_id_coll(void);
 
-void clean_stale_enb_state(
-    oai::S1apState* state, oai::EnbDescription* new_enb_association);
+void clean_stale_enb_state(oai::S1apState* state,
+                           oai::EnbDescription* new_enb_association);
+
+proto_map_rc_t s1ap_state_update_enb_map(oai::S1apState* state,
+                                         sctp_assoc_id_t assoc_id,
+                                         oai::EnbDescription* enb);
 
 }  // namespace lte
 }  // namespace magma

lte/gateway/c/core/oai/include/s1ap_types.hpp

@@ -36,18 +36,9 @@ extern "C" {
 #define S1AP_TIMER_INACTIVE_ID (-1)
 #define S1AP_UE_CONTEXT_REL_COMP_TIMER 1  // in seconds
 
-// Map- Key: uint32_t , Data: enb_description_t*
-typedef magma::proto_map_s<uint32_t, magma::lte::oai::EnbDescription*>
-    map_uint32_enb_description_t;
-
-typedef struct s1ap_state_s {
-  // key:sctp_assoc_id, value: pointer to eNB_description_s
-  map_uint32_enb_description_t enbs;
-  // contains sctp association id, key is mme_ue_s1ap_id
-  magma::proto_map_uint32_uint32_t mmeid2associd;
-
-  uint32_t num_enbs;
-} s1ap_state_t;
+// Map- Key: uint32_t , Data: EnbDescription
+typedef magma::proto_map_s<uint32_t, magma::lte::oai::EnbDescription>
+    proto_map_uint32_enb_description_t;
 
 typedef struct s1ap_imsi_map_s {
   magma::proto_map_uint32_uint64_t mme_ueid2imsi_map;

lte/gateway/c/core/oai/tasks/grpc_service/S1apServiceImpl.cpp

@@ -46,16 +46,16 @@ Status S1apServiceImpl::GetENBState(ServerContext* context, const Void* request,
   // it will not affect ownership
   oai::S1apState* s1ap_state = get_s1ap_state(false);
   if (s1ap_state != nullptr) {
-    if (!(s1ap_state->enbs.size())) {
+    if (!(s1ap_state->enbs_size())) {
       return Status::OK;
     }
-
-    for (auto itr = s1ap_state->enbs.map->begin();
-         itr != s1ap_state->enbs.map->end(); itr++) {
-      EnbDescription* enb_ref = itr->second;
-      if (enb_ref) {
-        (*response->mutable_enb_state_map())[enb_ref->enb_id()] =
-            enb_ref->nb_ue_associated();
+    proto_map_uint32_enb_description_t enb_map;
+    enb_map.map = s1ap_state->mutable_enbs();
+    for (auto itr = enb_map.map->begin(); itr != enb_map.map->end(); itr++) {
+      EnbDescription enb_ref = itr->second;
+      if (enb_ref.sctp_assoc_id()) {
+        (*response->mutable_enb_state_map())[enb_ref.enb_id()] =
+            enb_ref.nb_ue_associated();
       }
     }
   }

lte/gateway/c/core/oai/tasks/ha/ha_service_handler.cpp

@@ -73,7 +73,7 @@ bool sync_up_with_orc8r(void) {
 }
 
 typedef struct callback_data_s {
-  S1apState* s1ap_state;
+  magma::lte::oai::S1apState* s1ap_state;
   ha_agw_offload_req_t* request;
 } callback_data_t;
 
@@ -94,24 +94,26 @@ bool trigger_agw_offload_for_ue(const hash_key_t keyP, void* const elementP,
   callback_data_t* callback_data = (callback_data_t*)parameterP;
   ha_agw_offload_req_t* offload_request =
       (ha_agw_offload_req_t*)callback_data->request;
-  S1apState* s1ap_state = (S1apState*)callback_data->s1ap_state;
+  magma::lte::oai::S1apState* s1ap_state =
+      (magma::lte::oai::S1apState*)callback_data->s1ap_state;
   struct ue_mm_context_s* ue_context_p = (struct ue_mm_context_s*)elementP;
   bool any_flag = false;  // true if we tried offloading any UE
 
   IMSI_STRING_TO_IMSI64(offload_request->imsi, &imsi64);
 
-  EnbDescription* enb_ref_p = magma::lte::s1ap_state_get_enb(
-      s1ap_state, ue_context_p->sctp_assoc_id_key);
+  magma::lte::oai::EnbDescription enb_ref_p;
+  magma::proto_map_rc_t rc = magma::lte::s1ap_state_get_enb(
+      s1ap_state, ue_context_p->sctp_assoc_id_key, &enb_ref_p);
 
-  if (!enb_ref_p) {
+  if (rc != magma::PROTO_MAP_OK) {
     OAILOG_ERROR_UE(LOG_UTIL, imsi64,
                     "Failed to find enb_ref_p for assoc_id :%u",
                     ue_context_p->sctp_assoc_id_key);
     return false;
   }
   // Return if this UE does not satisfy any of the filtering criteria
   if ((imsi64 != ue_context_p->emm_context._imsi64) &&
-      (offload_request->eNB_id != enb_ref_p->enb_id())) {
+      (offload_request->eNB_id != enb_ref_p.enb_id())) {
     return false;
   }
 
@@ -128,7 +130,7 @@ bool trigger_agw_offload_for_ue(const hash_key_t keyP, void* const elementP,
         ue_context_p->mme_ue_s1ap_id;
     S1AP_UE_CONTEXT_RELEASE_REQ(message_p).enb_ue_s1ap_id =
         ue_context_p->enb_ue_s1ap_id;
-    S1AP_UE_CONTEXT_RELEASE_REQ(message_p).enb_id = enb_ref_p->enb_id();
+    S1AP_UE_CONTEXT_RELEASE_REQ(message_p).enb_id = enb_ref_p.enb_id();
     S1AP_UE_CONTEXT_RELEASE_REQ(message_p).relCause = S1AP_NAS_MME_OFFLOADING;
 
     OAILOG_INFO(
@@ -141,7 +143,7 @@ bool trigger_agw_offload_for_ue(const hash_key_t keyP, void* const elementP,
         ue_context_p->emm_context._imsi64, offload_request->imsi,
         ue_context_p->mme_ue_s1ap_id, ue_context_p->enb_ue_s1ap_id,
         ue_context_p->e_utran_cgi.cell_identity.enb_id,
-        ue_context_p->e_utran_cgi.cell_identity.cell_id, enb_ref_p->enb_id());
+        ue_context_p->e_utran_cgi.cell_identity.cell_id, enb_ref_p.enb_id());
     OAILOG_INFO(LOG_UTIL, "UE Context Release procedure initiated for IMSI%s",
                 offload_request->imsi);
     IMSI_STRING_TO_IMSI64(offload_request->imsi,

lte/gateway/c/core/oai/tasks/s1ap/s1ap_common.hpp

@@ -429,10 +429,9 @@ extern int asn1_xer_print;
 
 /** \brief Function callback prototype.
  **/
-typedef status_code_e (*s1ap_message_handler_t)(S1apState* state,
-                                                const sctp_assoc_id_t assoc_id,
-                                                const sctp_stream_id_t stream,
-                                                S1ap_S1AP_PDU_t* pdu);
+typedef status_code_e (*s1ap_message_handler_t)(
+    magma::lte::oai::S1apState* state, const sctp_assoc_id_t assoc_id,
+    const sctp_stream_id_t stream, S1ap_S1AP_PDU_t* pdu);
 
 /** \brief Handle criticality
  \param criticality Criticality of the IE

lte/gateway/c/core/oai/tasks/s1ap/s1ap_mme.cpp

@@ -107,7 +107,7 @@ static int s1ap_send_init_sctp(void) {
 static int handle_message(zloop_t* loop, zsock_t* reader, void* arg) {
   MessageDef* received_message_p = receive_msg(reader);
   imsi64_t imsi64 = itti_get_associated_imsi(received_message_p);
-  S1apState* state = get_s1ap_state(false);
+  oai::S1apState* state = get_s1ap_state(false);
   AssertFatal(state != NULL, "failed to retrieve s1ap state (was null)");
 
   bool is_task_state_same = false;
@@ -376,37 +376,27 @@ static void s1ap_mme_exit(void) {
 }
 
 //------------------------------------------------------------------------------
-oai::EnbDescription* s1ap_new_enb(void) {
-  oai::EnbDescription* enb_ref = NULL;
+void s1ap_new_enb(oai::EnbDescription* enb_ref) {
   magma::proto_map_uint32_uint64_t ue_id_coll;
 
-  enb_ref = new oai::EnbDescription();
-  /*
-   * Something bad happened during new
-   * * * * May be we are running out of memory.
-   * * * * TODO: Notify eNB with a cause like Hardware Failure.
-   */
-  if (enb_ref == NULL) {
-    OAILOG_CRITICAL(
+  if (enb_ref == nullptr) {
+    OAILOG_ERROR(
         LOG_S1AP,
-        "Failed to allocate memory for structure, oai::EnbDescription \n");
-    return enb_ref;
+        "Received invalid pointer for structure, oai::EnbDescription ");
+    return;
   }
   ue_id_coll.map = enb_ref->mutable_ue_id_map();
   ue_id_coll.set_name("s1ap_ue_coll");
   enb_ref->set_nb_ue_associated(0);
-  return enb_ref;
+  return;
 }
 
 //------------------------------------------------------------------------------
-oai::UeDescription* s1ap_new_ue(S1apState* state,
+oai::UeDescription* s1ap_new_ue(oai::EnbDescription* enb_ref,
                                 const sctp_assoc_id_t sctp_assoc_id,
                                 enb_ue_s1ap_id_t enb_ue_s1ap_id) {
-  oai::EnbDescription* enb_ref = NULL;
   oai::UeDescription* ue_ref = nullptr;
 
-  enb_ref = s1ap_state_get_enb(state, sctp_assoc_id);
-  DevAssert(enb_ref != NULL);
   ue_ref = new oai::UeDescription();
   /*
    * Something bad happened during memory allocation...
@@ -445,23 +435,28 @@ oai::UeDescription* s1ap_new_ue(S1apState* state,
 }
 
 //------------------------------------------------------------------------------
-void s1ap_remove_ue(S1apState* state, oai::UeDescription* ue_ref) {
-  oai::EnbDescription* enb_ref = NULL;
+void s1ap_remove_ue(oai::S1apState* state, oai::UeDescription* ue_ref) {
+  oai::EnbDescription enb_ref;
 
   // NULL reference...
   if (ue_ref == nullptr) return;
 
   mme_ue_s1ap_id_t mme_ue_s1ap_id = ue_ref->mme_ue_s1ap_id();
-  enb_ref = s1ap_state_get_enb(state, ue_ref->sctp_assoc_id());
-  DevAssert(enb_ref->nb_ue_associated() > 0);
+  if ((s1ap_state_get_enb(state, ue_ref->sctp_assoc_id(), &enb_ref)) !=
+      PROTO_MAP_OK) {
+    OAILOG_ERROR(LOG_S1AP, "Failed to get enb association for assoc_id: %u",
+                 ue_ref->sctp_assoc_id());
+    return;
+  }
+  DevAssert(enb_ref.nb_ue_associated() > 0);
   // Updating number of UE
-  enb_ref->set_nb_ue_associated((enb_ref->nb_ue_associated() - 1));
+  enb_ref.set_nb_ue_associated((enb_ref.nb_ue_associated() - 1));
 
   OAILOG_TRACE(LOG_S1AP,
                "Removing UE enb_ue_s1ap_id: " ENB_UE_S1AP_ID_FMT
                " mme_ue_s1ap_id:" MME_UE_S1AP_ID_FMT " in eNB id : %d\n",
                ue_ref->enb_ue_s1ap_id(), ue_ref->mme_ue_s1ap_id(),
-               enb_ref->enb_id);
+               enb_ref.enb_id);
 
   ue_ref->set_s1ap_ue_state(oai::S1AP_UE_INVALID_STATE);
   if (ue_ref->s1ap_ue_context_rel_timer().id() != S1AP_TIMER_INACTIVE_ID) {
@@ -475,12 +470,12 @@ void s1ap_remove_ue(S1apState* state, oai::UeDescription* ue_ref) {
     return;
   }
   s1ap_ue_state->remove(ue_ref->comp_s1ap_id());
-  proto_map_uint32_uint32_t mmeid2associd_map.map =
-      state->mutable_mmeid2associd();
+  proto_map_uint32_uint32_t mmeid2associd_map;
+  mmeid2associd_map.map = state->mutable_mmeid2associd();
   mmeid2associd_map.remove(mme_ue_s1ap_id);
 
   magma::proto_map_uint32_uint64_t ue_id_coll;
-  ue_id_coll.map = enb_ref->mutable_ue_id_map();
+  ue_id_coll.map = enb_ref.mutable_ue_id_map();
   ue_id_coll.remove(mme_ue_s1ap_id);
 
   imsi64_t imsi64 = INVALID_IMSI64;
@@ -490,28 +485,29 @@ void s1ap_remove_ue(S1apState* state, oai::UeDescription* ue_ref) {
   s1ap_imsi_map->mme_ueid2imsi_map.remove(mme_ue_s1ap_id);
 
   OAILOG_DEBUG(LOG_S1AP, "Num UEs associated %u num elements in ue_id_coll %lu",
-               enb_ref->nb_ue_associated(), ue_id_coll.size());
-  if (!enb_ref->nb_ue_associated()) {
-    if (enb_ref->s1_enb_state() == magma::lte::oai::S1AP_RESETING) {
+               enb_ref.nb_ue_associated(), ue_id_coll.size());
+  if (!enb_ref.nb_ue_associated()) {
+    if (enb_ref.s1_enb_state() == magma::lte::oai::S1AP_RESETING) {
       OAILOG_INFO(LOG_S1AP, "Moving eNB state to S1AP_INIT \n");
-      enb_ref->set_s1_state(magma::lte::oai::S1AP_INIT);
-      set_gauge("s1_connection", 0, 1, "enb_name", enb_ref->enb_name());
+      enb_ref.set_s1_state(magma::lte::oai::S1AP_INIT);
+      set_gauge("s1_connection", 0, 1, "enb_name", enb_ref.enb_name());
       state->set_num_enbs(state->num_enbs() - 1);
-    } else if (enb_ref->s1_enb_state() == magma::lte::oai::S1AP_SHUTDOWN) {
+    } else if (enb_ref.s1_enb_state() == magma::lte::oai::S1AP_SHUTDOWN) {
       OAILOG_INFO(LOG_S1AP, "Deleting eNB \n");
-      set_gauge("s1_connection", 0, 1, "enb_name", enb_ref->enb_name());
-      s1ap_remove_enb(state, enb_ref);
+      set_gauge("s1_connection", 0, 1, "enb_name", enb_ref.enb_name());
+      s1ap_remove_enb(state, &enb_ref);
     }
   }
+  s1ap_state_update_enb_map(state, enb_ref.sctp_assoc_id(), &enb_ref);
 }
 
 //------------------------------------------------------------------------------
-void s1ap_remove_enb(S1apState* state, oai::EnbDescription* enb_ref) {
+void s1ap_remove_enb(oai::S1apState* state, oai::EnbDescription* enb_ref) {
   if (enb_ref == NULL) {
     return;
   }
   magma::proto_map_uint32_uint64_t ue_id_coll;
-  map_uint32_enb_description_t enb_map;
+  proto_map_uint32_enb_description_t enb_map;
   enb_ref->set_s1_state(magma::lte::oai::S1AP_INIT);
 
   ue_id_coll.map = enb_ref->mutable_ue_id_map();
@@ -524,7 +520,7 @@ void s1ap_remove_enb(S1apState* state, oai::EnbDescription* enb_ref) {
 }
 
 static int handle_stats_timer(zloop_t* loop, int id, void* arg) {
-  S1apState* s1ap_state_p = get_s1ap_state(false);
+  oai::S1apState* s1ap_state_p = get_s1ap_state(false);
   application_s1ap_stats_msg_t stats_msg;
   stats_msg.nb_enb_connected = s1ap_state_p->num_enbs();
   stats_msg.nb_s1ap_last_msg_latency = s1ap_last_msg_latency;

lte/gateway/c/core/oai/tasks/s1ap/s1ap_mme.hpp

@@ -53,28 +53,26 @@ namespace lte {
 /** \brief Allocate and add to the list a new eNB descriptor
  * @returns Reference to the new eNB element in list
  **/
-magma::lte::oai::EnbDescription* s1ap_new_enb(void);
+void s1ap_new_enb(oai::EnbDescription*);
 
 /** \brief Allocate and add to the right eNB list a new UE descriptor
  * \param sctp_assoc_id association ID over SCTP
  * \param enb_ue_s1ap_id ue ID over S1AP
  * @returns Reference to the new UE element in list
  **/
-oai::UeDescription* s1ap_new_ue(S1apState* state,
-                                            sctp_assoc_id_t sctp_assoc_id,
-                                            enb_ue_s1ap_id_t enb_ue_s1ap_id);
+oai::UeDescription* s1ap_new_ue(oai::EnbDescription* enb_ref,
+                                sctp_assoc_id_t sctp_assoc_id,
+                                enb_ue_s1ap_id_t enb_ue_s1ap_id);
 
 /** \brief Remove target UE from the list
  * \param ue_ref UE structure reference to remove
  **/
-void s1ap_remove_ue(S1apState* state,
-                    oai::UeDescription* ue_ref);
+void s1ap_remove_ue(oai::S1apState* state, oai::UeDescription* ue_ref);
 
 /** \brief Remove target eNB from the list and remove any UE associated
  * \param enb_ref eNB structure reference to remove
  **/
-void s1ap_remove_enb(S1apState* state,
-                     oai::EnbDescription* enb_ref);
+void s1ap_remove_enb(oai::S1apState* state, oai::EnbDescription* enb_ref);
 
 void free_enb_description(void** ptr);