This patch introduces uAPI headers import into the DPDK repository. This import is possible thanks to Linux Kernel licence exception for syscalls:
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/LICENSES/exceptions/Linux-syscall-note Header files are have to be explicitly imported, and libraries and drivers have to explicitly enable their inclusion. Guidelines are provided in the documentation, and helper scripts are also provided to ensure proper importation of the header (unmodified content from a released Kernel version): - import-linux-uapi.sh: used to download and install a given header to linux-headers/uapi/ - check-linux-uapi.sh: used to check all headers are valid Signed-off-by: Maxime Coquelin <maxime.coque...@redhat.com> --- devtools/check-linux-uapi.sh | 74 +++++++++++++++++++++++++ devtools/import-linux-uapi.sh | 45 +++++++++++++++ doc/guides/contributing/index.rst | 1 + doc/guides/contributing/linux_uapi.rst | 77 ++++++++++++++++++++++++++ linux-headers/uapi/.gitignore | 3 + meson.build | 8 ++- 6 files changed, 206 insertions(+), 2 deletions(-) create mode 100755 devtools/check-linux-uapi.sh create mode 100755 devtools/import-linux-uapi.sh create mode 100644 doc/guides/contributing/linux_uapi.rst create mode 100644 linux-headers/uapi/.gitignore diff --git a/devtools/check-linux-uapi.sh b/devtools/check-linux-uapi.sh new file mode 100755 index 0000000000..76111d78ce --- /dev/null +++ b/devtools/check-linux-uapi.sh @@ -0,0 +1,74 @@ +#!/bin/sh +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2024 Red Hat, Inc. + +# +# Import Linux Kernel uAPI header file +# + +base_url="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/include/uapi/"; +base_path="linux-headers/uapi/" +errors=0 + +print_usage() +{ + echo "Usage: $(basename $0) [-h]" +} + +check_uapi_header() { + path=$1 + file=${1//"$base_path"/} + version=$(git log --format=%b -1 $path | sed -ne 's/^uAPI Version: \(.*\)$/\1/p') + + url="${base_url}${file}?h=${version}" + echo -n "Checking $file for version $version... " + curl -s -f -o $tmpinput $url + if [ $? -ne 0 ]; then + echo "Failed to download $url" + exit 1 + fi + + diff -q $path $tmpinput >/dev/null + if [ $? -ne 0 ]; then + echo "KO" + diff -u $path $tmpinput + errors=$((errors+1)) + else + echo "OK" + fi +} + +while getopts hv ARG ; do + case $ARG in + h ) + print_usage + exit 0 + ;; + ? ) + print_usage + exit 1 + ;; + esac +done + +shift $(($OPTIND - 1)) +if [ $# -ne 0 ]; then + print_usage + exit 1 +fi + +cd $(dirname $0)/.. + +tmpinput=$(mktemp -t dpdk.checkuapi.XXXXXX) +trap "rm -f '$tmpinput'" INT + +while IFS= read -d '' -r filename; do + check_uapi_header "${filename}" </dev/null +done < <(find $base_path -name "*.h" -type f -print0) + +echo "$errors error(s) found" + +rm -f $tmpinput +trap - INT + +exit $errors diff --git a/devtools/import-linux-uapi.sh b/devtools/import-linux-uapi.sh new file mode 100755 index 0000000000..e48dc6546c --- /dev/null +++ b/devtools/import-linux-uapi.sh @@ -0,0 +1,45 @@ +#!/bin/sh -e +# SPDX-License-Identifier: BSD-3-Clause +# Copyright (c) 2024 Red Hat, Inc. + +# +# Import Linux Kernel uAPI header file +# + +base_url="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/include/uapi/"; +base_path="linux-headers/uapi/" + +print_usage() +{ + echo "Usage: $(basename $0) [-h] file version" + echo "Example of valid file: linux/vfio.h" + echo "Example of valid version: v6.10" +} + +while getopts hv ARG ; do + case $ARG in + h ) + print_usage + exit 0 + ;; + ? ) + print_usage + exit 1 + ;; + esac +done +shift $(($OPTIND - 1)) + +if [ $# -ne 2 ]; then + print_usage + exit 1 +fi + +file=$1 +version=$2 + +url="${base_url}${file}?h=${version}" +path="${base_path}${file}" + +cd $(dirname $0)/.. +curl -s -f --create-dirs -o $path $url diff --git a/doc/guides/contributing/index.rst b/doc/guides/contributing/index.rst index dcb9b1fbf0..603dc72654 100644 --- a/doc/guides/contributing/index.rst +++ b/doc/guides/contributing/index.rst @@ -19,3 +19,4 @@ Contributor's Guidelines vulnerability stable cheatsheet + linux_uapi diff --git a/doc/guides/contributing/linux_uapi.rst b/doc/guides/contributing/linux_uapi.rst new file mode 100644 index 0000000000..a3f684013a --- /dev/null +++ b/doc/guides/contributing/linux_uapi.rst @@ -0,0 +1,77 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2024 Red Hat, Inc. + +Linux uAPI header files +======================= + +Rationale +--------- + +The system a DPDK library or driver is built on is not necessarily running the +same Kernel version than the system that will run it. +Importing Linux Kernel uAPI headers enable to build features that are not +supported yet by the build system. + +For example, the build system runs upstream Kernel v5.19 and we would like to +build a VDUSE application that will use VDUSE_IOTLB_GET_INFO ioctl() introduced +in Linux Kernel v6.0. + +`Linux Kernel licence exception regarding syscalls +<https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/LICENSES/exceptions/Linux-syscall-note>`_ +enable importing unmodified Linux Kernel uAPI header files. + +Importing or updating an uAPI header file +----------------------------------------- + +In order to ensure the imported uAPI headers are both unmodified and from a +released version of the linux Kernel, a helper script is made available and +MUST be used. +Below is an example to import ``linux/vduse.h`` file from Linux ``v6.10``: + +.. code-block:: console + + ./devtools/import-linux-uapi.sh linux/vduse.h v6.10 + +Once imported, the header files should be committed without any other change, +and the commit message MUST specify the imported version using +``uAPI Version:`` tag and title MUST be prefixed with uapi keyword. +For example:: + + uapi: import VDUSE header file + + This patch imports VDUSE uAPI header file for inclusion + into the Vhost library. + + uAPI Version: v6.10 + + Signed-off-by: Alex Smith <alex.sm...@example.com> + +Updating an already imported header to a newer released version should only +be done on a need basis. +The commit message should reflect why updating the header is necessary. + +Once committed, user can check headers and commit message are valid by using +the Linux uAPI checker tool: + +.. code-block:: console + + ./devtools/check-linux-uapi.sh + +Header inclusion into library or driver +--------------------------------------- + +The library or driver willing to make use of imported uAPI headers needs to +explicitly add uAPI headers path to the ``includes`` var in its ``meson.build`` +file: + +.. code-block:: python + + includes += linux_uapi_inc + +Then, it can be included with ``uapi/`` prefix in C files. +For example to include VDUSE uAPI: + +.. code-block:: c + + #include <uapi/linux/vduse.h> + diff --git a/linux-headers/uapi/.gitignore b/linux-headers/uapi/.gitignore new file mode 100644 index 0000000000..88829d04e9 --- /dev/null +++ b/linux-headers/uapi/.gitignore @@ -0,0 +1,3 @@ +** +!**/ +!**/*.h diff --git a/meson.build b/meson.build index 8b248d4505..aca47334ab 100644 --- a/meson.build +++ b/meson.build @@ -67,16 +67,20 @@ endif # configure the build, and make sure configs here and in config folder are # able to be included in any file. We also store a global array of include dirs # for passing to pmdinfogen scripts -global_inc = include_directories('.', 'config', +global_inc = [include_directories('.', 'config', 'lib/eal/include', 'lib/eal/@0@/include'.format(host_machine.system()), 'lib/eal/@0@/include'.format(arch_subdir), -) +)] # do configuration and get tool paths subdir('buildtools') subdir('config') +if is_linux + global_inc += include_directories('linux-headers') +endif + # build libs and drivers subdir('lib') subdir('drivers') -- 2.46.0
