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)
24 define disable_plugins
27 $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
32 MINIMAL_STARTUP_CONF=" \
35 cli-listen /run/vpp/cli.sock \
37 $(if $(wildcard startup.vpp),"exec startup.vpp",) \
39 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",) \
40 $(call disable_plugins,$(DISABLED_PLUGINS)) \
43 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
48 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
49 ifneq ($(shell uname),Darwin)
50 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
51 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
54 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
56 else ifeq ($(filter rhel centos fedora opensuse opensuse-leap opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
60 # +libganglia1-dev if building the gmond plugin
62 DEB_DEPENDS = curl build-essential autoconf automake ccache
63 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
64 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
65 DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
66 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6 check
67 DEB_DEPENDS += libboost-all-dev libffi-dev python-ply libmbedtls-dev
68 ifeq ($(OS_VERSION_ID),14.04)
69 DEB_DEPENDS += openjdk-8-jdk-headless
70 DEB_DEPENDS += libssl-dev
71 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
72 DEB_DEPENDS += openjdk-8-jdk-headless
73 DEB_DEPENDS += libssl-dev
74 APT_ARGS = -t jessie-backports
75 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
76 DEB_DEPENDS += default-jdk-headless
77 DEB_DEPENDS += libssl1.0-dev
79 DEB_DEPENDS += default-jdk-headless
80 DEB_DEPENDS += libssl-dev
83 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
84 RPM_DEPENDS += apr-devel
85 RPM_DEPENDS += numactl-devel
86 RPM_DEPENDS += check check-devel
87 RPM_DEPENDS += boost boost-devel
88 RPM_DEPENDS += selinux-policy selinux-policy-devel
90 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
91 RPM_DEPENDS += subunit subunit-devel
92 RPM_DEPENDS += openssl-devel
93 RPM_DEPENDS += python-devel python2-ply
94 RPM_DEPENDS += python2-virtualenv
95 RPM_DEPENDS += mbedtls-devel
96 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
97 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
98 RPM_DEPENDS += subunit subunit-devel
99 RPM_DEPENDS += compat-openssl10-devel
100 RPM_DEPENDS += python2-devel python2-ply
101 RPM_DEPENDS += python2-virtualenv
102 RPM_DEPENDS += mbedtls-devel
103 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
105 RPM_DEPENDS += openssl-devel
106 RPM_DEPENDS += python-devel python-ply
107 RPM_DEPENDS += python-virtualenv
108 RPM_DEPENDS_GROUPS = 'Development Tools'
111 # +ganglia-devel if building the ganglia plugin
113 RPM_DEPENDS += chrpath libffi-devel rpm-build
115 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
116 SUSE_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
117 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
118 RPM_SUSE_BUILDTOOLS_DEPS += clang indent libtool make python-ply
120 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel
121 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel
123 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
124 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
126 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
128 ifeq ($(OS_ID),opensuse)
129 ifeq ($(SUSE_NAME),Tumbleweed)
130 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
131 RPM_SUSE_PYTHON_DEPS += python2-virtualenv
133 ifeq ($(SUSE_ID),15.0)
134 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
135 RPM_SUSE_PYTHON_DEPS += python2-virtualenv
137 RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
138 RPM_SUSE_PYTHON_DEPS += python-virtualenv
142 ifeq ($(OS_ID),opensuse-leap)
143 ifeq ($(SUSE_ID),15.0)
144 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
145 RPM_SUSE_PYTHON_DEPS += python2-virtualenv
149 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
151 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
152 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
155 ifeq ($(findstring y,$(UNATTENDED)),y)
162 ifneq ($(SAMPLE_PLUGIN),no)
163 TARGETS += sample-plugin
166 .PHONY: help wipe wipe-release build build-release rebuild rebuild-release
167 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
169 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
170 .PHONY: test-cov test-wipe-cov
173 @echo "Make Targets:"
174 @echo " install-dep - install software dependencies"
175 @echo " wipe - wipe all products of debug build "
176 @echo " wipe-release - wipe all products of release build "
177 @echo " build - build debug binaries"
178 @echo " build-release - build release binaries"
179 @echo " build-coverity - build coverity artifacts"
180 @echo " rebuild - wipe and build debug binares"
181 @echo " rebuild-release - wipe and build release binares"
182 @echo " run - run debug binary"
183 @echo " run-release - run release binary"
184 @echo " debug - run debug binary with debugger"
185 @echo " debug-release - run release binary with debugger"
186 @echo " test - build and run (basic) functional tests"
187 @echo " test-debug - build and run (basic) functional tests (debug build)"
188 @echo " test-all - build and run (all) functional tests"
189 @echo " test-all-debug - build and run (all) functional tests (debug build)"
190 @echo " test-shell - enter shell with test environment"
191 @echo " test-shell-debug - enter shell with test environment (debug build)"
192 @echo " test-wipe - wipe files generated by unit tests"
193 @echo " retest - run functional tests"
194 @echo " retest-debug - run functional tests (debug build)"
195 @echo " test-help - show help on test framework"
196 @echo " run-vat - run vpp-api-test tool"
197 @echo " pkg-deb - build DEB packages"
198 @echo " pkg-rpm - build RPM packages"
199 @echo " dpdk-install-dev - install DPDK development packages"
200 @echo " ctags - (re)generate ctags database"
201 @echo " gtags - (re)generate gtags database"
202 @echo " cscope - (re)generate cscope database"
203 @echo " checkstyle - check coding style"
204 @echo " fixstyle - fix coding style"
205 @echo " doxygen - (re)generate documentation"
206 @echo " bootstrap-doxygen - setup Doxygen dependencies"
207 @echo " wipe-doxygen - wipe all generated documentation"
208 @echo " test-doc - generate documentation for test framework"
209 @echo " test-wipe-doc - wipe documentation for test framework"
210 @echo " test-cov - generate code coverage report for test framework"
211 @echo " test-wipe-cov - wipe code coverage report for test framework"
212 @echo " test-checkstyle - check PEP8 compliance for test framework"
214 @echo "Make Arguments:"
215 @echo " V=[0|1] - set build verbosity level"
216 @echo " STARTUP_CONF=<path> - startup configuration file"
217 @echo " (e.g. /etc/vpp/startup.conf)"
218 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
219 @echo " It also sets STARTUP_CONF if"
220 @echo " startup.conf file is present"
221 @echo " GDB=<path> - gdb binary to use for debugging"
222 @echo " PLATFORM=<name> - target platform. default is vpp"
223 @echo " TEST=<filter> - apply filter to test set, see test-help"
224 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
225 @echo " autogenerated startup.conf"
226 @echo " (e.g. \"no-pci\" )"
227 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
228 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
229 @echo " should not be loaded"
231 @echo "Current Argument Values:"
233 @echo " STARTUP_CONF = $(STARTUP_CONF)"
234 @echo " STARTUP_DIR = $(STARTUP_DIR)"
235 @echo " GDB = $(GDB)"
236 @echo " PLATFORM = $(PLATFORM)"
237 @echo " DPDK_VERSION = $(DPDK_VERSION)"
238 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
239 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
240 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
243 ifeq ($(findstring y,$(UNATTENDED)),y)
246 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
247 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
248 if [ -n "$$MISSING" ] ; then \
249 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
250 echo "by executing \"make install-dep\"\n" ; \
254 else ifneq ("$(wildcard /etc/redhat-release)","")
255 @for i in $(RPM_DEPENDS) ; do \
256 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
257 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
259 if [ -n "$$MISSING" ] ; then \
260 echo "Please install missing RPMs: \n$$MISSING\n" ; \
261 echo "by executing \"make install-dep\"\n" ; \
269 @echo "'make bootstrap' is not needed anymore"
272 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
273 ifeq ($(OS_VERSION_ID),14.04)
274 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
275 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
277 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
278 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
279 || ( echo "Please install jessie-backports" ; exit 1 )
281 @sudo -E apt-get update
282 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
283 else ifneq ("$(wildcard /etc/redhat-release)","")
284 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
285 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
286 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
287 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
288 @sudo -E zypper refresh
289 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
290 else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
291 @sudo -E zypper refresh
292 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
294 $(error "This option currently works only on Ubuntu, Debian, Centos or openSUSE systems")
298 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
301 $(BR)/scripts/.version:
302 ifneq ("$(wildcard /etc/redhat-release)","")
303 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
305 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
308 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
309 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
312 @if git rev-parse 2> /dev/null ; then \
314 --prefix=$(DIST_SUBDIR)/ \
318 git describe > $(BR)/.version ; \
320 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
321 src/scripts/version > $(BR)/.version ; \
324 --file $(DIST_FILE) \
325 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
327 @$(RM) $(BR)/.version $(DIST_FILE).xz
328 @xz -v --threads=0 $(DIST_FILE)
329 @$(RM) $(BR)/vpp-latest.tar.xz
330 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
332 build: $(BR)/.deps.ok
333 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
336 @$(RM) $(BR)/*.tar.xz
338 wipe: wipedist test-wipe $(BR)/.deps.ok
339 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
343 build-release: $(BR)/.deps.ok
344 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
346 wipe-release: test-wipe $(BR)/.deps.ok
347 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
349 rebuild-release: wipe-release build-release
351 export VPP_PYTHON_PREFIX ?= $(BR)/python
353 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
356 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install vom-install,)
357 $(eval libs:=lib lib64)
359 TEST_DIR=$(WS_ROOT)/test \
360 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
361 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
362 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
363 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
364 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
365 EXTENDED_TESTS=$(EXTENDED_TESTS) \
368 CACHE_OUTPUT=$(CACHE_OUTPUT) \
373 $(call test,vpp,vpp,test)
376 $(call test,vpp,vpp_debug,test)
379 $(eval EXTENDED_TESTS=yes)
380 $(call test,vpp,vpp,test)
383 $(eval EXTENDED_TESTS=yes)
384 $(call test,vpp,vpp_debug,test)
393 $(call test,vpp,vpp,shell)
396 $(call test,vpp,vpp_debug,shell)
399 @make -C test test-dep
405 @make -C test wipe-doc
408 $(eval EXTENDED_TESTS=yes)
409 $(call test,vpp,vpp_gcov,cov)
412 @make -C test wipe-cov
415 @make -C test checkstyle
418 $(call test,vpp,vpp,retest)
421 $(call test,vpp,vpp_debug,retest)
423 STARTUP_DIR ?= $(PWD)
424 ifeq ("$(wildcard $(STARTUP_CONF))","")
426 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
427 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
428 @cd $(STARTUP_DIR) && \
429 $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
433 @cd $(STARTUP_DIR) && \
434 $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
439 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
440 \( -not -path './build-root*' -o -path \
441 './build-root/build-vpp_debug-native/dpdk*' \) > $@
446 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
449 $(call run, $(BR)/install-$(PLATFORM)-native)
452 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
455 $(call make,$(PLATFORM)_coverity,install-packages)
458 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
461 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
464 @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
467 $(call make,$(PLATFORM),install-deb)
473 make -C extras/rpm srpm
476 make -C dpdk install-$(PKG)
479 @ctags --totals --tag-relative -L $<
483 @gtags --gtagslabel=ctags
489 @build-root/scripts/checkstyle.sh
492 @build-root/scripts/checkstyle.sh --fix
495 # Build the documentation
498 # Doxygen configuration and our utility scripts
499 export DOXY_DIR ?= $(WS_ROOT)/doxygen
502 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
505 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
517 @echo "========================================================================"
519 @echo "========================================================================"
523 verify: install-dep $(BR)/.deps.ok dpdk-install-dev
524 $(call banner,"Building for PLATFORM=vpp using gcc")
525 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
526 $(call banner,"Building sample-plugin")
527 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
528 $(call banner,"Building libmemif")
529 @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
530 $(call banner,"Building VOM")
531 @make -C build-root PLATFORM=vpp TAG=vpp vom-install
532 $(call banner,"Building $(PKG) packages")
534 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
535 @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test