build_oai 37.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
Cedric Roux's avatar
Cedric Roux committed
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

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

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

36 37 38 39 40 41 42
# set environment variables (OPENAIR_HOME, ...)
set_openair_env

#variables for UE data generation
gen_nvram_path=$OPENAIR_DIR/targets/bin
conf_nvram_path=$OPENAIR_DIR/openair3/NAS/TOOLS/ue_eurecom_test_sfr.conf

43
MSC_GEN="False"
44
XFORMS="True"
45
PRINT_STATS="False"
thomasl's avatar
thomasl committed
46
VCD_TIMING="False"
laurent's avatar
laurent committed
47 48
DEADLINE_SCHEDULER_FLAG_USER="False"
FORCE_DEADLINE_SCHEDULER_FLAG_USER=""
49
CPU_AFFINITY_FLAG_USER="False" #Only valid when lowlatecy flag is set to False
Cedric Roux's avatar
Cedric Roux committed
50
REL="Rel14"
51
HW="None"
52
TP="None"
Florian Kaltenberger's avatar
Florian Kaltenberger committed
53
NOS1=0
gauthier's avatar
gauthier committed
54
EPC=0
55
VERBOSE_COMPILE=0
56
CFLAGS_PROCESSOR_USER=""
57 58
RUN_GROUP=0
TEST_CASE_GROUP=""
59
BUILD_DOXYGEN=0
60
T_TRACER="False"
Rohit Gupta's avatar
Rohit Gupta committed
61
DISABLE_HARDWARE_DEPENDENCY="False"
62
CMAKE_BUILD_TYPE=""
63
CMAKE_CMD="$CMAKE"
64
UE_AUTOTEST_TRACE="False"
Gabriel's avatar
Gabriel committed
65 66
UE_DEBUG_TRACE="False"
UE_TIMING_TRACE="False"
Cedric Roux's avatar
Cedric Roux committed
67
DISABLE_LOG_X="False"
68
USRP_REC_PLAY="False"
69
BUILD_ECLIPSE=0
70
UE_NAS_USE_TUN="False"
Cedric Roux's avatar
Cedric Roux committed
71
BASIC_SIMULATOR=0
72 73
trap handle_ctrl_c INT

74
function print_help() {
Cedric Roux's avatar
Cedric Roux committed
75
  echo_info "
76 77 78 79 80 81
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
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, ...
gauthier's avatar
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
-r | --3gpp-release
Cedric Roux's avatar
Cedric Roux committed
105
   default is Rel14,
106
   Rel8 limits the implementation to 3GPP Release 8 version
Cedric Roux's avatar
Cedric Roux committed
107
   Rel10 limits the implementation to 3GPP Release 10 version
108
-w | --hardware
109
   EXMIMO, USRP, BLADERF, ETHERNET, LMSSDR, None (Default)
110
   Adds this RF board support (in external packages installation and in compilation)
111 112 113
-t | --transport protocol
   ETHERNET , None
   Adds this trasport protocol support in compilation
114
--oaisim
Cedric Roux's avatar
Cedric Roux committed
115
   Makes the oaisim simulator. Hardware will be defaulted to \"None\".
116 117 118 119 120 121
--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
122 123
--run-group 
   runs only specified test cases specified here. This flag is only valid with -s
124 125 126
-V | --vcd
   Adds a debgging facility to the binary files: GUI with major internal synchronization events
-x | --xforms
127
   Adds a software oscilloscope feature to the produced binaries. If oaisim, then enable PRINT_STATS.
128
--install-system-files
gauthier's avatar
gauthier committed
129
   Install OpenArInterface required files in Linux system
130
   (will ask root password)
131 132
--noS1 
   Compiles oaisim or lte-softmodem without S1 interface, using direct link to IP instead
133 134
--verbose-compile
   Shows detailed compilation instructions in makefile
135 136
--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
137 138
--build-doxygen
   Builds doxygen based documentation.
139
--disable-deadline
140 141
   Disables deadline scheduler of Linux kernel (>=3.14.x).
--enable-deadline
laurent's avatar
laurent committed
142
   Enable deadline scheduler of Linux kernel (>=3.14.x). 
Rohit Gupta's avatar
Rohit Gupta committed
143
--disable-cpu-affinity
144
   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
145 146
--T-tracer
   Enables the T tracer.
Rohit Gupta's avatar
Rohit Gupta committed
147 148
--disable-hardware-dependency
   Disable HW dependency during installation
149 150
--ue-autotest-trace
    Enable specific traces for UE autotest framework
Gabriel's avatar
Gabriel committed
151 152 153 154
--ue-trace
    Enable traces for UE debugging
--ue-timing
    Enable traces for timing
Cedric Roux's avatar
Cedric Roux committed
155 156
--disable-log
   Disable all LOG_* macros
157 158
--build-eclipse
   Build eclipse project files. Paths are auto corrected by fixprj.sh
159 160
--usrp-recplay
   Build for I/Q record-playback modes
161 162
--ue-nas-use-tun
   Use TUN devices for the UEs instead of ue_ip.ko
Cedric Roux's avatar
Cedric Roux committed
163 164 165
--basic-simulator
   Generates a basic [1 UE + 1 eNB + no channel] simulator.
   See targets/ARCH/tcp_bridge/README.tcp_bridge_oai for documentation.
166
Usage (first build):
167 168 169
 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
170 171 172
Usage (Regular):
 oaisim : ./build_oai --oaisim -x 
 Eurecom EXMIMO + OAI ENB : ./build_oai --eNB -x 
Cedric Roux's avatar
Cedric Roux committed
173
 NI/ETTUS B201  + OAI ENB : ./build_oai --eNB -x -w USRP"
174 175 176 177
}


