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

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


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

knopp's avatar
knopp committed
331
  echo_info "RF HW set to $HW" 
332 333 334 335
  #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
336
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
337
     if [ "$HW" = "EXMIMO" ] ; then 
338
        DEADLINE_SCHEDULER_FLAG_USER="True"
339
     elif [ "$HW" = "ETHERNET" ] ; then 
340
        DEADLINE_SCHEDULER_FLAG_USER="False"
341
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
342
        DEADLINE_SCHEDULER_FLAG_USER="False"
343
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
344
        DEADLINE_SCHEDULER_FLAG_USER="False"
345
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
346
        DEADLINE_SCHEDULER_FLAG_USER="False"
347
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
348
        DEADLINE_SCHEDULER_FLAG_USER="False"
349 350 351 352 353
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
354
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
355 356
  fi

Rohit Gupta's avatar
Rohit Gupta committed
357
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
358
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
Rohit Gupta's avatar
Rohit Gupta committed
359 360
     CPU_AFFINITY_FLAG_USER="False"
  fi
361

laurent's avatar
laurent committed
362
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
Rohit Gupta's avatar
Rohit Gupta committed
363
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
364

365 366 367
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
368

369
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
370

gauthier's avatar
gauthier committed
371
  set_openair_env
372
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
373

374 375 376 377 378 379 380 381 382 383
  # 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
384

385

386 387 388 389
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
390

391 392 393 394 395 396 397
  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
398 399 400
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
401 402 403
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        install_usrp_uhd_driver
      fi
404 405
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
406
      echo_info "installing packages for BLADERF support"
407
      check_install_bladerf_driver
408 409 410
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
411
    fi
412 413 414 415 416 417 418
  fi

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

419
  if [ "$oaisim" = "1" ] ; then
420 421 422 423 424
      #to be discussed
      # there is no RF device and no transport protocol 
      HW="None" 
      TP="None"
      
425 426 427 428 429 430
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
431 432 433
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
434 435 436 437 438 439 440
  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
441

442 443
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
444

445
    # LTE softmodem compilation
