build_oai 31 KB
Newer Older
thomasl's avatar
thomasl committed
1
#!/bin/bash
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
#/*
# * Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
# * contributor license agreements.  See the NOTICE file distributed with
# * this work for additional information regarding copyright ownership.
# * The OpenAirInterface Software Alliance licenses this file to You under
# * the OAI Public License, Version 1.0  (the "License"); you may not use this file
# * except in compliance with the License.
# * You may obtain a copy of the License at
# *
# *      http://www.openairinterface.org/?page_id=698
# *
# * Unless required by applicable law or agreed to in writing, software
# * distributed under the License is distributed on an "AS IS" BASIS,
# * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# * See the License for the specific language governing permissions and
# * limitations under the License.
# *-------------------------------------------------------------------------------
# * For more information about the OpenAirInterface (OAI) Software Alliance:
# *      contact@openairinterface.org
# */

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

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

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

36 37 38 39 40 41 42
# set environment variables (OPENAIR_HOME, ...)
set_openair_env

#variables for UE data generation
gen_nvram_path=$OPENAIR_DIR/targets/bin
conf_nvram_path=$OPENAIR_DIR/openair3/NAS/TOOLS/ue_eurecom_test_sfr.conf

43
MSC_GEN="False"
44
XFORMS="True"
45
FLEXRAN_AGENT_SB_IF="True"
46
PRINT_STATS="False"
thomasl's avatar
thomasl committed
47
VCD_TIMING="False"
laurent's avatar
laurent committed
48 49
DEADLINE_SCHEDULER_FLAG_USER="False"
FORCE_DEADLINE_SCHEDULER_FLAG_USER=""
50
CPU_AFFINITY_FLAG_USER="False" #Only valid when lowlatecy flag is set to False
Cedric Roux's avatar
Cedric Roux committed
51
REL="Rel14"
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
T_TRACER="False"
Rohit Gupta's avatar
Rohit Gupta committed
62
DISABLE_HARDWARE_DEPENDENCY="False"
63
CMAKE_BUILD_TYPE=""
64
UE_AUTOTEST_TRACE="False"
65 66
BUILD_ECLIPSE=0
CMAKE_CMD='cmake'
67 68
trap handle_ctrl_c INT