function main() {
178

179 180
  until [ -z "$1" ]
  do
181
    case "$1" in
182 183 184 185 186
       -c | --clean)
            CLEAN=1
            shift;;
       -C | --clean-all)
            CLEAN_ALL=1
thomasl's avatar
thomasl committed
187
            shift;;
188 189 190
       --clean-kernel)
            clean_kernel
            echo_info "Erased iptables config and removed modules from kernel"
thomasl's avatar
thomasl committed
191
            shift;;
192
       -I | --install-external-packages)
193
            INSTALL_EXTERNAL=1
194
            echo_info "Will install external packages"
thomasl's avatar
thomasl committed
195
            shift;;
196
       --install-optional-packages)
thomasl's avatar
thomasl committed
197 198 199
            INSTALL_OPTIONAL=1
            echo_info "Will install optional packages"
            shift;;
200
       -g | --run-with-gdb)
thomasl's avatar
thomasl committed
201
            GDB=1
202 203
            CMAKE_BUILD_TYPE="Debug"
            echo_info "Will Compile with gdb symbols and disable compiler optimization"
204
            CMAKE_CMD="$CMAKE_CMD -DCMAKE_BUILD_TYPE=Debug --trace-expand"
thomasl's avatar
thomasl committed
205
            shift;;
206 207 208 209
       --eNB)
            eNB=1
            echo_info "Will compile eNB"
            shift;;
210
       -a | --agent)
211
	    echo_info "FlexRAN support is always compiled into the eNB"
212
	    shift;;
213 214 215 216
       --UE)
            UE=1
            echo_info "Will compile UE"
            shift;;
Cedric Roux's avatar
Cedric Roux committed
217 218 219 220
       --UE-conf-nvram)
            conf_nvram_path=$(readlink -f "$1")
            shift 2;;
        --UE-gen-nvram)
221 222
            gen_nvram_path=$(readlink -f $2)
            shift 2;;
thomasl's avatar
thomasl committed
223
       -r | --3gpp-release)
gauthier's avatar
gauthier committed
224
            REL=$2
225
            echo_info "Setting release to: $REL"
thomasl's avatar
thomasl committed
226 227 228
            shift 2;;
       -w | --hardware)
            HW="$2" #"${i#*=}"
