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