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