build_oai 28.3 KB
Newer Older
thomasl's avatar
thomasl committed
1
#!/bin/bash
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
#/*
# * 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
# */

23
# file build_oai
thomasl's avatar
thomasl committed
24 25 26
# brief OAI automated build tool that can be used to install, compile, run OAI.
# author  Navid Nikaein, Lionel GAUTHIER, Laurent Thomas

27
set -e
thomasl's avatar
thomasl committed
28 29 30 31

################################
# include helper functions
################################
thomasl's avatar
thomasl committed
32
ORIGIN_PATH=$PWD
thomasl's avatar
thomasl committed
33
THIS_SCRIPT_PATH=$(dirname $(readlink -f $0))
34
source $THIS_SCRIPT_PATH/tools/build_helper
thomasl's avatar
thomasl committed
35

36
MSC_GEN="False"
37
XFORMS="True"
38
FLEXRAN_AGENT_SB_IF="True"
39
PRINT_STATS="False"
thomasl's avatar
thomasl committed
40
VCD_TIMING="False"
laurent's avatar
laurent committed
41 42
DEADLINE_SCHEDULER_FLAG_USER="False"
FORCE_DEADLINE_SCHEDULER_FLAG_USER=""
43
CPU_AFFINITY_FLAG_USER="False" #Only valid when lowlatecy flag is set to False
thomasl's avatar
thomasl committed
44
REL="Rel10"
45
HW="None"
46
TP="None"
Florian Kaltenberger's avatar
Florian Kaltenberger committed
47
NOS1=0
gauthier's avatar
gauthier committed
48
EPC=0
49
VERBOSE_COMPILE=0
50
CFLAGS_PROCESSOR_USER=""
51 52
RUN_GROUP=0
TEST_CASE_GROUP=""
53
BUILD_DOXYGEN=0
54
T_TRACER="False"
55
DISABLE_HARDWARE_DEPENDENCY="False"
56
CMAKE_BUILD_TYPE=""
57 58
trap handle_ctrl_c INT

59 60 61 62 63 64 65 66
function print_help() {
  echo_info '
This program installs OpenAirInterface Software
You should have ubuntu 14.xx, updated, and the Linux kernel >= 3.14
Options
-h
   This help
-c | --clean
gauthier's avatar
gauthier committed
67
   Erase all files to make a rebuild from start"
68
-C | --clean-all
gauthier's avatar
gauthier committed
69
   Erase all files made by previous compilations, installations"
70 71
--clean-kernel
   Erase previously installed features in kernel: iptables, drivers, ...
gauthier's avatar
gauthier committed
72
-I | --install-external-packages
73 74 75 76 77
   Installs required packages such as LibXML, asn1.1 compiler, freediameter, ...
   This option will require root password
--install-optional-packages
   Install useful but not mandatory packages such as valgrind
-g | --run-with-gdb
78
   Add debugging symbols to compilation directives. It also disables any compiler optimization. Only for debugging. Do not use in normal operation!
79 80 81
-h | --help
   Print this help
--eNB
82
   Makes the LTE softmodem
83
--UE
84
   Makes the UE specific parts (ue_ip, usim, nvram) 
85 86
--RRH
   Makes the RRH
87 88
-a | --agent
   Enables agent for software-defined control of the eNB
89
-r | --3gpp-release
gauthier's avatar
gauthier committed
90
   default is Rel10,
91 92
   Rel8 limits the implementation to 3GPP Release 8 version
-w | --hardware
93
   EXMIMO, USRP, BLADERF, ETHERNET, LMSSDR, None (Default)
94
   Adds this RF board support (in external packages installation and in compilation)
95 96 97
-t | --transport protocol
   ETHERNET , None
   Adds this trasport protocol support in compilation
98
--oaisim
99
   Makes the oaisim simulator. Hardware will be defaulted to "None".
100 101 102 103 104 105
--phy_simulators
   Makes the unitary tests Layer 1 simulators
--core_simulators
   Makes the core security features unitary simulators
-s | --check
   runs a set of auto-tests based on simulators and several compilation tests
106 107
--run-group 
   runs only specified test cases specified here. This flag is only valid with -s
108 109 110
-V | --vcd
   Adds a debgging facility to the binary files: GUI with major internal synchronization events
-x | --xforms
111
   Adds a software oscilloscope feature to the produced binaries. If oaisim, then enable PRINT_STATS.
112
--install-system-files
gauthier's avatar
gauthier committed
113
   Install OpenArInterface required files in Linux system
114
   (will ask root password)
115 116
--noS1 
   Compiles oaisim or lte-softmodem without S1 interface, using direct link to IP instead
117 118
--verbose-compile
   Shows detailed compilation instructions in makefile
119 120
--cflags_processor
   Manually Add CFLAGS of processor if they are not detected correctly by script. Only add these flags if you know your processor supports them. Example flags: -msse3 -msse4.1 -msse4.2 -mavx2
121 122
--build-doxygen
   Builds doxygen based documentation.
123
--disable-deadline
124 125
   Disables deadline scheduler of Linux kernel (>=3.14.x).
--enable-deadline
laurent's avatar
laurent committed
126
   Enable deadline scheduler of Linux kernel (>=3.14.x). 
127
--disable-cpu-affinity
128
   Disables CPU Affinity between UHD/TX/RX Threads (Valid only when deadline scheduler is disabled). By defaulT, CPU Affinity is enabled when not using deadline scheduler. It is enabled only with >2 CPUs. For eNB, CPU_0-> Device library (UHD), CPU_1->TX Threads, CPU_2...CPU_MAX->Rx Threads. For UE, CPU_0->Device Library(UHD), CPU_1..CPU_MAX -> All the UE threads
129 130
--T-tracer
   Enables the T tracer.
131 132
--disable-hardware-dependency
   Disable HW dependency during installation
133
Usage (first build):
134 135 136
 oaisim (eNB + UE): ./build_oai -I  --oaisim -x --install-system-files
 Eurecom EXMIMO + COTS UE : ./build_oai -I  --eNB -x --install-system-files
 NI/ETTUS B201  + COTS UE : ./build_oai -I  --eNB -x --install-system-files -w USRP
137 138 139 140
Usage (Regular):
 oaisim : ./build_oai --oaisim -x 
 Eurecom EXMIMO + OAI ENB : ./build_oai --eNB -x 
 NI/ETTUS B201  + OAI ENB : ./build_oai --eNB -x -w USRP'
141 142 143 144 145 146
}


