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 OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
28 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
30 DEB_DEPENDS = curl build-essential autoconf automake bison libssl-dev ccache
31 DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
32 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
33 DEB_DEPENDS += doxygen graphviz
34 ifeq ($(OS_VERSION_ID),14.04)
35 DEB_DEPENDS += openjdk-8-jdk-headless
37 DEB_DEPENDS += default-jdk-headless
40 RPM_DEPENDS_GROUPS = 'Development Tools'
41 RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
42 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
43 RPM_DEPENDS += doxygen graphviz
44 EPEL_DEPENDS = libconfuse-devel ganglia-devel
46 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
47 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
50 ifeq ($(findstring y,$(UNATTENDED)),y)
55 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
56 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
57 .PHONY: ctags cscope doxygen wipe-doxygen plugins plugins-release build-vpp-api
61 @echo " bootstrap - prepare tree for build"
62 @echo " install-dep - install software dependencies"
63 @echo " wipe - wipe all products of debug build "
64 @echo " wipe-release - wipe all products of release build "
65 @echo " build - build debug binaries"
66 @echo " build-release - build release binaries"
67 @echo " plugins - build debug plugin binaries"
68 @echo " plugins-release - build release plugin binaries"
69 @echo " rebuild - wipe and build debug binares"
70 @echo " rebuild-release - wipe and build release binares"
71 @echo " run - run debug binary"
72 @echo " run-release - run release binary"
73 @echo " debug - run debug binary with debugger"
74 @echo " debug-release - run release binary with debugger"
75 @echo " build-vat - build vpp-api-test tool"
76 @echo " build-vpp-api - build vpp-api"
77 @echo " run-vat - run vpp-api-test tool"
78 @echo " pkg-deb - build DEB packages"
79 @echo " pkg-rpm - build RPM packages"
80 @echo " ctags - (re)generate ctags database"
81 @echo " gtags - (re)generate gtags database"
82 @echo " cscope - (re)generate cscope database"
83 @echo " doxygen - (re)generate documentation"
84 @echo " wipe-doxygen - wipe all generated documentation"
86 @echo "Make Arguments:"
87 @echo " V=[0|1] - set build verbosity level"
88 @echo " STARTUP_CONF=<path> - startup configuration file"
89 @echo " (e.g. /etc/vpp/startup.conf)"
90 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
91 @echo " It also sets STARTUP_CONF if"
92 @echo " startup.conf file is present"
93 @echo " GDB=<path> - gdb binary to use for debugging"
94 @echo " PLATFORM=<name> - target platform. default is vpp"
96 @echo "Current Argumernt Values:"
98 @echo " STARTUP_CONF = $(STARTUP_CONF)"
99 @echo " STARTUP_DIR = $(STARTUP_DIR)"
100 @echo " GDB = $(GDB)"
101 @echo " PLATFORM = $(PLATFORM)"
102 @echo " DPDK_VERSION = $(DPDK_VERSION)"
105 ifeq ($(OS_ID),ubuntu)
106 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
107 if [ -n "$$MISSING" ] ; then \
108 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
109 echo "by executing \"make install-dep\"\n" ; \
114 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
115 @echo "#!/bin/bash\n" > $(BR)/path_setup
116 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
117 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
118 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
120 ifeq ("$(wildcard /usr/bin/ccache )","")
121 @echo "WARNING: Please install ccache AYEC and re-run this script"
123 @rm -rf $(BR)/tools/ccache-bin
124 @mkdir -p $(BR)/tools/ccache-bin
125 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
126 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
128 @make -C $(BR) V=$(V) is_build_tool=yes vppapigen-install
131 bootstrap: $(BR)/.bootstrap.ok
134 ifeq ($(OS_ID),ubuntu)
135 ifeq ($(OS_VERSION_ID),14.04)
136 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
137 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
138 @sudo -E apt-get update
140 @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
141 else ifneq ("$(wildcard /etc/redhat-release)","")
142 @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
143 @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
144 @sudo yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
145 @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
147 $(error "This option currently works only on Ubuntu or Centos systems")
151 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
154 build: $(BR)/.bootstrap.ok
155 $(call make,$(PLATFORM)_debug,vpp-install)
157 wipe: $(BR)/.bootstrap.ok
158 $(call make,$(PLATFORM)_debug,vpp-wipe)
162 build-release: $(BR)/.bootstrap.ok
163 $(call make,$(PLATFORM),vpp-install)
165 wipe-release: $(BR)/.bootstrap.ok
166 $(call make,$(PLATFORM),vpp-wipe)
168 rebuild-release: wipe-release build-release
170 plugins: $(BR)/.bootstrap.ok
171 $(call make,$(PLATFORM)_debug,plugins-install)
173 plugins-release: $(BR)/.bootstrap.ok
174 $(call make,$(PLATFORM),plugins-install)
176 build-vpp-api: $(BR)/.bootstrap.ok
177 $(call make,$(PLATFORM)_debug,vpp-api-install)
179 STARTUP_DIR ?= $(PWD)
180 ifeq ("$(wildcard $(STARTUP_CONF))","")
182 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
183 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
184 @cd $(STARTUP_DIR) && \
185 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/plugins/lib64/vpp_plugins
189 @cd $(STARTUP_DIR) && \
190 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/plugins/lib64/vpp_plugins
195 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
196 \( -not -path './build-root*' -o -path \
197 './build-root/build-vpp_debug-native/dpdk*' \) > $@
202 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
205 $(call run, $(BR)/install-$(PLATFORM)-native)
208 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
211 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
214 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
217 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp-api-test/bin/vpp_api_test
220 $(call make,$(PLATFORM),install-deb)
223 $(call make,$(PLATFORM),install-rpm)
226 @ctags --totals --tag-relative -L $<
230 @gtags --gtagslabel=ctags
237 # Build the documentation
251 @mkdir -p "$(BR)/docs"
254 INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT))" \
256 VERSION="`git describe --tags --dirty`" \
257 doxygen doxygen/doxygen.cfg