# See the License for the specific language governing permissions and
# limitations under the License.
-WS_ROOT=$(CURDIR)
-BR=$(WS_ROOT)/build-root
+export WS_ROOT=$(CURDIR)
+export BR=$(WS_ROOT)/build-root
CCACHE_DIR?=$(BR)/.ccache
GDB?=gdb
PLATFORM?=vpp
#
# 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
+
+ifeq ($(filter ubuntu debian,$(OS_ID)),$(OS_ID))
+PKG=deb
+else ifeq ($(filter rhel centos fedora,$(OS_ID)),$(OS_ID))
+PKG=rpm
+endif
DEB_DEPENDS = curl build-essential autoconf automake bison libssl-dev ccache
DEB_DEPENDS += debhelper dkms git libtool libganglia1-dev libapr1-dev dh-systemd
-DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope
-DEB_DEPENDS += doxygen graphviz
+DEB_DEPENDS += libconfuse-dev git-review exuberant-ctags cscope pkg-config
+DEB_DEPENDS += lcov chrpath autoconf nasm
+DEB_DEPENDS += python-all python-dev python-virtualenv python-pip libffi6
ifeq ($(OS_VERSION_ID),14.04)
DEB_DEPENDS += openjdk-8-jdk-headless
else
RPM_DEPENDS_GROUPS = 'Development Tools'
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 += doxygen graphviz
-EPEL_DEPENDS = libconfuse-devel ganglia-devel
+RPM_DEPENDS += python-devel
+ifeq ($(OS_ID)),fedora)
+ifeq ($(OS_VERSION_ID),25)
+ RPM_DEPENDS += python2-virtualenv
+else
+ RPM_DEPENDS += python-virtualenv
+endif
+endif
+RPM_DEPENDS += lcov chrpath libffi-devel
+RPM_DEPENDS += https://kojipkgs.fedoraproject.org//packages/nasm/2.12.02/2.fc26/x86_64/nasm-2.12.02-2.fc26.x86_64.rpm
+EPEL_DEPENDS = libconfuse-devel ganglia-devel epel-rpm-macros
ifneq ($(wildcard $(STARTUP_DIR)/startup.conf),)
STARTUP_CONF ?= $(STARTUP_DIR)/startup.conf
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 doxygen wipe-doxygen
+.PHONY: ctags cscope
+.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:"
@echo " wipe-release - wipe all products of release build "
@echo " build - build debug binaries"
@echo " build-release - build release binaries"
+ @echo " build-coverity - build coverity artifacts"
@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 " build-vat - build vpp-api-test tool"
+ @echo " test - build and run (basic) functional tests"
+ @echo " test-debug - build and run (basic) functional tests (debug build)"
+ @echo " test-all - build and run (all) functional tests"
+ @echo " test-all-debug - build and run (all) functional tests (debug build)"
+ @echo " test-shell - enter shell with test environment"
+ @echo " test-shell-debug - enter shell with test environment (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 " run-vat - run vpp-api-test tool"
@echo " pkg-deb - build DEB packages"
@echo " pkg-rpm - build RPM packages"
+ @echo " dpdk-install-dev - install DPDK development 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 " test-checkstyle - check PEP8 compliance for test framework"
@echo ""
@echo "Make Arguments:"
@echo " V=[0|1] - set build verbosity level"
@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=<filter> - apply filter to test set, see test-help"
@echo ""
- @echo "Current Argumernt Values:"
+ @echo "Current Argument Values:"
@echo " V = $(V)"
@echo " STARTUP_CONF = $(STARTUP_CONF)"
@echo " STARTUP_DIR = $(STARTUP_DIR)"
@echo " DPDK_VERSION = $(DPDK_VERSION)"
$(BR)/.bootstrap.ok:
+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 \
exit 1 ; \
fi ; \
exit 0
+else ifneq ("$(wildcard /etc/redhat-release)","")
+ @for i in $(RPM_DEPENDS) $(EPEL_DEPENDS) ; do \
+ RPM=$$(basename -s .rpm "$${i##*/}" | cut -d- -f1,2,3) ; \
+ if [[ "$$RPM" =~ "epel-release-latest" ]] ; then \
+ MISSING+=$$(rpm -q epel-release | grep "^package") ; \
+ else \
+ MISSING+=$$(rpm -q $$RPM | grep "^package") ; \
+ fi ; \
+ done ; \
+ if [ -n "$$MISSING" ] ; then \
+ echo "Please install missing RPMs: \n$$MISSING\n" ; \
+ echo "by executing \"make install-dep\"\n" ; \
+ exit 1 ; \
+ fi ; \
+ exit 0
endif
- @echo "SOURCE_PATH = $(WS_ROOT) $(WS_ROOT)/plugins"> $(BR)/build-config.mk
+ @echo "SOURCE_PATH = $(WS_ROOT)" > $(BR)/build-config.mk
@echo "#!/bin/bash\n" > $(BR)/path_setup
@echo 'export PATH=$(BR)/tools/ccache-bin:$$PATH' >> $(BR)/path_setup
@echo 'export PATH=$(BR)/tools/bin:$$PATH' >> $(BR)/path_setup
@ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/gcc
@ln -s /usr/bin/ccache $(BR)/tools/ccache-bin/g++
endif
- @make -C $(BR) V=$(V) is_build_tool=yes vppapigen-install
+ @make -C $(BR) V=$(V) is_build_tool=yes tools-install
@touch $@
bootstrap: $(BR)/.bootstrap.ok
install-dep:
ifeq ($(OS_ID),ubuntu)
ifeq ($(OS_VERSION_ID),14.04)
- @sudo -E apt-get $(CONFIRM) install software-properties-common
- @sudo -E add-apt-repository $(CONFIRM) ppa:openjdk-r/ppa
- @sudo -E apt-get update
+ @sudo -E apt-get $(CONFIRM) $(FORCE) install software-properties-common
+ @sudo -E add-apt-repository ppa:openjdk-r/ppa $(CONFIRM)
endif
- @sudo -E apt-get $(CONFIRM) install $(DEB_DEPENDS)
+ @sudo -E apt-get update
+ @sudo -E apt-get $(CONFIRM) $(FORCE) install $(DEB_DEPENDS)
else ifneq ("$(wildcard /etc/redhat-release)","")
- @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
+ @sudo -E yum groupinstall $(CONFIRM) $(RPM_DEPENDS_GROUPS)
+ @sudo -E yum install $(CONFIRM) $(RPM_DEPENDS)
+ @sudo -E yum install $(CONFIRM) --enablerepo=epel $(EPEL_DEPENDS)
+ @sudo -E 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
@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
rebuild-release: wipe-release build-release
-plugins: $(BR)/.bootstrap.ok
- $(call make,$(PLATFORM)_debug,sample-plugin-install)
+export VPP_PYTHON_PREFIX=$(BR)/python
+
+define test
+ $(if $(filter-out $(3),retest),make -C $(BR) PLATFORM=$(1) TAG=$(2) vpp-install,)
+ make -C test \
+ TEST_DIR=$(WS_ROOT)/test \
+ VPP_TEST_BUILD_DIR=$(BR)/build-$(2)-native \
+ VPP_TEST_BIN=$(BR)/install-$(2)-native/vpp/bin/vpp \
+ VPP_TEST_PLUGIN_PATH=$(BR)/install-$(2)-native/vpp/lib64/vpp_plugins \
+ VPP_TEST_INSTALL_PATH=$(BR)/install-$(2)-native/ \
+ LD_LIBRARY_PATH=$(BR)/install-$(2)-native/vpp/lib64/ \
+ EXTENDED_TESTS=$(EXTENDED_TESTS) \
+ $(3)
+endef
+
+test: bootstrap
+ $(call test,vpp,vpp,test)
+
+test-debug: bootstrap
+ $(call test,vpp,vpp_debug,test)
+
+test-all: bootstrap
+ $(eval EXTENDED_TESTS=yes)
+ $(call test,vpp,vpp,test)
-plugins-release: $(BR)/.bootstrap.ok
- $(call make,$(PLATFORM),sample-plugin-install)
+test-all-debug: bootstrap
+ $(eval EXTENDED_TESTS=yes)
+ $(call test,vpp,vpp_debug,test)
+
+test-help:
+ @make -C test help
+
+test-wipe:
+ @make -C test wipe
+
+test-shell: bootstrap
+ $(call test,vpp,vpp,shell)
+
+test-shell-debug: bootstrap
+ $(call test,vpp,vpp_debug,shell)
+
+test-doc:
+ @make -C test doc
+
+test-wipe-doc:
+ @make -C test wipe-doc
+
+test-cov: bootstrap
+ $(eval EXTENDED_TESTS=yes)
+ $(call test,vpp,vpp_gcov,cov)
+
+test-wipe-cov:
+ @make -C test wipe-cov
+
+test-checkstyle:
+ @make -C test checkstyle
+
+retest:
+ $(call test,vpp,vpp,retest)
+
+retest-debug:
+ $(call test,vpp,vpp_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"
- @sudo rm -f /dev/shm/vpe-api /dev/shm/db /dev/shm/global_vm
- @cd $(STARTUP_DIR) && sudo $(1) $(MINIMAL_STARTUP_CONF)
+ @cd $(STARTUP_DIR) && \
+ sudo $(2) $(1)/vpp/bin/vpp $(MINIMAL_STARTUP_CONF) plugin_path $(1)/vpp/lib64/vpp_plugins
endef
else
define run
- @sudo rm -f /dev/shm/vpe-api /dev/shm/db /dev/shm/global_vm
- @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)/vpp/lib64/vpp_plugins
endef
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)
+
+build-coverity:
+ $(call make,$(PLATFORM)_coverity,install-packages)
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)
run-vat:
- @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp-api-test/bin/vpp_api_test
+ @sudo $(BR)/install-$(PLATFORM)_debug-native/vpp/bin/vpp_api_test
pkg-deb:
$(call make,$(PLATFORM),install-deb)
-pkg-rpm:
+pkg-rpm: dist
$(call make,$(PLATFORM),install-rpm)
+dpdk-install-dev:
+ make -C dpdk install-$(PKG)
+
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
#
-DOXY_INPUT = \
- README.md \
- vppinfra \
- svm \
- vlib \
- vlib-api \
- vnet \
- vpp \
- vpp-api
+# Doxygen configuration and our utility scripts
+export DOXY_DIR ?= $(WS_ROOT)/doxygen
+
+define make-doxy
+ @OS_ID="$(OS_ID)" make -C $(DOXY_DIR) $@
+endef
+
+.PHONY: bootstrap-doxygen doxygen wipe-doxygen
+
+bootstrap-doxygen:
+ $(call make-doxy)
doxygen:
- @mkdir -p "$(BR)/docs"
- ROOT="$(WS_ROOT)" \
- BUILD_ROOT="$(BR)" \
- INPUT="$(addprefix $(WS_ROOT)/,$(DOXY_INPUT))" \
- HTML=YES \
- VERSION="`git describe --tags --dirty`" \
- doxygen doxygen/doxygen.cfg
+ $(call make-doxy)
wipe-doxygen:
- rm -rf "$(BR)/docs"
+ $(call make-doxy)
+
+define banner
+ @echo "========================================================================"
+ @echo " $(1)"
+ @echo "========================================================================"
+ @echo " "
+endef
+
+verify: install-dep $(BR)/.bootstrap.ok dpdk-install-dev
+ $(call banner,"Building for PLATFORM=vpp using gcc")
+ @make -C build-root PLATFORM=vpp TAG=vpp wipe-all install-packages
+ifeq ($(OS_ID)-$(OS_VERSION_ID),ubuntu-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 $(PKG) packages")
+ @make pkg-$(PKG)
+ @make test-all
+
+