build_helper 13.4 KB
Newer Older
thomasl's avatar
thomasl committed
1 2
################################################################################
#
3 4
# Copyright (c) 2015, EURECOM (www.eurecom.fr)
# All rights reserved.
thomasl's avatar
thomasl committed
5
#
6 7
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
thomasl's avatar
thomasl committed
8
#
9 10 11 12 13
# 1. Redistributions of source code must retain the above copyright notice, this
#    list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright notice,
#    this list of conditions and the following disclaimer in the documentation
#    and/or other materials provided with the distribution.
thomasl's avatar
thomasl committed
14
#
15 16 17 18 19 20 21 22 23 24
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
thomasl's avatar
thomasl committed
25
#
26 27 28
# The views and conclusions contained in the software and documentation are those
# of the authors and should not be interpreted as representing official policies,
# either expressed or implied, of the FreeBSD Project.
thomasl's avatar
thomasl committed
29 30
#
################################################################################
31
# file build_helper
thomasl's avatar
thomasl committed
32
# brief
33
# authors Laurent Thomas, Lionel GAUTHIER
thomasl's avatar
thomasl committed
34 35
#
#######################################
36
SUDO='sudo -E'
thomasl's avatar
thomasl committed
37

38 39 40 41 42 43 44
###############################
## echo and  family
###############################
black='\E[30m'
red='\E[31m'
green='\E[32m'
yellow='\E[33m'
45
blue='\E[1;34m'
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
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         ;}

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 96 97

###########################
# 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() {
98
 set_openair_env
99
 dir=$OPENAIR_DIR/cmake_targets
100
 rm -rf $dir/log $OPENAIR_DIR/targets/bin/* 
101 102 103
 rm -rf $dir/lte_build_oai $dir/lte-simulators/build
 rm -rf $dir/oaisim_build_oai/build $dir/oaisim_build_oai/CMakeLists.txt
 rm -rf $dir/autotests/bin $dir/autotests/log $dir/autotests/*/build 
104 105 106 107 108 109
}

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

thomasl's avatar
thomasl committed
110
compilations() {
thomasl's avatar
thomasl committed
111
  cd $OPENAIR_DIR/cmake_targets/$1/build
thomasl's avatar
thomasl committed
112 113
  {
    rm -f $3
114 115 116 117 118 119
    if [ "$VERBOSE_COMPILE" == "1" ]; then
       make -j`nproc` $2 VERBOSE=$VERBOSE_COMPILE
    else
       make -j`nproc` $2
    fi

thomasl's avatar
thomasl committed
120
  } > $dlog/$2.$REL.txt 2>&1
121
  echo_info "Log file for compilation has been written to: $dlog/$2.$REL.txt"
thomasl's avatar
thomasl committed
122
  if [ -s $3 ] ; then
123
     cp $3 $4
thomasl's avatar
thomasl committed
124
     echo_success "$2 compiled"
thomasl's avatar
thomasl committed
125
  else
thomasl's avatar
thomasl committed
126
     echo_error "$2 compilation failed"
thomasl's avatar
thomasl committed
127 128 129
  fi
}

130 131 132 133
############################################
# External packages installers
############################################

thomasl's avatar
thomasl committed
134
install_nettle_from_source() {
135 136 137
    nettle_install_log=$OPENAIR_DIR/cmake_targets/log/nettle_install_log.txt
    echo_info "\nInstalling Nettle. The log file for nettle installation is here: $nettle_install_log "
    (
thomasl's avatar
thomasl committed
138 139
    cd /tmp
    echo "Downloading nettle archive"
140 141 142 143 144 145 146 147 148 149
    $SUDO rm -rf /tmp/nettle-2.5.tar.gz* /tmp/nettle-2.5
    wget https://ftp.gnu.org/gnu/nettle/nettle-2.5.tar.gz
    if [ $? -ne 0 ]; then
      wget ftp://ftp.lysator.liu.se/pub/security/lsh/nettle-2.5.tar.gz
    fi
    if [ ! -f nettle-2.5.tar.gz ]; then
      echo_error "Could not download nettle source files"
      cd -
      return
    fi
thomasl's avatar
thomasl committed
150 151 152 153
    tar -xzf nettle-2.5.tar.gz
    cd nettle-2.5/
    ./configure --disable-openssl --enable-shared --prefix=/usr 
    echo "Compiling nettle"
154
    make -j`nproc`
thomasl's avatar
thomasl committed
155 156
    make check 
    $SUDO make install 
157
    ) >& $nettle_install_log
thomasl's avatar
thomasl committed
158 159
}

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190

