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
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_GROUPS = 'Development Tools'
51 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
52 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
53 RPM_DEPENDS += python-devel
54 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
55 RPM_DEPENDS += python2-virtualenv
57 RPM_DEPENDS += python-virtualenv
59 RPM_DEPENDS += chrpath libffi-devel
60 RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
61 EPEL_DEPENDS = libconfuse-devel ganglia-devel epel-rpm-macros
62 ifeq ($(OS_ID),centos)
68 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
69 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
72 ifeq ($(findstring y,$(UNATTENDED)),y)
77 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
78 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
80 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
81 .PHONY: test-cov test-wipe-cov
85 @echo " bootstrap - prepare tree for build"
86 @echo " install-dep - install software dependencies"
87 @echo " wipe - wipe all products of debug build "
88 @echo " wipe-release - wipe all products of release build "
89 @echo " build - build debug binaries"
90 @echo " build-release - build release binaries"
91 @echo " build-coverity - build coverity artifacts"
92 @echo " rebuild - wipe and build debug binares"
93 @echo " rebuild-release - wipe and build release binares"
94 @echo " run - run debug binary"
95 @echo " run-release - run release binary"
96 @echo " debug - run debug binary with debugger"
97 @echo " debug-release - run release binary with debugger"
98 @echo " test - build and run (basic) functional tests"
99 @echo " test-debug - build and run (basic) functional tests (debug build)"
100 @echo " test-all - build and run (all) functional tests"
101 @echo " test-all-debug - build and run (all) functional tests (debug build)"
102 @echo " test-shell - enter shell with test environment"
103 @echo " test-shell-debug - enter shell with test environment (debug build)"
104 @echo " test-wipe - wipe files generated by unit tests"
105 @echo " retest - run functional tests"
106 @echo " retest-debug - run functional tests (debug build)"
107 @echo " test-help - show help on test framework"
108 @echo " run-vat - run vpp-api-test tool"
109 @echo " pkg-deb - build DEB packages"
110 @echo " pkg-rpm - build RPM packages"
111 @echo " dpdk-install-dev - install DPDK development packages"
112 @echo " ctags - (re)generate ctags database"
113 @echo " gtags - (re)generate gtags database"
114 @echo " cscope - (re)generate cscope database"
115 @echo " checkstyle - check coding style"
116 @echo " fixstyle - fix coding style"
117 @echo " doxygen - (re)generate documentation"
118 @echo " bootstrap-doxygen - setup Doxygen dependencies"
119 @echo " wipe-doxygen - wipe all generated documentation"
120 @echo " test-doc - generate documentation for test framework"
121 @echo " test-wipe-doc - wipe documentation for test framework"
122 @echo " test-cov - generate code coverage report for test framework"
123 @echo " test-wipe-cov - wipe code coverage report for test framework"
124 @echo " test-checkstyle - check PEP8 compliance for test framework"
126 @echo "Make Arguments:"
127 @echo " V=[0|1] - set build verbosity level"
128 @echo " STARTUP_CONF=<path> - startup configuration file"
129 @echo " (e.g. /etc/vpp/startup.conf)"
130 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
131 @echo " It also sets STARTUP_CONF if"
132 @echo " startup.conf file is present"
133 @echo " GDB=<path> - gdb binary to use for debugging"
134 @echo " PLATFORM=<name> - target platform. default is vpp"
135 @echo " TEST=<filter> - apply filter to test set, see test-help"
137 @echo "Current Argument Values:"
139 @echo " STARTUP_CONF = $(STARTUP_CONF)"
140 @echo " STARTUP_DIR = $(STARTUP_DIR)"
141 @echo " GDB = $(GDB)"
142 @echo " PLATFORM = $(PLATFORM)"
143 @echo " DPDK_VERSION = $(DPDK_VERSION)"
146 ifeq ($(findstring y,$(UNATTENDED)),y)
149 ifeq ($(OS_ID),ubuntu)
150 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
151 if [ -n "$$MISSING" ] ; then \
152 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
153 echo "by executing \"make install-dep\"\n" ; \
157 else ifneq ("$(wildcard /etc/redhat-release)","")
158 @for i in $(RPM_DEPENDS) $(EPEL_DEPENDS) ; do \
159 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
160 if [[ "$$RPM" =~ "epel-release-latest" ]] ; then \
161 MISSING+=$$(rpm -q epel-release | grep "^package") ; \
163 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
166 if [ -n "$$MISSING" ] ; then \
167 echo "Please install missing RPMs: \n$$MISSING\n" ; \
168 echo "by executing \"make install-dep\"\n" ; \
173 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
174 @echo "#!/bin/bash\n" > $(BR)/path_setup
175 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
176 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
177 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
179 ifeq ("$(wildcard /usr/bin/ccache )","")
180 @echo "WARNING: Please install ccache AYEC and re-run this script"
182 @rm -rf $(BR)/tools/ccache-bin
183 @mkdir -p $(BR)/tools/ccache-bin
184 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
185 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
187 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
190 bootstrap: $(BR)/.bootstrap.ok
193 ifeq ($(OS_ID),ubuntu)
194 ifeq ($(OS_VERSION_ID),14.04)
195 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
196 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
198 @sudo -E apt-get update
199 @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
200 else ifneq ("$(wildcard /etc/redhat-release)","")
201 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
202 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
203 @sudo -E yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
204 @sudo -E debuginfo-install $(CONFIRM) glibc-2.17-106.el7_2.4.x86_64 openssl-libs-1.0.1e-51.el7_2.4.x86_64 zlib-1.2.7-15.el7.x86_64
206 $(error "This option currently works only on Ubuntu or Centos systems")
210 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
213 $(BR)/scripts/.version:
214 ifneq ("$(wildcard /etc/redhat-release)","")
215 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
217 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
220 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
221 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
225 --prefix=$(DIST_SUBDIR)/ \
229 @git describe > $(BR)/.version
231 --file $(DIST_FILE) \
232 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
234 @$(RM) $(BR)/.version $(DIST_FILE).xz
235 @xz -v --threads=0 $(DIST_FILE)
236 @$(RM) $(BR)/vpp-latest.tar.xz
237 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
239 build: $(BR)/.bootstrap.ok
240 $(call make,$(PLATFORM)_debug,vpp-install)
243 @$(RM) $(BR)/*.tar.xz
245 wipe: wipedist $(BR)/.bootstrap.ok
246 $(call make,$(PLATFORM)_debug,vpp-wipe)
250 build-release: $(BR)/.bootstrap.ok
251 $(call make,$(PLATFORM),vpp-install)
253 wipe-release: $(BR)/.bootstrap.ok
254 $(call make,$(PLATFORM),vpp-wipe)
256 rebuild-release: wipe-release build-release
258 export VPP_PYTHON_PREFIX=$(BR)/python
261 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
263 TEST_DIR=$(WS_ROOT)/test \
264 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
265 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
266 VPP_TEST_PLUGIN_PATH=$(BR)/install-$(2)-native/vpp/lib64/vpp_plugins \
267 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
268 LD_LIBRARY_PATH=$(BR)/install-$(2)-native/vpp/lib64/ \
269 EXTENDED_TESTS=$(EXTENDED_TESTS) \
275 $(call test,vpp,vpp,test)
277 test-debug: bootstrap
278 $(call test,vpp,vpp_debug,test)
281 $(eval EXTENDED_TESTS=yes)
282 $(call test,vpp,vpp,test)
284 test-all-debug: bootstrap
285 $(eval EXTENDED_TESTS=yes)
286 $(call test,vpp,vpp_debug,test)
294 test-shell: bootstrap
295 $(call test,vpp,vpp,shell)
297 test-shell-debug: bootstrap
298 $(call test,vpp,vpp_debug,shell)
304 @make -C test wipe-doc
307 $(eval EXTENDED_TESTS=yes)
308 $(call test,vpp,vpp_gcov,cov)
311 @make -C test wipe-cov
314 @make -C test checkstyle
317 $(call test,vpp,vpp,retest)
320 $(call test,vpp,vpp_debug,retest)
322 STARTUP_DIR ?= $(PWD)
323 ifeq ("$(wildcard $(STARTUP_CONF))","")
325 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
326 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
327 @cd $(STARTUP_DIR) && \
328 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/vpp/lib64/vpp_plugins
332 @cd $(STARTUP_DIR) && \
333 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/vpp/lib64/vpp_plugins
338 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
339 \( -not -path './build-root*' -o -path \
340 './build-root/build-vpp_debug-native/dpdk*' \) > $@
345 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
348 $(call run, $(BR)/install-$(PLATFORM)-native)
351 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
354 $(call make,$(PLATFORM)_coverity,install-packages)
357 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
360 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
363 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
366 $(call make,$(PLATFORM),install-deb)
372 make -C dpdk install-$(PKG)
375 @ctags --totals --tag-relative -L $<
379 @gtags --gtagslabel=ctags
385 @build-root/scripts/checkstyle.sh
388 @build-root/scripts/checkstyle.sh --fix
391 # Build the documentation
394 # Doxygen configuration and our utility scripts
395 export DOXY_DIR ?= $(WS_ROOT)/doxygen
398 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
401 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
413 @echo "========================================================================"
415 @echo "========================================================================"
419 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
420 $(call banner,"Building for PLATFORM=vpp using gcc")
421 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
422 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
423 $(call banner,"Installing dependencies")
424 @sudo -E apt-get update
425 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
426 $(call banner,"Building for PLATFORM=vpp using clang")
427 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
429 $(call banner,"Building sample-plugin")
430 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
431 $(call banner,"Building $(PKG) packages")