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 += 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 # python3.6 on 16.04 requires python36-dev
  76
  77 LIBFFI=libffi6 # works on all but 20.04 and debian-testing
  78
  79 ifeq ($(OS_VERSION_ID),18.04)
  80         DEB_DEPENDS += python-dev python-all python-pip python-virtualenv
  81         DEB_DEPENDS += libssl-dev
  82         DEB_DEPENDS += clang-9 clang-format-10
  83 else ifeq ($(OS_VERSION_ID),20.04)
  84         DEB_DEPENDS += python3-virtualenv
  85         DEB_DEPENDS += libssl-dev
  86         DEB_DEPENDS += libelf-dev # for libbpf (af_xdp)
  87         DEB_DEPENDS += clang-format-10
  88         LIBFFI=libffi7
  89 else ifeq ($(OS_VERSION_ID),20.10)
  90         DEB_DEPENDS += python3-virtualenv
  91         DEB_DEPENDS += libssl-dev
  92         DEB_DEPENDS += libelf-dev # for libbpf (af_xdp)
  93         DEB_DEPENDS += 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
 120 ifeq ($(OS_ID),fedora)
 121         RPM_DEPENDS += dnf-utils
 122         RPM_DEPENDS += subunit subunit-devel
 123         RPM_DEPENDS += compat-openssl10-devel
 124         RPM_DEPENDS += python3-devel  # needed for python3 -m pip install psutil
 125         RPM_DEPENDS += python3-ply  # for vppapigen
 126         RPM_DEPENDS += python3-virtualenv python3-jsonschema
 127         RPM_DEPENDS += cmake
 128         RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
 129 else ifeq ($(OS_ID)-$(OS_VERSION_ID),centos-8)
 130         RPM_DEPENDS += yum-utils
 131         RPM_DEPENDS += compat-openssl10 openssl-devel
 132         RPM_DEPENDS += python2-devel python36-devel python3-ply
 133         RPM_DEPENDS += python3-virtualenv python3-jsonschema
 134         RPM_DEPENDS += cmake
 135         RPM_DEPENDS_GROUPS = 'Development Tools'
 136 else
 137         RPM_DEPENDS += yum-utils
 138         RPM_DEPENDS += openssl-devel
 139         RPM_DEPENDS += python36-ply  # for vppapigen
 140         RPM_DEPENDS += python3-devel python3-pip
 141         RPM_DEPENDS += python-virtualenv python36-jsonschema
 142         RPM_DEPENDS += devtoolset-9 devtoolset-9-libasan-devel
 143         RPM_DEPENDS += cmake3
 144         RPM_DEPENDS_GROUPS = 'Development Tools'
 145 endif
 146
 147 # +ganglia-devel if building the ganglia plugin
 148
 149 RPM_DEPENDS += chrpath libffi-devel rpm-build
 150
 151 RPM_DEPENDS_DEBUG  = glibc-debuginfo e2fsprogs-debuginfo
 152 RPM_DEPENDS_DEBUG += krb5-debuginfo openssl-debuginfo
 153 RPM_DEPENDS_DEBUG += zlib-debuginfo nss-softokn-debuginfo
 154 RPM_DEPENDS_DEBUG += yum-plugin-auto-update-debug-info
 155
 156 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
 157         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
 158 endif
 159
 160 ifeq ($(findstring y,$(UNATTENDED)),y)
 161 CONFIRM=-y
 162 FORCE=--force-yes
 163 endif
 164
 165 TARGETS = vpp
 166
 167 ifneq ($(SAMPLE_PLUGIN),no)
 168 TARGETS += sample-plugin
 169 endif
 170
 171 define banner
 172         @echo "========================================================================"
 173         @echo " $(1)"
 174         @echo "========================================================================"
 175         @echo " "
 176 endef
 177
 178 .PHONY: help
 179 help:
 180         @echo "Make Targets:"
 181         @echo " install-dep[s]       - install software dependencies"
 182         @echo " wipe                 - wipe all products of debug build "
 183         @echo " wipe-release         - wipe all products of release build "
 184         @echo " build                - build debug binaries"
 185         @echo " build-release        - build release binaries"
 186         @echo " build-coverity       - build coverity artifacts"
 187         @echo " rebuild              - wipe and build debug binaries"
 188         @echo " rebuild-release      - wipe and build release binaries"
 189         @echo " run                  - run debug binary"
 190         @echo " run-release          - run release binary"
 191         @echo " debug                - run debug binary with debugger"
 192         @echo " debug-release        - run release binary with debugger"
 193         @echo " test                 - build and run tests"
 194         @echo " test-help            - show help on test framework"
 195         @echo " run-vat              - run vpp-api-test tool"
 196         @echo " pkg-deb              - build DEB packages"
 197         @echo " pkg-deb-debug        - build DEB debug packages"
 198         @echo " pkg-snap             - build SNAP package"
 199         @echo " snap-clean           - clean up snap build environment"
 200         @echo " pkg-rpm              - build RPM packages"
 201         @echo " install-ext-dep[s]   - install external development dependencies"
 202         @echo " ctags                - (re)generate ctags database"
 203         @echo " gtags                - (re)generate gtags database"
 204         @echo " cscope               - (re)generate cscope database"
 205         @echo " compdb               - (re)generate compile_commands.json"
 206         @echo " checkstyle           - check coding style"
 207         @echo " checkstyle-commit    - check commit message format"
 208         @echo " checkstyle-test      - check test framework coding style"
 209         @echo " checkstyle-test-diff - check test framework coding style (only changed files)"
 210         @echo " checkstyle-api       - check api for incompatible changes"
 211         @echo " fixstyle             - fix coding style"
 212         @echo " doxygen              - (re)generate documentation"
 213         @echo " bootstrap-doxygen    - setup Doxygen dependencies"
 214         @echo " wipe-doxygen         - wipe all generated documentation"
 215         @echo " checkfeaturelist     - check FEATURE.yaml according to schema"
 216         @echo " featurelist          - dump feature list in markdown"
 217         @echo " json-api-files       - (re)-generate json api files"
 218         @echo " json-api-files-debug - (re)-generate json api files for debug target"
 219         @echo " go-api-files         - (re)-generate golang api files"
 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 " stats-fs-help        - Help to build the stats segment file system"
 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 $(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         $(eval EXTENDED_TESTS=yes)
 419         $(call test,vpp,vpp,test)
 420
 421 .PHONY: test-all-debug
 422 test-all-debug:
 423         $(eval EXTENDED_TESTS=yes)
 424         $(call test,vpp,vpp_debug,test)
 425
 426 .PHONY: papi-wipe
 427 papi-wipe: test-wipe-papi
 428         $(call banner,"This command is deprecated. Please use 'test-wipe-papi'")
 429
 430 .PHONY: test-wipe-papi
 431 test-wipe-papi:
 432         @make -C test wipe-papi
 433
 434 .PHONY: test-help
 435 test-help:
 436         @make -C test help
 437
 438 .PHONY: test-wipe
 439 test-wipe:
 440         @make -C test wipe
 441
 442 .PHONY: test-shell
 443 test-shell:
 444         $(call test,vpp,vpp,shell)
 445
 446 .PHONY: test-shell-debug
 447 test-shell-debug:
 448         $(call test,vpp,vpp_debug,shell)
 449
 450 .PHONY: test-shell-gcov
 451 test-shell-gcov:
 452         $(call test,vpp,vpp_gcov,shell)
 453
 454 .PHONY: test-dep
 455 test-dep:
 456         @make -C test test-dep
 457
 458 .PHONY: test-doc
 459 test-doc:
 460         @make -C test doc
 461
 462 .PHONY: test-wipe-doc
 463 test-wipe-doc:
 464         @make -C test wipe-doc
 465
 466 .PHONY: test-cov
 467 test-cov:
 468         $(eval EXTENDED_TESTS=yes)
 469         $(call test,vpp,vpp_gcov,cov)
 470
 471 .PHONY: test-wipe-cov
 472 test-wipe-cov:
 473         @make -C test wipe-cov
 474
 475 .PHONY: test-wipe-all
 476 test-wipe-all:
 477         @make -C test wipe-all
 478
 479 .PHONY: test-checkstyle
 480 test-checkstyle:
 481         @make -C test checkstyle
 482
 483 .PHONY: test-checkstyle-diff
 484 test-checkstyle-diff:
 485         @make -C test checkstyle-diff
 486
 487 .PHONY: test-refresh-deps
 488 test-refresh-deps:
 489         @make -C test refresh-deps
 490
 491 .PHONY: retest
 492 retest:
 493         $(call test,vpp,vpp,retest)
 494
 495 .PHONY: retest-debug
 496 retest-debug:
 497         $(call test,vpp,vpp_debug,retest)
 498
 499 .PHONY: retest-all
 500 retest-all:
 501         $(eval EXTENDED_TESTS=yes)
 502         $(call test,vpp,vpp,retest)
 503
 504 .PHONY: retest-all-debug
 505 retest-all-debug:
 506         $(eval EXTENDED_TESTS=yes)
 507         $(call test,vpp,vpp_debug,retest)
 508
 509 .PHONY: test-start-vpp-in-gdb
 510 test-start-vpp-in-gdb:
 511         $(call test,vpp,vpp,start-gdb)
 512
 513 .PHONY: test-start-vpp-debug-in-gdb
 514 test-start-vpp-debug-in-gdb:
 515         $(call test,vpp,vpp_debug,start-gdb)
 516
 517 ifeq ("$(wildcard $(STARTUP_CONF))","")
 518 define run
 519         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
 520         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
 521         @cd $(STARTUP_DIR) && \
 522           $(SUDO) $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF)
 523 endef
 524 else
 525 define run
 526         @cd $(STARTUP_DIR) && \
 527           $(SUDO) $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//')
 528 endef
 529 endif
 530
 531 %.files: .FORCE
 532         @find src -name '*.[chS]' > $@
 533
 534 .FORCE:
 535
 536 .PHONY: run
 537 run:
 538         $(call run, $(BR)/install-$(PLATFORM)_debug-native)
 539
 540 .PHONY: run-release
 541 run-release:
 542         $(call run, $(BR)/install-$(PLATFORM)-native)
 543
 544 .PHONY: debug
 545 debug:
 546         $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
 547
 548 .PHONY: build-coverity
 549 build-coverity:
 550         $(call make,$(PLATFORM)_coverity,install-packages)
 551         @make -C build-root PLATFORM=vpp TAG=vpp_coverity libmemif-install
 552
 553 .PHONY: debug-release
 554 debug-release:
 555         $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
 556
 557 .PHONY: build-vat
 558 build-vat:
 559         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
 560
 561 .PHONY: run-vat
 562 run-vat:
 563         @$(SUDO) $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
 564
 565 .PHONY: pkg-deb
 566 pkg-deb:
 567         $(call make,$(PLATFORM),vpp-package-deb)
 568
 569 .PHONY: pkg-snap
 570 pkg-snap:
 571         cd extras/snap ;                        \
 572         ./prep ;                                \
 573         SNAPCRAFT_BUILD_ENVIRONMENT_MEMORY=8G   \
 574         SNAPCRAFT_BUILD_ENVIRONMENT_CPU=6       \
 575         snapcraft --debug
 576
 577 .PHONY: snap-clean
 578 snap-clean:
 579         cd extras/snap ;                        \
 580         snapcraft clean ;                       \
 581         rm -f *.snap *.tgz
 582
 583 .PHONY: pkg-deb-debug
 584 pkg-deb-debug:
 585         $(call make,$(PLATFORM)_debug,vpp-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: install-ext-deps
 596 install-ext-deps:
 597         make -C build/external install-$(PKG)
 598
 599 .PHONY: install-ext-dep
 600 install-ext-dep: install-ext-deps
 601
 602 .PHONY: json-api-files
 603 json-api-files:
 604         $(WS_ROOT)/src/tools/vppapigen/generate_json.py
 605
 606 .PHONY: json-api-files-debug
 607 json-api-files-debug:
 608         $(WS_ROOT)/src/tools/vppapigen/generate_json.py --debug-target
 609
 610 .PHONY: go-api-files
 611 go-api-files: json-api-files
 612         $(WS_ROOT)/src/tools/vppapigen/generate_go.py
 613
 614 .PHONY: ctags
 615 ctags: ctags.files
 616         @ctags --totals --tag-relative=yes -L $<
 617         @rm $<
 618
 619 .PHONY: gtags
 620 gtags: ctags
 621         @gtags --gtagslabel=ctags
 622
 623 .PHONY: cscope
 624 cscope: cscope.files
 625         @cscope -b -q -v
 626
 627 .PHONY: compdb
 628 compdb:
 629         @ninja -C build-root/build-vpp_debug-native/vpp build.ninja
 630         @ninja -C build-root/build-vpp_debug-native/vpp -t compdb | \
 631           src/scripts/compdb_cleanup.py > compile_commands.json
 632
 633 .PHONY: checkstyle
 634 checkstyle: checkfeaturelist
 635         @extras/scripts/checkstyle.sh
 636
 637 .PHONY: checkstyle-commit
 638 checkstyle-commit:
 639         @extras/scripts/check_commit_msg.sh
 640
 641 .PHONY: checkstyle-test
 642 checkstyle-test: test-checkstyle
 643
 644 .PHONY: checkstyle-all
 645 checkstyle-all: checkstyle-commit checkstyle checkstyle-test
 646
 647 .PHONY: fixstyle
 648 fixstyle:
 649         @extras/scripts/checkstyle.sh --fix
 650
 651 .PHONY: checkstyle-api
 652 checkstyle-api:
 653         @extras/scripts/crcchecker.py --check-patchset
 654
 655 # necessary because Bug 1696324 - Update to python3.6 breaks PyYAML dependencies
 656 # Status:       CLOSED CANTFIX
 657 # https://bugzilla.redhat.com/show_bug.cgi?id=1696324
 658 .PHONY: centos-pyyaml
 659 centos-pyyaml:
 660 ifeq ($(OS_ID)-$(OS_VERSION_ID),centos-8)
 661         @sudo -E yum install $(CONFIRM) python3-pyyaml
 662 endif
 663
 664 .PHONY: featurelist
 665 featurelist: centos-pyyaml
 666         @extras/scripts/fts.py --all --markdown
 667
 668 .PHONY: checkfeaturelist
 669 checkfeaturelist: centos-pyyaml
 670         @extras/scripts/fts.py --validate --all
 671
 672
 673 # Build vpp_stats_fs
 674
 675 .PHONY: stats-fs-install
 676 stats-fs-install:
 677         @extras/vpp_stats_fs/install.sh install
 678
 679 .PHONY: stats-fs-start
 680 stats-fs-start:
 681         @extras/vpp_stats_fs/install.sh start
 682
 683 .PHONY: stats-fs-cleanup
 684 stats-fs-cleanup:
 685         @extras/vpp_stats_fs/install.sh cleanup
 686
 687 .PHONY: stats-fs-help
 688 stats-fs-help:
 689         @extras/vpp_stats_fs/install.sh help
 690
 691 .PHONY: stats-fs-force-unmount
 692 stats-fs-force-unmount:
 693         @extras/vpp_stats_fs/install.sh unmount
 694
 695 .PHONY: stats-fs-stop
 696 stats-fs-stop:
 697         @extras/vpp_stats_fs/install.sh stop
 698
 699 #
 700 # Build the documentation
 701 #
 702
 703 # Doxygen configuration and our utility scripts
 704 export DOXY_DIR ?= $(WS_ROOT)/doxygen
 705
 706 define make-doxy
 707         @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
 708 endef
 709
 710 .PHONY: bootstrap-doxygen
 711 bootstrap-doxygen:
 712         $(call make-doxy)
 713
 714 .PHONY: doxygen
 715 doxygen: bootstrap-doxygen
 716         $(call make-doxy)
 717
 718 .PHONY: wipe-doxygen
 719 wipe-doxygen:
 720         $(call make-doxy)
 721
 722 # Sphinx Documents
 723 export DOCS_DIR = $(WS_ROOT)/docs
 724 export VENV_DIR = $(WS_ROOT)/sphinx_venv
 725 export SPHINX_SCRIPTS_DIR = $(WS_ROOT)/docs/scripts
 726
 727 .PHONY: docs-venv
 728 docs-venv:
 729         @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh venv)
 730
 731 .PHONY: docs
 732 docs: $(DOCS_DIR)
 733         @($(SPHINX_SCRIPTS_DIR)/sphinx-make.sh html)
 734
 735 .PHONY: docs-clean
 736 docs-clean:
 737         @rm -rf $(DOCS_DIR)/_build
 738         @rm -rf $(VENV_DIR)
 739
 740 .PHONY: pkg-verify
 741 pkg-verify: install-dep $(BR)/.deps.ok install-ext-deps
 742         $(call banner,"Building for PLATFORM=vpp using gcc")
 743         @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
 744         $(call banner,"Building sample-plugin")
 745         @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
 746         $(call banner,"Building libmemif")
 747         @make -C build-root PLATFORM=vpp TAG=vpp libmemif-install
 748         $(call banner,"Building $(PKG) packages")
 749         @make pkg-$(PKG)
 750
 751 MAKE_VERIFY_GATE_OS ?= ubuntu-18.04
 752 .PHONY: verify
 753 verify: pkg-verify
 754 ifeq ($(OS_ID)-$(OS_VERSION_ID),$(MAKE_VERIFY_GATE_OS))
 755         $(call banner,"Testing vppapigen")
 756         @src/tools/vppapigen/test_vppapigen.py
 757         $(call banner,"Running tests")
 758         @make COMPRESS_FAILED_TEST_LOGS=yes RETRIES=3 test
 759 else
 760         $(call banner,"Skipping tests. Tests under 'make verify' supported on $(MAKE_VERIFY_GATE_OS)")
 761 endif