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)
24 ifeq ($(findstring $(MAKECMDGOALS),verify pkg-deb pkg-rpm test),)
25 export vpp_uses_cmake?=yes
29 define disable_plugins
32 $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
37 MINIMAL_STARTUP_CONF=" \
40 cli-listen /run/vpp/cli.sock \
42 $(if $(wildcard startup.vpp),"exec startup.vpp",) \
44 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",) \
45 $(call disable_plugins,$(DISABLED_PLUGINS)) \
48 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
53 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
54 ifneq ($(shell uname),Darwin)
55 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
56 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
59 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
61 else ifeq ($(filter rhel centos fedora opensuse opensuse-leap opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
65 # +libganglia1-dev if building the gmond plugin
67 DEB_DEPENDS = curl build-essential autoconf automake ccache
68 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
69 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
70 DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
71 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6 check
72 DEB_DEPENDS += libboost-all-dev libffi-dev python-ply libmbedtls-dev
73 DEB_DEPENDS += cmake ninja-build
74 ifeq ($(OS_VERSION_ID),14.04)
75 DEB_DEPENDS += openjdk-8-jdk-headless
76 DEB_DEPENDS += libssl-dev
77 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
78 DEB_DEPENDS += openjdk-8-jdk-headless
79 DEB_DEPENDS += libssl-dev
80 APT_ARGS = -t jessie-backports
81 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
82 DEB_DEPENDS += default-jdk-headless
83 DEB_DEPENDS += libssl1.0-dev
85 DEB_DEPENDS += default-jdk-headless
86 DEB_DEPENDS += libssl-dev
89 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
90 RPM_DEPENDS += apr-devel
91 RPM_DEPENDS += numactl-devel
92 RPM_DEPENDS += check check-devel
93 RPM_DEPENDS += boost boost-devel
94 RPM_DEPENDS += selinux-policy selinux-policy-devel
96 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
97 RPM_DEPENDS += subunit subunit-devel
98 RPM_DEPENDS += openssl-devel
99 RPM_DEPENDS += python-devel python2-ply
100 RPM_DEPENDS += python2-virtualenv
101 RPM_DEPENDS += mbedtls-devel
102 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
103 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
104 RPM_DEPENDS += subunit subunit-devel
105 RPM_DEPENDS += compat-openssl10-devel
106 RPM_DEPENDS += python2-devel python2-ply
107 RPM_DEPENDS += python2-virtualenv
108 RPM_DEPENDS += mbedtls-devel
109 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
111 RPM_DEPENDS += openssl-devel
112 RPM_DEPENDS += python-devel python-ply
113 RPM_DEPENDS += python-virtualenv
114 RPM_DEPENDS_GROUPS = 'Development Tools'
117 # +ganglia-devel if building the ganglia plugin
119 RPM_DEPENDS += chrpath libffi-devel rpm-build
121 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
122 SUSE_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
123 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
124 RPM_SUSE_BUILDTOOLS_DEPS += clang cmake indent libtool make ninja python-ply
126 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel
127 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel
129 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
130 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
132 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
134 ifeq ($(OS_ID),opensuse)
135 ifeq ($(SUSE_NAME),Tumbleweed)
136 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
137 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
139 ifeq ($(SUSE_ID),15.0)
140 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
141 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
143 RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
144 RPM_SUSE_PYTHON_DEPS += python-virtualenv
148 ifeq ($(OS_ID),opensuse-leap)
149 ifeq ($(SUSE_ID),15.0)
150 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
151 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
155 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
157 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
158 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
161 ifeq ($(findstring y,$(UNATTENDED)),y)
168 ifneq ($(SAMPLE_PLUGIN),no)
169 TARGETS += sample-plugin
172 .PHONY: help wipe wipe-release build build-release rebuild rebuild-release
173 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
175 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
176 .PHONY: test-cov test-wipe-cov
179 @echo "Make Targets:"
180 @echo " install-dep - install software dependencies"
181 @echo " wipe - wipe all products of debug build "
182 @echo " wipe-release - wipe all products of release build "
183 @echo " build - build debug binaries"
184 @echo " build-release - build release binaries"
185 @echo " build-coverity - build coverity artifacts"
186 @echo " rebuild - wipe and build debug binares"
187 @echo " rebuild-release - wipe and build release binares"
188 @echo " run - run debug binary"
189 @echo " run-release - run release binary"
190 @echo " debug - run debug binary with debugger"
191 @echo " debug-release - run release binary with debugger"
192 @echo " test - build and run (basic) functional tests"
193 @echo " test-debug - build and run (basic) functional tests (debug build)"
194 @echo " test-all - build and run (all) functional tests"
195 @echo " test-all-debug - build and run (all) functional tests (debug build)"
196 @echo " test-ext - build and run 'extras' functional tests"
197 @echo " test-shell - enter shell with test environment"
198 @echo " test-shell-debug - enter shell with test environment (debug build)"
199 @echo " test-wipe - wipe files generated by unit tests"
200 @echo " retest - run functional tests"
201 @echo " retest-debug - run functional tests (debug build)"
202 @echo " test-help - show help on test framework"
203 @echo " run-vat - run vpp-api-test tool"
204 @echo " pkg-deb - build DEB packages"
205 @echo " pkg-rpm - build RPM packages"
206 @echo " dpdk-install-dev - install DPDK development packages"
207 @echo " ctags - (re)generate ctags database"
208 @echo " gtags - (re)generate gtags database"
209 @echo " cscope - (re)generate cscope database"
210 @echo " checkstyle - check coding style"
211 @echo " fixstyle - fix coding style"
212 @echo " doxygen - (re)generate documentation"
213 @echo " bootstrap-doxygen - setup Doxygen dependencies"
214 @echo " wipe-doxygen - wipe all generated documentation"
215 @echo " test-doc - generate documentation for test framework"
216 @echo " test-wipe-doc - wipe documentation for test framework"
217 @echo " test-cov - generate code coverage report for test framework"
218 @echo " test-wipe-cov - wipe code coverage report for test framework"
219 @echo " test-checkstyle - check PEP8 compliance for test framework"
221 @echo "Make Arguments:"
222 @echo " V=[0|1] - set build verbosity level"
223 @echo " STARTUP_CONF=<path> - startup configuration file"
224 @echo " (e.g. /etc/vpp/startup.conf)"
225 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
226 @echo " It also sets STARTUP_CONF if"
227 @echo " startup.conf file is present"
228 @echo " GDB=<path> - gdb binary to use for debugging"
229 @echo " PLATFORM=<name> - target platform. default is vpp"
230 @echo " TEST=<filter> - apply filter to test set, see test-help"
231 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
232 @echo " autogenerated startup.conf"
233 @echo " (e.g. \"no-pci\" )"
234 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
235 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
236 @echo " should not be loaded"
238 @echo "Current Argument Values:"
240 @echo " STARTUP_CONF = $(STARTUP_CONF)"
241 @echo " STARTUP_DIR = $(STARTUP_DIR)"
242 @echo " GDB = $(GDB)"
243 @echo " PLATFORM = $(PLATFORM)"
244 @echo " DPDK_VERSION = $(DPDK_VERSION)"
245 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
246 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
247 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
250 ifeq ($(findstring y,$(UNATTENDED)),y)
253 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
254 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
255 if [ -n "$$MISSING" ] ; then \
256 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
257 echo "by executing \"make install-dep\"\n" ; \
261 else ifneq ("$(wildcard /etc/redhat-release)","")
262 @for i in $(RPM_DEPENDS) ; do \
263 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
264 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
266 if [ -n "$$MISSING" ] ; then \
267 echo "Please install missing RPMs: \n$$MISSING\n" ; \
268 echo "by executing \"make install-dep\"\n" ; \
276 @echo "'make bootstrap' is not needed anymore"
279 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
280 ifeq ($(OS_VERSION_ID),14.04)
281 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
282 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
284 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
285 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
286 || ( echo "Please install jessie-backports" ; exit 1 )
288 @sudo -E apt-get update
289 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
290 else ifneq ("$(wildcard /etc/redhat-release)","")
291 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
292 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
293 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
294 else ifeq ($(filter opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
295 @sudo -E zypper refresh
296 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
297 else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
298 @sudo -E zypper refresh
299 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
300 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
301 @sudo -E zypper refresh
302 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
304 $(error "This option currently works only on Ubuntu, Debian, Centos or openSUSE systems")
308 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
311 $(BR)/scripts/.version:
312 ifneq ("$(wildcard /etc/redhat-release)","")
313 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
315 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
318 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
319 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
322 @if git rev-parse 2> /dev/null ; then \
324 --prefix=$(DIST_SUBDIR)/ \
328 git describe > $(BR)/.version ; \
330 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
331 src/scripts/version > $(BR)/.version ; \
334 --file $(DIST_FILE) \
335 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
337 @$(RM) $(BR)/.version $(DIST_FILE).xz
338 @xz -v --threads=0 $(DIST_FILE)
339 @$(RM) $(BR)/vpp-latest.tar.xz
340 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
342 build: $(BR)/.deps.ok
343 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
346 @$(RM) $(BR)/*.tar.xz
348 wipe: wipedist test-wipe $(BR)/.deps.ok
349 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
353 build-release: $(BR)/.deps.ok
354 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
356 wipe-release: test-wipe $(BR)/.deps.ok
357 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
359 rebuild-release: wipe-release build-release
361 export VPP_PYTHON_PREFIX ?= $(BR)/python
363 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
366 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
367 $(eval libs:=lib lib64)
369 TEST_DIR=$(WS_ROOT)/test \
370 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
371 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
372 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
373 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
374 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
375 EXTENDED_TESTS=$(EXTENDED_TESTS) \
378 CACHE_OUTPUT=$(CACHE_OUTPUT) \
383 $(call test,vpp,vpp,test)
386 $(call test,vpp,vpp_debug,test)
389 $(eval EXTENDED_TESTS=yes)
390 $(call test,vpp,vpp,test)
393 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install japi-install,)
394 $(eval EXTENDED_TESTS=yes)
395 $(call test,vpp,vpp_debug,test-ext)
398 $(eval EXTENDED_TESTS=yes)
399 $(call test,vpp,vpp_debug,test)
408 $(call test,vpp,vpp,shell)
411 $(call test,vpp,vpp_debug,shell)
414 @make -C test test-dep
420 @make -C test wipe-doc
423 $(eval EXTENDED_TESTS=yes)
424 $(call test,vpp,vpp_gcov,cov)
427 @make -C test wipe-cov
430 @make -C test checkstyle
433 $(call test,vpp,vpp,retest)
436 $(call test,vpp,vpp_debug,retest)
438 ifeq ("$(wildcard $(STARTUP_CONF))","")
440 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
441 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
442 @cd $(STARTUP_DIR) && \
443 $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
447 @cd $(STARTUP_DIR) && \
448 $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
453 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
454 \( -not -path './build-root*' -o -path \
455 './build-root/build-vpp_debug-native/dpdk*' \) > $@
460 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
463 $(call run, $(BR)/install-$(PLATFORM)-native)
466 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
469 $(call make,$(PLATFORM)_coverity,install-packages)
472 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
475 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
478 @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
481 $(call make,$(PLATFORM),install-deb)
487 make -C extras/rpm srpm
490 make -C dpdk install-$(PKG)
493 @ctags --totals --tag-relative -L $<
497 @gtags --gtagslabel=ctags
503 @build-root/scripts/checkstyle.sh
506 @build-root/scripts/checkstyle.sh --fix
509 # Build the documentation
512 # Doxygen configuration and our utility scripts
513 export DOXY_DIR ?= $(WS_ROOT)/doxygen
516 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
519 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
531 @echo "========================================================================"
533 @echo "========================================================================"
537 verify: install-dep $(BR)/.deps.ok dpdk-install-dev
538 $(call banner,"Building for PLATFORM=vpp using gcc")
539 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
540 $(call banner,"Building sample-plugin")
541 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
542 $(call banner,"Building libmemif")
543 @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
544 $(call banner,"Building JAPI")
545 @make -C build-root PLATFORM=vpp TAG=vpp japi-install
546 $(call banner,"Building VOM")
547 @make -C build-root PLATFORM=vpp TAG=vpp vom-install
548 $(call banner,"Building $(PKG) packages")
550 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
551 @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test