build_oai 14.6 KB
Newer Older
thomasl's avatar
thomasl committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#!/bin/bash
################################################################################
#   OpenAirInterface
#   Copyright(c) 1999 - 2014 Eurecom
#
#    OpenAirInterface is free software: you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation, either version 3 of the License, or
#    (at your option) anylater version.
#
#
#    OpenAirInterface is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with OpenAirInterface.The full GNU General Public License is
#    included in this distribution in the file called "COPYING". If not,
#    see <http://www.gnu.org/licenses/>.
#
#  Contact Information
#  OpenAirInterface Admin: openair_admin@eurecom.fr
#  OpenAirInterface Tech : openair_tech@eurecom.fr
#  OpenAirInterface Dev  : openair4g-devel@eurecom.fr
#
#  Address      : Eurecom, Campus SophiaTech, 450 Route des Chappes, CS 50193 - 06904 Biot Sophia Antipolis cedex, FRANCE
#
################################################################################
30
# file build_oai
thomasl's avatar
thomasl committed
31
32
33
34
35
36
37
# brief OAI automated build tool that can be used to install, compile, run OAI.
# author  Navid Nikaein, Lionel GAUTHIER, Laurent Thomas


################################
# include helper functions
################################
thomasl's avatar
thomasl committed
38
ORIGIN_PATH=$PWD
thomasl's avatar
thomasl committed
39
THIS_SCRIPT_PATH=$(dirname $(readlink -f $0))
40
source $THIS_SCRIPT_PATH/tools/build_helper
thomasl's avatar
thomasl committed
41

42
MSC_GEN="False"
thomasl's avatar
thomasl committed
43
44
45
46
47
XFORMS="False"
VCD_TIMING="False"
REL="Rel10"
HW="EXMIMO"

48
49
50
51
52
53
54
55
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
56
   Erase all files to make a rebuild from start"
57
-C | --clean-all
gauthier's avatar
gauthier committed
58
   Erase all files made by previous compilations, installations"
59
60
--clean-kernel
   Erase previously installed features in kernel: iptables, drivers, ...
gauthier's avatar
gauthier committed
61
-I | --install-external-packages
62
63
64
65
66
67
68
69
70
71
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
   Add debugging symbols to compilation directives
-h | --help
   Print this help
--eNB
   Makes the eNB LTE softmodem
--UE
   Makes the UE softmodem
--EPC
   Makes the EPC (MME-SPGW, HSS)
-r | --3gpp-release
gauthier's avatar
gauthier committed
77
   default is Rel10,
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
   Rel8 limits the implementation to 3GPP Release 8 version
-w | --hardware
   EXMIMO (Default), USRP, None
   Adds this RF board support (in external packages installation and in compilation)
--oaisim
   Makes the oaisim simulator
--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
-V | --vcd
   Adds a debgging facility to the binary files: GUI with major internal synchronization events
-x | --xforms
   Adds a software oscilloscope feature to the produced binaries
--install-system-files
gauthier's avatar
gauthier committed
95
   Install OpenArInterface required files in Linux system
96
97
98
99
100
101
102
103
   (will ask root password)
Typical Options for a quick startup with a COTS UE and Eurecom RF board: build_oai -I -g -eNB -EPC -x --install-system-files'
}


function main() {
  until [ -z "$1" ]
  do
104
    case "$1" in
105
106
107
108
109
       -c | --clean)
            CLEAN=1
            shift;;
       -C | --clean-all)
            CLEAN_ALL=1
thomasl's avatar
thomasl committed
110
            shift;;
111
112
113
       --clean-kernel)
            clean_kernel
            echo_info "Erased iptables config and removed modules from kernel"
thomasl's avatar
thomasl committed
114
            shift;;
115
       -I | --install-external-packages)
116
            INSTALL_EXTERNAL=1
117
            echo_info "Will install external packages"
thomasl's avatar
thomasl committed
118
            shift;;
119
       --install-optional-packages)
thomasl's avatar
thomasl committed
120
121
122
            INSTALL_OPTIONAL=1
            echo_info "Will install optional packages"
            shift;;
123
       -g | --run-with-gdb)
thomasl's avatar
thomasl committed
124
            GDB=1
125
            echo_info "Will Compile with gdb symbols"
thomasl's avatar
thomasl committed
126
            shift;;
127
128
129
130
131
132
133
134
135
136
137
138
       --eNB)
            eNB=1
            echo_info "Will compile eNB"
            shift;;
       --UE)
            UE=1
            echo_info "Will compile UE"
            shift;;
       --EPC)
            EPC=1
            echo_info "Will compile EPC"
            shift;;