function main() {
  until [ -z "$1" ]
  do
147
    case "$1" in
148 149 150 151 152
       -c | --clean)
            CLEAN=1
            shift;;
       -C | --clean-all)
            CLEAN_ALL=1
thomasl's avatar
thomasl committed
153
            shift;;
154 155 156
       --clean-kernel)
            clean_kernel
            echo_info "Erased iptables config and removed modules from kernel"
thomasl's avatar
thomasl committed
157
            shift;;
158
       -I | --install-external-packages)
159
            INSTALL_EXTERNAL=1
160
            echo_info "Will install external packages"
thomasl's avatar
thomasl committed
161
            shift;;
162
       --install-optional-packages)
163 164 165
            INSTALL_OPTIONAL=1
            echo_info "Will install optional packages"
            shift;;
166
       -g | --run-with-gdb)
thomasl's avatar
thomasl committed
167
            GDB=1
168 169
            CMAKE_BUILD_TYPE="Debug"
            echo_info "Will Compile with gdb symbols and disable compiler optimization"
thomasl's avatar
thomasl committed
170
            shift;;
171 172 173 174
       --eNB)
            eNB=1
            echo_info "Will compile eNB"
            shift;;
175 176 177 178
       -a | --agent)
	    FLEXRAN_AGENT=1
	    echo_info "Will compile eNB with agent support"
	    shift;;
179 180 181 182
       --UE)
            UE=1
            echo_info "Will compile UE"
            shift;;
183 184 185 186
       --RRH)
            RRH=1
            echo_info "Will compile RRH"
            shift;;
thomasl's avatar
thomasl committed
187
       -r | --3gpp-release)
gauthier's avatar
gauthier committed
188
            REL=$2
189
            echo_info "Setting release to: $REL"
thomasl's avatar
thomasl committed
190 191 192
            shift 2;;
       -w | --hardware)
            HW="$2" #"${i#*=}"
193
            # Use OAI_USRP  as the key word USRP is used inside UHD driver           
