Merge branch 'feature-68-enb-agent' into 'develop'

Feature 68 enb agent



See merge request !47

cmake_targets/build_oai

@@ -35,6 +35,7 @@ source $THIS_SCRIPT_PATH/tools/build_helper
 
 MSC_GEN="False"
 XFORMS="True"
+FLEXRAN_AGENT_SB_IF="True"
 PRINT_STATS="False"
 VCD_TIMING="False"
 DEADLINE_SCHEDULER_FLAG_USER="False"
@@ -83,6 +84,8 @@ Options
    Makes the UE specific parts (ue_ip, usim, nvram) 
 --RRH
    Makes the RRH
+-a | --agent
+   Enables agent for software-defined control of the eNB
 -r | --3gpp-release
    default is Rel10,
    Rel8 limits the implementation to 3GPP Release 8 version
@@ -169,6 +172,10 @@ function main() {
             eNB=1
             echo_info "Will compile eNB"
             shift;;
+       -a | --agent)
+	    FLEXRAN_AGENT=1
+	    echo_info "Will compile eNB with agent support"
+	    shift;;
        --UE)
             UE=1
             echo_info "Will compile UE"
@@ -439,6 +446,9 @@ function main() {
     echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
     echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
     echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
+    if [ "$FLEXRAN_AGENT" = "1" ] ; then
+	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
+    fi
     echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
     echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
     echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
@@ -581,6 +591,9 @@ function main() {
     echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
     echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
     echo "set ( XFORMS $XFORMS )" >>  $cmake_file
+    if [ "$FLEXRAN_AGENT" = "1" ] ; then
+	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
+    fi
     echo "set ( PRINT_STATS $PRINT_STATS )" >>  $cmake_file
     echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
     echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
@@ -649,6 +662,9 @@ function main() {
     cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
     echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
     echo "set ( XFORMS $XFORMS )" >>  $cmake_file
+    if [ "$FLEXRAN_AGENT" = "1" ] ; then
+	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
+    fi
     echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
     echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
     echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file

cmake_targets/oaisim_noS1_build_oai/CMakeLists.template

@@ -48,7 +48,7 @@ set (  NEW_FFT True )
 set (  NO_RRM True )
 set (  OAI_EMU True )
 set (  OAISIM True )
-set (  OAI_NW_DRIVER_TYPE_ETHERNET True )
+set (  OAI_NW_DRIVER_TYPE_ETHERNET False )
 set (  OAI_NW_DRIVER_USE_NETLINK True )
 set (  OPENAIR1 True )
 set (  OPENAIR2 True )

cmake_targets/tools/build_helper

@@ -163,6 +163,42 @@ compilations() {
 # External packages installers
 ############################################
 
+install_protobuf_from_source(){
+    protobuf_install_log=$OPENAIR_DIR/cmake_targets/log/protobuf_install_log.txt
+    echo_info "\nInstalling Google Protobuf from sources. The log file for Protobuf installation is here: $protobuf_install_log "
+    (
+    cd /tmp
+    echo "Downloading protobuf"
+    rm -rf /tmp/protobuf-2.6.1.tar.gz* /tmp/protobuf-2.6.1
+    wget https://github.com/google/protobuf/releases/download/v2.6.1/protobuf-2.6.1.tar.gz
+    tar -xzvf protobuf-2.6.1.tar.gz
+    cd protobuf-2.6.1/
+    ./configure
+    echo "Compiling protobuf"
+    make -j`nproc`
+    $SUDO make install
+    $SUDO ldconfig
+    ) >& $protobuf_install_log
+}
+
+install_protobuf_c_from_source(){
+    protobuf_c_install_log=$OPENAIR_DIR/cmake_targets/log/protobuf_c_install_log.txt
+    echo_info "\nInstalling Google Protobuf_C from sources. The log file for Protobuf_C installation is here: $protobuf_c_install_log "
+    (
+    cd /tmp
+    echo "Downloading protobuf-c"
+    rm -rf /tmp/protobuf-c
+    git clone https://github.com/protobuf-c/protobuf-c.git
+    cd protobuf-c
+    ./autogen.sh
+    ./configure
+    echo "Compiling protobuf-c"
+    make -j`nproc`
+    $SUDO make install
+    $SUDO ldconfig
+    ) >& $protobuf_c_install_log
+}
+
 check_install_usrp_uhd_driver(){
         #first we remove old installation
         $SUDO apt-get remove -y uhd || true
@@ -324,6 +360,7 @@ check_install_oai_software() {
 	xmlstarlet \
 	python-pip \
 	pydb \
+	libyaml-dev \
 	wget
 
     $SUDO update-alternatives --set liblapack.so /usr/lib/atlas-base/atlas/liblapack.so
@@ -337,6 +374,10 @@ check_install_oai_software() {
     $SUDO apt-get install -y libgnutls-dev
     
     install_asn1c_from_source
+    $SUDO rm -fr /opt/ssh
+    $SUDO git clone https://gist.github.com/2190472.git /opt/ssh
+    install_protobuf_from_source
+    install_protobuf_c_from_source
 }
 
 ### Remove Nettle installation which was done from sources
@@ -361,6 +402,7 @@ remove_nettle_from_source() {
     cd nettle-2.5/
     ./configure --disable-openssl --enable-shared --prefix=/usr 
     $SUDO make uninstall || true 
+    $SUDO ldconfig
     ) >& $nettle_uninstall_log
 }
 
@@ -384,6 +426,7 @@ remove_gnutls_from_source(){
     cd gnutls-3.1.23/
     ./configure --prefix=/usr
     $SUDO make uninstall || true
+    $SUDO ldconfig
     )>& $gnutls_uninstall_log
 }
 
@@ -398,6 +441,7 @@ install_asn1c_from_source(){
     make -j`nproc`
     $SUDO make install
     cd -
+    $SUDO ldconfig
     ) > $asn1_install_log 2>&1
 }
 

cmake_targets/tools/generate_protobuf

+#!/bin/bash
+
+function main()
+{
+mkdir -p $1
+
+#echo generate protobuf messages inside $1 $2
+
+c_out=$1
+shift
+proto_path=$1
+shift
+
+protoc-c  --c_out=$c_out --proto_path=$proto_path $*
+#protoc    --cpp_out=$c_out --proto_path=$proto_path $*
+
+}
+
+main "$@"

cmake_targets/tools/make_agent_cache

+#!/usr/bin/env bash
+
+CACHE_DIR=/mnt/oai_agent_cache
+
+if [ ! -d $CACHE_DIR ]; then
+    echo "Creating cache dir in $CACHE_DIR"
+    sudo mkdir $CACHE_DIR
+fi
+
+if grep -qs "$CACHE_DIR" /proc/mounts; then
+    echo "Agent cache is already mounted"
+else
+    echo "Agent cache was not mounted"
+    echo "Mounting..."
+    sudo mount -o size=100m -t tmpfs none "$CACHE_DIR"
+    if [ $? -eq 0 ]; then
+	echo "Mount success"
+    else
+	echo "Something went wrong with the mount"
+    fi
+fi

common/utils/itti/timer.c

@@ -86,8 +86,8 @@ int timer_handle_signal(siginfo_t *info)
   timer_p = (struct timer_elm_s *)info->si_ptr;
 
   // LG: To many traces for msc timer:
-  // TMR_DEBUG("Timer with id 0x%lx has expired\n", (long)timer_p->timer);
-
+  TMR_DEBUG("Timer with id 0x%lx has expired\n", (long)timer_p->timer);
+  
   task_id = timer_p->task_id;
   instance = timer_p->instance;
   message_p = itti_alloc_new_message(TASK_TIMER, TIMER_HAS_EXPIRED);
@@ -120,6 +120,10 @@ int timer_handle_signal(siginfo_t *info)
     return -1;
   }
 
+#if defined(ENB_AGENT_SB_IF)
+
+#endif 
+
   return 0;
 }
 

maketags

 #!/bin/sh
 echo "building ctags for openair1 and openair2 ..."
 ctags -e -R  --exclude=openair1/DOCS/ --exclude=openair2/DOCS/ --exclude=openair2/RRC/CELLULAR/ --exclude=openair2/NAS/DRIVER/CELLULAR/ --exclude=openair2/SIMULATION/ --exclude=targets/DOCS/ --exclude=targets/PROJECTS/ openair1 openair2 openair3 targets cmake_targets common
+

openair1/SCHED/defs.h

@@ -69,6 +69,11 @@ enum openair_SYNCH_STATUS {
   openair_SCHED_EXIT
 };
 
+enum openair_HARQ_TYPE {
+  openair_harq_DL = 0,
+  openair_harq_UL,
+  openair_harq_RA
+};
 
 #define DAQ_AGC_ON 1
 #define DAQ_AGC_OFF 0

openair1/SCHED/phy_procedures_lte_eNb.c

@@ -21,11 +21,11 @@
 
 /*! \file phy_procedures_lte_eNB.c
  * \brief Implementation of eNB procedures from 36.213 LTE specifications
- * \author R. Knopp, F. Kaltenberger, N. Nikaein
+ * \author R. Knopp, F. Kaltenberger, N. Nikaein, X. Foukas
  * \date 2011
  * \version 0.1
  * \company Eurecom
- * \email: knopp@eurecom.fr,florian.kaltenberger@eurecom.fr,navid.nikaein@eurecom.fr
+ * \email: knopp@eurecom.fr,florian.kaltenberger@eurecom.fr,navid.nikaein@eurecom.fr, x.foukas@sms.ed.ac.uk
  * \note
  * \warning
  */
@@ -61,6 +61,14 @@
 #   include "intertask_interface.h"
 #endif
 
+
+#if defined(FLEXRAN_AGENT_SB_IF)
+//Agent-related headers
+#include "ENB_APP/flexran_agent_extern.h"
+#include "ENB_APP/CONTROL_MODULES/MAC/flexran_agent_mac.h"
+#include "LAYER2/MAC/flexran_agent_mac_proto.h"
+#endif
+
 //#define DIAG_PHY
 
 #define NS_PER_SLOT 500000
@@ -221,7 +229,7 @@ int8_t find_next_ue_index(PHY_VARS_eNB *eNB)
   return(-1);
 }
 
