Makefile

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