build_helper 12.8 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
################################################################################
#   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) any later 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
#
################################################################################
29
# file build_helper
thomasl's avatar
thomasl committed
30
31
32
33
34
35
# brief
# author Laurent Thomas
#
#######################################
SUDO=sudo

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
###############################
## echo and  family
###############################
black='\E[30m'
red='\E[31m'
green='\E[32m'
yellow='\E[33m'
blue='\E[34m'
magenta='\E[35m'
cyan='\E[36m'
white='\E[37m'
reset_color='\E[00m'
COLORIZE=1

cecho()  {  
    # Color-echo
    # arg1 = message
    # arg2 = color
    local default_msg="No Message."
    message=${1:-$default_msg}
    color=${2:-$green}
    [ "$COLORIZE" = "1" ] && message="$color$message$reset_color"
    echo -e "$message"
    return
}

echo_error()   { cecho "$*" $red          ;}
echo_fatal()   { cecho "$*" $red; exit -1 ;}
echo_warning() { cecho "$*" $yellow       ;}
echo_success() { cecho "$*" $green        ;}
echo_info()    { cecho "$*" $blue         ;}

68

69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

###########################
# Cleaners
###########################

clean_kernel() {
    $SUDO modprobe ip_tables
    $SUDO modprobe x_tables
    $SUDO iptables -P INPUT ACCEPT
    $SUDO iptables -F INPUT
    $SUDO iptables -P OUTPUT ACCEPT
    $SUDO iptables -F OUTPUT
    $SUDO iptables -P FORWARD ACCEPT
    $SUDO iptables -F FORWARD
    $SUDO iptables -t nat -F
    $SUDO iptables -t mangle -F
    $SUDO iptables -t filter -F
    $SUDO iptables -t raw -F
    echo_info "Flushed iptables"
    $SUDO rmmod nasmesh > /dev/null 2>&1
    $SUDO rmmod oai_nw_drv  > /dev/null 2>&1
    $SUDO rmmod openair_rf > /dev/null 2>&1
    $SUDO rmmod ue_ip > /dev/null 2>&1
    echo_info "removed drivers from kernel"
}

clean_all_files() {
96
 set_openair_env
thomasl's avatar
thomasl committed
97
 dir=$OPENAIR_DIR/cmake_targets
98
  rm -rf $dir/log $OPENAIR_DIR/targets/bin/* 
thomasl's avatar
thomasl committed
99
100
101
102
 rm -rf $dir/lte_build_oai $dir/lte-simulators/build
 rm -rf $dir/epc_build_oai/build $dir/epc_build_oai/CMakeLists.txt
 rm -rf $dir/oaisim_build_oai/build $dir/oaisim_build_oai/CMakeLists.txt
 rm -rf $dir/oaisim_mme_build_oai/build $dir/oaisim_mme_build_oai/CMakeLists.txt
gauthier's avatar
gauthier committed
103
 rm -rf $dir/hss_build/build
thomasl's avatar
thomasl committed
104
 rm -rf $dir/autotests/bin $dir/autotests/log $dir/autotests/*/build 
105
106
107
108
109
110
}

###################################
# Compilers
###################################

thomasl's avatar
thomasl committed
111
compilations() {
thomasl's avatar
thomasl committed
112
  cd $OPENAIR_DIR/cmake_targets/$1/build
thomasl's avatar
thomasl committed
113
114
115
  {
    rm -f $3
    make -j4 $2
thomasl's avatar
thomasl committed
116
  } > $dlog/$2.$REL.txt 2>&1
thomasl's avatar
thomasl committed
117
  if [ -s $3 ] ; then
thomasl's avatar
thomasl committed
118
     cp $3 $dbin
thomasl's avatar
thomasl committed
119
     echo_success "$2 compiled"
thomasl's avatar
thomasl committed
120
  else
thomasl's avatar
thomasl committed
121
     echo_error "$2 compilation failed"
thomasl's avatar
thomasl committed
122
123
124
  fi
}

125

126
127
128
129
##########################################
# X.509 certificates
##########################################