194
	    if [ "$HW" != "BLADERF" -a  "$HW" != "USRP" -a "$HW" != "LMSSDR" -a  "$HW" != "None" -a  "$HW" != "EXMIMO"  ] ; then 
195 196 197 198 199 200 201 202
		echo_fatal "Unknown HW type $HW will exit..."		
	    else
		if [ "$HW" == "USRP" ] ; then 
		    HW="OAI_USRP"
		fi 
		if [ "$HW" == "BLADERF" ] ; then 
		    HW="OAI_BLADERF"
		fi
203 204 205
		if [ "$HW" == "LMSSDR" ] ; then 
		    HW="OAI_LMSSDR"
		fi 
206 207
		echo_info "Setting hardware to: $HW"
	    fi
thomasl's avatar
thomasl committed
208
            shift 2;;
209 210
	-t | --transport_protocol)
            TP="$2" #"${i#*=}"
211 212 213 214 215
	    if [ "$TP" != "ETHERNET" -a "$TP" != "None" ] ; then 
		echo_fatal "Unknown TP type $TP will exit..."		
	    else
		echo_info "Setting transport protocol to: $TP"		
	    fi
thomasl's avatar
thomasl committed
216
            shift 2;;
217
	--oaisim)
218 219 220 221
            oaisim=1
            echo_info "Will compile oaisim and drivers nasmesh, ..."
            shift;;
       --phy_simulators)
thomasl's avatar
thomasl committed
222
            SIMUS_PHY=1
223 224 225 226 227 228
            echo_info "Will compile dlsim, ulsim, ..."
            shift;;
       --core_simulators)
            SIMUS_CORE=1
            echo_info "Will compile security unitary tests"
            shift;;
thomasl's avatar
thomasl committed
229 230
       -s | --check)
            OAI_TEST=1
231
            echo_info "Will run auto-tests"
thomasl's avatar
thomasl committed
232
            shift;;
233 234 235 236 237
       --run-group)
            RUN_GROUP=1
            TEST_CASE_GROUP=$2
            echo_info "executing test cases only in group: $TEST_CASE_GROUP"
            shift 2;;
thomasl's avatar
thomasl committed
238
       -V | --vcd)
239
            echo_info "Setting gtk-wave output"
thomasl's avatar
thomasl committed
240 241
            VCD_TIMING=1
            EXE_ARGUMENTS="$EXE_ARGUMENTS -V"
thomasl's avatar
thomasl committed
242
            shift;;
thomasl's avatar
thomasl committed
243
       -x | --xforms)
244
            XFORMS="True"
thomasl's avatar
thomasl committed
245
            EXE_ARGUMENTS="$EXE_ARGUMENTS -d"
246
            echo_info "Will generate the software oscilloscope features"
thomasl's avatar
thomasl committed
247
            shift;;
248 249 250 251
       --install-system-files)
            INSTALL_SYSTEM_FILES=1
            echo_info "Will copy OpenAirInterface files in Linux directories"
            shift;;
252 253 254 255
       --noS1)
	    NOS1=1
            echo_info "Will compile without S1 interface"
            shift;;
256 257 258 259
       --verbose-compile)
	    VERBOSE_COMPILE=1
            echo_info "Will compile with verbose instructions"
            shift;;
260 261
       --cflags_processor)
            CFLAGS_PROCESSOR_USER=$2
262
            echo_info "Setting CPU FLAGS from USER to: $CFLAGS_PROCESSOR_USER"
263
            shift 2;;
264 265 266 267
       --build-doxygen)
	    BUILD_DOXYGEN=1
            echo_info "Will build doxygen support"
            shift;;     
268
       --disable-deadline)
laurent's avatar
laurent committed
269
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="False"
270 271
            echo_info "Disabling the usage of deadline scheduler"
            shift 1;;
272
       --enable-deadline)
laurent's avatar
laurent committed
273
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="True"
274 275
            echo_info "Enabling the usage of deadline scheduler"
            shift 1;;
276 277 278 279
       --disable-cpu-affinity)
            CPU_AFFINITY_FLAG_USER="False"
            echo_info "Disabling CPU Affinity (only valid when not using deadline scheduler)"
            shift 1;;
280 281 282 283
       --T-tracer)
            T_TRACER="True"
            echo_info "Enabling the T tracer"
            shift 1;;
