build_oai 27.7 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
PRINT_STATS="False"
thomasl's avatar
thomasl committed
39
VCD_TIMING="False"
laurent's avatar
laurent committed
40
41
DEADLINE_SCHEDULER_FLAG_USER="False"
FORCE_DEADLINE_SCHEDULER_FLAG_USER=""
42
CPU_AFFINITY_FLAG_USER="False" #Only valid when lowlatecy flag is set to False
thomasl's avatar
thomasl committed
43
REL="Rel10"
44
HW="None"
45
TP="None"
Florian Kaltenberger's avatar
Florian Kaltenberger committed
46
NOS1=0
gauthier's avatar
gauthier committed
47
EPC=0
48
VERBOSE_COMPILE=0
49
CFLAGS_PROCESSOR_USER=""
50
51
RUN_GROUP=0
TEST_CASE_GROUP=""
52
BUILD_DOXYGEN=0
53
T_TRACER="False"
Rohit Gupta's avatar
Rohit Gupta committed
54
DISABLE_HARDWARE_DEPENDENCY="False"
55
CMAKE_BUILD_TYPE=""
56
57
trap handle_ctrl_c INT

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


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

knopp's avatar
knopp committed
317
  echo_info "RF HW set to $HW" 
318
319
320
321
  #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
322
  if [ "$FORCE_DEADLINE_SCHEDULER_FLAG_USER" = "" ]; then
323
     if [ "$HW" = "EXMIMO" ] ; then 
324
        DEADLINE_SCHEDULER_FLAG_USER="False"
325
     elif [ "$HW" = "ETHERNET" ] ; then 
326
        DEADLINE_SCHEDULER_FLAG_USER="False"
327
     elif [ "$HW" = "OAI_USRP" ] ; then 
laurent's avatar
laurent committed
328
        DEADLINE_SCHEDULER_FLAG_USER="False"
329
     elif [ "$HW" = "OAI_BLADERF" ] ; then 
laurent's avatar
laurent committed
330
        DEADLINE_SCHEDULER_FLAG_USER="False"
331
     elif [ "$HW" = "OAI_LMSSDR" ] ; then 
laurent's avatar
laurent committed
332
        DEADLINE_SCHEDULER_FLAG_USER="False"
333
     elif [ "$HW" = "None" ] ; then 
laurent's avatar
laurent committed
334
        DEADLINE_SCHEDULER_FLAG_USER="False"
335
336
337
338
339
     else 
        echo_error "Unknown HW type $HW. Exiting now..."
        exit 
     fi
  else
laurent's avatar
laurent committed
340
     DEADLINE_SCHEDULER_FLAG_USER=$FORCE_DEADLINE_SCHEDULER_FLAG_USER
341
342
  fi

Rohit Gupta's avatar
Rohit Gupta committed
343
  #Disable CPU Affinity for deadline scheduler
laurent's avatar
laurent committed
344
  if [ "$DEADLINE_SCHEDULER_FLAG_USER" = "True" ] ; then 
Rohit Gupta's avatar
Rohit Gupta committed
345
346
     CPU_AFFINITY_FLAG_USER="False"
  fi
347

laurent's avatar
laurent committed
348
  echo_info "Flags for Deadline scheduler: $DEADLINE_SCHEDULER_FLAG_USER"
Rohit Gupta's avatar
Rohit Gupta committed
349
  echo_info "Flags for CPU Affinity: $CPU_AFFINITY_FLAG_USER"
350

351
352
353
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
354

355
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
356

gauthier's avatar
gauthier committed
357
  set_openair_env
358
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
359

360
361
362
363
364
365
366
367
368
369
  # 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
370

371

372
373
374
375
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
376

377
378
379
380
381
382
383
  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
384
385
386
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
387
388
389
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        install_usrp_uhd_driver
      fi
390
391
    fi 
    if [ "$HW" == "OAI_BLADERF" ] ; then
392
      echo_info "installing packages for BLADERF support"
393
      check_install_bladerf_driver
394
395
396
      if [ ! "$DISABLE_HARDWARE_DEPENDENCY" == "True" ]; then
        flash_firmware_bladerf
      fi
397
    fi
398
399
400
401
402
403
404
  fi

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

405
  if [ "$oaisim" = "1" ] ; then
406
407
408
409
410
      #to be discussed
      # there is no RF device and no transport protocol 
      HW="None" 
      TP="None"
      
411
412
413
414
415
416
      if [ "$XFORMS" == "True" ] ; then 
	  PRINT_STATS="True"
      fi 
  fi
  
  
417
418
419
  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets
420
421
422
423
424
425
426
  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
427

428
429
  # first generate the CMakefile in the right directory
  if [ "$eNB" = "1" -o "$UE" = "1" -o "$HW" = "EXMIMO" ] ; then
430

431
    # LTE softmodem compilation
