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 += lcov 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
63 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
64 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
67 ifeq ($(findstring y,$(UNATTENDED)),y)
72 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
73 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
75 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
76 .PHONY: test-cov test-wipe-cov
80 @echo " bootstrap - prepare tree for build"
81 @echo " install-dep - install software dependencies"
82 @echo " wipe - wipe all products of debug build "
83 @echo " wipe-release - wipe all products of release build "
84 @echo " build - build debug binaries"
85 @echo " build-release - build release binaries"
86 @echo " build-coverity - build coverity artifacts"
87 @echo " rebuild - wipe and build debug binares"
88 @echo " rebuild-release - wipe and build release binares"
89 @echo " run - run debug binary"
90 @echo " run-release - run release binary"
91 @echo " debug - run debug binary with debugger"
92 @echo " debug-release - run release binary with debugger"
93 @echo " test - build and run (basic) functional tests"
94 @echo " test-debug - build and run (basic) functional tests (debug build)"
95 @echo " test-all - build and run (all) functional tests"
96 @echo " test-all-debug - build and run (all) functional tests (debug build)"
97 @echo " test-shell - enter shell with test environment"
98 @echo " test-shell-debug - enter shell with test environment (debug build)"
99 @echo " test-wipe - wipe files generated by unit tests"
100 @echo " retest - run functional tests"
101 @echo " retest-debug - run functional tests (debug build)"
102 @echo " test-help - show help on test framework"
103 @echo " run-vat - run vpp-api-test tool"
104 @echo " pkg-deb - build DEB packages"
105 @echo " pkg-rpm - build RPM packages"
106 @echo " dpdk-install-dev - install DPDK development packages"
107 @echo " ctags - (re)generate ctags database"
108 @echo " gtags - (re)generate gtags database"
109 @echo " cscope - (re)generate cscope database"
110 @echo " checkstyle - check coding style"
111 @echo " fixstyle - fix coding style"
112 @echo " doxygen - (re)generate documentation"
113 @echo " bootstrap-doxygen - setup Doxygen dependencies"
114 @echo " wipe-doxygen - wipe all generated documentation"
115 @echo " test-doc - generate documentation for test framework"
116 @echo " test-wipe-doc - wipe documentation for test framework"
117 @echo " test-cov - generate code coverage report for test framework"
118 @echo " test-wipe-cov - wipe code coverage report for test framework"
119 @echo " test-checkstyle - check PEP8 compliance for test framework"
121 @echo "Make Arguments:"
122 @echo " V=[0|1] - set build verbosity level"
123 @echo " STARTUP_CONF=<path> - startup configuration file"
124 @echo " (e.g. /etc/vpp/startup.conf)"
125 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
126 @echo " It also sets STARTUP_CONF if"
127 @echo " startup.conf file is present"
128 @echo " GDB=<path> - gdb binary to use for debugging"
129 @echo " PLATFORM=<name> - target platform. default is vpp"
130 @echo " TEST=<filter> - apply filter to test set, see test-help"
132 @echo "Current Argument Values:"
134 @echo " STARTUP_CONF = $(STARTUP_CONF)"
135 @echo " STARTUP_DIR = $(STARTUP_DIR)"
136 @echo " GDB = $(GDB)"
137 @echo " PLATFORM = $(PLATFORM)"
138 @echo " DPDK_VERSION = $(DPDK_VERSION)"
141 ifeq ($(findstring y,$(UNATTENDED)),y)
144 ifeq ($(OS_ID),ubuntu)
145 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
146 if [ -n "$$MISSING" ] ; then \
147 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
148 echo "by executing \"make install-dep\"\n" ; \
152 else ifneq ("$(wildcard /etc/redhat-release)","")
153 @for i in $(RPM_DEPENDS) $(EPEL_DEPENDS) ; do \
154 RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
155 if [[ "$$RPM" =~ "epel-release-latest" ]] ; then \
156 MISSING+=$$(rpm -q epel-release | grep "^package") ; \
158 MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
161 if [ -n "$$MISSING" ] ; then \
162 echo "Please install missing RPMs: \n$$MISSING\n" ; \
163 echo "by executing \"make install-dep\"\n" ; \
168 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
169 @echo "#!/bin/bash\n" > $(BR)/path_setup
170 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
171 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
172 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
174 ifeq ("$(wildcard /usr/bin/ccache )","")
175 @echo "WARNING: Please install ccache AYEC and re-run this script"
177 @rm -rf $(BR)/tools/ccache-bin
178 @mkdir -p $(BR)/tools/ccache-bin
179 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
180 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
182 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
185 bootstrap: $(BR)/.bootstrap.ok
188 ifeq ($(OS_ID),ubuntu)
189 ifeq ($(OS_VERSION_ID),14.04)
190 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
191 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
193 @sudo -E apt-get update
194 @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
195 else ifneq ("$(wildcard /etc/redhat-release)","")
196 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
197 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
198 @sudo -E yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
199 @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
201 $(error "This option currently works only on Ubuntu or Centos systems")
205 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
208 $(BR)/scripts/.version:
209 ifneq ("$(wildcard /etc/redhat-release)","")
210 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
212 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
215 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
216 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
220 --prefix=$(DIST_SUBDIR)/ \
224 @git describe > $(BR)/.version
226 --file $(DIST_FILE) \
227 --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
229 @$(RM) $(BR)/.version $(DIST_FILE).xz
230 @xz -v --threads=0 $(DIST_FILE)
231 @$(RM) $(BR)/vpp-latest.tar.xz
232 @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
234 build: $(BR)/.bootstrap.ok
235 $(call make,$(PLATFORM)_debug,vpp-install)
238 @$(RM) $(BR)/*.tar.xz
240 wipe: wipedist $(BR)/.bootstrap.ok
241 $(call make,$(PLATFORM)_debug,vpp-wipe)
245 build-release: $(BR)/.bootstrap.ok
246 $(call make,$(PLATFORM),vpp-install)
248 wipe-release: $(BR)/.bootstrap.ok
249 $(call make,$(PLATFORM),vpp-wipe)
251 rebuild-release: wipe-release build-release
253 export VPP_PYTHON_PREFIX=$(BR)/python
256 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
258 TEST_DIR=$(WS_ROOT)/test \
259 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
260 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
261 VPP_TEST_PLUGIN_PATH=$(BR)/install-$(2)-native/vpp/lib64/vpp_plugins \
262 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
263 LD_LIBRARY_PATH=$(BR)/install-$(2)-native/vpp/lib64/ \
264 EXTENDED_TESTS=$(EXTENDED_TESTS) \
270 $(call test,vpp,vpp,test)
272 test-debug: bootstrap
273 $(call test,vpp,vpp_debug,test)
276 $(eval EXTENDED_TESTS=yes)
277 $(call test,vpp,vpp,test)
279 test-all-debug: bootstrap
280 $(eval EXTENDED_TESTS=yes)
281 $(call test,vpp,vpp_debug,test)
289 test-shell: bootstrap
290 $(call test,vpp,vpp,shell)
292 test-shell-debug: bootstrap
293 $(call test,vpp,vpp_debug,shell)
299 @make -C test wipe-doc
302 $(eval EXTENDED_TESTS=yes)
303 $(call test,vpp,vpp_gcov,cov)
306 @make -C test wipe-cov
309 @make -C test checkstyle
312 $(call test,vpp,vpp,retest)
315 $(call test,vpp,vpp_debug,retest)
317 STARTUP_DIR ?= $(PWD)
318 ifeq ("$(wildcard $(STARTUP_CONF))","")
320 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
321 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
322 @cd $(STARTUP_DIR) && \
323 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/vpp/lib64/vpp_plugins
327 @cd $(STARTUP_DIR) && \
328 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/vpp/lib64/vpp_plugins
333 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
334 \( -not -path './build-root*' -o -path \
335 './build-root/build-vpp_debug-native/dpdk*' \) > $@
340 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
343 $(call run, $(BR)/install-$(PLATFORM)-native)
346 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
349 $(call make,$(PLATFORM)_coverity,install-packages)
352 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
355 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
358 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
361 $(call make,$(PLATFORM),install-deb)
367 make -C dpdk install-$(PKG)
370 @ctags --totals --tag-relative -L $<
374 @gtags --gtagslabel=ctags
380 @build-root/scripts/checkstyle.sh
383 @build-root/scripts/checkstyle.sh --fix
386 # Build the documentation
389 # Doxygen configuration and our utility scripts
390 export DOXY_DIR ?= $(WS_ROOT)/doxygen
393 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
396 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
408 @echo "========================================================================"
410 @echo "========================================================================"
414 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
415 $(call banner,"Building for PLATFORM=vpp using gcc")
416 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
417 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
418 $(call banner,"Installing dependencies")
419 @sudo -E apt-get update
420 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
421 $(call banner,"Building for PLATFORM=vpp using clang")
422 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
424 $(call banner,"Building sample-plugin")
425 @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
426 $(call banner,"Building $(PKG) packages")