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