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

27
set -e
thomasl's avatar
thomasl committed
28 29 30 31

################################
# include helper functions
################################
thomasl's avatar
thomasl committed
32
ORIGIN_PATH=$PWD
thomasl's avatar
thomasl committed
33
THIS_SCRIPT_PATH=$(dirname $(readlink -f $0))
34
source $THIS_SCRIPT_PATH/tools/build_helper
thomasl's avatar
thomasl committed
35

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

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

65
function print_help() {
Cedric Roux's avatar
Cedric Roux committed
66
  echo_info "
67 68 69 70 71 72
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
73
   Erase all files to make a rebuild from start
74
-C | --clean-all
Cedric Roux's avatar
Cedric Roux committed
75
   Erase all files made by previous compilations, installations
76 77
--clean-kernel
   Erase previously installed features in kernel: iptables, drivers, ...
gauthier's avatar
gauthier committed
78
-I | --install-external-packages
79 80 81 82 83
   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
84
   Add debugging symbols to compilation directives. It also disables any compiler optimization. Only for debugging. Do not use in normal operation!
85 86 87
-h | --help
   Print this help
--eNB
88
   Makes the LTE softmodem
89
--UE
90
   Makes the UE specific parts (ue_ip, usim, nvram) from the given configuration file
Cedric Roux's avatar
Cedric Roux committed
91 92 93 94
--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\")
95 96
--RRH
   Makes the RRH
97 98
-a | --agent
   Enables agent for software-defined control of the eNB
99
-r | --3gpp-release
Cedric Roux's avatar
Cedric Roux committed
100
   default is Rel14,
101
   Rel8 limits the implementation to 3GPP Release 8 version
Cedric Roux's avatar
Cedric Roux committed
102
   Rel10 limits the implementation to 3GPP Release 10 version
103
-w | --hardware
104
   EXMIMO, USRP, BLADERF, ETHERNET, LMSSDR, None (Default)
105
   Adds this RF board support (in external packages installation and in compilation)
106 107 108
-t | --transport protocol
   ETHERNET , None
   Adds this trasport protocol support in compilation
109
--oaisim
Cedric Roux's avatar
Cedric Roux committed
110
   Makes the oaisim simulator. Hardware will be defaulted to \"None\".
111 112 113 114 115 116
--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
117 118
--run-group 
   runs only specified test cases specified here. This flag is only valid with -s
119 120 121
-V | --vcd
   Adds a debgging facility to the binary files: GUI with major internal synchronization events
-x | --xforms
122
   Adds a software oscilloscope feature to the produced binaries. If oaisim, then enable PRINT_STATS.
123
--install-system-files
gauthier's avatar
gauthier committed
124
   Install OpenArInterface required files in Linux system
125
   (will ask root password)
126 127
--noS1 
   Compiles oaisim or lte-softmodem without S1 interface, using direct link to IP instead
128 129
--verbose-compile
   Shows detailed compilation instructions in makefile
130 131
--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
132 133
--build-doxygen
   Builds doxygen based documentation.
134
--disable-deadline
135 136
   Disables deadline scheduler of Linux kernel (>=3.14.x).
--enable-deadline
laurent's avatar
laurent committed
137
   Enable deadline scheduler of Linux kernel (>=3.14.x). 
138
--disable-cpu-affinity
139
   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
140 141
--T-tracer
   Enables the T tracer.
Rohit Gupta's avatar
Rohit Gupta committed
142 143
--disable-hardware-dependency
   Disable HW dependency during installation
144 145
--ue-autotest-trace
    Enable specific traces for UE autotest framework
146 147
--build-eclipse
   Build eclipse project files. Paths are auto corrected by fixprj.sh
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"
186
            CMAKE_CMD="$CMAKE_CMD -DCMAKE_BUILD_TYPE=Debug"
thomasl's avatar
thomasl committed
187
            shift;;
188 189 190 191
       --eNB)
            eNB=1
            echo_info "Will compile eNB"
            shift;;
192 193 194 195
       -a | --agent)
	    FLEXRAN_AGENT=1
	    echo_info "Will compile eNB with agent support"
	    shift;;
196 197 198 199
       --UE)
            UE=1
            echo_info "Will compile UE"
            shift;;
Cedric Roux's avatar
Cedric Roux committed
200 201 202 203
       --UE-conf-nvram)
            conf_nvram_path=$(readlink -f "$1")
            shift 2;;
        --UE-gen-nvram)
204 205
            gen_nvram_path=$(readlink -f $2)
            shift 2;;
206 207 208 209
       --RRH)
            RRH=1
            echo_info "Will compile RRH"
            shift;;
thomasl's avatar
thomasl committed
210
       -r | --3gpp-release)
gauthier's avatar
gauthier committed
211
            REL=$2
212
            echo_info "Setting release to: $REL"
thomasl's avatar
thomasl committed
213 214 215
            shift 2;;
       -w | --hardware)
            HW="$2" #"${i#*=}"
216
            # Use OAI_USRP  as the key word USRP is used inside UHD driver           
217
	    if [ "$HW" != "BLADERF" -a  "$HW" != "USRP" -a "$HW" != "LMSSDR" -a  "$HW" != "None" -a  "$HW" != "EXMIMO"  ] ; then 
218 219 220 221 222 223 224 225
		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
226 227 228
		if [ "$HW" == "LMSSDR" ] ; then 
		    HW="OAI_LMSSDR"
		fi 
229 230
		echo_info "Setting hardware to: $HW"
	    fi
thomasl's avatar
thomasl committed
231
            shift 2;;
232 233
	-t | --transport_protocol)
            TP="$2" #"${i#*=}"
234 235 236 237 238
	    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
239
            shift 2;;
240
	--oaisim)
