build_oai 27.4 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
# brief OAI automated build tool that can be used to install, compile, run OAI.
# author  Navid Nikaein, Lionel GAUTHIER, Laurent Thomas

FredericLeroy's avatar
FredericLeroy committed
36
set -e
thomasl's avatar
thomasl committed
37 38 39 40

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

45
MSC_GEN="False"
46
XFORMS="True"
47
PRINT_STATS="False"
thomasl's avatar
thomasl committed
48
VCD_TIMING="False"
laurent's avatar
laurent committed
49 50
DEADLINE_SCHEDULER_FLAG_USER="False"
FORCE_DEADLINE_SCHEDULER_FLAG_USER=""
Rohit Gupta's avatar
Rohit Gupta committed
51
CPU_AFFINITY_FLAG_USER="True" #Only valid when lowlatecy flag is set to False
thomasl's avatar
thomasl committed
52
REL="Rel10"
53
HW="None"
54
TP="None"
Florian Kaltenberger's avatar
Florian Kaltenberger committed
55
NOS1=0
gauthier's avatar
gauthier committed
56
EPC=0
57
VERBOSE_COMPILE=0
58
CFLAGS_PROCESSOR_USER=""
59 60
RUN_GROUP=0
TEST_CASE_GROUP=""
61
BUILD_DOXYGEN=0
62
T_TRACER="False"
63 64
trap handle_ctrl_c INT

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


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

knopp's avatar
knopp committed
320
  echo_info "RF HW set to $HW" 
321 322 323 324
  #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
325
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
326
     if [ "$HW" = "EXMIMO" ] ; then 
laurent's avatar
laurent committed
327
        DEADLINE_SCHEDULER_FLAG_USER="False"
328
     elif [ "$HW" = "ETHERNET" ] ; then 
laurent's avatar
laurent committed
329
        DEADLINE_SCHEDULER_FLAG_USER="True"
330
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
331
        DEADLINE_SCHEDULER_FLAG_USER="False"
332
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
333
        DEADLINE_SCHEDULER_FLAG_USER="False"
334
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
335
        DEADLINE_SCHEDULER_FLAG_USER="False"
336
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
337
        DEADLINE_SCHEDULER_FLAG_USER="False"
338 339 340 341 342
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
343
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
344 345
  fi

Rohit Gupta's avatar
Rohit Gupta committed
346
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
347
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
Rohit Gupta's avatar
Rohit Gupta committed
348 349
     CPU_AFFINITY_FLAG_USER="False"
  fi
350

laurent's avatar
laurent committed
351
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
Rohit Gupta's avatar
Rohit Gupta committed
352
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
353

354 355 356
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
357

358
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
359

gauthier's avatar
gauthier committed
360
  set_openair_env
361
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
362

363 364 365 366 367 368 369 370 371 372
  # 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
373

374

375 376 377 378
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
379

380 381 382 383 384 385 386
  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
387 388 389 390 391
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
392
      echo_info "installing packages for BLADERF support"
393 394
      check_install_bladerf_driver
    fi
395 396 397 398 399 400 401
  fi

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

402
  if [ "$oaisim" = "1" ] ; then
403 404 405 406 407
      #to be discussed
      # there is no RF device and no transport protocol 
      HW="None" 
      TP="None"
      
408 409 410 411 412 413
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
414 415 416
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
417 418 419 420 421 422 423
  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
424

425 426
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
427

428
    # LTE softmodem compilation
