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