284 285 286 287
       --disable-hardware-dependency)
            echo_info "Disabling hardware dependency for compiling software"
            DISABLE_HARDWARE_DEPENDENCY="True"
            shift 1;;
thomasl's avatar
thomasl committed
288 289 290
        -h | --help)
            print_help
            exit 1;;
gauthier's avatar
gauthier committed
291
	*)
292 293
	    print_help
            echo_fatal "Unknown option $1"
thomasl's avatar
thomasl committed
294
            break;;
thomasl's avatar
thomasl committed
295
   esac
296
  done
297
  
298
  #########################################################
299
  # check validity of HW and TP parameters for RRH and eNB
300
  #########################################################
301
  # to be discussed
302
  
303
  if [ "$eNB" = "1" ] ; then
304 305
      if [ "$HW" = "None" -a  "$TP" = "None" ] ; then
	  echo_fatal "Define a local radio head (e.g. -w EXMIMO) or a transport protocol (e.g. -t ETHERNET) to communicate with a remote radio head!"
306
      fi
307 308
      if [ "$HW" = "None" ] ; then 
	  echo_info "No radio head has been selected (HW set to $HW)"	
309
      fi
310 311
      if [ "$TP" = "None" ] ; then
	  echo_info "No transport protocol has been selected (TP set to $TP)"	
312 313 314 315
      fi
  fi
  
  if [ "$RRH" = "1" ] ; then
316 317
      if [ "$TP" = "None" ] ; then
	  echo_fatal "A transport protocol (e.g. -t ETHERNET) must be defined!"
318
      fi
319 320
      if [ "$HW" = "None" ] ; then
	  echo_info "No radio head has been selected (HW set to $HW)"	
321 322
      fi
  fi
thomasl's avatar
thomasl committed
323

324
  echo_info "RF HW set to $HW" 
325 326 327 328
  #Now we set flags to enable deadline scheduler settings
  #By default: USRP: disable, 
  #By default: BLADERF: enable,
  #By default: EXMIMO: enable
laurent's avatar
laurent committed
329
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
330
     if [ "$HW" = "EXMIMO" ] ; then 
331
        DEADLINE_SCHEDULER_FLAG_USER="True"
332
     elif [ "$HW" = "ETHERNET" ] ; then 
333
        DEADLINE_SCHEDULER_FLAG_USER="False"
334
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
335
        DEADLINE_SCHEDULER_FLAG_USER="False"
336
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
337
        DEADLINE_SCHEDULER_FLAG_USER="False"
338
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
339
        DEADLINE_SCHEDULER_FLAG_USER="False"
340
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
341
        DEADLINE_SCHEDULER_FLAG_USER="False"
342 343 344 345 346
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
347
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
348 349
  fi

350
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
351
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
352 353
     CPU_AFFINITY_FLAG_USER="False"
  fi
354

laurent's avatar
laurent committed
355
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
356
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
357

358 359 360
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
361

362
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
363

gauthier's avatar
gauthier committed
364
  set_openair_env
365
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
366

367 368 369 370 371 372 373 374 375 376
  # for conf files copy in this bash script
  if [ -d /usr/lib/freeDiameter ]; then
    export FREEDIAMETER_PREFIX=/usr
  else
    if [ -d /usr/local/lib/freeDiameter ]; then
      export FREEDIAMETER_PREFIX=/usr/local
    else
      echo_warning "FreeDiameter prefix not found, install freeDiameter if EPC, HSS"
    fi
  fi
thomasl's avatar
thomasl committed
377

378

379 380 381 382
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
383

384 385 386 387 388 389 390
  dbin=$OPENAIR_DIR/targets/bin
  dlog=$OPENAIR_DIR/cmake_targets/log
  mkdir -p $dbin $dlog

  if [ "$INSTALL_EXTERNAL" = "1" ] ; then
    echo_info "Installing packages"
    check_install_oai_software
391 392 393
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
394 395 396
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        install_usrp_uhd_driver
      fi
397 398
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
399
      echo_info "installing packages for BLADERF support"
400
      check_install_bladerf_driver
401 402 403
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
404
    fi
405 406 407 408 409 410 411
  fi

  if [ "$INSTALL_OPTIONAL" = "1" ] ; then
    echo_info "Installing optional packages"
    check_install_additional_tools
  fi

