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

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

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
BUILD_ECLIPSE=0
66 67
trap handle_ctrl_c INT

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


function main() {
163

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

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

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

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

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

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

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

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

423

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

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

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

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

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

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

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

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

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

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

    # generate USIM data
563 564
    if [ -f $dbin/conf2uedata ]; then
      install_nas_tools $conf_nvram_path $gen_nvram_path
565
      echo_info "Copying UE specific part to $DIR/$lte_build_dir/build"
566 567 568
      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
569 570 571
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
572
  fi
thomasl's avatar
thomasl committed
573

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

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

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

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

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

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

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

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

711
	#oai_nw_drv
Cedric Roux's avatar
Cedric Roux committed
712 713 714
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
715
    fi
716

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

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

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

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

Wilson's avatar
Wilson committed
781
      if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
782 783 784 785 786
	  build_dir=$lte_build_dir	  
      else
	  build_dir=$rrh_build_dir	 
      fi

787
      # build RF device libraries
788
      if [ "$HW" != "None" ] ; then
789
	  rm -f liboai_device.so
790
	  rm -f $dbin/liboai_device.so
791

792
	  # link liboai_device.so with the selected RF device library
793
	  if [ "$HW" == "EXMIMO" ] ; then
794 795 796
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
797 798 799

	      ln -sf liboai_exmimodevif.so liboai_device.so
	      ln -sf $dbin/liboai_exmimodevif.so.$REL $dbin/liboai_device.so
800 801
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
802 803 804 805 806 807
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

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

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

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

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

852

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

gauthier's avatar
gauthier committed
869 870 871
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
872
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
873 874 875 876
    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 "
877 878
    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 "
879
    echo_info