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 += openssl-devel
76 RPM_DEPENDS += numactl-devel
77 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
78 RPM_DEPENDS += python-devel
79 RPM_DEPENDS += python2-virtualenv
80 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
81 else ifeq ($(shell if [ "$(OS_VERSION_ID)" -gt "25" ] ; then echo "y" ; fi),"y")
82 RPM_DEPENDS += python2-devel
83 RPM_DEPENDS += python2-virtualenv
84 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
86 RPM_DEPENDS += python-devel
87 RPM_DEPENDS += python-virtualenv
88 RPM_DEPENDS_GROUPS = 'Development Tools'
91 # +ganglia-devel if building the ganglia plugin
93 RPM_DEPENDS += chrpath libffi-devel rpm-build
94 ifeq ($(OS_ID),fedora)
97 RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
100 RPM_SUSE_DEPENDS = autoconf automake bison ccache chrpath distribution-release gcc6 glibc-devel-static
101 RPM_SUSE_DEPENDS += java-1_8_0-openjdk-devel libopenssl-devel libtool lsb-release make openssl-devel
102 RPM_SUSE_DEPENDS += python-devel python-pip python-rpm-macros shadow nasm libnuma-devel
104 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
105 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
108 ifeq ($(findstring y,$(UNATTENDED)),y)
115 ifneq ($(SAMPLE_PLUGIN),no)
116 TARGETS += sample-plugin
119 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
120 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
122 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
123 .PHONY: test-cov test-wipe-cov
126 @echo "Make Targets:"
127 @echo " bootstrap - prepare tree for build"
128 @echo " install-dep - install software dependencies"
129 @echo " wipe - wipe all products of debug build "
130 @echo " wipe-release - wipe all products of release build "
131 @echo " build - build debug binaries"
132 @echo " build-release - build release binaries"
133 @echo " build-coverity - build coverity artifacts"
134 @echo " rebuild - wipe and build debug binares"
135 @echo " rebuild-release - wipe and build release binares"
136 @echo " run - run debug binary"
137 @echo " run-release - run release binary"
138 @echo " debug - run debug binary with debugger"
139 @echo " debug-release - run release binary with debugger"
140 @echo " test - build and run (basic) functional tests"
141 @echo " test-debug - build and run (basic) functional tests (debug build)"
142 @echo " test-all - build and run (all) functional tests"
143 @echo " test-all-debug - build and run (all) functional tests (debug build)"
144 @echo " test-shell - enter shell with test environment"
145 @echo " test-shell-debug - enter shell with test environment (debug build)"
146 @echo " test-wipe - wipe files generated by unit tests"
147 @echo " retest - run functional tests"
148 @echo " retest-debug - run functional tests (debug build)"
149 @echo " test-help - show help on test framework"
150 @echo " run-vat - run vpp-api-test tool"
151 @echo " pkg-deb - build DEB packages"
152 @echo " pkg-rpm - build RPM packages"
153 @echo " dpdk-install-dev - install DPDK development packages"
154 @echo " ctags - (re)generate ctags database"
155 @echo " gtags - (re)generate gtags database"
156 @echo " cscope - (re)generate cscope database"
157 @echo " checkstyle - check coding style"
158 @echo " fixstyle - fix coding style"
159 @echo " doxygen - (re)generate documentation"
160 @echo " bootstrap-doxygen - setup Doxygen dependencies"
161 @echo " wipe-doxygen - wipe all generated documentation"
162 @echo " test-doc - generate documentation for test framework"
163 @echo " test-wipe-doc - wipe documentation for test framework"
164 @echo " test-cov - generate code coverage report for test framework"
165 @echo " test-wipe-cov - wipe code coverage report for test framework"
166 @echo " test-checkstyle - check PEP8 compliance for test framework"
168 @echo "Make Arguments:"
169 @echo " V=[0|1] - set build verbosity level"
170 @echo " STARTUP_CONF=<path> - startup configuration file"
171 @echo " (e.g. /etc/vpp/startup.conf)"
172 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
173 @echo " It also sets STARTUP_CONF if"
174 @echo " startup.conf file is present"
175 @echo " GDB=<path> - gdb binary to use for debugging"
176 @echo " PLATFORM=<name> - target platform. default is vpp"
177 @echo " TEST=<filter> - apply filter to test set, see test-help"
178 @echo " DPDK_CONFIG=<conf> - add specified dpdk config commands to"
179 @echo " autogenerated startup.conf"
180 @echo " (e.g. \"no-pci\" )"
181 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
182 @echo " DISABLED_PLUGINS=<list> - comma separated list of plugins which"
183 @echo " should not be loaded"
185 @echo "Current Argument Values:"
187 @echo " STARTUP_CONF = $(STARTUP_CONF)"
188 @echo " STARTUP_DIR = $(STARTUP_DIR)"
189 @echo " GDB = $(GDB)"
190 @echo " PLATFORM = $(PLATFORM)"
191 @echo " DPDK_VERSION = $(DPDK_VERSION)"
192 @echo " DPDK_CONFIG = $(DPDK_CONFIG)"
193 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
194 @echo " DISABLED_PLUGINS = $(DISABLED_PLUGINS)"
197 ifeq ($(findstring y,$(UNATTENDED)),y)
200 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
201 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
202 if [ -n "$$MISSING" ] ; then \
203 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
204 echo "by executing \"make install-dep\"\n" ; \
208 else ifneq ("$(wildcard /etc/redhat-release)","")
209 @for i in $(RPM_DEPENDS) ; do \
210 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
211 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
213 if [ -n "$$MISSING" ] ; then \
214 echo "Please install missing RPMs: \n$$MISSING\n" ; \
215 echo "by executing \"make install-dep\"\n" ; \
220 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
221 @echo "#!/bin/bash\n" > $(BR)/path_setup
222 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
223 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
224 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
226 ifeq ("$(wildcard /usr/bin/ccache )","")
227 @echo "WARNING: Please install ccache AYEC and re-run this script"
229 @rm -rf $(BR)/tools/ccache-bin
230 @mkdir -p $(BR)/tools/ccache-bin
231 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
232 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
234 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
237 bootstrap: $(BR)/.bootstrap.ok
240 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
241 ifeq ($(OS_VERSION_ID),14.04)
242 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
243 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
245 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
246 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
247 || ( echo "Please install jessie-backports" ; exit 1 )
249 @sudo -E apt-get update
250 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
251 else ifneq ("$(wildcard /etc/redhat-release)","")
252 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
253 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
254 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
255 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
256 @sudo -E zypper -n install -y $(RPM_SUSE_DEPENDS)
258 $(error "This option currently works only on Ubuntu, Debian or Centos systems")
262 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
265 $(BR)/scripts/.version:
266 ifneq ("$(wildcard /etc/redhat-release)","")
267 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
269 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
272 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
273 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
276 @if git rev-parse 2> /dev/null ; then \
278 --prefix=$(DIST_SUBDIR)/ \
282 git describe > $(BR)/.version ; \
284 (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
285 src/scripts/version > $(BR)/.version ; \
288 --file $(DIST_FILE) \
289 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
291 @$(RM) $(BR)/.version $(DIST_FILE).xz
292 @xz -v --threads=0 $(DIST_FILE)
293 @$(RM) $(BR)/vpp-latest.tar.xz
294 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
296 build: $(BR)/.bootstrap.ok
297 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
300 @$(RM) $(BR)/*.tar.xz
302 wipe: wipedist $(BR)/.bootstrap.ok
303 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
307 build-release: $(BR)/.bootstrap.ok
308 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
310 wipe-release: $(BR)/.bootstrap.ok
311 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
313 rebuild-release: wipe-release build-release
315 export VPP_PYTHON_PREFIX=$(BR)/python
317 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
320 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
321 $(eval libs:=lib lib64)
323 TEST_DIR=$(WS_ROOT)/test \
324 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
325 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
326 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
327 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
328 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
329 EXTENDED_TESTS=$(EXTENDED_TESTS) \
335 $(call test,vpp,vpp,test)
337 test-debug: bootstrap
338 $(call test,vpp,vpp_debug,test)
341 $(eval EXTENDED_TESTS=yes)
342 $(call test,vpp,vpp,test)
344 test-all-debug: bootstrap
345 $(eval EXTENDED_TESTS=yes)
346 $(call test,vpp,vpp_debug,test)
354 test-shell: bootstrap
355 $(call test,vpp,vpp,shell)
357 test-shell-debug: bootstrap
358 $(call test,vpp,vpp_debug,shell)
364 @make -C test wipe-doc
367 $(eval EXTENDED_TESTS=yes)
368 $(call test,vpp,vpp_gcov,cov)
371 @make -C test wipe-cov
374 @make -C test checkstyle
377 $(call test,vpp,vpp,retest)
380 $(call test,vpp,vpp_debug,retest)
382 STARTUP_DIR ?= $(PWD)
383 ifeq ("$(wildcard $(STARTUP_CONF))","")
385 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
386 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
387 @cd $(STARTUP_DIR) && \
388 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) \
389 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
393 @cd $(STARTUP_DIR) && \
394 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') \
395 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
400 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
401 \( -not -path './build-root*' -o -path \
402 './build-root/build-vpp_debug-native/dpdk*' \) > $@
407 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
410 $(call run, $(BR)/install-$(PLATFORM)-native)
413 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
416 $(call make,$(PLATFORM)_coverity,install-packages)
419 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
422 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
425 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
428 $(call make,$(PLATFORM),install-deb)
434 make -C extras/rpm srpm
437 make -C dpdk install-$(PKG)
440 @ctags --totals --tag-relative -L $<
444 @gtags --gtagslabel=ctags
450 @build-root/scripts/checkstyle.sh
453 @build-root/scripts/checkstyle.sh --fix
456 # Build the documentation
459 # Doxygen configuration and our utility scripts
460 export DOXY_DIR ?= $(WS_ROOT)/doxygen
463 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
466 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
478 @echo "========================================================================"
480 @echo "========================================================================"
484 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
485 $(call banner,"Building for PLATFORM=vpp using gcc")
486 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
487 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
488 $(call banner,"Installing dependencies")
489 @sudo -E apt-get update
490 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
491 $(call banner,"Building for PLATFORM=vpp using clang")
492 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
494 $(call banner,"Building sample-plugin")
495 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
496 $(call banner,"Building $(PKG) packages")
498 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
499 @make COMPRESS_FAILED_TEST_LOGS=yes test