build_helper 12.2 KB
Newer Older
1
 ################################################################################
thomasl's avatar
thomasl committed
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
########################
# distribution helpers #
########################
73

74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# This function return a string to identify the distribution we are running
# If we can't check the distribution, it returns "Unknown"
# This function return always true as exit code by design
# Examples:
#   Ubuntu16.04
#   Debian8.5
get_distribution_release() {
    local distributor
    if distributor=$(lsb_release -si 2>/dev/null) ; then
        echo $distributor$(lsb_release -sr)
    else
        echo Unknown
    fi
}

check_supported_distribution() {
    local distribution=$(get_distribution_release)
    case "$distribution" in
        "Ubuntu16.04") return 0 ;;
        "Ubuntu14.04") return 0 ;;
    esac
    return 1
}
97

98
99
100
101
102
103
104
105
106
107
108
109
##################
# Error handlers #
##################

handler_EXIT() {
	local exit_code=$?
    [ "$exit_code" -eq 0 ] || echo_error "build have failed"
	exit $exit_code
}

trap handler_EXIT EXIT

110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
###########################
# 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() {
136
 set_openair_env
thomasl's avatar
thomasl committed
137
 dir=$OPENAIR_DIR/cmake_targets
138
 rm -rf $dir/log $OPENAIR_DIR/targets/bin/* 
thomasl's avatar
thomasl committed
139
140
141
 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 
142
143
144
145
146
147
}

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

thomasl's avatar
thomasl committed
148
compilations() {
thomasl's avatar
thomasl committed
149
  cd $OPENAIR_DIR/cmake_targets/$1/build
150
  set +e
thomasl's avatar
thomasl committed
151
152
  {
    rm -f $3
153
154
155
156
157
158
    if [ "$VERBOSE_COMPILE" == "1" ]; then
       make -j`nproc` $2 VERBOSE=$VERBOSE_COMPILE
    else
       make -j`nproc` $2
    fi

thomasl's avatar
thomasl committed
159
  } > $dlog/$2.$REL.txt 2>&1
160
  set -e
161
  echo_info "Log file for compilation has been written to: $dlog/$2.$REL.txt"
thomasl's avatar
thomasl committed
162
  if [ -s $3 ] ; then
163
     cp $3 $4
thomasl's avatar
thomasl committed
164
     echo_success "$2 compiled"
thomasl's avatar
thomasl committed
165
  else
thomasl's avatar
thomasl committed
166
     echo_error "$2 compilation failed"
167
     exit 1
thomasl's avatar
thomasl committed
168
169
170
  fi
}

171
172
173
174
############################################
# External packages installers
############################################

thomasl's avatar
thomasl committed
175
check_install_usrp_uhd_driver(){
176
        #first we remove old installation
177
178
        $SUDO apt-get remove -y uhd || true
        $SUDO apt-get remove libuhd-dev libuhd003 uhd-host -y
thomasl's avatar
thomasl committed
179
        v=$(lsb_release -cs)
180
181
182
        $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
183
        $SUDO apt-get update
thomasl's avatar
thomasl committed
184
        $SUDO apt-get -y install  python python-tk libboost-all-dev libusb-1.0-0-dev
185
186
187
188
189
190
191
        $SUDO apt-get -y install libuhd-dev libuhd003
}

install_usrp_uhd_driver() {
        # We move uhd-host apart because it depends on linux kernel version
        # On newer kernels, it fails to install
        $SUDO apt-get -y install uhd-host
192
        $SUDO uhd_images_downloader 
thomasl's avatar
thomasl committed
193
}
194

195
check_install_bladerf_driver(){
196
197
198
199
	if [ "$(get_distribution_release)" == "Ubuntu14.04" ] ; then
		$SUDO add-apt-repository -y ppa:bladerf/bladerf
		$SUDO apt-get update
	fi
200
	$SUDO apt-get install -y bladerf libbladerf-dev
201
202
	$SUDO apt-get install -y bladerf-firmware-fx3
	$SUDO apt-get install -y bladerf-fpga-hostedx40	
203
204
205
206
}

flash_firmware_bladerf() {
	$SUDO bladeRF-cli --flash-firmware /usr/share/Nuand/bladeRF/bladeRF_fw.img
207
}
thomasl's avatar
thomasl committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

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  \
228
	vlan	  \
229
	ctags \
230
231
        ntpdate \
        iperf3 \
Rohit Gupta's avatar
Rohit Gupta committed
232
233
234
        android-tools-adb \
	wvdial \
        python-numpy \
235
236
    sshpass \
    nscd
237
238
239
240

    $SUDO pip install paramiko
    $SUDO pip install pyroute2
    $SUDO rm -fr /opt/ssh
241
    $SUDO GIT_SSL_NO_VERIFY=true git clone https://gist.github.com/2190472.git /opt/ssh
242
243
244
245
    
    log_netiface=$OPENAIR_DIR/cmake_targets/log/netiface_install_log.txt
    echo_info "Installing Netinterfaces package. The logfile for installation is in $log_netiface"
    (
246
247
248
249
250
251
    $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 -
252
    ) >& $log_netiface
thomasl's avatar
thomasl committed
253
254
255
}

check_install_oai_software() {
256
    local specific_packages=""
257
258
259
260
    if ! check_supported_distribution; then
        echo_error "Your distribution $(get_distribution_release) is not supported by oai !"
        exit 1
    fi
thomasl's avatar
thomasl committed
261
    $SUDO apt-get update
262
    $SUDO apt install -y software-properties-common
263
264
    case "$(get_distribution_release)" in
        "Ubuntu14.04")
265
            specific_packages="libtasn1-3-dev"
266
267
268
            # For iperf3
            $SUDO add-apt-repository "deb http://archive.ubuntu.com/ubuntu trusty-backports universe"
            $SUDO apt-get update
269
270
271
272
            ;;
        "Ubuntu16.04")
            specific_packages="libtasn1-6-dev"
            ;;
273
    esac
274
    $SUDO apt-get install -y \
275
    $specific_packages \
276
	autoconf  \
thomasl's avatar
thomasl committed
277
278
279
280
281
282
	automake  \
	bison  \
	build-essential \
	cmake \
	cmake-curses-gui  \
	doxygen \
283
284
	doxygen-gui \
	texlive-latex-base \
thomasl's avatar
thomasl committed
285
286
	ethtool \
	flex  \
287
288
289
	gccxml \
	gdb  \
	git \
thomasl's avatar
thomasl committed
290
291
292
293
294
295
296
297
298
299
300
	graphviz \
	gtkwave \
	guile-2.0-dev  \
	iperf \
	iproute \
	iptables \
	iptables-dev \
	libatlas-base-dev \
	libatlas-dev \
	libblas-dev \
	libconfig8-dev \
301
	libffi-dev \
thomasl's avatar
thomasl committed
302
303
304
305
306
307
	libforms-bin \
	libforms-dev \
	libgcrypt11-dev \
	libgmp-dev \
	libgtk-3-dev \
	libidn2-0-dev  \
308
	libidn11-dev \
thomasl's avatar
thomasl committed
309
	libmysqlclient-dev  \
310
	liboctave-dev \
thomasl's avatar
thomasl committed
311
	libpgm-dev \
312
	libpython2.7-dev \
thomasl's avatar
thomasl committed
313
314
315
316
317
318
319
	libsctp1  \
	libsctp-dev  \
	libssl-dev  \
	libtool  \
	libusb-1.0-0-dev \
	libxml2 \
	libxml2-dev  \
320
	libxslt1-dev \
321
322
323
	mscgen  \
	octave \
	octave-signal \
thomasl's avatar
thomasl committed
324
325
326
327
	openssh-client \
	openssh-server \
	openssl \
	python  \
Rohit Gupta's avatar
Rohit Gupta committed
328
	subversion \
329
330
331
	xmlstarlet \
	python-pip \
	pydb \
Rohit Gupta's avatar
Rohit Gupta committed
332
	wget
Rohit Gupta's avatar
Rohit Gupta committed
333

334
    $SUDO update-alternatives --set liblapack.so /usr/lib/atlas-base/atlas/liblapack.so
laurent's avatar
laurent committed
335
    $SUDO apt-get install libgnutls-dev nettle-dev nettle-bin
336
    
thomasl's avatar
thomasl committed
337
    install_asn1c_from_source
thomasl's avatar
thomasl committed
338
339
}

thomasl's avatar
thomasl committed
340
install_asn1c_from_source(){
341
342
    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 "
343
    (
Cedric Roux's avatar
Cedric Roux committed
344
345
346
    $SUDO rm -rf /tmp/asn1c
    git clone https://gitlab.eurecom.fr/oai/asn1c.git /tmp/asn1c
    cd /tmp/asn1c
thomasl's avatar
thomasl committed
347
    ./configure
348
    make -j`nproc`
349
    $SUDO make install
Rohit Gupta's avatar
Rohit Gupta committed
350
    cd -
351
    ) > $asn1_install_log 2>&1
thomasl's avatar
thomasl committed
352
353
354
355
356
}

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

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

gauthier's avatar
gauthier committed
367
368
369
370
371
372
  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
373
374

}
375

thomasl's avatar
thomasl committed
376
377
378
379
380
381
382
383
384

################################
# 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
385
    openair_path=${openair_path%/openair[123]/*}    
thomasl's avatar
thomasl committed
386
387
388
389
390
391
392
    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
}

393
394
395
396
397
398
399
400
################################
# 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..."
401
402
echo_info "** Calling sync now..."
sync 
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
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 ]
420
421
422
423
424
           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"
425
426
427
428
429
430
431
432
433
             $SUDO kill -9 "${procid[$arraycounter]}" >/dev/null
             arraycounter=`expr $arraycounter - 1`
           done
         exit
        fi
done
}


434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
# 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
451
}