build_oai 30.5 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 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
trap handle_ctrl_c INT

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


function main() {
160

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

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

Rohit Gupta's avatar
Rohit Gupta committed
380
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
381
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
Rohit Gupta's avatar
Rohit Gupta committed
382 383
     CPU_AFFINITY_FLAG_USER="False"
  fi
384

laurent's avatar
laurent committed
385
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
Rohit Gupta's avatar
Rohit Gupta committed
386
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
387

388 389 390 391
  if [ -n "$UHD_IMAGES_DIR" ] && [ -z "$INSTALL_EXTERNAL" ]; then
    echo_error "UHD images download settings will not be applied without -I present"
    exit
  fi
392 393 394
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
395

396
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
397

398
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
399

400 401 402 403 404 405 406 407 408 409
  # 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
410

411

412 413 414 415
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
416

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

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

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

  DIR=$OPENAIR_DIR/cmake_targets
460 461 462 463 464 465 466
  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
467

468 469
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
470

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

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

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

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

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

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

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

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

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

617 618
  # oaisim compilation
  ###############
619
  if [ "$oaisim" = "1" ] ; then
620
    dconf=$OPENAIR_DIR/targets/bin
621 622 623 624 625 626 627
      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
628
    
629 630 631
    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
632
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
633
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
634
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
635 636 637
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
638 639 640
    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
641
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
642
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
643 644 645
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
646 647
    cmake ..
    compilations \
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 676 677 678
	  $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 \
679 680
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
681 682

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

690 691 692
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
693

694 695 696 697
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
698

699
	#oai_nw_drv
Cedric Roux's avatar
Cedric Roux committed
700 701 702
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
703
    fi
704

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

734
  # RRH compilation
735
  #####################
736 737
  if [ "$RRH" = "1" ] ; then

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

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

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


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

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

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

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

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

841

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

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

main "$@"