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 OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
  28 OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
  29
  30 DEB_DEPENDS  = curl build-essential autoconf automake bison libssl-dev ccache
  31 DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
  32 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
  33 DEB_DEPENDS += doxygen graphviz
  34 ifeq ($(OS_VERSION_ID),14.04)
  35         DEB_DEPENDS += openjdk-8-jdk-headless
  36 else
  37         DEB_DEPENDS += default-jdk-headless
  38 endif
  39
  40 RPM_DEPENDS_GROUPS = 'Development Tools'
  41 RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
  42 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
  43 RPM_DEPENDS += doxygen graphviz
  44 EPEL_DEPENDS = libconfuse-devel ganglia-devel
  45
  46 ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
  47         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
  48 endif
  49
  50 ifeq ($(findstring y,$(UNATTENDED)),y)
  51 CONFIRM=-y
  52 FORCE=--force-yes
  53 endif
  54
  55 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
  56 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
  57 .PHONY: ctags cscope doxygen wipe-doxygen plugins plugins-release
  58
  59 help:
  60         @echo "Make Targets:"
  61         @echo " bootstrap           - prepare tree for build"
  62         @echo " install-dep         - install software dependencies"
  63         @echo " wipe                - wipe all products of debug build "
  64         @echo " wipe-release        - wipe all products of release build "
  65         @echo " build               - build debug binaries"
  66         @echo " build-release       - build release binaries"
  67         @echo " plugins             - build debug plugin binaries"
  68         @echo " plugins-release     - build release plugin binaries"
  69         @echo " rebuild             - wipe and build debug binares"
  70         @echo " rebuild-release     - wipe and build release binares"
  71         @echo " run                 - run debug binary"
  72         @echo " run-release         - run release binary"
  73         @echo " debug               - run debug binary with debugger"
  74         @echo " debug-release       - run release binary with debugger"
  75         @echo " build-vat           - build vpp-api-test tool"
  76         @echo " run-vat             - run vpp-api-test tool"
  77         @echo " pkg-deb             - build DEB packages"
  78         @echo " pkg-rpm             - build RPM packages"
  79         @echo " ctags               - (re)generate ctags database"
  80         @echo " gtags               - (re)generate gtags database"
  81         @echo " cscope              - (re)generate cscope database"
  82         @echo " doxygen             - (re)generate documentation"
  83         @echo " wipe-doxygen        - wipe all generated documentation"
  84         @echo ""
  85         @echo "Make Arguments:"
  86         @echo " V=[0|1]             - set build verbosity level"
  87         @echo " STARTUP_CONF=<path> - startup configuration file"
  88         @echo "                       (e.g. /etc/vpp/startup.conf)"
  89         @echo " STARTUP_DIR=<path>  - startup drectory (e.g. /etc/vpp)"
  90         @echo "                       It also sets STARTUP_CONF if"
  91         @echo "                       startup.conf file is present"
  92         @echo " GDB=<path>          - gdb binary to use for debugging"
  93         @echo " PLATFORM=<name>     - target platform. default is vpp"
  94         @echo ""
  95         @echo "Current Argumernt Values:"
  96         @echo " V            = $(V)"
  97         @echo " STARTUP_CONF = $(STARTUP_CONF)"
  98         @echo " STARTUP_DIR  = $(STARTUP_DIR)"
  99         @echo " GDB          = $(GDB)"
 100         @echo " PLATFORM     = $(PLATFORM)"
 101         @echo " DPDK_VERSION = $(DPDK_VERSION)"
 102
 103 $(BR)/.bootstrap.ok:
 104 ifeq ($(OS_ID),ubuntu)
 105         @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
 106         if [ -n "$$MISSING" ] ; then \
 107           echo "\nPlease install missing packages: \n$$MISSING\n" ; \
 108           echo "by executing \"make install-dep\"\n" ; \
 109           exit 1 ; \
 110         fi ; \
 111         exit 0
 112 endif
 113         @echo "SOURCE_PATH = $(WS_ROOT)"                   > $(BR)/build-config.mk
 114         @echo "#!/bin/bash\n"                              > $(BR)/path_setup
 115         @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
 116         @echo 'export PATH=$(BR)/tools/bin:$$PATH'        >> $(BR)/path_setup
 117         @echo 'export CCACHE_DIR=$(CCACHE_DIR)'           >> $(BR)/path_setup
 118
 119 ifeq ("$(wildcard /usr/bin/ccache )","")
 120         @echo "WARNING: Please install ccache AYEC and re-run this script"
 121 else
 122         @rm -rf $(BR)/tools/ccache-bin
 123         @mkdir -p $(BR)/tools/ccache-bin
 124         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
 125         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
 126 endif
 127         @make -C $(BR) V=$(V) is_build_tool=yes vppapigen-install
 128         @touch $@
 129
 130 bootstrap: $(BR)/.bootstrap.ok
 131
 132 install-dep:
 133 ifeq ($(OS_ID),ubuntu)
 134 ifeq ($(OS_VERSION_ID),14.04)
 135         @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
 136         @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
 137         @sudo -E apt-get update
 138 endif
 139         @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
 140 else ifneq ("$(wildcard /etc/redhat-release)","")
 141         @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
 142         @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
 143         @sudo yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
 144         @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
 145 else
 146         $(error "This option currently works only on Ubuntu or Centos systems")
 147 endif
 148
 149 define make
 150         @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
 151 endef
 152
 153 build: $(BR)/.bootstrap.ok
 154         $(call make,$(PLATFORM)_debug,vpp-install)
 155
 156 wipe: $(BR)/.bootstrap.ok
 157         $(call make,$(PLATFORM)_debug,vpp-wipe)
 158
 159 rebuild: wipe build
 160
 161 build-release: $(BR)/.bootstrap.ok
 162         $(call make,$(PLATFORM),vpp-install)
 163
 164 wipe-release: $(BR)/.bootstrap.ok
 165         $(call make,$(PLATFORM),vpp-wipe)
 166
 167 rebuild-release: wipe-release build-release
 168
 169 plugins: $(BR)/.bootstrap.ok
 170         $(call make,$(PLATFORM)_debug,plugins-install)
 171
 172 plugins-release: $(BR)/.bootstrap.ok
 173         $(call make,$(PLATFORM),plugins-install)
 174
 175 STARTUP_DIR ?= $(PWD)
 176 ifeq ("$(wildcard $(STARTUP_CONF))","")
 177 define run
 178         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
 179         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
 180         @cd $(STARTUP_DIR) && \
 181           sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/plugins/lib64/vpp_plugins
 182 endef
 183 else
 184 define run
 185         @cd $(STARTUP_DIR) && \
 186           sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/plugins/lib64/vpp_plugins
 187 endef
 188 endif
 189
 190 %.files: .FORCE
 191         @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
 192                 \( -not -path './build-root*' -o -path \
 193                 './build-root/build-vpp_debug-native/dpdk*' \) > $@
 194
 195 .FORCE:
 196
 197 run:
 198         $(call run, $(BR)/install-$(PLATFORM)_debug-native)
 199
 200 run-release:
 201         $(call run, $(BR)/install-$(PLATFORM)-native)
 202
 203 debug:
 204         $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
 205
 206 debug-release:
 207         $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
 208
 209 build-vat:
 210         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
 211
 212 run-vat:
 213         @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp-api-test/bin/vpp_api_test
 214
 215 pkg-deb:
 216         $(call make,$(PLATFORM),install-deb)
 217
 218 pkg-rpm:
 219         $(call make,$(PLATFORM),install-rpm)
 220
 221 ctags: ctags.files
 222         @ctags --totals --tag-relative -L $<
 223         @rm $<
 224
 225 gtags: ctags
 226         @gtags --gtagslabel=ctags
 227
 228 cscope: cscope.files
 229         @cscope -b -q -v
 230
 231
 232 #
 233 # Build the documentation
 234 #
 235
 236 DOXY_INPUT = \
 237         README.md \
 238         vppinfra \
 239         svm \
 240         vlib \
 241         vlib-api \
 242         vnet \
 243         vpp \
 244         vpp-api
 245
 246 doxygen:
 247         @mkdir -p "$(BR)/docs"
 248         ROOT="$(WS_ROOT)" \
 249              BUILD_ROOT="$(BR)" \
 250              INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT))" \
 251              HTML=YES \
 252              VERSION="`git describe --tags --dirty`" \
 253              doxygen doxygen/doxygen.cfg
 254
 255 wipe-doxygen:
 256         rm -rf "$(BR)/docs"