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
  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 libmnl-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 DEB_DEPENDS += iperf3 # for 'make test TEST=vcl'
  80 DEB_DEPENDS += nasm
  81
  82 LIBFFI=libffi6 # works on all but 20.04 and debian-testing
  83
  84 ifeq ($(OS_VERSION_ID),20.04)
  85         DEB_DEPENDS += python3-virtualenv
  86         DEB_DEPENDS += libssl-dev
  87         DEB_DEPENDS += libelf-dev # for libbpf (af_xdp)
  88         DEB_DEPENDS += clang clang-format-11
  89         LIBFFI=libffi7
  90         DEB_DEPENDS += enchant-2  # for docs
  91 else ifeq ($(OS_VERSION_ID),20.10)
  92         DEB_DEPENDS += clang clang-format-11
  93         LIBFFI=libffi8ubuntu1
  94 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-10)
  95         DEB_DEPENDS += virtualenv
  96 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-11)
  97         DEB_DEPENDS += virtualenv
  98         DEB_DEPENDS += clang clang-format-11
  99         LIBFFI=libffi7
 100 else
 101         DEB_DEPENDS += clang-11 clang-format-11
 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 += ccache
 116 RPM_DEPENDS += xmlto
 117 RPM_DEPENDS += elfutils-libelf-devel
 118 RPM_DEPENDS += libnl3-devel libmnl-devel
 119 RPM_DEPENDS += nasm
 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 nasm
 161 RPM_SUSE_DEVEL_DEPS += libopenssl-devel openssl-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-python    - check python coding style using 'black' formatter"
 236         @echo " checkstyle-api       - check api for incompatible changes"
 237         @echo " fixstyle             - fix coding style"
 238         @echo " fixstyle-python      - fix python coding style using 'black' formatter"
 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 " DPDK_CONFIG=<conf>       - add specified dpdk config commands to"
 261         @echo "                            autogenerated startup.conf"
 262         @echo "                            (e.g. \"no-pci\" )"
 263         @echo " SAMPLE_PLUGIN=yes        - in addition build/run/debug sample plugin"
 264         @echo " DISABLED_PLUGINS=<list>  - comma separated list of plugins which"
 265         @echo "                            should not be loaded"
 266         @echo ""
 267         @echo "Current Argument Values:"
 268         @echo " V                 = $(V)"
 269         @echo " STARTUP_CONF      = $(STARTUP_CONF)"
 270         @echo " STARTUP_DIR       = $(STARTUP_DIR)"
 271         @echo " GDB               = $(GDB)"
 272         @echo " PLATFORM          = $(PLATFORM)"
 273         @echo " DPDK_VERSION      = $(DPDK_VERSION)"
 274         @echo " DPDK_CONFIG       = $(DPDK_CONFIG)"
 275         @echo " SAMPLE_PLUGIN     = $(SAMPLE_PLUGIN)"
 276         @echo " DISABLED_PLUGINS  = $(DISABLED_PLUGINS)"
 277
 278 $(BR)/.deps.ok:
 279 ifeq ($(findstring y,$(UNATTENDED)),y)
 280         make install-dep
 281 endif
 282 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
 283         @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
 284         if [ -n "$$MISSING" ] ; then \
 285           echo "\nPlease install missing packages: \n$$MISSING\n" ; \
 286           echo "by executing \"make install-dep\"\n" ; \
 287           exit 1 ; \
 288         fi ; \
 289         exit 0
 290 else ifneq ("$(wildcard /etc/redhat-release)","")
 291         @for i in $(RPM_DEPENDS) ; do \
 292             RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3,4)  ; \
 293             MISSING+=$$(rpm -q $$RPM | grep "^package")    ;    \
 294         done                                                       ;    \
 295         if [ -n "$$MISSING" ] ; then \
 296           echo "Please install missing RPMs: \n$$MISSING\n" ; \
 297           echo "by executing \"make install-dep\"\n" ; \
 298           exit 1 ; \
 299         fi ; \
 300         exit 0
 301 endif
 302         @touch $@
 303
 304 .PHONY: bootstrap
 305 bootstrap:
 306         @echo "'make bootstrap' is not needed anymore"
 307
 308 .PHONY: install-dep
 309 install-dep:
 310 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
 311         @sudo -E apt-get update
 312         @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
 313 else ifneq ("$(wildcard /etc/redhat-release)","")
 314 ifeq ($(OS_ID),rhel)
 315         @sudo -E yum-config-manager --enable rhel-server-rhscl-7-rpms
 316         @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 317         @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
 318         @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
 319 else ifeq ($(OS_ID)-$(OS_VERSION_ID),centos-8)
 320         @sudo -E dnf install $(CONFIRM) dnf-plugins-core epel-release
 321         @sudo -E dnf config-manager --set-enabled \
 322           $(shell dnf repolist all 2>/dev/null|grep -i powertools|cut -d' ' -f1|grep -v source)
 323         @sudo -E dnf groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 324         @sudo -E dnf install --skip-broken $(CONFIRM) $(RPM_DEPENDS)
 325 else ifeq ($(OS_ID),centos)
 326         @sudo -E yum install $(CONFIRM) centos-release-scl-rh epel-release
 327         @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 328         @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
 329         @sudo -E yum install $(CONFIRM) --enablerepo=base-debuginfo $(RPM_DEPENDS_DEBUG)
 330 else ifeq ($(OS_ID),fedora)
 331         @sudo -E dnf groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 332         @sudo -E dnf install $(CONFIRM) $(RPM_DEPENDS)
 333         @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
 334 endif
 335 else ifeq ($(filter opensuse-leap,$(OS_ID)),$(OS_ID))
 336         @sudo -E zypper refresh
 337         @sudo -E zypper install  -y $(RPM_SUSE_DEPENDS)
 338 else
 339         $(error "This option currently works only on Ubuntu, Debian, RHEL, CentOS or openSUSE-leap systems")
 340 endif
 341         git config commit.template .git_commit_template.txt
 342
 343 .PHONY: install-deps
 344 install-deps: install-dep
 345
 346 define make
 347         @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
 348 endef
 349
 350 $(BR)/scripts/.version:
 351 ifneq ("$(wildcard /etc/redhat-release)","")
 352         $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
 353 else
 354         $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
 355 endif
 356
 357 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
 358 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
 359
 360 .PHONY: dist
 361 dist:
 362         @if git rev-parse 2> /dev/null ; then \
 363             git archive \
 364               --prefix=$(DIST_SUBDIR)/ \
 365               --format=tar \
 366               -o $(DIST_FILE) \
 367             HEAD ; \
 368             git describe --long > $(BR)/.version ; \
 369         else \
 370             (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
 371             src/scripts/version > $(BR)/.version ; \
 372         fi
 373         @tar --append \
 374           --file $(DIST_FILE) \
 375           --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
 376           $(BR)/.version
 377         @$(RM) $(BR)/.version $(DIST_FILE).xz
 378         @xz -v --threads=0 $(DIST_FILE)
 379         @$(RM) $(BR)/vpp-latest.tar.xz
 380         @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
 381
 382 .PHONY: build
 383 build: $(BR)/.deps.ok
 384         $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
 385
 386 .PHONY: wipedist
 387 wipedist:
 388         @$(RM) $(BR)/*.tar.xz
 389
 390 .PHONY: wipe
 391 wipe: wipedist test-wipe $(BR)/.deps.ok
 392         $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
 393         @find . -type f -name "*.api.json" ! -path "./src/*" -exec rm {} \;
 394
 395 .PHONY: rebuild
 396 rebuild: wipe build
 397
 398 .PHONY: build-release
 399 build-release: $(BR)/.deps.ok
 400         $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
 401
 402 .PHONY: wipe-release
 403 wipe-release: test-wipe $(BR)/.deps.ok
 404         $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
 405
 406 .PHONY: rebuild-release
 407 rebuild-release: wipe-release build-release
 408
 409 export TEST_DIR ?= $(WS_ROOT)/test
 410
 411 define test
 412         $(if $(filter-out $(2),retest),make -C $(BR) PLATFORM=vpp TAG=$(1) vpp-install,)
 413         $(eval libs:=lib lib64)
 414         make -C test \
 415           VPP_BUILD_DIR=$(BR)/build-$(1)-native/vpp \
 416           VPP_BIN=$(BR)/install-$(1)-native/vpp/bin/vpp \
 417           VPP_INSTALL_PATH=$(BR)/install-$(1)-native/ \
 418           EXTENDED_TESTS=$(EXTENDED_TESTS) \
 419           PYTHON=$(PYTHON) \
 420           OS_ID=$(OS_ID) \
 421           RND_SEED=$(RND_SEED) \
 422           CACHE_OUTPUT=$(CACHE_OUTPUT) \
 423           TAG=$(1) \
 424           $(2)
 425 endef
 426
 427 .PHONY: test
 428 test:
 429         $(call test,vpp,test)
 430
 431 .PHONY: test-debug
 432 test-debug:
 433         $(call test,vpp_debug,test)
 434
 435 .PHONY: test-gcov
 436 test-gcov:
 437         $(call test,vpp_gcov,test)
 438
 439 .PHONY: test-all
 440 test-all:
 441         $(eval EXTENDED_TESTS=1)
 442         $(call test,vpp,test)
 443
 444 .PHONY: test-all-debug
 445 test-all-debug:
 446         $(eval EXTENDED_TESTS=1)
 447         $(call test,vpp_debug,test)
 448
 449 .PHONY: papi-wipe
 450 papi-wipe: test-wipe-papi
 451         $(call banner,"This command is deprecated. Please use 'test-wipe-papi'")
 452
 453 .PHONY: test-wipe-papi
 454 test-wipe-papi:
 455         @make -C test wipe-papi
 456
 457 .PHONY: test-help
 458 test-help:
 459         @make -C test help
 460
 461 .PHONY: test-wipe
 462 test-wipe:
 463         @make -C test wipe
 464
 465 .PHONY: test-shell
 466 test-shell:
 467         $(call test,vpp,shell)
 468
 469 .PHONY: test-shell-debug
 470 test-shell-debug:
 471         $(call test,vpp_debug,shell)
 472
 473 .PHONY: test-shell-gcov
 474 test-shell-gcov:
 475         $(call test,vpp_gcov,shell)
 476
 477 .PHONY: test-dep
 478 test-dep:
 479         @make -C test test-dep
 480
 481 .PHONY: test-doc
 482 test-doc:
 483         @echo "make test-doc is DEPRECATED: use 'make docs'"
 484         sleep 300
 485
 486 .PHONY: test-wipe-doc
 487 test-wipe-doc:
 488         @echo "make test-wipe-doc is DEPRECATED"
 489         sleep 300
 490
 491 .PHONY: test-cov
 492 test-cov:
 493         $(eval EXTENDED_TESTS=1)
 494         $(call test,vpp_gcov,cov)
 495
 496 .PHONY: test-wipe-cov
 497 test-wipe-cov:
 498         @make -C test wipe-cov
 499
 500 .PHONY: test-wipe-all
 501 test-wipe-all:
 502         @make -C test wipe-all
 503
 504 # Note: All python venv consolidated in test/Makefile, test/requirements*.txt
 505 .PHONY: test-checkstyle
 506 test-checkstyle:
 507         $(warning test-checkstyle is deprecated. Running checkstyle-python.")
 508         @make -C test checkstyle-python-all
 509
 510 # Note: All python venv consolidated in test/Makefile, test/requirements*.txt
 511 .PHONY: test-checkstyle-diff
 512 test-checkstyle-diff:
 513         $(warning test-checkstyle-diff is deprecated. Running checkstyle-python.")
 514         @make -C test checkstyle-python-all
 515
 516 .PHONY: test-refresh-deps
 517 test-refresh-deps:
 518         @make -C test refresh-deps
 519
 520 .PHONY: retest
 521 retest:
 522         $(call test,vpp,retest)
 523
 524 .PHONY: retest-debug
 525 retest-debug:
 526         $(call test,vpp_debug,retest)
 527
 528 .PHONY: retest-all
 529 retest-all:
 530         $(eval EXTENDED_TESTS=1)
 531         $(call test,vpp,retest)
 532
 533 .PHONY: retest-all-debug
 534 retest-all-debug:
 535         $(eval EXTENDED_TESTS=1)
 536         $(call test,vpp_debug,retest)
 537
 538 .PHONY: test-start-vpp-in-gdb
 539 test-start-vpp-in-gdb:
 540         $(call test,vpp,start-gdb)
 541
 542 .PHONY: test-start-vpp-debug-in-gdb
 543 test-start-vpp-debug-in-gdb:
 544         $(call test,vpp_debug,start-gdb)
 545
 546 ifeq ("$(wildcard $(STARTUP_CONF))","")
 547 define run
 548         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
 549         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
 550         @cd $(STARTUP_DIR) && \
 551           $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
 552 endef
 553 else
 554 define run
 555         @cd $(STARTUP_DIR) && \
 556           $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
 557 endef
 558 endif
 559
 560 %.files: .FORCE
 561         @find src -name '*.[chS]' > $@
 562
 563 .FORCE:
 564
 565 .PHONY: run
 566 run:
 567         $(call run, $(BR)/install-$(PLATFORM)_debug-native)
 568
 569 .PHONY: run-release
 570 run-release:
 571         $(call run, $(BR)/install-$(PLATFORM)-native)
 572
 573 .PHONY: debug
 574 debug:
 575         $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
 576
 577 .PHONY: build-coverity
 578 build-coverity:
 579         $(call make,$(PLATFORM)_coverity,install-packages)
 580         @make -C build-root PLATFORM=vpp TAG=vpp_coverity libmemif-install
 581
 582 .PHONY: debug-release
 583 debug-release:
 584         $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
 585
 586 .PHONY: build-vat
 587 build-vat:
 588         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
 589
 590 .PHONY: run-vat
 591 run-vat:
 592         @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
 593
 594 .PHONY: pkg-deb
 595 pkg-deb:
 596         $(call make,$(PLATFORM),vpp-package-deb)
 597
 598 .PHONY: pkg-snap
 599 pkg-snap:
 600         cd extras/snap ;                        \
 601         ./prep ;                                \
 602         SNAPCRAFT_BUILD_ENVIRONMENT_MEMORY=8G   \
 603         SNAPCRAFT_BUILD_ENVIRONMENT_CPU=6       \
 604         snapcraft --debug
 605
 606 .PHONY: snap-clean
 607 snap-clean:
 608         cd extras/snap ;                        \
 609         snapcraft clean ;                       \
 610         rm -f *.snap *.tgz
 611
 612 .PHONY: pkg-deb-debug
 613 pkg-deb-debug:
 614         $(call make,$(PLATFORM)_debug,vpp-package-deb)
 615
 616 .PHONY: pkg-rpm
 617 pkg-rpm: dist
 618         make -C extras/rpm
 619
 620 .PHONY: pkg-srpm
 621 pkg-srpm: dist
 622         make -C extras/rpm srpm
 623
 624 .PHONY: install-ext-deps
 625 install-ext-deps:
 626         make -C build/external install-$(PKG)
 627
 628 .PHONY: install-ext-dep
 629 install-ext-dep: install-ext-deps
 630
 631 .PHONY: json-api-files
 632 json-api-files:
 633         $(WS_ROOT)/src/tools/vppapigen/generate_json.py
 634
 635 .PHONY: json-api-files-debug
 636 json-api-files-debug:
 637         $(WS_ROOT)/src/tools/vppapigen/generate_json.py --debug-target
 638
 639 .PHONY: go-api-files
 640 go-api-files: json-api-files
 641         $(WS_ROOT)/src/tools/vppapigen/generate_go.py $(ARGS)
 642
 643 .PHONY: ctags
 644 ctags: ctags.files
 645         @ctags --totals --tag-relative=yes -L $<
 646         @rm $<
 647
 648 .PHONY: gtags
 649 gtags: ctags
 650         @gtags --gtagslabel=ctags
 651
 652 .PHONY: cscope
 653 cscope: cscope.files
 654         @cscope -b -q -v
 655
 656 .PHONY: compdb
 657 compdb:
 658         @ninja -C build-root/build-vpp_debug-native/vpp build.ninja
 659         @ninja -C build-root/build-vpp_debug-native/vpp -t compdb | \
 660           src/scripts/compdb_cleanup.py > compile_commands.json
 661
 662 .PHONY: checkstyle
 663 checkstyle: checkfeaturelist
 664         @extras/scripts/checkstyle.sh
 665
 666 .PHONY: checkstyle-commit
 667 checkstyle-commit:
 668         @extras/scripts/check_commit_msg.sh
 669
 670 .PHONY: checkstyle-test
 671 checkstyle-test:
 672         $(warning test-checkstyle is deprecated. Running checkstyle-python.")
 673         @make -C test checkstyle-python-all
 674
 675 # Note: All python venv consolidated in test/Makefile, test/requirements*.txt
 676 .PHONY: checkstyle-python
 677 checkstyle-python:
 678         @make -C test checkstyle-python-all
 679
 680 .PHONY: checkstyle-all
 681 checkstyle-all: checkstyle-commit checkstyle checkstyle-python
 682
 683 .PHONY: fixstyle
 684 fixstyle:
 685         @extras/scripts/checkstyle.sh --fix
 686
 687 # Note: All python venv consolidated in test/Makefile, test/requirements*.txt
 688 .PHONY: fixstyle-python
 689 fixstyle-python:
 690         @make -C test fixstyle-python-all
 691
 692 .PHONY: checkstyle-api
 693 checkstyle-api:
 694         @extras/scripts/crcchecker.py --check-patchset
 695
 696 # necessary because Bug 1696324 - Update to python3.6 breaks PyYAML dependencies
 697 # Status:       CLOSED CANTFIX
 698 # https://bugzilla.redhat.com/show_bug.cgi?id=1696324
 699 .PHONY: centos-pyyaml
 700 centos-pyyaml:
 701 ifeq ($(OS_ID)-$(OS_VERSION_ID),centos-8)
 702         @sudo -E yum install $(CONFIRM) python3-pyyaml
 703 endif
 704
 705 .PHONY: featurelist
 706 featurelist: centos-pyyaml
 707         @extras/scripts/fts.py --all --markdown
 708
 709 .PHONY: checkfeaturelist
 710 checkfeaturelist: centos-pyyaml
 711         @extras/scripts/fts.py --validate --all
 712
 713 #
 714 # Build the documentation
 715 #
 716
 717 .PHONY: bootstrap-doxygen
 718 bootstrap-doxygen:
 719         @echo "make bootstrap-doxygen is DEPRECATED"
 720         sleep 300
 721
 722 .PHONY: doxygen
 723 doxygen: docs
 724         @echo "make doxygen is DEPRECATED: use 'make docs'"
 725         sleep 300
 726
 727 .PHONY: wipe-doxygen
 728 wipe-doxygen:
 729         @echo "make wipe-doxygen is DEPRECATED"
 730         sleep 300
 731
 732 .PHONY: docs-%
 733 docs-%:
 734         @make -C $(WS_ROOT)/docs $*
 735
 736 .PHONY: docs
 737 docs:
 738         @make -C $(WS_ROOT)/docs docs
 739
 740 .PHONY: pkg-verify
 741 pkg-verify: install-dep $(BR)/.deps.ok install-ext-deps
 742         $(call banner,"Building for PLATFORM=vpp using gcc")
 743         @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
 744         $(call banner,"Building sample-plugin")
 745         @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
 746         $(call banner,"Building libmemif")
 747         @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
 748         $(call banner,"Building $(PKG) packages")
 749         @make pkg-$(PKG)
 750
 751 MAKE_VERIFY_GATE_OS ?= ubuntu-20.04
 752 .PHONY: verify
 753 verify: pkg-verify
 754 ifeq ($(OS_ID)-$(OS_VERSION_ID),$(MAKE_VERIFY_GATE_OS))
 755         $(call banner,"Testing vppapigen")
 756         @src/tools/vppapigen/test_vppapigen.py
 757         $(call banner,"Running tests")
 758         @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test
 759 else
 760         $(call banner,"Skipping tests. Tests under 'make verify' supported on $(MAKE_VERIFY_GATE_OS)")
 761 endif