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
21 MACHINE=$(shell uname -m)
25 define disable_plugins
28 $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
33 MINIMAL_STARTUP_CONF=" \
36 cli-listen /run/vpp/cli.sock \
38 $(if $(wildcard startup.vpp),"exec startup.vpp",) \
40 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",) \
41 $(call disable_plugins,$(DISABLED_PLUGINS)) \
44 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
49 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
50 ifneq ($(shell uname),Darwin)
51 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
52 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
55 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
57 else ifeq ($(filter rhel centos fedora opensuse opensuse-leap opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
61 # +libganglia1-dev if building the gmond plugin
63 DEB_DEPENDS = curl build-essential autoconf automake ccache
64 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
65 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
66 DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
67 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6 check
68 DEB_DEPENDS += libboost-all-dev libffi-dev python-ply libmbedtls-dev
69 ifeq ($(OS_VERSION_ID),14.04)
70 DEB_DEPENDS += openjdk-8-jdk-headless
71 DEB_DEPENDS += libssl-dev
72 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
73 DEB_DEPENDS += openjdk-8-jdk-headless
74 DEB_DEPENDS += libssl-dev
75 APT_ARGS = -t jessie-backports
76 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
77 DEB_DEPENDS += default-jdk-headless
78 DEB_DEPENDS += libssl1.0-dev
80 DEB_DEPENDS += default-jdk-headless
81 DEB_DEPENDS += libssl-dev
84 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
85 RPM_DEPENDS += apr-devel
86 RPM_DEPENDS += numactl-devel
87 RPM_DEPENDS += check check-devel
88 RPM_DEPENDS += boost boost-devel
89 RPM_DEPENDS += selinux-policy selinux-policy-devel
91 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
92 RPM_DEPENDS += subunit subunit-devel
93 RPM_DEPENDS += openssl-devel
94 RPM_DEPENDS += python-devel python2-ply
95 RPM_DEPENDS += python2-virtualenv
96 RPM_DEPENDS += mbedtls-devel
97 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
98 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
99 RPM_DEPENDS += subunit subunit-devel
100 RPM_DEPENDS += compat-openssl10-devel
101 RPM_DEPENDS += python2-devel python2-ply
102 RPM_DEPENDS += python2-virtualenv
103 RPM_DEPENDS += mbedtls-devel
104 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
106 RPM_DEPENDS += openssl-devel
107 RPM_DEPENDS += python-devel python-ply
108 RPM_DEPENDS += python-virtualenv
109 RPM_DEPENDS_GROUPS = 'Development Tools'
112 # +ganglia-devel if building the ganglia plugin
114 RPM_DEPENDS += chrpath libffi-devel rpm-build
116 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
117 SUSE_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
118 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
119 RPM_SUSE_BUILDTOOLS_DEPS += clang indent libtool make python-ply
121 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel
122 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel
124 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
125 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
127 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
129 ifeq ($(OS_ID),opensuse)
130 ifeq ($(SUSE_NAME),Tumbleweed)
131 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
132 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
134 ifeq ($(SUSE_ID),15.0)
135 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
136 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
138 RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
139 RPM_SUSE_PYTHON_DEPS += python-virtualenv
143 ifeq ($(OS_ID),opensuse-leap)
144 ifeq ($(SUSE_ID),15.0)
145 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
146 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
150 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
152 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
153 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
156 ifeq ($(findstring y,$(UNATTENDED)),y)
163 ifneq ($(SAMPLE_PLUGIN),no)
164 TARGETS += sample-plugin
167 .PHONY: help wipe wipe-release build build-release rebuild rebuild-release
168 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
170 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
171 .PHONY: test-cov test-wipe-cov
174 @echo "Make Targets:"
175 @echo " install-dep - install software dependencies"
176 @echo " wipe - wipe all products of debug build "
177 @echo " wipe-release - wipe all products of release build "
178 @echo " build - build debug binaries"
179 @echo " build-release - build release binaries"
180 @echo " build-coverity - build coverity artifacts"
181 @echo " rebuild - wipe and build debug binares"
182 @echo " rebuild-release - wipe and build release binares"
183 @echo " run - run debug binary"
184 @echo " run-release - run release binary"
185 @echo " debug - run debug binary with debugger"
186 @echo " debug-release - run release binary with debugger"
187 @echo " test - build and run (basic) functional tests"
188 @echo " test-debug - build and run (basic) functional tests (debug build)"
189 @echo " test-all - build and run (all) functional tests"
190 @echo " test-all-debug - build and run (all) functional tests (debug build)"
191 @echo " test-ext - build and run 'extras' functional tests"
192 @echo " test-shell - enter shell with test environment"
193 @echo " test-shell-debug - enter shell with test environment (debug build)"
194 @echo " test-wipe - wipe files generated by unit tests"
195 @echo " retest - run functional tests"
196 @echo " retest-debug - run functional tests (debug build)"
197 @echo " test-help - show help on test framework"
198 @echo " run-vat - run vpp-api-test tool"
199 @echo " pkg-deb - build DEB packages"
200 @echo " pkg-rpm - build RPM packages"
201 @echo " dpdk-install-dev - install DPDK development packages"
202 @echo " ctags - (re)generate ctags database"
203 @echo " gtags - (re)generate gtags database"
204 @echo " cscope - (re)generate cscope database"
205 @echo " checkstyle - check coding style"
206 @echo " fixstyle - fix coding style"
207 @echo " doxygen - (re)generate documentation"
208 @echo " bootstrap-doxygen - setup Doxygen dependencies"
209 @echo " wipe-doxygen - wipe all generated documentation"
210 @echo " test-doc - generate documentation for test framework"
211 @echo " test-wipe-doc - wipe documentation for test framework"
212 @echo " test-cov - generate code coverage report for test framework"
213 @echo " test-wipe-cov - wipe code coverage report for test framework"
214 @echo " test-checkstyle - check PEP8 compliance for test framework"
216 @echo "Make Arguments:"
217 @echo " V=[0|1] - set build verbosity level"
218 @echo " STARTUP_CONF=<path> - startup configuration file"
219 @echo " (e.g. /etc/vpp/startup.conf)"
220 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
221 @echo " It also sets STARTUP_CONF if"
222 @echo " startup.conf file is present"
223 @echo " GDB=<path> - gdb binary to use for debugging"
224 @echo " PLATFORM=<name> - target platform. default is vpp"
225 @echo " TEST=<filter> - apply filter to test set, see test-help"
226 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
227 @echo " autogenerated startup.conf"
228 @echo " (e.g. \"no-pci\" )"
229 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
230 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
231 @echo " should not be loaded"
233 @echo "Current Argument Values:"
235 @echo " STARTUP_CONF = $(STARTUP_CONF)"
236 @echo " STARTUP_DIR = $(STARTUP_DIR)"
237 @echo " GDB = $(GDB)"
238 @echo " PLATFORM = $(PLATFORM)"
239 @echo " DPDK_VERSION = $(DPDK_VERSION)"
240 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
241 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
242 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
245 ifeq ($(findstring y,$(UNATTENDED)),y)
248 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
249 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
250 if [ -n "$$MISSING" ] ; then \
251 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
252 echo "by executing \"make install-dep\"\n" ; \
256 else ifneq ("$(wildcard /etc/redhat-release)","")
257 @for i in $(RPM_DEPENDS) ; do \
258 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
259 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
261 if [ -n "$$MISSING" ] ; then \
262 echo "Please install missing RPMs: \n$$MISSING\n" ; \
263 echo "by executing \"make install-dep\"\n" ; \
271 @echo "'make bootstrap' is not needed anymore"
274 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
275 ifeq ($(OS_VERSION_ID),14.04)
276 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
277 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
279 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
280 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
281 || ( echo "Please install jessie-backports" ; exit 1 )
283 @sudo -E apt-get update
284 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
285 else ifneq ("$(wildcard /etc/redhat-release)","")
286 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
287 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
288 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
289 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
290 @sudo -E zypper refresh
291 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
292 else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
293 @sudo -E zypper refresh
294 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
296 $(error "This option currently works only on Ubuntu, Debian, Centos or openSUSE systems")
300 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
303 $(BR)/scripts/.version:
304 ifneq ("$(wildcard /etc/redhat-release)","")
305 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
307 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
310 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
311 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
314 @if git rev-parse 2> /dev/null ; then \
316 --prefix=$(DIST_SUBDIR)/ \
320 git describe > $(BR)/.version ; \
322 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
323 src/scripts/version > $(BR)/.version ; \
326 --file $(DIST_FILE) \
327 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
329 @$(RM) $(BR)/.version $(DIST_FILE).xz
330 @xz -v --threads=0 $(DIST_FILE)
331 @$(RM) $(BR)/vpp-latest.tar.xz
332 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
334 build: $(BR)/.deps.ok
335 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
338 @$(RM) $(BR)/*.tar.xz
340 wipe: wipedist test-wipe $(BR)/.deps.ok
341 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
345 build-release: $(BR)/.deps.ok
346 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
348 wipe-release: test-wipe $(BR)/.deps.ok
349 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
351 rebuild-release: wipe-release build-release
353 export VPP_PYTHON_PREFIX ?= $(BR)/python
355 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
358 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
359 $(eval libs:=lib lib64)
361 TEST_DIR=$(WS_ROOT)/test \
362 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
363 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
364 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
365 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
366 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
367 EXTENDED_TESTS=$(EXTENDED_TESTS) \
370 CACHE_OUTPUT=$(CACHE_OUTPUT) \
375 $(call test,vpp,vpp,test)
378 $(call test,vpp,vpp_debug,test)
381 $(eval EXTENDED_TESTS=yes)
382 $(call test,vpp,vpp,test)
385 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install,)
386 $(eval EXTENDED_TESTS=yes)
387 $(call test,vpp,vpp_debug,test-ext)
390 $(eval EXTENDED_TESTS=yes)
391 $(call test,vpp,vpp_debug,test)
400 $(call test,vpp,vpp,shell)
403 $(call test,vpp,vpp_debug,shell)
406 @make -C test test-dep
412 @make -C test wipe-doc
415 $(eval EXTENDED_TESTS=yes)
416 $(call test,vpp,vpp_gcov,cov)
419 @make -C test wipe-cov
422 @make -C test checkstyle
425 $(call test,vpp,vpp,retest)
428 $(call test,vpp,vpp_debug,retest)
430 ifeq ("$(wildcard $(STARTUP_CONF))","")
432 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
433 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
434 @cd $(STARTUP_DIR) && \
435 $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
439 @cd $(STARTUP_DIR) && \
440 $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
445 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
446 \( -not -path './build-root*' -o -path \
447 './build-root/build-vpp_debug-native/dpdk*' \) > $@
452 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
455 $(call run, $(BR)/install-$(PLATFORM)-native)
458 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
461 $(call make,$(PLATFORM)_coverity,install-packages)
464 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
467 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
470 @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
473 $(call make,$(PLATFORM),install-deb)
479 make -C extras/rpm srpm
482 make -C dpdk install-$(PKG)
485 @ctags --totals --tag-relative -L $<
489 @gtags --gtagslabel=ctags
495 @build-root/scripts/checkstyle.sh
498 @build-root/scripts/checkstyle.sh --fix
501 # Build the documentation
504 # Doxygen configuration and our utility scripts
505 export DOXY_DIR ?= $(WS_ROOT)/doxygen
508 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
511 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
523 @echo "========================================================================"
525 @echo "========================================================================"
529 verify: install-dep $(BR)/.deps.ok dpdk-install-dev
530 $(call banner,"Building for PLATFORM=vpp using gcc")
531 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
532 $(call banner,"Building sample-plugin")
533 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
534 $(call banner,"Building libmemif")
535 @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
536 $(call banner,"Building VOM")
537 @make -C build-root PLATFORM=vpp TAG=vpp vom-install
538 $(call banner,"Building $(PKG) packages")
540 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
541 @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test