thomasl's avatar
thomasl committed
139
       -r | --3gpp-release)
gauthier's avatar
gauthier committed
140
            REL=$2
141
            echo_info "setting release to: $REL"
thomasl's avatar
thomasl committed
142
143
144
            shift 2;;
       -w | --hardware)
            HW="$2" #"${i#*=}"
145
146
            # Use OAI_USRP  as the key work USRP is used inside UHD driver
            [ "$HW" == "USRP" ] && HW=OAI_USRP
thomasl's avatar
thomasl committed
147
148
            echo_info "setting hardware to: $HW"
            shift 2;;
149
150
151
152
153
       --oaisim)
            oaisim=1
            echo_info "Will compile oaisim and drivers nasmesh, ..."
            shift;;
       --phy_simulators)
thomasl's avatar
thomasl committed
154
            SIMUS_PHY=1
155
156
157
158
159
160
            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
161
162
       -s | --check)
            OAI_TEST=1
163
            echo_info "Will run auto-tests"
thomasl's avatar
thomasl committed
164
            shift;;
thomasl's avatar
thomasl committed
165
       -V | --vcd)
166
            echo_info "setting gtk-wave output"
thomasl's avatar
thomasl committed
167
168
            VCD_TIMING=1
            EXE_ARGUMENTS="$EXE_ARGUMENTS -V"
thomasl's avatar
thomasl committed
169
            shift;;
thomasl's avatar
thomasl committed
170
171
172
       -x | --xforms)
            XFORMS=1
            EXE_ARGUMENTS="$EXE_ARGUMENTS -d"
173
            echo_info "Will generate the software oscilloscope features"
thomasl's avatar
thomasl committed
174
            shift;;
175
176
177
178
       --install-system-files)
            INSTALL_SYSTEM_FILES=1
            echo_info "Will copy OpenAirInterface files in Linux directories"
            shift;;
thomasl's avatar
thomasl committed
179
180
181
        -h | --help)
            print_help
            exit 1;;
gauthier's avatar
gauthier committed
182
	*)
183
184
	    print_help
            echo_fatal "Unknown option $1"
thomasl's avatar
thomasl committed
185
            break;;
thomasl's avatar
thomasl committed
186
   esac
187
  done
thomasl's avatar
thomasl committed
188

189
190
191
  ############################################
  # setting and printing OAI envs, we should check here
  ############################################
gauthier's avatar
gauthier committed
192

193
  echo_info "2. Setting the OAI PATHS ..."
thomasl's avatar
thomasl committed
194

gauthier's avatar
gauthier committed
195
  set_openair_env
196
  cecho "OPENAIR_DIR    = $OPENAIR_DIR" $green
thomasl's avatar
thomasl committed
197

198
199
200
201
202
203
204
205
206
207
  # 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
208

209

210
211
212
213
  if [ "$CLEAN_ALL" = "1" ] ; then
    clean_all_files
    echo_info "Erased all previously producted files"
  fi
214

215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
  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
    echo_info "Making X.509 certificates"
    make_certs eur
    if [ "$HW" == "OAI_USRP" ] ; then
      echo_info "installing packages for USRP support"
      check_install_usrp_uhd_driver
    fi
  fi

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

  echo_info "3. building the compilation directives ..."

  DIR=$OPENAIR_DIR/cmake_targets


gauthier's avatar
gauthier committed
240
  if [ "$eNB" = "1" -o "$UE" = "1" ] ; then
241
    # LTE softmodem compilation
242
243
    mkdir -p $DIR/lte_build_oai/build
    cmake_file=$DIR/lte_build_oai/CMakeLists.txt
244
245
246
247
248
    echo "cmake_minimum_required(VERSION 2.8)"   >   $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
    echo "set(RF_BOARD \"${HW}\")"               >>  $cmake_file
249
250
251
252
    echo 'set(PACKAGE_NAME "\"lte-softmodem\"")' >>  $cmake_file
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
    cd  $DIR/lte_build_oai/build
    cmake ..
253
254
    echo_info "Compiling LTE softmodem"
    compilations \
gauthier's avatar
gauthier committed
255
256
	  lte_build_oai lte-softmodem \
	  lte-softmodem lte-softmodem.$REL
257

258
  fi
thomasl's avatar
thomasl committed
259

260
  if [ "$UE" = 1 ] ; then
261
262
263
    # ue_ip driver compilation
    echo_info "Compiling UE specific part"
    compilations \
gauthier's avatar
gauthier committed
264
265
	  lte_build_oai ue_ip \
	  CMakeFiles/ue_ip/ue_ip.ko $dbin/ue_ip.ko
thomasl's avatar
thomasl committed
266
    compilations \