412
  if [ "$oaisim" = "1" ] ; then
413 414 415 416 417
      #to be discussed
      # there is no RF device and no transport protocol 
      HW="None" 
      TP="None"
      
418 419 420 421 422 423
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
424 425 426
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
427 428 429 430 431 432 433
  if [ "$NOS1" =  "1" ] ; then
      lte_build_dir=lte_noS1_build_oai
      lte_exec=lte-softmodem-nos1
  else
      lte_build_dir=lte_build_oai
      lte_exec=lte-softmodem
  fi
434

435 436
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
437

438
    # LTE softmodem compilation
439 440 441 442 443 444 445
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$lte_build_dir/build
    mkdir -p $DIR/$lte_build_dir/build
    cmake_file=$DIR/$lte_build_dir/CMakeLists.txt
    echo "cmake_minimum_required(VERSION 2.8)"   >  $cmake_file
    if [ "$NOS1" = "1" ] ; then
	cat  $DIR/$lte_build_dir/CMakeLists.template >>  $cmake_file
    fi
446
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
447
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
448
    echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
449 450 451
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
452 453 454
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
455 456
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
457
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
458
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
459
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
460
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
461
    cd  $DIR/$lte_build_dir/build
462
    cmake ..
463 464
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
465
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
466
    echo_info "Compiling $lte_exec"
467
    compilations \
468 469 470 471 472 473 474 475 476 477 478 479
	  $lte_build_dir $lte_exec \
	  $lte_exec $dbin/$lte_exec.$REL

    if [ "$NOS1" = "1" ] ; then
	compilations \
	    $lte_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
	compilations \
	    $lte_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
	cp $OPENAIR_DIR/cmake_targets/tools/init_nas_nos1 $dbin
    fi
480
  fi
481

Florian Kaltenberger's avatar
Florian Kaltenberger committed
482
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
483 484 485
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
486
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
487
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
488

gauthier's avatar
gauthier committed
489 490 491 492 493 494
#    mkdir -p $DIR/at_commands/build
#    cd $DIR/at_commands/build
#    cmake ..
#    compilations \
#      at_commands at_nas_ue \
#      at_nas_ue $dbin/at_nas_ue
495
    
gauthier's avatar
gauthier committed
496
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
497 498
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
499
    
500
    cmake ..
thomasl's avatar
thomasl committed
501
    compilations \
502 503
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
504
    compilations \
505 506 507 508 509 510
      nas_sim_tools nvram \
      nvram $dbin/nvram

    # generate USIM data
    if [ -f $dbin/nvram ]; then
      install_nas_tools $dbin $dconf
511 512 513 514 515
      echo_info "Copying UE specific part to $DIR/$lte_build_dir/build"
      cp -Rvf $dbin/.ue_emm.nvram $DIR/$lte_build_dir/build
      cp -Rvf $dbin/.ue.nvram $DIR/$lte_build_dir/build
      cp -Rvf $dbin/.usim.nvram $DIR/$lte_build_dir/build

516 517 518
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
519
  fi
thomasl's avatar
thomasl committed
520

521
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
522 523 524 525 526 527
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
528
  fi
529

