Makefile

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