build_oai 30.4 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

FredericLeroy's avatar
FredericLeroy committed
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
MSC_GEN="False"
37
XFORMS="True"
38
FLEXRAN_AGENT_SB_IF="True"
39
PRINT_STATS="False"
thomasl's avatar
thomasl committed
40
VCD_TIMING="False"
laurent's avatar
laurent committed
41 42
DEADLINE_SCHEDULER_FLAG_USER="False"
FORCE_DEADLINE_SCHEDULER_FLAG_USER=""
43
CPU_AFFINITY_FLAG_USER="False" #Only valid when lowlatecy flag is set to False
Cedric Roux's avatar
Cedric Roux committed
44
REL="Rel14"
45
HW="None"
46
TP="None"
Florian Kaltenberger's avatar
Florian Kaltenberger committed
47
NOS1=0
gauthier's avatar
gauthier committed
48
EPC=0
49
VERBOSE_COMPILE=0
50
CFLAGS_PROCESSOR_USER=""
51 52
RUN_GROUP=0
TEST_CASE_GROUP=""
53
BUILD_DOXYGEN=0
54
T_TRACER="False"
Rohit Gupta's avatar
Rohit Gupta committed
55
DISABLE_HARDWARE_DEPENDENCY="False"
56
CMAKE_BUILD_TYPE=""
57
UE_AUTOTEST_TRACE="False"
58 59
trap handle_ctrl_c INT

60
function print_help() {
Cedric Roux's avatar
Cedric Roux committed
61
  echo_info "
62 63 64 65 66 67
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
68
   Erase all files to make a rebuild from start
69
-C | --clean-all
Cedric Roux's avatar
Cedric Roux committed
70
   Erase all files made by previous compilations, installations
71 72
--clean-kernel
   Erase previously installed features in kernel: iptables, drivers, ...
gauthier's avatar
gauthier committed
73
-I | --install-external-packages
74 75 76 77 78
   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
79
   Add debugging symbols to compilation directives. It also disables any compiler optimization. Only for debugging. Do not use in normal operation!
80 81 82
-h | --help
   Print this help
--eNB
83
   Makes the LTE softmodem
84
--UE
85
   Makes the UE specific parts (ue_ip, usim, nvram) from the given configuration file
Cedric Roux's avatar
Cedric Roux committed
86 87 88 89
--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\")
90 91
--RRH
   Makes the RRH
92 93
-a | --agent
   Enables agent for software-defined control of the eNB
94
-r | --3gpp-release
Cedric Roux's avatar
Cedric Roux committed
95
   default is Rel14,
96
   Rel8 limits the implementation to 3GPP Release 8 version
Cedric Roux's avatar
Cedric Roux committed
97
   Rel10 limits the implementation to 3GPP Release 10 version
98
-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
Cedric Roux's avatar
Cedric Roux committed
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
--ue-autotest-trace
    Enable specific traces for UE autotest framework
141
Usage (first build):
142 143 144
 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
145 146 147
Usage (Regular):
 oaisim : ./build_oai --oaisim -x 
 Eurecom EXMIMO + OAI ENB : ./build_oai --eNB -x 
Cedric Roux's avatar
Cedric Roux committed
148
 NI/ETTUS B201  + OAI ENB : ./build_oai --eNB -x -w USRP"
149 150 151 152
}


