FlexRAN: Add app loader/CM

cmake_targets/CMakeLists.txt

@@ -1095,6 +1095,7 @@ add_library(FLEXRAN_AGENT
   ${OPENAIR2_DIR}/ENB_APP/flexran_agent_async.c
   ${OPENAIR2_DIR}/ENB_APP/CONTROL_MODULES/MAC/flexran_agent_mac_internal.c
   ${OPENAIR2_DIR}/ENB_APP/CONTROL_MODULES/MAC/flexran_agent_mac_slice_verification.c
+  ${OPENAIR2_DIR}/ENB_APP/flexran_agent_app.c
   )
 add_dependencies(FLEXRAN_AGENT rrc_flag)
 set(FLEXRAN_AGENT_LIB FLEXRAN_AGENT)

openair2/ENB_APP/flexran_agent.c

@@ -233,6 +233,9 @@ int flexran_agent_start(mid_t mod_id)
     agent_task_created = 1;
   }
 
+  /* Init the app sublayer */
+  flexran_agent_app_init(mod_id);
+
   pthread_mutex_init(&flexran->mutex_node_ctrl, NULL);
   pthread_cond_init(&flexran->cond_node_ctrl, NULL);
 

openair2/ENB_APP/flexran_agent.h

@@ -41,6 +41,7 @@
 #include "flexran_agent_rrc.h"
 #include "flexran_agent_pdcp.h"
 #include "flexran_agent_s1ap.h"
+#include "flexran_agent_app.h"
 #include "common/utils/LOG/log.h"
 #include "assertions.h"
 

openair2/ENB_APP/flexran_agent_app.c

