blob: 3db644e037d89d5454f5c8199c04cd891ccf8b0f [file] [log] [blame]
Damjan Marione17fdb52016-02-10 00:36:06 +01001# 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:
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
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.
13
14WS_ROOT=$(CURDIR)
15BR=$(WS_ROOT)/build-root
16CCACHE_DIR?=$(BR)/.ccache
Damjan Marione17fdb52016-02-10 00:36:06 +010017GDB?=gdb
Damjan Marione6f90232016-03-16 22:49:05 +010018PLATFORM?=vpp
Damjan Marione17fdb52016-02-10 00:36:06 +010019
Damjan Marion7a2a3782016-04-15 20:24:55 +020020MINIMAL_STARTUP_CONF="unix { interactive }"
Damjan Marione17fdb52016-02-10 00:36:06 +010021
Damjan Marioneef4d992016-02-23 22:04:50 +010022GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
23
Damjan Marionc5e86812016-05-02 19:40:27 +020024#
25# OS Detection
26#
Chris Luke36d25062016-09-22 20:52:26 -040027# We allow Darwin (MacOS) for docs generation; VPP build will still fail.
28ifneq ($(shell uname),Darwin)
Damjan Marionc5e86812016-05-02 19:40:27 +020029OS_ID = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
30OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
Chris Luke36d25062016-09-22 20:52:26 -040031endif
Damjan Marionc5e86812016-05-02 19:40:27 +020032
Damjan Marione17fdb52016-02-10 00:36:06 +010033DEB_DEPENDS = curl build-essential autoconf automake bison libssl-dev ccache
Ed Warnicke027103e2016-05-05 18:03:27 -050034DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
Damjan Marione6f90232016-03-16 22:49:05 +010035DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
Chris Luke54ccf222016-07-25 16:38:11 -040036DEB_DEPENDS += python-dev
Ed Warnicke027103e2016-05-05 18:03:27 -050037ifeq ($(OS_VERSION_ID),14.04)
38 DEB_DEPENDS += openjdk-8-jdk-headless
39else
40 DEB_DEPENDS += default-jdk-headless
41endif
Damjan Marione17fdb52016-02-10 00:36:06 +010042
Ed Warnicke84eda9d2016-03-22 16:09:29 -050043RPM_DEPENDS_GROUPS = 'Development Tools'
Thomas F Herbert473bf232016-04-27 16:19:03 -040044RPM_DEPENDS = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
Ed Warnicke3c79e652016-03-28 14:53:19 -050045RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
Chris Luke54ccf222016-07-25 16:38:11 -040046RPM_DEPENDS += python-devel
Ed Warnicke84eda9d2016-03-22 16:09:29 -050047EPEL_DEPENDS = libconfuse-devel ganglia-devel
48
Damjan Marion0df78dd2016-03-29 22:37:02 +020049ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
Damjan Marioneef4d992016-02-23 22:04:50 +010050 STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
51endif
Damjan Marione17fdb52016-02-10 00:36:06 +010052
Damjan Marionc5e86812016-05-02 19:40:27 +020053ifeq ($(findstring y,$(UNATTENDED)),y)
54CONFIRM=-y
Keith Burns (alagalah)f289ca62016-06-17 12:54:17 -070055FORCE=--force-yes
Damjan Marionc5e86812016-05-02 19:40:27 +020056endif
57
Damjan Marione17fdb52016-02-10 00:36:06 +010058.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
Chris Luke54ccf222016-07-25 16:38:11 -040060.PHONY: ctags cscope plugins plugins-release build-vpp-api
Damjan Marionf56b77a2016-10-03 19:44:57 +020061.PHONY: test test-debug retest retest-debug
Damjan Marione17fdb52016-02-10 00:36:06 +010062
63help:
64 @echo "Make Targets:"
65 @echo " bootstrap - prepare tree for build"
Damjan Marionebb27fb2016-02-25 16:26:01 +010066 @echo " install-dep - install software dependencies"
Damjan Marione17fdb52016-02-10 00:36:06 +010067 @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"
Damjan Mariona7775382016-07-07 17:56:48 +020071 @echo " plugins - build debug plugin binaries"
72 @echo " plugins-release - build release plugin binaries"
Damjan Marione17fdb52016-02-10 00:36:06 +010073 @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"
Damjan Marionf56b77a2016-10-03 19:44:57 +020079 @echo " test - build and run functional tests"
80 @echo " test-debug - build and run functional tests (debug build)"
81 @echo " retest - run functional tests"
82 @echo " retest-debug - run functional tests (debug build)"
Damjan Marione17fdb52016-02-10 00:36:06 +010083 @echo " build-vat - build vpp-api-test tool"
Ole Troan5f9dcff2016-08-01 04:59:13 +020084 @echo " build-vpp-api - build vpp-api"
Damjan Marione17fdb52016-02-10 00:36:06 +010085 @echo " run-vat - run vpp-api-test tool"
86 @echo " pkg-deb - build DEB packages"
87 @echo " pkg-rpm - build RPM packages"
Damjan Marione6f90232016-03-16 22:49:05 +010088 @echo " ctags - (re)generate ctags database"
Damjan Mariona7775382016-07-07 17:56:48 +020089 @echo " gtags - (re)generate gtags database"
Damjan Marione6f90232016-03-16 22:49:05 +010090 @echo " cscope - (re)generate cscope database"
Damjan Marion24704852016-09-07 13:10:50 +020091 @echo " checkstyle - check coding style"
92 @echo " fixstyle - fix coding style"
Chris Luke1d1644c2016-05-13 13:41:36 -040093 @echo " doxygen - (re)generate documentation"
Chris Luke54ccf222016-07-25 16:38:11 -040094 @echo " bootstrap-doxygen - setup Doxygen dependencies"
Chris Luke1d1644c2016-05-13 13:41:36 -040095 @echo " wipe-doxygen - wipe all generated documentation"
Damjan Marione17fdb52016-02-10 00:36:06 +010096 @echo ""
97 @echo "Make Arguments:"
98 @echo " V=[0|1] - set build verbosity level"
99 @echo " STARTUP_CONF=<path> - startup configuration file"
100 @echo " (e.g. /etc/vpp/startup.conf)"
Damjan Marioneef4d992016-02-23 22:04:50 +0100101 @echo " STARTUP_DIR=<path> - startup drectory (e.g. /etc/vpp)"
102 @echo " It also sets STARTUP_CONF if"
103 @echo " startup.conf file is present"
Damjan Marione17fdb52016-02-10 00:36:06 +0100104 @echo " GDB=<path> - gdb binary to use for debugging"
Damjan Marione6f90232016-03-16 22:49:05 +0100105 @echo " PLATFORM=<name> - target platform. default is vpp"
Damjan Marionf56b77a2016-10-03 19:44:57 +0200106 @echo " TEST=<name> - only run specific test"
Damjan Marione17fdb52016-02-10 00:36:06 +0100107 @echo ""
108 @echo "Current Argumernt Values:"
109 @echo " V = $(V)"
110 @echo " STARTUP_CONF = $(STARTUP_CONF)"
Damjan Marioneef4d992016-02-23 22:04:50 +0100111 @echo " STARTUP_DIR = $(STARTUP_DIR)"
Damjan Marione17fdb52016-02-10 00:36:06 +0100112 @echo " GDB = $(GDB)"
Damjan Marione6f90232016-03-16 22:49:05 +0100113 @echo " PLATFORM = $(PLATFORM)"
Damjan Marion0df78dd2016-03-29 22:37:02 +0200114 @echo " DPDK_VERSION = $(DPDK_VERSION)"
Damjan Marione17fdb52016-02-10 00:36:06 +0100115
116$(BR)/.bootstrap.ok:
Damjan Marionc5e86812016-05-02 19:40:27 +0200117ifeq ($(OS_ID),ubuntu)
Damjan Marione17fdb52016-02-10 00:36:06 +0100118 @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
119 if [ -n "$$MISSING" ] ; then \
120 echo "\nPlease install missing packages: \n$$MISSING\n" ; \
Damjan Marionebb27fb2016-02-25 16:26:01 +0100121 echo "by executing \"make install-dep\"\n" ; \
Damjan Marione17fdb52016-02-10 00:36:06 +0100122 exit 1 ; \
123 fi ; \
124 exit 0
125endif
Damjan Marion905a7f52016-07-07 20:27:49 +0200126 @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
Damjan Marione17fdb52016-02-10 00:36:06 +0100127 @echo "#!/bin/bash\n" > $(BR)/path_setup
128 @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
129 @echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
130 @echo 'export CCACHE_DIR=$(CCACHE_DIR)' >> $(BR)/path_setup
Ole Troan6855f6c2016-04-09 03:16:30 +0200131
Damjan Marione17fdb52016-02-10 00:36:06 +0100132ifeq ("$(wildcard /usr/bin/ccache )","")
133 @echo "WARNING: Please install ccache AYEC and re-run this script"
134else
135 @rm -rf $(BR)/tools/ccache-bin
136 @mkdir -p $(BR)/tools/ccache-bin
137 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
138 @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
139endif
140 @make -C $(BR) V=$(V) is_build_tool=yes vppapigen-install
141 @touch $@
142
143bootstrap: $(BR)/.bootstrap.ok
144
Damjan Marionebb27fb2016-02-25 16:26:01 +0100145install-dep:
Damjan Marionc5e86812016-05-02 19:40:27 +0200146ifeq ($(OS_ID),ubuntu)
147ifeq ($(OS_VERSION_ID),14.04)
Keith Burns (alagalah)f289ca62016-06-17 12:54:17 -0700148 @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
149 @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
Dave Wallaceed18a1c2016-05-13 19:00:29 -0400150 @sudo -E apt-get update
Damjan Marionc5e86812016-05-02 19:40:27 +0200151endif
Keith Burns (alagalah)f289ca62016-06-17 12:54:17 -0700152 @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
Ed Warnicke84eda9d2016-03-22 16:09:29 -0500153else ifneq ("$(wildcard /etc/redhat-release)","")
Damjan Marionc5e86812016-05-02 19:40:27 +0200154 @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
155 @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
156 @sudo yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
Ed Warnicked6a779c2016-05-03 16:47:50 -0500157 @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
Damjan Marionebb27fb2016-02-25 16:26:01 +0100158else
Ed Warnicke84eda9d2016-03-22 16:09:29 -0500159 $(error "This option currently works only on Ubuntu or Centos systems")
Damjan Marionebb27fb2016-02-25 16:26:01 +0100160endif
161
Damjan Marione17fdb52016-02-10 00:36:06 +0100162define make
Damjan Marion6b1d7c52016-04-26 18:19:47 +0200163 @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
Damjan Marione17fdb52016-02-10 00:36:06 +0100164endef
165
166build: $(BR)/.bootstrap.ok
Damjan Marione6f90232016-03-16 22:49:05 +0100167 $(call make,$(PLATFORM)_debug,vpp-install)
Damjan Marione17fdb52016-02-10 00:36:06 +0100168
169wipe: $(BR)/.bootstrap.ok
Damjan Marione6f90232016-03-16 22:49:05 +0100170 $(call make,$(PLATFORM)_debug,vpp-wipe)
Damjan Marione17fdb52016-02-10 00:36:06 +0100171
172rebuild: wipe build
173
174build-release: $(BR)/.bootstrap.ok
Damjan Marione6f90232016-03-16 22:49:05 +0100175 $(call make,$(PLATFORM),vpp-install)
Damjan Marione17fdb52016-02-10 00:36:06 +0100176
177wipe-release: $(BR)/.bootstrap.ok
Damjan Marione6f90232016-03-16 22:49:05 +0100178 $(call make,$(PLATFORM),vpp-wipe)
Damjan Marione17fdb52016-02-10 00:36:06 +0100179
180rebuild-release: wipe-release build-release
181
Pierre Pfister35352222016-05-27 10:30:13 +0100182plugins: $(BR)/.bootstrap.ok
Ole Troan3b3688f2016-06-15 14:29:08 +0200183 $(call make,$(PLATFORM)_debug,plugins-install)
Pierre Pfister35352222016-05-27 10:30:13 +0100184
185plugins-release: $(BR)/.bootstrap.ok
Ole Troan3b3688f2016-06-15 14:29:08 +0200186 $(call make,$(PLATFORM),plugins-install)
Pierre Pfister35352222016-05-27 10:30:13 +0100187
Ole Troan5f9dcff2016-08-01 04:59:13 +0200188build-vpp-api: $(BR)/.bootstrap.ok
189 $(call make,$(PLATFORM)_debug,vpp-api-install)
190
Damjan Marionf56b77a2016-10-03 19:44:57 +0200191define test
Klement Sekerab80f9d12016-10-05 14:05:33 +0200192 @make -C test \
Damjan Marionf56b77a2016-10-03 19:44:57 +0200193 VPP_TEST_BIN=$(BR)/install-$(1)-native/vpp/bin/vpp \
194 VPP_TEST_API_TEST_BIN=$(BR)/install-$(1)-native/vpp-api-test/bin/vpp_api_test \
195 V=$(V) TEST=$(TEST)
196endef
197
198test:
199ifeq ($(OS_ID),ubuntu)
200 @sudo -E apt-get $(CONFIRM) $(FORCE) install python-dev python-scapy
201endif
202 @make -C $(BR) PLATFORM=vpp_lite TAG=vpp_lite vpp-install vpp-api-test-install
203 $(call test,vpp_lite)
204
205test-debug:
206ifeq ($(OS_ID),ubuntu)
207 @sudo -E apt-get $(CONFIRM) $(FORCE) install python-dev python-scapy
208endif
209 @make -C $(BR) PLATFORM=vpp_lite TAG=vpp_lite_debug vpp-install vpp-api-test-install
210 $(call test,vpp_lite_debug)
211
212retest:
213 $(call test,vpp_lite)
214
215retest-debug:
216 $(call test,vpp_lite_debug)
217
Damjan Marioneef4d992016-02-23 22:04:50 +0100218STARTUP_DIR ?= $(PWD)
Damjan Marione17fdb52016-02-10 00:36:06 +0100219ifeq ("$(wildcard $(STARTUP_CONF))","")
220define run
221 @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
222 @echo " Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
Damjan Mariona7775382016-07-07 17:56:48 +0200223 @cd $(STARTUP_DIR) && \
Damjan Marion905a7f52016-07-07 20:27:49 +0200224 sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/plugins/lib64/vpp_plugins
Damjan Marione17fdb52016-02-10 00:36:06 +0100225endef
226else
227define run
Damjan Mariona7775382016-07-07 17:56:48 +0200228 @cd $(STARTUP_DIR) && \
Damjan Marion905a7f52016-07-07 20:27:49 +0200229 sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/plugins/lib64/vpp_plugins
Damjan Marione17fdb52016-02-10 00:36:06 +0100230endef
231endif
232
Damjan Marione6f90232016-03-16 22:49:05 +0100233%.files: .FORCE
234 @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
235 \( -not -path './build-root*' -o -path \
236 './build-root/build-vpp_debug-native/dpdk*' \) > $@
237
238.FORCE:
239
Damjan Marione17fdb52016-02-10 00:36:06 +0100240run:
Damjan Mariona7775382016-07-07 17:56:48 +0200241 $(call run, $(BR)/install-$(PLATFORM)_debug-native)
Damjan Marione17fdb52016-02-10 00:36:06 +0100242
243run-release:
Damjan Mariona7775382016-07-07 17:56:48 +0200244 $(call run, $(BR)/install-$(PLATFORM)-native)
Damjan Marione17fdb52016-02-10 00:36:06 +0100245
246debug:
Damjan Mariona7775382016-07-07 17:56:48 +0200247 $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
Damjan Marione17fdb52016-02-10 00:36:06 +0100248
249debug-release:
Damjan Mariona7775382016-07-07 17:56:48 +0200250 $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
Damjan Marione17fdb52016-02-10 00:36:06 +0100251
252build-vat:
Damjan Marione6f90232016-03-16 22:49:05 +0100253 $(call make,$(PLATFORM)_debug,vpp-api-test-install)
Damjan Marione17fdb52016-02-10 00:36:06 +0100254
255run-vat:
Damjan Marione6f90232016-03-16 22:49:05 +0100256 @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp-api-test/bin/vpp_api_test
Damjan Marione17fdb52016-02-10 00:36:06 +0100257
258pkg-deb:
Damjan Marione6f90232016-03-16 22:49:05 +0100259 $(call make,$(PLATFORM),install-deb)
Damjan Marione17fdb52016-02-10 00:36:06 +0100260
261pkg-rpm:
Damjan Marione6f90232016-03-16 22:49:05 +0100262 $(call make,$(PLATFORM),install-rpm)
263
264ctags: ctags.files
265 @ctags --totals --tag-relative -L $<
266 @rm $<
267
Keith Burns (alagalah)4b72a582016-07-02 17:54:36 -0700268gtags: ctags
269 @gtags --gtagslabel=ctags
270
Damjan Marione6f90232016-03-16 22:49:05 +0100271cscope: cscope.files
272 @cscope -b -q -v
Marek Gradzki60c63c72016-04-26 08:01:31 +0200273
Damjan Marion24704852016-09-07 13:10:50 +0200274checkstyle:
275 @build-root/scripts/checkstyle.sh
276
277fixstyle:
278 @build-root/scripts/checkstyle.sh --fix
Chris Lukeb5850972016-05-03 16:34:59 -0400279
Chris Luke1d1644c2016-05-13 13:41:36 -0400280#
281# Build the documentation
282#
283
Chris Luke54ccf222016-07-25 16:38:11 -0400284# Doxygen configuration and our utility scripts
285export DOXY_DIR ?= $(WS_ROOT)/doxygen
286
287define make-doxy
Chris Lukee0d802b2016-08-31 10:04:58 -0400288 @OS_ID="$(OS_ID)" WS_ROOT="$(WS_ROOT)" BR="$(BR)" make -C $(DOXY_DIR) $@
Chris Luke54ccf222016-07-25 16:38:11 -0400289endef
290
291.PHONY: bootstrap-doxygen doxygen wipe-doxygen
292
293bootstrap-doxygen:
294 $(call make-doxy)
Chris Lukeb5850972016-05-03 16:34:59 -0400295
Chris Lukeb5850972016-05-03 16:34:59 -0400296doxygen:
Chris Luke54ccf222016-07-25 16:38:11 -0400297 $(call make-doxy)
Chris Lukeb5850972016-05-03 16:34:59 -0400298
299wipe-doxygen:
Chris Luke54ccf222016-07-25 16:38:11 -0400300 $(call make-doxy)
301