API refactoring : ipsec-gre
[vpp.git] / Makefile
index a9b4d9a..292b0d2 100644 (file)
--- a/Makefile
+++ b/Makefile
 WS_ROOT=$(CURDIR)
 BR=$(WS_ROOT)/build-root
 CCACHE_DIR?=$(BR)/.ccache
-V?=0
 GDB?=gdb
 PLATFORM?=vpp
 
-MINIMAL_STARTUP_CONF="unix { interactive } dpdk { no-pci socket-mem 1024 }"
+MINIMAL_STARTUP_CONF="unix { interactive }"
 
 GDB_ARGS= -ex "handle SIGUSR1 noprint nostop"
 
+#
+# OS Detection
+#
+# We allow Darwin (MacOS) for docs generation; VPP build will still fail.
+ifneq ($(shell uname),Darwin)
+OS_ID        = $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+OS_VERSION_ID= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g')
+endif
+
 DEB_DEPENDS  = curl build-essential autoconf automake bison libssl-dev ccache
-DEB_DEPENDS += debhelper dkms openjdk-7-jdk git libtool libganglia1-dev libapr1-dev
+DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
 DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
+DEB_DEPENDS += python-dev python-virtualenv python-pip lcov chrpath autoconf
+ifeq ($(OS_VERSION_ID),14.04)
+       DEB_DEPENDS += openjdk-8-jdk-headless
+else
+       DEB_DEPENDS += default-jdk-headless
+endif
 
 RPM_DEPENDS_GROUPS = 'Development Tools'
-RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel
+RPM_DEPENDS  = redhat-lsb glibc-static java-1.8.0-openjdk-devel yum-utils
 RPM_DEPENDS += openssl-devel https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm apr-devel
+RPM_DEPENDS += python-devel python-virtualenv lcov chrpath
 EPEL_DEPENDS = libconfuse-devel ganglia-devel
 
