build_oai 26.8 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=""
50
CPU_AFFINITY_FLAG_USER="True" #Only valid when lowlatecy flag is set to False
thomasl's avatar
thomasl committed
51
REL="Rel10"
52
HW="None"
53
TP="None"
Florian Kaltenberger's avatar
Florian Kaltenberger committed
54
NOS1=0
gauthier's avatar
gauthier committed
55
EPC=0
56
VERBOSE_COMPILE=0
57
CFLAGS_PROCESSOR_USER=""
58 59
RUN_GROUP=0
TEST_CASE_GROUP=""
60
BUILD_DOXYGEN=0
61 62
trap handle_ctrl_c INT

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


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

312
  echo_info "RF HW set to $HW" 
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 
319
        LOWLATENCY_FLAG_USER="False"
320 321 322 323 324 325
     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"
326
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
327
        LOWLATENCY_FLAG_USER="False"
328 329 330 331 332 333 334 335 336 337
     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

338 339 340 341
  #Disable CPU Affinity for deadline scheduler
  if [ "$LOWLATENCY_FLAG_USER" = "True" ] ; then 
     CPU_AFFINITY_FLAG_USER="False"
  fi
342

343 344
  echo_info "Flags for Deadline scheduler: $LOWLATENCY_FLAG_USER"
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
345

346 347 348
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
349

350
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
351

gauthier's avatar
gauthier committed
352
  set_openair_env
353
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
354

355 356 357 358 359 360 361 362 363 364
  # 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
365

366

367 368 369 370
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
371

372 373 374 375 376 377 378
  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
379 380 381 382 383
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
384
      echo_info "installing packages for BLADERF support"
385 386
      check_install_bladerf_driver
    fi
387 388 389 390 391 392 393
  fi

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

394
  if [ "$oaisim" = "1" ] ; then
395 396 397 398 399
      #to be discussed
      # there is no RF device and no transport protocol 
      HW="None" 
      TP="None"
      
400 401 402 403 404 405
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
406 407 408
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
409 410 411 412 413 414 415
  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
416

417 418
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
419

420
    # LTE softmodem compilation
421 422 423 424 425 426 427
    [ "$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
428
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
429 430 431 432
    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
433 434
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
435
    echo "set (LOWLATENCY \"${LOWLATENCY_FLAG_USER}\" )"    >>$cmake_file
436
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
437
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
438
    cd  $DIR/$lte_build_dir/build
439
    cmake ..
440 441
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
442
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
443
    echo_info "Compiling $lte_exec"
444
    compilations \
445 446 447 448 449 450 451 452 453 454 455 456
	  $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
457
  fi
458

Florian Kaltenberger's avatar
Florian Kaltenberger committed
459
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
460 461 462
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
463
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
464
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
465

gauthier's avatar
gauthier committed
466 467 468 469 470 471
#    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
472
    
gauthier's avatar
gauthier committed
473
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
474 475
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
476
    
477
    cmake ..
thomasl's avatar
thomasl committed
478
    compilations \
479 480
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
481
    compilations \
482 483 484 485 486 487
      nas_sim_tools nvram \
      nvram $dbin/nvram

    # generate USIM data
    if [ -f $dbin/nvram ]; then
      install_nas_tools $dbin $dconf
488 489 490 491 492
      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

493 494 495
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
496
  fi
thomasl's avatar
thomasl committed
497

498
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
499 500 501 502 503 504
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
505
  fi
506

507 508 509 510 511 512 513 514 515 516
  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
517

gauthier's avatar
gauthier committed
518
  # Core simulators
519 520 521 522 523 524 525 526 527 528 529
  #############
  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
530

531 532
  # EXMIMO drivers & firmware loader
  ###############
533
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
534
    
535 536
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
537
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
538
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
539
    compilations \
540
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
541
	  updatefw $dbin/updatefw
542 543 544 545 546 547 548
    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
549
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
550
  fi
thomasl's avatar
thomasl committed
551

552
  if [ "$oaisim" = "1" ] ; then
553
    dconf=$OPENAIR_DIR/targets/bin
554 555 556 557 558 559 560
      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
561
    
562 563 564
    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
565
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
566 567 568 569
    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
570
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
571 572 573
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
574 575
    cmake ..
    compilations \
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
	  $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
613 614
    else

615 616 617
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
618

619 620 621 622
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
623

624 625 626 627 628
	#oai_nw_drv
	compilations \
	    $oaisim_build_dir oai_nw_drv \
	    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
    fi
629

630 631 632 633 634 635
    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
636 637 638 639 640 641 642
    #[ "$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
643 644
  fi

645
  # RRH compilation
646
  #####################
647 648
  if [ "$RRH" = "1" ] ; then

649 650 651 652 653
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
654 655
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
656 657 658 659 660 661 662
     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
663
     echo "set (LOWLATENCY \"${LOWLATENCY_FLAG_USER}\" )"    >>$cmake_file
664
     echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"    >>$cmake_file
665
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
666 667 668 669 670
     cd $DIR/$rrh_build_dir/build
     cmake ..
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
671

672
  fi
673 674 675 676 677 678 679 680 681 682 683 684
  
  # 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)
685
      if [ "$HW" != "None" ] ; then
686
	  rm -f liboai_device.so
687
	  rm -f $dbin/liboai_device.so
688 689


690
	  # link liboai_device.so with the selected RF device library
691
	  if [ "$HW" == "EXMIMO" ] ; then
692 693
	      
	      #add exmimo compilation
694 695
	      #TODO EXMIMO library support
	     
696 697
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
698 699 700 701 702 703
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

704
	      ln -s liboai_usrpdevif.so liboai_device.so
705
	      ln -s $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
706 707
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
708 709 710 711 712 713
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

714
	      ln -s liboai_bladerfdevif.so liboai_device.so
715
	      ln -s $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
716
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
717 718 719 720 721 722 723 724 725 726
	  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"	 
727 728 729 730 731 732
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
733
      if [ "$TP" != "None" ] ; then
734
	  rm -f liboai_transpro.so
735 736
	  rm -f $dbin/liboai_transpro.so

737
	  if [ "$TP" == "ETHERNET" ] ; then
738 739 740
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
741
	      ln -s liboai_eth_transpro.so liboai_transpro.so
742
	      ln -s $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
743 744 745 746 747
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

748

749 750 751 752 753 754 755 756 757 758 759
  # 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
760
    cmake ..
761 762
    make doc
    ) >& $doxygen_log
763 764
  fi

gauthier's avatar
gauthier committed
765 766 767
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
768
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
769 770 771 772
    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 "
773 774
    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 "
775
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
776 777 778
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
779 780
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
781
    if [ "$RUN_GROUP" -eq "1" ]; then
782
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
783
    else
784
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
785
    fi
786
    wait
gauthier's avatar
gauthier committed
787
  else
thomasl's avatar
thomasl committed
788
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
789
  fi
790 791 792
}

main "$@"