build_oai 27.8 KB
Newer Older
thomasl's avatar
thomasl committed
1
#!/bin/bash
2 3 4 5 6
#/*
# * 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
7
# * the OAI Public License, Version 1.1  (the "License"); you may not use this file
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
# * 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 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=0
44
XFORMS="True"
Xu Bo's avatar
Xu Bo committed
45
UE_EXPANSION="False"
46
UESIM_EXPANSION="False"
47
PRINT_STATS="False"
thomasl's avatar
thomasl committed
48
VCD_TIMING="False"
laurent's avatar
laurent committed
49 50
DEADLINE_SCHEDULER_FLAG_USER="False"
FORCE_DEADLINE_SCHEDULER_FLAG_USER=""
51
CPU_AFFINITY_FLAG_USER="False" #Only valid when lowlatecy flag is set to False
Cedric Roux's avatar
Cedric Roux committed
52
REL="Rel14"
53
HW="None"
54
TP="None"
Lionel Gauthier's avatar
Lionel 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
BUILD_COVERITY_SCAN=0
62
T_TRACER="True"
Rohit Gupta's avatar
Rohit Gupta committed
63
DISABLE_HARDWARE_DEPENDENCY="False"
64
CMAKE_BUILD_TYPE=""
65
CMAKE_CMD="$CMAKE"
66
UE_AUTOTEST_TRACE="False"
gabrielC's avatar
gabrielC committed
67 68
UE_DEBUG_TRACE="False"
UE_TIMING_TRACE="False"
69
USRP_REC_PLAY="False"
70
BUILD_ECLIPSE=0
71
OPTIONAL_LIBRARIES="telnetsrv enbscope uescope msc"
72 73
trap handle_ctrl_c INT

74
function print_help() {
Cedric Roux's avatar
Cedric Roux committed
75
  echo_info "
76
This program installs OpenAirInterface Software
77
You should have ubuntu 16.xx or 18.04 updated
78 79 80 81
Options
-h
   This help
-c | --clean
Cedric Roux's avatar
Cedric Roux committed
82
   Erase all files to make a rebuild from start
83
-C | --clean-all
Cedric Roux's avatar
Cedric Roux committed
84
   Erase all files made by previous compilations, installations
85 86
--clean-kernel
   Erase previously installed features in kernel: iptables, drivers, ...
Lionel Gauthier's avatar
Lionel Gauthier committed
87
-I | --install-external-packages
88 89 90 91 92
   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
93
   Add debugging symbols to compilation directives. It also disables any compiler optimization. Only for debugging. Do not use in normal operation!
94 95 96
-h | --help
   Print this help
--eNB
97
   Makes the LTE softmodem
98
--UE
99
   Makes the UE specific parts (ue_ip, usim, nvram) from the given configuration file
Cedric Roux's avatar
Cedric Roux committed
100 101 102 103
--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\")
104 105
-a | --agent
   Enables agent for software-defined control of the eNB
106
-r | --3gpp-release
Cedric Roux's avatar
Cedric Roux committed
107
   default is Rel14,
108
   Rel8 limits the implementation to 3GPP Release 8 version
Cedric Roux's avatar
Cedric Roux committed
109
   Rel10 limits the implementation to 3GPP Release 10 version
110
-w | --hardware
111
   EXMIMO, USRP, BLADERF, LMSSDR, IRIS, None (Default)
112 113 114 115 116 117 118
   Adds this RF board support (in external packages installation and in compilation)
--phy_simulators
   Makes the unitary tests Layer 1 simulators
--core_simulators
   Makes the core security features unitary simulators
-s | --check
   runs a set of auto-tests based on simulators and several compilation tests
119 120
--run-group 
   runs only specified test cases specified here. This flag is only valid with -s
121 122 123
-V | --vcd
   Adds a debgging facility to the binary files: GUI with major internal synchronization events
--install-system-files
Lionel Gauthier's avatar
Lionel Gauthier committed
124
   Install OpenArInterface required files in Linux system
125
   (will ask root password)
126 127
--verbose-compile
   Shows detailed compilation instructions in makefile
128 129
--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
130 131
--build-doxygen
   Builds doxygen based documentation.
132 133
--build-coverity-scan
   Builds Coverity-Scan objects for upload
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
--disable-T-Tracer
   Disables 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
gabrielC's avatar
gabrielC committed
146 147 148 149
--ue-trace
    Enable traces for UE debugging
--ue-timing
    Enable traces for timing
150 151
--build-eclipse
   Build eclipse project files. Paths are auto corrected by fixprj.sh
152
--build-lib <libraries>
153
   Build optional shared library, <libraries> can be one or several of $OPTIONAL_LIBRARIES or \"all\"
154 155
--usrp-recplay
   Build for I/Q record-playback modes
156

157
Usage (first build):
158
 NI/ETTUS B201  + COTS UE : ./build_oai -I  --eNB --install-system-files -w USRP
159
Usage (Regular):
160 161
 Eurecom EXMIMO + OAI ENB : ./build_oai --eNB  
 NI/ETTUS B201  + OAI ENB : ./build_oai --eNB -w USRP"
162 163 164 165
}