69
function print_help() {
Cedric Roux's avatar
Cedric Roux committed
70
  echo_info "
71 72 73 74 75 76
This program installs OpenAirInterface Software
You should have ubuntu 14.xx, updated, and the Linux kernel >= 3.14
Options
-h
   This help
-c | --clean
Cedric Roux's avatar
Cedric Roux committed
77
   Erase all files to make a rebuild from start
78
-C | --clean-all
Cedric Roux's avatar
Cedric Roux committed
79
   Erase all files made by previous compilations, installations
80 81
--clean-kernel
   Erase previously installed features in kernel: iptables, drivers, ...
gauthier's avatar
gauthier committed
82
-I | --install-external-packages
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
88
   Add debugging symbols to compilation directives. It also disables any compiler optimization. Only for debugging. Do not use in normal operation!
89 90 91
-h | --help
   Print this help
--eNB
92
   Makes the LTE softmodem
93
--UE
94
   Makes the UE specific parts (ue_ip, usim, nvram) from the given configuration file
Cedric Roux's avatar
Cedric Roux committed
95 96 97 98
--UE-conf-nvram [configuration file]
   Specify conf_nvram_path (default \"$conf_nvram_path\")
--UE-gen-nvram [output path]
   Specify gen_nvram_path (default \"$gen_nvram_path\")
99 100
--RRH
   Makes the RRH
101 102
-a | --agent
   Enables agent for software-defined control of the eNB
103
-r | --3gpp-release
Cedric Roux's avatar
Cedric Roux committed
104
   default is Rel14,
105
   Rel8 limits the implementation to 3GPP Release 8 version
Cedric Roux's avatar
Cedric Roux committed
106
   Rel10 limits the implementation to 3GPP Release 10 version
107
-w | --hardware
108
   EXMIMO, USRP, BLADERF, ETHERNET, LMSSDR, None (Default)
109
   Adds this RF board support (in external packages installation and in compilation)
110 111 112
-t | --transport protocol
   ETHERNET , None
   Adds this trasport protocol support in compilation
113
--oaisim
Cedric Roux's avatar
Cedric Roux committed
114
   Makes the oaisim simulator. Hardware will be defaulted to \"None\".
115 116 117 118 119 120
--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
121 122
--run-group 
   runs only specified test cases specified here. This flag is only valid with -s
123 124 125
-V | --vcd
   Adds a debgging facility to the binary files: GUI with major internal synchronization events
-x | --xforms
126
   Adds a software oscilloscope feature to the produced binaries. If oaisim, then enable PRINT_STATS.
127
--install-system-files
gauthier's avatar
gauthier committed
128
   Install OpenArInterface required files in Linux system
129
   (will ask root password)
130 131
--noS1 
   Compiles oaisim or lte-softmodem without S1 interface, using direct link to IP instead
132 133
--verbose-compile
   Shows detailed compilation instructions in makefile
134 135
--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
136 137
--build-doxygen
   Builds doxygen based documentation.
138
--disable-deadline
139 140
   Disables deadline scheduler of Linux kernel (>=3.14.x).
--enable-deadline
laurent's avatar
laurent committed
141
   Enable deadline scheduler of Linux kernel (>=3.14.x). 
142
--disable-cpu-affinity
143
   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
144 145
--T-tracer
   Enables the T tracer.
Rohit Gupta's avatar
Rohit Gupta committed
146 147
--disable-hardware-dependency
   Disable HW dependency during installation
148 149
--ue-autotest-trace
    Enable specific traces for UE autotest framework
150 151
--build-eclipse
   Build eclipse project files. Paths are auto corrected by fixprj.sh
152
Usage (first build):
153 154 155
 oaisim (eNB + UE): ./build_oai -I  --oaisim -x --install-system-files
 Eurecom EXMIMO + COTS UE : ./build_oai -I  --eNB -x --install-system-files
 NI/ETTUS B201  + COTS UE : ./build_oai -I  --eNB -x --install-system-files -w USRP
156 157 158
Usage (Regular):
 oaisim : ./build_oai --oaisim -x 
 Eurecom EXMIMO + OAI ENB : ./build_oai --eNB -x 
Cedric Roux's avatar
Cedric Roux committed
159
 NI/ETTUS B201  + OAI ENB : ./build_oai --eNB -x -w USRP"
160 161 162 163
}


function main() {
164

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

367
  echo_info "RF HW set to $HW" 
368 369 370 371
  #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
372
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
373
     if [ "$HW" = "EXMIMO" ] ; then 
374
        DEADLINE_SCHEDULER_FLAG_USER="True"
375
     elif [ "$HW" = "ETHERNET" ] ; then 
376
        DEADLINE_SCHEDULER_FLAG_USER="False"
377
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
378
        DEADLINE_SCHEDULER_FLAG_USER="False"
379
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
380
        DEADLINE_SCHEDULER_FLAG_USER="False"
381
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
382
        DEADLINE_SCHEDULER_FLAG_USER="False"
383
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
384
        DEADLINE_SCHEDULER_FLAG_USER="False"
385 386 387 388 389
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
390
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
391 392
  fi

393
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
394
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
395 396
     CPU_AFFINITY_FLAG_USER="False"
  fi
397

laurent's avatar
laurent committed
398
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
399
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
400

401 402 403 404
  if [ -n "$UHD_IMAGES_DIR" ] && [ -z "$INSTALL_EXTERNAL" ]; then
    echo_error "UHD images download settings will not be applied without -I present"
    exit
  fi
405 406 407
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
408

409
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
410

411
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
412

413 414 415 416 417 418 419 420 421 422
  # 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
423

424

425 426 427 428
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
429

430 431 432 433 434 435 436
  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
437 438 439
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
440
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
441
        install_usrp_uhd_driver $UHD_IMAGES_DIR
442
      fi
443 444
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
445
      echo_info "installing packages for BLADERF support"
446
      check_install_bladerf_driver
447 448 449
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
450
    fi
451 452 453 454 455 456 457
  fi

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

458
  if [ "$oaisim" = "1" ] ; then
459
      #to be discussed
460
      # there is no RF device  transport protocol 
461
      HW="None" 
462
      TP="ETHERNET"
463
      
464 465 466 467 468 469
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
470 471 472
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
473 474 475 476 477 478 479
  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
480

481 482
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
483

484
    # LTE softmodem compilation
485 486 487 488 489 490 491
    [ "$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
492
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
493
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
494
    echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
495 496 497
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
498 499 500
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
501 502
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
503
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
504
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
505
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
506
    echo "set (UE_AUTOTEST_TRACE $UE_AUTOTEST_TRACE)"        >>  $cmake_file
Gabriel's avatar
Gabriel committed
507 508 509 510 511
    if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
     echo_info "Compiling UE S1 build : enabling Linux and NETLINK"
     echo "set (LINUX True )"              >>  $cmake_file
     echo "set (PDCP_USE_NETLINK True )"   >>  $cmake_file
    fi
512
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
513
    cd  $DIR/$lte_build_dir/build
514
    eval $CMAKE_CMD
515 516
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
517
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
518
    echo_info "Compiling $lte_exec"
519
    compilations \
520 521 522 523 524 525 526 527 528 529 530 531
	  $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
532
  fi
533

Florian Kaltenberger's avatar
Florian Kaltenberger committed
534
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
535 536 537
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
538
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
539
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
540

gauthier's avatar
gauthier committed
541 542
#    mkdir -p $DIR/at_commands/build
#    cd $DIR/at_commands/build
543
#    eval $CMAKE_CMD
gauthier's avatar
gauthier committed
544 545 546
#    compilations \
#      at_commands at_nas_ue \
#      at_nas_ue $dbin/at_nas_ue
547
    
gauthier's avatar
gauthier committed
548
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
549 550
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
551
    
552
    eval $CMAKE_CMD
thomasl's avatar
thomasl committed
553
    compilations \
554 555
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
556
    compilations \
557 558
      nas_sim_tools nvram \
      nvram $dbin/nvram
thomasl's avatar
thomasl committed
559
    compilations \
560 561
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
562 563

    # generate USIM data
564 565
    if [ -f $dbin/conf2uedata ]; then
      install_nas_tools $conf_nvram_path $gen_nvram_path
566
      echo_info "Copying UE specific part to $DIR/$lte_build_dir/build"
567 568 569
      cp -Rvf $dbin/.ue_emm.nvram0 $DIR/$lte_build_dir/build
      cp -Rvf $dbin/.ue.nvram0 $DIR/$lte_build_dir/build
      cp -Rvf $dbin/.usim.nvram0 $DIR/$lte_build_dir/build
570 571 572
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
573
  fi
thomasl's avatar
thomasl committed
574

575
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
576 577 578 579 580
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
581
    eval $CMAKE_CMD
582
  fi
583

584 585 586
  if [ "$SIMUS_PHY" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
587
    simlist="dlsim_tm4 dlsim ulsim pucchsim prachsim pdcchsim pbchsim mbmssim"
588 589 590 591 592 593
    for f in $simlist ; do
      compilations \
      lte-simulators $f \
	  $f $dbin/$f.$REL
    done
  fi
thomasl's avatar
thomasl committed
594

gauthier's avatar
gauthier committed
595
  # Core simulators
596 597 598 599 600 601 602 603 604 605 606
  #############
  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
607

608 609
  # EXMIMO drivers & firmware loader
  ###############
610
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
611
    
612 613
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
614
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
615
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
616
    compilations \
617
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
618
	  updatefw $dbin/updatefw
619
    echo_info "Compiling oarf tools. The logfile for compilation is here: $dlog/oarf.txt"
620 621 622 623 624 625 626
    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
627
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
628
  fi
thomasl's avatar
thomasl committed
629

630 631
  # oaisim compilation
  ###############
632
  if [ "$oaisim" = "1" ] ; then
633
    dconf=$OPENAIR_DIR/targets/bin
634 635 636 637 638 639 640
      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
641
    
642 643 644
    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
645
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
646
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
647
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
648 649 650
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
651 652 653
    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
654
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
655
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
656 657 658
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
659
    eval $CMAKE_CMD
660
    compilations \
661 662 663 664 665 666 667 668 669
	  $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
670
	eval $CMAKE_CMD
671 672 673 674 675 676 677 678 679 680 681 682 683
	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
684
	eval $CMAKE_CMD
685 686 687 688 689 690 691
	compilations \
	    nas_sim_tools usim \
	    usim $dbin/usim
	compilations \
	    nas_sim_tools nvram \
	    nvram $dbin/nvram
	compilations \
692 693
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
694 695

	# generate USIM data
696 697
	if [ -f $dbin/conf2uedata ]; then
	    install_nas_tools $conf_nvram_path $gen_nvram_path
698 699 700
	else
	    echo_warning "not generated UE NAS files: binaries not found"
	fi
701 702
    else

703 704 705
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
706

707 708 709 710
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
711

712
	#oai_nw_drv
713 714 715
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
716
    fi
717

718 719 720 721
    if [ "$TP" == "ETHERNET" ] ; then
	compilations \
	    $oaisim_build_dir oai_eth_transpro \
	    liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
722 723
	ln -sf liboai_eth_transpro.so liboai_transpro.so
	ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
724 725 726
	echo_info "liboai_transpro.so is linked with ETHERNET library"	 
    fi
      
727 728
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
729 730
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
731 732 733
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
734 735
    echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
736
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
737
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
738 739 740
    #[ "$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
741
    #eval $CMAKE_CMD
742 743 744
    #compilations \
	#  oaisim_mme_build_oai oaisim_mme \
	#  oaisim_mme $dbin/oaisim_mme.$REL
745 746
  fi

747
  # RRH compilation
748
  #####################
749 750
  if [ "$RRH" = "1" ] ; then

751 752 753 754 755
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
756 757
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
758 759
     cmake_file=$DIR/$rrh_build_dir/CMakeLists.txt
     echo "cmake_minimum_required(VERSION 2.8)"   >   $cmake_file
760 761 762 763 764 765 766 767
     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
768
     echo "set ( T_TRACER $T_TRACER )"            >>  $cmake_file
769
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
770
     cd $DIR/$rrh_build_dir/build
771
     eval $CMAKE_CMD
772 773 774
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
775

776
  fi
777 778 779
  
  # build RF device and transport protocol libraries
  #####################################
Wilson's avatar
Wilson committed
780
  if [ "$eNB" = "1" -o "$UE" = "1" -o  "$RRH" = "1" ] ; then
781

Wilson's avatar
Wilson committed
782
      if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
783 784 785 786 787 788
	  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)
789
      if [ "$HW" != "None" ] ; then
790
	  rm -f liboai_device.so
791
	  rm -f $dbin/liboai_device.so
792 793


794
	  # link liboai_device.so with the selected RF device library
795
	  if [ "$HW" == "EXMIMO" ] ; then
796 797
	      
	      #add exmimo compilation
798
	      #TODO EXMIMO library support
799 800 801
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
802 803
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
804 805 806 807 808 809
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

810 811
	      ln -sf liboai_usrpdevif.so liboai_device.so
	      ln -sf $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
812 813
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
814 815 816 817 818 819
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

820 821
	      ln -sf liboai_bladerfdevif.so liboai_device.so
	      ln -sf $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
822
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
823 824 825 826 827 828 829
	  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

830 831
	      ln -sf liboai_lmssdrdevif.so liboai_device.so
	      ln -sf $dbin/liboai_lmssdrdevif.so.$REL $dbin/liboai_device.so
832
	      echo_info "liboai_device.so is linked to LMSSDR device library"	 
833 834 835 836 837 838
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
839
      if [ "$TP" != "None" ] ; then
840
	  rm -f liboai_transpro.so
841 842
	  rm -f $dbin/liboai_transpro.so

843
	  if [ "$TP" == "ETHERNET" ] ; then
844 845 846
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
847 848
	      ln -sf liboai_eth_transpro.so liboai_transpro.so
	      ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
849 850 851 852 853
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

854

855 856 857 858 859 860 861 862 863 864 865
  # 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
866
    eval $CMAKE_CMD
867 868
    make doc
    ) >& $doxygen_log
869 870
  fi

gauthier's avatar
gauthier committed
871 872 873
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
874
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
875 876 877 878
    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 "
879 880
    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 "
881
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
882 883 884
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
885 886
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
887
    if [ "$RUN_GROUP" -eq "1" ]; then
888
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
889
    else
890
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
891
    fi
892
    wait
gauthier's avatar
gauthier committed
893
  else
thomasl's avatar
thomasl committed
894
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
895
  fi
896 897 898
}

main "$@"