229
            # Use OAI_USRP  as the key word USRP is used inside UHD driver           
230
	    if [ "$HW" != "BLADERF" -a  "$HW" != "USRP" -a "$HW" != "LMSSDR" -a  "$HW" != "None" -a  "$HW" != "EXMIMO"  ] ; then 
231 232 233 234 235 236 237 238
		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
239 240 241
		if [ "$HW" == "LMSSDR" ] ; then 
		    HW="OAI_LMSSDR"
		fi 
242 243
		echo_info "Setting hardware to: $HW"
	    fi
thomasl's avatar
thomasl committed
244
            shift 2;;
245 246
	-t | --transport_protocol)
            TP="$2" #"${i#*=}"
247 248 249 250 251
	    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
252
            shift 2;;
253
	--oaisim)
254 255 256 257
            oaisim=1
            echo_info "Will compile oaisim and drivers nasmesh, ..."
            shift;;
       --phy_simulators)
thomasl's avatar
thomasl committed
258
            SIMUS_PHY=1
259 260 261 262 263 264
            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
265 266
       -s | --check)
            OAI_TEST=1
267
            echo_info "Will run auto-tests"
thomasl's avatar
thomasl committed
268
            shift;;
269 270 271 272 273
       --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
274
       -V | --vcd)
275
            echo_info "Setting gtk-wave output"
thomasl's avatar
thomasl committed
276 277
            VCD_TIMING=1
            EXE_ARGUMENTS="$EXE_ARGUMENTS -V"
thomasl's avatar
thomasl committed
278
            shift;;
thomasl's avatar
thomasl committed
279
       -x | --xforms)
280
            XFORMS="True"
thomasl's avatar
thomasl committed
281
            EXE_ARGUMENTS="$EXE_ARGUMENTS -d"
282
            echo_info "Will generate the software oscilloscope features"
thomasl's avatar
thomasl committed
283
            shift;;
284 285 286 287
       --install-system-files)
            INSTALL_SYSTEM_FILES=1
            echo_info "Will copy OpenAirInterface files in Linux directories"
            shift;;
288 289 290 291
       --noS1)
	    NOS1=1
            echo_info "Will compile without S1 interface"
            shift;;
292 293 294 295
       --verbose-compile)
	    VERBOSE_COMPILE=1
            echo_info "Will compile with verbose instructions"
            shift;;
296 297
       --cflags_processor)
            CFLAGS_PROCESSOR_USER=$2
298
            echo_info "Setting CPU FLAGS from USER to: $CFLAGS_PROCESSOR_USER"
299
            shift 2;;
300 301 302 303
       --build-doxygen)
	    BUILD_DOXYGEN=1
            echo_info "Will build doxygen support"
            shift;;     
304
       --disable-deadline)
laurent's avatar
laurent committed
305
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="False"
306 307
            echo_info "Disabling the usage of deadline scheduler"
            shift 1;;
308
       --enable-deadline)
laurent's avatar
laurent committed
309
            FORCE_DEADLINE_SCHEDULER_FLAG_USER="True"
310 311
            echo_info "Enabling the usage of deadline scheduler"
            shift 1;;
Rohit Gupta's avatar
Rohit Gupta committed
312 313 314 315
       --disable-cpu-affinity)
            CPU_AFFINITY_FLAG_USER="False"
            echo_info "Disabling CPU Affinity (only valid when not using deadline scheduler)"
            shift 1;;
316 317 318 319
       --T-tracer)
            T_TRACER="True"
            echo_info "Enabling the T tracer"
            shift 1;;
320 321 322 323
       --disable-hardware-dependency)
            echo_info "Disabling hardware dependency for compiling software"
            DISABLE_HARDWARE_DEPENDENCY="True"
            shift 1;;
324 325 326 327
        --ue-autotest-trace)
            UE_AUTOTEST_TRACE="True"
            echo_info "Enabling autotest specific trace for UE"
            shift 1;;
