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