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
  21 ,:=,
  22 define disable_plugins
  23 $(if $(1), \
  24   "plugins {" \
  25   $(patsubst %,"plugin %_plugin.so { disable }",$(subst $(,), ,$(1))) \
  26   " }" \
  27   ,)
  28 endef
  29
  30 MINIMAL_STARTUP_CONF="                                                  \
  31 unix {                                                                  \
  32         interactive                                                     \
  33         cli-listen /run/vpp/cli.sock                                    \
  34         gid $(shell id -g)                                              \
  35         $(if $(wildcard startup.vpp),"exec startup.vpp",)               \
  36 }                                                                       \
  37 $(if $(DPDK_CONFIG), "dpdk { $(DPDK_CONFIG) }",)                        \
  38 $(call disable_plugins,$(DISABLED_PLUGINS))                             \
  39 "
  40
  41 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
  42
  43 #
  44 # OS Detection
  45 #
  46 # We allow Darwin (MacOS) for docs generation; VPP build will still fail.
  47 ifneq ($(shell uname),Darwin)
  48 OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
  49 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
  50 endif
  51
  52 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
  53 PKG=deb
  54 else ifeq ($(filter rhel centos fedora opensuse,$(OS_ID)),$(OS_ID))
  55 PKG=rpm
  56 endif
  57
  58 # +libganglia1-dev if building the gmond plugin
  59
  60 DEB_DEPENDS  = curl build-essential autoconf automake bison libssl-dev ccache
  61 DEB_DEPENDS += debhelper dkms git libtool libapr1-dev dh-systemd
  62 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
  63 DEB_DEPENDS += lcov chrpath autoconf nasm indent
  64 DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6
  65 ifeq ($(OS_VERSION_ID),14.04)
  66         DEB_DEPENDS += openjdk-8-jdk-headless
  67 else ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
  68         DEB_DEPENDS += openjdk-8-jdk-headless
  69         APT_ARGS = -t jessie-backports
  70 else
  71         DEB_DEPENDS += default-jdk-headless
  72 endif
  73
  74 RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
  75 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
  76 RPM_DEPENDS += python-devel
  77 ifeq ($(OS_ID)-$(OS_VERSION_ID),fedora-25)
  78         RPM_DEPENDS += python2-virtualenv
  79         RPM_DEPENDS_GROUPS = 'C Development Tools and Libraries'
  80 else
  81         RPM_DEPENDS += python-virtualenv
  82         RPM_DEPENDS_GROUPS = 'Development Tools'
  83 endif
  84
  85 # +ganglia-devel if building the ganglia plugin
  86
  87 RPM_DEPENDS += chrpath libffi-devel rpm-build
  88 ifeq ($(OS_ID),fedora)
  89         RPM_DEPENDS += nasm
  90 else
  91         RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
  92 endif
  93 EPEL_DEPENDS = libconfuse-devel epel-rpm-macros
  94 ifeq ($(filter rhel centos,$(OS_ID)),$(OS_ID))
  95         EPEL_DEPENDS += lcov
  96 else
  97         RPM_DEPENDS += lcov
  98 endif
  99
 100 RPM_SUSE_DEPENDS = autoconf automake bison ccache chrpath distribution-release gcc6 glibc-devel-static
 101 RPM_SUSE_DEPENDS += java-1_8_0-openjdk-devel libopenssl-devel libtool lsb-release make openssl-devel
 102 RPM_SUSE_DEPENDS += python-devel python-pip python-rpm-macros shadow nasm
 103
 104 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
 105         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
 106 endif
 107
 108 ifeq ($(findstring y,$(UNATTENDED)),y)
 109 CONFIRM=-y
 110 FORCE=--force-yes
 111 endif
 112
 113 TARGETS = vpp
 114
 115 ifneq ($(SAMPLE_PLUGIN),no)
 116 TARGETS += sample-plugin
 117 endif
 118
 119 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
 120 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
 121 .PHONY: ctags cscope
 122 .PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
 123 .PHONY: test-cov test-wipe-cov
 124
 125 help:
 126         @echo "Make Targets:"
 127         @echo " bootstrap           - prepare tree for build"
 128         @echo " install-dep         - install software dependencies"
 129         @echo " wipe                - wipe all products of debug build "
 130         @echo " wipe-release        - wipe all products of release build "
 131         @echo " build               - build debug binaries"
 132         @echo " build-release       - build release binaries"
 133         @echo " build-coverity      - build coverity artifacts"
 134         @echo " rebuild             - wipe and build debug binares"
 135         @echo " rebuild-release     - wipe and build release binares"
 136         @echo " run                 - run debug binary"
 137         @echo " run-release         - run release binary"
 138         @echo " debug               - run debug binary with debugger"
 139         @echo " debug-release       - run release binary with debugger"
 140         @echo " test                - build and run (basic) functional tests"
 141         @echo " test-debug          - build and run (basic) functional tests (debug build)"
 142         @echo " test-all            - build and run (all) functional tests"
 143         @echo " test-all-debug      - build and run (all) functional tests (debug build)"
 144         @echo " test-shell          - enter shell with test environment"
 145         @echo " test-shell-debug    - enter shell with test environment (debug build)"
 146         @echo " test-wipe           - wipe files generated by unit tests"
 147         @echo " retest              - run functional tests"
 148         @echo " retest-debug        - run functional tests (debug build)"
 149         @echo " test-help           - show help on test framework"
 150         @echo " run-vat             - run vpp-api-test tool"
 151         @echo " pkg-deb             - build DEB packages"
 152         @echo " pkg-rpm             - build RPM packages"
 153         @echo " dpdk-install-dev    - install DPDK development packages"
 154         @echo " ctags               - (re)generate ctags database"
 155         @echo " gtags               - (re)generate gtags database"
 156         @echo " cscope              - (re)generate cscope database"
 157         @echo " checkstyle          - check coding style"
 158         @echo " fixstyle            - fix coding style"
 159         @echo " doxygen             - (re)generate documentation"
 160         @echo " bootstrap-doxygen   - setup Doxygen dependencies"
 161         @echo " wipe-doxygen        - wipe all generated documentation"
 162         @echo " test-doc            - generate documentation for test framework"
 163         @echo " test-wipe-doc       - wipe documentation for test framework"
 164         @echo " test-cov            - generate code coverage report for test framework"
 165         @echo " test-wipe-cov       - wipe code coverage report for test framework"
 166         @echo " test-checkstyle     - check PEP8 compliance for test framework"
 167         @echo ""
 168         @echo "Make Arguments:"
 169         @echo " V=[0|1]                  - set build verbosity level"
 170         @echo " STARTUP_CONF=<path>      - startup configuration file"
 171         @echo "                            (e.g. /etc/vpp/startup.conf)"
 172         @echo " STARTUP_DIR=<path>       - startup drectory (e.g. /etc/vpp)"
 173         @echo "                            It also sets STARTUP_CONF if"
 174         @echo "                            startup.conf file is present"
 175         @echo " GDB=<path>               - gdb binary to use for debugging"
 176         @echo " PLATFORM=<name>          - target platform. default is vpp"
 177         @echo " TEST=<filter>            - apply filter to test set, see test-help"
 178         @echo " DPDK_CONFIG=<conf>       - add specified dpdk config commands to"
 179         @echo "                            autogenerated startup.conf"
 180         @echo "                            (e.g. \"no-pci\" )"
 181         @echo " SAMPLE_PLUGIN=yes        - in addition build/run/debug sample plugin"
 182         @echo " DISABLED_PLUGINS=<list>  - comma separated list of plugins which"
 183         @echo "                            should not be loaded"
 184         @echo ""
 185         @echo "Current Argument Values:"
 186         @echo " V                 = $(V)"
 187         @echo " STARTUP_CONF      = $(STARTUP_CONF)"
 188         @echo " STARTUP_DIR       = $(STARTUP_DIR)"
 189         @echo " GDB               = $(GDB)"
 190         @echo " PLATFORM          = $(PLATFORM)"
 191         @echo " DPDK_VERSION      = $(DPDK_VERSION)"
 192         @echo " DPDK_CONFIG       = $(DPDK_CONFIG)"
 193         @echo " SAMPLE_PLUGIN     = $(SAMPLE_PLUGIN)"
 194         @echo " DISABLED_PLUGINS  = $(DISABLED_PLUGINS)"
 195
 196 $(BR)/.bootstrap.ok:
 197 ifeq ($(findstring y,$(UNATTENDED)),y)
 198         make install-dep
 199 endif
 200 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
 201         @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
 202         if [ -n "$$MISSING" ] ; then \
 203           echo "\nPlease install missing packages: \n$$MISSING\n" ; \
 204           echo "by executing \"make install-dep\"\n" ; \
 205           exit 1 ; \
 206         fi ; \
 207         exit 0
 208 else ifneq ("$(wildcard /etc/redhat-release)","")
 209         @for i in $(RPM_DEPENDS) $(EPEL_DEPENDS) ; do \
 210             RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3)  ;   \
 211             if [[ "$$RPM" =~ "epel-release-latest" ]] ; then            \
 212                 MISSING+=$$(rpm -q epel-release | grep "^package") ;    \
 213             else                                                        \
 214                 MISSING+=$$(rpm -q $$RPM | grep "^package")        ;    \
 215             fi                                                     ;    \
 216         done                                                       ;    \
 217         if [ -n "$$MISSING" ] ; then \
 218           echo "Please install missing RPMs: \n$$MISSING\n" ; \
 219           echo "by executing \"make install-dep\"\n" ; \
 220           exit 1 ; \
 221         fi ; \
 222         exit 0
 223 endif
 224         @echo "SOURCE_PATH = $(WS_ROOT)"                   > $(BR)/build-config.mk
 225         @echo "#!/bin/bash\n"                              > $(BR)/path_setup
 226         @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
 227         @echo 'export PATH=$(BR)/tools/bin:$$PATH'        >> $(BR)/path_setup
 228         @echo 'export CCACHE_DIR=$(CCACHE_DIR)'           >> $(BR)/path_setup
 229
 230 ifeq ("$(wildcard /usr/bin/ccache )","")
 231         @echo "WARNING: Please install ccache AYEC and re-run this script"
 232 else
 233         @rm -rf $(BR)/tools/ccache-bin
 234         @mkdir -p $(BR)/tools/ccache-bin
 235         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
 236         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
 237 endif
 238         @make -C $(BR) V=$(V) is_build_tool=yes tools-install
 239         @touch $@
 240
 241 bootstrap: $(BR)/.bootstrap.ok
 242
 243 install-dep:
 244 ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
 245 ifeq ($(OS_VERSION_ID),14.04)
 246         @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
 247         @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
 248 endif
 249 ifeq ($(OS_ID)-$(OS_VERSION_ID),debian-8)
 250         @grep -q jessie-backports /etc/apt/sources.list /etc/apt/sources.list.d/* 2> /dev/null \
 251            || ( echo "Please install jessie-backports" ; exit 1 )
 252 endif
 253         @sudo -E apt-get update
 254         @sudo -E apt-get $(APT_ARGS) $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
 255 else ifneq ("$(wildcard /etc/redhat-release)","")
 256         @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 257         @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
 258         @sudo -E yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
 259         @sudo -E debuginfo-install $(CONFIRM) glibc openssl-libs zlib
 260 else ifeq ($(filter opensuse,$(OS_ID)),$(OS_ID))
 261         @sudo -E zypper -n install -y $(RPM_SUSE_DEPENDS)
 262 else
 263         $(error "This option currently works only on Ubuntu, Debian or Centos systems")
 264 endif
 265
 266 define make
 267         @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
 268 endef
 269
 270 $(BR)/scripts/.version:
 271 ifneq ("$(wildcard /etc/redhat-release)","")
 272         $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
 273 else
 274         $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
 275 endif
 276
 277 DIST_FILE = $(BR)/vpp-$(shell src/scripts/version).tar
 278 DIST_SUBDIR = vpp-$(shell src/scripts/version|cut -f1 -d-)
 279
 280 dist:
 281         @if git rev-parse 2> /dev/null ; then \
 282             git archive \
 283               --prefix=$(DIST_SUBDIR)/ \
 284               --format=tar \
 285               -o $(DIST_FILE) \
 286             HEAD ; \
 287             git describe > $(BR)/.version ; \
 288         else \
 289             (cd .. ; tar -cf $(DIST_FILE) $(DIST_SUBDIR) --exclude=*.tar) ; \
 290             src/scripts/version > $(BR)/.version ; \
 291         fi
 292         @tar --append \
 293           --file $(DIST_FILE) \
 294           --transform='s,.*/.version,$(DIST_SUBDIR)/src/scripts/.version,' \
 295           $(BR)/.version
 296         @$(RM) $(BR)/.version $(DIST_FILE).xz
 297         @xz -v --threads=0 $(DIST_FILE)
 298         @$(RM) $(BR)/vpp-latest.tar.xz
 299         @ln -rs $(DIST_FILE).xz $(BR)/vpp-latest.tar.xz
 300
 301 build: $(BR)/.bootstrap.ok
 302         $(call make,$(PLATFORM)_debug,$(addsuffix -install,$(TARGETS)))
 303
 304 wipedist:
 305         @$(RM) $(BR)/*.tar.xz
 306
 307 wipe: wipedist $(BR)/.bootstrap.ok
 308         $(call make,$(PLATFORM)_debug,$(addsuffix -wipe,$(TARGETS)))
 309
 310 rebuild: wipe build
 311
 312 build-release: $(BR)/.bootstrap.ok
 313         $(call make,$(PLATFORM),$(addsuffix -install,$(TARGETS)))
 314
 315 wipe-release: $(BR)/.bootstrap.ok
 316         $(call make,$(PLATFORM),$(addsuffix -wipe,$(TARGETS)))
 317
 318 rebuild-release: wipe-release build-release
 319
 320 export VPP_PYTHON_PREFIX=$(BR)/python
 321
 322 libexpand = $(subst $(subst ,, ),:,$(foreach lib,$(1),$(BR)/install-$(2)-native/vpp/$(lib)/$(3)))
 323
 324 define test
 325         $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
 326         $(eval libs:=lib lib64)
 327         make -C test \
 328           TEST_DIR=$(WS_ROOT)/test \
 329           VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
 330           VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
 331           VPP_TEST_PLUGIN_PATH=$(call libexpand,$(libs),$(2),vpp_plugins) \
 332           VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
 333           LD_LIBRARY_PATH=$(call libexpand,$(libs),$(2),) \
 334           EXTENDED_TESTS=$(EXTENDED_TESTS) \
 335           PYTHON=$(PYTHON) \
 336           $(3)
 337 endef
 338
 339 test: bootstrap
 340         $(call test,vpp,vpp,test)
 341
 342 test-debug: bootstrap
 343         $(call test,vpp,vpp_debug,test)
 344
 345 test-all: bootstrap
 346         $(eval EXTENDED_TESTS=yes)
 347         $(call test,vpp,vpp,test)
 348
 349 test-all-debug: bootstrap
 350         $(eval EXTENDED_TESTS=yes)
 351         $(call test,vpp,vpp_debug,test)
 352
 353 test-help:
 354         @make -C test help
 355
 356 test-wipe:
 357         @make -C test wipe
 358
 359 test-shell: bootstrap
 360         $(call test,vpp,vpp,shell)
 361
 362 test-shell-debug: bootstrap
 363         $(call test,vpp,vpp_debug,shell)
 364
 365 test-doc:
 366         @make -C test doc
 367
 368 test-wipe-doc:
 369         @make -C test wipe-doc
 370
 371 test-cov: bootstrap
 372         $(eval EXTENDED_TESTS=yes)
 373         $(call test,vpp,vpp_gcov,cov)
 374
 375 test-wipe-cov:
 376         @make -C test wipe-cov
 377
 378 test-checkstyle:
 379         @make -C test checkstyle
 380
 381 retest:
 382         $(call test,vpp,vpp,retest)
 383
 384 retest-debug:
 385         $(call test,vpp,vpp_debug,retest)
 386
 387 STARTUP_DIR ?= $(PWD)
 388 ifeq ("$(wildcard $(STARTUP_CONF))","")
 389 define run
 390         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
 391         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
 392         @cd $(STARTUP_DIR) && \
 393           sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) \
 394             plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
 395 endef
 396 else
 397 define run
 398         @cd $(STARTUP_DIR) && \
 399           sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') \
 400             plugin_path $(subst $(subst ,, ),:,$(wildcard $(1)/*/lib*/vpp_plugins))
 401 endef
 402 endif
 403
 404 %.files: .FORCE
 405         @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
 406                 \( -not -path './build-root*' -o -path \
 407                 './build-root/build-vpp_debug-native/dpdk*' \) > $@
 408
 409 .FORCE:
 410
 411 run:
 412         $(call run, $(BR)/install-$(PLATFORM)_debug-native)
 413
 414 run-release:
 415         $(call run, $(BR)/install-$(PLATFORM)-native)
 416
 417 debug:
 418         $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
 419
 420 build-coverity:
 421         $(call make,$(PLATFORM)_coverity,install-packages)
 422
 423 debug-release:
 424         $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
 425
 426 build-vat:
 427         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
 428
 429 run-vat:
 430         @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
 431
 432 pkg-deb:
 433         $(call make,$(PLATFORM),install-deb)
 434
 435 pkg-rpm: dist
 436         make -C extras/rpm
 437
 438 pkg-srpm: dist
 439         make -C extras/rpm srpm
 440
 441 dpdk-install-dev:
 442         make -C dpdk install-$(PKG)
 443
 444 ctags: ctags.files
 445         @ctags --totals --tag-relative -L $<
 446         @rm $<
 447
 448 gtags: ctags
 449         @gtags --gtagslabel=ctags
 450
 451 cscope: cscope.files
 452         @cscope -b -q -v
 453
 454 checkstyle:
 455         @build-root/scripts/checkstyle.sh
 456
 457 fixstyle:
 458         @build-root/scripts/checkstyle.sh --fix
 459
 460 #
 461 # Build the documentation
 462 #
 463
 464 # Doxygen configuration and our utility scripts
 465 export DOXY_DIR ?= $(WS_ROOT)/doxygen
 466
 467 define make-doxy
 468         @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
 469 endef
 470
 471 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
 472
 473 bootstrap-doxygen:
 474         $(call make-doxy)
 475
 476 doxygen:
 477         $(call make-doxy)
 478
 479 wipe-doxygen:
 480         $(call make-doxy)
 481
 482 define banner
 483         @echo "========================================================================"
 484         @echo " $(1)"
 485         @echo "========================================================================"
 486         @echo " "
 487 endef
 488
 489 verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
 490         $(call banner,"Building for PLATFORM=vpp using gcc")
 491         @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
 492 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
 493         $(call banner,"Installing dependencies")
 494         @sudo -E apt-get update
 495         @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
 496         $(call banner,"Building for PLATFORM=vpp using clang")
 497         @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
 498 endif
 499         $(call banner,"Building sample-plugin")
 500         @make -C build-root PLATFORM=vpp TAG=vpp sample-plugin-install
 501         $(call banner,"Building $(PKG) packages")
 502         @make pkg-$(PKG)
 503 ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-16.04)
 504         @make test
 505 endif
 506
 507