gauthier's avatar
gauthier committed
267
268
	  lte_build_oai usim \
	  usim $dbin/usim
thomasl's avatar
thomasl committed
269
    compilations \
gauthier's avatar
gauthier committed
270
271
	  lte_build_oai nvram \
	  nvram $dbin/nvram
272
  fi
thomasl's avatar
thomasl committed
273

274
  if [ "$SIMUS_PHY" = "1" -o "$SIMUS_CORE" = "1" ] ; then
275
276
277
278
279
280
    cd $OPENAIR_DIR/cmake_targets/lte-simulators
    [ "$CLEAN" = "1" ] && rm -rf build
    mkdir -p build
    cd build
    rm -f *sim
    cmake ..
281
  fi
282

283
284
285
286
287
288
289
290
291
292
  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
293

gauthier's avatar
gauthier committed
294
  # Core simulators
295
296
297
298
299
300
301
302
303
304
305
  #############
  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
306

307
308
309
  # EXMIMO drivers & firmware loader
  ###############
  if [ "$HW" = "EXMIMO" -a "$UE$eNB" != "" ] ; then
310
311
    echo_info "Compiling Express MIMO 2 board drivers"
    compilations \
thomasl's avatar
thomasl committed
312
        lte_build_oai openair_rf \
thomasl's avatar
thomasl committed
313
        CMakeFiles/openair_rf/openair_rf.ko $dbin/openair_rf.ko
314
    compilations \
gauthier's avatar
gauthier committed
315
316
	  lte_build_oai updatefw \
	  updatefw $dbin/updatefw
317
  fi
thomasl's avatar
thomasl committed
318

319
  if [ "$oaisim" = "1" ] ; then
thomasl's avatar
thomasl committed
320
    echo_info "Compiling oaisim"
321
322
323
324
325
326
327
328
329
    cmake_file=$DIR/oaisim_build_oai/CMakeLists.txt
    cp $DIR/oaisim_build_oai/CMakeLists.template $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
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
    mkdir -p $DIR/oaisim_build_oai/build
    cd $DIR/oaisim_build_oai/build
    cmake ..
330
331
    compilations \
	oaisim_build_oai oaisim \
thomasl's avatar
thomasl committed
332
	oaisim $dbin/oaisim.$REL
333
334

    # nasmesh driver compilation
thomasl's avatar
thomasl committed
335
    compilations \
336
337
	oaisim_build_oai nasmesh \
	CMakeFiles/nasmesh/nasmesh.ko $dbin/nasmesh.ko
338
339
340
    #oai_nw_drv
    compilations \
	oaisim_build_oai oai_nw_drv \
thomasl's avatar
thomasl committed
341
	CMakeFiles/oai_nw_drv/oai_nw_drv.ko $dbin/oai_nw_drv.ko
342
343
344
345
346
347
348
349
350
351
352
353
    cmake_file=$DIR/oaisim_mme_build_oai/CMakeLists.txt
    cp $DIR/oaisim_mme_build_oai/CMakeLists.template $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
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
    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
354
355
356
357
358
359
360
361
362
363
  fi

  # EPC compilation
  ##################
  if [ "$EPC" = "1" ] ; then
    echo_info "Compiling EPC"
    cmake_file=$DIR/epc_build_oai/CMakeLists.txt
    cp $DIR/epc_build_oai/CMakeLists.template $cmake_file
    echo "set(ENABLE_VCD_FIFO $VCD_TIMING )" >>  $cmake_file
    echo 'include(${CMAKE_CURRENT_SOURCE_DIR}/../CMakeLists.txt)' >> $cmake_file
gauthier's avatar
gauthier committed
364

365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
    [ "$CLEAN" = "1" ] && rm -rf $DIR/epc_build_oai/build
    mkdir -p $DIR/epc_build_oai/build
    cd $DIR/epc_build_oai/build
    cmake ..
    compilations \
      epc_build_oai mme_gw \
      mme_gw $dbin/mme_gw.$REL
    # Only integrated mme+sgw+pgw is operational today
    #    compilations \
    #  epc_build_oai oai_sgw \
    #  oai_sgw $dbin/oai_sgw.$REL
    compilations \
      epc_build_oai xt_GTPUAH_lib \
      libxt_GTPUAH_lib.so $dbin
    compilations \
      epc_build_oai xt_GTPURH_lib \
      libxt_GTPURH_lib.so $dbin
    compilations \
      epc_build_oai xt_GTPURH \
      CMakeFiles/xt_GTPURH/xt_GTPURH.ko $dbin
    compilations \
      epc_build_oai xt_GTPUAH \
      CMakeFiles/xt_GTPUAH/xt_GTPUAH.ko $dbin

