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)
23 define disable_plugins
26 $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
31 MINIMAL_STARTUP_CONF=" \
34 cli-listen /run/vpp/cli.sock \
36 $(if $(wildcard startup.vpp),"exec startup.vpp",) \
38 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",) \
39 $(call disable_plugins,$(DISABLED_PLUGINS)) \
42 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
47 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
48 ifneq ($(shell uname),Darwin)
49 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
50 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
53 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
55 else ifeq ($(filter rhel centos fedora opensuse,$(OS_ID)),$(OS_ID))
59 # +libganglia1-dev if building the gmond plugin
61 DEB_DEPENDS = curl build-essential autoconf automake ccache
62 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
63 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
64 DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
65 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6 check
66 DEB_DEPENDS += libboost-all-dev libffi-dev python-ply
67 ifeq ($(OS_VERSION_ID),14.04)
68 DEB_DEPENDS += openjdk-8-jdk-headless
69 DEB_DEPENDS += libssl-dev
70 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
71 DEB_DEPENDS += openjdk-8-jdk-headless
72 DEB_DEPENDS += libssl-dev
73 APT_ARGS = -t jessie-backports
74 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
75 DEB_DEPENDS += default-jdk-headless
76 DEB_DEPENDS += libssl1.0-dev
78 DEB_DEPENDS += default-jdk-headless
79 DEB_DEPENDS += libssl-dev
82 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
83 RPM_DEPENDS += apr-devel
84 RPM_DEPENDS += numactl-devel
85 RPM_DEPENDS += check check-devel
86 RPM_DEPENDS += boost boost-devel
87 RPM_DEPENDS += subunit subunit-devel
88 RPM_DEPENDS += selinux-policy selinux-policy-devel
90 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
91 RPM_DEPENDS += openssl-devel
92 RPM_DEPENDS += python-devel python2-ply
93 RPM_DEPENDS += python2-virtualenv
94 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
95 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
96 RPM_DEPENDS += compat-openssl10-devel
97 RPM_DEPENDS += python2-devel python2-ply
98 RPM_DEPENDS += python2-virtualenv
99 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
101 RPM_DEPENDS += openssl-devel
102 RPM_DEPENDS += python-devel python-ply
103 RPM_DEPENDS += python-virtualenv
104 RPM_DEPENDS_GROUPS = 'Development Tools'
107 # +ganglia-devel if building the ganglia plugin
109 RPM_DEPENDS += chrpath libffi-devel rpm-build
111 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
112 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
113 RPM_SUSE_BUILDTOOLS_DEPS += clang indent libtool make python-ply
115 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel
116 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel
118 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
119 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
121 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
123 ifeq ($(OS_ID),opensuse)
124 ifneq ($(SUSE_NAME),Tumbleweed)
125 RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
126 RPM_SUSE_PYTHON_DEPS += python-virtualenv
128 RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
129 RPM_SUSE_PYTHON_DEPS += python2-virtualenv
133 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
135 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
136 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
139 ifeq ($(findstring y,$(UNATTENDED)),y)
146 ifneq ($(SAMPLE_PLUGIN),no)
147 TARGETS += sample-plugin
150 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
151 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
153 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
154 .PHONY: test-cov test-wipe-cov
157 @echo "Make Targets:"
158 @echo " bootstrap - prepare tree for build"
159 @echo " install-dep - install software dependencies"
160 @echo " wipe - wipe all products of debug build "
161 @echo " wipe-release - wipe all products of release build "
162 @echo " build - build debug binaries"
163 @echo " build-release - build release binaries"
164 @echo " build-coverity - build coverity artifacts"
165 @echo " rebuild - wipe and build debug binares"
166 @echo " rebuild-release - wipe and build release binares"
167 @echo " run - run debug binary"
168 @echo " run-release - run release binary"
169 @echo " debug - run debug binary with debugger"
170 @echo " debug-release - run release binary with debugger"
171 @echo " test - build and run (basic) functional tests"
172 @echo " test-debug - build and run (basic) functional tests (debug build)"
173 @echo " test-all - build and run (all) functional tests"
174 @echo " test-all-debug - build and run (all) functional tests (debug build)"
175 @echo " test-shell - enter shell with test environment"
176 @echo " test-shell-debug - enter shell with test environment (debug build)"
177 @echo " test-wipe - wipe files generated by unit tests"
178 @echo " retest - run functional tests"
179 @echo " retest-debug - run functional tests (debug build)"
180 @echo " test-help - show help on test framework"
181 @echo " run-vat - run vpp-api-test tool"
182 @echo " pkg-deb - build DEB packages"
183 @echo " pkg-rpm - build RPM packages"
184 @echo " dpdk-install-dev - install DPDK development packages"
185 @echo " ctags - (re)generate ctags database"
186 @echo " gtags - (re)generate gtags database"
187 @echo " cscope - (re)generate cscope database"
188 @echo " checkstyle - check coding style"
189 @echo " fixstyle - fix coding style"
190 @echo " doxygen - (re)generate documentation"
191 @echo " bootstrap-doxygen - setup Doxygen dependencies"
192 @echo " wipe-doxygen - wipe all generated documentation"
193 @echo " test-doc - generate documentation for test framework"
194 @echo " test-wipe-doc - wipe documentation for test framework"
195 @echo " test-cov - generate code coverage report for test framework"
196 @echo " test-wipe-cov - wipe code coverage report for test framework"
197 @echo " test-checkstyle - check PEP8 compliance for test framework"
199 @echo "Make Arguments:"
200 @echo " V=[0|1] - set build verbosity level"
201 @echo " STARTUP_CONF=<path> - startup configuration file"
202 @echo " (e.g. /etc/vpp/startup.conf)"
203 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
204 @echo " It also sets STARTUP_CONF if"
205 @echo " startup.conf file is present"
206 @echo " GDB=<path> - gdb binary to use for debugging"
207 @echo " PLATFORM=<name> - target platform. default is vpp"
208 @echo " TEST=<filter> - apply filter to test set, see test-help"
209 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
210 @echo " autogenerated startup.conf"
211 @echo " (e.g. \"no-pci\" )"
212 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
213 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
214 @echo " should not be loaded"
216 @echo "Current Argument Values:"
218 @echo " STARTUP_CONF = $(STARTUP_CONF)"
219 @echo " STARTUP_DIR = $(STARTUP_DIR)"
220 @echo " GDB = $(GDB)"
221 @echo " PLATFORM = $(PLATFORM)"
222 @echo " DPDK_VERSION = $(DPDK_VERSION)"
223 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
224 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
225 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
228 ifeq ($(findstring y,$(UNATTENDED)),y)
231 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
232 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
233 if [ -n "$$MISSING" ] ; then \
234 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
235 echo "by executing \"make install-dep\"\n" ; \
239 else ifneq ("$(wildcard /etc/redhat-release)","")
240 @for i in $(RPM_DEPENDS) ; do \
241 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
242 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
244 if [ -n "$$MISSING" ] ; then \
245 echo "Please install missing RPMs: \n$$MISSING\n" ; \
246 echo "by executing \"make install-dep\"\n" ; \
251 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
252 @echo "#!/bin/bash\n" > $(BR)/path_setup
253 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
254 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
255 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
257 ifeq ("$(wildcard /usr/bin/ccache )","")
258 @echo "WARNING: Please install ccache AYEC and re-run this script"
260 @rm -rf $(BR)/tools/ccache-bin
261 @mkdir -p $(BR)/tools/ccache-bin
262 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
263 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
265 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
268 bootstrap: $(BR)/.bootstrap.ok
271 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
272 ifeq ($(OS_VERSION_ID),14.04)
273 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
274 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
276 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
277 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
278 || ( echo "Please install jessie-backports" ; exit 1 )
280 @sudo -E apt-get update
281 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
282 else ifneq ("$(wildcard /etc/redhat-release)","")
283 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
284 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
285 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
286 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
287 @sudo -E zypper refresh
288 @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
290 $(error "This option currently works only on Ubuntu, Debian, Centos or openSUSE systems")
294 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
297 $(BR)/scripts/.version:
298 ifneq ("$(wildcard /etc/redhat-release)","")
299 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
301 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
304 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
305 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
308 @if git rev-parse 2> /dev/null ; then \
310 --prefix=$(DIST_SUBDIR)/ \
314 git describe > $(BR)/.version ; \
316 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
317 src/scripts/version > $(BR)/.version ; \
320 --file $(DIST_FILE) \
321 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
323 @$(RM) $(BR)/.version $(DIST_FILE).xz
324 @xz -v --threads=0 $(DIST_FILE)
325 @$(RM) $(BR)/vpp-latest.tar.xz
326 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
328 build: $(BR)/.bootstrap.ok
329 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
332 @$(RM) $(BR)/*.tar.xz
334 wipe: wipedist test-wipe $(BR)/.bootstrap.ok
335 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
339 build-release: $(BR)/.bootstrap.ok
340 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
342 wipe-release: test-wipe $(BR)/.bootstrap.ok
343 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
345 rebuild-release: wipe-release build-release
347 export VPP_PYTHON_PREFIX=$(BR)/python
349 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
352 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
353 $(eval libs:=lib lib64)
355 TEST_DIR=$(WS_ROOT)/test \
356 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
357 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
358 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
359 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
360 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
361 EXTENDED_TESTS=$(EXTENDED_TESTS) \
364 CACHE_OUTPUT=$(CACHE_OUTPUT) \
369 $(call test,vpp,vpp,test)
371 test-debug: bootstrap
372 $(call test,vpp,vpp_debug,test)
375 $(eval EXTENDED_TESTS=yes)
376 $(call test,vpp,vpp,test)
378 test-all-debug: bootstrap
379 $(eval EXTENDED_TESTS=yes)
380 $(call test,vpp,vpp_debug,test)
388 test-shell: bootstrap
389 $(call test,vpp,vpp,shell)
391 test-shell-debug: bootstrap
392 $(call test,vpp,vpp_debug,shell)
398 @make -C test wipe-doc
401 $(eval EXTENDED_TESTS=yes)
402 $(call test,vpp,vpp_gcov,cov)
405 @make -C test wipe-cov
408 @make -C test checkstyle
411 $(call test,vpp,vpp,retest)
414 $(call test,vpp,vpp_debug,retest)
416 STARTUP_DIR ?= $(PWD)
417 ifeq ("$(wildcard $(STARTUP_CONF))","")
419 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
420 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
421 @cd $(STARTUP_DIR) && \
422 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) \
423 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
427 @cd $(STARTUP_DIR) && \
428 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') \
429 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
434 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
435 \( -not -path './build-root*' -o -path \
436 './build-root/build-vpp_debug-native/dpdk*' \) > $@
441 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
444 $(call run, $(BR)/install-$(PLATFORM)-native)
447 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
450 $(call make,$(PLATFORM)_coverity,install-packages)
453 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
456 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
459 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
462 $(call make,$(PLATFORM),install-deb)
468 make -C extras/rpm srpm
471 make -C dpdk install-$(PKG)
474 @ctags --totals --tag-relative -L $<
478 @gtags --gtagslabel=ctags
484 @build-root/scripts/checkstyle.sh
487 @build-root/scripts/checkstyle.sh --fix
490 # Build the documentation
493 # Doxygen configuration and our utility scripts
494 export DOXY_DIR ?= $(WS_ROOT)/doxygen
497 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
500 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
512 @echo "========================================================================"
514 @echo "========================================================================"
518 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
519 $(call banner,"Building for PLATFORM=vpp using gcc")
520 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
521 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
522 $(call banner,"Installing dependencies")
523 @sudo -E apt-get update
524 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
525 $(call banner,"Building for PLATFORM=vpp using clang")
526 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
528 $(call banner,"Building sample-plugin")
529 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
530 $(call banner,"Building $(PKG) packages")
532 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
533 @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test