binary module build: use kernel headers from highest version
[deb_dpdk.git] / debian / rules
index 77f90d8..2d69b82 100755 (executable)
 #!/usr/bin/make -f
-# See debhelper(7) (uncomment to enable)
-# output every command that modifies files on the build system.
-export DH_VERBOSE=1
-export DH_OPTIONS=-v
-
-VERSION := $(shell dpkg-parsechangelog | sed -nr '/^Version:/s/Version: (.*:)?(.*)-(.*)/\2/p')
 
 # see EXAMPLES in dpkg-buildflags(1) and read /usr/share/dpkg/*
+DPKG_EXPORT_BUILDFLAGS = 1
+export DEB_BUILD_MAINT_OPTIONS = hardening=+all
 include /usr/share/dpkg/default.mk
 
-DEB_HOST_GNU_CPU := $(shell dpkg-architecture -qDEB_HOST_GNU_CPU)
+DPDK_ABI := $(shell echo $(DEB_VERSION_UPSTREAM) | cut -d '-' -f1 | cut -d '.'  -f1-2 | cut -d '~' -f1)
+
+ifeq (,$(findstring terse,$(DEB_BUILD_OPTIONS)))
+       export DH_VERBOSE=1
+       export DH_OPTIONS=-v
+endif
 
-# see FEATURE AREAS in dpkg-buildflags(1)
-export DEB_BUILD_MAINT_OPTIONS = hardening=+all,-pie
+# People rebuilding this package can overwrite RTE_MACHINE
+# via DEB_BUILD_OPTIONS if they like
+ifneq (,$(filter rte_machine=%,$(DEB_BUILD_OPTIONS)))
+    RTE_MACHINE ?= $(patsubst rte_machine=%,%,$(filter rte_machine=%,$(DEB_BUILD_OPTIONS)))
+endif
+# default to minimal base, without setting this it would build
+# -march=native which is a non portable invariant
+RTE_MACHINE ?= "default"
+
+# now stable with parallel comilation, so support -j
+ifneq (,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
+    PAR := $(patsubst parallel=%,%,$(filter parallel=%,$(DEB_BUILD_OPTIONS)))
+    MAKEFLAGS += -j$(PAR)
+endif
 
-# see ENVIRONMENT in dpkg-buildflags(1)
-# package maintainers to append CFLAGS
-export DEB_CFLAGS_MAINT_APPEND  = -fPIC
-# package maintainers to append LDFLAGS
-#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed
+ifneq (,$(findstring nodoc,$(DEB_BUILD_PROFILES)))
+BUILD_DOCS=n
+else
+ifneq (,$(findstring nodoc,$(DEB_BUILD_OPTIONS)))
+BUILD_DOCS=n
+# to stop dh_installdoc from running
+export DEB_BUILD_PROFILES += nodoc
+else
+BUILD_DOCS=y
+endif
+endif
 
-include /usr/share/dpkg/buildflags.mk
-export EXTRA_CFLAGS=$(CFLAGS)
-# need to be stripped as DPDK build system adds them and it would be -Wl,-Wl,opt
-export EXTRA_LDFLAGS=$(shell echo $(LDFLAGS) | sed 's/-Wl,//g')
+# Allow to pass specific configure flags to meson as a comma separated list
+ifneq (,$(filter dpdk_config_options=%,$(DEB_BUILD_OPTIONS)))
+# GNU Makefile hack: can't directly escape comma and spaces, so use variables
+    comma := ,
+    space :=
+    space +=
+    DPDK_CONFIG_OPTIONS ?= $(subst $(comma),$(space),$(patsubst dpdk_config_options=%,%,$(filter dpdk_config_options=%,$(DEB_BUILD_OPTIONS))))
+endif
 
-# People rebuilding this package can overwrite DPDK_CONFIG, RTE_MACHINE and
-# RTE_TARGET via environment variables if they like
-ifneq (,$(filter $(DEB_HOST_ARCH), arm64))
-DPDK_CONFIG := "arm64-armv8a-linuxapp-gcc"
-RTE_MACHINE := "armv8a"
-RTE_TARGET := "arm64-armv8a-linuxapp-gcc"
+# kernel_modules can be passed via DEB_BUILD_OPTIONS to enable building the
+# optional binary kernel modules package. By default it will be built against
+# the current kernel, or ksrc can be passed with a path to the target kernel
+# sources instead.
+ifeq (,$(findstring kernel_modules,$(DEB_BUILD_OPTIONS)))
+DPDK_CONFIG_BUILD_KMOD=false
+KSRC=""
 else
-DPDK_CONFIG := "$(DEB_HOST_GNU_CPU)-native-linuxapp-gcc"
-RTE_MACHINE := "default"
-RTE_TARGET := "$(DEB_HOST_GNU_CPU)-default-linuxapp-gcc"
+ifneq (,$(filter ksrc=%,$(DEB_BUILD_OPTIONS)))
+    KSRC := $(patsubst ksrc=%,%,$(filter ksrc=%,$(DEB_BUILD_OPTIONS)))
+else
+    KSRC := /lib/modules/$(shell LIST=$$(ls /lib/modules/); for dir in $$LIST; do test -d /lib/modules/$$dir/build && echo $$dir; done | sort -V | tail -n1)/build
+endif
+
+KVERS := $(shell perl debian/kernel-version $(KSRC))
+export KVERS
+export MODULE_CFLAGS=-fno-PIE
+
+DPDK_CONFIG_BUILD_KMOD=true
+
+# Since the binary module package is generated at build time depending on the
+# local kernel version, we have to append the new package in d/control.
+# We cannot use a separate control file since that wouldn't work with
+# dpkg-genchanges, and also would require a lot of overrides for debhelpers.
+get_built_using        ?= $(filter-out (=),$(shell dpkg-query -f='$${source:Package} (=$${source:Version})' -W $1))
+
+build:
+       @if [ x"$(KVERS)" = x ] ; then \
+           echo 'No version in $(KSRC)/include/linux/version.h' >&2; \
+           exit 1; \
+       fi
+       sh debian/prep-modules $(KSRC)
+       cat debian/control.modules >> debian/control
+       dh $@ --with python3,dkms,systemd --buildsystem=meson
 endif
-DPDK_STATIC_DIR = "debian/build/static-root"
-DPDK_SHARED_DIR = "debian/build/shared-root"
 
 %:
-       dh $@ --with python2,dkms
+       dh $@ --with python3,dkms,systemd --buildsystem=meson
+
+override_dh_gencontrol:
+       dh_gencontrol
+       # debian/files will not exist until dh_gencontrol has ran at least once,
+       # so we need to run gencontrol for libdpdk-dev after.
+       # The list of libraries and PMDs is everchanging, so generate the dependency
+       # list for libdpdk-dev to avoid having to maintain it manually.
+       # Same for the recommends list for dpdk, were we want the PMDs and the mempools.
+       dh_gencontrol -p libdpdk-dev -- -V"librte:Depends=`grep -E 'librte-*' ./debian/files | grep -v dbgsym | tr '_' ' ' | awk '{ print $$1,"(=",$$2 ")" }' | paste -sd ',' - | sed -e 's/,/, /g'`"
+       dh_gencontrol -p dpdk -- -V"librte:Suggests=`grep -E 'librte-(pmd|mempool).*' ./debian/files | grep -v dbgsym | tr '_' ' ' | awk '{ print $$1,"(=",$$2 ")" }' | paste -sd ',' - | sed -e 's/,/, /g'`"
+ifneq (,$(findstring kernel_modules,$(DEB_BUILD_OPTIONS)))
+       dh_gencontrol -p dpdk-modules-$(KVERS) -- \
+               -v`cat debian/VERSION` \
+               -V'built:using:kernel=$(call get_built_using,linux-headers-$(KVERS))'
+endif
 
 override_dh_auto_clean:
-       rm -rf debian/build debian/tmp
+       rm -rf debian/build debian/tmp debian/dpdk-modules-* \
+               debian/control.modules debian/VERSION
+       sed -i '/Package: dpdk-modules-/,/`tail -n1 debian/control.modules.in`/d' debian/control
+       rm -f debian/dpdk-igb-uio-dkms.dkms debian/dpdk-rte-kni-dkms.dkms
+       dh_auto_clean
 
 override_dh_auto_configure:
-       # report dpkg-buildflags status to build log
-       dpkg-buildflags --status
-       echo EXTRA_CFLAGS $$EXTRA_CFLAGS
-       echo EXTRA_LDFLAGS: $$EXTRA_LDFLAGS
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) T=$(DPDK_CONFIG) config
-       sed -ri -e 's,(RTE_MACHINE=).*,\1$(RTE_MACHINE),' \
-               -e 's,(RTE_NEXT_ABI=).*,\1n,' \
-               -e 's,(CONFIG_RTE_EAL_IGB_UIO=).*,\1n,' \
-               -e 's,(CONFIG_RTE_KNI_KMOD=).*,\1n,' \
-               -e 's,(LIBRTE_PMD_PCAP=).*,\1y,' \
-               -e 's,(LIBRTE_PMD_XENVIRT=).*,\1y,' \
-               $(DPDK_STATIC_DIR)/.config
-       dh_auto_configure
+       dh_auto_configure -- $(DPDK_CONFIG_OPTIONS) \
+               --includedir=include/dpdk \
+               --default-library=shared \
+               -Dper_library_versions=false \
+               -Dinclude_subdir_arch=../$(DEB_HOST_MULTIARCH)/dpdk \
+               -Dmachine=$(RTE_MACHINE) \
+               -Dkernel_dir=$(KSRC) \
+               -Denable_kmods=$(DPDK_CONFIG_BUILD_KMOD)
 
 override_dh_auto_build-indep:
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) doc-api-html doc-guides-html
+ifeq (y,$(BUILD_DOCS))
+       dh_auto_build -- doc
+       # NINJA DOC INSTALL DOES NOT WORK - .buildinfo present, css missing
+       rm -f obj-$(DEB_HOST_MULTIARCH)/doc/guides/guides/.buildinfo
+endif
 