function main() {
166

167 168
  until [ -z "$1" ]
  do
169
    case "$1" in
170 171 172 173 174
       -c | --clean)
            CLEAN=1
            shift;;
       -C | --clean-all)
            CLEAN_ALL=1
thomasl's avatar
thomasl committed
175
            shift;;
176 177 178
       --clean-kernel)
            clean_kernel
            echo_info "Erased iptables config and removed modules from kernel"
thomasl's avatar
thomasl committed
179
            shift;;
180
       -I | --install-external-packages)
181
            INSTALL_EXTERNAL=1
182
            echo_info "Will install external packages"
thomasl's avatar
thomasl committed
183
            shift;;
184
       --install-optional-packages)
thomasl's avatar
thomasl committed
185 186 187
            INSTALL_OPTIONAL=1
            echo_info "Will install optional packages"
            shift;;
188
       -g | --run-with-gdb)
thomasl's avatar
thomasl committed
189
            GDB=1
190 191
            CMAKE_BUILD_TYPE="Debug"
            echo_info "Will Compile with gdb symbols and disable compiler optimization"
192
            CMAKE_CMD="$CMAKE_CMD -DCMAKE_BUILD_TYPE=Debug --trace-expand"
thomasl's avatar
thomasl committed
193
            shift;;
194 195 196 197
       --eNB)
            eNB=1
            echo_info "Will compile eNB"
            shift;;
198
       -a | --agent)
199
	    echo_info "FlexRAN support is always compiled into the eNB"
200
	    shift;;
201 202 203 204
       --UE)
            UE=1
            echo_info "Will compile UE"
            shift;;
Xu Bo's avatar
Xu Bo committed
205 206 207 208
       --mu)
            UE_EXPANSION="True"
            echo_info "Will compile with UE_EXPANSION"
            shift;;
209 210 211 212
       --musim)
            UESIM_EXPANSION="True"
            echo_info "Will compile with UESIM_EXPANSION"
            shift;;
Cedric Roux's avatar
Cedric Roux committed
213
       --UE-conf-nvram)
214
            conf_nvram_path=$(readlink -f $2)
Cedric Roux's avatar
Cedric Roux committed
215 216
            shift 2;;
        --UE-gen-nvram)
217 218
            gen_nvram_path=$(readlink -f $2)
            shift 2;;
thomasl's avatar
thomasl committed
219
       -r | --3gpp-release)
Lionel Gauthier's avatar
Lionel Gauthier committed
220
            REL=$2
221
            echo_info "Setting release to: $REL"
thomasl's avatar
thomasl committed
222 223
            shift 2;;
       -w | --hardware)
224
            # Use OAI_USRP  as the key word USRP is used inside UHD driver           
225 226 227 228 229 230 231 232 233 234
                case "$2" in
                    "USRP" | "BLADERF" | "LMSSDR" | "IRIS" | "SIMU")
                        HW="OAI_"$2
                        ;;
                    "None")
                        HW="None"
                        ;;
                    *)
                        echo_fatal "Unknown HW type $HW: exit..."
                esac
235
		echo_info "Setting hardware to: $HW"
thomasl's avatar
thomasl committed
236
            shift 2;;
237
       --phy_simulators)
thomasl's avatar
thomasl committed
238
            SIMUS_PHY=1
