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