build_oai 25.6 KB
Newer Older
thomasl's avatar
thomasl committed
1 2 3
#!/bin/bash
################################################################################
#
4 5
# Copyright (c) 2015, EURECOM (www.eurecom.fr)
# All rights reserved.
thomasl's avatar
thomasl committed
6
#
7 8
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
thomasl's avatar
thomasl committed
9
#
10 11 12 13 14
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
thomasl's avatar
thomasl committed
15
#
16 17 18 19 20 21 22 23 24 25
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
thomasl's avatar
thomasl committed
26
#
27 28 29
# The views and conclusions contained in the software and documentation are those
# of the authors and should not be interpreted as representing official policies,
# either expressed or implied, of the FreeBSD Project.
thomasl's avatar
thomasl committed
30 31
#
################################################################################
32
# file build_oai
thomasl's avatar
thomasl committed
33 34 35 36 37 38 39
# brief OAI automated build tool that can be used to install, compile, run OAI.
# author  Navid Nikaein, Lionel GAUTHIER, Laurent Thomas


################################
# include helper functions
################################
thomasl's avatar
thomasl committed
40
ORIGIN_PATH=$PWD
thomasl's avatar
thomasl committed
41
THIS_SCRIPT_PATH=$(dirname $(readlink -f $0))
42
source $THIS_SCRIPT_PATH/tools/build_helper
thomasl's avatar
thomasl committed
43

44
MSC_GEN="False"
45
XFORMS="True"
46
PRINT_STATS="False"
thomasl's avatar
thomasl committed
47
VCD_TIMING="False"
Rohit Gupta's avatar
Rohit Gupta committed
48
LOWLATENCY_FLAG_USER="False"
49
FORCE_LOWLATENCY_FLAG_USER=""
thomasl's avatar
thomasl committed
50
REL="Rel10"
51
HW="None"
52
TP="None"
Florian Kaltenberger's avatar
Florian Kaltenberger committed
53
NOS1=0
gauthier's avatar
gauthier committed
54
EPC=0
55
VERBOSE_COMPILE=0
56
CFLAGS_PROCESSOR_USER=""
57 58
RUN_GROUP=0
TEST_CASE_GROUP=""
59
BUILD_DOXYGEN=0
60 61
trap handle_ctrl_c INT

62 63 64 65 66 67 68 69
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
70
   Erase all files to make a rebuild from start"
71
-C | --clean-all
gauthier's avatar
gauthier committed
72
   Erase all files made by previous compilations, installations"
73 74
--clean-kernel
   Erase previously installed features in kernel: iptables, drivers, ...
gauthier's avatar
gauthier committed
75
-I | --install-external-packages
76 77 78 79 80 81 82 83 84
   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
   Add debugging symbols to compilation directives
-h | --help
   Print this help
--eNB
85
   Makes the LTE softmodem
86
--UE
87
   Makes the UE specific parts (ue_ip, usim, nvram) 
88 89
--RRH
   Makes the RRH
90
-r | --3gpp-release
gauthier's avatar
gauthier committed
91
   default is Rel10,
92 93
   Rel8 limits the implementation to 3GPP Release 8 version
-w | --hardware
94
   EXMIMO, USRP, BLADERF, ETHERNET, LMSSDR, None (Default)
95
   Adds this RF board support (in external packages installation and in compilation)
96 97 98
-t | --transport protocol
   ETHERNET , None
   Adds this trasport protocol support in compilation
99
--oaisim
100
   Makes the oaisim simulator. Hardware will be defaulted to "None".
101 102 103 104 105 106
--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
107 108
--run-group 
   runs only specified test cases specified here. This flag is only valid with -s
109 110 111
-V | --vcd
   Adds a debgging facility to the binary files: GUI with major internal synchronization events
-x | --xforms
112
   Adds a software oscilloscope feature to the produced binaries. If oaisim, then enable PRINT_STATS.
113
--install-system-files
gauthier's avatar
gauthier committed
114
   Install OpenArInterface required files in Linux system
