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