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