Remove subunit from Centos requirements.
[vpp.git] / Makefile
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:
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
14 export WS_ROOT=$(CURDIR)
15 export BR=$(WS_ROOT)/build-root
16 CCACHE_DIR?=$(BR)/.ccache
17 GDB?=gdb
18 PLATFORM?=vpp
19 SAMPLE_PLUGIN?=no
20 MACHINE=$(shell uname -m)
21
22 ,:=,
23 define disable_plugins
24 $(if $(1), \
25   "plugins {" \
26   $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
27   " }" \
28   ,)
29 endef
30
31 MINIMAL_STARTUP_CONF="                                                  \
32 unix {                                                                  \
33         interactive                                                     \
34         cli-listen /run/vpp/cli.sock                                    \
35         gid $(shell id -g)                                              \
36         $(if $(wildcard startup.vpp),"exec startup.vpp",)               \
37 }                                                                       \
38 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",)                        \
39 $(call disable_plugins,$(DISABLED_PLUGINS))                             \
40 "
41
42 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
43
44 #
45 # OS Detection
46 #
47 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
48 ifneq ($(shell uname),Darwin)
49 OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
50 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
51 endif
52
53 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
54 PKG=deb
55 else ifeq ($(filter rhel centos fedora opensuse,$(OS_ID)),$(OS_ID))
56 PKG=rpm
57 endif
58
59 # +libganglia1-dev if building the gmond plugin
60
61 DEB_DEPENDS  = curl build-essential autoconf automake ccache
62 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
63 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
64 DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
65 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6 check
66 DEB_DEPENDS += libboost-all-dev libffi-dev python-ply libmbedtls-dev
67 ifeq ($(OS_VERSION_ID),14.04)
68         DEB_DEPENDS += openjdk-8-jdk-headless
69         DEB_DEPENDS += libssl-dev
70 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
71         DEB_DEPENDS += openjdk-8-jdk-headless
72         DEB_DEPENDS += libssl-dev
73         APT_ARGS = -t jessie-backports
74 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
75         DEB_DEPENDS += default-jdk-headless
76         DEB_DEPENDS += libssl1.0-dev
77 else 
78         DEB_DEPENDS += default-jdk-headless
79         DEB_DEPENDS += libssl-dev
80 endif
81
82 RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
83 RPM_DEPENDS += apr-devel
84 RPM_DEPENDS += numactl-devel
85 RPM_DEPENDS += check check-devel
86 RPM_DEPENDS += boost boost-devel
87 RPM_DEPENDS += selinux-policy selinux-policy-devel
88
89 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
90         RPM_DEPENDS += subunit subunit-devel
91         RPM_DEPENDS += openssl-devel
92         RPM_DEPENDS += python-devel python2-ply
93         RPM_DEPENDS += python2-virtualenv
94         RPM_DEPENDS += mbedtls-devel
95         RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
96 else ifeq ($(shell if [ "$(OS_ID)" = "fedora" ]; then test $(OS_VERSION_ID) -gt 25; echo $$?; fi),0)
97         RPM_DEPENDS += subunit subunit-devel
98         RPM_DEPENDS += compat-openssl10-devel
99         RPM_DEPENDS += python2-devel python2-ply
100         RPM_DEPENDS += python2-virtualenv
101         RPM_DEPENDS += mbedtls-devel
102         RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
103 else
104         RPM_DEPENDS += openssl-devel
105         RPM_DEPENDS += python-devel python-ply
106         RPM_DEPENDS += python-virtualenv
107         RPM_DEPENDS_GROUPS = 'Development Tools'
108 endif
109
110 # +ganglia-devel if building the ganglia plugin
111
112 RPM_DEPENDS += chrpath libffi-devel rpm-build
113
114 SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
115 RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
116 RPM_SUSE_BUILDTOOLS_DEPS += clang indent libtool make python-ply
117
118 RPM_SUSE_DEVEL_DEPS = glibc-devel-static java-1_8_0-openjdk-devel libnuma-devel
119 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel
120
121 RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
122 RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
123
124 RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
125
126 ifeq ($(OS_ID),opensuse)
127 ifneq ($(SUSE_NAME),Tumbleweed)
128         RPM_SUSE_DEVEL_DEPS += boost_1_61-devel gcc6
129         RPM_SUSE_PYTHON_DEPS += python-virtualenv
130 else
131         RPM_SUSE_DEVEL_DEPS = libboost_headers-devel libboost_thread-devel gcc
132         RPM_SUSE_PYTHON_DEPS += python2-virtualenv
133 endif
134 endif
135
136 RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
137
138 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
139         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
140 endif
141
142 ifeq ($(findstring y,$(UNATTENDED)),y)
143 CONFIRM=-y
144 FORCE=--force-yes
145 endif
146
147 TARGETS = vpp
148
149 ifneq ($(SAMPLE_PLUGIN),no)
150 TARGETS += sample-plugin
151 endif
152
153 .PHONY: help wipe wipe-release build build-release rebuild rebuild-release
154 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
155 .PHONY: ctags cscope
156 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
157 .PHONY: test-cov test-wipe-cov
158
159 help:
160         @echo "Make Targets:"
161         @echo " install-dep         - install software dependencies"
162         @echo " wipe                - wipe all products of debug build "
163         @echo " wipe-release        - wipe all products of release build "
164         @echo " build               - build debug binaries"
165         @echo " build-release       - build release binaries"
166         @echo " build-coverity      - build coverity artifacts"
167         @echo " rebuild             - wipe and build debug binares"
168         @echo " rebuild-release     - wipe and build release binares"
169         @echo " run                 - run debug binary"
170         @echo " run-release         - run release binary"
171         @echo " debug               - run debug binary with debugger"
172         @echo " debug-release       - run release binary with debugger"
173         @echo " test                - build and run (basic) functional tests"
174         @echo " test-debug          - build and run (basic) functional tests (debug build)"
175         @echo " test-all            - build and run (all) functional tests"
176         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
177         @echo " test-shell          - enter shell with test environment"
178         @echo " test-shell-debug    - enter shell with test environment (debug build)"
179         @echo " test-wipe           - wipe files generated by unit tests"
180         @echo " retest              - run functional tests"
181         @echo " retest-debug        - run functional tests (debug build)"
182         @echo " test-help           - show help on test framework"
183         @echo " run-vat             - run vpp-api-test tool"
184         @echo " pkg-deb             - build DEB packages"
185         @echo " pkg-rpm             - build RPM packages"
186         @echo " dpdk-install-dev    - install DPDK development packages"
187         @echo " ctags               - (re)generate ctags database"
188         @echo " gtags               - (re)generate gtags database"
189         @echo " cscope              - (re)generate cscope database"
190         @echo " checkstyle          - check coding style"
191         @echo " fixstyle            - fix coding style"
192         @echo " doxygen             - (re)generate documentation"
193         @echo " bootstrap-doxygen   - setup Doxygen dependencies"
194         @echo " wipe-doxygen        - wipe all generated documentation"
195         @echo " test-doc            - generate documentation for test framework"
196         @echo " test-wipe-doc       - wipe documentation for test framework"
197         @echo " test-cov            - generate code coverage report for test framework"
198         @echo " test-wipe-cov       - wipe code coverage report for test framework"
199         @echo " test-checkstyle     - check PEP8 compliance for test framework"
200         @echo ""
201         @echo "Make Arguments:"
202         @echo " V=[0|1]                  - set build verbosity level"
203         @echo " STARTUP_CONF=<path>      - startup configuration file"
204         @echo "                            (e.g. /etc/vpp/startup.conf)"
205         @echo " STARTUP_DIR=<path>       - startup drectory (e.g. /etc/vpp)"
206         @echo "                            It also sets STARTUP_CONF if"
207         @echo "                            startup.conf file is present"
208         @echo " GDB=<path>               - gdb binary to use for debugging"
209         @echo " PLATFORM=<name>          - target platform. default is vpp"
210         @echo " TEST=<filter>            - apply filter to test set, see test-help"
211         @echo " DPDK_CONFIG=<conf>       - add specified dpdk config commands to"
212         @echo "                            autogenerated startup.conf"
213         @echo "                            (e.g. \"no-pci\" )"
214         @echo " SAMPLE_PLUGIN=yes        - in addition build/run/debug sample plugin"
215         @echo " DISABLED_PLUGINS=<list>  - comma separated list of plugins which"
216         @echo "                            should not be loaded"
217         @echo ""
218         @echo "Current Argument Values:"
219         @echo " V                 = $(V)"
220         @echo " STARTUP_CONF      = $(STARTUP_CONF)"
221         @echo " STARTUP_DIR       = $(STARTUP_DIR)"
222         @echo " GDB               = $(GDB)"
223         @echo " PLATFORM          = $(PLATFORM)"
224         @echo " DPDK_VERSION      = $(DPDK_VERSION)"
225         @echo " DPDK_CONFIG       = $(DPDK_CONFIG)"
226         @echo " SAMPLE_PLUGIN     = $(SAMPLE_PLUGIN)"
227         @echo " DISABLED_PLUGINS  = $(DISABLED_PLUGINS)"
228
229 $(BR)/.deps.ok:
230 ifeq ($(findstring y,$(UNATTENDED)),y)
231         make install-dep
232 endif
233 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
234         @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
235         if [ -n "$$MISSING" ] ; then \
236           echo "\nPlease install missing packages: \n$$MISSING\n" ; \
237           echo "by executing \"make install-dep\"\n" ; \
238           exit 1 ; \
239         fi ; \
240         exit 0
241 else ifneq ("$(wildcard /etc/redhat-release)","")
242         @for i in $(RPM_DEPENDS) ; do \
243             RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3)  ;   \
244             MISSING+=$$(rpm -q $$RPM | grep "^package")    ;    \
245         done                                                       ;    \
246         if [ -n "$$MISSING" ] ; then \
247           echo "Please install missing RPMs: \n$$MISSING\n" ; \
248           echo "by executing \"make install-dep\"\n" ; \
249           exit 1 ; \
250         fi ; \
251         exit 0
252 endif
253         @touch $@
254
255 bootstrap:
256         @echo "'make bootstrap' is not needed anymore"
257
258 install-dep:
259 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
260 ifeq ($(OS_VERSION_ID),14.04)
261         @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
262         @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
263 endif
264 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
265         @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
266            || ( echo "Please install jessie-backports" ; exit 1 )
267 endif
268         @sudo -E apt-get update
269         @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
270 else ifneq ("$(wildcard /etc/redhat-release)","")
271         @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
272         @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
273         @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
274 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
275         @sudo -E zypper refresh
276         @sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
277 else
278         $(error "This option currently works only on Ubuntu, Debian, Centos or openSUSE systems")
279 endif
280
281 define make
282         @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
283 endef
284
285 $(BR)/scripts/.version:
286 ifneq ("$(wildcard /etc/redhat-release)","")
287         $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
288 else
289         $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
290 endif
291
292 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
293 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
294
295 dist:
296         @if git rev-parse 2> /dev/null ; then \
297             git archive \
298               --prefix=$(DIST_SUBDIR)/ \
299               --format=tar \
300               -o $(DIST_FILE) \
301             HEAD ; \
302             git describe > $(BR)/.version ; \
303         else \
304             (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
305             src/scripts/version > $(BR)/.version ; \
306         fi
307         @tar --append \
308           --file $(DIST_FILE) \
309           --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
310           $(BR)/.version
311         @$(RM) $(BR)/.version $(DIST_FILE).xz
312         @xz -v --threads=0 $(DIST_FILE)
313         @$(RM) $(BR)/vpp-latest.tar.xz
314         @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
315
316 build: $(BR)/.deps.ok
317         $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
318
319 wipedist:
320         @$(RM) $(BR)/*.tar.xz
321
322 wipe: wipedist test-wipe $(BR)/.deps.ok
323         $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
324
325 rebuild: wipe build
326
327 build-release: $(BR)/.deps.ok
328         $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
329
330 wipe-release: test-wipe $(BR)/.deps.ok
331         $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
332
333 rebuild-release: wipe-release build-release
334
335 export VPP_PYTHON_PREFIX ?= $(BR)/python
336
337 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
338
339 define test
340         $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
341         $(eval libs:=lib lib64)
342         make -C test \
343           TEST_DIR=$(WS_ROOT)/test \
344           VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
345           VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
346           VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
347           VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
348           LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
349           EXTENDED_TESTS=$(EXTENDED_TESTS) \
350           PYTHON=$(PYTHON) \
351           OS_ID=$(OS_ID) \
352           CACHE_OUTPUT=$(CACHE_OUTPUT) \
353           $(3)
354 endef
355
356 test:
357         $(call test,vpp,vpp,test)
358
359 test-debug:
360         $(call test,vpp,vpp_debug,test)
361
362 test-all:
363         $(eval EXTENDED_TESTS=yes)
364         $(call test,vpp,vpp,test)
365
366 test-all-debug:
367         $(eval EXTENDED_TESTS=yes)
368         $(call test,vpp,vpp_debug,test)
369
370 test-help:
371         @make -C test help
372
373 test-wipe:
374         @make -C test wipe
375
376 test-shell:
377         $(call test,vpp,vpp,shell)
378
379 test-shell-debug:
380         $(call test,vpp,vpp_debug,shell)
381
382 test-dep:
383         @make -C test test-dep
384
385 test-doc:
386         @make -C test doc
387
388 test-wipe-doc:
389         @make -C test wipe-doc
390
391 test-cov:
392         $(eval EXTENDED_TESTS=yes)
393         $(call test,vpp,vpp_gcov,cov)
394
395 test-wipe-cov:
396         @make -C test wipe-cov
397
398 test-checkstyle:
399         @make -C test checkstyle
400
401 retest:
402         $(call test,vpp,vpp,retest)
403
404 retest-debug:
405         $(call test,vpp,vpp_debug,retest)
406
407 STARTUP_DIR ?= $(PWD)
408 ifeq ("$(wildcard $(STARTUP_CONF))","")
409 define run
410         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
411         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
412         @cd $(STARTUP_DIR) && \
413           sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) \
414             plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
415 endef
416 else
417 define run
418         @cd $(STARTUP_DIR) && \
419           sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') \
420             plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
421 endef
422 endif
423
424 %.files: .FORCE
425         @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
426                 \( -not -path './build-root*' -o -path \
427                 './build-root/build-vpp_debug-native/dpdk*' \) > $@
428
429 .FORCE:
430
431 run:
432         $(call run, $(BR)/install-$(PLATFORM)_debug-native)
433
434 run-release:
435         $(call run, $(BR)/install-$(PLATFORM)-native)
436
437 debug:
438         $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
439
440 build-coverity: 
441         $(call make,$(PLATFORM)_coverity,install-packages)
442
443 debug-release:
444         $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
445
446 build-vat:
447         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
448
449 run-vat:
450         @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
451
452 pkg-deb:
453         $(call make,$(PLATFORM),install-deb)
454
455 pkg-rpm: dist
456         make -C extras/rpm
457
458 pkg-srpm: dist
459         make -C extras/rpm srpm
460
461 dpdk-install-dev:
462         make -C dpdk install-$(PKG)
463
464 ctags: ctags.files
465         @ctags --totals --tag-relative -L $<
466         @rm $<
467
468 gtags: ctags
469         @gtags --gtagslabel=ctags
470
471 cscope: cscope.files
472         @cscope -b -q -v
473
474 checkstyle:
475         @build-root/scripts/checkstyle.sh
476
477 fixstyle:
478         @build-root/scripts/checkstyle.sh --fix
479
480 #
481 # Build the documentation
482 #
483
484 # Doxygen configuration and our utility scripts
485 export DOXY_DIR ?= $(WS_ROOT)/doxygen
486
487 define make-doxy
488         @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
489 endef
490
491 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
492
493 bootstrap-doxygen:
494         $(call make-doxy)
495
496 doxygen:
497         $(call make-doxy)
498
499 wipe-doxygen:
500         $(call make-doxy)
501
502 define banner
503         @echo "========================================================================"
504         @echo " $(1)"
505         @echo "========================================================================"
506         @echo " "
507 endef
508
509 verify: install-dep $(BR)/.deps.ok dpdk-install-dev
510         $(call banner,"Building for PLATFORM=vpp using gcc")
511         @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
512 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
513         $(call banner,"Installing dependencies")
514         @sudo -E apt-get update
515         @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
516         $(call banner,"Building for PLATFORM=vpp using clang")
517         @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
518 endif
519         $(call banner,"Building sample-plugin")
520         @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
521         $(call banner,"Building libmemif")
522         @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
523         $(call banner,"Building $(PKG) packages")
524         @make pkg-$(PKG)
525 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
526         @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test
527 endif
528
529