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 MINIMAL_STARTUP_CONF="unix { interactive }"
23 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
28 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
29 ifneq ($(shell uname),Darwin)
30 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
31 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
34 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
36 else ifeq ($(filter rhel centos fedora opensuse,$(OS_ID)),$(OS_ID))
40 DEB_DEPENDS = curl build-essential autoconf automake bison libssl-dev ccache
41 DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
42 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
43 DEB_DEPENDS += lcov chrpath autoconf nasm indent
44 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6
45 ifeq ($(OS_VERSION_ID),14.04)
46 DEB_DEPENDS += openjdk-8-jdk-headless
47 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
48 DEB_DEPENDS += openjdk-8-jdk-headless
49 APT_ARGS = -t jessie-backports
51 DEB_DEPENDS += default-jdk-headless
54 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
55 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
56 RPM_DEPENDS += python-devel
57 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
58 RPM_DEPENDS += python2-virtualenv
59 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
61 RPM_DEPENDS += python-virtualenv
62 RPM_DEPENDS_GROUPS = 'Development Tools'
64 RPM_DEPENDS += chrpath libffi-devel rpm-build
65 RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
66 EPEL_DEPENDS = libconfuse-devel ganglia-devel epel-rpm-macros
67 ifeq ($(filter rhel centos,$(OS_ID)),$(OS_ID))
73 RPM_SUSE_DEPENDS = autoconf automake bison ccache chrpath distribution-release gcc6 glibc-devel-static
74 RPM_SUSE_DEPENDS += java-1_8_0-openjdk-devel libopenssl-devel libtool lsb-release make openssl-devel
75 RPM_SUSE_DEPENDS += python-devel python-pip python-rpm-macros shadow
77 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
78 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
81 ifeq ($(findstring y,$(UNATTENDED)),y)
88 ifneq ($(SAMPLE_PLUGIN),no)
89 TARGETS += sample-plugin
92 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
93 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
95 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
96 .PHONY: test-cov test-wipe-cov
100 @echo " bootstrap - prepare tree for build"
101 @echo " install-dep - install software dependencies"
102 @echo " wipe - wipe all products of debug build "
103 @echo " wipe-release - wipe all products of release build "
104 @echo " build - build debug binaries"
105 @echo " build-release - build release binaries"
106 @echo " build-coverity - build coverity artifacts"
107 @echo " rebuild - wipe and build debug binares"
108 @echo " rebuild-release - wipe and build release binares"
109 @echo " run - run debug binary"
110 @echo " run-release - run release binary"
111 @echo " debug - run debug binary with debugger"
112 @echo " debug-release - run release binary with debugger"
113 @echo " test - build and run (basic) functional tests"
114 @echo " test-debug - build and run (basic) functional tests (debug build)"
115 @echo " test-all - build and run (all) functional tests"
116 @echo " test-all-debug - build and run (all) functional tests (debug build)"
117 @echo " test-shell - enter shell with test environment"
118 @echo " test-shell-debug - enter shell with test environment (debug build)"
119 @echo " test-wipe - wipe files generated by unit tests"
120 @echo " retest - run functional tests"
121 @echo " retest-debug - run functional tests (debug build)"
122 @echo " test-help - show help on test framework"
123 @echo " run-vat - run vpp-api-test tool"
124 @echo " pkg-deb - build DEB packages"
125 @echo " pkg-rpm - build RPM packages"
126 @echo " dpdk-install-dev - install DPDK development packages"
127 @echo " ctags - (re)generate ctags database"
128 @echo " gtags - (re)generate gtags database"
129 @echo " cscope - (re)generate cscope database"
130 @echo " checkstyle - check coding style"
131 @echo " fixstyle - fix coding style"
132 @echo " doxygen - (re)generate documentation"
133 @echo " bootstrap-doxygen - setup Doxygen dependencies"
134 @echo " wipe-doxygen - wipe all generated documentation"
135 @echo " test-doc - generate documentation for test framework"
136 @echo " test-wipe-doc - wipe documentation for test framework"
137 @echo " test-cov - generate code coverage report for test framework"
138 @echo " test-wipe-cov - wipe code coverage report for test framework"
139 @echo " test-checkstyle - check PEP8 compliance for test framework"
141 @echo "Make Arguments:"
142 @echo " V=[0|1] - set build verbosity level"
143 @echo " STARTUP_CONF=<path> - startup configuration file"
144 @echo " (e.g. /etc/vpp/startup.conf)"
145 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
146 @echo " It also sets STARTUP_CONF if"
147 @echo " startup.conf file is present"
148 @echo " GDB=<path> - gdb binary to use for debugging"
149 @echo " PLATFORM=<name> - target platform. default is vpp"
150 @echo " TEST=<filter> - apply filter to test set, see test-help"
151 @echo " SAMPLE_PLUGIN=yes - in addition build/run/debug sample plugin"
153 @echo "Current Argument Values:"
155 @echo " STARTUP_CONF = $(STARTUP_CONF)"
156 @echo " STARTUP_DIR = $(STARTUP_DIR)"
157 @echo " GDB = $(GDB)"
158 @echo " PLATFORM = $(PLATFORM)"
159 @echo " DPDK_VERSION = $(DPDK_VERSION)"
160 @echo " SAMPLE_PLUGIN = $(SAMPLE_PLUGIN)"
163 ifeq ($(findstring y,$(UNATTENDED)),y)
166 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
167 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
168 if [ -n "$$MISSING" ] ; then \
169 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
170 echo "by executing \"make install-dep\"\n" ; \
174 else ifneq ("$(wildcard /etc/redhat-release)","")
175 @for i in $(RPM_DEPENDS) $(EPEL_DEPENDS) ; do \
176 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
177 if [[ "$$RPM" =~ "epel-release-latest" ]] ; then \
178 MISSING+=$$(rpm -q epel-release | grep "^package") ; \
180 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
183 if [ -n "$$MISSING" ] ; then \
184 echo "Please install missing RPMs: \n$$MISSING\n" ; \
185 echo "by executing \"make install-dep\"\n" ; \
190 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
191 @echo "#!/bin/bash\n" > $(BR)/path_setup
192 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
193 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
194 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
196 ifeq ("$(wildcard /usr/bin/ccache )","")
197 @echo "WARNING: Please install ccache AYEC and re-run this script"
199 @rm -rf $(BR)/tools/ccache-bin
200 @mkdir -p $(BR)/tools/ccache-bin
201 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
202 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
204 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
207 bootstrap: $(BR)/.bootstrap.ok
210 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
211 ifeq ($(OS_VERSION_ID),14.04)
212 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
213 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
215 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
216 @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
217 || ( echo "Please install jessie-backports" ; exit 1 )
219 @sudo -E apt-get update
220 @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
221 else ifneq ("$(wildcard /etc/redhat-release)","")
222 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
223 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
224 @sudo -E yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
225 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
226 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
227 @sudo -E zypper -n install -y $(RPM_SUSE_DEPENDS)
229 $(error "This option currently works only on Ubuntu, Debian or Centos systems")
233 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
236 $(BR)/scripts/.version:
237 ifneq ("$(wildcard /etc/redhat-release)","")
238 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
240 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
243 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
244 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
248 --prefix=$(DIST_SUBDIR)/ \
252 @git describe > $(BR)/.version
254 --file $(DIST_FILE) \
255 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
257 @$(RM) $(BR)/.version $(DIST_FILE).xz
258 @xz -v --threads=0 $(DIST_FILE)
259 @$(RM) $(BR)/vpp-latest.tar.xz
260 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
262 build: $(BR)/.bootstrap.ok
263 $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
266 @$(RM) $(BR)/*.tar.xz
268 wipe: wipedist $(BR)/.bootstrap.ok
269 $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
273 build-release: $(BR)/.bootstrap.ok
274 $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
276 wipe-release: $(BR)/.bootstrap.ok
277 $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
279 rebuild-release: wipe-release build-release
281 export VPP_PYTHON_PREFIX=$(BR)/python
283 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
286 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
287 $(eval libs:=lib lib64)
289 TEST_DIR=$(WS_ROOT)/test \
290 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
291 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
292 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
293 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
294 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
295 EXTENDED_TESTS=$(EXTENDED_TESTS) \
301 $(call test,vpp,vpp,test)
303 test-debug: bootstrap
304 $(call test,vpp,vpp_debug,test)
307 $(eval EXTENDED_TESTS=yes)
308 $(call test,vpp,vpp,test)
310 test-all-debug: bootstrap
311 $(eval EXTENDED_TESTS=yes)
312 $(call test,vpp,vpp_debug,test)
320 test-shell: bootstrap
321 $(call test,vpp,vpp,shell)
323 test-shell-debug: bootstrap
324 $(call test,vpp,vpp_debug,shell)
330 @make -C test wipe-doc
333 $(eval EXTENDED_TESTS=yes)
334 $(call test,vpp,vpp_gcov,cov)
337 @make -C test wipe-cov
340 @make -C test checkstyle
343 $(call test,vpp,vpp,retest)
346 $(call test,vpp,vpp_debug,retest)
348 STARTUP_DIR ?= $(PWD)
349 ifeq ("$(wildcard $(STARTUP_CONF))","")
351 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
352 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
353 @cd $(STARTUP_DIR) && \
354 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) \
355 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
359 @cd $(STARTUP_DIR) && \
360 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') \
361 plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
366 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
367 \( -not -path './build-root*' -o -path \
368 './build-root/build-vpp_debug-native/dpdk*' \) > $@
373 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
376 $(call run, $(BR)/install-$(PLATFORM)-native)
379 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
382 $(call make,$(PLATFORM)_coverity,install-packages)
385 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
388 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
391 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
394 $(call make,$(PLATFORM),install-deb)
400 make -C dpdk install-$(PKG)
403 @ctags --totals --tag-relative -L $<
407 @gtags --gtagslabel=ctags
413 @build-root/scripts/checkstyle.sh
416 @build-root/scripts/checkstyle.sh --fix
419 # Build the documentation
422 # Doxygen configuration and our utility scripts
423 export DOXY_DIR ?= $(WS_ROOT)/doxygen
426 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
429 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
441 @echo "========================================================================"
443 @echo "========================================================================"
447 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
448 $(call banner,"Building for PLATFORM=vpp using gcc")
449 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
450 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
451 $(call banner,"Installing dependencies")
452 @sudo -E apt-get update
453 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
454 $(call banner,"Building for PLATFORM=vpp using clang")
455 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
457 $(call banner,"Building sample-plugin")
458 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
459 $(call banner,"Building $(PKG) packages")
461 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)