build_oai 28.3 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"
Rohit Gupta's avatar
Rohit Gupta committed
63
DISABLE_HARDWARE_DEPENDENCY="False"
64
CMAKE_BUILD_TYPE=""
65 66
trap handle_ctrl_c INT

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


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

knopp's avatar
knopp committed
329
  echo_info "RF HW set to $HW" 
330 331 332 333
  #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
334
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
335
     if [ "$HW" = "EXMIMO" ] ; then 
laurent's avatar
laurent committed
336
        DEADLINE_SCHEDULER_FLAG_USER="False"
337
     elif [ "$HW" = "ETHERNET" ] ; then 
laurent's avatar
laurent committed
338
        DEADLINE_SCHEDULER_FLAG_USER="True"
339
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
340
        DEADLINE_SCHEDULER_FLAG_USER="False"
341
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
342
        DEADLINE_SCHEDULER_FLAG_USER="False"
343
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
344
        DEADLINE_SCHEDULER_FLAG_USER="False"
345
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
346
        DEADLINE_SCHEDULER_FLAG_USER="False"
347 348 349 350 351
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
352
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
353 354
  fi

Rohit Gupta's avatar
Rohit Gupta committed
355
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
356
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
Rohit Gupta's avatar
Rohit Gupta committed
357 358
     CPU_AFFINITY_FLAG_USER="False"
  fi
359

laurent's avatar
laurent committed
360
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
Rohit Gupta's avatar
Rohit Gupta committed
361
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
362

363 364 365
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
366

367
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
368

gauthier's avatar
gauthier committed
369
  set_openair_env
370
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
371

372 373 374 375 376 377 378 379 380 381
  # 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
382

383

384 385 386 387
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
388

389 390 391 392 393 394 395
  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
396 397 398
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
399 400 401
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        install_usrp_uhd_driver
      fi
402 403
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
404
      echo_info "installing packages for BLADERF support"
405
      check_install_bladerf_driver
406 407 408
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
409
    fi
410 411 412 413 414 415 416
  fi

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

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

  DIR=$OPENAIR_DIR/cmake_targets
432 433 434 435 436 437 438
  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
439

440 441
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
442

443
    # LTE softmodem compilation
444 445 446 447 448 449 450
    [ "$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
451
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
452
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
453 454 455 456
    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
457 458
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
459
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
Rohit Gupta's avatar
Rohit Gupta committed
460
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
461
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
462
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
463
    cd  $DIR/$lte_build_dir/build
464
    cmake ..
465 466
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
467
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
468
    echo_info "Compiling $lte_exec"
469
    compilations \
470 471 472 473 474 475 476 477 478 479 480 481
	  $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
482
  fi
thomasl's avatar
thomasl committed
483

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

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

    # generate USIM data
    if [ -f $dbin/nvram ]; then
      install_nas_tools $dbin $dconf
513 514 515 516 517
      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

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

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

532 533 534 535 536 537 538 539 540 541
  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
542

gauthier's avatar
gauthier committed
543
  # Core simulators
544 545 546 547 548 549 550 551 552 553 554
  #############
  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
555

556 557
  # EXMIMO drivers & firmware loader
  ###############
558
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
559
    
560 561
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
562
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
563
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
564
    compilations \
565
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
566
	  updatefw $dbin/updatefw
567 568 569 570 571 572 573
    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
574
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
575
  fi
thomasl's avatar
thomasl committed
576

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

644 645 646
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
647

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

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

659 660
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
661 662 663 664
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $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
665
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
666
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
667 668 669 670 671 672 673
    #[ "$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
674 675
  fi

676
  # RRH compilation
677
  #####################
678 679
  if [ "$RRH" = "1" ] ; then

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

705
  fi
706 707 708 709 710 711 712 713 714 715 716 717
  
  # 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)
718
      if [ "$HW" != "None" ] ; then
719
	  rm -f liboai_device.so
720
	  rm -f $dbin/liboai_device.so
721 722


723
	  # link liboai_device.so with the selected RF device library
724
	  if [ "$HW" == "EXMIMO" ] ; then
725 726
	      
	      #add exmimo compilation
727 728
	      #TODO EXMIMO library support
	     
729 730
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
731 732 733 734 735 736
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

737
	      ln -s liboai_usrpdevif.so liboai_device.so
738
	      ln -s $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
739 740
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
741 742 743 744 745 746
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

747
	      ln -s liboai_bladerfdevif.so liboai_device.so
748
	      ln -s $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
749
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
750 751 752 753 754 755 756 757 758 759
	  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"	 
760 761 762 763 764 765
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
766
      if [ "$TP" != "None" ] ; then
767
	  rm -f liboai_transpro.so
768 769
	  rm -f $dbin/liboai_transpro.so

770
	  if [ "$TP" == "ETHERNET" ] ; then
771 772 773
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
774
	      ln -s liboai_eth_transpro.so liboai_transpro.so
775
	      ln -s $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
776 777 778 779 780
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

781

782 783 784 785 786 787 788 789 790 791 792
  # 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
793
    cmake ..
794 795
    make doc
    ) >& $doxygen_log
796 797
  fi

gauthier's avatar
gauthier committed
798 799 800
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
801
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
802 803 804 805
    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 "
806 807
    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 "
808
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
809 810 811
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
812 813
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
814
    if [ "$RUN_GROUP" -eq "1" ]; then
815
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
816
    else
817
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
818
    fi
819
    wait
gauthier's avatar
gauthier committed
820
  else
thomasl's avatar
thomasl committed
821
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
822
  fi
823 824 825
}

main "$@"