Gabriel's avatar
Gabriel committed
328 329 330 331 332 333 334 335
        --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;;
Cedric Roux's avatar
Cedric Roux committed
336 337 338 339
        --disable-log)
            DISABLE_LOG_X="True"
            echo_info "Disabling all LOG_* traces"
            shift 1;;
340 341 342 343
        --uhd-images-dir)
            UHD_IMAGES_DIR=$2
            echo_info "Downloading UHD images in the indicated location"
            shift 2;;
344 345 346 347
       --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
348 349 350 351 352
            shift 1;;
       --build-telnetsrv)
            BUILD_TELNETSRV=1
            echo_info "Build embedded telnet server"
            shift ;;			
353 354 355 356
        --usrp-recplay)
            USRP_REC_PLAY="True"
            echo_info "Enabling USRP record playback mode"
            shift 1;;
357 358 359 360
        --ue-nas-use-tun)
            UE_NAS_USE_TUN="True"
            echo_info "Enabling UE NAS TUN device usage instead of ue_ip.ko"
            shift 1;;
Cedric Roux's avatar
Cedric Roux committed
361 362 363 364
        --basic-simulator)
            BASIC_SIMULATOR=1
            echo_info "Compiling the basic simulator"
            shift 1;;
thomasl's avatar
thomasl committed
365 366 367
        -h | --help)
            print_help
            exit 1;;
gauthier's avatar
gauthier committed
368
	*)
369 370
	    print_help
            echo_fatal "Unknown option $1"
thomasl's avatar
thomasl committed
371
            break;;
thomasl's avatar
thomasl committed
372
   esac
373
  done
374
  
375 376
  CMAKE_CMD="$CMAKE_CMD .."
  echo_info "CMAKE_CMD=$CMAKE_CMD"
377 378 379 380 381
  if [ "$eNB" = "1" ] && [ "$UE" = "1" ]; then
    echo_error "Cannot build UE and eNB on one build_oai execution"
    echo_error "use 2 build_oai invocations"
    exit
  fi  
382
  #########################################################
383
  # check validity of HW and TP parameters for eNB
384
  #########################################################
385
  # to be discussed
386
  
387
  if [ "$eNB" = "1" ] ; then
388 389
      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!"
390
      fi
391 392
      if [ "$HW" = "None" ] ; then 
	  echo_info "No radio head has been selected (HW set to $HW)"	
393
      fi
394 395
      if [ "$TP" = "None" ] ; then
	  echo_info "No transport protocol has been selected (TP set to $TP)"	
396 397 398
      fi
  fi
  
knopp's avatar
knopp committed
399
  echo_info "RF HW set to $HW" 
400 401 402 403
  #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
404
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
405
     if [ "$HW" = "EXMIMO" ] ; then 
406
        DEADLINE_SCHEDULER_FLAG_USER="True"
407
     elif [ "$HW" = "ETHERNET" ] ; then 
408
        DEADLINE_SCHEDULER_FLAG_USER="False"
409
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
410
        DEADLINE_SCHEDULER_FLAG_USER="False"
411
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
412
        DEADLINE_SCHEDULER_FLAG_USER="False"
413
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
414
        DEADLINE_SCHEDULER_FLAG_USER="False"
415
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
416
        DEADLINE_SCHEDULER_FLAG_USER="False"
417 418 419 420 421
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
422
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
423 424
  fi

Rohit Gupta's avatar
Rohit Gupta committed
425
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
426
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
Rohit Gupta's avatar
Rohit Gupta committed
427 428
     CPU_AFFINITY_FLAG_USER="False"
  fi
429

laurent's avatar
laurent committed
430
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
Rohit Gupta's avatar
Rohit Gupta committed
431
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
432

433 434 435 436
  if [ -n "$UHD_IMAGES_DIR" ] && [ -z "$INSTALL_EXTERNAL" ]; then
    echo_error "UHD images download settings will not be applied without -I present"
    exit
  fi
437 438 439
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
440

441
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
442

443
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
444

