Makefile revision 86a9441c
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
14export WS_ROOT=$(CURDIR)
15export BR=$(WS_ROOT)/build-root
16CCACHE_DIR?=$(BR)/.ccache
17GDB?=gdb
18PLATFORM?=vpp
19SAMPLE_PLUGIN?=no
20STARTUP_DIR?=$(PWD)
21MACHINE=$(shell uname -m)
22SUDO?=sudo
23DPDK_CONFIG?=no-pci
24
25,:=,
26define disable_plugins
27$(if $(1), \
28  "plugins {" \
29  $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
30  " }" \
31  ,)
32endef
33
34MINIMAL_STARTUP_CONF="							\
35unix { 									\
36	interactive 							\
37	cli-listen /run/vpp/cli.sock					\
38	gid $(shell id -g)						\
39	$(if $(wildcard startup.vpp),"exec startup.vpp",)		\
40}									\
41$(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",)			\
42$(call disable_plugins,$(DISABLED_PLUGINS))				\
43"
44
45GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
46
47#
48# OS Detection
49#
50# We allow Darwin (MacOS) for docs generation; VPP build will still fail.
51ifneq ($(shell uname),Darwin)
52OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
53OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
54endif
55
56ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
57PKG=deb
58else ifeq ($(filter rhel centos fedora opensuse opensuse-leap opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
59PKG=rpm
60endif
61
62# +libganglia1-dev if building the gmond plugin
63
64DEB_DEPENDS  = curl build-essential autoconf automake ccache
65DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
66DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
67DEB_DEPENDS += lcov chrpath autoconf indent clang-format libnuma-dev
68DEB_DEPENDS += python-all python3-all python3-setuptools python-dev
69DEB_DEPENDS += python-virtualenv python-pip libffi6 check
70DEB_DEPENDS += libboost-all-dev libffi-dev python3-ply libmbedtls-dev
71DEB_DEPENDS += cmake ninja-build uuid-dev python3-jsonschema python3-yaml yamllint
72ifeq ($(OS_VERSION_ID),14.04)
73	DEB_DEPENDS += libssl-dev
74else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
75	DEB_DEPENDS += libssl-dev
76	APT_ARGS = -t jessie-backports
77else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-9)
78	DEB_DEPENDS += libssl1.0-dev
79else
80	DEB_DEPENDS += libssl-dev
81endif
82
83RPM_DEPENDS  = redhat-lsb glibc-static
84RPM_DEPENDS += apr-devel
85RPM_DEPENDS += numactl-devel
86RPM_DEPENDS += check check-devel
87RPM_DEPENDS += boost boost-devel
88RPM_DEPENDS += selinux-policy selinux-policy-devel
89RPM_DEPENDS += ninja-build
90RPM_DEPENDS += libuuid-devel
91RPM_DEPENDS += mbedtls-devel
92RPM_DEPENDS += yamllint
93
94ifeq ($(OS_ID),fedora)
95	RPM_DEPENDS += dnf-utils
96	RPM_DEPENDS += subunit subunit-devel
97	RPM_DEPENDS += compat-openssl10-devel
98	RPM_DEPENDS += python3-devel python3-ply
99	RPM_DEPENDS += python3-virtualenv python3-jsonschema
100	RPM_DEPENDS += cmake
101	RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
102else
103	RPM_DEPENDS += yum-utils
104	RPM_DEPENDS += openssl-devel
105	RPM_DEPENDS += python-devel python36-ply
106	RPM_DEPENDS += python3-devel python3-pip
107	RPM_DEPENDS += python-virtualenv python36-jsonschema
108	RPM_DEPENDS += devtoolset-7
109	RPM_DEPENDS += cmake3
110	RPM_DEPENDS_GROUPS = 'Development Tools'
111endif
112
113# +ganglia-devel if building the ganglia plugin
114
115RPM_DEPENDS += chrpath libffi-devel rpm-build
116# lowercase- replace spaces with dashes.
117SUSE_NAME= $(shell grep '^NAME=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | sed -e 's/ /-/' | awk '{print tolower($$0)}')
118SUSE_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g' | cut -d' ' -f2)
119RPM_SUSE_BUILDTOOLS_DEPS = autoconf automake ccache check-devel chrpath
120RPM_SUSE_BUILDTOOLS_DEPS += clang cmake indent libtool make ninja python3-ply
121
122RPM_SUSE_DEVEL_DEPS = glibc-devel-static libnuma-devel
123RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-devel mbedtls-devel libuuid-devel
124
125RPM_SUSE_PYTHON_DEPS = python-devel python3-devel python-pip python3-pip
126RPM_SUSE_PYTHON_DEPS += python-rpm-macros python3-rpm-macros
127
128RPM_SUSE_PLATFORM_DEPS = distribution-release shadow rpm-build
129
130ifeq ($(OS_ID),opensuse)
131ifeq ($(SUSE_NAME),tumbleweed)
132	RPM_SUSE_DEVEL_DEPS = libboost_headers1_68_0-devel-1.68.0  libboost_thread1_68_0-devel-1.68.0 gcc
133	RPM_SUSE_PYTHON_DEPS += python3-ply python2-virtualenv
134endif
135ifeq ($(SUSE_ID),15.0)
136	RPM_SUSE_DEVEL_DEPS += libboost_headers-devel libboost_thread-devel gcc
137	RPM_SUSE_PYTHON_DEPS += python3-ply python2-virtualenv
138else
139	RPM_SUSE_DEVEL_DEPS += libboost_headers1_68_0-devel-1.68.0 gcc6
140	RPM_SUSE_PYTHON_DEPS += python-virtualenv
141endif
142endif
143
144ifeq ($(OS_ID),opensuse-leap)
145ifeq ($(SUSE_ID),15.0)
146	RPM_SUSE_DEVEL_DEPS += libboost_headers-devel libboost_thread-devel gcc git curl
147	RPM_SUSE_PYTHON_DEPS += python3-ply python2-virtualenv
148endif
149endif
150
151RPM_SUSE_DEPENDS += $(RPM_SUSE_BUILDTOOLS_DEPS) $(RPM_SUSE_DEVEL_DEPS) $(RPM_SUSE_PYTHON_DEPS) $(RPM_SUSE_PLATFORM_DEPS)
152
153ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
154        STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
155endif
156
157ifeq ($(findstring y,$(UNATTENDED)),y)
158CONFIRM=-y
159FORCE=--force-yes
160endif
161
162TARGETS = vpp
163
164ifneq ($(SAMPLE_PLUGIN),no)
165TARGETS += sample-plugin
166endif
167
168.PHONY: help wipe wipe-release build build-release rebuild rebuild-release
169.PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
170.PHONY: ctags cscope
171.PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
172.PHONY: test-cov test-wipe-cov
173
174define banner
175	@echo "========================================================================"
176	@echo " $(1)"
177	@echo "========================================================================"
178	@echo " "
179endef
180
181help:
182	@echo "Make Targets:"
183	@echo " install-dep          - install software dependencies"
184	@echo " wipe                 - wipe all products of debug build "
185	@echo " wipe-release         - wipe all products of release build "
186	@echo " build                - build debug binaries"
187	@echo " build-release        - build release binaries"
188	@echo " build-coverity       - build coverity artifacts"
189	@echo " rebuild              - wipe and build debug binaries"
190	@echo " rebuild-release      - wipe and build release binaries"
191	@echo " run                  - run debug binary"
192	@echo " run-release          - run release binary"
193	@echo " debug                - run debug binary with debugger"
194	@echo " debug-release        - run release binary with debugger"
195	@echo " test                 - build and run (basic) functional tests"
196	@echo " test-debug           - build and run (basic) functional tests (debug build)"
197	@echo " test-all             - build and run functional and extended tests"
198	@echo " test-all-debug       - build and run functional and extended tests (debug build)"
199	@echo " test-gcov            - build and run functional tests (gcov build)"
200	@echo " test-shell           - enter shell with test environment"
201	@echo " test-shell-debug     - enter shell with test environment (debug build)"
202	@echo " test-wipe            - wipe files generated by unit tests"
203	@echo " retest               - run functional tests"
204	@echo " retest-debug         - run functional tests (debug build)"
205	@echo " test-help            - show help on test framework"
206	@echo " run-vat              - run vpp-api-test tool"
207	@echo " pkg-deb              - build DEB packages"
208	@echo " pkg-deb-debug        - build DEB debug packages"
209	@echo " vom-pkg-deb          - build vom DEB packages"
210	@echo " vom-pkg-deb-debug    - build vom DEB debug packages"
211	@echo " pkg-rpm              - build RPM packages"
212	@echo " install-ext-deps     - install external development dependencies"
213	@echo " ctags                - (re)generate ctags database"
214	@echo " gtags                - (re)generate gtags database"
215	@echo " cscope               - (re)generate cscope database"
216	@echo " checkstyle           - check coding style"
217	@echo " fixstyle             - fix coding style"
218	@echo " doxygen              - (re)generate documentation"
219	@echo " bootstrap-doxygen    - setup Doxygen dependencies"
220	@echo " wipe-doxygen         - wipe all generated documentation"
221	@echo " checkfeaturelist     - check FEATURE.yaml according to schema"
222	@echo " featurelist          - dump feature list in markdown"
223	@echo " json-api-files       - (re)-generate json api files"
224	@echo " json-api-files-debug - (re)-generate json api files for debug target"
225	@echo " docs                 - Build the Sphinx documentation"
226	@echo " docs-venv            - Build the virtual environment for the Sphinx docs"
227	@echo " docs-clean           - Remove the generated files from the Sphinx docs"
228	@echo " test-doc             - generate documentation for test framework"
229	@echo " test-wipe-doc        - wipe documentation for test framework"
230	@echo " test-cov             - generate code coverage report for test framework"
231	@echo " test-wipe-cov        - wipe code coverage report for test framework"
232	@echo " test-checkstyle      - check PEP8 compliance for test framework"
233	@echo " test-refresh-deps    - refresh the Python dependencies for the tests"
234	@echo ""
235	@echo "Make Arguments:"
236	@echo " V=[0|1]                  - set build verbosity level"
237	@echo " STARTUP_CONF=<path>      - startup configuration file"
238	@echo "                            (e.g. /etc/vpp/startup.conf)"
239	@echo " STARTUP_DIR=<path>       - startup directory (e.g. /etc/vpp)"
240	@echo "                            It also sets STARTUP_CONF if"
241	@echo "                            startup.conf file is present"
242	@echo " GDB=<path>               - gdb binary to use for debugging"
243	@echo " PLATFORM=<name>          - target platform. default is vpp"
244	@echo " TEST=<filter>            - apply filter to test set, see test-help"
245	@echo " DPDK_CONFIG=<conf>       - add specified dpdk config commands to"
246	@echo "                            autogenerated startup.conf"
247	@echo "                            (e.g. \"no-pci\" )"
248	@echo " SAMPLE_PLUGIN=yes        - in addition build/run/debug sample plugin"
249	@echo " DISABLED_PLUGINS=<list>  - comma separated list of plugins which"
250	@echo "                            should not be loaded"
251	@echo ""
252	@echo "Current Argument Values:"
253	@echo " V                 = $(V)"
254	@echo " STARTUP_CONF      = $(STARTUP_CONF)"
255	@echo " STARTUP_DIR       = $(STARTUP_DIR)"
256	@echo " GDB               = $(GDB)"
257	@echo " PLATFORM          = $(PLATFORM)"
258	@echo " DPDK_VERSION      = $(DPDK_VERSION)"
259	@echo " DPDK_CONFIG       = $(DPDK_CONFIG)"
260	@echo " SAMPLE_PLUGIN     = $(SAMPLE_PLUGIN)"
261	@echo " DISABLED_PLUGINS  = $(DISABLED_PLUGINS)"
262
263$(BR)/.deps.ok:
264ifeq ($(findstring y,$(UNATTENDED)),y)
265	make install-dep
266endif
267ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
268	@MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
269	if [ -n "$$MISSING" ] ; then \
270	  echo "\nPlease install missing packages: \n$$MISSING\n" ; \
271	  echo "by executing \"make install-dep\"\n" ; \
272	  exit 1 ; \
273	fi ; \
274	exit 0
275else ifneq ("$(wildcard /etc/redhat-release)","")
276	@for i in $(RPM_DEPENDS) ; do \
277	    RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3)  ;	\
278	    MISSING+=$$(rpm -q $$RPM | grep "^package")	   ;    \
279	done							   ;	\
280	if [ -n "$$MISSING" ] ; then \
281	  echo "Please install missing RPMs: \n$$MISSING\n" ; \
282	  echo "by executing \"make install-dep\"\n" ; \
283	  exit 1 ; \
284	fi ; \
285	exit 0
286endif
287	@touch $@
288
289bootstrap:
290	@echo "'make bootstrap' is not needed anymore"
291
292install-dep:
293ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
294ifeq ($(OS_VERSION_ID),14.04)
295	@sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
296endif
297ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
298	@grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
299           || ( echo "Please install jessie-backports" ; exit 1 )
300endif
301	@sudo -E apt-get update
302	@sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
303else ifneq ("$(wildcard /etc/redhat-release)","")
304ifeq ($(OS_ID),rhel)
305	@sudo -E yum-config-manager --enable rhel-server-rhscl-7-rpms
306	@sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
307	@sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
308	@sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
309else ifeq ($(OS_ID),centos)
310	@sudo -E yum install $(CONFIRM) centos-release-scl-rh epel-release
311	@sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
312	@sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
313	@sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
314else ifeq ($(OS_ID),fedora)
315	@sudo -E dnf groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
316	@sudo -E dnf install $(CONFIRM) $(RPM_DEPENDS)
317	@sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs mbedtls-devel zlib
318endif
319else ifeq ($(filter opensuse-tumbleweed,$(OS_ID)),$(OS_ID))
320	@sudo -E zypper refresh
321	@sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
322else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
323	@sudo -E zypper refresh
324	@sudo -E zypper install  -y $(RPM_SUSE_DEPENDS)
325else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
326	@sudo -E zypper refresh
327	@sudo -E zypper install -y $(RPM_SUSE_DEPENDS)
328else
329	$(error "This option currently works only on Ubuntu, Debian, RHEL, CentOS or openSUSE systems")
330endif
331	git config commit.template .git_commit_template.txt
332
333define make
334	@make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
335endef
336
337$(BR)/scripts/.version:
338ifneq ("$(wildcard /etc/redhat-release)","")
339	$(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
340else
341	$(shell $(BR)/scripts/version > $(BR)/scripts/.version)
342endif
343
344DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
345DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
346
347dist:
348	@if git rev-parse 2> /dev/null ; then \
349	    git archive \
350	      --prefix=$(DIST_SUBDIR)/ \
351	      --format=tar \
352	      -o $(DIST_FILE) \
353	    HEAD ; \
354	    git describe > $(BR)/.version ; \
355	else \
356	    (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
357	    src/scripts/version > $(BR)/.version ; \
358	fi
359	@tar --append \
360	  --file $(DIST_FILE) \
361	  --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
362	  $(BR)/.version
363	@$(RM) $(BR)/.version $(DIST_FILE).xz
364	@xz -v --threads=0 $(DIST_FILE)
365	@$(RM) $(BR)/vpp-latest.tar.xz
366	@ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
367
368build: $(BR)/.deps.ok
369	$(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
370
371wipedist:
372	@$(RM) $(BR)/*.tar.xz
373
374wipe: wipedist test-wipe $(BR)/.deps.ok
375	$(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
376	@find . -type f -name "*.api.json" ! -path "./test/*" -exec rm {} \;
377
378rebuild: wipe build
379
380build-release: $(BR)/.deps.ok
381	$(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
382
383wipe-release: test-wipe $(BR)/.deps.ok
384	$(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
385
386rebuild-release: wipe-release build-release
387
388libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
389
390export TEST_DIR ?= $(WS_ROOT)/test
391
392define test
393	$(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
394	$(eval libs:=lib lib64)
395	make -C test \
396	  VPP_BUILD_DIR=$(BR)/build-$(2)-native \
397	  VPP_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
398	  VPP_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
399	  VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_api_test_plugins) \
400	  VPP_INSTALL_PATH=$(BR)/install-$(2)-native/ \
401	  LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
402	  EXTENDED_TESTS=$(EXTENDED_TESTS) \
403	  PYTHON=$(PYTHON) \
404	  OS_ID=$(OS_ID) \
405	  CACHE_OUTPUT=$(CACHE_OUTPUT) \
406	  $(3)
407endef
408
409test:
410	$(call test,vpp,vpp,test)
411
412test-debug:
413	$(call test,vpp,vpp_debug,test)
414
415test-gcov:
416	$(call test,vpp,vpp_gcov,test)
417
418test-all:
419	$(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp vom-install,)
420	$(eval EXTENDED_TESTS=yes)
421	$(call test,vpp,vpp,test)
422
423test-all-debug:
424	$(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=vpp TAG=vpp_debug vom-install,)
425	$(eval EXTENDED_TESTS=yes)
426	$(call test,vpp,vpp_debug,test)
427
428papi-wipe:
429	@make -C test papi-wipe
430
431test-help:
432	@make -C test help
433
434test-wipe:
435	@make -C test wipe
436
437test-shell:
438	$(call test,vpp,vpp,shell)
439
440test-shell-debug:
441	$(call test,vpp,vpp_debug,shell)
442
443test-shell-gcov:
444	$(call test,vpp,vpp_gcov,shell)
445
446test-dep:
447	@make -C test test-dep
448
449test-doc:
450	@make -C test doc
451
452test-wipe-doc:
453	@make -C test wipe-doc
454
455test-cov:
456	@make -C $(BR) PLATFORM=vpp TAG=vpp_gcov vom-install
457	$(eval EXTENDED_TESTS=yes)
458	$(call test,vpp,vpp_gcov,cov)
459
460test-wipe-cov:
461	@make -C test wipe-cov
462
463test-checkstyle:
464	@make -C test checkstyle
465
466test-refresh-deps:
467	@make -C test refresh-deps
468
469retest:
470	$(call test,vpp,vpp,retest)
471
472retest-debug:
473	$(call test,vpp,vpp_debug,retest)
474
475ifeq ("$(wildcard $(STARTUP_CONF))","")
476define run
477	@echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
478	@echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
479	@cd $(STARTUP_DIR) && \
480	  $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
481endef
482else
483define run
484	@cd $(STARTUP_DIR) && \
485	  $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
486endef
487endif
488
489%.files: .FORCE
490	@find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
491		\( -not -path './build-root*' -o -path \
492		'./build-root/build-vpp_debug-native/dpdk*' \) > $@
493
494.FORCE:
495
496run:
497	$(call run, $(BR)/install-$(PLATFORM)_debug-native)
498
499run-release:
500	$(call run, $(BR)/install-$(PLATFORM)-native)
501
502debug:
503	$(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
504
505build-coverity:
506	$(call make,$(PLATFORM)_coverity,install-packages)
507
508debug-release:
509	$(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
510
511build-vat:
512	$(call make,$(PLATFORM)_debug,vpp-api-test-install)
513
514run-vat:
515	@$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
516
517pkg-deb:
518	$(call make,$(PLATFORM),vpp-package-deb)
519
520vom-pkg-deb:
521	$(call make,$(PLATFORM),vpp-package-deb)
522	$(call make,$(PLATFORM),vom-package-deb)
523
524pkg-deb-debug:
525	$(call make,$(PLATFORM)_debug,vpp-package-deb)
526
527vom-pkg-deb-debug:
528	$(call make,$(PLATFORM)_debug,vpp-package-deb)
529	$(call make,$(PLATFORM)_debug,vom-package-deb)
530
531pkg-rpm: dist
532	make -C extras/rpm
533
534pkg-srpm: dist
535	make -C extras/rpm srpm
536
537dpdk-install-dev:
538	$(call banner,"This command is deprecated. Please use 'make install-ext-deps'")
539	make -C build/external install-$(PKG)
540
541install-ext-deps:
542	make -C build/external install-$(PKG)
543
544json-api-files:
545	$(WS_ROOT)/src/tools/vppapigen/generate_json.py
546
547json-api-files-debug:
548	$(WS_ROOT)/src/tools/vppapigen/generate_json.py --debug-target
549
550ctags: ctags.files
551	@ctags --totals --tag-relative -L $<
552	@rm $<
553
554gtags: ctags
555	@gtags --gtagslabel=ctags
556
557cscope: cscope.files
558	@cscope -b -q -v
559
560checkstyle:
561	@build-root/scripts/checkstyle.sh
562	yamllint $(WS_ROOT)/src
563
564fixstyle:
565	@build-root/scripts/checkstyle.sh --fix
566
567# necessary because Bug 1696324 - Update to python3.6 breaks PyYAML dependencies
568# Status:	CLOSED CANTFIX
569# https://bugzilla.redhat.com/show_bug.cgi?id=1696324
570centos-pyyaml:
571ifeq ($(OS_ID)-$(OS_VERSION_ID),centos-7)
572	@python3 -m pip install pyyaml
573endif
574ifeq ($(OS_ID)-$(OS_VERSION_ID),centos-8)
575	@sudo -E yum install $(CONFIRM) python3-pyyaml
576endif
577
578featurelist: centos-pyyaml
579	@build-root/scripts/fts.py --all --markdown
580
581checkfeaturelist: centos-pyyaml
582	@build-root/scripts/fts.py --validate --git-status
583
584#
585# Build the documentation
586#
587
588# Doxygen configuration and our utility scripts
589export DOXY_DIR ?= $(WS_ROOT)/doxygen
590
591define make-doxy
592	@OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
593endef
594
595.PHONY: bootstrap-doxygen doxygen wipe-doxygen
596
597bootstrap-doxygen:
598	$(call make-doxy)
599
600doxygen:
601	$(call make-doxy)
602
603wipe-doxygen:
604	$(call make-doxy)
605
606# Sphinx Documents
607export DOCS_DIR = $(WS_ROOT)/docs
608export VENV_DIR = $(WS_ROOT)/sphinx_venv
609export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
610
611.PHONY: docs-venv docs docs-clean
612
613docs-venv:
614	@($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
615
616docs: $(DOCS_DIR)
617	@($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
618
619docs-clean:
620	@($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh clean)
621
622pkg-verify: install-dep $(BR)/.deps.ok install-ext-deps
623	$(call banner,"Building for PLATFORM=vpp using gcc")
624	@make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
625	$(call banner,"Building sample-plugin")
626	@make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
627	$(call banner,"Building libmemif")
628	@make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
629	$(call banner,"Building VOM")
630	@make -C build-root PLATFORM=vpp TAG=vpp vom-install
631	$(call banner,"Building $(PKG) packages")
632	@make pkg-$(PKG)
633ifeq ($(OS_ID),ubuntu)
634	$(call banner,"Building VOM $(PKG) package")
635	@make vom-pkg-deb
636endif
637
638MAKE_VERIFY_GATE_OS ?= ubuntu-18.04
639verify: pkg-verify
640ifeq ($(OS_ID)-$(OS_VERSION_ID),$(MAKE_VERIFY_GATE_OS))
641	$(call banner,"Testing vppapigen")
642	@src/tools/vppapigen/test_vppapigen.py
643	$(call banner,"Running tests")
644	@make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test
645else
646	$(call banner,"Skipping tests. Tests under 'make verify' supported on $(MAKE_VERIFY_GATE_OS)")
647endif
648