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
22 define disable_plugins
25 $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
30 MINIMAL_STARTUP_CONF=" \
33 cli-listen /run/vpp/cli.sock \
35 $(if $(wildcard startup.vpp),"exec startup.vpp",) \
37 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",) \
38 $(call disable_plugins,$(DISABLED_PLUGINS)) \
41 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
46 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
47 ifneq ($(shell uname),Darwin)
48 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
49 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
52 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
54 else ifeq ($(filter rhel centos fedora opensuse,$(OS_ID)),$(OS_ID))
58 # +libganglia1-dev if building the gmond plugin
60 DEB_DEPENDS = curl build-essential autoconf automake bison libssl-dev ccache
61 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
62 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
63 DEB_DEPENDS += lcov chrpath autoconf nasm indent libnuma-dev
64 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6
65 ifeq ($(OS_VERSION_ID),14.04)
66 DEB_DEPENDS += openjdk-8-jdk-headless
67 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
68 DEB_DEPENDS += openjdk-8-jdk-headless
69 APT_ARGS = -t jessie-backports
71 DEB_DEPENDS += default-jdk-headless
74 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
75 RPM_DEPENDS += apr-devel
76 RPM_DEPENDS += openssl-devel
77 RPM_DEPENDS += numactl-devel
78 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
79 RPM_DEPENDS += python-devel
80 RPM_DEPENDS += python2-virtualenv
81 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
82 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
83 RPM_DEPENDS += python2-devel
84 RPM_DEPENDS += python2-virtualenv
85 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
87 RPM_DEPENDS += python-devel
88 RPM_DEPENDS += python-virtualenv
89 RPM_DEPENDS_GROUPS = 'Development Tools'
92 # +ganglia-devel if building the ganglia plugin
94 RPM_DEPENDS += chrpath libffi-devel rpm-build
95 ifeq ($(OS_ID),fedora)
98 RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
101 RPM_SUSE_DEPENDS = autoconf automake bison ccache chrpath distribution-release gcc6 glibc-devel-static
102 RPM_SUSE_DEPENDS += java-1_8_0-openjdk-devel libopenssl-devel libtool lsb-release make openssl-devel
103 RPM_SUSE_DEPENDS += python-devel python-pip python-rpm-macros shadow nasm libnuma-devel
105 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
106 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
109 ifeq ($(findstring y,$(UNATTENDED)),y)
116 ifneq ($(SAMPLE_PLUGIN),no)
117 TARGETS += sample-plugin
120 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
121 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
123 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
124 .PHONY: test-cov test-wipe-cov
127 @echo "Make Targets:"
128 @echo " bootstrap - prepare tree for build"
129 @echo " install-dep - install software dependencies"
130 @echo " wipe - wipe all products of debug build "
131 @echo " wipe-release - wipe all products of release build "
132 @echo " build - build debug binaries"
133 @echo " build-release - build release binaries"
134 @echo " build-coverity - build coverity artifacts"
135 @echo " rebuild - wipe and build debug binares"
136 @echo " rebuild-release - wipe and build release binares"
137 @echo " run - run debug binary"
138 @echo " run-release - run release binary"
139 @echo " debug - run debug binary with debugger"
140 @echo " debug-release - run release binary with debugger"
141 @echo " test - build and run (basic) functional tests"
142 @echo " test-debug - build and run (basic) functional tests (debug build)"
143 @echo " test-all - build and run (all) functional tests"
144 @echo " test-all-debug - build and run (all) functional tests (debug build)"
145 @echo " test-shell - enter shell with test environment"
146 @echo " test-shell-debug - enter shell with test environment (debug build)"
147 @echo " test-wipe - wipe files generated by unit tests"
148 @echo " retest - run functional tests"
149 @echo " retest-debug - run functional tests (debug build)"
150 @echo " test-help - show help on test framework"
151 @echo " run-vat - run vpp-api-test tool"
152 @echo " pkg-deb - build DEB packages"
153 @echo " pkg-rpm - build RPM packages"
154 @echo " dpdk-install-dev - install DPDK development packages"
155 @echo " ctags - (re)generate ctags database"
156 @echo " gtags - (re)generate gtags database"
157 @echo " cscope - (re)generate cscope database"
158 @echo " checkstyle - check coding style"
159 @echo " fixstyle - fix coding style"
160 @echo " doxygen - (re)generate documentation"
161 @echo " bootstrap-doxygen - setup Doxygen dependencies"
162 @echo " wipe-doxygen - wipe all generated documentation"
163 @echo " test-doc - generate documentation for test framework"
164 @echo " test-wipe-doc - wipe documentation for test framework"
165 @echo " test-cov - generate code coverage report for test framework"
166 @echo " test-wipe-cov - wipe code coverage report for test framework"
167 @echo " test-checkstyle - check PEP8 compliance for test framework"
169 @echo "Make Arguments:"
170 @echo " V=[0|1] - set build verbosity level"
171 @echo " STARTUP_CONF=<path> - startup configuration file"
172 @echo " (e.g. /etc/vpp/startup.conf)"
173 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
174 @echo " It also sets STARTUP_CONF if"
175 @echo " startup.conf file is present"
176 @echo " GDB=<path> - gdb binary to use for debugging"
177 @echo " PLATFORM=<name> - target platform. default is vpp"
178 @echo " TEST=<filter> - apply filter to test set, see test-help"
179 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
180 @echo " autogenerated startup.conf"
181 @echo " (e.g. \"no-pci\" )"
182 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
183 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
184 @echo " should not be loaded"
186 @echo "Current Argument Values:"
188 @echo " STARTUP_CONF = $(STARTUP_CONF)"
189 @echo " STARTUP_DIR = $(STARTUP_DIR)"
190 @echo " GDB = $(GDB)"
191 @echo " PLATFORM = $(PLATFORM)"
192 @echo " DPDK_VERSION = $(DPDK_VERSION)"
193 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
194 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
195 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
198 ifeq ($(findstring y,$(UNATTENDED)),y)
201 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
202 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
203 if [ -n "$$MISSING" ] ; then \
204 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
205 echo "by executing \"make install-dep\"\n" ; \
209 else ifneq ("$(wildcard /etc/redhat-release)","")
210 @for i in $(RPM_DEPENDS) ; do \
211 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
212 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
214 if [ -n "$$MISSING" ] ; then \
215 echo "Please install missing RPMs: \n$$MISSING\n" ; \
216 echo "by executing \"make install-dep\"\n" ; \
221 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
222 @echo "#!/bin/bash\n" > $(BR)/path_setup
223 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
224 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
225 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
227 ifeq ("$(wildcard /usr/bin/ccache )","")
228 @echo "WARNING: Please install ccache AYEC and re-run this script"
230 @rm -rf $(BR)/tools/ccache-bin
231 @mkdir -p $(BR)/tools/ccache-bin
232 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
233 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
235 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
238 bootstrap: $(BR)/.bootstrap.ok
241 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
242 ifeq ($(OS_VERSION_ID),14.04)
243 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
244 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
246 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
247 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
248 || ( echo "Please install jessie-backports" ; exit 1 )
250 @sudo -E apt-get update
251 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
252 else ifneq ("$(wildcard /etc/redhat-release)","")
253 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
254 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
255 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
256 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
257 @sudo -E zypper -n install -y $(RPM_SUSE_DEPENDS)
259 $(error "This option currently works only on Ubuntu, Debian or Centos systems")
263 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
266 $(BR)/scripts/.version:
267 ifneq ("$(wildcard /etc/redhat-release)","")
268 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
270 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
273 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
274 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
277 @if git rev-parse 2> /dev/null ; then \
279 --prefix=$(DIST_SUBDIR)/ \
283 git describe > $(BR)/.version ; \
285 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
286 src/scripts/version > $(BR)/.version ; \
289 --file $(DIST_FILE) \
290 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
292 @$(RM) $(BR)/.version $(DIST_FILE).xz
293 @xz -v --threads=0 $(DIST_FILE)
294 @$(RM) $(BR)/vpp-latest.tar.xz
295 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
297 build: $(BR)/.bootstrap.ok
298 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
301 @$(RM) $(BR)/*.tar.xz
303 wipe: wipedist $(BR)/.bootstrap.ok
304 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
308 build-release: $(BR)/.bootstrap.ok
309 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
311 wipe-release: $(BR)/.bootstrap.ok
312 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
314 rebuild-release: wipe-release build-release
316 export VPP_PYTHON_PREFIX=$(BR)/python
318 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
321 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
322 $(eval libs:=lib lib64)
324 TEST_DIR=$(WS_ROOT)/test \
325 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
326 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
327 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
328 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
329 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
330 EXTENDED_TESTS=$(EXTENDED_TESTS) \
336 $(call test,vpp,vpp,test)
338 test-debug: bootstrap
339 $(call test,vpp,vpp_debug,test)
342 $(eval EXTENDED_TESTS=yes)
343 $(call test,vpp,vpp,test)
345 test-all-debug: bootstrap
346 $(eval EXTENDED_TESTS=yes)
347 $(call test,vpp,vpp_debug,test)
355 test-shell: bootstrap
356 $(call test,vpp,vpp,shell)
358 test-shell-debug: bootstrap
359 $(call test,vpp,vpp_debug,shell)
365 @make -C test wipe-doc
368 $(eval EXTENDED_TESTS=yes)
369 $(call test,vpp,vpp_gcov,cov)
372 @make -C test wipe-cov
375 @make -C test checkstyle
378 $(call test,vpp,vpp,retest)
381 $(call test,vpp,vpp_debug,retest)
383 STARTUP_DIR ?= $(PWD)
384 ifeq ("$(wildcard $(STARTUP_CONF))","")
386 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
387 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
388 @cd $(STARTUP_DIR) && \
389 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) \
390 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
394 @cd $(STARTUP_DIR) && \
395 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') \
396 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
401 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
402 \( -not -path './build-root*' -o -path \
403 './build-root/build-vpp_debug-native/dpdk*' \) > $@
408 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
411 $(call run, $(BR)/install-$(PLATFORM)-native)
414 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
417 $(call make,$(PLATFORM)_coverity,install-packages)
420 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
423 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
426 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
429 $(call make,$(PLATFORM),install-deb)
435 make -C extras/rpm srpm
438 make -C dpdk install-$(PKG)
441 @ctags --totals --tag-relative -L $<
445 @gtags --gtagslabel=ctags
451 @build-root/scripts/checkstyle.sh
454 @build-root/scripts/checkstyle.sh --fix
457 # Build the documentation
460 # Doxygen configuration and our utility scripts
461 export DOXY_DIR ?= $(WS_ROOT)/doxygen
464 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
467 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
479 @echo "========================================================================"
481 @echo "========================================================================"
485 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
486 $(call banner,"Building for PLATFORM=vpp using gcc")
487 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
488 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
489 $(call banner,"Installing dependencies")
490 @sudo -E apt-get update
491 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
492 $(call banner,"Building for PLATFORM=vpp using clang")
493 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
495 $(call banner,"Building sample-plugin")
496 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
497 $(call banner,"Building $(PKG) packages")
499 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
500 @make COMPRESS_FAILED_TEST_LOGS=yes test