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