rrh_gw.c 12.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

/*******************************************************************************
    OpenAirInterface
    Copyright(c) 1999 - 2014 Eurecom

    OpenAirInterface is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.


    OpenAirInterface is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with OpenAirInterface.The full GNU General Public License is
    included in this distribution in the file called "COPYING". If not,
    see <http://www.gnu.org/licenses/>.

   Contact Information
   OpenAirInterface Admin: openair_admin@eurecom.fr
   OpenAirInterface Tech : openair_tech@eurecom.fr
25
   OpenAirInterface Dev  : openair4g-devel@lists.eurecom.fr
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53

   Address      : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE

 *******************************************************************************/

/*! \file rrh_gw.h
 * \brief top-level for the remote radio head gateway (RRH_gw) module reusing the ethernet library 
 * \author Navid Nikaein,  Katerina Trilyraki, Raymond Knopp
 * \date 2015
 * \version 0.1
 * \company Eurecom
 * \maintainer:  navid.nikaein@eurecom.fr
 * \note
 * \warning very experimental 
 */

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <signal.h>
#include <execinfo.h>
#include <unistd.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <net/if.h>
#include <time.h>

#include "common_lib.h"
54
#include "rrh_gw.h"
55
#include "rt_wrapper.h"
56
#include "rrh_gw_externs.h"
57 58 59 60 61 62


#include "log_if.h"
#include "log_extern.h"
#include "vcd_signal_dumper.h"

navid's avatar
navid committed
63 64 65 66 67 68 69 70 71 72
/*****************************************************************************************
 *                                                                        ----------     *
 *     -------    RRH_BBU_IF    -------    RRH_RF_IF     -------USRP      - COTS_UE-     *
 *     - BBU - ---------------  - RRH -  -------------   -------BLADERF   ----------     *
 *     -------                  -------                  -------EXMIMO                   *
 *                                                                        ---------      *
 *                                                       -------ETH_IF    - EMU_UE-      *
 *                                                                        ---------      *                              
 *****************************************************************************************/

73

74 75
/* local IP/MAC address is detected*/
char rrh_ip[20] = "0.0.0.0"; 
76
unsigned char rrh_mac[6] = "0:0:0:0:0:0"; 
77 78 79 80 81 82 83 84 85 86 87 88 89
int  rrh_port = 50000; // has to be an option

/* log */
int16_t           glog_level          = LOG_DEBUG;
int16_t           glog_verbosity      = LOG_MED;
int16_t           rrh_log_level       = LOG_INFO;
int16_t           rrh_log_verbosity   = LOG_MED;
int16_t           enb_log_level       = LOG_INFO;
int16_t           enb_log_verbosity   = LOG_MED;
int16_t           ue_log_level        = LOG_INFO;
int16_t           ue_log_verbosity    = LOG_MED;


90
/* flag definitions */
91 92 93 94 95 96 97 98
uint8_t 	eNB_flag=0;
uint8_t 	UE_flag=0;
uint8_t 	EXMIMO_flag=0;
uint8_t 	USRP_flag=0;
uint8_t 	RT_flag=0, NRT_flag=1;
uint8_t 	rrh_exit=0;
uint8_t         loopback_flag=0;
uint8_t         measurements_flag=0;
99 100

/* Default operation as RRH:
101
   - there are neither eNB nor UE modules
navid's avatar
navid committed
102 103
   - no RF hardware is specified (NONE_IF)
   - default ethernet interface is local */
104 105
uint8_t 	    num_eNB_mod=0;
uint8_t 	    num_UE_mod=0;
106 107
char*           if_name="lo";
uint8_t         eth_mode=ETH_UDP_MODE;
108

109 110 111
rrh_module_t 	        *enb_array;
rrh_module_t            *ue_array;

112 113
openair0_vtimestamp 	hw_counter=0;

Aikaterini Trilyraki's avatar
Aikaterini Trilyraki committed
114
char   rf_config_file[1024];
navid's avatar
navid committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128

static void debug_init(void);
static void get_options(int argc, char *argv[]);
static void print_help(void);

/*!\fn static rrh_module_t new_module(unsigned int id);
* \brief creation of a eNB/UE module
* \param[in] module id
* \return module
* \note
* @ingroup  _oai
*/
static rrh_module_t new_module(unsigned int id);

129
/*!\fn static int get_address(char* if_name, uint8_t flag);
navid's avatar
navid committed
130 131 132 133 134 135
 * \brief retrieves IP address from the specified network interface
 * \param[in] name of network interface
 * \return 0 
 * \note
 * @ingroup  _oai
 */