239 240 241 242 243 244
            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
245 246
       -s | --check)
            OAI_TEST=1
247
            echo_info "Will run auto-tests"
thomasl's avatar
thomasl committed
248
            shift;;
249 250 251 252 253
       --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
254
       -V | --vcd)
255
            echo_info "Setting gtk-wave output"
thomasl's avatar
thomasl committed
256 257
            VCD_TIMING=1
            EXE_ARGUMENTS="$EXE_ARGUMENTS -V"
thomasl's avatar
thomasl committed
258
            shift;;
thomasl's avatar
thomasl committed
259
       -x | --xforms)
260
            XFORMS=1
thomasl's avatar
thomasl committed
261
            EXE_ARGUMENTS="$EXE_ARGUMENTS -d"
262
            echo_info "Will generate the software oscilloscope features"
thomasl's avatar
thomasl committed
263
            shift;;
264 265 266 267
       --install-system-files)
            INSTALL_SYSTEM_FILES=1
            echo_info "Will copy OpenAirInterface files in Linux directories"
            shift;;
268 269 270 271
       --verbose-compile)
	    VERBOSE_COMPILE=1
            echo_info "Will compile with verbose instructions"
            shift;;
272 273
       --cflags_processor)
            CFLAGS_PROCESSOR_USER=$2
274
            echo_info "Setting CPU FLAGS from USER to: $CFLAGS_PROCESSOR_USER"
275
            shift 2;;
276 277 278 279
       --build-doxygen)
	    BUILD_DOXYGEN=1
            echo_info "Will build doxygen support"
            shift;;     
280 281 282 283
       --build-coverity-scan)
           BUILD_COVERITY_SCAN=1
            echo_info "Will build Coverity-Scan objects for upload"
            shift;;
284
       --disable-deadline)
laurent's avatar
laurent committed
285
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="False"
286 287
            echo_info "Disabling the usage of deadline scheduler"
            shift 1;;
288
       --enable-deadline)
laurent's avatar
laurent committed
289
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="True"
290 291
            echo_info "Enabling the usage of deadline scheduler"
            shift 1;;
292 293 294 295
       --disable-cpu-affinity)
            CPU_AFFINITY_FLAG_USER="False"
            echo_info "Disabling CPU Affinity (only valid when not using deadline scheduler)"
            shift 1;;
296 297 298
       --disable-T-Tracer)
            T_TRACER="False"
            echo_info "Disabling the T tracer"
299
            shift 1;;
300 301 302 303
       --disable-hardware-dependency)
            echo_info "Disabling hardware dependency for compiling software"
            DISABLE_HARDWARE_DEPENDENCY="True"
            shift 1;;
304 305 306 307
        --ue-autotest-trace)
            UE_AUTOTEST_TRACE="True"
            echo_info "Enabling autotest specific trace for UE"
            shift 1;;
gabrielC's avatar
gabrielC committed
308 309 310 311 312 313 314 315
        --ue-trace)
            UE_DEBUG_TRACE="True"
            echo_info "Enabling UE trace for debug"
            shift 1;;
        --ue-timing)
            UE_TIMING_TRACE="True"
            echo_info "Enabling UE timing trace"
            shift 1;;
316 317 318 319
        --uhd-images-dir)
            UHD_IMAGES_DIR=$2
            echo_info "Downloading UHD images in the indicated location"
            shift 2;;
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"
oai's avatar
oai committed
324
            shift 1;;
325 326
       --build-lib) 
            BUILD_OPTLIB="" 
327 328 329 330 331
            if [  "$2" == "all" ] ; then
              BUILD_OPTLIB="$OPTIONAL_LIBRARIES"
              echo_info "Enabling build of all optional shared libraries ($OPTIONAL_LIBRARIES)" 
            else
              for alib in $2 ; do 
332
                for oklib in $OPTIONAL_LIBRARIES ; do
333 334 335 336 337
                  if [ "$alib" = "$oklib" ] ; then
                    BUILD_OPTLIB="$BUILD_OPTLIB $alib" 
                    echo_info "Enabling build of lib${alib}.so" 
                    fi   
                  done
338
                done
