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 MINIMAL_STARTUP_CONF="unix { interactive }"
22 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
27 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
28 ifneq ($(shell uname),Darwin)
29 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
30 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
33 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
35 else ifeq ($(filter rhel centos fedora,$(OS_ID)),$(OS_ID))
39 DEB_DEPENDS = curl build-essential autoconf automake bison libssl-dev ccache
40 DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
41 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
42 DEB_DEPENDS += lcov chrpath autoconf nasm indent
43 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6
44 ifeq ($(OS_VERSION_ID),14.04)
45 DEB_DEPENDS += openjdk-8-jdk-headless
47 DEB_DEPENDS += default-jdk-headless
50 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
51 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
52 RPM_DEPENDS += python-devel
53 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
54 RPM_DEPENDS += python2-virtualenv
55 RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
57 RPM_DEPENDS += python-virtualenv
58 RPM_DEPENDS_GROUPS = 'Development Tools'
60 RPM_DEPENDS += chrpath libffi-devel rpm-build
61 RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
62 EPEL_DEPENDS = libconfuse-devel ganglia-devel epel-rpm-macros
63 ifeq ($(filter rhel centos,$(OS_ID)),$(OS_ID))
69 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
70 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
73 ifeq ($(findstring y,$(UNATTENDED)),y)
78 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
79 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
81 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
82 .PHONY: test-cov test-wipe-cov
86 @echo " bootstrap - prepare tree for build"
87 @echo " install-dep - install software dependencies"
88 @echo " wipe - wipe all products of debug build "
89 @echo " wipe-release - wipe all products of release build "
90 @echo " build - build debug binaries"
91 @echo " build-release - build release binaries"
92 @echo " build-coverity - build coverity artifacts"
93 @echo " rebuild - wipe and build debug binares"
94 @echo " rebuild-release - wipe and build release binares"
95 @echo " run - run debug binary"
96 @echo " run-release - run release binary"
97 @echo " debug - run debug binary with debugger"
98 @echo " debug-release - run release binary with debugger"
99 @echo " test - build and run (basic) functional tests"
100 @echo " test-debug - build and run (basic) functional tests (debug build)"
101 @echo " test-all - build and run (all) functional tests"
102 @echo " test-all-debug - build and run (all) functional tests (debug build)"
103 @echo " test-shell - enter shell with test environment"
104 @echo " test-shell-debug - enter shell with test environment (debug build)"
105 @echo " test-wipe - wipe files generated by unit tests"
106 @echo " retest - run functional tests"
107 @echo " retest-debug - run functional tests (debug build)"
108 @echo " test-help - show help on test framework"
109 @echo " run-vat - run vpp-api-test tool"
110 @echo " pkg-deb - build DEB packages"
111 @echo " pkg-rpm - build RPM packages"
112 @echo " dpdk-install-dev - install DPDK development packages"
113 @echo " ctags - (re)generate ctags database"
114 @echo " gtags - (re)generate gtags database"
115 @echo " cscope - (re)generate cscope database"
116 @echo " checkstyle - check coding style"
117 @echo " fixstyle - fix coding style"
118 @echo " doxygen - (re)generate documentation"
119 @echo " bootstrap-doxygen - setup Doxygen dependencies"
120 @echo " wipe-doxygen - wipe all generated documentation"
121 @echo " test-doc - generate documentation for test framework"
122 @echo " test-wipe-doc - wipe documentation for test framework"
123 @echo " test-cov - generate code coverage report for test framework"
124 @echo " test-wipe-cov - wipe code coverage report for test framework"
125 @echo " test-checkstyle - check PEP8 compliance for test framework"
127 @echo "Make Arguments:"
128 @echo " V=[0|1] - set build verbosity level"
129 @echo " STARTUP_CONF=<path> - startup configuration file"
130 @echo " (e.g. /etc/vpp/startup.conf)"
131 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
132 @echo " It also sets STARTUP_CONF if"
133 @echo " startup.conf file is present"
134 @echo " GDB=<path> - gdb binary to use for debugging"
135 @echo " PLATFORM=<name> - target platform. default is vpp"
136 @echo " TEST=<filter> - apply filter to test set, see test-help"
138 @echo "Current Argument Values:"
140 @echo " STARTUP_CONF = $(STARTUP_CONF)"
141 @echo " STARTUP_DIR = $(STARTUP_DIR)"
142 @echo " GDB = $(GDB)"
143 @echo " PLATFORM = $(PLATFORM)"
144 @echo " DPDK_VERSION = $(DPDK_VERSION)"
147 ifeq ($(findstring y,$(UNATTENDED)),y)
150 ifeq ($(OS_ID),ubuntu)
151 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
152 if [ -n "$$MISSING" ] ; then \
153 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
154 echo "by executing \"make install-dep\"\n" ; \
158 else ifneq ("$(wildcard /etc/redhat-release)","")
159 @for i in $(RPM_DEPENDS) $(EPEL_DEPENDS) ; do \
160 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
161 if [[ "$$RPM" =~ "epel-release-latest" ]] ; then \
162 MISSING+=$$(rpm -q epel-release | grep "^package") ; \
164 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
167 if [ -n "$$MISSING" ] ; then \
168 echo "Please install missing RPMs: \n$$MISSING\n" ; \
169 echo "by executing \"make install-dep\"\n" ; \
174 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
175 @echo "#!/bin/bash\n" > $(BR)/path_setup
176 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
177 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
178 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
180 ifeq ("$(wildcard /usr/bin/ccache )","")
181 @echo "WARNING: Please install ccache AYEC and re-run this script"
183 @rm -rf $(BR)/tools/ccache-bin
184 @mkdir -p $(BR)/tools/ccache-bin
185 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
186 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
188 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
191 bootstrap: $(BR)/.bootstrap.ok
194 ifeq ($(OS_ID),ubuntu)
195 ifeq ($(OS_VERSION_ID),14.04)
196 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
197 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
199 @sudo -E apt-get update
200 @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
201 else ifneq ("$(wildcard /etc/redhat-release)","")
202 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
203 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
204 @sudo -E yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
205 @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
207 $(error "This option currently works only on Ubuntu or Centos systems")
211 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
214 $(BR)/scripts/.version:
215 ifneq ("$(wildcard /etc/redhat-release)","")
216 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
218 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
221 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
222 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
226 --prefix=$(DIST_SUBDIR)/ \
230 @git describe > $(BR)/.version
232 --file $(DIST_FILE) \
233 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
235 @$(RM) $(BR)/.version $(DIST_FILE).xz
236 @xz -v --threads=0 $(DIST_FILE)
237 @$(RM) $(BR)/vpp-latest.tar.xz
238 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
240 build: $(BR)/.bootstrap.ok
241 $(call make,$(PLATFORM)_debug,vpp-install)
244 @$(RM) $(BR)/*.tar.xz
246 wipe: wipedist $(BR)/.bootstrap.ok
247 $(call make,$(PLATFORM)_debug,vpp-wipe)
251 build-release: $(BR)/.bootstrap.ok
252 $(call make,$(PLATFORM),vpp-install)
254 wipe-release: $(BR)/.bootstrap.ok
255 $(call make,$(PLATFORM),vpp-wipe)
257 rebuild-release: wipe-release build-release
259 export VPP_PYTHON_PREFIX=$(BR)/python
261 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
264 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
265 $(eval libs:=lib lib64)
267 TEST_DIR=$(WS_ROOT)/test \
268 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
269 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
270 VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
271 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
272 LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
273 EXTENDED_TESTS=$(EXTENDED_TESTS) \
279 $(call test,vpp,vpp,test)
281 test-debug: bootstrap
282 $(call test,vpp,vpp_debug,test)
285 $(eval EXTENDED_TESTS=yes)
286 $(call test,vpp,vpp,test)
288 test-all-debug: bootstrap
289 $(eval EXTENDED_TESTS=yes)
290 $(call test,vpp,vpp_debug,test)
298 test-shell: bootstrap
299 $(call test,vpp,vpp,shell)
301 test-shell-debug: bootstrap
302 $(call test,vpp,vpp_debug,shell)
308 @make -C test wipe-doc
311 $(eval EXTENDED_TESTS=yes)
312 $(call test,vpp,vpp_gcov,cov)
315 @make -C test wipe-cov
318 @make -C test checkstyle
321 $(call test,vpp,vpp,retest)
324 $(call test,vpp,vpp_debug,retest)
326 STARTUP_DIR ?= $(PWD)
327 ifeq ("$(wildcard $(STARTUP_CONF))","")
329 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
330 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
331 @cd $(STARTUP_DIR) && \
332 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(wildcard $(1)/vpp/lib*/vpp_plugins)
336 @cd $(STARTUP_DIR) && \
337 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(wildcard $(1)/vpp/lib*/vpp_plugins)
342 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
343 \( -not -path './build-root*' -o -path \
344 './build-root/build-vpp_debug-native/dpdk*' \) > $@
349 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
352 $(call run, $(BR)/install-$(PLATFORM)-native)
355 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
358 $(call make,$(PLATFORM)_coverity,install-packages)
361 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
364 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
367 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
370 $(call make,$(PLATFORM),install-deb)
376 make -C dpdk install-$(PKG)
379 @ctags --totals --tag-relative -L $<
383 @gtags --gtagslabel=ctags
389 @build-root/scripts/checkstyle.sh
392 @build-root/scripts/checkstyle.sh --fix
395 # Build the documentation
398 # Doxygen configuration and our utility scripts
399 export DOXY_DIR ?= $(WS_ROOT)/doxygen
402 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
405 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
417 @echo "========================================================================"
419 @echo "========================================================================"
423 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
424 $(call banner,"Building for PLATFORM=vpp using gcc")
425 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
426 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
427 $(call banner,"Installing dependencies")
428 @sudo -E apt-get update
429 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
430 $(call banner,"Building for PLATFORM=vpp using clang")
431 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
433 $(call banner,"Building sample-plugin")
434 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
435 $(call banner,"Building $(PKG) packages")
437 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)