-ifneq ("$(wildcard $(STARTUP_DIR)/startup.conf),"")
+ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
         STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
 endif
 
+ifeq ($(findstring y,$(UNATTENDED)),y)
+CONFIRM=-y
+FORCE=--force-yes
+endif
+
 .PHONY: help bootstrap wipe wipe-release build build-release rebuild rebuild-release
 .PHONY: run run-release debug debug-release build-vat run-vat pkg-deb pkg-rpm
-.PHONY: ctags cscope
+.PHONY: ctags cscope plugins plugins-release build-vpp-api
+.PHONY: test test-debug retest retest-debug test-doc test-wipe-doc test-help test-wipe
+.PHONY: test-cov test-wipe-cov
 
 help:
        @echo "Make Targets:"
@@ -47,18 +69,37 @@ help:
        @echo " wipe-release        - wipe all products of release build "
        @echo " build               - build debug binaries"
        @echo " build-release       - build release binaries"
+       @echo " plugins             - build debug plugin binaries"
+       @echo " plugins-release     - build release plugin binaries"
        @echo " rebuild             - wipe and build debug binares"
        @echo " rebuild-release     - wipe and build release binares"
        @echo " run                 - run debug binary"
        @echo " run-release         - run release binary"
        @echo " debug               - run debug binary with debugger"
        @echo " debug-release       - run release binary with debugger"
+       @echo " test                - build and run functional tests"
+       @echo " test-debug          - build and run functional tests (debug build)"
+       @echo " test-wipe           - wipe files generated by unit tests"
+       @echo " retest              - run functional tests"
+       @echo " retest-debug        - run functional tests (debug build)"
+       @echo " test-help           - show help on test framework"
        @echo " build-vat           - build vpp-api-test tool"
+       @echo " build-vpp-api       - build vpp-api"
        @echo " run-vat             - run vpp-api-test tool"
        @echo " pkg-deb             - build DEB packages"
        @echo " pkg-rpm             - build RPM packages"
        @echo " ctags               - (re)generate ctags database"
+       @echo " gtags               - (re)generate gtags database"
        @echo " cscope              - (re)generate cscope database"
+       @echo " checkstyle          - check coding style"
+       @echo " fixstyle            - fix coding style"
+       @echo " doxygen             - (re)generate documentation"
+       @echo " bootstrap-doxygen   - setup Doxygen dependencies"
+       @echo " wipe-doxygen        - wipe all generated documentation"
+       @echo " test-doc            - generate documentation for test framework"
+       @echo " test-wipe-doc       - wipe documentation for test framework"
+       @echo " test-cov            - generate code coverage report for test framework"
+       @echo " test-wipe-cov       - wipe code coverage report for test framework"
        @echo ""
        @echo "Make Arguments:"
        @echo " V=[0|1]             - set build verbosity level"
@@ -69,16 +110,21 @@ help:
        @echo "                       startup.conf file is present"
        @echo " GDB=<path>          - gdb binary to use for debugging"
        @echo " PLATFORM=<name>     - target platform. default is vpp"
+       @echo " TEST=<name>         - only run specific test"
        @echo ""
-       @echo "Current Argumernt Values:"
+       @echo "Current Argument Values:"
        @echo " V            = $(V)"
        @echo " STARTUP_CONF = $(STARTUP_CONF)"
        @echo " STARTUP_DIR  = $(STARTUP_DIR)"
        @echo " GDB          = $(GDB)"
        @echo " PLATFORM     = $(PLATFORM)"
+       @echo " DPDK_VERSION = $(DPDK_VERSION)"
 
 $(BR)/.bootstrap.ok:
-ifeq ("$(shell lsb_release -si)", "Ubuntu")
+ifeq ($(findstring y,$(UNATTENDED)),y)
+       make install-dep
+endif
+ifeq ($(OS_ID),ubuntu)
        @MISSING=$$(apt-get install -y -qq -s $(DEB_DEPENDS) | grep "^Inst ") ; \
        if [ -n "$$MISSING" ] ; then \
          echo "\nPlease install missing packages: \n$$MISSING\n" ; \
@@ -92,7 +138,7 @@ endif
        @echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
        @echo 'export PATH=$(BR)/tools/bin:$$PATH'        >> $(BR)/path_setup
        @echo 'export CCACHE_DIR=$(CCACHE_DIR)'           >> $(BR)/path_setup
-       
+
 ifeq ("$(wildcard /usr/bin/ccache )","")
        @echo "WARNING: Please install ccache AYEC and re-run this script"
 else
@@ -107,24 +153,47 @@ endif
 bootstrap: $(BR)/.bootstrap.ok
 
 install-dep:
-ifeq ("$(shell lsb_release -si)", "Ubuntu")
-       @sudo apt-get -y install $(DEB_DEPENDS)
+ifeq ($(OS_ID),ubuntu)
+ifeq ($(OS_VERSION_ID),14.04)
+       @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
+       @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
+       @sudo -E apt-get update
+endif
+       @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
 else ifneq ("$(wildcard /etc/redhat-release)","")
-       @sudo yum groupinstall -y $(RPM_DEPENDS_GROUPS)
-       @sudo yum install -y $(RPM_DEPENDS)
-       @sudo yum install -y --enablerepo=epel $(EPEL_DEPENDS)
+       @sudo yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
+       @sudo yum install $(CONFIRM) $(RPM_DEPENDS)
+       @sudo yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
+       @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
 else
        $(error "This option currently works only on Ubuntu or Centos systems")
 endif
 
 define make
-       @make -C $(BR) V=$(V) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
+       @make -C $(BR) PLATFORM=$(PLATFORM) TAG=$(1) $(2)
 endef
 
+$(BR)/scripts/.version:
+ifneq ("$(wildcard /etc/redhat-release)","")
+       $(shell $(BR)/scripts/version rpm-string > $(BR)/scripts/.version)
+else
+       $(shell $(BR)/scripts/version > $(BR)/scripts/.version)
+endif
+
+dist:  $(BR)/scripts/.version
+       $(MAKE) verstring=$(PLATFORM)-$(shell cat $(BR)/scripts/.version) prefix=$(PLATFORM) distversion
+
+distversion:   $(BR)/scripts/.version
+       $(BR)/scripts/verdist ${BR} ${prefix}-$(shell $(BR)/scripts/version rpm-version) ${verstring}
+       mv $(verstring).tar.gz $(BR)/rpm
+
 build: $(BR)/.bootstrap.ok
        $(call make,$(PLATFORM)_debug,vpp-install)
 
-wipe: $(BR)/.bootstrap.ok
+wipedist:
+       $(RM) $(BR)/scripts/.version $(BR)/rpm/*.tar.gz
+
+wipe: wipedist $(BR)/.bootstrap.ok
        $(call make,$(PLATFORM)_debug,vpp-wipe)
 
 rebuild: wipe build
@@ -137,16 +206,72 @@ wipe-release: $(BR)/.bootstrap.ok
 
 rebuild-release: wipe-release build-release
 
+plugins: $(BR)/.bootstrap.ok
+       $(call make,$(PLATFORM)_debug,plugins-install)
+
+plugins-release: $(BR)/.bootstrap.ok
+       $(call make,$(PLATFORM),plugins-install)
+
+build-vpp-api: $(BR)/.bootstrap.ok
+       $(call make,$(PLATFORM)_debug,vpp-api-install)
+
+VPP_PYTHON_PREFIX=$(BR)/python
+
+define test
+       $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-api-install plugins-install vpp-install,)
+       make -C test \
+         BR=$(BR) \
+         VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
+         VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
+         VPP_TEST_API_TEST_BIN=$(BR)/install-$(2)-native/vpp-api-test/bin/vpp_api_test \
+         VPP_TEST_PLUGIN_PATH=$(BR)/install-$(2)-native/plugins/lib64/vpp_plugins \
+         VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
+         LD_LIBRARY_PATH=$(BR)/install-$(2)-native/vpp-api/lib64/ \
+         WS_ROOT=$(WS_ROOT) V=$(V) TEST=$(TEST) VPP_PYTHON_PREFIX=$(VPP_PYTHON_PREFIX) $(3)
+endef
+
+test: bootstrap
+       $(call test,vpp_lite,vpp_lite,test)
+
+test-debug: bootstrap
+       $(call test,vpp_lite,vpp_lite_debug,test)
+
+test-help:
+       @make -C test help
+
+test-wipe:
+       @make -C test wipe
+
+test-doc:
+       @make -C test WS_ROOT=$(WS_ROOT) BR=$(BR) VPP_PYTHON_PREFIX=$(VPP_PYTHON_PREFIX) doc
+
+test-wipe-doc:
+       @make -C test wipe-doc BR=$(BR)
+
+test-cov: bootstrap
+       $(call test,vpp_lite,vpp_lite_gcov,cov)
+
+test-wipe-cov:
+       @make -C test wipe-cov BR=$(BR)
+
+retest:
+       $(call test,vpp_lite,vpp_lite,retest)
+
+retest-debug:
+       $(call test,vpp_lite,vpp_lite_debug,retest)
+
 STARTUP_DIR ?= $(PWD)
 ifeq ("$(wildcard $(STARTUP_CONF))","")
 define run
        @echo "WARNING: STARTUP_CONF not defined or file doesn't exist."
        @echo "         Running with minimal startup config: $(MINIMAL_STARTUP_CONF)\n"
-       @cd $(STARTUP_DIR) && sudo $(1) $(MINIMAL_STARTUP_CONF)
+       @cd $(STARTUP_DIR) && \
+         sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/plugins/lib64/vpp_plugins
 endef
 else
 define run
-       @cd $(STARTUP_DIR) && sudo $(1) -c $(STARTUP_CONF)
+       @cd $(STARTUP_DIR) && \
+         sudo $(2) $(1)/vpp/bin/vpp $(shell cat $(STARTUP_CONF) | sed -e 's/#.*//') plugin_path $(1)/plugins/lib64/vpp_plugins
 endef
 endif
 
@@ -158,16 +283,16 @@ endif
 .FORCE:
 
 run:
-       $(call run, $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)_debug-native)
 
 run-release:
-       $(call run, $(BR)/install-$(PLATFORM)-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)-native)
 
 debug:
-       $(call run, $(GDB) $(GDB_ARGS) --args $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)_debug-native,$(GDB) $(GDB_ARGS) --args)
 
 debug-release:
-       $(call run, $(GDB) $(GDB_ARGS) --args $(BR)/install-$(PLATFORM)-native/vpp/bin/vpp)
+       $(call run, $(BR)/install-$(PLATFORM)-native,$(GDB) $(GDB_ARGS) --args)
 
 build-vat:
        $(call make,$(PLATFORM)_debug,vpp-api-test-install)
@@ -178,12 +303,73 @@ run-vat:
 pkg-deb:
        $(call make,$(PLATFORM),install-deb)
 
-pkg-rpm:
+pkg-rpm: dist
        $(call make,$(PLATFORM),install-rpm)
 
 ctags: ctags.files
        @ctags --totals --tag-relative -L $<
        @rm $<
 
+gtags: ctags
+       @gtags --gtagslabel=ctags
+
 cscope: cscope.files
        @cscope -b -q -v
+
+checkstyle:
+       @build-root/scripts/checkstyle.sh
+
+fixstyle:
+       @build-root/scripts/checkstyle.sh --fix
+
+#
+# Build the documentation
+#
+
+# Doxygen configuration and our utility scripts
+export DOXY_DIR ?= $(WS_ROOT)/doxygen
+
+define make-doxy
+       @OS_ID="$(OS_ID)" WS_ROOT="$(WS_ROOT)" BR="$(BR)" make -C $(DOXY_DIR) $@
+endef
+
+.PHONY: bootstrap-doxygen doxygen wipe-doxygen
+
+bootstrap-doxygen:
+       $(call make-doxy)
+
+doxygen:
+       $(call make-doxy)
+
+wipe-doxygen:
+       $(call make-doxy)
+
+define banner
+       @echo "========================================================================"
+       @echo " $(1)"
+       @echo "========================================================================"
+       @echo " "
+endef
+
+verify: install-dep $(BR)/.bootstrap.ok
+       $(call banner,"Building for PLATFORM=vpp using gcc")
+       @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
+       $(call banner,"Building for PLATFORM=vpp_lite using gcc")
+       @make -C build-root PLATFORM=vpp_lite TAG=vpp_lite wipe-all install-packages
+ifeq ($(OS_ID),ubuntu)
+ifeq ($(OS_VERSION_ID),16.04)
+       $(call banner,"Installing dependencies")
+       @sudo -E apt-get update
+       @sudo -E apt-get $(CONFIRM) $(FORCE) install clang
+       $(call banner,"Building for PLATFORM=vpp using clang")
+       @make -C build-root CC=clang PLATFORM=vpp TAG=vpp_clang wipe-all install-packages
+endif
+       $(call banner,"Building deb packages")
+       @make pkg-deb
+endif
+ifeq ($(OS_ID),centos)
+       $(call banner,"Building rpm packages")
+       @make pkg-rpm
+endif
+
+