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