+# ninja install doc does not work, will rebuild everything,
+# only dpdk-doc as arch: all so just skip it
 override_dh_auto_install-indep:
-       # Package: dpdk-doc
-       # All files based on the install-doc rule (includes examples)
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) prefix=/usr \
-               DESTDIR=debian/dpdk-doc install-doc
-
-override_dh_auto_build-arch:
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) build
-       # Unfortunately the decision about having static or shared libraries is
-       # made for the whole build, which then produces only .a or .so files
-       # (but not both).
-       # And the target layout for target selection has no field for the
-       # type of library.
-       # Right now I hack this by doing a second build which only differs in
-       # the selection of shared libs.
-       # Shared libs should be default, so the previous static build is only
-       # used to get static libraries.
-       cp -a $(DPDK_STATIC_DIR) $(DPDK_SHARED_DIR)
-       sed -ri 's,(RTE_BUILD_SHARED_LIB=).*,\1y,' \
-               $(DPDK_SHARED_DIR)/.config
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_SHARED_DIR) build
-
-override_dh_auto_install-arch: LIBDIR=usr/lib/$(shell dpkg-architecture -qDEB_HOST_MULTIARCH)
+
 override_dh_auto_install-arch:
-       # Package: dpdk (runtime)
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_STATIC_DIR) prefix=/usr \
-               DESTDIR=debian/dpdk install-runtime
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_SHARED_DIR) prefix=/usr \
-               DESTDIR=debian/dpdk install-runtime
-       mkdir -p debian/dpdk/etc/dpdk
-       cp debian/dpdk.interfaces debian/dpdk/etc/dpdk/interfaces
-       rm debian/dpdk/usr/sbin/dpdk-devbind
-       mkdir -p debian/dpdk/sbin
-       ln -s /usr/share/dpdk/tools/dpdk-devbind.py \
-               debian/dpdk/sbin/dpdk-devbind
-       # Package: dpdk-dev (build environment)
-       $(MAKE) V=$(DH_VERBOSE) O=$(DPDK_SHARED_DIR) prefix=/usr \
-               DESTDIR=debian/dpdk-dev install-sdk
-       cp $(DPDK_SHARED_DIR)/.config debian/dpdk-dev/usr/share/dpdk/config
-       sed -e 's/SDK_TARGET/$(RTE_TARGET)/' debian/dpdk-sdk-env.sh.in > \
-               debian/dpdk-dev/usr/share/dpdk/dpdk-sdk-env.sh
-       # Package: libdpdk-dev (bare headers, static devel libs and linker
-       # script)
-       mkdir -p debian/libdpdk-dev/$(LIBDIR)
-       # linker script
-       mv debian/dpdk/usr/lib/libdpdk.so debian/libdpdk-dev/$(LIBDIR)/
-       # includes
-       mkdir -p debian/libdpdk-dev/usr/include
-       mv debian/dpdk-dev/usr/include/dpdk debian/libdpdk-dev/usr/include/
-       # all static libs are in the dev package
-       mv debian/dpdk/usr/lib/lib*.a debian/libdpdk-dev/$(LIBDIR)/
-       # symlinks to last .so's are in the non versioned libdpdk-dev as well
-       # this allows multiple libdpdk-<NAME><VER> at different VER concurrently
-       # libdpdk-dev depends on all sublibs so symlinks are never broken
-       mv debian/dpdk/usr/lib/*.so debian/libdpdk-dev/$(LIBDIR)/
-       # Package(s): libdpdk-<NAME><VER> (bare runtime libs)
-       for lib in $$(ls -1 debian/dpdk/usr/lib/*.so.*); do \
-         BN=$$(basename $${lib}); \
-         VER=$$(echo $${BN} | sed -e 's/^.*\.so\.//'); \
-         LN=$$(echo $${BN} | sed -e 's/\.so\.[0-9]*$$//' | tr '_' '-'); \
+       dh_auto_install
+       # have the DKMS build include the correct per-arch directory
+       sed "s/@@DEB_HOST_MULTIARCH@@/$(DEB_HOST_MULTIARCH)/g" debian/dpdk-igb-uio-dkms.dkms.in > debian/dpdk-igb-uio-dkms.dkms
+       sed "s/@@DEB_HOST_MULTIARCH@@/$(DEB_HOST_MULTIARCH)/g" debian/dpdk-rte-kni-dkms.dkms.in > debian/dpdk-rte-kni-dkms.dkms
+       # Package(s): libdpdk-<NAME><VER> (bare runtime libs and PMDs)
+       for lib in $$(ls -1 debian/tmp/usr/lib/$(DEB_HOST_MULTIARCH)/*.so.*); do \
+         LN=$$(basename $${lib} | sed -e 's/\.so\.[0-9\.]*$$//' | tr '_' '-'); \
          if echo $${LN} | grep -q ".*[0-9]$$"; then \
-           PKG=$${LN}-$${VER}; \
+           PKG=$${LN}-$(DPDK_ABI); \
          else \
-           PKG=$${LN}$${VER}; \
+           PKG=$${LN}$(DPDK_ABI); \
+         fi; \
+         LIBF="$$(basename $${lib})"; \
+         dh_install -p $${PKG} usr/lib/$(DEB_HOST_MULTIARCH)/$${LIBF}; \
+         if [ -f debian/tmp/usr/lib/$(DEB_HOST_MULTIARCH)/*/*/$${LIBF} ]; then \
+           dh_install -p $${PKG} usr/lib/$(DEB_HOST_MULTIARCH)/*/*/$${LIBF}; \
          fi; \