339 340 341
	          if [ "${BUILD_OPTLIB## }" != "$2" ] ; then
                 echo_fatal "Unknown optional library in $2, valid libraries are $OPTIONAL_LIBRARIES" 
              fi
342 343
            fi
            shift 2;;		
344 345 346 347
        --usrp-recplay)
            USRP_REC_PLAY="True"
            echo_info "Enabling USRP record playback mode"
            shift 1;;
thomasl's avatar
thomasl committed
348 349 350
        -h | --help)
            print_help
            exit 1;;
Lionel Gauthier's avatar
Lionel Gauthier committed
351
	*)
352 353
	    print_help
            echo_fatal "Unknown option $1"
thomasl's avatar
thomasl committed
354
            break;;
thomasl's avatar
thomasl committed
355
   esac
356
  done
357 358 359 360 361 362 363 364 365 366 367 368 369 370

  #########################################################
  # check if cov-build is installed
  #########################################################
  if [ "$BUILD_COVERITY_SCAN" == "1" ] ; then
      echo_info "Checking cov-build is installed"
      IS_INSTALLED=`which cov-build | grep -c cov-build || true`
      if [ $IS_INSTALLED -eq 1 ] ; then
          echo_info "Found cov-build"
      else
          echo_fatal "Did NOT find cov-build in PATH!"
      fi
  fi

371 372
  CMAKE_CMD="$CMAKE_CMD .."
  echo_info "CMAKE_CMD=$CMAKE_CMD"
373
  #########################################################
374
  # check validity of HW and TP parameters for eNB
375
  #########################################################
Aikaterini's avatar
Aikaterini committed
376
  # to be discussed
377
  
378
  if [ "$eNB" = "1" ] ; then
379
      if [ "$HW" = "None" -a  "$TP" = "None" ] ; then
380
	  echo_info "No local radio head and no transport protocol selected"
381
      fi
382 383
      if [ "$HW" = "None" ] ; then 
	  echo_info "No radio head has been selected (HW set to $HW)"	
384
      fi
385 386
      if [ "$TP" = "None" ] ; then
	  echo_info "No transport protocol has been selected (TP set to $TP)"	
387 388 389
      fi
  fi
  
390
  echo_info "RF HW set to $HW" 
391 392
    # If the user doesn't specify the Linux scheduler to use, we set a value
    if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
393
        DEADLINE_SCHEDULER_FLAG_USER="False"
394
  fi
395
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
396
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
397 398
     CPU_AFFINITY_FLAG_USER="False"
  fi
399

laurent's avatar
laurent committed
400
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
401
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
Aikaterini's avatar
Aikaterini committed
402

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

411
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
412

413
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
414

415 416 417 418 419 420 421 422 423 424
  # 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
425

426

427 428 429 430
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
431

432 433 434 435 436 437
  dbin=$OPENAIR_DIR/targets/bin
  dlog=$OPENAIR_DIR/cmake_targets/log
  mkdir -p $dbin $dlog

  if [ "$INSTALL_EXTERNAL" = "1" ] ; then
    echo_info "Installing packages"
438
    check_install_oai_software
439 440 441
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
442
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
443
        install_usrp_uhd_driver $UHD_IMAGES_DIR
444
      fi
445 446
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
447
      echo_info "installing packages for BLADERF support"
448
      check_install_bladerf_driver
449 450 451
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
452
    fi
453 454 455 456 457 458
    if [ "$HW" == "OAI_IRIS" ] ; then
      echo_info "installing packages for IRIS support"
      check_install_soapy
      #if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
      #  flash_firmware_iris
      #fi
459
    fi
460 461 462
    echo_info "installing protobuf/protobuf-c for flexran agent support"
    install_protobuf_from_source
    install_protobuf_c_from_source
463 464 465 466 467 468 469
  fi

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

470 471
  
  
472 473 474
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
475 476 477
    
    if [ "$T_TRACER" =  "False" ] ; then
        noLOGDirsuffix="_noLOG"
478
      fi
479 480
    lte_build_dir=lte_build_oai
      bin_suffix=""
481

482
    lte_build_dir="lte_build_oai${noLOGDirsuffix}"
483 484 485
# configuration module libraries, one currently available, using libconfig 
  config_libconfig_shlib=params_libconfig
  
