build_oai 31.6 KB
Newer Older
thomasl's avatar
thomasl committed
1
#!/bin/bash
2 3 4 5 6
#/*
# * 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
Cedric Roux's avatar
Cedric Roux committed
7
# * the OAI Public License, Version 1.1  (the "License"); you may not use this file
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# * 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
CMAKE_CMD="$CMAKE"
65
UE_AUTOTEST_TRACE="False"
Gabriel's avatar
Gabriel committed
66 67
UE_DEBUG_TRACE="False"
UE_TIMING_TRACE="False"
Cedric Roux's avatar
Cedric Roux committed
68
DISABLE_LOG_X="False"
69
USRP_REC_PLAY="False"
70
BUILD_ECLIPSE=0
71 72
trap handle_ctrl_c INT

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


function main() {
174

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

410
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
411
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
412 413
     CPU_AFFINITY_FLAG_USER="False"
  fi
414

laurent's avatar
laurent committed
415
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
416
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
417

418 419 420 421
  if [ -n "$UHD_IMAGES_DIR" ] && [ -z "$INSTALL_EXTERNAL" ]; then
    echo_error "UHD images download settings will not be applied without -I present"
    exit
  fi
422 423 424
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
425

426
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
427

428
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
429

430 431 432 433 434 435 436 437 438 439
  # 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
440

441

442 443 444 445
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
446

447 448 449 450 451 452 453
  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
454 455 456
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
457
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
458
        install_usrp_uhd_driver $UHD_IMAGES_DIR
459
      fi
460 461
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
462
      echo_info "installing packages for BLADERF support"
463
      check_install_bladerf_driver
464 465 466
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
467
    fi
468 469 470 471 472
    if [ "$FLEXRAN_AGENT" == "1" ] ; then
      echo_info "installing protobuf/protobuf-c for flexran agent support"
      install_protobuf_from_source
      install_protobuf_c_from_source
    fi
473 474 475 476 477 478 479
  fi

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

480
  if [ "$oaisim" = "1" ] ; then
481
      #to be discussed
482
      # there is no RF device  transport protocol 
483
      HW="None" 
484
      TP="ETHERNET"
485
      
486 487 488 489 490 491
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
492 493 494
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
495 496
  if [ "$NOS1" =  "1" ] ; then
      lte_build_dir=lte_noS1_build_oai
497
      #lte_exec=lte-softmodem-nos1
498
      lte_exec=lte-softmodem-stub-nos1
499 500
  else
      lte_build_dir=lte_build_oai
501 502
      #lte_exec=lte-softmodem
      lte_exec=lte-softmodem-stub
503
  fi
504

505 506 507
# configuration module libraries, one currently available, using libconfig 
  config_libconfig_shlib=params_libconfig
  
508 509
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
510

511
    # LTE softmodem compilation
512 513 514 515 516 517 518
    [ "$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
519
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
520
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
521
    echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
522 523 524
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
525 526 527
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
528 529
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
530
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
531
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
532
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
533
    echo "set (UE_AUTOTEST_TRACE $UE_AUTOTEST_TRACE)"        >>  $cmake_file
Gabriel's avatar
Gabriel committed
534 535
    echo "set (UE_DEBUG_TRACE $UE_DEBUG_TRACE)"        >>  $cmake_file
    echo "set (UE_TIMING_TRACE $UE_TIMING_TRACE)"        >>  $cmake_file
Cedric Roux's avatar
Cedric Roux committed
536
    echo "set (DISABLE_LOG_X $DISABLE_LOG_X)"        >>  $cmake_file
537
    echo "set (USRP_REC_PLAY $USRP_REC_PLAY)"        >>  $cmake_file
Gabriel's avatar
Gabriel committed
538 539 540 541 542
    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
543
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
544
    cd  $DIR/$lte_build_dir/build
545
    eval $CMAKE_CMD
546 547
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
548
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
549
    echo_info "Compiling $lte_exec"
550
    compilations \
551 552 553
	  $lte_build_dir $lte_exec \
	  $lte_exec $dbin/$lte_exec.$REL

554 555 556 557 558
# mandatory shared lib
    compilations \
	  $lte_build_dir $config_libconfig_shlib \
	  lib$config_libconfig_shlib.so $dbin/lib$config_libconfig_shlib.so
	  
559 560 561 562 563 564 565 566 567
    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
568
  fi
569

Florian Kaltenberger's avatar
Florian Kaltenberger committed
570
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
571 572 573
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
574
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
575
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
576

gauthier's avatar
gauthier committed
577 578
#    mkdir -p $DIR/at_commands/build
#    cd $DIR/at_commands/build
579
#    eval $CMAKE_CMD
gauthier's avatar
gauthier committed
580 581 582
#    compilations \
#      at_commands at_nas_ue \
#      at_nas_ue $dbin/at_nas_ue
583
    
gauthier's avatar
gauthier committed
584
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
585 586
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
587
    
588
    eval $CMAKE_CMD
thomasl's avatar
thomasl committed
589
    compilations \
590 591
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
592
    compilations \
593 594
      nas_sim_tools nvram \
      nvram $dbin/nvram
thomasl's avatar
thomasl committed
595
    compilations \
596 597
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
598 599

    # generate USIM data
600 601
    if [ -f $dbin/conf2uedata ]; then
      install_nas_tools $conf_nvram_path $gen_nvram_path
602
      echo_info "Copying UE specific part to $DIR/$lte_build_dir/build"
603 604 605
      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
606 607 608
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
609
  fi
thomasl's avatar
thomasl committed
610

611
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
612 613 614 615 616
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
617
    eval $CMAKE_CMD
618
  fi
619

620 621 622
  if [ "$SIMUS_PHY" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
623
    simlist="dlsim_tm4 dlsim ulsim pucchsim prachsim pdcchsim pbchsim mbmssim"
624 625 626 627 628 629
    for f in $simlist ; do
      compilations \
      lte-simulators $f \
	  $f $dbin/$f.$REL
    done
  fi
thomasl's avatar
thomasl committed
630

gauthier's avatar
gauthier committed
631
  # Core simulators
632 633 634 635 636 637 638 639 640 641 642
  #############
  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
643

644 645
  # EXMIMO drivers & firmware loader
  ###############
646
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
647
    
648 649
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
650
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
651
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
652
    compilations \
653
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
654
	  updatefw $dbin/updatefw
655
    echo_info "Compiling oarf tools. The logfile for compilation is here: $dlog/oarf.txt"
656 657 658 659 660 661 662
    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
663
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
664
  fi
thomasl's avatar
thomasl committed
665

666 667
  # oaisim compilation
  ###############
668
  if [ "$oaisim" = "1" ] ; then
669
    dconf=$OPENAIR_DIR/targets/bin
670 671 672 673 674 675 676
      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
677
    
678 679 680
    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
681
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
682
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
683
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
684 685 686
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
687 688 689
    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
690
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
691
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
692 693 694
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
695
    eval $CMAKE_CMD
696
    compilations \
697 698 699 700 701 702 703 704 705
	  $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
706
	eval $CMAKE_CMD
707 708 709 710 711 712 713 714 715 716 717 718 719
	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
720
	eval $CMAKE_CMD
721 722 723 724 725 726 727
	compilations \
	    nas_sim_tools usim \
	    usim $dbin/usim
	compilations \
	    nas_sim_tools nvram \
	    nvram $dbin/nvram
	compilations \
728 729
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
730 731

	# generate USIM data
732 733
	if [ -f $dbin/conf2uedata ]; then
	    install_nas_tools $conf_nvram_path $gen_nvram_path
734 735 736
	else
	    echo_warning "not generated UE NAS files: binaries not found"
	fi
737 738
    else

739 740 741
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
742

743 744 745 746
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
747

748
	#oai_nw_drv
749 750 751
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
752
    fi
753

754 755 756 757
    if [ "$TP" == "ETHERNET" ] ; then
	compilations \
	    $oaisim_build_dir oai_eth_transpro \
	    liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
758 759
	ln -sf liboai_eth_transpro.so liboai_transpro.so
	ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
760 761 762
	echo_info "liboai_transpro.so is linked with ETHERNET library"	 
    fi
      
763 764
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
765 766
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
767 768 769
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
770 771
    echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
772
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
773
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
774 775 776
    #[ "$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
777
    #eval $CMAKE_CMD
778 779 780
    #compilations \
	#  oaisim_mme_build_oai oaisim_mme \
	#  oaisim_mme $dbin/oaisim_mme.$REL
781 782
  fi

oai's avatar
oai committed
783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
  # Telnet server compilation
  #####################
  if [ "$BUILD_TELNETSRV" = "1" ] ; then

     telnetsrv_build_dir=telnetsrv
     mkdir -p $DIR/$telnetsrv_build_dir/build
     cd $DIR/$telnetsrv_build_dir/build   
     echo_info "Compiling telnet server library ..."
    
     [ "$CLEAN" = "1" ] && rm -rf $DIR/$telnetsrv_build_dir 
     cmake_file=$OPENAIR_DIR/common/utils/$telnetsrv_build_dir/CMakeLists.txt   
     cd $DIR/$telnetsrv_build_dir/build
     eval  "$CMAKE_CMD $OPENAIR_DIR/common/utils/$telnetsrv_build_dir/"
     make

  fi  
799 800
  # build RF device and transport protocol libraries
  #####################################
801
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
802

803
      build_dir=$lte_build_dir	  
804

805
      # build RF device libraries
806
      if [ "$HW" != "None" ] ; then
807
	  rm -f liboai_device.so
808
	  rm -f $dbin/liboai_device.so
809

810
	  # link liboai_device.so with the selected RF device library
811
	  if [ "$HW" == "EXMIMO" ] ; then
812 813 814
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
815 816 817

	      ln -sf liboai_exmimodevif.so liboai_device.so
	      ln -sf $dbin/liboai_exmimodevif.so.$REL $dbin/liboai_device.so
818 819
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
820 821 822
              compilations \
                  $build_dir oai_usrpdevif \
                  liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
823

824 825
	      ln -sf liboai_usrpdevif.so liboai_device.so
	      ln -sf $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
826 827
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
828 829 830 831 832 833
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

834 835
	      ln -sf liboai_bladerfdevif.so liboai_device.so
	      ln -sf $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
836
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
837 838 839 840 841 842 843
	  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

844 845
	      ln -sf liboai_lmssdrdevif.so liboai_device.so
	      ln -sf $dbin/liboai_lmssdrdevif.so.$REL $dbin/liboai_device.so
846
	      echo_info "liboai_device.so is linked to LMSSDR device library"	 
847 848 849 850 851 852
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
853
      if [ "$TP" != "None" ] ; then
854
	  rm -f liboai_transpro.so
855 856
	  rm -f $dbin/liboai_transpro.so

857
	  if [ "$TP" == "ETHERNET" ] ; then
858 859 860
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
861 862
	      ln -sf liboai_eth_transpro.so liboai_transpro.so
	      ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
863 864 865 866 867
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

868

869 870 871 872 873 874 875 876 877 878 879
  # 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
880
    eval $CMAKE_CMD
881 882
    make doc
    ) >& $doxygen_log
883 884
  fi

gauthier's avatar
gauthier committed
885 886 887
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
888
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
889 890 891 892
    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 "
893 894
    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 "
895
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
896 897 898
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
899 900
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
901
    if [ "$RUN_GROUP" -eq "1" ]; then
902
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
903
    else
904
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
905
    fi
906
    wait
gauthier's avatar
gauthier committed
907
  else
thomasl's avatar
thomasl committed
908
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
909
  fi
910 911 912
}

main "$@"