136
static int get_address(char* if_name, uint8_t flag);
navid's avatar
navid committed
137 138 139 140 141 142 143





int main(int argc, char **argv) {
  
144
  unsigned int i;
Aikaterini Trilyraki's avatar
Aikaterini Trilyraki committed
145
  rf_config_file[0]='\0';
146 147 148 149
  /* parse input arguments */
  get_options(argc, argv);
  /* initialize logger and signal analyzer */
  debug_init();
150
  /* */
151
  set_latency_target();
navid's avatar
navid committed
152
  /* make a graceful exit when ctrl-c is pressed */
153 154
  signal(SIGSEGV, signal_handler);
  signal(SIGINT, signal_handler);
155
  
156
  /* create modules based on input arguments */
157
  if (eNB_flag==1){    
158
    enb_array=(rrh_module_t*)malloc(num_eNB_mod*sizeof(rrh_module_t));	
159 160
    for(i=0;i<num_eNB_mod;i++){  
      enb_array[i]=new_module(i);//enb_array[i]=new_module(i, get_RF_interfaces(&hardware_target));	
navid's avatar
navid committed
161
      config_BBU_mod(&enb_array[i],RT_flag,NRT_flag);
162
      LOG_I(RRH,"[eNB %d] module(s) created (out of %u) \n",i,num_eNB_mod);		
163 164
    }
  }
165
  if (UE_flag==1){    
166 167
    ue_array=(rrh_module_t*)malloc(num_UE_mod*sizeof(rrh_module_t));	
    for(i=0;i<num_UE_mod;i++){
168
      ue_array[i]=new_module(i);
navid's avatar
navid committed
169
      config_UE_mod(&ue_array[i],RT_flag,NRT_flag);			
170
      LOG_I(RRH,"[UE %d] module(s) created (out of %u)\n",i, num_UE_mod);
171 172
    }
  }
173
 
174 175 176 177 178 179 180 181 182
  printf("TYPE <CTRL-C> TO TERMINATE\n");
  
  while (rrh_exit==0)
    sleep(1);

  return EXIT_SUCCESS;
}


183
static rrh_module_t new_module (unsigned int id) {
184 185 186

  rrh_module_t 	  	rrh_mod;
  openair0_config_t 	openair0_cfg;
187

188 189 190
  rrh_mod.id=id;
  rrh_mod.loopback=loopback_flag;
  rrh_mod.measurements=measurements_flag;
191

192
  /* each module is associated with an ethernet device */
193 194
  rrh_mod.eth_dev.type=NONE_DEV;
  rrh_mod.eth_dev.transp_type=NONE_TP;
navid's avatar
navid committed
195
  /* ethernet device is functioning within RRH */
196 197 198 199
  rrh_mod.eth_dev.host_type=RRH_HOST;
  /* */
  rrh_mod.eth_dev.openair0_cfg = (openair0_config_t*)malloc(sizeof(openair0_config_t));
  memset(rrh_mod.eth_dev.openair0_cfg,0,sizeof(openair0_config_t));
200 201
  /* get IP and MAC address */
  get_address(if_name,eth_mode);
202
  
203 204 205 206 207 208 209 210 211 212
  if(eth_mode==ETH_UDP_MODE) {
    openair0_cfg.my_addr = &rrh_ip[0];
    openair0_cfg.my_port = rrh_port;
    LOG_I(RRH,"UDP mode selected for ethernet.\n");
  } else if (eth_mode==ETH_RAW_MODE) {
    openair0_cfg.my_addr = &rrh_mac[0];
    openair0_cfg.my_port = rrh_port;
    LOG_I(RRH,"RAW mode selected for ethernet.\n");
  } 

213 214 215 216 217
  /* */
  eth_params_t *eth_params = (eth_params_t*)malloc(sizeof(eth_params_t));
  memset(eth_params, 0, sizeof(eth_params_t));
  eth_params->local_if_name     = if_name;
  eth_params->transp_preference = eth_mode;
218

219
  /* ethernet device initialization */
220
  if (openair0_transport_load(&rrh_mod.eth_dev, &openair0_cfg,eth_params)<0) {
221 222 223
    LOG_E(RRH,"Exiting, cannot initialize ethernet interface.\n");
    exit(-1);
  }
navid's avatar
navid committed
224 225

  /* allocate space and specify associated RF device */
226
  openair0_device *oai_dv = (openair0_device *)malloc(sizeof(openair0_device));
227
  memset(oai_dv,0,sizeof(openair0_device));
228

229
  rrh_mod.devs=oai_dv;   
230 231 232 233
  rrh_mod.devs->type=NONE_DEV;
  rrh_mod.devs->transp_type=NONE_TP;
  rrh_mod.devs->host_type=RRH_HOST; 

234 235 236 237
  return rrh_mod;
}

