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