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.
15 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 DEB_DEPENDS = curl build-essential autoconf automake bison libssl-dev ccache
34 DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
35 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
36 DEB_DEPENDS += python-dev python-virtualenv python-pip
37 ifeq ($(OS_VERSION_ID),14.04)
38 DEB_DEPENDS += openjdk-8-jdk-headless
40 DEB_DEPENDS += default-jdk-headless
43 RPM_DEPENDS_GROUPS = 'Development Tools'
44 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
45 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
46 RPM_DEPENDS += python-devel python-virtualenv
47 EPEL_DEPENDS = libconfuse-devel ganglia-devel
49 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
50 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
53 ifeq ($(findstring y,$(UNATTENDED)),y)
58 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
59 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
60 .PHONY: ctags cscope plugins plugins-release build-vpp-api
61 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
65 @echo " bootstrap - prepare tree for build"
66 @echo " install-dep - install software dependencies"
67 @echo " wipe - wipe all products of debug build "
68 @echo " wipe-release - wipe all products of release build "
69 @echo " build - build debug binaries"
70 @echo " build-release - build release binaries"
71 @echo " plugins - build debug plugin binaries"
72 @echo " plugins-release - build release plugin binaries"
73 @echo " rebuild - wipe and build debug binares"
74 @echo " rebuild-release - wipe and build release binares"
75 @echo " run - run debug binary"
76 @echo " run-release - run release binary"
77 @echo " debug - run debug binary with debugger"
78 @echo " debug-release - run release binary with debugger"
79 @echo " test - build and run functional tests"
80 @echo " test-debug - build and run functional tests (debug build)"
81 @echo " test-wipe - wipe files generated by unit tests"
82 @echo " retest - run functional tests"
83 @echo " retest-debug - run functional tests (debug build)"
84 @echo " test-help - show help on test framework"
85 @echo " build-vat - build vpp-api-test tool"
86 @echo " build-vpp-api - build vpp-api"
87 @echo " run-vat - run vpp-api-test tool"
88 @echo " pkg-deb - build DEB packages"
89 @echo " pkg-rpm - build RPM packages"
90 @echo " ctags - (re)generate ctags database"
91 @echo " gtags - (re)generate gtags database"
92 @echo " cscope - (re)generate cscope database"
93 @echo " checkstyle - check coding style"
94 @echo " fixstyle - fix coding style"
95 @echo " doxygen - (re)generate documentation"
96 @echo " bootstrap-doxygen - setup Doxygen dependencies"
97 @echo " wipe-doxygen - wipe all generated documentation"
98 @echo " test-doc - generate documentation for test framework"
99 @echo " test-wipe-doc - wipe documentation for test framework"
101 @echo "Make Arguments:"
102 @echo " V=[0|1] - set build verbosity level"
103 @echo " STARTUP_CONF=<path> - startup configuration file"
104 @echo " (e.g. /etc/vpp/startup.conf)"
105 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
106 @echo " It also sets STARTUP_CONF if"
107 @echo " startup.conf file is present"
108 @echo " GDB=<path> - gdb binary to use for debugging"
109 @echo " PLATFORM=<name> - target platform. default is vpp"
110 @echo " TEST=<name> - only run specific test"
112 @echo "Current Argument Values:"
114 @echo " STARTUP_CONF = $(STARTUP_CONF)"
115 @echo " STARTUP_DIR = $(STARTUP_DIR)"
116 @echo " GDB = $(GDB)"
117 @echo " PLATFORM = $(PLATFORM)"
118 @echo " DPDK_VERSION = $(DPDK_VERSION)"
121 ifeq ($(findstring y,$(UNATTENDED)),y)
124 ifeq ($(OS_ID),ubuntu)
125 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
126 if [ -n "$$MISSING" ] ; then \
127 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
128 echo "by executing \"make install-dep\"\n" ; \
133 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
134 @echo "#!/bin/bash\n" > $(BR)/path_setup
135 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
136 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
137 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
139 ifeq ("$(wildcard /usr/bin/ccache )","")
140 @echo "WARNING: Please install ccache AYEC and re-run this script"
142 @rm -rf $(BR)/tools/ccache-bin
143 @mkdir -p $(BR)/tools/ccache-bin
144 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
145 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
147 @make -C $(BR) V=$(V) is_build_tool=yes vppapigen-install
150 bootstrap: $(BR)/.bootstrap.ok
153 ifeq ($(OS_ID),ubuntu)
154 ifeq ($(OS_VERSION_ID),14.04)
155 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
156 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
157 @sudo -E apt-get update
159 @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
160 else ifneq ("$(wildcard /etc/redhat-release)","")
161 @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
162 @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
163 @sudo yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
164 @sudo 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
166 $(error "This option currently works only on Ubuntu or Centos systems")
170 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
173 $(BR)/scripts/.version:
174 ifneq ("$(wildcard /etc/redhat-release)","")
175 $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
177 $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
180 dist: $(BR)/scripts/.version
181 $(MAKE) verstring=$(PLATFORM)-$(shell cat $(BR)/scripts/.version) prefix=$(PLATFORM) distversion
183 distversion: $(BR)/scripts/.version
184 $(BR)/scripts/verdist ${BR} ${prefix}-$(shell $(BR)/scripts/version rpm-version) ${verstring}
185 mv $(verstring).tar.gz $(BR)/rpm
187 build: $(BR)/.bootstrap.ok
188 $(call make,$(PLATFORM)_debug,vpp-install)
191 $(RM) $(BR)/scripts/.version $(BR)/rpm/*.tar.gz
193 wipe: wipedist $(BR)/.bootstrap.ok
194 $(call make,$(PLATFORM)_debug,vpp-wipe)
198 build-release: $(BR)/.bootstrap.ok
199 $(call make,$(PLATFORM),vpp-install)
201 wipe-release: $(BR)/.bootstrap.ok
202 $(call make,$(PLATFORM),vpp-wipe)
204 rebuild-release: wipe-release build-release
206 plugins: $(BR)/.bootstrap.ok
207 $(call make,$(PLATFORM)_debug,plugins-install)
209 plugins-release: $(BR)/.bootstrap.ok
210 $(call make,$(PLATFORM),plugins-install)
212 build-vpp-api: $(BR)/.bootstrap.ok
213 $(call make,$(PLATFORM)_debug,vpp-api-install)
215 VPP_PYTHON_PREFIX=$(BR)/python
218 $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-api-install plugins-install vpp-install,)
220 VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
221 VPP_TEST_API_TEST_BIN=$(BR)/install-$(2)-native/vpp-api-test/bin/vpp_api_test \
222 VPP_TEST_PLUGIN_PATH=$(BR)/install-$(2)-native/plugins/lib64/vpp_plugins \
223 LD_LIBRARY_PATH=$(BR)/install-$(2)-native/vpp-api/lib64/ \
224 WS_ROOT=$(WS_ROOT) V=$(V) TEST=$(TEST) VPP_PYTHON_PREFIX=$(VPP_PYTHON_PREFIX) $(3)
228 $(call test,vpp_lite,vpp_lite,test)
230 test-debug: bootstrap
231 $(call test,vpp_lite,vpp_lite_debug,test)
240 @make -C test WS_ROOT=$(WS_ROOT) BR=$(BR) VPP_PYTHON_PREFIX=$(VPP_PYTHON_PREFIX) doc
243 @make -C test wipe-doc BR=$(BR)
246 $(call test,vpp_lite,vpp_lite,retest)
249 $(call test,vpp_lite,vpp_lite_debug,retest)
251 STARTUP_DIR ?= $(PWD)
252 ifeq ("$(wildcard $(STARTUP_CONF))","")
254 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
255 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
256 @cd $(STARTUP_DIR) && \
257 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/plugins/lib64/vpp_plugins
261 @cd $(STARTUP_DIR) && \
262 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/plugins/lib64/vpp_plugins
267 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
268 \( -not -path './build-root*' -o -path \
269 './build-root/build-vpp_debug-native/dpdk*' \) > $@
274 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
277 $(call run, $(BR)/install-$(PLATFORM)-native)
280 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
283 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
286 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
289 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp-api-test/bin/vpp_api_test
292 $(call make,$(PLATFORM),install-deb)
295 $(call make,$(PLATFORM),install-rpm)
298 @ctags --totals --tag-relative -L $<
302 @gtags --gtagslabel=ctags
308 @build-root/scripts/checkstyle.sh
311 @build-root/scripts/checkstyle.sh --fix
314 # Build the documentation
317 # Doxygen configuration and our utility scripts
318 export DOXY_DIR ?= $(WS_ROOT)/doxygen
321 @OS_ID="$(OS_ID)" WS_ROOT="$(WS_ROOT)" BR="$(BR)" make -C $(DOXY_DIR) $@
324 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
336 @echo "========================================================================"
338 @echo "========================================================================"
342 verify: install-dep $(BR)/.bootstrap.ok
343 $(call banner,"Building for PLATFORM=vpp using gcc")
344 @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
345 $(call banner,"Building for PLATFORM=vpp_lite using gcc")
346 @make -C build-root PLATFORM=vpp_lite TAG=vpp_lite wipe-all install-packages
347 ifeq ($(OS_ID),ubuntu)
348 ifeq ($(OS_VERSION_ID),16.04)
349 $(call banner,"Installing dependencies")
350 @sudo -E apt-get update
351 @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
352 $(call banner,"Building for PLATFORM=vpp using clang")
353 @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
355 $(call banner,"Building deb packages")
358 ifeq ($(OS_ID),centos)
359 $(call banner,"Building rpm packages")