445 446 447 448 449 450 451 452 453 454
  # 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
455

456

457 458 459 460
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
461

462 463 464 465 466 467 468
  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
469 470 471
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
472
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
473
        install_usrp_uhd_driver $UHD_IMAGES_DIR
474
      fi
475 476
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
477
      echo_info "installing packages for BLADERF support"
478
      check_install_bladerf_driver
479 480 481
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
482
    fi
483 484 485
    echo_info "installing protobuf/protobuf-c for flexran agent support"
    install_protobuf_from_source
    install_protobuf_c_from_source
486 487 488 489 490 491 492
  fi

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

493
  if [ "$oaisim" = "1" ] ; then
494
      #to be discussed
495
      # there is no RF device  transport protocol 
496
      HW="None" 
497
      TP="ETHERNET"
498
      
499 500 501 502 503 504
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
505 506 507
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
508 509
  if [ "$NOS1" =  "1" ] ; then
      lte_build_dir=lte_noS1_build_oai
510 511 512 513 514 515
      if [ "$eNB" = "1" ] ; then
         lte_exec=lte-softmodem-nos1
      fi
      if [ "$UE" = "1" ] ; then
         lte_exec=lte-uesoftmodem-nos1
      fi
516 517
  else
      lte_build_dir=lte_build_oai
518 519 520 521 522 523
      if [ "$eNB" = "1" ] ; then
         lte_exec=lte-softmodem
      fi
      if [ "$UE" = "1" ] ; then
         lte_exec=lte-uesoftmodem
      fi
524
  fi
525

526 527 528
# configuration module libraries, one currently available, using libconfig 
  config_libconfig_shlib=params_libconfig
  
529 530
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
531

532
    # LTE softmodem compilation
533 534 535 536 537 538 539
    [ "$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
540
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
541
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
542 543 544 545
    echo "set ( XFORMS $XFORMS )"                  >>  $cmake_file
    echo "set ( RRC_ASN1_VERSION \"${REL}\")"      >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )"     >>  $cmake_file
    echo "set ( RF_BOARD \"${HW}\")"               >>  $cmake_file
546 547
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
548
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
Rohit Gupta's avatar
Rohit Gupta committed
549
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
550
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
551
    echo "set (UE_AUTOTEST_TRACE $UE_AUTOTEST_TRACE)"        >>  $cmake_file
Gabriel's avatar
Gabriel committed
552 553
    echo "set (UE_DEBUG_TRACE $UE_DEBUG_TRACE)"        >>  $cmake_file
    echo "set (UE_TIMING_TRACE $UE_TIMING_TRACE)"        >>  $cmake_file
Cedric Roux's avatar
Cedric Roux committed
554
    echo "set (DISABLE_LOG_X $DISABLE_LOG_X)"        >>  $cmake_file
555
    echo "set (USRP_REC_PLAY $USRP_REC_PLAY)"        >>  $cmake_file
Gabriel's avatar
Gabriel committed
556 557 558 559 560
    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
561
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
562
    cd  $DIR/$lte_build_dir/build
563
    eval $CMAKE_CMD
564 565
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
566
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
567
    echo_info "Compiling $lte_exec"
568
    compilations \
569 570 571
	  $lte_build_dir $lte_exec \
	  $lte_exec $dbin/$lte_exec.$REL

572 573 574 575
# mandatory shared lib
    compilations \
	  $lte_build_dir $config_libconfig_shlib \
	  lib$config_libconfig_shlib.so $dbin/lib$config_libconfig_shlib.so
576 577 578
    compilations \
          $lte_build_dir coding \
          libcoding.so $dbin/libcoding.so
579
	  
580 581 582 583 584 585 586 587 588
    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
589
  fi
thomasl's avatar
thomasl committed
590

Florian Kaltenberger's avatar
Florian Kaltenberger committed
591
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
592 593 594
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
595
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
596
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
597