thomasl's avatar
thomasl committed
130
make_one_cert() {
thomasl's avatar
thomasl committed
131
132
133
134
135
    fqdn=$1
    name=$2
    $SUDO openssl genrsa -out $name.key.pem 1024
    $SUDO openssl req -new -batch -out $name.csr.pem -key $name.key.pem -subj /CN=$name.$fqdn/C=FR/ST=PACA/L=Aix/O=Eurecom/OU=CM
    $SUDO openssl ca -cert cacert.pem -keyfile cakey.pem -in $name.csr.pem -out $name.cert.pem -outdir . -batch
thomasl's avatar
thomasl committed
136
137
}

thomasl's avatar
thomasl committed
138
make_certs(){
thomasl's avatar
thomasl committed
139
140
    
    fqdn=$1
141
  certs_dir=$FREEDIAMETER_PREFIX/freeDiameter
thomasl's avatar
thomasl committed
142
    # certificates are stored in diameter config directory
thomasl's avatar
thomasl committed
143
144
145
    if [ ! -d $certs_dir ];  then
        echo "Creating non existing directory: $certs_dir"
        $SUDO mkdir -p $certs_dir || echo_error "can't create: $certs_dir"
thomasl's avatar
thomasl committed
146
    fi
thomasl's avatar
thomasl committed
147

thomasl's avatar
thomasl committed
148
    cd $certs_dir
thomasl's avatar
thomasl committed
149
150
    echo "creating the CA certificate"
    echo_warning "erase all existing certificates as long as the CA is regenerated"
thomasl's avatar
thomasl committed
151
152
    $SUDO rm -f $certs_dir/*.pem
    $SUDO mkdir -p  $certs_dir/demoCA/
153
154
    $SUDO touch $certs_dir/demoCA/index.txt
    $SUDO sh -c "echo 01 > $certs_dir/demoCA/serial"
thomasl's avatar
thomasl committed
155
156

    # CA self certificate
thomasl's avatar
thomasl committed
157
    $SUDO openssl req  -new -batch -x509 -days 3650 -nodes -newkey rsa:1024 -out cacert.pem -keyout cakey.pem -subj /CN=$fqdn/C=FR/ST=PACA/L=Aix/O=Eurecom/OU=CM
thomasl's avatar
thomasl committed
158
    
thomasl's avatar
thomasl committed
159
    # generate hss certificate and sign it
thomasl's avatar
thomasl committed
160
161
    make_one_cert eur hss
    make_one_cert eur mme
thomasl's avatar
thomasl committed
162
163

    # legacy config is using a certificate named 'user'
thomasl's avatar
thomasl committed
164
    make_one_cert eur user
thomasl's avatar
thomasl committed
165

thomasl's avatar
thomasl committed
166
167
}

thomasl's avatar
thomasl committed
168

169
170
171
172
############################################
# External packages installers
############################################

thomasl's avatar
thomasl committed
173
174
175
install_nettle_from_source() {
    cd /tmp
    echo "Downloading nettle archive"
176
    rm -rf /tmp/nettle-2.5.tar.gz* /tmp/nettle-2.5
thomasl's avatar
thomasl committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
    wget ftp://ftp.lysator.liu.se/pub/security/lsh/nettle-2.5.tar.gz 
    tar -xzf nettle-2.5.tar.gz
    cd nettle-2.5/
    ./configure --disable-openssl --enable-shared --prefix=/usr 
    echo "Compiling nettle"
    make -j4
    make check 
    $SUDO make install 
    rm -rf /tmp/nettle-2.5.tar.gz /tmp/nettle-2.5
}

install_gnutls_from_source(){
    cd /tmp 
    echo "Downloading gnutls archive"
191
    rm -rf /tmp/gnutls-3.1.23.tar.xz* /tmp/gnutls-3.1.23
thomasl's avatar
thomasl committed
192
193
194
195
196
197
198
199
200
201
    wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.1/gnutls-3.1.23.tar.xz 
    tar -xzf gnutls-3.1.23.tar.xz
    cd gnutls-3.1.23/
    ./configure --prefix=/usr
    echo "Compiling gnutls"
    make -j4
    $SUDO make install 
    rm -rf /tmp/gnutls-3.1.23.tar.xz /tmp/gnutls-3.1.23
}

202
install_1.1.5_freediameter_from_source() {
thomasl's avatar
thomasl committed
203
    cd /tmp
204
  echo "Downloading 1.1.5 freeDiameter archive"
205
    rm -rf /tmp/1.1.5.tar.gz* /tmp/freeDiameter-1.1.5
thomasl's avatar
thomasl committed
206
    wget http://www.freediameter.net/hg/freeDiameter/archive/1.1.5.tar.gz 
207
    tar xzf 1.1.5.tar.gz
thomasl's avatar
thomasl committed
208
209
210
211
212
213
214
    cd freeDiameter-1.1.5
    patch -p1 < $OPENAIRCN_DIR/S6A/freediameter/freediameter-1.1.5.patch 
    mkdir build
    cd build
    cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ../ 
    echo "Compiling freeDiameter"
    make -j4
thomasl's avatar
thomasl committed
215
    #make test 
thomasl's avatar
thomasl committed
216
217
218
219
    $SUDO make install 
    rm -rf /tmp/1.1.5.tar.gz /tmp/freeDiameter-1.1.5
}

220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
install_freediameter_from_source() {
  cd /tmp
  echo "Downloading 1.2.0 freeDiameter archive"
  rm -rf /tmp/1.2.0.tar.gz* /tmp/freeDiameter-1.2.0
  wget http://www.freediameter.net/hg/freeDiameter/archive/1.2.0.tar.gz 
  tar xzf 1.2.0.tar.gz
  cd freeDiameter-1.2.0
  patch -p1 < $OPENAIRCN_DIR/S6A/freediameter/freediameter-1.2.0.patch 
  mkdir build
  cd build
  cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ../ 
  echo "Compiling freeDiameter"
  make -j4
  #make test 
  $SUDO make install 
  rm -rf /tmp/1.2.0.tar.gz /tmp/freeDiameter-1.2.0
}

thomasl's avatar
thomasl committed
238
check_install_usrp_uhd_driver(){
thomasl's avatar
thomasl committed
239
240
        v=$(lsb_release -cs)
        $SUDO apt-add-repository "deb http://files.ettus.com/binaries/uhd/repo/uhd/ubuntu/$v $v main"
thomasl's avatar
thomasl committed
241
        $SUDO apt-get update
thomasl's avatar
thomasl committed
242
243
244
        $SUDO apt-get -y install  python python-tk libboost-all-dev libusb-1.0-0-dev
        $SUDO apt-get -y install -t `lsb_release -cs` uhd --force-yes
}
245
246
247
248
check_install_bladerf_driver(){
	$SUDO add-apt-repository -y ppa:bladerf/bladerf
	$SUDO apt-get update
	$SUDO apt-get install -y bladerf libbladerf-dev
nikaeinn's avatar
nikaeinn committed
249
250
251
	$SUDO apt-get install bladerf-firmware-fx3
	$SUDO apt-get install bladerf-fpga-hostedx40	
	bladeRF-cli --flash-firmware /usr/share/Nuand/bladeRF/bladeRF_fw.img	
252
}
thomasl's avatar
thomasl committed
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

check_install_additional_tools (){
    $SUDO apt-get update
    $SUDO apt-get install -y \
	check \
	dialog \
	dkms \
	gawk \
	libboost-all-dev \
	libpthread-stubs0-dev \
	openvpn \
	phpmyadmin \
	pkg-config \
	python-dev  \
	python-pexpect \
	sshfs \
	swig  \
	tshark \
	uml-utilities \
	unzip  \
	valgrind  \
274
275
	vlan	  \
	ctags
thomasl's avatar
thomasl committed
276
277
278
279
280
}

check_install_oai_software() {
    
    $SUDO apt-get update
281
    $SUDO apt-get install -y \
thomasl's avatar
thomasl committed
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
        autoconf  \
	automake  \
	bison  \
	build-essential \
	cmake \
	cmake-curses-gui  \
	doxygen \
	ethtool \
	flex  \
	gccxml \
	gdb  \
	graphviz \
	gtkwave \
	guile-2.0-dev  \
	iperf \
	iproute \
	iptables \
	iptables-dev \
	libatlas-base-dev \
	libatlas-dev \
	libblas3gf \
	libblas-dev \
	libconfig8-dev \
	libforms-bin \
	libforms-dev \
	libgcrypt11-dev \
	libgmp-dev \
	libgtk-3-dev \
	libidn2-0-dev  \
thomasl's avatar
thomasl committed
311
        libidn11-dev \
thomasl's avatar
thomasl committed
312
	libmysqlclient-dev  \
313
	liboctave-dev \
thomasl's avatar
thomasl committed
314
315
316
317
318
319
320
321
322
323
324
	libpgm-5.1 \
	libpgm-dev \
	libsctp1  \
	libsctp-dev  \
	libssl-dev  \
	libtasn1-3-dev  \
	libtool  \
	libusb-1.0-0-dev \
	libxml2 \
	libxml2-dev  \
	linux-headers-`uname -r` \
325
	mscgen  \
thomasl's avatar
thomasl committed
326
327
	mysql-client  \
	mysql-server \
328
329
	octave \
	octave-signal \
thomasl's avatar
thomasl committed
330
331
332
333
	openssh-client \
	openssh-server \
	openssl \
	python  \
thomasl's avatar
thomasl committed
334
	subversion
335
    $SUDO update-alternatives --set liblapack.so /usr/lib/atlas-base/atlas/liblapack.so
thomasl's avatar
thomasl committed
336
337
338
339
340
341
342
    if [ `lsb_release -rs` = '12.04' ] ; then
        install_nettle_from_source
	install_gnutls_from_source
    else
        $SUDO apt-get install -y libgnutls-dev nettle-dev nettle-bin 
    fi
    install_freediameter_from_source
thomasl's avatar
thomasl committed
343
    install_asn1c_from_source
thomasl's avatar
thomasl committed
344
345
}

thomasl's avatar
thomasl committed
346
install_asn1c_from_source(){
347
    mkdir -p /tmp/asn1c-r1516
thomasl's avatar
thomasl committed
348
    cd /tmp/asn1c-r1516
349
    rm -rf /tmp/asn1c-r1516/*
thomasl's avatar
thomasl committed
350
351
    svn co https://github.com/vlm/asn1c/trunk  /tmp/asn1c-r1516 -r 1516 > /tmp/log_compile_asn1c
    patch -p0 < $OPENAIRCN_DIR/S1AP/MESSAGES/ASN1/asn1cpatch.p0 >> /tmp/log_compile_asn1c
352
    patch -p0 < $OPENAIRCN_DIR/S1AP/MESSAGES/ASN1/asn1cpatch_2.p0 >> /tmp/log_compile_asn1c
thomasl's avatar
thomasl committed
353
    ./configure
thomasl's avatar
thomasl committed
354
    make > /tmp/log_compile_asn1c 2>&1
thomasl's avatar
thomasl committed
355
    $SUDO make install
thomasl's avatar
thomasl committed
356
357
358
359
360
}

#################################################
# 2. compile 
################################################
thomasl's avatar
thomasl committed
361

thomasl's avatar
thomasl committed
362
install_nas_tools() {
gauthier's avatar
gauthier committed
363
364
365
366
367
  cd $1
  if [ ! -f .ue.nvram ]; then
    echo_success "generate .ue_emm.nvram .ue.nvram"
    ./nvram --gen
  else
gauthier's avatar
syntax    
gauthier committed
368
    [ ./nvram -nt .ue.nvram  -o ./nvram -nt .ue_emm.nvram ] && ./nvram --gen
gauthier's avatar
gauthier committed
369
  fi
thomasl's avatar
thomasl committed
370

gauthier's avatar
gauthier committed
371
372
373
374
375
376
  if [ ! -f .usim.nvram ]; then
    echo_success "generate .usim.nvram"
    ./usim --gen
  else
    [ ./usim -nt .usim.nvram ] && ./usim --gen
  fi
thomasl's avatar
thomasl committed
377
378
379
380
381
382
383

}

##################################
# create HSS DB
################################

384
385
386
387
388
# arg 1 is mysql admin     (ex: root)
# arg 2 is mysql password  (ex: linux)
# arg 3 is hss username    (ex: hssadmin)
# arg 4 is hss password    (ex: admin)
# arg 5 is database name   (ex: oai_db)
thomasl's avatar
thomasl committed
389
create_hss_database(){
390
391
392
393
394
395
396
397
398
399
400
  EXPECTED_ARGS=5
  if [ $# -ne $EXPECTED_ARGS ]
  then
    echo_error "Usage: $0 dbadmin dbpass hssuser hsspass databasename"
    return 1
  fi
  local mysql_admin=$1
  local mysql_password=$2
  local hss_username=$3
  local hss_password=$4
  local database_name=$5
thomasl's avatar
thomasl committed
401
    
402
403
404
405
406
407
408
409
410
411
412
  Q1="GRANT ALL PRIVILEGES ON *.* TO '$hss_username'@'localhost' IDENTIFIED BY '$hss_password' WITH GRANT OPTION;"
  Q2="FLUSH PRIVILEGES;"
  mysql -u $mysql_admin --password=$mysql_password -e "${Q1}${Q2}"
  if [ $? -ne 0 ]; then
    echo_error "HSS: $hss_username permissions creation failed"
    echo_error "verify root password for mysql is linux: mysql -u root --password=linux"
    echo_error "if not, reset it to "linux" with sudo dpkg-reconfigure mysql-server-5.5"
    return 1
  else
    echo_success "HSS: $hss_username permissions creation succeeded"
  fi
thomasl's avatar
thomasl committed
413
    
414
415
416
417
418
419
420
421
422
  Q3="CREATE DATABASE IF NOT EXISTS $database_name;"
  mysql -u $hss_username --password=$hss_password -e "${Q3}"
  if [ $? -ne 0 ]; then
    echo_error "HSS: $database_name creation failed"
    return 1
  else
    echo_success "HSS: $database_name creation succeeded"
  fi

thomasl's avatar
thomasl committed
423
    
424
425
426
427
  # test if tables have been created
  mysql -u $hss_username --password=$hss_password  -e "desc $database_name.users" > /dev/null 2>&1
  if [ $? -eq 1 ]; then 
    mysql -u $hss_username --password=$hss_password $database_name < $OPENAIRCN_DIR/OPENAIRHSS/db/$database_name.sql
thomasl's avatar
thomasl committed
428
    if [ $? -ne 0 ]; then
429
430
      echo_error "HSS: $database_name tables creation failed"
      return 1
thomasl's avatar
thomasl committed
431
    else
432
      echo_success "HSS: $database_name tables creation succeeded"
thomasl's avatar
thomasl committed
433
    fi
434
435
436
437
  else
      echo_success "HSS: $database_name tables already created, nothing done"
  fi 
  return 0
thomasl's avatar
thomasl committed
438
439
440
441
442
443
444
445
446
447
448
}

################################
# set_openair_env
###############################
set_openair_env(){
    fullpath=`readlink -f $BASH_SOURCE`
    [ -f "/.$fullpath" ] || fullpath=`readlink -f $PWD/$fullpath`
    openair_path=${fullpath%/cmake_targets/*}
    openair_path=${openair_path%/targets/*}
    openair_path=${openair_path%/openair-cn/*}
thomasl's avatar
thomasl committed
449
    openair_path=${openair_path%/openair[123]/*}    
thomasl's avatar
thomasl committed
450
451
452
453
454
455
456
457
    export OPENAIR_DIR=$openair_path
    export OPENAIR1_DIR=$openair_path/openair1
    export OPENAIR2_DIR=$openair_path/openair2
    export OPENAIR3_DIR=$openair_path/openair3
    export OPENAIRCN_DIR=$openair_path/openair-cn
    export OPENAIR_TARGETS=$openair_path/targets
}