432
433
434
435
436
437
438
    [ "$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
439
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
440
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
441
442
443
444
    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
445
446
    echo "set ( TRANSP_PRO \"${TP}\")"             >>  $cmake_file
    echo "set(PACKAGE_NAME \"${lte_exec}\")"       >>  $cmake_file
laurent's avatar
laurent committed
447
    echo "set (DEADLINE_SCHEDULER \"${DEADLINE_SCHEDULER_FLAG_USER}\" )"    >>$cmake_file
Rohit Gupta's avatar
Rohit Gupta committed
448
    echo "set (CPU_AFFINITY \"${CPU_AFFINITY_FLAG_USER}\" )"      >>$cmake_file
449
    echo "set ( T_TRACER $T_TRACER )"              >>  $cmake_file
450
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
451
    cd  $DIR/$lte_build_dir/build
452
    cmake ..
453
454
  fi

Florian Kaltenberger's avatar
Florian Kaltenberger committed
455
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
456
    echo_info "Compiling $lte_exec"
457
    compilations \
458
459
460
461
462
463
464
465
466
467
468
469
	  $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
470
  fi
thomasl's avatar
thomasl committed
471

Florian Kaltenberger's avatar
Florian Kaltenberger committed
472
  if [ "$UE" = 1 -a "$NOS1" = "0" ] ; then
473
474
475
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
476
      $lte_build_dir ue_ip \
gauthier's avatar
gauthier committed
477
      CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
478

gauthier's avatar
gauthier committed
479
480
481
482
483
484
#    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
485
    
gauthier's avatar
gauthier committed
486
    [ "$CLEAN" = "1" ] && rm -rf $DIR/nas_sim_tools/build
487
488
    mkdir -p $DIR/nas_sim_tools/build
    cd $DIR/nas_sim_tools/build
gauthier's avatar
gauthier committed
489
    
490
    cmake ..
thomasl's avatar
thomasl committed
491
    compilations \
492
493
      nas_sim_tools usim \
      usim $dbin/usim
thomasl's avatar
thomasl committed
494
    compilations \
495
496
497
498
499
500
      nas_sim_tools nvram \
      nvram $dbin/nvram

    # generate USIM data
    if [ -f $dbin/nvram ]; then
      install_nas_tools $dbin $dconf
501
502
503
504
505
      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

506
507
508
    else
      echo_warning "not generated UE NAS files: binaries not found"
    fi
509
  fi
thomasl's avatar
thomasl committed
510

511
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
512
513
514
515
516
517
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
518
  fi
519

520
521
522
523
524
525
526
527
528
529
  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
530

gauthier's avatar
gauthier committed
531
  # Core simulators
532
533
534
535
536
537
538
539
540
541
542
  #############
  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
543

544
545
  # EXMIMO drivers & firmware loader
  ###############
546
  if [ "$HW" = "EXMIMO" ] ; then
gauthier's avatar
gauthier committed
547
    
548
549
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
550
        $lte_build_dir openair_rf \
thomasl's avatar
thomasl committed
551
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
552
    compilations \
553
	  $lte_build_dir updatefw \
gauthier's avatar
gauthier committed
554
	  updatefw $dbin/updatefw
555
556
557
558
559
560
561
    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
562
    cp $OPENAIR_DIR/cmake_targets/tools/init_exmimo2 $dbin
563
  fi
thomasl's avatar
thomasl committed
564

565
566
  # oaisim compilation
  ###############
567
  if [ "$oaisim" = "1" ] ; then
568
    dconf=$OPENAIR_DIR/targets/bin
569
570
571
572
573
574
575
      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
576
    
577
578
579
    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
580
    echo "set ( CMAKE_BUILD_TYPE $CMAKE_BUILD_TYPE )" >> $cmake_file
581
    echo "set ( CFLAGS_PROCESSOR_USER \"$CFLAGS_PROCESSOR_USER\" )" >>  $cmake_file
582
583
584
585
    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
586
    echo "set ( T_TRACER $T_TRACER )"          >>  $cmake_file
587
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
588
589
590
    [ "$CLEAN" = "1" ] && rm -rf $DIR/$oaisim_build_dir/build
    mkdir -p $DIR/$oaisim_build_dir/build
    cd $DIR/$oaisim_build_dir/build
591
592
    cmake ..
    compilations \
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
	  $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
630
631
    else

632
633
634
	compilations \
	    $oaisim_build_dir rb_tool \
	    rb_tool $dbin/rb_tool
gauthier's avatar
gauthier committed
635

636
637
638
639
	# nasmesh driver compilation
	compilations \
	    $oaisim_build_dir nasmesh \
	    CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
640

641
642
643
644
645
	#oai_nw_drv
	compilations \
	    $oaisim_build_dir oai_nw_drv \
	    CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
    fi
646

647
648
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $cmake_file
649
650
651
652
    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
653
    echo "set ( T_TRACER $T_TRACER )"        >>  $cmake_file
654
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
655
656
657
658
659
660
661
    #[ "$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
662
663
  fi

664
  # RRH compilation
665
  #####################
666
667
  if [ "$RRH" = "1" ] ; then

668
669
670
671
672
     rrh_exec=rrh_gw
     rrh_build_dir=rrh_gw
     
     echo_info "Compiling $rrh_exec ..."
    
673
674
     [ "$CLEAN" = "1" ] && rm -rf $DIR/rrh_gw/build 
     mkdir -p $DIR/$rrh_build_dir/build
675
676
     cmake_file=$DIR/$rrh_build_dir/CMakeLists.txt
     echo "cmake_minimum_required(VERSION 2.8)"   >   $cmake_file
677
678
679
680
681
682
683
684
     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
685
     echo "set ( T_TRACER $T_TRACER )"            >>  $cmake_file
686
     echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file    
687
688
689
690
691
     cd $DIR/$rrh_build_dir/build
     cmake ..
     compilations \
	 rrh_gw rrh_gw \
	 rrh_gw $dbin/rrh_gw
692

693
  fi
694
695
696
697
698
699
700
701
702
703
704
705
  
  # 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)
706
      if [ "$HW" != "None" ] ; then
707
	  rm -f liboai_device.so
708
	  rm -f $dbin/liboai_device.so
709
710


711
	  # link liboai_device.so with the selected RF device library
712
	  if [ "$HW" == "EXMIMO" ] ; then
713
714
	      
	      #add exmimo compilation
715
	      #TODO EXMIMO library support
716
717
718
	      compilations \
		  $build_dir oai_exmimodevif \
		  liboai_exmimodevif.so $dbin/liboai_exmimodevif.so.$REL
719
720
	      echo_info "liboai_device.so is linked to EXMIMO device library"       
	  elif [ "$HW" == "OAI_USRP" ] ; then
721
722
723
724
725
726
	      if [ -d "/usr/include/uhd" ] ; then
		  compilations \
		      $build_dir oai_usrpdevif \
		      liboai_usrpdevif.so $dbin/liboai_usrpdevif.so.$REL
	      fi

727
	      ln -s liboai_usrpdevif.so liboai_device.so
728
	      ln -s $dbin/liboai_usrpdevif.so.$REL $dbin/liboai_device.so
729
730
	      echo_info "liboai_device.so is linked to USRP device library"        
	  elif [ "$HW" == "OAI_BLADERF" ] ; then
731
732
733
734
735
736
	      if [ -f "/usr/include/libbladeRF.h" ] ; then
		  compilations \
		      $build_dir oai_bladerfdevif \
		      liboai_bladerfdevif.so $dbin/liboai_bladerfdevif.so.$REL
	      fi

737
	      ln -s liboai_bladerfdevif.so liboai_device.so
738
	      ln -s $dbin/liboai_bladerfdevif.so.$REL $dbin/liboai_device.so
739
	      echo_info "liboai_device.so is linked to BLADERF device library"	 
740
741
742
743
744
745
746
747
748
749
	  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"	 
750
751
752
753
754
755
	  else 
	      echo_info "liboai_device.so is not linked to any device library"	    
	  fi
      fi
      
      # build trasport protocol libraries (currently only ETHERNET is available)
756
      if [ "$TP" != "None" ] ; then
757
	  rm -f liboai_transpro.so
758
759
	  rm -f $dbin/liboai_transpro.so

760
	  if [ "$TP" == "ETHERNET" ] ; then
761
762
763
	      compilations \
		  $build_dir oai_eth_transpro \
		  liboai_eth_transpro.so $dbin/liboai_eth_transpro.so.$REL
764
	      ln -s liboai_eth_transpro.so liboai_transpro.so
765
	      ln -s $dbin/liboai_eth_transpro.so.$REL $dbin/liboai_transpro.so
766
767
768
769
770
	      echo_info "liboai_transpro.so is linked with ETHERNET library"	 
	  fi      
      fi
fi

771

772
773
774
775
776
777
778
779
780
781
782
  # 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
783
    cmake ..
784
785
    make doc
    ) >& $doxygen_log
786
787
  fi

gauthier's avatar
gauthier committed
788
789
790
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
791
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
792
793
794
795
    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 "
796
797
    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 "
798
    echo_info "You can hit CTRL-C any time to terminate the autotests..."
799
800
801
    echo "Current User Name: $USER"
    read -s -p "Enter Password: " mypassword
    echo -e "\n"
802
803
    rm -fr $OPENAIR_DIR/cmake_targets/autotests/log
    mkdir -p $OPENAIR_DIR/cmake_targets/autotests/log
804
    if [ "$RUN_GROUP" -eq "1" ]; then
805
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -g "$TEST_CASE_GROUP" -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
806
    else
807
        $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash -p $mypassword >& $OPENAIR_DIR/cmake_targets/autotests/log/autotests.log &
808
    fi
809
    wait
gauthier's avatar
gauthier committed
810
  else
thomasl's avatar
thomasl committed
811
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
812
  fi
813
814
815
}

main "$@"