530 531 532 533 534 535 536 537 538 539
  if [ "$SIMUS_PHY" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
    simlist="dlsim ulsim pucchsim prachsim pdcchsim pbchsim mbmssim"
    for f in $simlist ; do
      compilations \
      lte-simulators $f \
	  $f $dbin/$f.$REL
    done
  fi
thomasl's avatar
thomasl committed
540

gauthier's avatar
gauthier committed
541
  # Core simulators
542 543 544 545 546 547 548 549 550 551 552
  #############
  if [ "$SIMUS_CORE" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
    simlist="secu_knas_encrypt_eia1 secu_kenb aes128_ctr_encrypt aes128_ctr_decrypt secu_knas_encrypt_eea2 secu_knas secu_knas_encrypt_eea1 kdf aes128_cmac_encrypt secu_knas_encrypt_eia2"
    for f in $simlist ; do
      compilations \
	  lte-simulators test_$f \
	  test_$f $dbin/test_$f.$REL
    done
  fi
thomasl's avatar
thomasl committed
553

554 555
  # EXMIMO drivers & firmware loader
  ###############
556
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
557
    
558 559
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
560
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
561
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
562
    compilations \
563
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
564
	  updatefw $dbin/updatefw
565
    echo_info "Compiling oarf tools. The logfile for compilation is here: $dlog/oarf.txt"
566 567 568 569 570 571 572
    make -C $OPENAIR_DIR/cmake_targets/$lte_build_dir/build oarf > $dlog/oarf.txt 2>&1
    cp $OPENAIR_DIR/cmake_targets/$lte_build_dir/build/*.oct $dbin
    if [ -s $dbin/oarf_config_exmimo.oct ] ; then
	echo_success "oarf tools compiled"
    else
	echo_error "oarf tools compilation failed"
    fi
573
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
574
  fi
thomasl's avatar
thomasl committed
575

576 577
  # oaisim compilation
  ###############
578
  if [ "$oaisim" = "1" ] ; then
579
    dconf=$OPENAIR_DIR/targets/bin
580 581 582 583 584 585 586
      if [ "$NOS1" =  "1" ] ; then
	  oaisim_build_dir=oaisim_noS1_build_oai
	  oaisim_exec=oaisim_nos1
      else
	  oaisim_build_dir=oaisim_build_oai
	  oaisim_exec=oaisim
      fi
587
    
588 589 590
    echo_info "Compiling $oaisim_exec ($oaisim_build_dir)"
    cmake_file=$DIR/$oaisim_build_dir/CMakeLists.txt
    cp $DIR/$oaisim_build_dir/CMakeLists.template $cmake_file
591
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
592
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
593
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
594 595 596
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
597 598 599
    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
600
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
601
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
602 603 604
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
605 606
    cmake ..
    compilations \
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
	  $oaisim_build_dir $oaisim_exec \
	  $oaisim_exec $dbin/$oaisim_exec.$REL

    if [ "$NOS1" != "1" ] ; then

	[ "$CLEAN" = "1" ] && rm -rf $DIR/at_commands/build
    	echo_info "Compiling at_nas_ue"
	mkdir -p $DIR/at_commands/build
	cd $DIR/at_commands/build
	cmake ..
	compilations \
	    at_commands at_nas_ue \
	    at_nas_ue $dbin/at_nas_ue

	# ue_ip driver compilation
	echo_info "Compiling UE specific part (ue_ip driver and usim tools)"
	compilations \
	    oaisim_build_oai ue_ip \
	    CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko

	[ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
	mkdir -p $DIR/nas_sim_tools/build
	cd $DIR/nas_sim_tools/build
	cmake ..
	compilations \
	    nas_sim_tools usim \
	    usim $dbin/usim
	compilations \
	    nas_sim_tools nvram \
	    nvram $dbin/nvram

	# generate USIM data
	if [ -f $dbin/nvram ]; then
	    install_nas_tools $dbin $dconf
	else
	    echo_warning "not generated UE NAS files: binaries not found"
	fi
644 645
    else

646 647 648
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
649

650 651 652 653
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
654

655 656 657 658 659
	#oai_nw_drv
	compilations \
	    $oaisim_build_dir oai_nw_drv \
	    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
    fi
660

661 662
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
663 664
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
665 666 667
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
668 669
    echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
670
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
671
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
672 673 674 675 676 677 678
    #[ "$CLEAN" = "1" ] && rm -rf $DIR/oaisim_mme_build_oai/build
    #mkdir -p $DIR/oaisim_mme_build_oai/build
    #cd $DIR/oaisim_mme_build_oai/build
    #cmake ..
    #compilations \
	#  oaisim_mme_build_oai oaisim_mme \
	#  oaisim_mme $dbin/oaisim_mme.$REL
679 680
  fi

681
  # RRH compilation
682
  #####################
683 684
  if [ "$RRH" = "1" ] ; then

685 686 687 688 689
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
690 691
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
692 693
     cmake_file=$DIR/$rrh_build_dir/CMakeLists.txt
     echo "cmake_minimum_required(VERSION 2.8)"   >   $cmake_file
694 695 696 697 698 699 700 701
     echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
     echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
     echo "set ( ENABLE_ITTI False )"     		 >>  $cmake_file
     echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
     echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
     echo 'set ( PACKAGE_NAME "\"rrh_gw\"")'        >>  $cmake_file
     echo "set ( DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
     echo "set ( CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"    >>$cmake_file
702
     echo "set ( T_TRACER $T_TRACER )"            >>  $cmake_file
703
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
704 705 706 707 708
     cd $DIR/$rrh_build_dir/build
     cmake ..
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
709

710
  fi
711 712 713 714 715 716 717 718 719 720 721 722
  
  # build RF device and transport protocol libraries
  #####################################
  if [ "$eNB" = "1" -o  "$RRH" = "1" ] ; then

      if [ "$eNB" = "1" ] ; then
	  build_dir=$lte_build_dir	  
      else
	  build_dir=$rrh_build_dir	 
      fi

      # build RF device libraries (currently EXMIMO is not complied with the rest of HW targets)
723
      if [ "$HW" != "None" ] ; then
724
	  rm -f liboai_device.so
725
	  rm -f $dbin/liboai_device.so
726 727


728
	  # link liboai_device.so with the selected RF device library
729
	  if [ "$HW" == "EXMIMO" ] ; then
730 731
	      
	      #add exmimo compilation
732
	      #TODO EXMIMO library support
733 734 735
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
736 737
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
738 739 740 741 742 743
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

744
	      ln -s liboai_usrpdevif.so liboai_device.so
745
	      ln -s $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
746 747
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
748 749 750 751 752 753
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

754
	      ln -s liboai_bladerfdevif.so liboai_device.so
755
	      ln -s $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
756
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
757 758 759 760 761 762 763 764 765 766
	  elif [ "$HW" == "OAI_LMSSDR" ] ; then
#	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_lmssdrdevif \
		      liboai_lmssdrdevif.so $dbin/liboai_lmssdrdevif.so.$REL
#	      fi

	      ln -s liboai_lmssdrdevif.so liboai_device.so
	      ln -s $dbin/liboai_lmssdrdevif.so.$REL $dbin/liboai_device.so
	      echo_info "liboai_device.so is linked to LMSSDR device library"	 
767 768 769 770 771 772
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
773
      if [ "$TP" != "None" ] ; then
774
	  rm -f liboai_transpro.so
775 776
	  rm -f $dbin/liboai_transpro.so

777
	  if [ "$TP" == "ETHERNET" ] ; then
778 779 780
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
781
	      ln -s liboai_eth_transpro.so liboai_transpro.so
782
	      ln -s $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
783 784 785 786 787
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

788

789 790 791 792 793 794 795 796 797 798 799
  # Doxygen Support
  #####################
  if [ "$BUILD_DOXYGEN" = "1" ] ;then
    doxygen_log=$OPENAIR_DIR/cmake_targets/log/doxygen.log
    echo_info "Building doxygen based documentation. The documentation file is located here: $OPENAIR_DIR/targets/DOCS/html/index.html"
    echo_info "Doxygen Generation log is located here: $doxygen_log"
    echo_info "Generating doxygen files....please wait"
    (
    [ "$CLEAN" = "1" ] && rm -rf $OPENAIR_DIR/cmake_targets/doxygen/build
    mkdir -p $OPENAIR_DIR/cmake_targets/doxygen/build
    cd $OPENAIR_DIR/cmake_targets/doxygen/build
800
    cmake ..
801 802
    make doc
    ) >& $doxygen_log
803 804
  fi

gauthier's avatar
gauthier committed
805 806 807
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
808
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
809 810 811 812
    echo_error "These scripts ASSUME that user is in /etc/sudoers and can execute commands without PASSWORD prompt"
    echo_error "Add the following lines in /etc/sudoers file to make your __user_name__ sudo without password prompt"
    echo_error " __your_user_name__ ALL = (ALL:ALL) NOPASSWD: ALL"
    echo_error " __your_user_name__ ALL = (ALL) NOPASSWD: ALL "
813 814
    echo_info "The log file for the autotest script for debugging is located here: $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log "
    echo_info "The results of autotests results is located here: $OPENAIR_DIR/cmake_targets/autotests/log/results_autotests.xml "
815
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
816 817 818
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
819 820
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
821
    if [ "$RUN_GROUP" -eq "1" ]; then
822
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
823
    else
824
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
825
    fi
826
    wait
gauthier's avatar
gauthier committed
827
  else
thomasl's avatar
thomasl committed
828
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
829
  fi
830 831 832
}

main "$@"