gauthier's avatar
gauthier committed
598 599
#    mkdir -p $DIR/at_commands/build
#    cd $DIR/at_commands/build
600
#    eval $CMAKE_CMD
gauthier's avatar
gauthier committed
601 602 603
#    compilations \
#      at_commands at_nas_ue \
#      at_nas_ue $dbin/at_nas_ue
604
    
gauthier's avatar
gauthier committed
605
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
606 607
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
608
    
609
    eval $CMAKE_CMD
thomasl's avatar
thomasl committed
610
    compilations \
611 612
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
613
    compilations \
614 615
      nas_sim_tools nvram \
      nvram $dbin/nvram
thomasl's avatar
thomasl committed
616
    compilations \
617 618
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
619 620

    # generate USIM data
621 622
    if [ -f $dbin/conf2uedata ]; then
      install_nas_tools $conf_nvram_path $gen_nvram_path
623
      echo_info "Copying UE specific part to $DIR/$lte_build_dir/build"
624 625 626
      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
627 628 629
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
630
  fi
thomasl's avatar
thomasl committed
631

632
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
633 634 635 636 637
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
638
    eval $CMAKE_CMD
639
  fi
640

641 642 643
  if [ "$SIMUS_PHY" = "1" ] ; then
    # lte unitary simulators compilation
    echo_info "Compiling unitary tests simulators"
Cedric Roux's avatar
Cedric Roux committed
644 645 646
    # TODO: fix: dlsim_tm4 pucchsim prachsim pdcchsim pbchsim mbmssim
    #simlist="dlsim_tm4 dlsim ulsim pucchsim prachsim pdcchsim pbchsim mbmssim"
    simlist="dlsim ulsim"
647 648 649 650 651
    for f in $simlist ; do
      compilations \
      lte-simulators $f \
	  $f $dbin/$f.$REL
    done
Cedric Roux's avatar
Cedric Roux committed
652 653 654
    compilations \
          lte-simulators coding \
          libcoding.so $dbin/libcoding.so
655
  fi
thomasl's avatar
thomasl committed
656

gauthier's avatar
gauthier committed
657
  # Core simulators
658 659 660 661 662 663 664 665 666 667 668
  #############
  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
669

670 671
  # EXMIMO drivers & firmware loader
  ###############
672
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
673
    
674 675
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
676
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
677
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
678
    compilations \
679
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
680
	  updatefw $dbin/updatefw
681
    echo_info "Compiling oarf tools. The logfile for compilation is here: $dlog/oarf.txt"
682 683 684 685 686 687 688
    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
689
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
690
  fi
thomasl's avatar
thomasl committed
691

692 693
  # oaisim compilation
  ###############
694
  if [ "$oaisim" = "1" ] ; then
695
    dconf=$OPENAIR_DIR/targets/bin
696 697 698 699 700 701 702
      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
703
    
704 705 706
    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
707
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
708
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
709 710 711 712
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
    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
713
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
714
    echo "set ( UE_NAS_USE_TUN $UE_NAS_USE_TUN )" >>  $cmake_file
715
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
716 717 718
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
719
    eval $CMAKE_CMD
720
    compilations \
721 722
	  $oaisim_build_dir $oaisim_exec \
	  $oaisim_exec $dbin/$oaisim_exec.$REL
Cedric Roux's avatar
Cedric Roux committed
723 724 725 726 727 728
    compilations \
	  $oaisim_build_dir $config_libconfig_shlib \
	  lib$config_libconfig_shlib.so $dbin/lib$config_libconfig_shlib.so
    compilations \
          $oaisim_build_dir coding \
          libcoding.so $dbin/libcoding.so
729 730 731 732 733 734 735

    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
736
	eval $CMAKE_CMD
737 738 739 740 741 742 743 744 745 746 747 748 749
	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
750
	eval $CMAKE_CMD
751 752 753 754 755 756 757
	compilations \
	    nas_sim_tools usim \
	    usim $dbin/usim
	compilations \
	    nas_sim_tools nvram \
	    nvram $dbin/nvram
	compilations \
758 759
        nas_sim_tools conf2uedata \
        conf2uedata $dbin/conf2uedata
