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