1 # Copyright (c) 2016 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 export WS_ROOT=$(CURDIR)
15 export BR=$(WS_ROOT)/build-root
16 CCACHE_DIR?=$(BR)/.ccache
20 MACHINE=$(shell uname -m)
23 define disable_plugins
26 $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
31 MINIMAL_STARTUP_CONF=" \
34 cli-listen /run/vpp/cli.sock \
36 $(if $(wildcard startup.vpp),"exec startup.vpp",) \
38 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",) \
39 $(call disable_plugins,$(DISABLED_PLUGINS)) \
42 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
47 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
48 ifneq ($(shell uname),Darwin)
49 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
50 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
53 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
55 else ifeq ($(filter rhel centos fedora opensuse,$(OS_ID)),$(OS_ID))
59 # +libganglia1-dev if building the gmond plugin
61 DEB_DEPENDS = curl build-essential autoconf automake bison ccache
62 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
63 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
64 DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
65 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6 check
66 DEB_DEPENDS += libboost-all-dev
67 ifeq ($(OS_VERSION_ID),14.04)
68 DEB_DEPENDS += openjdk-8-jdk-headless
69 DEB_DEPENDS += libssl-dev
70 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
71 DEB_DEPENDS += openjdk-8-jdk-headless
72 DEB_DEPENDS += libssl-dev
73 APT_ARGS = -t jessie-backports
74 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
75 DEB_DEPENDS += default-jdk-headless
76 DEB_DEPENDS += libssl1.0-dev
78 DEB_DEPENDS += default-jdk-headless
79 DEB_DEPENDS += libssl-dev
82 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
83 RPM_DEPENDS += apr-devel
84 RPM_DEPENDS += numactl-devel
85 RPM_DEPENDS += check check-devel
86 RPM_DEPENDS += boost boost-devel
88 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
89 RPM_DEPENDS += subunit subunit-devel
90 RPM_DEPENDS += openssl-devel
91 RPM_DEPENDS += python-devel
92 RPM_DEPENDS += python2-virtualenv
93 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
94 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
95 RPM_DEPENDS += subunit subunit-devel
96 RPM_DEPENDS += compat-openssl10-devel
97 RPM_DEPENDS += python2-devel
98 RPM_DEPENDS += python2-virtualenv
99 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
101 RPM_DEPENDS += openssl-devel
102 RPM_DEPENDS += python-devel
103 RPM_DEPENDS += python-virtualenv
104 RPM_DEPENDS_GROUPS = 'Development Tools'
107 # +ganglia-devel if building the ganglia plugin
109 RPM_DEPENDS += chrpath libffi-devel rpm-build
111 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
112 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake bison ccache check-devel chrpath clang indent libtool make
113 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel libopenssl-devel openssl-devel
114 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip python-rpm-macros python3-rpm-macros
115 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
117 ifeq ($(OS_ID),opensuse)
118 ifneq ($(SUSE_NAME),Tumbleweed)
119 RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
120 RPM_SUSE_PYTHON_DEPS += python-virtualenv
122 RPM_SUSE_DEVEL_DEPS += boost_1_65-devel gcc
123 RPM_SUSE_PYTHON_DEPS += python2-virtualenv
127 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
129 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
130 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
133 ifeq ($(findstring y,$(UNATTENDED)),y)
140 ifneq ($(SAMPLE_PLUGIN),no)
141 TARGETS += sample-plugin
144 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
145 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
147 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
148 .PHONY: test-cov test-wipe-cov
151 @echo "Make Targets:"
152 @echo " bootstrap - prepare tree for build"
153 @echo " install-dep - install software dependencies"
154 @echo " wipe - wipe all products of debug build "
155 @echo " wipe-release - wipe all products of release build "
156 @echo " build - build debug binaries"
157 @echo " build-release - build release binaries"
158 @echo " build-coverity - build coverity artifacts"
159 @echo " rebuild - wipe and build debug binares"
160 @echo " rebuild-release - wipe and build release binares"
161 @echo " run - run debug binary"
162 @echo " run-release - run release binary"
163 @echo " debug - run debug binary with debugger"
164 @echo " debug-release - run release binary with debugger"
165 @echo " test - build and run (basic) functional tests"
166 @echo " test-debug - build and run (basic) functional tests (debug build)"
167 @echo " test-all - build and run (all) functional tests"
168 @echo " test-all-debug - build and run (all) functional tests (debug build)"
169 @echo " test-shell - enter shell with test environment"
170 @echo " test-shell-debug - enter shell with test environment (debug build)"
171 @echo " test-wipe - wipe files generated by unit tests"
172 @echo " retest - run functional tests"
173 @echo " retest-debug - run functional tests (debug build)"
174 @echo " test-help - show help on test framework"
175 @echo " run-vat - run vpp-api-test tool"
176 @echo " pkg-deb - build DEB packages"
177 @echo " pkg-rpm - build RPM packages"
178 @echo " dpdk-install-dev - install DPDK development packages"
179 @echo " ctags - (re)generate ctags database"
180 @echo " gtags - (re)generate gtags database"
181 @echo " cscope - (re)generate cscope database"
182 @echo " checkstyle - check coding style"
183 @echo " fixstyle - fix coding style"
184 @echo " doxygen - (re)generate documentation"
185 @echo " bootstrap-doxygen - setup Doxygen dependencies"
186 @echo " wipe-doxygen - wipe all generated documentation"
187 @echo " test-doc - generate documentation for test framework"
188 @echo " test-wipe-doc - wipe documentation for test framework"
189 @echo " test-cov - generate code coverage report for test framework"
190 @echo " test-wipe-cov - wipe code coverage report for test framework"
191 @echo " test-checkstyle - check PEP8 compliance for test framework"
193 @echo "Make Arguments:"
194 @echo " V=[0|1] - set build verbosity level"
195 @echo " STARTUP_CONF=<path> - startup configuration file"
196 @echo " (e.g. /etc/vpp/startup.conf)"
197 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
198 @echo " It also sets STARTUP_CONF if"
199 @echo " startup.conf file is present"
200 @echo " GDB=<path> - gdb binary to use for debugging"
201 @echo " PLATFORM=<name> - target platform. default is vpp"
202 @echo " TEST=<filter> - apply filter to test set, see test-help"
203 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
204 @echo " autogenerated startup.conf"
205 @echo " (e.g. \"no-pci\" )"
206 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
207 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
208 @echo " should not be loaded"
210 @echo "Current Argument Values:"
212 @echo " STARTUP_CONF = $(STARTUP_CONF)"
213 @echo " STARTUP_DIR = $(STARTUP_DIR)"
214 @echo " GDB = $(GDB)"
215 @echo " PLATFORM = $(PLATFORM)"
216 @echo " DPDK_VERSION = $(DPDK_VERSION)"
217 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
218 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
219 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
222 ifeq ($(findstring y,$(UNATTENDED)),y)
225 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
226 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
227 if [ -n "$$MISSING" ] ; then \
228 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
229 echo "by executing \"make install-dep\"\n" ; \
233 else ifneq ("$(wildcard /etc/redhat-release)","")
234 @for i in $(RPM_DEPENDS) ; do \
235 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
236 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
238 if [ -n "$$MISSING" ] ; then \
239 echo "Please install missing RPMs: \n$$MISSING\n" ; \
240 echo "by executing \"make install-dep\"\n" ; \
245 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
246 @echo "#!/bin/bash\n" > $(BR)/path_setup
247 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
248 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
249 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
251 ifeq ("$(wildcard /usr/bin/ccache )","")
252 @echo "WARNING: Please install ccache AYEC and re-run this script"
254 @rm -rf $(BR)/tools/ccache-bin
255 @mkdir -p $(BR)/tools/ccache-bin
256 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
257 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
259 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
262 bootstrap: $(BR)/.bootstrap.ok
265 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
266 ifeq ($(OS_VERSION_ID),14.04)
267 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
268 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
270 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
271 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
272 || ( echo "Please install jessie-backports" ; exit 1 )
274 @sudo -E apt-get update
275 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
276 else ifneq ("$(wildcard /etc/redhat-release)","")
277 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
278 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
279 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
280 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
281 @sudo -E zypper refresh
282 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
284 $(error "This option currently works only on Ubuntu, Debian, Centos or openSUSE systems")
288 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
291 $(BR)/scripts/.version:
292 ifneq ("$(wildcard /etc/redhat-release)","")
293 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
295 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
298 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
299 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
302 @if git rev-parse 2> /dev/null ; then \
304 --prefix=$(DIST_SUBDIR)/ \
308 git describe > $(BR)/.version ; \
310 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
311 src/scripts/version > $(BR)/.version ; \
314 --file $(DIST_FILE) \
315 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
317 @$(RM) $(BR)/.version $(DIST_FILE).xz
318 @xz -v --threads=0 $(DIST_FILE)
319 @$(RM) $(BR)/vpp-latest.tar.xz
320 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
322 build: $(BR)/.bootstrap.ok
323 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
326 @$(RM) $(BR)/*.tar.xz
328 wipe: wipedist $(BR)/.bootstrap.ok
329 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
333 build-release: $(BR)/.bootstrap.ok
334 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
336 wipe-release: $(BR)/.bootstrap.ok
337 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
339 rebuild-release: wipe-release build-release
341 export VPP_PYTHON_PREFIX=$(BR)/python
343 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
346 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
347 $(eval libs:=lib lib64)
349 TEST_DIR=$(WS_ROOT)/test \
350 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
351 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
352 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
353 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
354 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
355 EXTENDED_TESTS=$(EXTENDED_TESTS) \
358 CACHE_OUTPUT=$(CACHE_OUTPUT) \
363 $(call test,vpp,vpp,test)
365 test-debug: bootstrap
366 $(call test,vpp,vpp_debug,test)
369 $(eval EXTENDED_TESTS=yes)
370 $(call test,vpp,vpp,test)
372 test-all-debug: bootstrap
373 $(eval EXTENDED_TESTS=yes)
374 $(call test,vpp,vpp_debug,test)
382 test-shell: bootstrap
383 $(call test,vpp,vpp,shell)
385 test-shell-debug: bootstrap
386 $(call test,vpp,vpp_debug,shell)
392 @make -C test wipe-doc
395 $(eval EXTENDED_TESTS=yes)
396 $(call test,vpp,vpp_gcov,cov)
399 @make -C test wipe-cov
402 @make -C test checkstyle
405 $(call test,vpp,vpp,retest)
408 $(call test,vpp,vpp_debug,retest)
410 STARTUP_DIR ?= $(PWD)
411 ifeq ("$(wildcard $(STARTUP_CONF))","")
413 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
414 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
415 @cd $(STARTUP_DIR) && \
416 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) \
417 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
421 @cd $(STARTUP_DIR) && \
422 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') \
423 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
428 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
429 \( -not -path './build-root*' -o -path \
430 './build-root/build-vpp_debug-native/dpdk*' \) > $@
435 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
438 $(call run, $(BR)/install-$(PLATFORM)-native)
441 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
444 $(call make,$(PLATFORM)_coverity,install-packages)
447 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
450 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
453 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
456 $(call make,$(PLATFORM),install-deb)
462 make -C extras/rpm srpm
465 make -C dpdk install-$(PKG)
468 @ctags --totals --tag-relative -L $<
472 @gtags --gtagslabel=ctags
478 @build-root/scripts/checkstyle.sh
481 @build-root/scripts/checkstyle.sh --fix
484 # Build the documentation
487 # Doxygen configuration and our utility scripts
488 export DOXY_DIR ?= $(WS_ROOT)/doxygen
491 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
494 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
506 @echo "========================================================================"
508 @echo "========================================================================"
512 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
513 $(call banner,"Building for PLATFORM=vpp using gcc")
514 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
515 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
516 $(call banner,"Installing dependencies")
517 @sudo -E apt-get update
518 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
519 $(call banner,"Building for PLATFORM=vpp using clang")
520 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
522 $(call banner,"Building sample-plugin")
523 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
524 $(call banner,"Building $(PKG) packages")
526 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
527 @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test