summaryrefslogtreecommitdiffstats
path: root/tools/vnf_build.sh
blob: d1bb898f7c6eb197b9ef2533afbbd745bea24e2a (plain)
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
30
31
32
33
34
35
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
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
#! /bin/bash
#
# Copyright (c) 2017 Intel Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

cd $(dirname ${BASH_SOURCE[0]})/..
export VNF_CORE=$PWD
echo "------------------------------------------------------------------------------"
echo " VNF_CORE exported as $VNF_CORE"
echo "------------------------------------------------------------------------------"

HUGEPGSZ=`cat /proc/meminfo  | grep Hugepagesize | cut -d : -f 2 | tr -d ' '`
MODPROBE="/sbin/modprobe"
INSMOD="/sbin/insmod"
DPDK_DOWNLOAD="Not initialized"
CIVETWEB_DOWNLOAD="Not initialized"
DPDK_DIR=$VNF_CORE/dpdk
DPDK_RTE_VER="17.02"

#
# Sets QUIT variable so script will finish.
#
quit()
{
	QUIT=$1
}

# Shortcut for quit.
q()
{
	quit
}

setup_http_proxy()
{
	while true; do
		echo
		read -p "Enter Proxy : " proxy
		export http_proxy=$proxy
		export https_proxy=$proxy
		echo "Acquire::http::proxy \"$http_proxy\";" | sudo tee -a /etc/apt/apt.conf > /dev/null
		echo "Acquire::https::proxy \"$http_proxy\";" | sudo tee -a /etc/apt/apt.conf > /dev/null

		wget -T 20 -t 3 --spider http://www.google.com > /dev/null 2>&1
		if [ "$?" != 0 ]; then
			echo -e "No Internet connection. Proxy incorrect? Try again"
			echo -e "eg: http://<proxy>:<port>"
			exit 1
		fi
	return
	done
	echo "Network connectivity successful."
}

step_1()
{
        TITLE="Environment setup."
        CONFIG_NUM=1
        TEXT[1]="Check OS and network connection"
        FUNC[1]="setup_env"
        TEXT[2]="Select DPDK RTE version"
        FUNC[2]="select_dpdk_rte_ver"
}
setup_env()
{
	# a. Check for OS dependencies
	source /etc/os-release
	if [[ $VERSION_ID != "16.04" ]] ; then
		echo "WARNING: It is recommended to use Ubuntu 16.04..Your version is "$VERSION_ID
	else
		echo "Ubuntu 16.04 OS requirement met..."
	fi
	echo
	echo "Checking network connectivity..."
	# b. Check for internet connections
	wget -T 20 -t 3 --spider http://www.google.com > /dev/null 2>&1
	if [ "$?" != 0 ]; then
		while true; do
			read -p "No Internet connection. Are you behind a proxy (y/n)? " yn
			case $yn in
				[Yy]* ) $SETUP_PROXY ; return;;
				[Nn]* ) echo "Please check your internet connection..." ; exit;;
				* ) "Please answer yes or no.";;
			esac
		done
	fi
	echo "Network connectivity successful."
}
select_dpdk_rte_ver()
{

	TITLE="Select the DPDK RTE version"
	CONFIG_NUM=1
	echo "[1] DPDK 16.04"
	echo "[2] DPDK 16.11"
	echo "[3] DPDK 17.02"
	echo "[4] DPDK 17.05"
	echo

	while true; do
		read -p "Select DPDK version to be used: " yn
			case $yn in
				[1]* ) DPDK_RTE_VER=16.04 ; return;;
				[2]* ) DPDK_RTE_VER=16.11 ; return;;
				[3]* ) DPDK_RTE_VER=17.02 ; return;;
				[4]* ) DPDK_RTE_VER=17.05 ; return;;
				* ) echo " Invalid selection...";;
			esac
	done
}

step_2()
{
        TITLE="Download and Install"
        CONFIG_NUM=1
        TEXT[1]="Agree to download"
        FUNC[1]="get_agreement_download"
	TEXT[2]="Download packages"
	FUNC[2]="install_libs"
	TEXT[3]="Download DPDK zip"
	FUNC[3]="download_dpdk_zip"
	TEXT[4]="Build and Install DPDK"
	FUNC[4]="install_dpdk"
	TEXT[5]="Setup hugepages"
	FUNC[5]="setup_hugepages"
	TEXT[6]="Download and Build civetweb"
	FUNC[6]="download_civetweb_zip"
}
get_agreement_download()
{
	echo
	echo "List of packages needed for VNFs build and installation:"
	echo "-------------------------------------------------------"
	echo "1. DPDK version $DPDK_RTE_VER"
	echo "2. build-essential"
	echo "3. linux-headers-generic"
	echo "4. git"
	echo "5. unzip"
	echo "6. libpcap-dev"
	echo "7. make"
	echo "8. and other library dependencies"
	while true; do
		read -p "We need download above mentioned package. Press (y/n) to continue? " yn
		case $yn in
			[Yy]* )
				touch .agree
				return;;
			[Nn]* ) exit;;
			* ) "Please answer yes or no.";;
		esac
	done
}

