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