thomasl's avatar
thomasl committed
389

390
    # Example HSS and EPC run on the same host
391
392
393
394
395
    if [ "$CLEAN" = "1" ]; then
      $OPENAIR_DIR/cmake_targets/tools/build_hss --clean --debug --transport-tcp-only --transport-prefer-tcp --fqdn `hostname --fqdn` --connect-to-mme `hostname --fqdn`
    else
      $OPENAIR_DIR/cmake_targets/tools/build_hss --debug --transport-tcp-only --transport-prefer-tcp --fqdn `hostname --fqdn` --connect-to-mme `hostname --fqdn`
    fi
396
    # example HHS and EPC run on separate hosts (can use SCTP)
gauthier's avatar
gauthier committed
397
    # $OPENAIR_DIR/cmake_targets/tools/build_hss --debug
thomasl's avatar
thomasl committed
398

399
    echo_info "Copying iptables libraries into system directory: /lib/xtables"
400
    if [ -f  $dbin/libxt_GTPURH_lib.so ] ; then
401
402
403
      $SUDO rm -f /lib/xtables/libxt_GTPURH.so /lib/xtables/libxt_GTPUAH.so
      $SUDO ln -s $dbin/libxt_GTPURH_lib.so /lib/xtables/libxt_GTPURH.so
      $SUDO ln -s $dbin/libxt_GTPUAH_lib.so /lib/xtables/libxt_GTPUAH.so
404
    else
405
      echo_warning "not installed GTP-U iptables: binaries not found"
406
    fi
thomasl's avatar
thomasl committed
407

thomasl's avatar
thomasl committed
408
    dconf=$OPENAIR_TARGETS/bin
thomasl's avatar
thomasl committed
409
    mkdir -p $dconf
410
    #cp $ORIGIN_PATH/$CONFIG_FILE $dconf || echo_error "config file $ORIGIN_PATH/$CONFIG_FILE not found"
thomasl's avatar
thomasl committed
411
412

    # generate USIM data
413
    if [ -f $dbin/nvram ]; then
414
      install_nas_tools $dbin $dconf
415
    else
416
      echo_warning "not generated UE NAS files: binaries not found"
gauthier's avatar
gauthier committed
417
    fi
thomasl's avatar
thomasl committed
418

419

thomasl's avatar
thomasl committed
420
    # Do EPC
421
422
423
    if [ -f $DIR/epc_build_oai/build/mme_fd.conf ] ; then
      cp $DIR/epc_build_oai/build/epc.*.conf $dconf
      $SUDO cp -uv $DIR/epc_build_oai/build/mme_fd.conf  $FREEDIAMETER_PREFIX/etc/freeDiameter
424
    else
425
      echo_warning "not installed EPC config files: not found"
426
    fi
thomasl's avatar
thomasl committed
427

gauthier's avatar
gauthier committed
428
    # Do HSS
thomasl's avatar
thomasl committed
429
    # bash doesn't like space char around = char
430
431
    cp -uv $DIR/hss_build/build/hss.conf $dbin
    $SUDO cp -uv $DIR/hss_build/build/hss_fd.conf $DIR/hss_build/build/acl.conf $FREEDIAMETER_PREFIX/etc/freeDiameter
gauthier's avatar
gauthier committed
432

433
434
435
436
437
438
439
440
441
442
#   if [ "$INSTALL_SYSTEM_FILES" = "1" ] ;then
#    if [ -f $dbin/hss.conf ] ; then
#      sed -e 's/ *= */=/' $dbin/hss.conf > $dconf/hss.conf.nospace
#      source $dconf/hss.conf.nospace
#      rm -f $dconf/hss.conf.nospace
#      create_hss_database root linux "$MYSQL_user" "$MYSQL_pass" "$MYSQL_db"
#    else
#      echo_warning "not created HSS database: config not found"
#    fi
#  fi
443
fi
444

gauthier's avatar
gauthier committed
445
446
447
  # Auto-tests
  #####################
  if [ "$OAI_TEST" = "1" ]; then
thomasl's avatar
thomasl committed
448
    echo_info "10. Running OAI pre commit tests (pre-ci) ..."
449
    $OPENAIR_DIR/cmake_targets/autotests/run_compilation_autotests.bash
thomasl's avatar
thomasl committed
450
    $OPENAIR_DIR/cmake_targets/autotests/run_exec_autotests.bash
gauthier's avatar
gauthier committed
451
  else
thomasl's avatar
thomasl committed
452
    echo_info "10. Bypassing the Tests ..."
gauthier's avatar
gauthier committed
453
  fi
454
455
456
}

main "$@"