install_libs()
{
	echo "Install libs needed to build and run VNFs..."
	file_name=".agree"
	if [ ! -e "$file_name" ]; then
		echo "Please choose option '2.Agree to download' first"
		return
	fi
	file_name=".download"
	if [ -e "$file_name" ]; then
		clear
		return
	fi
	sudo apt-get update
	sudo apt-get -y install build-essential linux-headers-$(uname -r) git unzip libpcap0.8-dev gcc \
		make libc6 libc6-dev g++-multilib libzmq3-dev libcurl4-openssl-dev net-tools wget gcc unzip \
                libpcap-dev libncurses-dev libedit-dev pciutils liblua5.2-dev libncursesw5-dev libjson-c-dev libssl-dev
	touch .download
}

download_dpdk_zip()
{
	echo "Download DPDK zip"
	file_name=".agree"
	if [ ! -e "$file_name" ]; then
		echo "Please choose option '2.Agree to download' first"
		return
	fi
	DPDK_DOWNLOAD="http://dpdk.org/browse/dpdk/snapshot/dpdk-$DPDK_RTE_VER.zip"
	rm -rf $DPDK_DIR
	if [ ! -e ${DPDK_DOWNLOAD##*/} ] ; then
		wget ${DPDK_DOWNLOAD}
	fi
	unzip -o ${DPDK_DOWNLOAD##*/}
	mv $VNF_CORE/dpdk-$DPDK_RTE_VER $VNF_CORE/dpdk
}

download_civetweb_zip()
{
	echo "Download CIVETWEB zip"
	CIVETWEB_DOWNLOAD="https://sourceforge.net/projects/civetweb/files/1.9/CivetWeb_V1.9.zip"
	if [ ! -e ${CIVETWEB_DOWNLOAD##*/} ] ; then
		wget ${CIVETWEB_DOWNLOAD}
	fi
	unzip -o ${CIVETWEB_DOWNLOAD##*/}
	mv $VNF_CORE/civetweb-master $VNF_CORE/civetweb
	pushd $VNF_CORE/civetweb
	make lib
	popd
}

install_dpdk()
{
	echo "Build DPDK"

	if [ ! -d "$DPDK_DIR" ]; then
     echo "Please choose option '4 Download DPDK zip'"
     return
	fi

	export RTE_TARGET=x86_64-native-linuxapp-gcc

	pushd $DPDK_DIR

	if [ $DPDK_RTE_VER == "16.04" ] ; then
		echo "Apply dpdk custom patches..."
			patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-management.patch
			patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/i40e-fix-Rx-hang-when-disable-LLDP.patch
			patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/i40e-fix-link-status-change-interrupt.patch
			patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/i40e-fix-VF-bonded-device-link-down.patch
			patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/disable-acl-debug-logs.patch
			patch -p1 < $VNF_CORE/patches/dpdk_custom_patch/set-log-level-to-info.patch
	fi

	make -j16 install T=$RTE_TARGET
	if [ $? -ne 0 ] ; then
		echo "Failed to build dpdk, please check the errors."
		return
	fi
	sudo modinfo igb_uio
	if [ $? -ne 0 ] ; then
		sudo $MODPROBE -v uio
		sudo $INSMOD $RTE_TARGET/kmod/igb_uio.ko
		sudo cp -f $RTE_TARGET/kmod/igb_uio.ko /lib/modules/$(uname -r)
		echo "uio" | sudo tee -a /etc/modules
		echo "igb_uio" | sudo tee -a /etc/modules
		sudo depmod
	fi
  if [ -d "dpdk/usertools/" ]; then
	    cp usertools/dpdk-devbind.py /usr/sbin/dpdk-devbind
	else
	    cp tools/dpdk_nic_bind.py /usr/sbin/dpdk-devbind
  fi
	popd
}

setup_hugepages()
{
	#----
	Pages=16
	if [[ "$HUGEPGSZ" = "2048kB" ]] ; then
		Pages=8192
	fi
	if [ ! "`grep nr_hugepages /etc/sysctl.conf`" ] ; then
		echo "vm.nr_hugepages=$Pages" | sudo tee /etc/sysctl.conf
	fi
	sudo sysctl -p

	sudo service procps start

	grep -s '/dev/hugepages' /proc/mounts
	if [ $? -ne 0 ] ; then
		echo "Creating /mnt/huge and mounting as hugetlbfs"
		sudo mkdir -p /mnt/huge
		sudo mount -t hugetlbfs nodev /mnt/huge
		echo "nodev /mnt/huge hugetlbfs defaults 0 0" | sudo tee -a /etc/fstab > /dev/null
        fi
}

step_3()
{
        TITLE="Build VNFs"
        CONFIG_NUM=1
				TEXT[1]="Build all VNFs (vACL, vCGNAPT, vFW, UDP_Replay)"
        FUNC[1]="build_vnfs"
}

build_vnfs()
{

	if [ ! -d "$DPDK_DIR" ]; then
     echo "Please choose option '4 Download DPDK zip'"
     return
	fi

	if [ ! -d "$DPDK_DIR/x86_64-native-linuxapp-gcc" ]; then
     echo "Please choose option '5 Build and Install DPDK'"
     return
	fi

	export RTE_SDK=$DPDK_DIR
	export RTE_TARGET=x86_64-native-linuxapp-gcc
	pushd $VNF_CORE
	make clean
	make || { echo -e "\nVNF: Make failed\n"; }
	popd
}

non_interactive()
{
  #--- Add non intractive option to build vnfs
  if [[ "$1" = "true" ]];then
		  DPDK_VER=("" "16.04" "16.11" "17.02" "17.05")
		  member="$2"
		  for item in "${DPDK_VER[@]}"; do
			   if [[ "$member" == "$item" ]]; then
		      DPDK_RTE_VER="$member"
		    fi
    done
    pushd $VNF_CORE

    echo "Install required libraries..."
    touch .agree
    install_libs

    echo "Download dpdk for VNF build..."
    download_dpdk_zip

    echo "Download civetweb for VNF build..."
    download_civetweb_zip

    echo "Build dpdk..."
    install_dpdk

    echo "Setup hugepages..."
    setup_hugepages

    echo "build VNFS..."
    build_vnfs

    popd
    exit
  fi
}

interactive()
{
  SETUP_PROXY="setup_http_proxy"
  STEPS[1]="step_1"
  STEPS[2]="step_2"
  STEPS[3]="step_3"

  QUIT=0

  while [ "$QUIT" == "0" ]; do
    OPTION_NUM=1
    for s in $(seq ${#STEPS[@]}) ; do
      ${STEPS[s]}

      echo "----------------------------------------------------------"
      echo " Step $s: ${TITLE}"
      echo "----------------------------------------------------------"

      for i in $(seq ${#TEXT[@]}) ; do
              echo "[$OPTION_NUM] ${TEXT[i]}"
              OPTIONS[$OPTION_NUM]=${FUNC[i]}
              let "OPTION_NUM+=1"
      done

      # Clear TEXT and FUNC arrays before next step
      unset TEXT
      unset FUNC

      echo ""
    done

    echo "[$OPTION_NUM] Exit Script"
    OPTIONS[$OPTION_NUM]="quit"
    echo ""
    echo -n "Option: "
    read our_entry
    echo ""
    ${OPTIONS[our_entry]} ${our_entry}

    if [ "$QUIT" == "0" ] ; then
      echo
      echo -n "Press enter to continue ..."; read
      clear
      continue
      exit
    fi
    echo "Installation successfully complete."
  done
}

# -- main script
clear
sudo -n true
if [ $? -ne 0 ]; then
  echo -n "Checking for user permission.. "
  echo "Password-less sudo user must run this script" 1>&2
  exit 1
fi

NON_INTERACTIVE=false
INTERACTIVE=true
DPDK_VERSION=$DPDK_RTE_VER

for i in "$@"
do
case $i in
		-s|--silient)
		NON_INTERACTIVE=true
  INTERACTIVE=false
		;;
		-i|--interactive)
		INTERACTIVE=true
		;;
		-p=*|--proxy=*)
		export http_proxy="${i#*=}"
		export https_proxy="${i#*=}"
		;;
		-d=*|--dpdk=*)
		DPDK_VERSION="${i#*=}"
		;;
		-h|--help)
		echo "CommandLine options:"
		echo "===================="
		echo "1. Intractive mode:"
		echo "./tools/vnf_build.sh or ./tools/vnf_build.sh -i"
		echo
		echo "1. Non-Intractive mode:"
		echo "./tools/vnf_build.sh -s [Default dpdk 17.02]"
		echo "If system is behind proxy use -p=<proxy> and to use different dpdk version use -d=<dpdk>"
		echo "eg: ./tools/vnf_build.sh -s -p=http://proxy.com -d=17.05"
		echo 'Note:- supported dpdk version ("16.04" "16.11" "17.02" "17.05")'
		echo
		exit
		;;
		--default)
		INTERACTIVE=true
		;;
		*)
  ;;
esac
done

if [[ "$INTERACTIVE" == "true" ]]; then
			interactive
			exit
fi

if [[ "$NON_INTERACTIVE" == "true" ]]; then
			non_interactive $NON_INTERACTIVE $DPDK_VERSION
			exit
fi