build_helper 13.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
################################################################################
#   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
# brief
# author Laurent Thomas
#
#######################################
34
SUDO='sudo -E'
thomasl's avatar
thomasl committed
35

36 37 38 39 40 41 42
###############################
## echo and  family
###############################
black='\E[30m'
red='\E[31m'
green='\E[32m'
yellow='\E[33m'
43
blue='\E[1;34m'
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
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
97
 dir=$OPENAIR_DIR/cmake_targets
98
  rm -rf $dir/log $OPENAIR_DIR/targets/bin/* 
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
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
  {
    rm -f $3
115
    make -j`nproc` $2 VERBOSE=$VERBOSE_COMPILE
thomasl's avatar
thomasl committed
116
  } > $dlog/$2.$REL.txt 2>&1
117
  echo_info "Log file for compilation has been written to: $dlog/$2.$REL.txt"
thomasl's avatar
thomasl committed
118
  if [ -s $3 ] ; then
119
     cp $3 $4
thomasl's avatar
thomasl committed
120
     echo_success "$2 compiled"
thomasl's avatar
thomasl committed
121
  else
thomasl's avatar
thomasl committed
122
     echo_error "$2 compilation failed"
thomasl's avatar
thomasl committed
123 124 125
  fi
}

126

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

131
make_one_cert() {
thomasl's avatar
thomasl committed
132 133 134 135 136
    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
137 138
}

thomasl's avatar
thomasl committed
139
make_certs(){
thomasl's avatar
thomasl committed
140 141
    
    fqdn=$1
142
  certs_dir=$FREEDIAMETER_PREFIX/freeDiameter
143
    # certificates are stored in diameter config directory
thomasl's avatar
thomasl committed
144 145 146
    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
147
    fi
148

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

    # CA self certificate
thomasl's avatar
thomasl committed
158
    $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
159
    
160
    # generate hss certificate and sign it
thomasl's avatar
thomasl committed
161 162
    make_one_cert eur hss
    make_one_cert eur mme
163 164

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

thomasl's avatar
thomasl committed
167 168
}

thomasl's avatar
thomasl committed
169

170 171 172 173
############################################
# External packages installers
############################################

thomasl's avatar
thomasl committed
174 175 176
install_nettle_from_source() {
    cd /tmp
    echo "Downloading nettle archive"
177
    rm -rf /tmp/nettle-2.5.tar.gz* /tmp/nettle-2.5
thomasl's avatar
thomasl committed
178 179 180 181 182
    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"
183
    make -j`nproc`
thomasl's avatar
thomasl committed
184 185 186 187 188 189 190 191
    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"
192
    rm -rf /tmp/gnutls-3.1.23.tar.xz* /tmp/gnutls-3.1.23
thomasl's avatar
thomasl committed
193 194 195 196 197
    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"
198
    make -j`nproc`
thomasl's avatar
thomasl committed
199 200 201 202
    $SUDO make install 
    rm -rf /tmp/gnutls-3.1.23.tar.xz /tmp/gnutls-3.1.23
}

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

221 222 223 224 225 226 227
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
228
  patch -p1 < $OPENAIR_DIR/openair-cn/S6A/freediameter/freediameter-1.2.0.patch 
229 230 231 232
  mkdir build
  cd build
  cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ../ 
  echo "Compiling freeDiameter"
233
  make -j`nproc`
234 235 236 237 238
  #make test 
  $SUDO make install 
  rm -rf /tmp/1.2.0.tar.gz /tmp/freeDiameter-1.2.0
}

gauthier's avatar
gauthier committed
239 240 241 242 243 244 245 246 247 248 249
install_latest_freediameter_from_source() {
  cd /tmp
  rm -rf /tmp/freeDiameter
  echo "Downloading latest freeDiameter trunk (may be unstable)"
  git clone https://github.com/Metaswitch/freeDiameter.git
  cd freeDiameter
  patch -p1 < $OPENAIR_DIR/openair-cn/S6A/freediameter/freediameter-1.2.0.patch 
  mkdir build
  cd build
  cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr ../ 
  echo "Compiling freeDiameter"
250
  make -j`nproc`
gauthier's avatar
gauthier committed
251 252 253 254
  #make test 
  $SUDO make install 
  rm -rf /tmp/freeDiameter
}
255 256


thomasl's avatar
thomasl committed
257
check_install_usrp_uhd_driver(){
thomasl's avatar
thomasl committed
258 259
        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
260
        $SUDO apt-get update
thomasl's avatar
thomasl committed
261 262 263
        $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
}
264 265 266 267
check_install_bladerf_driver(){
	$SUDO add-apt-repository -y ppa:bladerf/bladerf
	$SUDO apt-get update
	$SUDO apt-get install -y bladerf libbladerf-dev
268 269 270
	$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	
271
}
thomasl's avatar
thomasl committed
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

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  \
293 294
	vlan	  \
	ctags
thomasl's avatar
thomasl committed
295 296 297 298 299
}

check_install_oai_software() {
    
    $SUDO apt-get update
300
    $SUDO apt-get install -y \
301
    autoconf  \
thomasl's avatar
thomasl committed
302 303 304 305 306 307
	automake  \
	bison  \
	build-essential \
	cmake \
	cmake-curses-gui  \
	doxygen \
308
	doxygen-gui\
309
	texlive-latex-base\
thomasl's avatar
thomasl committed
310 311
	ethtool \
	flex  \
312 313 314
    gccxml \
    gdb  \
    git \
thomasl's avatar
thomasl committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
	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  \
333
    libidn11-dev \
thomasl's avatar
thomasl committed
334
	libmysqlclient-dev  \
335
	liboctave-dev \
thomasl's avatar
thomasl committed
336 337 338 339 340 341 342 343 344 345 346
	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` \
347
	mscgen  \
thomasl's avatar
thomasl committed
348 349
	mysql-client  \
	mysql-server \
350 351
	octave \
	octave-signal \
thomasl's avatar
thomasl committed
352 353 354 355
	openssh-client \
	openssh-server \
	openssl \
	python  \
thomasl's avatar
thomasl committed
356
	subversion
357
    $SUDO update-alternatives --set liblapack.so /usr/lib/atlas-base/atlas/liblapack.so
thomasl's avatar
thomasl committed
358 359 360 361 362 363 364
    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
365
    install_asn1c_from_source
thomasl's avatar
thomasl committed
366 367
}

thomasl's avatar
thomasl committed
368
install_asn1c_from_source(){
369
    mkdir -p /tmp/asn1c-r1516
thomasl's avatar
thomasl committed
370
    cd /tmp/asn1c-r1516
371
    rm -rf /tmp/asn1c-r1516/*
thomasl's avatar
thomasl committed
372
    svn co https://github.com/vlm/asn1c/trunk  /tmp/asn1c-r1516 -r 1516 > /tmp/log_compile_asn1c
373 374
    patch -p0 < $OPENAIR_DIR/openair-cn/S1AP/MESSAGES/ASN1/asn1cpatch.p0 >> /tmp/log_compile_asn1c
    patch -p0 < $OPENAIR_DIR/openair-cn/S1AP/MESSAGES/ASN1/asn1cpatch_2.p0 >> /tmp/log_compile_asn1c
375
    patch -p0 < $OPENAIR_DIR/openair2/RRC/LITE/MESSAGES/asn1c/asn1cpatch.p0 >> /tmp/log_compile_asn1c
thomasl's avatar
thomasl committed
376
    ./configure
thomasl's avatar
thomasl committed
377
    make > /tmp/log_compile_asn1c 2>&1
thomasl's avatar
thomasl committed
378
    $SUDO make install
thomasl's avatar
thomasl committed
379 380 381 382 383
}

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

thomasl's avatar
thomasl committed
385
install_nas_tools() {
gauthier's avatar
gauthier committed
386 387 388 389 390
  cd $1
  if [ ! -f .ue.nvram ]; then
    echo_success "generate .ue_emm.nvram .ue.nvram"
    ./nvram --gen
  else
gauthier's avatar
gauthier committed
391
    [ ./nvram -nt .ue.nvram  -o ./nvram -nt .ue_emm.nvram ] && ./nvram --gen
gauthier's avatar
gauthier committed
392
  fi
thomasl's avatar
thomasl committed
393

gauthier's avatar
gauthier committed
394 395 396 397 398 399
  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
400 401 402 403 404 405 406

}

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

407 408 409 410 411
# 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
412
create_hss_database(){
413 414 415 416 417 418 419 420 421 422 423
  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
424
    
425 426 427 428 429 430 431 432 433 434 435
  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
436
    
437 438 439 440 441 442 443 444 445
  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
446
    
447 448 449
  # 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 
450
    mysql -u $hss_username --password=$hss_password $database_name < $OPENAIR_DIR/openair-cn/OPENAIRHSS/db/$database_name.sql
thomasl's avatar
thomasl committed
451
    if [ $? -ne 0 ]; then
452 453
      echo_error "HSS: $database_name tables creation failed"
      return 1
thomasl's avatar
thomasl committed
454
    else
455
      echo_success "HSS: $database_name tables creation succeeded"
thomasl's avatar
thomasl committed
456
    fi
457 458 459 460
  else
      echo_success "HSS: $database_name tables already created, nothing done"
  fi 
  return 0
thomasl's avatar
thomasl committed
461 462 463 464 465 466 467 468 469 470 471
}

################################
# 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
472
    openair_path=${openair_path%/openair[123]/*}    
thomasl's avatar
thomasl committed
473 474 475 476 477 478 479 480
    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
}