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