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