install_protobuf_from_source(){
    cd /tmp
    echo "Downloading protobuf"
    rm -rf /tmp/protobuf-2.6.1.tar.gz* /tmp/protobuf-2.6.1
    wget https://github.com/google/protobuf/releases/download/v2.6.1/protobuf-2.6.1.tar.gz
    tar -xzvf protobuf-2.6.1.tar.gz
    cd protobuf-2.6.1/
    ./configure
    echo "Compiling protobuf"
    make -j`nproc`
    $SUDO make install
    rm -rf /tmp/protobuf-2.6.1.tar.gz /tmp/protobuf-2.6.1
    $SUDO ldconfig
}

install_protobuf_c_from_source(){
    cd /tmp
    echo "Downloading protobuf-c"
    rm -rf /tmp/protobuf-c
    git clone https://github.com/protobuf-c/protobuf-c.git
    cd protobuf-c
    ./autogen.sh
    ./configure
    echo "Compiling protobuf-c"
    make -j`nproc`
    $SUDO make install
    rm -rf /tmp/protobuf-c
    $SUDO ldconfig
}

thomasl's avatar
thomasl committed
191
install_gnutls_from_source(){
192 193 194
    gnutls_install_log=$OPENAIR_DIR/cmake_targets/log/gnutls_install_log.txt
    echo_info "\nInstalling Gnutls. The log file for Gnutls installation is here: $gnutls_install_log "
    (
thomasl's avatar
thomasl committed
195 196
    cd /tmp 
    echo "Downloading gnutls archive"
197 198 199 200 201 202 203 204 205 206 207
    $SUDO rm -rf /tmp/gnutls-3.1.23.tar.xz* /tmp/gnutls-3.1.23
    wget http://mirrors.dotsrc.org/gcrypt/gnutls/v3.1/gnutls-3.1.23.tar.xz
    if [ $? -ne 0 ]; then
      wget ftp://ftp.gnutls.org/gcrypt/gnutls/v3.1/gnutls-3.1.23.tar.xz
    fi
    if [ ! -f gnutls-3.1.23.tar.xz ]; then
      echo_error "Could not download gnutls source files"
      cd -
      return
    fi
    tar -xJf gnutls-3.1.23.tar.xz
thomasl's avatar
thomasl committed
208 209 210
    cd gnutls-3.1.23/
    ./configure --prefix=/usr
    echo "Compiling gnutls"
211
    make -j`nproc`
thomasl's avatar
thomasl committed
212
    $SUDO make install 
213
    )>& $gnutls_install_log
thomasl's avatar
thomasl committed
214 215
}

216 217


thomasl's avatar
thomasl committed
218
check_install_usrp_uhd_driver(){
219 220
        #first we remove old installation
        $SUDO apt-get remove uhd libuhd-dev libuhd003 uhd-host -y
thomasl's avatar
thomasl committed
221
        v=$(lsb_release -cs)
222 223 224
        $SUDO apt-add-repository --remove "deb http://files.ettus.com/binaries/uhd/repo/uhd/ubuntu/$v $v main"
        #The new USRP repository
        $SUDO add-apt-repository ppa:ettusresearch/uhd -y
thomasl's avatar
thomasl committed
225
        $SUDO apt-get update
thomasl's avatar
thomasl committed
226
        $SUDO apt-get -y install  python python-tk libboost-all-dev libusb-1.0-0-dev
227 228
        $SUDO apt-get -y install libuhd-dev libuhd003 uhd-host
        $SUDO uhd_images_downloader 
thomasl's avatar
thomasl committed
229
}
230 231 232 233
check_install_bladerf_driver(){
	$SUDO add-apt-repository -y ppa:bladerf/bladerf
	$SUDO apt-get update
	$SUDO apt-get install -y bladerf libbladerf-dev
234 235
	$SUDO apt-get install -y bladerf-firmware-fx3
	$SUDO apt-get install -y bladerf-fpga-hostedx40	
236
	$SUDO bladeRF-cli --flash-firmware /usr/share/Nuand/bladeRF/bladeRF_fw.img	
237
}
thomasl's avatar
thomasl committed
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

