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