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