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