check_install_additional_tools (){
    $SUDO apt-get update
    $SUDO apt-get install -y \
	check \
	dialog \
	dkms \
	gawk \
	libboost-all-dev \
	libpthread-stubs0-dev \
	openvpn \
	pkg-config \
	python-dev  \
	python-pexpect \
	sshfs \
	swig  \
	tshark \
	uml-utilities \
	unzip  \
	valgrind  \
258
	vlan	  \
259
	ctags \
260 261 262 263 264 265 266
        ntpdate \
        iperf3 \
        android-tools-adb

    $SUDO pip install paramiko
    $SUDO pip install pyroute2
    $SUDO rm -fr /opt/ssh
267
    $SUDO GIT_SSL_NO_VERIFY=true git clone https://gist.github.com/2190472.git /opt/ssh
268 269 270 271
    
    log_netiface=$OPENAIR_DIR/cmake_targets/log/netiface_install_log.txt
    echo_info "Installing Netinterfaces package. The logfile for installation is in $log_netiface"
    (
272 273 274 275 276 277
    $SUDO rm -fr /tmp/netifaces-0.10.4.tar.gz /tmp/netifaces
    wget -P /tmp  https://pypi.python.org/packages/18/fa/dd13d4910aea339c0bb87d2b3838d8fd923c11869b1f6e741dbd0ff3bc00/netifaces-0.10.4.tar.gz
    tar -xzvf /tmp/netifaces-0.10.4.tar.gz -C /tmp
    cd /tmp/netifaces-0.10.4
    $SUDO python setup.py install
    cd -
278
    ) >& $log_netiface
thomasl's avatar
thomasl committed
279 280 281 282
}

