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