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,$(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 += python-dev python-virtualenv python-pip lcov chrpath autoconf nasm
43 ifeq ($(OS_VERSION_ID),14.04)
44 DEB_DEPENDS += openjdk-8-jdk-headless
46 DEB_DEPENDS += default-jdk-headless
49 RPM_DEPENDS_GROUPS = 'Development Tools'
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 python-virtualenv lcov chrpath
53 RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
54 EPEL_DEPENDS = libconfuse-devel ganglia-devel
56 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
57 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
60 ifeq ($(findstring y,$(UNATTENDED)),y)
65 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
66 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
68 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
69 .PHONY: test-cov test-wipe-cov
73 @echo " bootstrap - prepare tree for build"
74 @echo " install-dep - install software dependencies"
75 @echo " wipe - wipe all products of debug build "
76 @echo " wipe-release - wipe all products of release build "
77 @echo " build - build debug binaries"
78 @echo " build-release - build release binaries"
79 @echo " build-coverity - build coverity artifacts"
80 @echo " rebuild - wipe and build debug binares"
81 @echo " rebuild-release - wipe and build release binares"
82 @echo " run - run debug binary"
83 @echo " run-release - run release binary"
84 @echo " debug - run debug binary with debugger"
85 @echo " debug-release - run release binary with debugger"
86 @echo " test - build and run (basic) functional tests"
87 @echo " test-debug - build and run (basic) functional tests (debug build)"
88 @echo " test-all - build and run (all) functional tests"
89 @echo " test-all-debug - build and run (all) functional tests (debug build)"
90 @echo " test-shell - enter shell with test environment"
91 @echo " test-shell-debug - enter shell with test environment (debug build)"
92 @echo " test-wipe - wipe files generated by unit tests"
93 @echo " retest - run functional tests"
94 @echo " retest-debug - run functional tests (debug build)"
95 @echo " test-help - show help on test framework"
96 @echo " run-vat - run vpp-api-test tool"
97 @echo " pkg-deb - build DEB packages"
98 @echo " pkg-rpm - build RPM packages"
99 @echo " dpdk-install-dev - install DPDK development packages"
100 @echo " ctags - (re)generate ctags database"
101 @echo " gtags - (re)generate gtags database"
102 @echo " cscope - (re)generate cscope database"
103 @echo " checkstyle - check coding style"
104 @echo " fixstyle - fix coding style"
105 @echo " doxygen - (re)generate documentation"
106 @echo " bootstrap-doxygen - setup Doxygen dependencies"
107 @echo " wipe-doxygen - wipe all generated documentation"
108 @echo " test-doc - generate documentation for test framework"
109 @echo " test-wipe-doc - wipe documentation for test framework"
110 @echo " test-cov - generate code coverage report for test framework"
111 @echo " test-wipe-cov - wipe code coverage report for test framework"
112 @echo " test-checkstyle - check PEP8 compliance for test framework"
114 @echo "Make Arguments:"
115 @echo " V=[0|1] - set build verbosity level"
116 @echo " STARTUP_CONF=<path> - startup configuration file"
117 @echo " (e.g. /etc/vpp/startup.conf)"
118 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
119 @echo " It also sets STARTUP_CONF if"
120 @echo " startup.conf file is present"
121 @echo " GDB=<path> - gdb binary to use for debugging"
122 @echo " PLATFORM=<name> - target platform. default is vpp"
123 @echo " TEST=<filter> - apply filter to test set, see test-help"
125 @echo "Current Argument Values:"
127 @echo " STARTUP_CONF = $(STARTUP_CONF)"
128 @echo " STARTUP_DIR = $(STARTUP_DIR)"
129 @echo " GDB = $(GDB)"
130 @echo " PLATFORM = $(PLATFORM)"
131 @echo " DPDK_VERSION = $(DPDK_VERSION)"
134 ifeq ($(findstring y,$(UNATTENDED)),y)
137 ifeq ($(OS_ID),ubuntu)
138 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
139 if [ -n "$$MISSING" ] ; then \
140 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
141 echo "by executing \"make install-dep\"\n" ; \
146 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
147 @echo "#!/bin/bash\n" > $(BR)/path_setup
148 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
149 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
150 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
152 ifeq ("$(wildcard /usr/bin/ccache )","")
153 @echo "WARNING: Please install ccache AYEC and re-run this script"
155 @rm -rf $(BR)/tools/ccache-bin
156 @mkdir -p $(BR)/tools/ccache-bin
157 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
158 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
160 @make -C $(BR) V=$(V) is_build_tool=yes tools-install
163 bootstrap: $(BR)/.bootstrap.ok
166 ifeq ($(OS_ID),ubuntu)
167 ifeq ($(OS_VERSION_ID),14.04)
168 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
169 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
171 @sudo -E apt-get update
172 @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
173 else ifneq ("$(wildcard /etc/redhat-release)","")
174 @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
175 @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
176 @sudo -E yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
177 @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
179 $(error "This option currently works only on Ubuntu or Centos systems")
183 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
186 $(BR)/scripts/.version:
187 ifneq ("$(wildcard /etc/redhat-release)","")
188 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
190 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
193 dist: $(BR)/scripts/.version
194 $(MAKE) verstring=$(PLATFORM)-$(shell cat $(BR)/scripts/.version) prefix=$(PLATFORM) distversion
196 distversion: $(BR)/scripts/.version
197 $(BR)/scripts/verdist ${BR} ${prefix}-$(shell $(BR)/scripts/version rpm-version) ${verstring}
198 mv $(verstring).tar.gz $(BR)/rpm
200 build: $(BR)/.bootstrap.ok
201 $(call make,$(PLATFORM)_debug,vpp-install)
204 $(RM) $(BR)/scripts/.version $(BR)/rpm/*.tar.gz
206 wipe: wipedist $(BR)/.bootstrap.ok
207 $(call make,$(PLATFORM)_debug,vpp-wipe)
211 build-release: $(BR)/.bootstrap.ok
212 $(call make,$(PLATFORM),vpp-install)
214 wipe-release: $(BR)/.bootstrap.ok
215 $(call make,$(PLATFORM),vpp-wipe)
217 rebuild-release: wipe-release build-release
219 export VPP_PYTHON_PREFIX=$(BR)/python
222 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
224 VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
225 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
226 VPP_TEST_PLUGIN_PATH=$(BR)/install-$(2)-native/vpp/lib64/vpp_plugins \
227 VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
228 LD_LIBRARY_PATH=$(BR)/install-$(2)-native/vpp/lib64/ \
229 EXTENDED_TESTS=$(EXTENDED_TESTS) \
234 $(call test,vpp,vpp,test)
236 test-debug: bootstrap
237 $(call test,vpp,vpp_debug,test)
240 $(eval EXTENDED_TESTS=yes)
241 $(call test,vpp,vpp,test)
243 test-all-debug: bootstrap
244 $(eval EXTENDED_TESTS=yes)
245 $(call test,vpp,vpp_debug,test)
253 test-shell: bootstrap
254 $(call test,vpp_lite,vpp_lite,shell)
256 test-shell-debug: bootstrap
257 $(call test,vpp_lite,vpp_lite_debug,shell)
263 @make -C test wipe-doc
266 $(call test,vpp,vpp_gcov,cov)
269 @make -C test wipe-cov
272 @make -C test checkstyle
275 $(call test,vpp,vpp,retest)
278 $(call test,vpp,vpp_debug,retest)
280 STARTUP_DIR ?= $(PWD)
281 ifeq ("$(wildcard $(STARTUP_CONF))","")
283 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
284 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
285 @cd $(STARTUP_DIR) && \
286 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/vpp/lib64/vpp_plugins
290 @cd $(STARTUP_DIR) && \
291 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/vpp/lib64/vpp_plugins
296 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
297 \( -not -path './build-root*' -o -path \
298 './build-root/build-vpp_debug-native/dpdk*' \) > $@
303 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
306 $(call run, $(BR)/install-$(PLATFORM)-native)
309 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
312 $(call make,$(PLATFORM)_coverity,install-packages)
315 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
318 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
321 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
324 $(call make,$(PLATFORM),install-deb)
327 $(call make,$(PLATFORM),install-rpm)
330 make -C dpdk install-$(PKG)
333 @ctags --totals --tag-relative -L $<
337 @gtags --gtagslabel=ctags
343 @build-root/scripts/checkstyle.sh
346 @build-root/scripts/checkstyle.sh --fix
349 # Build the documentation
352 # Doxygen configuration and our utility scripts
353 export DOXY_DIR ?= $(WS_ROOT)/doxygen
356 @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
359 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
371 @echo "========================================================================"
373 @echo "========================================================================"
377 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
378 $(call banner,"Building for PLATFORM=vpp using gcc")
379 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
380 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
381 $(call banner,"Installing dependencies")
382 @sudo -E apt-get update
383 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
384 $(call banner,"Building for PLATFORM=vpp using clang")
385 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
387 $(call banner,"Building $(PKG) packages")