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