-int get_ue_active_harq_pid(const uint8_t Mod_id,const uint8_t CC_id,const uint16_t rnti, const int frame, const uint8_t subframe,uint8_t *harq_pid,uint8_t *round,const uint8_t ul_flag)
+int get_ue_active_harq_pid(const uint8_t Mod_id,const uint8_t CC_id,const uint16_t rnti, const int frame, const uint8_t subframe,uint8_t *harq_pid,uint8_t *round,const uint8_t harq_flag)
 {
   LTE_eNB_DLSCH_t *DLSCH_ptr;
   LTE_eNB_ULSCH_t *ULSCH_ptr;
@@ -235,9 +243,20 @@ int get_ue_active_harq_pid(const uint8_t Mod_id,const uint8_t CC_id,const uint16
     return(-1);
   }
 
-  if (ul_flag == 0)  {// this is a DL request
+  if ((harq_flag == openair_harq_DL) || (harq_flag == openair_harq_RA))  {// this is a DL request
+
     DLSCH_ptr = PHY_vars_eNB_g[Mod_id][CC_id]->dlsch[(uint32_t)UE_id][0];
 
+    if (harq_flag == openair_harq_RA) {
+      if (DLSCH_ptr->harq_processes[0] != NULL) {
+	*harq_pid = 0;
+	*round = DLSCH_ptr->harq_processes[0]->round;
+	return 0;
+      } else {
+	return -1;
+      }
+    }
+
     /* let's go synchronous for the moment - maybe we can change at some point */
     i = (frame * 10 + subframe) % 8;
 
@@ -1405,7 +1424,16 @@ void phy_procedures_eNB_TX(PHY_VARS_eNB *eNB,
     
     eNB->dlsch_ra->active = 0;
   }
-  
+
+#if defined(FLEXRAN_AGENT_SB_IF)
+#ifndef DISABLE_SF_TRIGGER
+  //Send subframe trigger to the controller
+  if (mac_agent_registered[eNB->Mod_id]) {
+    agent_mac_xface[eNB->Mod_id]->flexran_agent_send_sf_trigger(eNB->Mod_id);
+  }
+#endif
+#endif
+
   // Now scan UE specific DLSCH
   for (UE_id=0; UE_id<NUMBER_OF_UE_MAX; UE_id++)
     {

openair2/COMMON/tasks_def.h

@@ -55,6 +55,8 @@ TASK_DEF(TASK_X2AP,     TASK_PRIORITY_MED,          200)
 TASK_DEF(TASK_SCTP,     TASK_PRIORITY_MED,          200)
 ///   eNB APP task
 TASK_DEF(TASK_ENB_APP,  TASK_PRIORITY_MED,          200)
+///   eNB Agent task
+TASK_DEF(TASK_FLEXRAN_AGENT,  TASK_PRIORITY_MED,          200)
 
 // UE tasks and sub-tasks:
 //// Layer 2 and Layer 1 sub-tasks

openair2/ENB_APP/CONTROL_MODULES/MAC/flexran_agent_mac.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.0  (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_mac.h
+ * \brief FlexRAN agent message handler APIs for MAC layer
+ * \author  Xenofon Foukas, Mohamed Kassem and Navid Nikaein
+ * \date 2016
+ * \version 0.1
+ */
+
+#ifndef FLEXRAN_AGENT_MAC_H_
+#define FLEXRAN_AGENT_MAC_H_
+
+#include "header.pb-c.h"
+#include "flexran.pb-c.h"
+#include "stats_messages.pb-c.h"
+#include "stats_common.pb-c.h"
+
+#include "flexran_agent_common.h"
+#include "flexran_agent_extern.h"
+
+/* These types will be used to give
+   instructions for the type of stats reports
+   we need to create */
+typedef struct {
+  uint16_t ue_rnti;
+  uint32_t ue_report_flags; /* Indicates the report elements
+			       required for this UE id. See
+			       FlexRAN specification 1.2.4.2 */
+} ue_report_type_t;
+
+typedef struct {
+  uint16_t cc_id;
+  uint32_t cc_report_flags; /* Indicates the report elements
+			      required for this CC index. See
+			      FlexRAN specification 1.2.4.3 */
+} cc_report_type_t;
+
+typedef struct {
+  int nr_ue;
+  ue_report_type_t *ue_report_type;
+  int nr_cc;
+  cc_report_type_t *cc_report_type;
+} report_config_t;
+
+typedef struct stats_request_config_s{
+  uint8_t report_type;
+  uint8_t report_frequency;
+  uint16_t period; /*In number of subframes*/
+  report_config_t *config;
+} stats_request_config_t;
+
+/* Initialization function for the agent structures etc */
+void flexran_agent_init_mac_agent(mid_t mod_id);
+
+int flexran_agent_mac_handle_stats(mid_t mod_id, const void *params, Protocol__FlexranMessage **msg);
+
+/* Statistics request protocol message constructor and destructor */
+int flexran_agent_mac_stats_request(mid_t mod_id, xid_t xid, const stats_request_config_t *report_config, Protocol__FlexranMessage **msg);
+int flexran_agent_mac_destroy_stats_request(Protocol__FlexranMessage *msg);
+
+/* Statistics reply protocol message constructor and destructor */
+int flexran_agent_mac_stats_reply(mid_t mod_id, xid_t xid, const report_config_t *report_config, Protocol__FlexranMessage **msg);
+int flexran_agent_mac_destroy_stats_reply(Protocol__FlexranMessage *msg);
+
+/* Scheduling request information protocol message constructor and estructor */
+int flexran_agent_mac_sr_info(mid_t mod_id, const void *params, Protocol__FlexranMessage **msg);
+int flexran_agent_mac_destroy_sr_info(Protocol__FlexranMessage *msg);
+
+/* Subframe trigger protocol msssage constructor and destructor */
+int flexran_agent_mac_sf_trigger(mid_t mod_id, const void *params, Protocol__FlexranMessage **msg);
+int flexran_agent_mac_destroy_sf_trigger(Protocol__FlexranMessage *msg);
+
+/* DL MAC scheduling decision protocol message constructor (empty command) and destructor */ 
+int flexran_agent_mac_create_empty_dl_config(mid_t mod_id, Protocol__FlexranMessage **msg);
+int flexran_agent_mac_destroy_dl_config(Protocol__FlexranMessage *msg);
+
+int flexran_agent_mac_handle_dl_mac_config(mid_t mod_id, const void *params, Protocol__FlexranMessage **msg);
+
+
+/**********************************
+ * FlexRAN agent - technology mac API
+ **********************************/
+
+/*Inform controller about received scheduling requests during a subframe*/
+void flexran_agent_send_sr_info(mid_t mod_id);
+
+/*Inform the controller about the current UL/DL subframe*/
+void flexran_agent_send_sf_trigger(mid_t mod_id);
+
+/// Send to the controller all the mac stat updates that occured during this subframe
+/// based on the stats request configuration
+void flexran_agent_send_update_mac_stats(mid_t mod_id);
+
+/// Provide to the scheduler a pending dl_mac_config message
+void flexran_agent_get_pending_dl_mac_config(mid_t mod_id, Protocol__FlexranMessage **msg);
+
+/*Register technology specific interface callbacks*/
+int flexran_agent_register_mac_xface(mid_t mod_id, AGENT_MAC_xface *xface);
+
+/*Unregister technology specific callbacks*/
+int flexran_agent_unregister_mac_xface(mid_t mod_id, AGENT_MAC_xface*xface);
+
+#endif

openair2/ENB_APP/CONTROL_MODULES/MAC/flexran_agent_mac_defs.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.0  (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_mac_defs.h
+ * \brief FlexRAN agent - mac interface primitives
+ * \author Xenofon Foukas
+ * \date 2016
+ * \version 0.1
+ * \mail x.foukas@sms.ed.ac.uk
+ */
+
+#ifndef __FLEXRAN_AGENT_MAC_PRIMITIVES_H__
+#define __FLEXRAN_AGENT_MAC_PRIMITIVES_H__
+
+#include "flexran_agent_defs.h"
+#include "flexran.pb-c.h"
+#include "header.pb-c.h"
+
+#define RINGBUFFER_SIZE 100
+
+/* FLEXRAN AGENT-MAC Interface */
+typedef struct {
+  //msg_context_t *agent_ctxt;
+
+  /// Inform the controller about the scheduling requests received during the subframe
+  void (*flexran_agent_send_sr_info)(mid_t mod_id);
+  
+  /// Inform the controller about the current UL/DL subframe
+  void (*flexran_agent_send_sf_trigger)(mid_t mod_id);
+
+  /// Send to the controller all the mac stat updates that occured during this subframe
+  /// based on the stats request configuration
+  void (*flexran_agent_send_update_mac_stats)(mid_t mod_id);
+
+  /// Provide to the scheduler a pending dl_mac_config message
+  void (*flexran_agent_get_pending_dl_mac_config)(mid_t mod_id,
+						  Protocol__FlexranMessage **msg);
+  
+  /// Run the UE DL scheduler and fill the Protocol__FlexranMessage. Assumes that
+  /// dl_info is already initialized as flex_dl_mac_config and fills the
+  /// flex_dl_data part of it
+  void (*flexran_agent_schedule_ue_spec)(mid_t mod_id, uint32_t frame, uint32_t subframe,
+					 int *mbsfn_flag, Protocol__FlexranMessage **dl_info);
+  
+
+  /// Notify the controller for a state change of a particular UE, by sending the proper
+  /// UE state change message (ACTIVATION, DEACTIVATION, HANDOVER)
+  void (*flexran_agent_notify_ue_state_change)(mid_t mod_id, uint32_t rnti,
+					       uint32_t state_change);
+  
+  
+  void *dl_scheduler_loaded_lib;
+  /*TODO: Fill in with the rest of the MAC layer technology specific callbacks (UL/DL scheduling, RACH info etc)*/
+
+} AGENT_MAC_xface;
+
+#endif

openair2/ENB_APP/CONTROL_MODULES/MAC/flexran_agent_mac_internal.h

+/*