check_install_oai_software() {
    $SUDO apt-get update
283
    $SUDO apt-get install -y \
284
	autoconf  \
thomasl's avatar
thomasl committed
285 286 287 288 289 290
	automake  \
	bison  \
	build-essential \
	cmake \
	cmake-curses-gui  \
	doxygen \
291 292
	doxygen-gui \
	texlive-latex-base \
thomasl's avatar
thomasl committed
293 294
	ethtool \
	flex  \
295 296 297
	gccxml \
	gdb  \
	git \
thomasl's avatar
thomasl committed
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
	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  \
316
	libidn11-dev \
thomasl's avatar
thomasl committed
317
	libmysqlclient-dev  \
318
	liboctave-dev \
thomasl's avatar
thomasl committed
319 320 321 322 323 324 325 326 327 328 329
	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` \
330 331 332
	mscgen  \
	octave \
	octave-signal \
thomasl's avatar
thomasl committed
333 334 335 336
	openssh-client \
	openssh-server \
	openssl \
	python  \
337
	subversion \
338 339 340
	xmlstarlet \
	python-pip \
	pydb \
341
	wvdial \
342
        python-numpy \
Rohit Gupta's avatar
Rohit Gupta committed
343
        sshpass \
344
        libxslt1-dev \
345 346
        android-tools-adb \
	libyaml-dev
Rohit Gupta's avatar
Rohit Gupta committed
347

348
    $SUDO update-alternatives --set liblapack.so /usr/lib/atlas-base/atlas/liblapack.so
349 350 351 352 353 354
    
    # First we remove gnutls/nettle installation and then install from sources
    $SUDO apt-get remove -y libgnutls-dev nettle-dev nettle-bin
    install_nettle_from_source
    install_gnutls_from_source

thomasl's avatar
thomasl committed
355
    install_asn1c_from_source
356 357
    $SUDO rm -fr /opt/ssh
    $SUDO git clone https://gist.github.com/2190472.git /opt/ssh
358 359
    install_protobuf_from_source
    install_protobuf_c_from_source
thomasl's avatar
thomasl committed
360 361
}

thomasl's avatar
thomasl committed
362
install_asn1c_from_source(){
363 364
    asn1_install_log=$OPENAIR_DIR/cmake_targets/log/asn1c_install_log.txt
    echo_info "\nInstalling ASN1. The log file for ASN1 installation is here: $asn1_install_log "
365
    (
366
    $SUDO rm -rf /tmp/asn1c-r1516
367 368 369 370 371 372
    svn co https://github.com/vlm/asn1c/trunk  /tmp/asn1c-r1516 -r 1516
    cd /tmp/asn1c-r1516 
    patch -p0 < $OPENAIR_DIR/openair3/S1AP/MESSAGES/ASN1/asn1cpatch.p0 
    patch -p0 < $OPENAIR_DIR/openair3/S1AP/MESSAGES/ASN1/asn1cpatch_2.p0 
    patch -p0 < $OPENAIR_DIR/openair2/RRC/LITE/MESSAGES/asn1c/asn1cpatch.p0 
    patch -p0 < $OPENAIR_DIR/openair3/S1AP/MESSAGES/ASN1/asn1cpatch_3.p0 
thomasl's avatar
thomasl committed
373
    ./configure
374
    make -j`nproc`
375
    $SUDO make install
376
    ) > $asn1_install_log 2>&1
thomasl's avatar
thomasl committed
377 378 379 380 381
}

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

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

gauthier's avatar
gauthier committed
392 393 394 395 396 397
  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
398 399

}
400

thomasl's avatar
thomasl committed
401 402 403 404 405 406 407 408 409

################################
# 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/*}
thomasl's avatar
thomasl committed
410
    openair_path=${openair_path%/openair[123]/*}    
thomasl's avatar
thomasl committed
411 412 413 414 415 416 417
    export OPENAIR_DIR=$openair_path
    export OPENAIR1_DIR=$openair_path/openair1
    export OPENAIR2_DIR=$openair_path/openair2
    export OPENAIR3_DIR=$openair_path/openair3
    export OPENAIR_TARGETS=$openair_path/targets
}

418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
################################
# Function to killall the subprocesses when Ctrl-C Key is hit
###############################
function handle_ctrl_c(){
CURPID=$$
ppid=$$
arraycounter=1
echo_info "** Trapped CTRL-C. Killing all subprocesses now..."
while true
do
        FORLOOP=FALSE
        # Get all the child process id
        for i in `ps -ef| awk '$3 == '$ppid' { print $2 }'`
        do
                if [ $i -ne $CURPID ] ; then
                        procid[$arraycounter]=$i
                        arraycounter=`expr $arraycounter + 1`
                        ppid=$i
                        FORLOOP=TRUE
                fi
        done
        if [ "$FORLOOP" = "FALSE" ] ; then
           arraycounter=`expr $arraycounter - 1`
           ## We want to kill child process id first and then parent id's
           while [ $arraycounter -ne 0 ]
443 444 445 446 447
           do  
             echo "first we send ctrl-c to program"
             $SUDO kill -INT "${procid[$arraycounter]}"
             sleep 5
             echo "Now we force kill if that didn't work"
448 449 450 451 452 453 454 455 456
             $SUDO kill -9 "${procid[$arraycounter]}" >/dev/null
             arraycounter=`expr $arraycounter - 1`
           done
         exit
        fi
done
}


457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
# get from http://www.linuxjournal.com/content/validating-ip-address-bash-script
validate_ip() {

local  ip=$1
local  stat=1

if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
    OIFS=$IFS
    IFS='.'
    ip=($ip)
    IFS=$OIFS
    [[ ${ip[0]} -le 255 && ${ip[1]} -le 255 \
        && ${ip[2]} -le 255 && ${ip[3]} -le 255 ]]
    stat=$?
fi

return $stat
Rohit Gupta's avatar
Rohit Gupta committed
474
}