115
   (will ask root password)
116 117
--noS1 
   Compiles oaisim or lte-softmodem without S1 interface, using direct link to IP instead
118 119
--verbose-compile
   Shows detailed compilation instructions in makefile
120 121
--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
122 123
--build-doxygen
   Builds doxygen based documentation.
124
--disable-deadline
125 126 127
   Disables deadline scheduler of Linux kernel (>=3.14.x).
--enable-deadline
   Disables deadline scheduler of Linux kernel (>=3.14.x). 
128 129
Usage (first build):
 oaisim (eNB + UE): ./build_oai -I -g --oaisim -x --install-system-files
130 131
 Eurecom EXMIMO + COTS UE : ./build_oai -I -g --eNB -x --install-system-files
 NI/ETTUS B201  + COTS UE : ./build_oai -I -g --eNB -x --install-system-files -w USRP
132 133 134 135
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'
136 137 138 139 140 141
}


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

knopp's avatar
knopp committed
305
  echo_info "RF HW set to $HW" 
306 307 308 309 310 311 312 313 314 315 316 317 318
  #Now we set flags to enable deadline scheduler settings
  #By default: USRP: disable, 
  #By default: BLADERF: enable,
  #By default: EXMIMO: enable
  if [ "$FORCE_LOWLATENCY_FLAG_USER" = "" ]; then
     if [ "$HW" = "EXMIMO" ] ; then 
        LOWLATENCY_FLAG_USER="True"
     elif [ "$HW" = "ETHERNET" ] ; then 
        LOWLATENCY_FLAG_USER="True"
     elif [ "$HW" = "OAI_USRP" ] ; then 
        LOWLATENCY_FLAG_USER="False"
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
        LOWLATENCY_FLAG_USER="False"
319
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
knopp's avatar
knopp committed
320
        LOWLATENCY_FLAG_USER="False"
321 322 323 324 325 326 327 328 329 330 331 332
     elif [ "$HW" = "None" ] ; then 
        LOWLATENCY_FLAG_USER="False"
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
     LOWLATENCY_FLAG_USER=$FORCE_LOWLATENCY_FLAG_USER
  fi

  echo_info "Flags for Deadline scheduler: $LOWLATENCY_FLAG_USER"

333

334 335 336
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
337

338
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
339

gauthier's avatar
gauthier committed
340
  set_openair_env
341
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
342

343 344 345 346 347 348 349 350 351 352
  # 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
353

354

355 356 357 358
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
359

360 361 362 363 364 365 366
  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
367 368 369 370 371
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
372
      echo_info "installing packages for BLADERF support"
373 374
      check_install_bladerf_driver
    fi
375 376 377 378 379 380 381
  fi

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

382
  if [ "$oaisim" = "1" ] ; then
383 384 385 386 387
      #to be discussed
      # there is no RF device and no transport protocol 
      HW="None" 
      TP="None"
      
388 389 390 391 392 393
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
394 395 396
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
397 398 399 400 401 402 403
  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
404

405 406
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
407

408
    # LTE softmodem compilation
