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