446 447 448 449 450 451 452
    [ "$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
453
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
454
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
455
    echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
456 457 458
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
459 460 461
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
462 463
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
464
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
Rohit Gupta's avatar
Rohit Gupta committed
465
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
466
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
467
    echo "set (UE_AUTOTEST_TRACE $UE_AUTOTEST_TRACE)"        >>  $cmake_file
468
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
469
    cd  $DIR/$lte_build_dir/build
470
    cmake ..
471 472
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
473
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
474
    echo_info "Compiling $lte_exec"
475
    compilations \
476 477 478 479 480 481 482 483 484 485 486 487
	  $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
488
  fi
thomasl's avatar
thomasl committed
489

Florian Kaltenberger's avatar
Florian Kaltenberger committed
490
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
491 492 493
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
494
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
495
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
496

gauthier's avatar
gauthier committed
497 498 499 500 501 502
#    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
503
    
gauthier's avatar
gauthier committed
504
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
505 506
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
507
    
508
    cmake ..
thomasl's avatar
thomasl committed
509
    compilations \
510 511
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
512
    compilations \
513 514 515 516 517 518
      nas_sim_tools nvram \
      nvram $dbin/nvram

    # generate USIM data
    if [ -f $dbin/nvram ]; then
      install_nas_tools $dbin $dconf
519 520 521 522 523
      echo_info "Copying UE specific part to $DIR/$lte_build_dir/build"
      cp -Rvf $dbin/.ue_emm.nvram $DIR/$lte_build_dir/build
      cp -Rvf $dbin/.ue.nvram $DIR/$lte_build_dir/build
      cp -Rvf $dbin/.usim.nvram $DIR/$lte_build_dir/build

524 525 526
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
527
  fi
thomasl's avatar
thomasl committed
528

529
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
530 531 532 533 534 535
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
536
  fi
537

538 539 540 541 542 543 544 545 546 547
  if [ "$SIMUS_PHY" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
    simlist="dlsim ulsim pucchsim prachsim pdcchsim pbchsim mbmssim"
    for f in $simlist ; do
      compilations \
      lte-simulators $f \
	  $f $dbin/$f.$REL
    done
  fi
thomasl's avatar
thomasl committed
548

gauthier's avatar
gauthier committed
549
  # Core simulators
550 551 552 553 554 555 556 557 558 559 560
  #############
  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
561

562 563
  # EXMIMO drivers & firmware loader
  ###############
564
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
565
    
566 567
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
568
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
569
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
570
    compilations \
571
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
572
	  updatefw $dbin/updatefw
573
    echo_info "Compiling oarf tools. The logfile for compilation is here: $dlog/oarf.txt"
574 575 576 577 578 579 580
    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
581
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
582
  fi
thomasl's avatar
thomasl committed
583

584 585
  # oaisim compilation
  ###############
586
  if [ "$oaisim" = "1" ] ; then
587
    dconf=$OPENAIR_DIR/targets/bin
588 589 590 591 592 593 594
      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
595
    
596 597 598
    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
599
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
600
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
601
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
602 603 604
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
605 606 607
    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
608
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
609
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
610 611 612
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
613 614
    cmake ..
    compilations \
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
	  $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

	# generate USIM data
	if [ -f $dbin/nvram ]; then
	    install_nas_tools $dbin $dconf
	else
	    echo_warning "not generated UE NAS files: binaries not found"
	fi
652 653
    else

654 655 656
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
657

658 659 660 661
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
662

663
	#oai_nw_drv
Cedric Roux's avatar
Cedric Roux committed
664 665 666
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
667
    fi
668

669 670
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
671 672
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
673 674 675
    if [ "$FLEXRAN_AGENT" = "1" ] ; then
	echo "set ( FLEXRAN_AGENT_SB_IF $FLEXRAN_AGENT_SB_IF )"      >>  $cmake_file
    fi
676 677
    echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
678
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
679
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
680 681 682 683 684 685 686
    #[ "$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
687 688
  fi

689
  # RRH compilation
690
  #####################
691 692
  if [ "$RRH" = "1" ] ; then

693 694 695 696 697
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
698 699
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
700 701
     cmake_file=$DIR/$rrh_build_dir/CMakeLists.txt
     echo "cmake_minimum_required(VERSION 2.8)"   >   $cmake_file
702 703 704 705 706 707 708 709
     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
710
     echo "set ( T_TRACER $T_TRACER )"            >>  $cmake_file
711
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
712 713 714 715 716
     cd $DIR/$rrh_build_dir/build
     cmake ..
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
717

718
  fi
719 720 721 722 723 724 725 726 727 728 729 730
  
  # 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)
731
      if [ "$HW" != "None" ] ; then
732
	  rm -f liboai_device.so
733
	  rm -f $dbin/liboai_device.so
734 735


736
	  # link liboai_device.so with the selected RF device library
737
	  if [ "$HW" == "EXMIMO" ] ; then
738 739
	      
	      #add exmimo compilation
740
	      #TODO EXMIMO library support
741 742 743
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
744 745
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
746 747 748 749 750 751
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

752
	      ln -s liboai_usrpdevif.so liboai_device.so
753
	      ln -s $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
754 755
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
756 757 758 759 760 761
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

762
	      ln -s liboai_bladerfdevif.so liboai_device.so
763
	      ln -s $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
764
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
765 766 767 768 769 770 771 772 773 774
	  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

	      ln -s liboai_lmssdrdevif.so liboai_device.so
	      ln -s $dbin/liboai_lmssdrdevif.so.$REL $dbin/liboai_device.so
	      echo_info "liboai_device.so is linked to LMSSDR device library"	 
775 776 777 778 779 780
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
781
      if [ "$TP" != "None" ] ; then
782
	  rm -f liboai_transpro.so
783 784
	  rm -f $dbin/liboai_transpro.so

785
	  if [ "$TP" == "ETHERNET" ] ; then
786 787 788
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
789
	      ln -s liboai_eth_transpro.so liboai_transpro.so
790
	      ln -s $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
791 792 793 794 795
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

796

797 798 799 800 801 802 803 804 805 806 807
  # 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
808
    cmake ..
809 810
    make doc
    ) >& $doxygen_log
811 812
  fi

gauthier's avatar
gauthier committed
813 814 815
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
816
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
817 818 819 820
    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 "
821 822
    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 "
823
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
824 825 826
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
827 828
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
829
    if [ "$RUN_GROUP" -eq "1" ]; then
830
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
831
    else
832
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
833
    fi
834
    wait
gauthier's avatar
gauthier committed
835
  else
thomasl's avatar
thomasl committed
836
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
837
  fi
838 839 840
}

main "$@"