+/*
+ * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The OpenAirInterface Software Alliance licenses this file to You under
+ * the OAI Public License, Version 1.1  (the "License"); you may not use this file
+ * except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.openairinterface.org/?page_id=698
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *-------------------------------------------------------------------------------
+ * For more information about the OpenAirInterface (OAI) Software Alliance:
+ *      contact@openairinterface.org
+ */ 
+
+/*! \file flexran_agent_app.c
+ * \brief CM for handling of applications
+ * \author Robert Schmidt
+ * \date 2020
+ * \version 0.1
+ */
+
+#include "flexran_agent_app.h"
+#include "queue.h"
+#include <dlfcn.h>
+
+/* app definition */
+typedef struct flexran_agent_app_internal_s {
+  char *name;
+  void *dl_handle;
+  flexran_agent_app_t *app;
+
+  SLIST_ENTRY (flexran_agent_app_internal_s) entries;
+} flexran_agent_app_internal_t;
+
+/* a list of all apps */
+SLIST_HEAD(flexran_apps_s, flexran_agent_app_internal_s) flexran_apps[NUM_MAX_ENB];
+
+void flexran_agent_app_init(mid_t mod_id) {
+  //flexran_apps[mod_id] = SLIST_HEAD_INITIALIZER(flexran_apps[mod_id]);
+  SLIST_INIT(&flexran_apps[mod_id]);
+}
+
+int flexran_agent_start_app_direct(mid_t mod_id, flexran_agent_app_t *app, char *name) {
+  app->start(mod_id, NULL, 0);
+
+  flexran_agent_app_internal_t *so = malloc(sizeof(flexran_agent_app_internal_t));
+  DevAssert(so);
+  so->name = strdup(name);
+  DevAssert(so->name);
+  so->dl_handle = NULL;
+  so->app = app;
+  SLIST_INSERT_HEAD(&flexran_apps[mod_id], so, entries);
+  return 0;
+}
+
+int flexran_agent_start_app(mid_t mod_id, Protocol__FlexAgentReconfigurationSubsystem *sub) {
+  char s[512];
+  int rc = flexran_agent_map_name_to_delegated_object(mod_id, sub->name, s, 512);
+  if (rc < 0) {
+    LOG_E(FLEXRAN_AGENT, "cannot map name %s\n", sub->name);
+    return -1;
+  }
+  void *h = dlopen(s, RTLD_NOW);
+  if (!h) {
+    LOG_E(FLEXRAN_AGENT, "cannot open shared object %s\n", s);
+    return -1;
+  }
+  flexran_agent_app_t *app = dlsym(h, "app");
+  if (!app) {
+    LOG_E(FLEXRAN_AGENT, "cannot locate app inside of shared object %s\n", s);
+    return -1;
+  }
+  app->start(mod_id, sub->params, sub->n_params);
+
+  flexran_agent_app_internal_t *so = malloc(sizeof(flexran_agent_app_internal_t));
+  DevAssert(so);
+  so->name = strdup(sub->name);
+  DevAssert(so->name);
+  so->dl_handle = h;
+  so->app = app;
+  SLIST_INSERT_HEAD(&flexran_apps[mod_id], so, entries);
+
+  return 0;
+}
+
+int flexran_agent_stop_app(mid_t mod_id, char *name) {
+  flexran_agent_app_internal_t *so = NULL;
+  SLIST_FOREACH(so, &flexran_apps[mod_id], entries) {
+    if (strcmp(so->name, name) == 0) {
+      LOG_I(FLEXRAN_AGENT, "application %s seems to be running\n", name);
+      break;
+    }
+  }
+  if (!so) {
+    LOG_E(FLEXRAN_AGENT, "no such application %s found\n", name);
+    return -1;
+  }
+  flexran_agent_app_t *app = so->app;
+  app->stop(mod_id);
+
+  SLIST_REMOVE(&flexran_apps[mod_id], so, flexran_agent_app_internal_s, entries);
+  free(so->name);
+  if (so->dl_handle)
+    dlclose(so->dl_handle);
+  free(so);
+  so = NULL;
+  return 0;
+}
+
+int flexran_agent_reconfig_app(
+    mid_t mod_id,
+    Protocol__FlexAgentReconfigurationSubsystem *sub)
+{
+  flexran_agent_app_internal_t *so = NULL;
+  SLIST_FOREACH(so, &flexran_apps[mod_id], entries) {
+    if (strcmp(so->name, sub->name) == 0) {
+      LOG_I(FLEXRAN_AGENT, "application %s is running\n", sub->name);
+      break;
+    }
+  }
+  if (!so) {
+    LOG_E(FLEXRAN_AGENT, "no such application %s found\n", sub->name);
+    return -1;
+  }
+  flexran_agent_app_t *app = so->app;
+  LOG_I(FLEXRAN_AGENT, "reconfiguring app %s\n", so->name);
+  app->reconfig(mod_id, sub->params, sub->n_params);
+  return 0;
+}
+
+int flexran_agent_custom_command_app(
+    mid_t mod_id,
+    Protocol__FlexAgentReconfigurationSubsystem *sub)
+{
+  flexran_agent_app_internal_t *so = NULL;
+  SLIST_FOREACH(so, &flexran_apps[mod_id], entries) {
+    if (strcmp(so->name, sub->name) == 0) {
+      LOG_I(FLEXRAN_AGENT, "application %s is running\n", sub->name);
+      break;
+    }
+  }
+  if (!so) {
+    LOG_E(FLEXRAN_AGENT, "no such application %s found\n", sub->name);
+    return -1;
+  }
+  void (*cmd)(mid_t, Protocol__FlexAgentReconfigurationSubsystem *) = dlsym(so->dl_handle, sub->behavior);
+  if (!cmd) {
+    LOG_E(FLEXRAN_AGENT,
+          "cannot locate command %s inside of app %s\n",
+          sub->behavior,
+          so->name);
+    return -1;
+  }
+
+  LOG_I(FLEXRAN_AGENT,
+        "calling command %s inside of app %s\n",
+        sub->behavior,
+        so->name);
+  (*cmd)(mod_id, sub);
+  return 0;
+}
+
+void flexran_agent_handle_apps(
+    mid_t mod_id,
+    Protocol__FlexAgentReconfigurationSubsystem **subs,
+    int n_subs) {
+  for (int i = 0; i < n_subs; ++i) {
+    Protocol__FlexAgentReconfigurationSubsystem *s = subs[i];
+    if (strcmp(s->behavior, "start") == 0) {
+      int rc = flexran_agent_start_app(mod_id, s);
+      if (rc == 0)
+        LOG_I(FLEXRAN_AGENT, "application \"%s\" started\n", s->name);
+    } else if (strcmp(s->behavior, "stop") == 0) {
+      int rc = flexran_agent_stop_app(mod_id, s->name);
+      if (rc == 0)
+        LOG_I(FLEXRAN_AGENT, "application \"%s\" stopped\n", s->name);
+    } else if (strcmp(s->behavior, "reconfig") == 0) {
+      flexran_agent_reconfig_app(mod_id, s);
+    } else {
+      flexran_agent_custom_command_app(mod_id, s);
+    }
+  }
+}