static void debug_init(void) {
navid's avatar
navid committed
238
  
239
  /* log initialization */
240 241 242 243 244 245 246
  logInit();
  set_glog(glog_level,  glog_verbosity);
  
  set_comp_log(RRH,     rrh_log_level,   rrh_log_verbosity, 1);
  //set_comp_log(ENB_LOG, enb_log_level,   enb_log_verbosity, 1);
  //set_comp_log(UE_LOG,  ue_log_level,    ue_log_verbosity,  1);
  
247
  /* vcd initialization */
248
  if (ouput_vcd) {
249
    vcd_signal_dumper_init("/tmp/openair_dump_rrh.vcd");
250
    
navid's avatar
navid committed
251
  }
252
}
253

navid's avatar
navid committed
254

255 256 257 258
static void get_options(int argc, char *argv[]) {

  int 	opt;

Aikaterini Trilyraki's avatar
Aikaterini Trilyraki committed
259
  while ((opt = getopt(argc, argv, "xvhlte:n:u:g:r:m:i:f:")) != -1) {
260 261 262 263 264 265 266 267 268 269 270 271 272
    
    switch (opt) {
    case 'n':
      eNB_flag=1;
      num_eNB_mod=atoi(optarg);
      break;
    case 'u':
      UE_flag=1;
      num_UE_mod=atoi(optarg);
      break;
    case 'g':
      glog_level=atoi(optarg);
      break;
273 274 275 276 277 278
    case 'i':  
      if (optarg) {
	if_name=strdup(optarg); 
	printf("RRH interface name is set to %s\n", if_name);	
      }
      break;
279 280 281
    case 'm':  
      eth_mode=atoi(optarg);      
      break;
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
    case 'r':
      //rrh_log_level=atoi(optarg);
      break;
    case 'e':
      //enb_log_level=atoi(optarg);
      break;
    case 'x':
      rt_period = DEFAULT_PERIOD_NS;
      RT_flag=1;
      NRT_flag=0;
      break;
    case 'v':
      /* extern from vcd */
      ouput_vcd=1;  
      break;
    case 'l':
      /*In loopback mode rrh sends back to bbu what it receives*/
      loopback_flag=1; 
      break;
Aikaterini Trilyraki's avatar
Aikaterini Trilyraki committed
301 302 303 304 305 306 307 308
    case 'f':
      if (strlen(optarg)<=1024)
	strcpy(rf_config_file,optarg);
      else {
	printf("Configuration filename is too long\n");
	exit(-1);   
      }
      break;
309
    case 't':
310
      /* When measurements are enabled statistics related to TX/RX time are printed */
311
      measurements_flag=1; 
312 313 314 315
      break;      
    case 'h':
      print_help();
      exit(-1);
316 317 318 319 320 321
    default: /* '?' */
      //fprintf(stderr, "Usage: \n", argv[0]);
      exit(-1);
  }
}

322 323
}

324
static int get_address(char* if_name, uint8_t flag) {
325 326 327
  
  int fd;
  struct ifreq ifr;
328 329
    
  fd = socket(AF_INET, SOCK_DGRAM, 0);  
330
  /* I want to get an IPv4 IP address */
331
  ifr.ifr_addr.sa_family = AF_INET;  
navid's avatar
navid committed
332
  /* I want IP address attached to "if_name" */
333
  strncpy(ifr.ifr_name, if_name, IFNAMSIZ-1);
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

  if (flag==ETH_UDP_MODE) {
    if ( ioctl(fd, SIOCGIFADDR, &ifr)<0 ) {
      perror("IOCTL:");
      exit(-1);
    } 
    snprintf(&rrh_ip[0],20,"%s", inet_ntoa(((struct sockaddr_in *)&ifr.ifr_addr)->sin_addr));
    LOG_I(RRH,"%s: IP address: %s\n",if_name,rrh_ip);
  } else if (flag==ETH_RAW_MODE) {
    if ( ioctl(fd, SIOCGIFHWADDR, &ifr)<0 ) {
      perror("IOCTL:");
      exit(-1);
    } 
    ether_ntoa_r ((unsigned char *)ifr.ifr_hwaddr.sa_data, rrh_mac);
    LOG_I(RRH,"%s: MAC address: %s\n",if_name,rrh_mac);    
  }
navid's avatar
navid committed
350 351 352
  
  close(fd);
  return 0;
353
}
354