241 242 243 244
            oaisim=1
            echo_info "Will compile oaisim and drivers nasmesh, ..."
            shift;;
       --phy_simulators)
thomasl's avatar
thomasl committed
245
            SIMUS_PHY=1
246 247 248 249 250 251
            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
252 253
       -s | --check)
            OAI_TEST=1
254
            echo_info "Will run auto-tests"
thomasl's avatar
thomasl committed
255
            shift;;
256 257 258 259 260
       --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
261
       -V | --vcd)
262
            echo_info "Setting gtk-wave output"
thomasl's avatar
thomasl committed
263 264
            VCD_TIMING=1
            EXE_ARGUMENTS="$EXE_ARGUMENTS -V"
thomasl's avatar
thomasl committed
265
            shift;;
thomasl's avatar
thomasl committed
266
       -x | --xforms)
267
            XFORMS="True"
thomasl's avatar
thomasl committed
268
            EXE_ARGUMENTS="$EXE_ARGUMENTS -d"
269
            echo_info "Will generate the software oscilloscope features"
thomasl's avatar
thomasl committed
270
            shift;;
271 272 273 274
       --install-system-files)
            INSTALL_SYSTEM_FILES=1
            echo_info "Will copy OpenAirInterface files in Linux directories"
            shift;;
275 276 277 278
       --noS1)
	    NOS1=1
            echo_info "Will compile without S1 interface"
            shift;;
279 280 281 282
       --verbose-compile)
	    VERBOSE_COMPILE=1
            echo_info "Will compile with verbose instructions"
            shift;;
283 284
       --cflags_processor)
            CFLAGS_PROCESSOR_USER=$2
285
            echo_info "Setting CPU FLAGS from USER to: $CFLAGS_PROCESSOR_USER"
286
            shift 2;;
287 288 289 290
       --build-doxygen)
	    BUILD_DOXYGEN=1
            echo_info "Will build doxygen support"
            shift;;     
291
       --disable-deadline)
laurent's avatar
laurent committed
292
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="False"
293 294
            echo_info "Disabling the usage of deadline scheduler"
            shift 1;;
295
       --enable-deadline)
laurent's avatar
laurent committed
296
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="True"
297 298
            echo_info "Enabling the usage of deadline scheduler"
            shift 1;;
299 300 301 302
       --disable-cpu-affinity)
            CPU_AFFINITY_FLAG_USER="False"
            echo_info "Disabling CPU Affinity (only valid when not using deadline scheduler)"
            shift 1;;
303 304 305 306
       --T-tracer)
            T_TRACER="True"
            echo_info "Enabling the T tracer"
            shift 1;;
307 308 309 310
       --disable-hardware-dependency)
            echo_info "Disabling hardware dependency for compiling software"
            DISABLE_HARDWARE_DEPENDENCY="True"
            shift 1;;
311 312 313 314
        --ue-autotest-trace)
            UE_AUTOTEST_TRACE="True"
            echo_info "Enabling autotest specific trace for UE"
            shift 1;;
315 316 317 318
        --uhd-images-dir)
            UHD_IMAGES_DIR=$2
            echo_info "Downloading UHD images in the indicated location"
            shift 2;;
319 320 321 322 323
       --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
324 325 326
        -h | --help)
            print_help
            exit 1;;
gauthier's avatar
gauthier committed
327
	*)
328 329
	    print_help
            echo_fatal "Unknown option $1"
thomasl's avatar
thomasl committed
330
            break;;
thomasl's avatar
thomasl committed
331
   esac
332
  done
333
  
334 335 336
  CMAKE_CMD="$CMAKE_CMD .."
  echo_info "CMAKE_CMD=$CMAKE_CMD"
  
337
  #########################################################
338
  # check validity of HW and TP parameters for RRH and eNB
339
  #########################################################
340
  # to be discussed
341
  
342
  if [ "$eNB" = "1" ] ; then
343 344
      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!"
345
      fi
346 347
      if [ "$HW" = "None" ] ; then 
	  echo_info "No radio head has been selected (HW set to $HW)"	
348
      fi
349 350
      if [ "$TP" = "None" ] ; then
	  echo_info "No transport protocol has been selected (TP set to $TP)"	
351 352 353 354
      fi
  fi
  
  if [ "$RRH" = "1" ] ; then
355 356
      if [ "$TP" = "None" ] ; then
	  echo_fatal "A transport protocol (e.g. -t ETHERNET) must be defined!"
357
      fi
358 359
      if [ "$HW" = "None" ] ; then
	  echo_info "No radio head has been selected (HW set to $HW)"	
360 361
      fi
  fi
thomasl's avatar
thomasl committed
362

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

389
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
390
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
391 392
     CPU_AFFINITY_FLAG_USER="False"
  fi
393

laurent's avatar
laurent committed
394
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
395
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
396

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

405
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
406

gauthier's avatar
gauthier committed
407
  set_openair_env
408
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
409

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

421

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

700 701 702
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
703

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

709
	#oai_nw_drv
710 711 712
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
713
    fi
714

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

744
  # RRH compilation
745
  #####################
746 747
  if [ "$RRH" = "1" ] ; then

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

773
  fi
774 775 776 777 778 779 780 781 782 783 784 785
  
  # 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)
786
      if [ "$HW" != "None" ] ; then
787
	  rm -f liboai_device.so
788
	  rm -f $dbin/liboai_device.so
789 790


791
	  # link liboai_device.so with the selected RF device library
792
	  if [ "$HW" == "EXMIMO" ] ; then
793 794
	      
	      #add exmimo compilation
795
	      #TODO EXMIMO library support
796 797 798
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
799 800
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
801 802 803 804 805 806
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

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

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

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

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

851

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

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

main "$@"