function main() {
153

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

knopp's avatar
knopp committed
347
  echo_info "RF HW set to $HW" 
348 349 350 351
  #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
352
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
353
     if [ "$HW" = "EXMIMO" ] ; then 
354
        DEADLINE_SCHEDULER_FLAG_USER="True"
355
     elif [ "$HW" = "ETHERNET" ] ; then 
356
        DEADLINE_SCHEDULER_FLAG_USER="False"
357
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
358
        DEADLINE_SCHEDULER_FLAG_USER="False"
359
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
360
        DEADLINE_SCHEDULER_FLAG_USER="False"
361
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
362
        DEADLINE_SCHEDULER_FLAG_USER="False"
363
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
364
        DEADLINE_SCHEDULER_FLAG_USER="False"
365 366 367 368 369
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
370
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
371 372
  fi

Rohit Gupta's avatar
Rohit Gupta committed
373
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
374
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
Rohit Gupta's avatar
Rohit Gupta committed
375 376
     CPU_AFFINITY_FLAG_USER="False"
  fi
377

laurent's avatar
laurent committed
378
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
Rohit Gupta's avatar
Rohit Gupta committed
379
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
380

381 382 383 384
  if [ -n "$UHD_IMAGES_DIR" ] && [ -z "$INSTALL_EXTERNAL" ]; then
    echo_error "UHD images download settings will not be applied without -I present"
    exit
  fi
385 386 387
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
388

389
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
390

gauthier's avatar
gauthier committed
391
  set_openair_env
392
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
393

394 395 396
  gen_nvram_path=$OPENAIR_DIR/targets/bin
  conf_nvram_path=$OPENAIR_DIR/openair3/NAS/TOOLS/ue_eurecom_test_sfr.conf

397 398 399 400 401 402 403 404 405 406
  # 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
407

408

409 410 411 412
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
413

414 415 416 417 418 419 420
  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
421 422 423
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
424
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
425
        install_usrp_uhd_driver $UHD_IMAGES_DIR
426
      fi
427 428
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
429
      echo_info "installing packages for BLADERF support"
430
      check_install_bladerf_driver
431 432 433
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
434
    fi
435 436 437 438 439 440 441
  fi

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

442
  if [ "$oaisim" = "1" ] ; then
443
      #to be discussed
444
      # there is no RF device  transport protocol 
445
      HW="None" 
446
      TP="ETHERNET"
447
      
448 449 450 451 452 453
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
454 455 456
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
457 458 459 460 461 462 463
  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
464

465 466
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
467

468
    # LTE softmodem compilation
469 470 471 472 473 474 475
    [ "$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
476
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
477
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
478
    echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
479 480 481
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
482 483 484
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
485 486
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
487
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
Rohit Gupta's avatar
Rohit Gupta committed
488
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
489
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
490
    echo "set (UE_AUTOTEST_TRACE $UE_AUTOTEST_TRACE)"        >>  $cmake_file
Gabriel's avatar
Gabriel committed
491 492 493 494 495
    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
496
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
497
    cd  $DIR/$lte_build_dir/build
498
    cmake ..
499 500
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
501
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
502
    echo_info "Compiling $lte_exec"
503
    compilations \
504 505 506 507 508 509 510 511 512 513 514 515
	  $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
516
  fi
thomasl's avatar
thomasl committed
517

Florian Kaltenberger's avatar
Florian Kaltenberger committed
518
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
519 520 521
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
522
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
523
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
524

gauthier's avatar
gauthier committed
525 526 527 528 529 530
#    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
531
    
gauthier's avatar
gauthier committed
532
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
533 534
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
535
    
536
    cmake ..
thomasl's avatar
thomasl committed
537
    compilations \
538 539
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
540
    compilations \
541 542
      nas_sim_tools nvram \
      nvram $dbin/nvram
thomasl's avatar
thomasl committed
543
    compilations \
544 545
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
546 547

    # generate USIM data
548 549
    if [ -f $dbin/conf2uedata ]; then
      install_nas_tools $conf_nvram_path $gen_nvram_path
550
      echo_info "Copying UE specific part to $DIR/$lte_build_dir/build"
551 552 553
      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
554 555 556
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
557
  fi
thomasl's avatar
thomasl committed
558

559
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
560 561 562 563 564 565
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
566
  fi
567

568 569 570
  if [ "$SIMUS_PHY" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
571
    simlist="dlsim_tm4 dlsim ulsim pucchsim prachsim pdcchsim pbchsim mbmssim"
572 573 574 575 576 577
    for f in $simlist ; do
      compilations \
      lte-simulators $f \
	  $f $dbin/$f.$REL
    done
  fi
thomasl's avatar
thomasl committed
578

gauthier's avatar
gauthier committed
579
  # Core simulators
580 581 582 583 584 585 586 587 588 589 590
  #############
  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
591

592 593
  # EXMIMO drivers & firmware loader
  ###############
594
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
595
    
596 597
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
598
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
599
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
600
    compilations \
601
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
602
	  updatefw $dbin/updatefw
603
    echo_info "Compiling oarf tools. The logfile for compilation is here: $dlog/oarf.txt"
604 605 606 607 608 609 610
    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
611
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
612
  fi
thomasl's avatar
thomasl committed
613

614 615
  # oaisim compilation
  ###############
616
  if [ "$oaisim" = "1" ] ; then
617
    dconf=$OPENAIR_DIR/targets/bin
618 619 620 621 622 623 624
      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
625
    
626 627 628
    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
629
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
630
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
631
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
632 633 634
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
635 636 637
    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
638
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
639
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
640 641 642
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
643 644
    cmake ..
    compilations \
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
	  $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
	compilations \
676 677
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
678 679

	# generate USIM data
680 681
	if [ -f $dbin/conf2uedata ]; then
	    install_nas_tools $conf_nvram_path $gen_nvram_path
682 683 684
	else
	    echo_warning "not generated UE NAS files: binaries not found"
	fi
685 686
    else

687 688 689
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
690

691 692 693 694
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
695

696
	#oai_nw_drv
Cedric Roux's avatar
Cedric Roux committed
697 698 699
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
700
    fi
701

702 703 704 705
    if [ "$TP" == "ETHERNET" ] ; then
	compilations \
	    $oaisim_build_dir oai_eth_transpro \
	    liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
706 707
	ln -sf liboai_eth_transpro.so liboai_transpro.so
	ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
708 709 710
	echo_info "liboai_transpro.so is linked with ETHERNET library"	 
    fi
      
711 712
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
713 714
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
715 716 717
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
718 719
    echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
720
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
721
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
722 723 724 725 726 727 728
    #[ "$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
729 730
  fi

731
  # RRH compilation
732
  #####################
733 734
  if [ "$RRH" = "1" ] ; then

735 736 737 738 739
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
740 741
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
742 743
     cmake_file=$DIR/$rrh_build_dir/CMakeLists.txt
     echo "cmake_minimum_required(VERSION 2.8)"   >   $cmake_file
744 745 746 747 748 749 750 751
     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
752
     echo "set ( T_TRACER $T_TRACER )"            >>  $cmake_file
753
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
754 755 756 757 758
     cd $DIR/$rrh_build_dir/build
     cmake ..
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
759

760
  fi
761 762 763
  
  # build RF device and transport protocol libraries
  #####################################
Wilson's avatar
Wilson committed
764
  if [ "$eNB" = "1" -o "$UE" = "1" -o  "$RRH" = "1" ] ; then
765

Wilson's avatar
Wilson committed
766
      if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
767 768 769 770 771 772
	  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)
773
      if [ "$HW" != "None" ] ; then
774
	  rm -f liboai_device.so
775
	  rm -f $dbin/liboai_device.so
776 777


778
	  # link liboai_device.so with the selected RF device library
779
	  if [ "$HW" == "EXMIMO" ] ; then
780 781
	      
	      #add exmimo compilation
782
	      #TODO EXMIMO library support
783 784 785
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
786 787
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
788 789 790 791 792 793
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

794 795
	      ln -sf liboai_usrpdevif.so liboai_device.so
	      ln -sf $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
796 797
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
798 799 800 801 802 803
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

804 805
	      ln -sf liboai_bladerfdevif.so liboai_device.so
	      ln -sf $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
806
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
807 808 809 810 811 812 813
	  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

814 815
	      ln -sf liboai_lmssdrdevif.so liboai_device.so
	      ln -sf $dbin/liboai_lmssdrdevif.so.$REL $dbin/liboai_device.so
816
	      echo_info "liboai_device.so is linked to LMSSDR device library"	 
817 818 819 820 821 822
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
823
      if [ "$TP" != "None" ] ; then
824
	  rm -f liboai_transpro.so
825 826
	  rm -f $dbin/liboai_transpro.so

827
	  if [ "$TP" == "ETHERNET" ] ; then
828 829 830
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
831 832
	      ln -sf liboai_eth_transpro.so liboai_transpro.so
	      ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
833 834 835 836 837
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

838

839 840 841 842 843 844 845 846 847 848 849
  # 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
850
    cmake ..
851 852
    make doc
    ) >& $doxygen_log
853 854
  fi

gauthier's avatar
gauthier committed
855 856 857
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
858
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
859 860 861 862
    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 "
863 864
    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 "
865
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
866 867 868
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
869 870
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
871
    if [ "$RUN_GROUP" -eq "1" ]; then
872
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
873
    else
874
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
875
    fi
876
    wait
gauthier's avatar
gauthier committed
877
  else
thomasl's avatar
thomasl committed
878
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
879
  fi
880 881 882
}

main "$@"