-         echo "moving $${lib} for library $${PKG}"; \
-         mkdir -p debian/$${PKG}/$(LIBDIR); \
-         mv $${lib} debian/$${PKG}/$(LIBDIR); \
        done
-       # pkg-config
-       mkdir -p debian/libdpdk-dev/$(LIBDIR)/pkgconfig
-       LIBS=$$(sed -e 's/GROUP ( \(.*\) )/\1/' -e 's/lib/-l/g' -e 's/\.so//g' \
-               $(CURDIR)/debian/libdpdk-dev/$(LIBDIR)/libdpdk.so); \
-       sed -e "s/@DPDK_LIBS@/$${LIBS}/" -e "s/@VERSION@/$(VERSION)/" \
-               debian/libdpdk.pc.in > debian/libdpdk-dev/$(LIBDIR)/pkgconfig/libdpdk.pc
        # Package: dpdk-igb-uio-dkms
-       mkdir -p debian/dpdk-igb-uio-dkms/usr/src/dpdk-igb-uio-$(VERSION)
-       cp lib/librte_eal/linuxapp/igb_uio/* \
-               debian/dpdk-igb-uio-dkms/usr/src/dpdk-igb-uio-$(VERSION)
+       dh_install -p dpdk-igb-uio-dkms kernel/linux/igb_uio/* \
+               usr/src/dpdk-igb-uio-$(DEB_VERSION_UPSTREAM)
        # Package: dpdk-rte-kni-dkms
-       mkdir -p debian/dpdk-rte-kni-dkms/usr/src/dpdk-rte-kni-$(VERSION)
-       cp -a lib/librte_eal/linuxapp/kni/* \
-               debian/dpdk-rte-kni-dkms/usr/src/dpdk-rte-kni-$(VERSION)
+       dh_install -p dpdk-rte-kni-dkms kernel/linux/kni/* \
+               usr/src/dpdk-rte-kni-$(DEB_VERSION_UPSTREAM)
+ifneq (,$(KVERS))
+       # Package: dpdk-modules-<kernel version>
+       dh_install -p dpdk-modules-$(KVERS) lib/modules
+endif
 
 override_dh_dkms:
-       dh_dkms -V $(VERSION)
+       dh_dkms -V $(DEB_VERSION_UPSTREAM)
 
 override_dh_installinit:
-       dh_installinit --no-start --no-restart-on-upgrade
+       dh_installinit --no-start --no-stop-on-upgrade
 
 override_dh_systemd_start:
-       dh_systemd_start --no-start --no-restart-on-upgrade
+       dh_systemd_start --no-start --no-stop-on-upgrade
 
 override_dh_auto_test:
 
+override_dh_python3:
+       # dh_python only looks in /usr/share/package_name but dpdk-doc installs in
+       # /usr/share/dpdk, so pass /usr to catch all
+       dh_python3 --shebang=/usr/bin/python3 /usr
+
+override_dh_missing:
+       dh_missing --fail-missing