From mboxrd@z Thu Jan 1 00:00:00 1970 X-GM-THRID: 6950929522725224448 X-Received: by 2002:a5d:4405:: with SMTP id z5mr5124137wrq.313.1619107572787; Thu, 22 Apr 2021 09:06:12 -0700 (PDT) X-BeenThere: isar-users@googlegroups.com Received: by 2002:a7b:c1c3:: with SMTP id a3ls2946206wmj.0.gmail; Thu, 22 Apr 2021 09:06:12 -0700 (PDT) X-Google-Smtp-Source: ABdhPJy+bupSVSi1MdXJ3D69mt2N3bPQMNEl+pD1ud68upWT9RzajMi+0MjZeeMXjrtAOS0oLziD X-Received: by 2002:a1c:2b03:: with SMTP id r3mr735566wmr.173.1619107571842; Thu, 22 Apr 2021 09:06:11 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1619107571; cv=none; d=google.com; s=arc-20160816; b=Qi6gOD8ntAWSpdehbHSZ4i4Siniyx/DLuDeO+Cuj8j/3dlVMa8KNOl6CR7051OgxyA 563ZFP5VPvMR8lDJvfDUpzqS0/vLCb6EQTE+FHEg/qEzkT4PS7llccCFTep13yFfLo+Y wiUqeQUFCH09iWsg+ED7k/V3M04R46Uq4kEsql1I4FzM0YAoHvM3lXt/vLk7hemIwrkb d2aNL9PbRFd1OMDvxUKQ6BCpGnm8Lyx+xcrIZ1/9g8qkOjxdpUbRTZEunC6iLwP2S7vK uxBeQhVgwQhNdottqXVXqVZyrRWwlFsCwVLsotAK6ckYLQ4W6vgKqcPmZa+UZyz+kf8N RODQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from; bh=CNeMJ6aVsk+mduGu0vwiT9eiFvTFQMmraCc60VM5DnA=; b=Cu2hmwmkKvndtmalBLQxx9snUz0k7faxyizroEIBPLWSTTE1pbHnMJIB8yu12Pn4wJ HZ56taPpwVOuqq42pJv6CRK/fAI8EfRVvnMDeHuhGGqKNTtGzPJvDmnDox6EPn+ay78R jJAngmJKtmOA+VNWYiLXGR4gyYPm0B6j7ZXUT36waWbXm92g3umjhn4vUyC6MeK2ydN6 z6dX6rXtlUKATxytpa+TYIlHcWWlvd4gjmc3n/kbfetpdubKVbKE8GQBvHmr0am8UCqM WSLWaQvbuvizHXLzcY0cD6Ixt+Mfiqv4pwA+ZieZxtUnbAFIKSGSbiDZKLj1FUQ4sJeL ggFQ== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of felix.moessbauer@siemens.com designates 194.138.37.39 as permitted sender) smtp.mailfrom=felix.moessbauer@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com Return-Path: Received: from lizzard.sbs.de (lizzard.sbs.de. [194.138.37.39]) by gmr-mx.google.com with ESMTPS id 187si347132wmb.0.2021.04.22.09.06.11 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 22 Apr 2021 09:06:11 -0700 (PDT) Received-SPF: pass (google.com: domain of felix.moessbauer@siemens.com designates 194.138.37.39 as permitted sender) client-ip=194.138.37.39; Authentication-Results: gmr-mx.google.com; spf=pass (google.com: domain of felix.moessbauer@siemens.com designates 194.138.37.39 as permitted sender) smtp.mailfrom=felix.moessbauer@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com Received: from mail1.sbs.de (mail1.sbs.de [192.129.41.35]) by lizzard.sbs.de (8.15.2/8.15.2) with ESMTPS id 13MG6BUt013062 (version=TLSv1.2 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK); Thu, 22 Apr 2021 18:06:11 +0200 Received: from MD1T0KAC-VM.ad001.siemens.net (md1t0kac.ad001.siemens.net [139.25.0.7]) by mail1.sbs.de (8.15.2/8.15.2) with ESMTP id 13MG2Up5011919; Thu, 22 Apr 2021 18:02:33 +0200 From: Felix Moessbauer To: isar-users@googlegroups.com, amikan@ilbers.de, jan.kiszka@siemens.com Cc: henning.schild@siemens.com, Felix Moessbauer Subject: [PATCH v2 1/1] Add support to build binary version of DKMS kernel modules Date: Thu, 22 Apr 2021 18:02:24 +0200 Message-Id: <20210422160224.23668-2-felix.moessbauer@siemens.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <3495ece4-950e-a0ba-64b2-e892f98ec1f8@ilbers.de> References: <3495ece4-950e-a0ba-64b2-e892f98ec1f8@ilbers.de> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-TUID: qtJIRAdFv+WX This patch adds support to build and install a kernel module that is available via a debian DKMS package. As it is hard to directly build and install the package we create and distribute a meta package that is independent of the kernel version. In that package, we depend on the versioned prebuild kernel module package. To build the dkms module, we add two tasks and directly use dkms to build the debian package containing the binary module Then we just copy the binary-module debian package to the workdir, Signed-off-by: Felix Moessbauer --- meta-isar/conf/local.conf.sample | 2 +- .../example-dkms-module.bb | 14 ++++ meta/classes/dkms-module.bbclass | 70 +++++++++++++++++++ scripts/ci_build.sh | 1 + 4 files changed, 86 insertions(+), 1 deletion(-) create mode 100644 meta-isar/recipes-kernel/example-dkms-module/example-dkms-module.bb create mode 100644 meta/classes/dkms-module.bbclass diff --git a/meta-isar/conf/local.conf.sample b/meta-isar/conf/local.conf.sample index 77585ec..678d2f0 100644 --- a/meta-isar/conf/local.conf.sample +++ b/meta-isar/conf/local.conf.sample @@ -178,7 +178,7 @@ CONF_VERSION = "1" # # The default list of extra packages to be installed. -IMAGE_INSTALL = "hello-isar example-raw example-module-${KERNEL_NAME} enable-fsck isar-exclude-docs samefile hello isar-disable-apt-cache cowsay example-prebuilt" +IMAGE_INSTALL = "hello-isar example-raw example-module-${KERNEL_NAME} example-dkms-module-${KERNEL_NAME} enable-fsck isar-exclude-docs samefile hello isar-disable-apt-cache cowsay example-prebuilt" # # Enable cross-compilation support diff --git a/meta-isar/recipes-kernel/example-dkms-module/example-dkms-module.bb b/meta-isar/recipes-kernel/example-dkms-module/example-dkms-module.bb new file mode 100644 index 0000000..113f232 --- /dev/null +++ b/meta-isar/recipes-kernel/example-dkms-module/example-dkms-module.bb @@ -0,0 +1,14 @@ +# Example recipe for building the binary version of a DKMS module +# +# This software is a part of ISAR. +# Copyright (c) Siemens AG, 2021 +# +# SPDX-License-Identifier: MIT + +inherit dkms-module + +PN .= "-${KERNEL_NAME}" + +#package name (without -dkms. E.g "v4l2loopback" for package "v4l2loopback-dkms") +DKMS_PACKAGE_NAME = "v4l2loopback" +AUTOLOAD += "v4l2loopback" diff --git a/meta/classes/dkms-module.bbclass b/meta/classes/dkms-module.bbclass new file mode 100644 index 0000000..9fbf4c2 --- /dev/null +++ b/meta/classes/dkms-module.bbclass @@ -0,0 +1,70 @@ +# This software is a part of ISAR. +# Copyright (C) 2021 Siemens AG +# +# SPDX-License-Identifier: MIT + +inherit dpkg-raw + +# Build and install a kernel module that is available via a debian DKMS package. +# As it is hard to directly build and install the package we create and distribute +# a meta package that is independent of the kernel version. +# In that package, we depend on the versioned prebuild kernel module package. +# +# To build the dkms module, we add two tasks and directly +# use dkms to build the debian package containing the binary module +# Then we just copy the binary-module debian package to the workdir, +# so ISAR's do_deploy_deb picks it up. + +#package name (without -dkms. E.g "dpdk-kmods" for package "dpdk-kmods-dkms") +DKMS_PACKAGE_NAME ?= "" +AUTOLOAD ?= "" + +DESCRIPTION ?= "Kernel module from DKMS package for ${PN}" +DEPENDS += "linux-headers-${KERNEL_NAME}" +DEBIAN_DEPENDS += "${DKMS_PACKAGE_NAME}-modules," +DEBIAN_BUILD_DEPENDS += "linux-headers-${KERNEL_NAME}, ${DKMS_PACKAGE_NAME}-dkms," + +ISAR_CROSS_COMPILE = "0" + +# install configuration to auto-load the modules in ${AUTOLOAD} +do_install() { + # auto load the module + install -v -d ${D}/etc/modules-load.d + for module in "${AUTOLOAD}"; do + echo $module > ${D}/etc/modules-load.d/${PN}.conf + done +} + +# build the binary kernel module and package as debian package (versioned) +do_module_build() { + # we have to find out the module version, e.g. dpdk-kmods/0~20201113+git -k 5.10.0-3-rt-amd64/x86_64 + REVISION=$(find ${BUILDCHROOT_DIR}/usr/src/${DKMS_PACKAGE_NAME}-* -type d -exec basename {} + | sed 's/${DKMS_PACKAGE_NAME}-//g') + if ! dpkg -s --root=${BUILDCHROOT_DIR} linux-headers-${KERNEL_NAME} | grep "Depends:.*linux-headers"; then + # custom kernels directly place their files in linux-image-KERNEL-NAME, instead + # of using a meta package + a versioned package with the resources + # The prebuild DKMS binary package depends on the versioned kernel package, + # but that is not available on custom kernels. Hence, we just remove the dependency. + bbnote "Building ${DKMS_PACKAGE_NAME} for custom kernel ${KERNEL_NAME}" + cp ${BUILDCHROOT_DIR}/etc/dkms/template-dkms-mkbmdeb/debian/control ${WORKDIR}/control.dkms.orig + sudo sed -i 's/, linux-image-KERNEL_VERSION//' ${BUILDCHROOT_DIR}/etc/dkms/template-dkms-mkbmdeb/debian/control + fi + # build the module for all installed kernels (should be just one) + sudo -E chroot ${BUILDCHROOT_DIR} dkms mkbmdeb ${DKMS_PACKAGE_NAME}/${REVISION} --all + DKMS_PACKAGE_VERSIONED=$(find ${BUILDCHROOT_DIR}/var/lib/dkms/${DKMS_PACKAGE_NAME}/ -name "${DKMS_PACKAGE_NAME}-modules*.deb" -exec dpkg -I {} + | grep "Package:" | awk '{print $2}') + if [ -z "$DKMS_PACKAGE_VERSIONED" ]; then + bberror "No prebuild dkms module found" + exit 1 + fi + # restore dkms template (if any) + cp ${WORKDIR}/control.dkms.orig ${BUILDCHROOT_DIR}/etc/dkms/template-dkms-mkbmdeb/debian/control || true +} + +# simply copy our module from the build tree to the expected output location +# of this recipe. Then, do_deploy_dep finds it and adds it to the +# debian isar repo +do_module_deploy() { + cp ${BUILDCHROOT_DIR}/var/lib/dkms/${DKMS_PACKAGE_NAME}/*/bmdeb/*.deb ${S}/../ +} + +addtask module_build after do_install_builddeps before do_dpkg_build +addtask module_deploy after do_module_build before do_deploy_deb diff --git a/scripts/ci_build.sh b/scripts/ci_build.sh index adc22e4..1426569 100755 --- a/scripts/ci_build.sh +++ b/scripts/ci_build.sh @@ -259,6 +259,7 @@ mv ${BUILDDIR}/tmp/deploy/images/qemuamd64/isar-image-base-debian-stretch-qemuam # Finalize with containerized images, since they remove some not-needed packages from the local.conf sed -i -e 's/\(IMAGE_INSTALL = .*\) example-module-${KERNEL_NAME}\(.*\)/\1\2/g' conf/local.conf +sed -i -e 's/\(IMAGE_INSTALL = .*\) example-dkms-module-${KERNEL_NAME}\(.*\)/\1\2/g' conf/local.conf sed -i -e 's/\(IMAGE_INSTALL = .*\) enable-fsck\(.*\)/\1\2/g' conf/local.conf bitbake $BB_ARGS $TARGETS_CONTAINERS while [ -e bitbake.sock ]; do sleep 1; done -- 2.20.1