486
  # first generate the CMakefile in the right directory
487
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
488

489
    # LTE softmodem compilation
490 491 492 493
    [ "$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
494
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
495
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
Xu Bo's avatar
Xu Bo committed
496
    echo "set ( UE_EXPANSION $UE_EXPANSION )"      >>  $cmake_file
497
#    echo "set ( PHY_TX_THREAD $UE_EXPANSION )"     >>  $cmake_file
498
    echo "set ( PRE_SCD_THREAD $UE_EXPANSION )"    >>  $cmake_file
499
    echo "set ( UESIM_EXPANSION $UESIM_EXPANSION )"      >>  $cmake_file
500 501 502
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
503 504
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
505
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
506
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
507
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
508
    echo "set (UE_AUTOTEST_TRACE $UE_AUTOTEST_TRACE)"        >>  $cmake_file
gabrielC's avatar
gabrielC committed
509 510
    echo "set (UE_DEBUG_TRACE $UE_DEBUG_TRACE)"        >>  $cmake_file
    echo "set (UE_TIMING_TRACE $UE_TIMING_TRACE)"        >>  $cmake_file
511
    echo "set (USRP_REC_PLAY $USRP_REC_PLAY)"        >>  $cmake_file
512
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
513
    cd  $DIR/$lte_build_dir/build
514
    eval $CMAKE_CMD
515 516
  fi

517 518
  if [ "$eNB" = "1" ] ; then
    lte_exec=lte-softmodem${bin_suffix}
519
    compilations \
520 521 522
	  $lte_build_dir $lte_exec \
	  $lte_exec $dbin/$lte_exec.$REL

523
	  
524
  fi
525

526
  if [ "$UE" = 1  ] ; then
527 528 529 530
    lte_exec=lte-uesoftmodem${bin_suffix}
    compilations \
        $lte_build_dir $lte_exec \
        $lte_exec $dbin/$lte_exec.$REL
531
        
532 533
    # ue_ip driver compilation
    compilations \
534 535
          $lte_build_dir ue_ip \
          CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
536

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

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

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

580 581 582
  if [ "$SIMUS_PHY" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
583 584 585
    # TODO: fix: dlsim_tm4 pucchsim prachsim pdcchsim pbchsim mbmssim
    #simlist="dlsim_tm4 dlsim ulsim pucchsim prachsim pdcchsim pbchsim mbmssim"
    simlist="dlsim ulsim"
586 587 588 589 590
    for f in $simlist ; do
      compilations \
      lte-simulators $f \
	  $f $dbin/$f.$REL
    done
591 592 593
    compilations \
          lte-simulators coding \
          libcoding.so $dbin/libcoding.so
594 595 596
#    compilations \
#	  lte-simulators $config_libconfig_shlib \
#	  lib$config_libconfig_shlib.so $dbin/lib$config_libconfig_shlib.so
597
  fi
thomasl's avatar
thomasl committed
598

Lionel Gauthier's avatar
Lionel Gauthier committed
599
  # Core simulators
600 601 602 603 604 605 606 607 608 609 610
  #############
  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
611

612 613
  # EXMIMO drivers & firmware loader
  ###############
614
  if [ "$HW" = "EXMIMO" ] ; then
Lionel Gauthier's avatar
Lionel Gauthier committed
615
    
616 617
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
618
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
619
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
620
    compilations \
621
	  $lte_build_dir updatefw \
Lionel Gauthier's avatar
Lionel Gauthier committed
622
	  updatefw $dbin/updatefw
623
    echo_info "Compiling oarf tools. The logfile for compilation is here: $dlog/oarf.txt"
624 625 626 627 628 629 630
    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
631
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
632
  fi
633
  # optional libraries
634
  #####################
635 636 637 638 639 640
  if [ ! -z "$BUILD_OPTLIB" ] ; then 
     for oklib in $BUILD_OPTLIB ; do
         compilations \
            $lte_build_dir $oklib \
                  lib${oklib}.so $dbin/lib${oklib}.so
     done
Aikaterini's avatar
Aikaterini committed
641

642
  fi 
643
 
644 645
  # build RF device, transport protocol libraries and all
  # shared libraries common to UE and eNB
646
  #####################################
647
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
# mandatory shared lib
    compilations \
	  $lte_build_dir $config_libconfig_shlib \
	  lib$config_libconfig_shlib.so $dbin/lib$config_libconfig_shlib.so
    compilations \
          $lte_build_dir coding \
          libcoding.so $dbin/libcoding.so
# optional libs (used when noS1 with kernel modules 
    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
663
      # build RF device libraries
664
      if [ "$HW" != "None" ] ; then
665
	  rm -f liboai_device.so
666
	  rm -f $dbin/liboai_device.so
667

668
	  # link liboai_device.so with the selected RF device library
669
	  if [ "$HW" == "OAI_USRP" ] ; then
670
              compilations \
671
                    $lte_build_dir oai_usrpdevif \
672
                  liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
673

674 675
	      ln -sf liboai_usrpdevif.so liboai_device.so
	      ln -sf $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
676 677
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
678 679
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
680
                        $lte_build_dir oai_bladerfdevif \
681 682 683
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

684 685
	      ln -sf liboai_bladerfdevif.so liboai_device.so
	      ln -sf $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
686
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
687
	  elif [ "$HW" == "OAI_LMSSDR" ] ; then
688
                #       if [ -f "/usr/include/libbladeRF.h" ] ; then
689
		  compilations \
690
                    $lte_build_dir oai_lmssdrdevif \
691
		      liboai_lmssdrdevif.so $dbin/liboai_lmssdrdevif.so.$REL
692
                #       fi
693

694 695
	      ln -sf liboai_lmssdrdevif.so liboai_device.so
	      ln -sf $dbin/liboai_lmssdrdevif.so.$REL $dbin/liboai_device.so
696
	      echo_info "liboai_device.so is linked to LMSSDR device library"	 
697 698
          elif [ "$HW" == "OAI_IRIS" ] ; then
                  compilations \
699
                    $lte_build_dir oai_irisdevif \
700 701 702 703 704
                      liboai_irisdevif.so $dbin/liboai_irisdevif.so.$REL

              ln -s liboai_irisdevif.so liboai_device.so
              ln -s $dbin/liboai_irisdevif.so.$REL $dbin/liboai_device.so
              echo_info "liboai_device.so is linked to IRIS device library"
705 706 707 708 709
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
710 711 712 713 714 715 716 717 718 719 720
        # build simulators devices
        echo_info "Compiling rfsimulator"
        compilations \
            $lte_build_dir rfsimulator \
            librfsimulator.so $dbin/librfsimulator.so.$REL
        echo_info "Compiling basicsimulator"
        compilations \
            $lte_build_dir tcp_bridge_oai \
            libtcp_bridge_oai.so $dbin/libtcp_bridge_oai.so.$REL
        # build transport protocol libraries (currently only ETHERNET is available)

721
	  rm -f liboai_transpro.so
722
	  rm -f $dbin/liboai_transpro.so
723
	      compilations \
724
            $lte_build_dir oai_eth_transpro \
725
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
726 727
	      ln -sf liboai_eth_transpro.so liboai_transpro.so
	      ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
728
        echo_info "liboai_transpro.so is linked to ETHERNET transport"
729 730
      fi

731
    if [ "$HW" == "OAI_SIMU" ] ; then
732 733 734 735 736
        echo_info "Compiling rfsimulator"
        compilations \
            $lte_build_dir rfsimulator \
            librfsimulator.so $dbin/librfsimulator.so.$REL
    fi
737

738 739 740 741 742 743 744 745 746 747 748
  # 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
749
    eval $CMAKE_CMD
750 751
    make doc
    ) >& $doxygen_log
752 753
  fi

Lionel Gauthier's avatar
Lionel Gauthier committed
754 755 756
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
757
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
758 759 760 761
    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 "
762 763
    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 "
764
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
765 766 767
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
768 769
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
770
    if [ "$RUN_GROUP" -eq "1" ]; then
771
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
772
    else
773
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
774
    fi
775
    wait
Lionel Gauthier's avatar
Lionel Gauthier committed
776
  else
thomasl's avatar
thomasl committed
777
    echo_info "10. Bypassing the Tests ..."
Lionel Gauthier's avatar
Lionel Gauthier committed
778
  fi
779

780 781 782
}

main "$@"