760 761

	# generate USIM data
762 763
	if [ -f $dbin/conf2uedata ]; then
	    install_nas_tools $conf_nvram_path $gen_nvram_path
764 765 766
	else
	    echo_warning "not generated UE NAS files: binaries not found"
	fi
767 768
    else

769 770 771
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
772

773 774 775 776
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
777

778
	#oai_nw_drv
Cedric Roux's avatar
Cedric Roux committed
779 780 781
	#compilations \
	#    $oaisim_build_dir oai_nw_drv \
	#    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
782
    fi
783

784 785 786 787
    if [ "$TP" == "ETHERNET" ] ; then
	compilations \
	    $oaisim_build_dir oai_eth_transpro \
	    liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
788 789
	ln -sf liboai_eth_transpro.so liboai_transpro.so
	ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
790 791 792
	echo_info "liboai_transpro.so is linked with ETHERNET library"	 
    fi
      
793 794
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
795 796 797 798
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
    echo "set ( XFORMS $XFORMS )" >>  $cmake_file
    echo "set ( RRC_ASN1_VERSION \"${REL}\")" >>  $cmake_file
    echo "set ( ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
799
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
800
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
801 802 803
    #[ "$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
804
    #eval $CMAKE_CMD
805 806 807
    #compilations \
	#  oaisim_mme_build_oai oaisim_mme \
	#  oaisim_mme $dbin/oaisim_mme.$REL
808 809
  fi

oai's avatar
oai committed
810 811 812
  # Telnet server compilation
  #####################
  if [ "$BUILD_TELNETSRV" = "1" ] ; then
813 814 815 816
              build_dir=$lte_build_dir
              compilations \
                  $build_dir telnetsrv \
                  libtelnetsrv.so $dbin/libtelnetsrv.so
oai's avatar
oai committed
817 818

  fi  
819 820
  # build RF device and transport protocol libraries
  #####################################
821
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
822

823
      build_dir=$lte_build_dir	  
824

825
      # build RF device libraries
826
      if [ "$HW" != "None" ] ; then
827
	  rm -f liboai_device.so
828
	  rm -f $dbin/liboai_device.so
829

830
	  # link liboai_device.so with the selected RF device library
831
	  if [ "$HW" == "EXMIMO" ] ; then
832 833 834
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
835 836 837

	      ln -sf liboai_exmimodevif.so liboai_device.so
	      ln -sf $dbin/liboai_exmimodevif.so.$REL $dbin/liboai_device.so
838 839
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
840 841 842
              compilations \
                  $build_dir oai_usrpdevif \
                  liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
843

844 845
	      ln -sf liboai_usrpdevif.so liboai_device.so
	      ln -sf $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
846 847
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
848 849 850 851 852 853
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

854 855
	      ln -sf liboai_bladerfdevif.so liboai_device.so
	      ln -sf $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
856
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
857 858 859 860 861 862 863
	  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

864 865
	      ln -sf liboai_lmssdrdevif.so liboai_device.so
	      ln -sf $dbin/liboai_lmssdrdevif.so.$REL $dbin/liboai_device.so
866
	      echo_info "liboai_device.so is linked to LMSSDR device library"	 
867 868 869 870 871 872
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
873
      if [ "$TP" != "None" ] ; then
874
	  rm -f liboai_transpro.so
875 876
	  rm -f $dbin/liboai_transpro.so

877
	  if [ "$TP" == "ETHERNET" ] ; then
878 879 880
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
881 882
	      ln -sf liboai_eth_transpro.so liboai_transpro.so
	      ln -sf $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
883 884 885 886 887
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

888

889 890 891 892 893 894 895 896 897 898 899
  # 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
900
    eval $CMAKE_CMD
901 902
    make doc
    ) >& $doxygen_log
903 904
  fi

gauthier's avatar
gauthier committed
905 906 907
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
908
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
909 910 911 912
    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 "
913 914
    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 "
915
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
916 917 918
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"