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 DEB_DEPENDS += cmake ninja-build
70 ifeq ($(OS_VERSION_ID),14.04)
71 DEB_DEPENDS += openjdk-8-jdk-headless
72 DEB_DEPENDS += libssl-dev
73 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
74 DEB_DEPENDS += openjdk-8-jdk-headless
75 DEB_DEPENDS += libssl-dev
76 APT_ARGS = -t jessie-backports
77 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
78 DEB_DEPENDS += default-jdk-headless
79 DEB_DEPENDS += libssl1.0-dev
81 DEB_DEPENDS += default-jdk-headless
82 DEB_DEPENDS += libssl-dev
85 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
86 RPM_DEPENDS += apr-devel
87 RPM_DEPENDS += numactl-devel
88 RPM_DEPENDS += check check-devel
89 RPM_DEPENDS += boost boost-devel
90 RPM_DEPENDS += selinux-policy selinux-policy-devel
91 RPM_DEPENDS += cmake3 ninja-build
93 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
94 RPM_DEPENDS += subunit subunit-devel
95 RPM_DEPENDS += openssl-devel
96 RPM_DEPENDS += python-devel python2-ply
97 RPM_DEPENDS += python2-virtualenv
98 RPM_DEPENDS += mbedtls-devel
99 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
100 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
101 RPM_DEPENDS += subunit subunit-devel
102 RPM_DEPENDS += compat-openssl10-devel
103 RPM_DEPENDS += python2-devel python2-ply
104 RPM_DEPENDS += python2-virtualenv
105 RPM_DEPENDS += mbedtls-devel
106 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
108 RPM_DEPENDS += openssl-devel
109 RPM_DEPENDS += python-devel python-ply
110 RPM_DEPENDS += python-virtualenv
111 RPM_DEPENDS += devtoolset-7
112 RPM_DEPENDS_GROUPS = 'Development Tools'
115 # +ganglia-devel if building the ganglia plugin
117 RPM_DEPENDS += chrpath libffi-devel rpm-build
119 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
120 SUSE_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
121 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
122 RPM_SUSE_BUILDTOOLS_DEPS += clang cmake indent libtool make ninja python-ply
124 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel
125 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel
127 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
128 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
130 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
132 ifeq ($(OS_ID),opensuse)
133 ifeq ($(SUSE_NAME),Tumbleweed)
134 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
135 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
137 ifeq ($(SUSE_ID),15.0)
138 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
139 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
141 RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
142 RPM_SUSE_PYTHON_DEPS += python-virtualenv
146 ifeq ($(OS_ID),opensuse-leap)
147 ifeq ($(SUSE_ID),15.0)
148 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc6
149 RPM_SUSE_PYTHON_DEPS += python2-ply python2-virtualenv
153 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
155 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
156 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
159 ifeq ($(findstring y,$(UNATTENDED)),y)
166 ifneq ($(SAMPLE_PLUGIN),no)
167 TARGETS += sample-plugin
170 .PHONY: help wipe wipe-release build build-release rebuild rebuild-release
171 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
173 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
174 .PHONY: test-cov test-wipe-cov
177 @echo "Make Targets:"
178 @echo " install-dep - install software dependencies"
179 @echo " wipe - wipe all products of debug build "
180 @echo " wipe-release - wipe all products of release build "
181 @echo " build - build debug binaries"
182 @echo " build-release - build release binaries"
183 @echo " build-coverity - build coverity artifacts"
184 @echo " rebuild - wipe and build debug binares"
185 @echo " rebuild-release - wipe and build release binares"
186 @echo " run - run debug binary"
187 @echo " run-release - run release binary"
188 @echo " debug - run debug binary with debugger"
189 @echo " debug-release - run release binary with debugger"
190 @echo " test - build and run (basic) functional tests"
191 @echo " test-debug - build and run (basic) functional tests (debug build)"
192 @echo " test-all - build and run (all) functional tests"
193 @echo " test-all-debug - build and run (all) functional tests (debug build)"
194 @echo " test-ext - build and run 'extras' functional tests"
195 @echo " test-shell - enter shell with test environment"
196 @echo " test-shell-debug - enter shell with test environment (debug build)"
197 @echo " test-wipe - wipe files generated by unit tests"
198 @echo " retest - run functional tests"
199 @echo " retest-debug - run functional tests (debug build)"
200 @echo " test-help - show help on test framework"
201 @echo " run-vat - run vpp-api-test tool"
202 @echo " pkg-deb - build DEB packages"
203 @echo " pkg-rpm - build RPM packages"
204 @echo " dpdk-install-dev - install DPDK development packages"
205 @echo " ctags - (re)generate ctags database"
206 @echo " gtags - (re)generate gtags database"
207 @echo " cscope - (re)generate cscope database"
208 @echo " checkstyle - check coding style"
209 @echo " fixstyle - fix coding style"
210 @echo " doxygen - (re)generate documentation"
211 @echo " bootstrap-doxygen - setup Doxygen dependencies"
212 @echo " wipe-doxygen - wipe all generated documentation"
213 @echo " test-doc - generate documentation for test framework"
214 @echo " test-wipe-doc - wipe documentation for test framework"
215 @echo " test-cov - generate code coverage report for test framework"
216 @echo " test-wipe-cov - wipe code coverage report for test framework"
217 @echo " test-checkstyle - check PEP8 compliance for test framework"
219 @echo "Make Arguments:"
220 @echo " V=[0|1] - set build verbosity level"
221 @echo " STARTUP_CONF=<path> - startup configuration file"
222 @echo " (e.g. /etc/vpp/startup.conf)"
223 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
224 @echo " It also sets STARTUP_CONF if"
225 @echo " startup.conf file is present"
226 @echo " GDB=<path> - gdb binary to use for debugging"
227 @echo " PLATFORM=<name> - target platform. default is vpp"
228 @echo " TEST=<filter> - apply filter to test set, see test-help"
229 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
230 @echo " autogenerated startup.conf"
231 @echo " (e.g. \"no-pci\" )"
232 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
233 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
234 @echo " should not be loaded"
236 @echo "Current Argument Values:"
238 @echo " STARTUP_CONF = $(STARTUP_CONF)"
239 @echo " STARTUP_DIR = $(STARTUP_DIR)"
240 @echo " GDB = $(GDB)"
241 @echo " PLATFORM = $(PLATFORM)"
242 @echo " DPDK_VERSION = $(DPDK_VERSION)"
243 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
244 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
245 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
248 ifeq ($(findstring y,$(UNATTENDED)),y)
251 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
252 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
253 if [ -n "$$MISSING" ] ; then \
254 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
255 echo "by executing \"make install-dep\"\n" ; \
259 else ifneq ("$(wildcard /etc/redhat-release)","")
260 @for i in $(RPM_DEPENDS) ; do \
261 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
262 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
264 if [ -n "$$MISSING" ] ; then \
265 echo "Please install missing RPMs: \n$$MISSING\n" ; \
266 echo "by executing \"make install-dep\"\n" ; \
274 @echo "'make bootstrap' is not needed anymore"
277 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
278 ifeq ($(OS_VERSION_ID),14.04)
279 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
280 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
282 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
283 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
284 || ( echo "Please install jessie-backports" ; exit 1 )
286 @sudo -E apt-get update
287 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
288 else ifneq ("$(wildcard /etc/redhat-release)","")
289 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
290 @sudo -E yum install $(CONFIRM) centos-release-scl-rh
291 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
292 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
293 else ifeq ($(filter opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
294 @sudo -E zypper refresh
295 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
296 else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
297 @sudo -E zypper refresh
298 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
299 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
300 @sudo -E zypper refresh
301 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
303 $(error "This option currently works only on Ubuntu, Debian, Centos or openSUSE systems")
307 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
310 $(BR)/scripts/.version:
311 ifneq ("$(wildcard /etc/redhat-release)","")
312 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
314 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
317 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
318 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
321 @if git rev-parse 2> /dev/null ; then \
323 --prefix=$(DIST_SUBDIR)/ \
327 git describe > $(BR)/.version ; \
329 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
330 src/scripts/version > $(BR)/.version ; \
333 --file $(DIST_FILE) \
334 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
336 @$(RM) $(BR)/.version $(DIST_FILE).xz
337 @xz -v --threads=0 $(DIST_FILE)
338 @$(RM) $(BR)/vpp-latest.tar.xz
339 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
341 build: $(BR)/.deps.ok
342 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
345 @$(RM) $(BR)/*.tar.xz
347 wipe: wipedist test-wipe $(BR)/.deps.ok
348 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
352 build-release: $(BR)/.deps.ok
353 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
355 wipe-release: test-wipe $(BR)/.deps.ok
356 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
358 rebuild-release: wipe-release build-release
360 export VPP_PYTHON_PREFIX ?= $(BR)/python
362 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
365 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
366 $(eval libs:=lib lib64)
368 TEST_DIR=$(WS_ROOT)/test \
369 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
370 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
371 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
372 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
373 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
374 EXTENDED_TESTS=$(EXTENDED_TESTS) \
377 CACHE_OUTPUT=$(CACHE_OUTPUT) \
382 $(call test,vpp,vpp,test)
385 $(call test,vpp,vpp_debug,test)
388 $(eval EXTENDED_TESTS=yes)
389 $(call test,vpp,vpp,test)
392 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install japi-install,)
393 $(eval EXTENDED_TESTS=yes)
394 $(call test,vpp,vpp_debug,test-ext)
397 $(eval EXTENDED_TESTS=yes)
398 $(call test,vpp,vpp_debug,test)
407 $(call test,vpp,vpp,shell)
410 $(call test,vpp,vpp_debug,shell)
413 @make -C test test-dep
419 @make -C test wipe-doc
422 $(eval EXTENDED_TESTS=yes)
423 $(call test,vpp,vpp_gcov,cov)
426 @make -C test wipe-cov
429 @make -C test checkstyle
432 $(call test,vpp,vpp,retest)
435 $(call test,vpp,vpp_debug,retest)
437 ifeq ("$(wildcard $(STARTUP_CONF))","")
439 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
440 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
441 @cd $(STARTUP_DIR) && \
442 $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
446 @cd $(STARTUP_DIR) && \
447 $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
452 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
453 \( -not -path './build-root*' -o -path \
454 './build-root/build-vpp_debug-native/dpdk*' \) > $@
459 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
462 $(call run, $(BR)/install-$(PLATFORM)-native)
465 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
468 $(call make,$(PLATFORM)_coverity,install-packages)
471 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
474 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
477 @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
480 $(call make,$(PLATFORM),install-deb)
486 make -C extras/rpm srpm
489 make -C dpdk install-$(PKG)
492 @ctags --totals --tag-relative -L $<
496 @gtags --gtagslabel=ctags
502 @build-root/scripts/checkstyle.sh
505 @build-root/scripts/checkstyle.sh --fix
508 # Build the documentation
511 # Doxygen configuration and our utility scripts
512 export DOXY_DIR ?= $(WS_ROOT)/doxygen
515 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
518 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
530 @echo "========================================================================"
532 @echo "========================================================================"
536 verify: install-dep $(BR)/.deps.ok dpdk-install-dev
537 $(call banner,"Building for PLATFORM=vpp using gcc")
538 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
539 $(call banner,"Building sample-plugin")
540 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
541 $(call banner,"Building libmemif")
542 @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
543 $(call banner,"Building JAPI")
544 @make -C build-root PLATFORM=vpp TAG=vpp japi-install
545 $(call banner,"Building VOM")
546 @make -C build-root PLATFORM=vpp TAG=vpp vom-install
547 $(call banner,"Building $(PKG) packages")
549 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
550 $(call banner,"Running tests")
551 @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test