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 python3-ply libmbedtls-dev
69 DEB_DEPENDS += cmake ninja-build uuid-dev
70 ifeq ($(OS_VERSION_ID),14.04)
71 DEB_DEPENDS += libssl-dev
72 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
73 DEB_DEPENDS += libssl-dev
74 APT_ARGS = -t jessie-backports
75 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
76 DEB_DEPENDS += libssl1.0-dev
78 DEB_DEPENDS += libssl-dev
81 RPM_DEPENDS = redhat-lsb glibc-static
82 RPM_DEPENDS += apr-devel
83 RPM_DEPENDS += numactl-devel
84 RPM_DEPENDS += check check-devel
85 RPM_DEPENDS += boost boost-devel
86 RPM_DEPENDS += selinux-policy selinux-policy-devel
87 RPM_DEPENDS += ninja-build
88 RPM_DEPENDS += libuuid-devel
90 ifeq ($(OS_ID),fedora)
91 RPM_DEPENDS += dnf-utils
92 RPM_DEPENDS += subunit subunit-devel
93 RPM_DEPENDS += compat-openssl10-devel
94 RPM_DEPENDS += python2-devel python34-ply
95 RPM_DEPENDS += python2-virtualenv
96 RPM_DEPENDS += mbedtls-devel
98 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
100 RPM_DEPENDS += yum-utils
101 RPM_DEPENDS += openssl-devel
102 RPM_DEPENDS += python-devel python34-ply
103 RPM_DEPENDS += python34-devel python34-pip
104 RPM_DEPENDS += python-virtualenv
105 RPM_DEPENDS += devtoolset-7
106 RPM_DEPENDS += cmake3
107 RPM_DEPENDS_GROUPS = 'Development Tools'
110 # +ganglia-devel if building the ganglia plugin
112 RPM_DEPENDS += chrpath libffi-devel rpm-build
114 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
115 SUSE_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
116 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
117 RPM_SUSE_BUILDTOOLS_DEPS += clang cmake indent libtool make ninja python3-ply
119 RPM_SUSE_DEVEL_DEPS = glibc-devel-static libnuma-devel
120 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel libuuid-devel
122 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
123 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
125 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
127 ifeq ($(OS_ID),opensuse)
128 ifeq ($(SUSE_NAME),Tumbleweed)
129 RPM_SUSE_DEVEL_DEPS = libboost_headers1_68_0-devel-1.68.0 libboost_thread1_68_0-devel-1.68.0 gcc
130 RPM_SUSE_PYTHON_DEPS += python3-ply python2-virtualenv
132 ifeq ($(SUSE_ID),15.0)
133 RPM_SUSE_DEVEL_DEPS += libboost_headers-devel libboost_thread-devel gcc
134 RPM_SUSE_PYTHON_DEPS += python3-ply python2-virtualenv
136 RPM_SUSE_DEVEL_DEPS += libboost_headers1_68_0-devel-1.68.0 gcc6
137 RPM_SUSE_PYTHON_DEPS += python-virtualenv
141 ifeq ($(OS_ID),opensuse-leap)
142 ifeq ($(SUSE_ID),15.0)
143 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
144 RPM_SUSE_PYTHON_DEPS += python3-ply python2-virtualenv
148 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
150 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
151 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
154 ifeq ($(findstring y,$(UNATTENDED)),y)
161 ifneq ($(SAMPLE_PLUGIN),no)
162 TARGETS += sample-plugin
165 .PHONY: help wipe wipe-release build build-release rebuild rebuild-release
166 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
168 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
169 .PHONY: test-cov test-wipe-cov
172 @echo "========================================================================"
174 @echo "========================================================================"
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-shell - enter shell with test environment"
197 @echo " test-shell-debug - enter shell with test environment (debug build)"
198 @echo " test-wipe - wipe files generated by unit tests"
199 @echo " retest - run functional tests"
200 @echo " retest-debug - run functional tests (debug build)"
201 @echo " test-help - show help on test framework"
202 @echo " run-vat - run vpp-api-test tool"
203 @echo " pkg-deb - build DEB packages"
204 @echo " vom-pkg-deb - build vom DEB packages"
205 @echo " pkg-rpm - build RPM packages"
206 @echo " install-ext-deps - install external development dependencies"
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 " docs - Build the Sphinx documentation"
216 @echo " docs-venv - Build the virtual environment for the Sphinx docs"
217 @echo " docs-clean - Remove the generated files from the Sphinx docs"
218 @echo " test-doc - generate documentation for test framework"
219 @echo " test-wipe-doc - wipe documentation for test framework"
220 @echo " test-cov - generate code coverage report for test framework"
221 @echo " test-wipe-cov - wipe code coverage report for test framework"
222 @echo " test-checkstyle - check PEP8 compliance for test framework"
224 @echo "Make Arguments:"
225 @echo " V=[0|1] - set build verbosity level"
226 @echo " STARTUP_CONF=<path> - startup configuration file"
227 @echo " (e.g. /etc/vpp/startup.conf)"
228 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
229 @echo " It also sets STARTUP_CONF if"
230 @echo " startup.conf file is present"
231 @echo " GDB=<path> - gdb binary to use for debugging"
232 @echo " PLATFORM=<name> - target platform. default is vpp"
233 @echo " TEST=<filter> - apply filter to test set, see test-help"
234 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
235 @echo " autogenerated startup.conf"
236 @echo " (e.g. \"no-pci\" )"
237 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
238 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
239 @echo " should not be loaded"
241 @echo "Current Argument Values:"
243 @echo " STARTUP_CONF = $(STARTUP_CONF)"
244 @echo " STARTUP_DIR = $(STARTUP_DIR)"
245 @echo " GDB = $(GDB)"
246 @echo " PLATFORM = $(PLATFORM)"
247 @echo " DPDK_VERSION = $(DPDK_VERSION)"
248 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
249 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
250 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
253 ifeq ($(findstring y,$(UNATTENDED)),y)
256 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
257 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
258 if [ -n "$$MISSING" ] ; then \
259 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
260 echo "by executing \"make install-dep\"\n" ; \
264 else ifneq ("$(wildcard /etc/redhat-release)","")
265 @for i in $(RPM_DEPENDS) ; do \
266 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
267 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
269 if [ -n "$$MISSING" ] ; then \
270 echo "Please install missing RPMs: \n$$MISSING\n" ; \
271 echo "by executing \"make install-dep\"\n" ; \
279 @echo "'make bootstrap' is not needed anymore"
282 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
283 ifeq ($(OS_VERSION_ID),14.04)
284 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
286 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
287 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
288 || ( echo "Please install jessie-backports" ; exit 1 )
290 @sudo -E apt-get update
291 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
292 else ifneq ("$(wildcard /etc/redhat-release)","")
294 @sudo -E yum-config-manager --enable rhel-server-rhscl-7-rpms
295 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
296 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
297 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
298 else ifeq ($(OS_ID),centos)
299 @sudo -E yum install $(CONFIRM) centos-release-scl-rh epel-release
300 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
301 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
302 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
303 else ifeq ($(OS_ID),fedora)
304 @sudo -E dnf groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
305 @sudo -E dnf install $(CONFIRM) $(RPM_DEPENDS)
306 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
308 else ifeq ($(filter opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
309 @sudo -E zypper refresh
310 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
311 else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
312 @sudo -E zypper refresh
313 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
314 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
315 @sudo -E zypper refresh
316 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
318 $(error "This option currently works only on Ubuntu, Debian, RHEL, CentOS or openSUSE systems")
322 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
325 $(BR)/scripts/.version:
326 ifneq ("$(wildcard /etc/redhat-release)","")
327 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
329 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
332 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
333 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
336 @if git rev-parse 2> /dev/null ; then \
338 --prefix=$(DIST_SUBDIR)/ \
342 git describe > $(BR)/.version ; \
344 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
345 src/scripts/version > $(BR)/.version ; \
348 --file $(DIST_FILE) \
349 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
351 @$(RM) $(BR)/.version $(DIST_FILE).xz
352 @xz -v --threads=0 $(DIST_FILE)
353 @$(RM) $(BR)/vpp-latest.tar.xz
354 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
356 build: $(BR)/.deps.ok
357 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
360 @$(RM) $(BR)/*.tar.xz
362 wipe: wipedist test-wipe $(BR)/.deps.ok
363 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
364 @find . -type f -name "*.api.json" ! -path "./test/*" -exec rm {} \;
368 build-release: $(BR)/.deps.ok
369 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
371 wipe-release: test-wipe $(BR)/.deps.ok
372 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
374 rebuild-release: wipe-release build-release
376 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
378 export TEST_DIR ?= $(WS_ROOT)/test
381 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
382 $(eval libs:=lib lib64)
384 VPP_BUILD_DIR=$(BR)/build-$(2)-native \
385 VPP_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
386 VPP_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
387 VPP_INSTALL_PATH=$(BR)/install-$(2)-native/ \
388 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
389 EXTENDED_TESTS=$(EXTENDED_TESTS) \
392 CACHE_OUTPUT=$(CACHE_OUTPUT) \
397 $(call test,vpp,vpp,test)
400 $(call test,vpp,vpp_debug,test)
403 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp vom-install,)
404 $(eval EXTENDED_TESTS=yes)
405 $(call test,vpp,vpp,test)
408 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install,)
409 $(eval EXTENDED_TESTS=yes)
410 $(call test,vpp,vpp_debug,test)
419 $(call test,vpp,vpp,shell)
422 $(call test,vpp,vpp_debug,shell)
425 @make -C test test-dep
431 @make -C test wipe-doc
434 @make -C $(BR) PLATFORM=vpp TAG=vpp_gcov vom-install japi-install
435 $(eval EXTENDED_TESTS=yes)
436 $(call test,vpp,vpp_gcov,cov)
439 @make -C test wipe-cov
442 @make -C test checkstyle
445 $(call test,vpp,vpp,retest)
448 $(call test,vpp,vpp_debug,retest)
450 ifeq ("$(wildcard $(STARTUP_CONF))","")
452 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
453 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
454 @cd $(STARTUP_DIR) && \
455 $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
459 @cd $(STARTUP_DIR) && \
460 $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
465 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
466 \( -not -path './build-root*' -o -path \
467 './build-root/build-vpp_debug-native/dpdk*' \) > $@
472 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
475 $(call run, $(BR)/install-$(PLATFORM)-native)
478 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
481 $(call make,$(PLATFORM)_coverity,install-packages)
484 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
487 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
490 @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
493 $(call make,$(PLATFORM),vpp-package-deb)
496 $(call make,$(PLATFORM),vpp-package-deb)
497 $(call make,$(PLATFORM),vom-package-deb)
500 $(call make,$(PLATFORM)_debug,vpp-package-deb)
503 $(call make,$(PLATFORM)_debug,vpp-package-deb)
504 $(call make,$(PLATFORM)_debug,vom-package-deb)
510 make -C extras/rpm srpm
513 $(call banner,"This command is deprecated. Please use 'make install-ext-deps'")
514 make -C build/external install-$(PKG)
517 make -C build/external install-$(PKG)
520 @ctags --totals --tag-relative -L $<
524 @gtags --gtagslabel=ctags
530 @build-root/scripts/checkstyle.sh
533 @build-root/scripts/checkstyle.sh --fix
536 # Build the documentation
539 # Doxygen configuration and our utility scripts
540 export DOXY_DIR ?= $(WS_ROOT)/doxygen
543 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
546 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
558 export DOCS_DIR = $(WS_ROOT)/docs
559 export VENV_DIR = $(WS_ROOT)/sphinx_venv
560 export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
562 .PHONY: docs-venv docs docs-clean
565 @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
568 @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
571 @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh clean)
573 verify: install-dep $(BR)/.deps.ok install-ext-deps
574 $(call banner,"Building for PLATFORM=vpp using gcc")
575 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
576 $(call banner,"Building sample-plugin")
577 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
578 $(call banner,"Building libmemif")
579 @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
580 $(call banner,"Building VOM")
581 @make -C build-root PLATFORM=vpp TAG=vpp vom-install
582 $(call banner,"Building $(PKG) packages")
584 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-18.04)
585 $(call banner,"Running tests")
586 @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test