429 430 431 432 433 434 435
    [ "$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
436
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
437 438 439 440
    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
441 442
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
443
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
Rohit Gupta's avatar
Rohit Gupta committed
444
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
445
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
446
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
447
    cd  $DIR/$lte_build_dir/build
448
    cmake ..
449 450
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
451
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
452
    echo_info "Compiling $lte_exec"
453
    compilations \
454 455 456 457 458 459 460 461 462 463 464 465
	  $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
466
  fi
thomasl's avatar
thomasl committed
467

Florian Kaltenberger's avatar
Florian Kaltenberger committed
468
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
469 470 471
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
472
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
473
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
474

gauthier's avatar
gauthier committed
475 476 477 478 479 480
#    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
481
    
gauthier's avatar
gauthier committed
482
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
483 484
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
485
    
486
    cmake ..
thomasl's avatar
thomasl committed
487
    compilations \
488 489
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
490
    compilations \
491 492 493 494 495 496
      nas_sim_tools nvram \
      nvram $dbin/nvram

    # generate USIM data
    if [ -f $dbin/nvram ]; then
      install_nas_tools $dbin $dconf
497 498 499 500 501
      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

502 503 504
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
505
  fi
thomasl's avatar
thomasl committed
506

507
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
508 509 510 511 512 513
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
514
  fi
515

516 517 518 519 520 521 522 523 524 525
  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
526

gauthier's avatar
gauthier committed
527
  # Core simulators
528 529 530 531 532 533 534 535 536 537 538
  #############
  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
539

540 541
  # EXMIMO drivers & firmware loader
  ###############
542
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
543
    
544 545
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
546
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
547
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
548
    compilations \
549
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
550
	  updatefw $dbin/updatefw
551 552 553 554 555 556 557
    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
558
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
559
  fi
thomasl's avatar
thomasl committed
560

561
  if [ "$oaisim" = "1" ] ; then
562
    dconf=$OPENAIR_DIR/targets/bin
563 564 565 566 567 568 569
      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
570
    
571 572 573
    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
574
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
575 576 577 578
    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
579
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
580
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
581 582 583
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
584 585
    cmake ..
    compilations \
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 613 614 615 616 617 618 619 620 621 622
	  $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
623 624
    else

625 626 627
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
628

629 630 631 632
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
633

634 635 636 637 638
	#oai_nw_drv
	compilations \
	    $oaisim_build_dir oai_nw_drv \
	    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
    fi
639

640 641 642 643 644
    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
645
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
646
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
647 648 649 650 651 652 653
    #[ "$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
654 655
  fi

656
  # RRH compilation
657
  #####################
658 659
  if [ "$RRH" = "1" ] ; then

660 661 662 663 664
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
665 666
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
667 668 669 670 671 672 673
     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
laurent's avatar
laurent committed
674
     echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
Rohit Gupta's avatar
Rohit Gupta committed
675
     echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"    >>$cmake_file
676
     echo "set ( T_TRACER $T_TRACER )"            >>  $cmake_file
677
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
678 679 680 681 682
     cd $DIR/$rrh_build_dir/build
     cmake ..
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
683

684
  fi
685 686 687 688 689 690 691 692 693 694 695 696
  
  # 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)
697
      if [ "$HW" != "None" ] ; then
698
	  rm -f liboai_device.so
699
	  rm -f $dbin/liboai_device.so
700 701


702
	  # link liboai_device.so with the selected RF device library
703
	  if [ "$HW" == "EXMIMO" ] ; then
704 705
	      
	      #add exmimo compilation
706 707
	      #TODO EXMIMO library support
	     
708 709
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
710 711 712 713 714 715
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

716
	      ln -s liboai_usrpdevif.so liboai_device.so
717
	      ln -s $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
718 719
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
720 721 722 723 724 725
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

726
	      ln -s liboai_bladerfdevif.so liboai_device.so
727
	      ln -s $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
728
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
729 730 731 732 733 734 735 736 737 738
	  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"	 
739 740 741 742 743 744
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
745
      if [ "$TP" != "None" ] ; then
746
	  rm -f liboai_transpro.so
747 748
	  rm -f $dbin/liboai_transpro.so

749
	  if [ "$TP" == "ETHERNET" ] ; then
750 751 752
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
753
	      ln -s liboai_eth_transpro.so liboai_transpro.so
754
	      ln -s $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
755 756 757 758 759
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

760

761 762 763 764 765 766 767 768 769 770 771
  # 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
772
    cmake ..
773 774
    make doc
    ) >& $doxygen_log
775 776
  fi

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

main "$@"