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