navid's avatar
navid committed
355

356 357 358
static void print_help(void) {

  puts("Usage: \n");
359
  puts("     sudo -E chrt 99 ./rrh -n1 -g6 -v -t -i lo -m1");
360 361 362 363
  puts("Options:\n");
  puts("\t -n create eNB module\n");
  puts("\t -u create UE module\n");
  puts("\t -g define global log level\n");
navid's avatar
navid committed
364
  puts("\t -i set the RRH interface (default lo)\n");
365
  puts("\t -m set ethernet mode to be used by RRH, valid options: (1:raw, 0:udp) \n");
366 367 368 369 370 371 372 373 374 375
  puts("\t -r define rrh log level\n");
  puts("\t -e define eNB log level\n");
  puts("\t -x enable real time bahaviour\n");
  puts("\t -v enable vcd dump\n");
  puts("\t -l enable loopback mode\n");
  puts("\t -t enable measurements\n");
  puts("\t -h display info\n");

}

376

navid's avatar
navid committed
377
void *timer_proc(void *arg) {
378

navid's avatar
navid committed
379 380 381
  timer_t             timerid;    
  struct itimerspec   *timer= (struct itimerspec *)arg ; // the timer data structure
  struct itimerspec   *old_value;
382

navid's avatar
navid committed
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
  
#ifdef LOWLATENCY
  struct sched_attr attr;
  unsigned int flags = 0;
  
  attr.size = sizeof(attr);
  attr.sched_flags = 0;
  attr.sched_nice = 0;
  attr.sched_priority = 0;
  
  attr.sched_policy   = SCHED_DEADLINE;
  attr.sched_runtime  =  (0.1  *  100) * 10000; // 
  attr.sched_deadline =  rt_period-30000;//(0.1  *  100) * 10000; 
  attr.sched_period   =  rt_period;//(0.1  *  100) * 10000; // each TX/RX thread has, as a function of RT PERIOD ?? 
  
  if (sched_setattr(0, &attr, flags) < 0 ) {
    perror("[SCHED] timer thread: sched_setattr failed\n");
    exit(-1);
  }
#endif  
  
 if (timer_create (CLOCK_REALTIME, NULL, &timerid) == -1) {
    fprintf (stderr, "couldn't create a timer\n");
    perror (NULL);
    exit (EXIT_FAILURE);
  }
  
  signal(SIGALRM, timer_signal_handler);
  LOG_I(RRH,"Timer has started!\n");
  timer_settime (timerid, 0, timer, old_value);
413

navid's avatar
navid committed
414 415 416 417 418 419 420
  while (!rrh_exit) {
    sleep(1);
  }
  
  timer_delete(timerid);
  
  return (0);
421 422 423
}


navid's avatar
navid committed
424
void timer_signal_handler(int sig) {
425
  
navid's avatar
navid committed
426 427 428 429 430 431 432
  if (sig == SIGALRM) {
    pthread_mutex_lock(&timer_mutex);
    hw_counter ++;
    pthread_mutex_unlock(&timer_mutex);
     VCD_SIGNAL_DUMPER_DUMP_VARIABLE_BY_NAME( VCD_SIGNAL_DUMPER_VARIABLES_CNT, hw_counter);//USED ELSEWHERE
  }
}
433

navid's avatar
navid committed
434 435

void signal_handler(int sig) {
436
  
navid's avatar
navid committed
437 438
  void *array[10];
  size_t size;
439
  
navid's avatar
navid committed
440 441 442 443 444 445 446
  if (sig==SIGSEGV) {
    // get void*'s for all entries on the stack
    size = backtrace(array, 10);
    
    // print out all the frames to stderr
    fprintf(stderr, "Error: signal %d:\n", sig);
    backtrace_symbols_fd(array, size, 2);
447
    exit(-1);
navid's avatar
navid committed
448 449 450
  } else {
    printf("trying to exit gracefully...\n");
    rrh_exit = 1;
451 452
  }
}
navid's avatar
navid committed
453 454 455 456 457 458 459 460 461 462

void exit_fun(const char* s) {
  if (s != NULL) {
    printf("%s %s() Exiting RRH: %s\n",__FILE__, __FUNCTION__, s);
  }
  rrh_exit = 1;
  exit (-1);
}