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