build_oai 30.3 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
thomasl's avatar
thomasl committed
44
REL="Rel10"
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

Cedric Roux's avatar
Cedric Roux committed
60 61 62
gen_nvram_path=$OPENAIR_DIR/targets/bin
conf_nvram_path=$OPENAIR_DIR/openair3/NAS/TOOLS/ue_eurecom_test_sfr.conf

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


function main() {
155

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

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

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

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

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

391
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
392

gauthier's avatar
gauthier committed
393
  set_openair_env
394
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
395

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

407

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

759
  fi
760 761 762 763 764 765 766 767 768 769 770 771
  
  # build RF device and transport protocol libraries
  #####################################
  if [ "$eNB" = "1" -o  "$RRH" = "1" ] ; then

      if [ "$eNB" = "1" ] ; then
	  build_dir=$lte_build_dir	  
      else
	  build_dir=$rrh_build_dir	 
      fi

      # build RF device libraries (currently EXMIMO is not complied with the rest of HW targets)
772
      if [ "$HW" != "None" ] ; then
773
	  rm -f liboai_device.so
774
	  rm -f $dbin/liboai_device.so
775 776


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

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

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

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

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

837

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

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

main "$@"