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