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