409 410 411 412 413 414 415
    [ "$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
416
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
417 418 419 420
    echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
421 422
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
423
    echo "set (LOWLATENCY \"${LOWLATENCY_FLAG_USER}\" )"    >>$cmake_file
424
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
425
    cd  $DIR/$lte_build_dir/build
426
    cmake ..
427 428
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
429
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
430
    echo_info "Compiling $lte_exec"
431
    compilations \
432 433 434 435 436 437 438 439 440 441 442 443
	  $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
444
  fi
thomasl's avatar
thomasl committed
445

Florian Kaltenberger's avatar
Florian Kaltenberger committed
446
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
447 448 449
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
450
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
451 452 453 454 455 456 457 458
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
      
#    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
459
    
gauthier's avatar
gauthier committed
460
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
461 462
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
463
    
464
    cmake ..
thomasl's avatar
thomasl committed
465
    compilations \
466 467
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
468
    compilations \
469 470 471 472 473 474 475 476 477
      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
478
  fi
thomasl's avatar
thomasl committed
479

480
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
481 482 483 484 485 486
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
487
  fi
488

489 490 491 492 493 494 495 496 497 498
  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
499

gauthier's avatar
gauthier committed
500
  # Core simulators
501 502 503 504 505 506 507 508 509 510 511
  #############
  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
512

513 514
  # EXMIMO drivers & firmware loader
  ###############
515
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
516
    
517 518
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
519
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
520
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
521
    compilations \
522
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
523
	  updatefw $dbin/updatefw
524 525 526 527 528 529 530
    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
531
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
532
  fi
thomasl's avatar
thomasl committed
533

534
  if [ "$oaisim" = "1" ] ; then
535
    dconf=$OPENAIR_DIR/targets/bin
536 537 538 539 540 541 542
      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
543
    
544 545 546
    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
547
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
548 549 550 551
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
    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
552
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
553 554 555
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
556 557
    cmake ..
    compilations \
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
	  $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
595 596
    else

597 598 599
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
600

601 602 603 604
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
605

606 607 608 609 610
	#oai_nw_drv
	compilations \
	    $oaisim_build_dir oai_nw_drv \
	    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
    fi
611

612 613 614 615 616 617
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
    echo "set(XFORMS $XFORMS )" >>  $cmake_file
    echo "set(RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
    echo "set(ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
618 619 620 621 622 623 624
    #[ "$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
625 626
  fi

627
  # RRH compilation
628
  #####################
629 630
  if [ "$RRH" = "1" ] ; then

631 632 633 634 635
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
636 637
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
638 639 640 641 642 643 644
     cmake_file=$DIR/$rrh_build_dir/CMakeLists.txt
     echo "cmake_minimum_required(VERSION 2.8)"   >   $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
645
     echo "set (LOWLATENCY \"${LOWLATENCY_FLAG_USER}\" )"    >>$cmake_file
646
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
647 648 649 650 651
     cd $DIR/$rrh_build_dir/build
     cmake ..
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
652

653
  fi
654 655 656 657 658 659 660 661 662 663 664 665
  
  # 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)
666
      if [ "$HW" != "None" ] ; then
667
	  rm -f liboai_device.so
668
	  rm -f $dbin/liboai_device.so
669 670


671
	  # link liboai_device.so with the selected RF device library
672
	  if [ "$HW" == "EXMIMO" ] ; then
673 674
	      
	      #add exmimo compilation
675 676
	      #TODO EXMIMO library support
	     
677 678
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
679 680 681 682 683 684
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

685
	      ln -s liboai_usrpdevif.so liboai_device.so
686
	      ln -s $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
687 688
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
689 690 691 692 693 694
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

695
	      ln -s liboai_bladerfdevif.so liboai_device.so
696
	      ln -s $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
697
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
698 699 700 701 702 703 704 705 706 707
	  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"	 
708 709 710 711 712 713
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
714
      if [ "$TP" != "None" ] ; then
715
	  rm -f liboai_transpro.so
716 717
	  rm -f $dbin/liboai_transpro.so

718
	  if [ "$TP" == "ETHERNET" ] ; then
719 720 721
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
722
	      ln -s liboai_eth_transpro.so liboai_transpro.so
723
	      ln -s $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
724 725 726 727 728
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

729

730 731 732 733 734 735 736 737 738 739 740
  # 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
741
    cmake ..
742 743
    make doc
    ) >& $doxygen_log
744 745
  fi

gauthier's avatar
gauthier committed
746 747 748
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
749
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
750 751 752 753
    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 "
754 755
    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 "
756
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
757 758 759
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
760 761
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
762
    if [ "$RUN_GROUP" -eq "1" ]; then
763
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
764
    else
765
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
766
    fi
767
    wait
gauthier's avatar
gauthier committed
768
  else
thomasl's avatar
thomasl committed
769
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
770
  fi
771 772 773
}

main "$@"