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 V?=0
  18 GDB?=gdb
  19 PLATFORM?=vpp
  20
  21 MINIMAL_STARTUP_CONF="unix { interactive } dpdk { no-pci socket-mem 1024 }"
  22
  23 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
  24
  25 DEB_DEPENDS  = curl build-essential autoconf automake bison libssl-dev ccache
  26 DEB_DEPENDS += debhelper dkms openjdk-7-jdk git libtool libganglia1-dev libapr1-dev
  27 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
  28
  29 ifneq ("$(wildcard $(STARTUP_DIR)/startup.conf),"")
  30         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
  31 endif
  32
  33 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
  34 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
  35 .PHONY: ctags cscope
  36
  37 help:
  38         @echo "Make Targets:"
  39         @echo " bootstrap           - prepare tree for build"
  40         @echo " install-dep         - install software dependencies"
  41         @echo " wipe                - wipe all products of debug build "
  42         @echo " wipe-release        - wipe all products of release build "
  43         @echo " build               - build debug binaries"
  44         @echo " build-release       - build release binaries"
  45         @echo " rebuild             - wipe and build debug binares"
  46         @echo " rebuild-release     - wipe and build release binares"
  47         @echo " run                 - run debug binary"
  48         @echo " run-release         - run release binary"
  49         @echo " debug               - run debug binary with debugger"
  50         @echo " debug-release       - run release binary with debugger"
  51         @echo " build-vat           - build vpp-api-test tool"
  52         @echo " run-vat             - run vpp-api-test tool"
  53         @echo " pkg-deb             - build DEB packages"
  54         @echo " pkg-rpm             - build RPM packages"
  55         @echo " ctags               - (re)generate ctags database"
  56         @echo " cscope              - (re)generate cscope database"
  57         @echo ""
  58         @echo "Make Arguments:"
  59         @echo " V=[0|1]             - set build verbosity level"
  60         @echo " STARTUP_CONF=<path> - startup configuration file"
  61         @echo "                       (e.g. /etc/vpp/startup.conf)"
  62         @echo " STARTUP_DIR=<path>  - startup drectory (e.g. /etc/vpp)"
  63         @echo "                       It also sets STARTUP_CONF if"
  64         @echo "                       startup.conf file is present"
  65         @echo " GDB=<path>          - gdb binary to use for debugging"
  66         @echo " PLATFORM=<name>     - target platform. default is vpp"
  67         @echo ""
  68         @echo "Current Argumernt Values:"
  69         @echo " V            = $(V)"
  70         @echo " STARTUP_CONF = $(STARTUP_CONF)"
  71         @echo " STARTUP_DIR  = $(STARTUP_DIR)"
  72         @echo " GDB          = $(GDB)"
  73         @echo " PLATFORM     = $(PLATFORM)"
  74
  75 $(BR)/.bootstrap.ok:
  76 ifeq ("$(shell lsb_release -si)", "Ubuntu")
  77         @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
  78         if [ -n "$$MISSING" ] ; then \
  79           echo "\nPlease install missing packages: \n$$MISSING\n" ; \
  80           echo "by executing \"make install-dep\"\n" ; \
  81           exit 1 ; \
  82         fi ; \
  83         exit 0
  84 endif
  85         @echo "SOURCE_PATH = $(WS_ROOT)"                   > $(BR)/build-config.mk
  86         @echo "#!/bin/bash\n"                              > $(BR)/path_setup
  87         @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
  88         @echo 'export PATH=$(BR)/tools/bin:$$PATH'        >> $(BR)/path_setup
  89         @echo 'export CCACHE_DIR=$(CCACHE_DIR)'           >> $(BR)/path_setup
  90
  91 ifeq ("$(wildcard /usr/bin/ccache )","")
  92         @echo "WARNING: Please install ccache AYEC and re-run this script"
  93 else
  94         @rm -rf $(BR)/tools/ccache-bin
  95         @mkdir -p $(BR)/tools/ccache-bin
  96         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
  97         @ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
  98 endif
  99         @make -C $(BR) V=$(V) is_build_tool=yes vppapigen-install
 100         @touch $@
 101
 102 bootstrap: $(BR)/.bootstrap.ok
 103
 104 install-dep:
 105 ifeq ("$(shell lsb_release -si)", "Ubuntu")
 106         @sudo apt-get -y install $(DEB_DEPENDS)
 107 else
 108         $(error "This option currently works only on Ubuntu systems")
 109 endif
 110
 111 define make
 112         @make -C $(BR) V=$(V) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
 113 endef
 114
 115 build: $(BR)/.bootstrap.ok
 116         $(call make,$(PLATFORM)_debug,vpp-install)
 117
 118 wipe: $(BR)/.bootstrap.ok
 119         $(call make,$(PLATFORM)_debug,vpp-wipe)
 120
 121 rebuild: wipe build
 122
 123 build-release: $(BR)/.bootstrap.ok
 124         $(call make,$(PLATFORM),vpp-install)
 125
 126 wipe-release: $(BR)/.bootstrap.ok
 127         $(call make,$(PLATFORM),vpp-wipe)
 128
 129 rebuild-release: wipe-release build-release
 130
 131 STARTUP_DIR ?= $(PWD)
 132 ifeq ("$(wildcard $(STARTUP_CONF))","")
 133 define run
 134         @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
 135         @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
 136         @cd $(STARTUP_DIR) && sudo $(1) $(MINIMAL_STARTUP_CONF)
 137 endef
 138 else
 139 define run
 140         @cd $(STARTUP_DIR) && sudo $(1) -c $(STARTUP_CONF)
 141 endef
 142 endif
 143
 144 %.files: .FORCE
 145         @find . \( -name '*\.[chyS]' -o -name '*\.java' -o -name '*\.lex' \) -and \
 146                 \( -not -path './build-root*' -o -path \
 147                 './build-root/build-vpp_debug-native/dpdk*' \) > $@
 148
 149 .FORCE:
 150
 151 run:
 152         $(call run, $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp)
 153
 154 run-release:
 155         $(call run, $(BR)/install-$(PLATFORM)-native/vpp/bin/vpp)
 156
 157 debug:
 158         $(call run, $(GDB) $(GDB_ARGS) --args $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp)
 159
 160 debug-release:
 161         $(call run, $(GDB) $(GDB_ARGS) --args $(BR)/install-$(PLATFORM)-native/vpp/bin/vpp)
 162
 163 build-vat:
 164         $(call make,$(PLATFORM)_debug,vpp-api-test-install)
 165
 166 run-vat:
 167         @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp-api-test/bin/vpp_api_test
 168
 169 pkg-deb:
 170         $(call make,$(PLATFORM),install-deb)
 171
 172 pkg-rpm:
 173         $(call make,$(PLATFORM),install-rpm)
 174
 175 ctags: ctags.files
 176         @ctags --totals --tag-relative -L $<
 177         @rm $<
 178
 179 cscope: cscope.files
 180         @cscope -b -q -v