Makefile

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