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
  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
  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 " retest              - run functional tests"
  82         @echo " retest-debug        - run functional tests (debug build)"
  83         @echo " build-vat           - build vpp-api-test tool"
  84         @echo " build-vpp-api       - build vpp-api"
  85         @echo " run-vat             - run vpp-api-test tool"
  86         @echo " pkg-deb             - build DEB packages"
  87         @echo " pkg-rpm             - build RPM packages"
  88         @echo " ctags               - (re)generate ctags database"
  89         @echo " gtags               - (re)generate gtags database"
  90         @echo " cscope              - (re)generate cscope database"
  91         @echo " checkstyle          - check coding style"
  92         @echo " fixstyle            - fix coding style"
  93         @echo " doxygen             - (re)generate documentation"
  94         @echo " bootstrap-doxygen   - setup Doxygen dependencies"
  95         @echo " wipe-doxygen        - wipe all generated documentation"
  96         @echo ""
  97         @echo "Make Arguments:"
  98         @echo " V=[0|1]             - set build verbosity level"
  99         @echo " STARTUP_CONF=<path> - startup configuration file"
 100         @echo "                       (e.g. /etc/vpp/startup.conf)"
 101         @echo " STARTUP_DIR=<path>  - startup drectory (e.g. /etc/vpp)"
 102         @echo "                       It also sets STARTUP_CONF if"
 103         @echo "                       startup.conf file is present"
 104         @echo " GDB=<path>          - gdb binary to use for debugging"
 105         @echo " PLATFORM=<name>     - target platform. default is vpp"
 106         @echo " TEST=<name>         - only run specific test"
 107         @echo ""
 108         @echo "Current Argumernt Values:"
 109         @echo " V            = $(V)"
 110         @echo " STARTUP_CONF = $(STARTUP_CONF)"
 111         @echo " STARTUP_DIR  = $(STARTUP_DIR)"
 112         @echo " GDB          = $(GDB)"
 113         @echo " PLATFORM     = $(PLATFORM)"
 114         @echo " DPDK_VERSION = $(DPDK_VERSION)"
 115
 116 $(BR)/.bootstrap.ok:
 117 ifeq ($(OS_ID),ubuntu)
 118         @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
 119         if [ -n "$$MISSING" ] ; then \
 120           echo "\nPlease install missing packages: \n$$MISSING\n" ; \
 121           echo "by executing \"make install-dep\"\n" ; \
 122           exit 1 ; \
 123         fi ; \
 124         exit 0
 125 endif
 126         @echo "SOURCE_PATH = $(WS_ROOT)"                   > $(BR)/build-config.mk
 127         @echo "#!/bin/bash\n"                              > $(BR)/path_setup
 128         @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
 129         @echo 'export PATH=$(BR)/tools/bin:$$PATH'        >> $(BR)/path_setup
 130         @echo 'export CCACHE_DIR=$(CCACHE_DIR)'           >> $(BR)/path_setup
 131
 132 ifeq ("$(wildcard /usr/bin/ccache )","")
 133         @echo "WARNING: Please install ccache AYEC and re-run this script"
 134 else
 135         @rm -rf $(BR)/tools/ccache-bin
 136         @mkdir -p $(BR)/tools/ccache-bin
 137         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
 138         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
 139 endif
 140         @make -C $(BR) V=$(V) is_build_tool=yes vppapigen-install
 141         @touch $@
 142
 143 bootstrap: $(BR)/.bootstrap.ok
 144
 145 install-dep:
 146 ifeq ($(OS_ID),ubuntu)
 147 ifeq ($(OS_VERSION_ID),14.04)
 148         @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
 149         @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
 150         @sudo -E apt-get update
 151 endif
 152         @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
 153 else ifneq ("$(wildcard /etc/redhat-release)","")
 154         @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 155         @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
 156         @sudo yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
 157         @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
 158 else
 159         $(error "This option currently works only on Ubuntu or Centos systems")
 160 endif
 161
 162 define make
 163         @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
 164 endef
 165
 166 build: $(BR)/.bootstrap.ok
 167         $(call make,$(PLATFORM)_debug,vpp-install)
 168
 169 wipe: $(BR)/.bootstrap.ok
 170         $(call make,$(PLATFORM)_debug,vpp-wipe)
 171
 172 rebuild: wipe build
 173
 174 build-release: $(BR)/.bootstrap.ok
 175         $(call make,$(PLATFORM),vpp-install)
 176
 177 wipe-release: $(BR)/.bootstrap.ok
 178         $(call make,$(PLATFORM),vpp-wipe)
 179
 180 rebuild-release: wipe-release build-release
 181
 182 plugins: $(BR)/.bootstrap.ok
 183         $(call make,$(PLATFORM)_debug,plugins-install)
 184
 185 plugins-release: $(BR)/.bootstrap.ok
 186         $(call make,$(PLATFORM),plugins-install)
 187
 188 build-vpp-api: $(BR)/.bootstrap.ok
 189         $(call make,$(PLATFORM)_debug,vpp-api-install)
 190
 191 define test
 192         @make -C test \
 193           VPP_TEST_BIN=$(BR)/install-$(1)-native/vpp/bin/vpp \
 194           VPP_TEST_API_TEST_BIN=$(BR)/install-$(1)-native/vpp-api-test/bin/vpp_api_test \
 195           VPP_TEST_PLUGIN_PATH=$(BR)/install-$(1)-native/plugins/lib64/vpp_plugins \
 196           V=$(V) TEST=$(TEST)
 197 endef
 198
 199 test: bootstrap
 200 ifeq ($(OS_ID),ubuntu)
 201         @if ! (dpkg -l python-dev python-scapy &> /dev/null); then \
 202           sudo -E apt-get $(CONFIRM) $(FORCE) install python-dev python-scapy; \
 203         fi
 204 endif
 205         @make -C $(BR) PLATFORM=vpp_lite TAG=vpp_lite vpp-api-install plugins-install vpp-install vpp-api-test-install
 206         $(call test,vpp_lite)
 207
 208 test-debug: bootstrap
 209 ifeq ($(OS_ID),ubuntu)
 210         @if ! (dpkg -l python-dev python-scapy &> /dev/null); then \
 211           sudo -E apt-get $(CONFIRM) $(FORCE) install python-dev python-scapy; \
 212         fi
 213 endif
 214         @make -C $(BR) PLATFORM=vpp_lite TAG=vpp_lite_debug vpp-api-install plugins-install vpp-install vpp-api-test-install
 215         $(call test,vpp_lite_debug)
 216
 217 retest:
 218         $(call test,vpp_lite)
 219
 220 retest-debug:
 221         $(call test,vpp_lite_debug)
 222
 223 STARTUP_DIR ?= $(PWD)
 224 ifeq ("$(wildcard $(STARTUP_CONF))","")
 225 define run
 226         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
 227         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
 228         @cd $(STARTUP_DIR) && \
 229           sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/plugins/lib64/vpp_plugins
 230 endef
 231 else
 232 define run
 233         @cd $(STARTUP_DIR) && \
 234           sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/plugins/lib64/vpp_plugins
 235 endef
 236 endif
 237
 238 %.files: .FORCE
 239         @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
 240                 \( -not -path './build-root*' -o -path \
 241                 './build-root/build-vpp_debug-native/dpdk*' \) > $@
 242
 243 .FORCE:
 244
 245 run:
 246         $(call run, $(BR)/install-$(PLATFORM)_debug-native)
 247
 248 run-release:
 249         $(call run, $(BR)/install-$(PLATFORM)-native)
 250
 251 debug:
 252         $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
 253
 254 debug-release:
 255         $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
 256
 257 build-vat:
 258         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
 259
 260 run-vat:
 261         @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp-api-test/bin/vpp_api_test
 262
 263 pkg-deb:
 264         $(call make,$(PLATFORM),install-deb)
 265
 266 pkg-rpm:
 267         $(call make,$(PLATFORM),install-rpm)
 268
 269 ctags: ctags.files
 270         @ctags --totals --tag-relative -L $<
 271         @rm $<
 272
 273 gtags: ctags
 274         @gtags --gtagslabel=ctags
 275
 276 cscope: cscope.files
 277         @cscope -b -q -v
 278
 279 checkstyle:
 280         @build-root/scripts/checkstyle.sh
 281
 282 fixstyle:
 283         @build-root/scripts/checkstyle.sh --fix
 284
 285 #
 286 # Build the documentation
 287 #
 288
 289 # Doxygen configuration and our utility scripts
 290 export DOXY_DIR ?= $(WS_ROOT)/doxygen
 291
 292 define make-doxy
 293         @OS_ID="$(OS_ID)" WS_ROOT="$(WS_ROOT)" BR="$(BR)" make -C $(DOXY_DIR) $@
 294 endef
 295
 296 .PHONY: bootstrap-doxygen doxygen wipe-doxygen
 297
 298 bootstrap-doxygen:
 299         $(call make-doxy)
 300
 301 doxygen:
 302         $(call make-doxy)
 303
 304 wipe-doxygen:
 305         $(call make-doxy)
 306