openair2/ENB_APP/flexran_agent_app.h

+/*
+ * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The OpenAirInterface Software Alliance licenses this file to You under
+ * the OAI Public License, Version 1.1  (the "License"); you may not use this file
+ * except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.openairinterface.org/?page_id=698
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *-------------------------------------------------------------------------------
+ * For more information about the OpenAirInterface (OAI) Software Alliance:
+ *      contact@openairinterface.org
+ */ 
+
+/*! \file flexran_agent_app.h
+ * \brief Common app definitions
+ * \author Robert Schmidt
+ * \date 2020
+ * \version 0.1
+ */
+
+#ifndef BURST_ANALYSIS_LL_H_
+#define BURST_ANALYSIS_LL_H_
+
+#include "flexran_agent_common.h"
+#include "flexran_agent_async.h"
+#include "flexran_agent_extern.h"
+#include "flexran_agent_timer.h"
+#include "flexran_agent_defs.h"
+#include "flexran_agent_net_comm.h"
+#include "flexran_agent_ran_api.h"
+#include "flexran_agent_phy.h"
+#include "flexran_agent_mac.h"
+#include "flexran_agent_rrc.h"
+#include "flexran_agent_pdcp.h"
+#include "flexran_agent_s1ap.h"
+#include "common/utils/LOG/log.h"
+#include "assertions.h"
+
+/* App type: to be implemented by shared libraries */
+typedef struct {
+  int (*start)(mid_t mod_id,
+               Protocol__FlexAgentReconfigurationSubsystem__ParamsEntry **p,
+               int n_p);
+  int (*reconfig)(mid_t mod_id,
+                  Protocol__FlexAgentReconfigurationSubsystem__ParamsEntry **p,
+                  int n_p);
+  int (* stop)(mid_t mod_id);
+} flexran_agent_app_t;
+
+/* FlexRAN agent app handling init */
+void flexran_agent_app_init(mid_t mod_id);
+
+/* Start an app from within the agent */
+int flexran_agent_start_app_direct(mid_t mod_id, flexran_agent_app_t *app, char *name);
+
+/* FlexRAN agent handler to setup/teardown apps */
+void flexran_agent_handle_apps(
+    mid_t mod_id,
+    Protocol__FlexAgentReconfigurationSubsystem **subs,
+    int n_subs);
+
+#endif

openair2/ENB_APP/flexran_agent_common.c

@@ -42,6 +42,7 @@
 #include "flexran_agent_mac.h"
 #include "flexran_agent_rrc.h"
 #include "flexran_agent_s1ap.h"
+#include "flexran_agent_app.h"
 //#include "PHY/extern.h"
 #include "common/utils/LOG/log.h"
 #include "flexran_agent_mac_internal.h"

openair2/ENB_APP/flexran_agent_handler.c

@@ -32,6 +32,7 @@
 #include "flexran_agent_rrc.h"
 #include "flexran_agent_pdcp.h"
 #include "flexran_agent_s1ap.h"
+#include "flexran_agent_app.h"
 #include "flexran_agent_timer.h"
 #include "flexran_agent_ran_api.h"
 #include "common/utils/LOG/log.h"