* [PATCH v1 1/3] uapi: introduce kernel uAPI headers import
2024-10-09 8:58 [PATCH v1 0/3] Import Kernel uAPI header files Maxime Coquelin
@ 2024-10-09 8:58 ` Maxime Coquelin
2024-10-09 14:50 ` Stephen Hemminger
2024-10-09 8:58 ` [PATCH v1 2/3] uapi: import VDUSE header Maxime Coquelin
` (2 subsequent siblings)
3 siblings, 1 reply; 11+ messages in thread
From: Maxime Coquelin @ 2024-10-09 8:58 UTC (permalink / raw)
To: dev, techboard, david.marchand, thomas, mb, stephen, ferruh.yigit
Cc: Maxime Coquelin
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 have to be explicitly imported.
Guidelines are provided in the documentation, and helper
script is also provided to ensure proper import of the
headers (unmodified content from a released Kernel
version).
Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
---
devtools/linux-uapi.sh | 177 +++++++++++++++++++++++++
doc/guides/contributing/index.rst | 1 +
doc/guides/contributing/linux_uapi.rst | 70 ++++++++++
kernel/linux/uapi/.gitignore | 4 +
kernel/linux/uapi/version | 1 +
meson.build | 8 +-
6 files changed, 259 insertions(+), 2 deletions(-)
create mode 100755 devtools/linux-uapi.sh
create mode 100644 doc/guides/contributing/linux_uapi.rst
create mode 100644 kernel/linux/uapi/.gitignore
create mode 100644 kernel/linux/uapi/version
diff --git a/devtools/linux-uapi.sh b/devtools/linux-uapi.sh
new file mode 100755
index 0000000000..175d6a345d
--- /dev/null
+++ b/devtools/linux-uapi.sh
@@ -0,0 +1,177 @@
+#!/bin/sh -e
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright (c) 2024 Red Hat, Inc.
+
+#
+# Import and check Linux Kernel uAPI headers
+#
+
+base_url="https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/plain/include/uapi/"
+base_path="kernel/linux/uapi/"
+version=""
+file=""
+check_headers=0
+errors=0
+
+print_usage()
+{
+ echo "Usage: $(basename $0) [-h] [-i FILE] [-u VERSION] [-c]"
+ echo "-i FILE import Linux header file. E.g. linux/vfio.h"
+ echo "-u VERSION update imported list of Linux headers to a given version. E.g. v6.10"
+ echo "-c check headers are valid"
+}
+
+version_older_than() {
+ printf '%s\n%s' "$1" "$2" | sort -C -V
+}
+
+download_header()
+{
+ local header=$1
+ local path=$2
+
+ local url="${base_url}${header}?h=${version}"
+
+ if ! curl -s -f --create-dirs -o $path $url; then
+ echo "Failed to download $url"
+ return 1
+ fi
+
+ return 0
+}
+
+update_headers()
+{
+ local header
+ local url
+ local path
+
+ echo "Updating to $version"
+ for filename in $(find $base_path -name "*.h" -type f); do
+ header=${filename#$base_path}
+ download_header $header $filename || return 1
+ done
+
+ return 0
+}
+
+import_header()
+{
+ local include
+ local import
+ local header=$1
+
+ local path="${base_path}${header}"
+
+ download_header $header $path || return 1
+
+ for include in $(sed -ne 's/^#include <\(.*\)>$/\1/p' $path); do
+ if [ ! -f "${base_path}${include}" ]; then
+ read -p "Import $include (y/n): " import && [ "$import" = 'y' ] || continue
+ echo "Importing $include for $path"
+ import_header "$include" || return 1
+ fi
+ done
+
+ return 0
+}
+
+fixup_includes()
+{
+ local path=$1
+
+ sed -i -E -e '
+ s/([[:space:](])(__user|__force|__iomem)[[:space:]]/\1/g
+ s/__attribute_const__([[:space:]]|$)/\1/g
+ s@^#include <linux/compiler(|_types).h>@@
+ s/(^|[^a-zA-Z0-9])__packed([^a-zA-Z0-9_]|$)/\1__attribute__((packed))\2/g
+ s/(^|[[:space:](])(inline|asm|volatile)([[:space:](]|$)/\1__\2__\3/g
+ s@#(ifndef|define|endif[[:space:]]*/[*])[[:space:]]*_UAPI@#\1 @
+ ' $path
+
+ # Prepend include path with "uapi/" if the header is imported
+ for include in $(sed -ne 's/^#include <\(.*\)>$/\1/p' $path); do
+ if [ -f "${base_path}${include}" ]; then
+ sed -i "s|${include}|uapi/${include}|g" $path
+ fi
+ done
+}
+
+check_header() {
+ echo -n "Checking $1... "
+
+ if ! diff -q $1 $2 >/dev/null; then
+ echo "KO"
+ diff -u $1 $2
+ return 1
+ else
+ echo "OK"
+ fi
+
+ return 0
+}
+
+while getopts i:u:ch opt ; do
+ case ${opt} in
+ i ) file=$OPTARG ;;
+ u ) version=$OPTARG ;;
+ c ) check_headers=1 ;;
+ 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)/..
+
+current_version=$(< ${base_path}/version)
+
+if [ -n "${version}" ]; then
+ if version_older_than "$version" "$current_version"; then
+ echo "Headers already up to date ($current_version >= $version)"
+ version=$current_version
+ else
+ update_headers || exit 1
+ fi
+else
+ echo "Version not specified, using current version ($current_version)"
+ version=$current_version
+fi
+
+if [ -n "${file}" ]; then
+ import_header $file || exit 1
+fi
+
+for filename in $(find $base_path -name "*.h" -type f); do
+ fixup_includes $filename || exit 1
+done
+
+echo $version > ${base_path}/version
+
+if [ $check_headers -eq 0 ]; then
+ exit 0
+fi
+
+tmpheader="$(mktemp -t dpdk.checkuapi.XXXXXX)"
+trap "rm -f '$tmpheader" INT
+
+echo "Checking imported headers for version ${version}"
+
+for filename in $(find $base_path -name "*.h" -type f); do
+ header=${filename#$base_path}
+ download_header $header $tmpheader || exit 1
+ fixup_includes $tmpheader || exit 1
+ check_header $filename $tmpheader || errors=$((errors+1))
+done
+
+echo "$errors error(s) found"
+
+rm -f $tmpheader
+trap - INT
+
+exit $errors
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..00bc092311
--- /dev/null
+++ b/doc/guides/contributing/linux_uapi.rst
@@ -0,0 +1,70 @@
+.. 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/linux-uapi.sh -i linux/vduse.h -u v6.10
+
+Once imported, the header files should be committed without any other change.
+Note that all the imported headers will be updated to the requested version.
+
+Updating imported headers to a newer released version should only be done on
+a need basis, it can be achieved using the same script:
+
+.. code-block:: console
+
+ ./devtools/linux-uapi.sh -u v6.10
+
+The commit message should reflect why updating the headers is necessary.
+
+Once committed, user can check headers are valid by using the same Linux
+uAPI script using the check option:
+
+.. code-block:: console
+
+ ./devtools/linux-uapi.sh -c
+
+Note that all the linux-uapi.sh script options can be combined. For example:
+
+.. code-block:: console
+
+ ./devtools/linux-uapi.sh -i linux/virtio_net.h -u v6.10 -c
+
+Header inclusion into library or driver
+---------------------------------------
+
+The library or driver willing to make use of imported uAPI headers needs to
+explicitly include the header file with ``uapi/`` prefix in C files.
+For example to include VDUSE uAPI:
+
+.. code-block:: c
+
+ #include <uapi/linux/vduse.h>
+
diff --git a/kernel/linux/uapi/.gitignore b/kernel/linux/uapi/.gitignore
new file mode 100644
index 0000000000..558ba597d6
--- /dev/null
+++ b/kernel/linux/uapi/.gitignore
@@ -0,0 +1,4 @@
+**
+!**/
+!**/*.h
+!version
diff --git a/kernel/linux/uapi/version b/kernel/linux/uapi/version
new file mode 100644
index 0000000000..2b256fd48f
--- /dev/null
+++ b/kernel/linux/uapi/version
@@ -0,0 +1 @@
+v0.0
diff --git a/meson.build b/meson.build
index 8b248d4505..85b53cafbb 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('kernel/linux')
+endif
+
# build libs and drivers
subdir('lib')
subdir('drivers')
--
2.46.2
^ permalink raw reply [flat|nested] 11+ messages in thread* Re: [PATCH v1 1/3] uapi: introduce kernel uAPI headers import
2024-10-09 8:58 ` [PATCH v1 1/3] uapi: introduce kernel uAPI headers import Maxime Coquelin
@ 2024-10-09 14:50 ` Stephen Hemminger
2024-10-14 12:14 ` Maxime Coquelin
0 siblings, 1 reply; 11+ messages in thread
From: Stephen Hemminger @ 2024-10-09 14:50 UTC (permalink / raw)
To: Maxime Coquelin; +Cc: dev, techboard, david.marchand, thomas, mb, ferruh.yigit
On Wed, 9 Oct 2024 10:58:03 +0200
Maxime Coquelin <maxime.coquelin@redhat.com> wrote:
> +fixup_includes()
> +{
> + local path=$1
> +
> + sed -i -E -e '
> + s/([[:space:](])(__user|__force|__iomem)[[:space:]]/\1/g
> + s/__attribute_const__([[:space:]]|$)/\1/g
> + s@^#include <linux/compiler(|_types).h>@@
> + s/(^|[^a-zA-Z0-9])__packed([^a-zA-Z0-9_]|$)/\1__attribute__((packed))\2/g
> + s/(^|[[:space:](])(inline|asm|volatile)([[:space:](]|$)/\1__\2__\3/g
> + s@#(ifndef|define|endif[[:space:]]*/[*])[[:space:]]*_UAPI@#\1 @
> + ' $path
> +
Rather than copy-pasting headers_install.sh, could you use it directly?
The copy/paste from GPL-2.0 concerns me.
And the potential upstream change as well.
^ permalink raw reply [flat|nested] 11+ messages in thread* Re: [PATCH v1 1/3] uapi: introduce kernel uAPI headers import
2024-10-09 14:50 ` Stephen Hemminger
@ 2024-10-14 12:14 ` Maxime Coquelin
2024-10-24 12:45 ` Maxime Coquelin
0 siblings, 1 reply; 11+ messages in thread
From: Maxime Coquelin @ 2024-10-14 12:14 UTC (permalink / raw)
To: Stephen Hemminger
Cc: dev, techboard, david.marchand, thomas, mb, ferruh.yigit
On 10/9/24 16:50, Stephen Hemminger wrote:
> On Wed, 9 Oct 2024 10:58:03 +0200
> Maxime Coquelin <maxime.coquelin@redhat.com> wrote:
>
>> +fixup_includes()
>> +{
>> + local path=$1
>> +
>> + sed -i -E -e '
>> + s/([[:space:](])(__user|__force|__iomem)[[:space:]]/\1/g
>> + s/__attribute_const__([[:space:]]|$)/\1/g
>> + s@^#include <linux/compiler(|_types).h>@@
>> + s/(^|[^a-zA-Z0-9])__packed([^a-zA-Z0-9_]|$)/\1__attribute__((packed))\2/g
>> + s/(^|[[:space:](])(inline|asm|volatile)([[:space:](]|$)/\1__\2__\3/g
>> + s@#(ifndef|define|endif[[:space:]]*/[*])[[:space:]]*_UAPI@#\1 @
>> + ' $path
>> +
>
>
>
> Rather than copy-pasting headers_install.sh, could you use it directly?
>
> The copy/paste from GPL-2.0 concerns me.
> And the potential upstream change as well.
>
The downside I see by calling directly the headers_install.sh script is
that it could trigger some false positives if the version used for
import is different from the one used to check.
What we could do it to just do our own sed command if that's really an
issue, that we would tailor based on our needs.
Others, any thoughts?
Thanks,
Maxime
^ permalink raw reply [flat|nested] 11+ messages in thread* Re: [PATCH v1 1/3] uapi: introduce kernel uAPI headers import
2024-10-14 12:14 ` Maxime Coquelin
@ 2024-10-24 12:45 ` Maxime Coquelin
2024-10-24 16:14 ` Stephen Hemminger
0 siblings, 1 reply; 11+ messages in thread
From: Maxime Coquelin @ 2024-10-24 12:45 UTC (permalink / raw)
To: Stephen Hemminger
Cc: dev, techboard, david.marchand, thomas, mb, ferruh.yigit
On 10/14/24 14:14, Maxime Coquelin wrote:
>
>
> On 10/9/24 16:50, Stephen Hemminger wrote:
>> On Wed, 9 Oct 2024 10:58:03 +0200
>> Maxime Coquelin <maxime.coquelin@redhat.com> wrote:
>>
>>> +fixup_includes()
>>> +{
>>> + local path=$1
>>> +
>>> + sed -i -E -e '
>>> + s/([[:space:](])(__user|__force|__iomem)[[:space:]]/\1/g
>>> + s/__attribute_const__([[:space:]]|$)/\1/g
>>> + s@^#include <linux/compiler(|_types).h>@@
>>> +
>>> s/(^|[^a-zA-Z0-9])__packed([^a-zA-Z0-9_]|$)/\1__attribute__((packed))\2/g
>>> +
>>> s/(^|[[:space:](])(inline|asm|volatile)([[:space:](]|$)/\1__\2__\3/g
>>> + s@#(ifndef|define|endif[[:space:]]*/[*])[[:space:]]*_UAPI@#\1 @
>>> + ' $path
>>> +
>>
>>
>>
>> Rather than copy-pasting headers_install.sh, could you use it directly?
>>
>> The copy/paste from GPL-2.0 concerns me.
>> And the potential upstream change as well.
>>
>
> The downside I see by calling directly the headers_install.sh script is
> that it could trigger some false positives if the version used for
> import is different from the one used to check.
>
> What we could do it to just do our own sed command if that's really an
> issue, that we would tailor based on our needs.
>
> Others, any thoughts?
Following the discussion during the DPDK Release status meeting this
morning, I will propose a new version implementing our own sed command,
tailored to only our needs.
Thanks,
Maxime
> Thanks,
> Maxime
^ permalink raw reply [flat|nested] 11+ messages in thread* Re: [PATCH v1 1/3] uapi: introduce kernel uAPI headers import
2024-10-24 12:45 ` Maxime Coquelin
@ 2024-10-24 16:14 ` Stephen Hemminger
2024-10-25 7:57 ` Maxime Coquelin
0 siblings, 1 reply; 11+ messages in thread
From: Stephen Hemminger @ 2024-10-24 16:14 UTC (permalink / raw)
To: Maxime Coquelin; +Cc: dev, techboard, david.marchand, thomas, mb, ferruh.yigit
On Thu, 24 Oct 2024 14:45:10 +0200
Maxime Coquelin <maxime.coquelin@redhat.com> wrote:
> >>
> >>
> >> Rather than copy-pasting headers_install.sh, could you use it directly?
> >>
> >> The copy/paste from GPL-2.0 concerns me.
> >> And the potential upstream change as well.
> >>
> >
> > The downside I see by calling directly the headers_install.sh script is
> > that it could trigger some false positives if the version used for
> > import is different from the one used to check.
> >
> > What we could do it to just do our own sed command if that's really an
> > issue, that we would tailor based on our needs.
> >
> > Others, any thoughts?
>
> Following the discussion during the DPDK Release status meeting this
> morning, I will propose a new version implementing our own sed command,
> tailored to only our needs.
Or you can just ask original author of the headers_install.sh script.
Have done that many times and gotten approval every time when taking
stuff out of kernel infrastructure for DPDK.
^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH v1 1/3] uapi: introduce kernel uAPI headers import
2024-10-24 16:14 ` Stephen Hemminger
@ 2024-10-25 7:57 ` Maxime Coquelin
0 siblings, 0 replies; 11+ messages in thread
From: Maxime Coquelin @ 2024-10-25 7:57 UTC (permalink / raw)
To: Stephen Hemminger
Cc: dev, techboard, david.marchand, thomas, mb, ferruh.yigit
On 10/24/24 18:14, Stephen Hemminger wrote:
> On Thu, 24 Oct 2024 14:45:10 +0200
> Maxime Coquelin <maxime.coquelin@redhat.com> wrote:
>
>>>>
>>>>
>>>> Rather than copy-pasting headers_install.sh, could you use it directly?
>>>>
>>>> The copy/paste from GPL-2.0 concerns me.
>>>> And the potential upstream change as well.
>>>>
>>>
>>> The downside I see by calling directly the headers_install.sh script is
>>> that it could trigger some false positives if the version used for
>>> import is different from the one used to check.
>>>
>>> What we could do it to just do our own sed command if that's really an
>>> issue, that we would tailor based on our needs.
>>>
>>> Others, any thoughts?
>>
>> Following the discussion during the DPDK Release status meeting this
>> morning, I will propose a new version implementing our own sed command,
>> tailored to only our needs.
>
> Or you can just ask original author of the headers_install.sh script.
> Have done that many times and gotten approval every time when taking
> stuff out of kernel infrastructure for DPDK.
>
Ok, what we need for now is really trivial. I'll do it myself.
We can revisit in the future if the need arises.
Thanks,
Maxime
^ permalink raw reply [flat|nested] 11+ messages in thread
* [PATCH v1 2/3] uapi: import VDUSE header
2024-10-09 8:58 [PATCH v1 0/3] Import Kernel uAPI header files Maxime Coquelin
2024-10-09 8:58 ` [PATCH v1 1/3] uapi: introduce kernel uAPI headers import Maxime Coquelin
@ 2024-10-09 8:58 ` Maxime Coquelin
2024-10-09 8:58 ` [PATCH v1 3/3] vduse: use imported VDUSE uAPI header Maxime Coquelin
2024-10-09 10:29 ` [PATCH v1 0/3] Import Kernel uAPI header files Morten Brørup
3 siblings, 0 replies; 11+ messages in thread
From: Maxime Coquelin @ 2024-10-09 8:58 UTC (permalink / raw)
To: dev, techboard, david.marchand, thomas, mb, stephen, ferruh.yigit
Cc: Maxime Coquelin
Import VDUSE headers to be included in the Vhost library.
Set header version to v6.10 Linux Kernel release.
Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
---
kernel/linux/uapi/linux/vduse.h | 353 ++++++++++++++++++++++++++++++++
kernel/linux/uapi/version | 2 +-
2 files changed, 354 insertions(+), 1 deletion(-)
create mode 100644 kernel/linux/uapi/linux/vduse.h
diff --git a/kernel/linux/uapi/linux/vduse.h b/kernel/linux/uapi/linux/vduse.h
new file mode 100644
index 0000000000..6d2ca064b5
--- /dev/null
+++ b/kernel/linux/uapi/linux/vduse.h
@@ -0,0 +1,353 @@
+/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
+#ifndef _VDUSE_H_
+#define _VDUSE_H_
+
+#include <linux/types.h>
+
+#define VDUSE_BASE 0x81
+
+/* The ioctls for control device (/dev/vduse/control) */
+
+#define VDUSE_API_VERSION 0
+
+/*
+ * Get the version of VDUSE API that kernel supported (VDUSE_API_VERSION).
+ * This is used for future extension.
+ */
+#define VDUSE_GET_API_VERSION _IOR(VDUSE_BASE, 0x00, __u64)
+
+/* Set the version of VDUSE API that userspace supported. */
+#define VDUSE_SET_API_VERSION _IOW(VDUSE_BASE, 0x01, __u64)
+
+/**
+ * struct vduse_dev_config - basic configuration of a VDUSE device
+ * @name: VDUSE device name, needs to be NUL terminated
+ * @vendor_id: virtio vendor id
+ * @device_id: virtio device id
+ * @features: virtio features
+ * @vq_num: the number of virtqueues
+ * @vq_align: the allocation alignment of virtqueue's metadata
+ * @reserved: for future use, needs to be initialized to zero
+ * @config_size: the size of the configuration space
+ * @config: the buffer of the configuration space
+ *
+ * Structure used by VDUSE_CREATE_DEV ioctl to create VDUSE device.
+ */
+struct vduse_dev_config {
+#define VDUSE_NAME_MAX 256
+ char name[VDUSE_NAME_MAX];
+ __u32 vendor_id;
+ __u32 device_id;
+ __u64 features;
+ __u32 vq_num;
+ __u32 vq_align;
+ __u32 reserved[13];
+ __u32 config_size;
+ __u8 config[];
+};
+
+/* Create a VDUSE device which is represented by a char device (/dev/vduse/$NAME) */
+#define VDUSE_CREATE_DEV _IOW(VDUSE_BASE, 0x02, struct vduse_dev_config)
+
+/*
+ * Destroy a VDUSE device. Make sure there are no more references
+ * to the char device (/dev/vduse/$NAME).
+ */
+#define VDUSE_DESTROY_DEV _IOW(VDUSE_BASE, 0x03, char[VDUSE_NAME_MAX])
+
+/* The ioctls for VDUSE device (/dev/vduse/$NAME) */
+
+/**
+ * struct vduse_iotlb_entry - entry of IOTLB to describe one IOVA region [start, last]
+ * @offset: the mmap offset on returned file descriptor
+ * @start: start of the IOVA region
+ * @last: last of the IOVA region
+ * @perm: access permission of the IOVA region
+ *
+ * Structure used by VDUSE_IOTLB_GET_FD ioctl to find an overlapped IOVA region.
+ */
+struct vduse_iotlb_entry {
+ __u64 offset;
+ __u64 start;
+ __u64 last;
+#define VDUSE_ACCESS_RO 0x1
+#define VDUSE_ACCESS_WO 0x2
+#define VDUSE_ACCESS_RW 0x3
+ __u8 perm;
+};
+
+/*
+ * Find the first IOVA region that overlaps with the range [start, last]
+ * and return the corresponding file descriptor. Return -EINVAL means the
+ * IOVA region doesn't exist. Caller should set start and last fields.
+ */
+#define VDUSE_IOTLB_GET_FD _IOWR(VDUSE_BASE, 0x10, struct vduse_iotlb_entry)
+
+/*
+ * Get the negotiated virtio features. It's a subset of the features in
+ * struct vduse_dev_config which can be accepted by virtio driver. It's
+ * only valid after FEATURES_OK status bit is set.
+ */
+#define VDUSE_DEV_GET_FEATURES _IOR(VDUSE_BASE, 0x11, __u64)
+
+/**
+ * struct vduse_config_data - data used to update configuration space
+ * @offset: the offset from the beginning of configuration space
+ * @length: the length to write to configuration space
+ * @buffer: the buffer used to write from
+ *
+ * Structure used by VDUSE_DEV_SET_CONFIG ioctl to update device
+ * configuration space.
+ */
+struct vduse_config_data {
+ __u32 offset;
+ __u32 length;
+ __u8 buffer[];
+};
+
+/* Set device configuration space */
+#define VDUSE_DEV_SET_CONFIG _IOW(VDUSE_BASE, 0x12, struct vduse_config_data)
+
+/*
+ * Inject a config interrupt. It's usually used to notify virtio driver
+ * that device configuration space has changed.
+ */
+#define VDUSE_DEV_INJECT_CONFIG_IRQ _IO(VDUSE_BASE, 0x13)
+
+/**
+ * struct vduse_vq_config - basic configuration of a virtqueue
+ * @index: virtqueue index
+ * @max_size: the max size of virtqueue
+ * @reserved: for future use, needs to be initialized to zero
+ *
+ * Structure used by VDUSE_VQ_SETUP ioctl to setup a virtqueue.
+ */
+struct vduse_vq_config {
+ __u32 index;
+ __u16 max_size;
+ __u16 reserved[13];
+};
+
+/*
+ * Setup the specified virtqueue. Make sure all virtqueues have been
+ * configured before the device is attached to vDPA bus.
+ */
+#define VDUSE_VQ_SETUP _IOW(VDUSE_BASE, 0x14, struct vduse_vq_config)
+
+/**
+ * struct vduse_vq_state_split - split virtqueue state
+ * @avail_index: available index
+ */
+struct vduse_vq_state_split {
+ __u16 avail_index;
+};
+
+/**
+ * struct vduse_vq_state_packed - packed virtqueue state
+ * @last_avail_counter: last driver ring wrap counter observed by device
+ * @last_avail_idx: device available index
+ * @last_used_counter: device ring wrap counter
+ * @last_used_idx: used index
+ */
+struct vduse_vq_state_packed {
+ __u16 last_avail_counter;
+ __u16 last_avail_idx;
+ __u16 last_used_counter;
+ __u16 last_used_idx;
+};
+
+/**
+ * struct vduse_vq_info - information of a virtqueue
+ * @index: virtqueue index
+ * @num: the size of virtqueue
+ * @desc_addr: address of desc area
+ * @driver_addr: address of driver area
+ * @device_addr: address of device area
+ * @split: split virtqueue state
+ * @packed: packed virtqueue state
+ * @ready: ready status of virtqueue
+ *
+ * Structure used by VDUSE_VQ_GET_INFO ioctl to get virtqueue's information.
+ */
+struct vduse_vq_info {
+ __u32 index;
+ __u32 num;
+ __u64 desc_addr;
+ __u64 driver_addr;
+ __u64 device_addr;
+ union {
+ struct vduse_vq_state_split split;
+ struct vduse_vq_state_packed packed;
+ };
+ __u8 ready;
+};
+
+/* Get the specified virtqueue's information. Caller should set index field. */
+#define VDUSE_VQ_GET_INFO _IOWR(VDUSE_BASE, 0x15, struct vduse_vq_info)
+
+/**
+ * struct vduse_vq_eventfd - eventfd configuration for a virtqueue
+ * @index: virtqueue index
+ * @fd: eventfd, -1 means de-assigning the eventfd
+ *
+ * Structure used by VDUSE_VQ_SETUP_KICKFD ioctl to setup kick eventfd.
+ */
+struct vduse_vq_eventfd {
+ __u32 index;
+#define VDUSE_EVENTFD_DEASSIGN -1
+ int fd;
+};
+
+/*
+ * Setup kick eventfd for specified virtqueue. The kick eventfd is used
+ * by VDUSE kernel module to notify userspace to consume the avail vring.
+ */
+#define VDUSE_VQ_SETUP_KICKFD _IOW(VDUSE_BASE, 0x16, struct vduse_vq_eventfd)
+
+/*
+ * Inject an interrupt for specific virtqueue. It's used to notify virtio driver
+ * to consume the used vring.
+ */
+#define VDUSE_VQ_INJECT_IRQ _IOW(VDUSE_BASE, 0x17, __u32)
+
+/**
+ * struct vduse_iova_umem - userspace memory configuration for one IOVA region
+ * @uaddr: start address of userspace memory, it must be aligned to page size
+ * @iova: start of the IOVA region
+ * @size: size of the IOVA region
+ * @reserved: for future use, needs to be initialized to zero
+ *
+ * Structure used by VDUSE_IOTLB_REG_UMEM and VDUSE_IOTLB_DEREG_UMEM
+ * ioctls to register/de-register userspace memory for IOVA regions
+ */
+struct vduse_iova_umem {
+ __u64 uaddr;
+ __u64 iova;
+ __u64 size;
+ __u64 reserved[3];
+};
+
+/* Register userspace memory for IOVA regions */
+#define VDUSE_IOTLB_REG_UMEM _IOW(VDUSE_BASE, 0x18, struct vduse_iova_umem)
+
+/* De-register the userspace memory. Caller should set iova and size field. */
+#define VDUSE_IOTLB_DEREG_UMEM _IOW(VDUSE_BASE, 0x19, struct vduse_iova_umem)
+
+/**
+ * struct vduse_iova_info - information of one IOVA region
+ * @start: start of the IOVA region
+ * @last: last of the IOVA region
+ * @capability: capability of the IOVA regsion
+ * @reserved: for future use, needs to be initialized to zero
+ *
+ * Structure used by VDUSE_IOTLB_GET_INFO ioctl to get information of
+ * one IOVA region.
+ */
+struct vduse_iova_info {
+ __u64 start;
+ __u64 last;
+#define VDUSE_IOVA_CAP_UMEM (1 << 0)
+ __u64 capability;
+ __u64 reserved[3];
+};
+
+/*
+ * Find the first IOVA region that overlaps with the range [start, last]
+ * and return some information on it. Caller should set start and last fields.
+ */
+#define VDUSE_IOTLB_GET_INFO _IOWR(VDUSE_BASE, 0x1a, struct vduse_iova_info)
+
+/* The control messages definition for read(2)/write(2) on /dev/vduse/$NAME */
+
+/**
+ * enum vduse_req_type - request type
+ * @VDUSE_GET_VQ_STATE: get the state for specified virtqueue from userspace
+ * @VDUSE_SET_STATUS: set the device status
+ * @VDUSE_UPDATE_IOTLB: Notify userspace to update the memory mapping for
+ * specified IOVA range via VDUSE_IOTLB_GET_FD ioctl
+ */
+enum vduse_req_type {
+ VDUSE_GET_VQ_STATE,
+ VDUSE_SET_STATUS,
+ VDUSE_UPDATE_IOTLB,
+};
+
+/**
+ * struct vduse_vq_state - virtqueue state
+ * @index: virtqueue index
+ * @split: split virtqueue state
+ * @packed: packed virtqueue state
+ */
+struct vduse_vq_state {
+ __u32 index;
+ union {
+ struct vduse_vq_state_split split;
+ struct vduse_vq_state_packed packed;
+ };
+};
+
+/**
+ * struct vduse_dev_status - device status
+ * @status: device status
+ */
+struct vduse_dev_status {
+ __u8 status;
+};
+
+/**
+ * struct vduse_iova_range - IOVA range [start, last]
+ * @start: start of the IOVA range
+ * @last: last of the IOVA range
+ */
+struct vduse_iova_range {
+ __u64 start;
+ __u64 last;
+};
+
+/**
+ * struct vduse_dev_request - control request
+ * @type: request type
+ * @request_id: request id
+ * @reserved: for future use
+ * @vq_state: virtqueue state, only index field is available
+ * @s: device status
+ * @iova: IOVA range for updating
+ * @padding: padding
+ *
+ * Structure used by read(2) on /dev/vduse/$NAME.
+ */
+struct vduse_dev_request {
+ __u32 type;
+ __u32 request_id;
+ __u32 reserved[4];
+ union {
+ struct vduse_vq_state vq_state;
+ struct vduse_dev_status s;
+ struct vduse_iova_range iova;
+ __u32 padding[32];
+ };
+};
+
+/**
+ * struct vduse_dev_response - response to control request
+ * @request_id: corresponding request id
+ * @result: the result of request
+ * @reserved: for future use, needs to be initialized to zero
+ * @vq_state: virtqueue state
+ * @padding: padding
+ *
+ * Structure used by write(2) on /dev/vduse/$NAME.
+ */
+struct vduse_dev_response {
+ __u32 request_id;
+#define VDUSE_REQ_RESULT_OK 0x00
+#define VDUSE_REQ_RESULT_FAILED 0x01
+ __u32 result;
+ __u32 reserved[4];
+ union {
+ struct vduse_vq_state vq_state;
+ __u32 padding[32];
+ };
+};
+
+#endif /* _VDUSE_H_ */
diff --git a/kernel/linux/uapi/version b/kernel/linux/uapi/version
index 2b256fd48f..d06407735c 100644
--- a/kernel/linux/uapi/version
+++ b/kernel/linux/uapi/version
@@ -1 +1 @@
-v0.0
+v6.10
--
2.46.2
^ permalink raw reply [flat|nested] 11+ messages in thread* [PATCH v1 3/3] vduse: use imported VDUSE uAPI header
2024-10-09 8:58 [PATCH v1 0/3] Import Kernel uAPI header files Maxime Coquelin
2024-10-09 8:58 ` [PATCH v1 1/3] uapi: introduce kernel uAPI headers import Maxime Coquelin
2024-10-09 8:58 ` [PATCH v1 2/3] uapi: import VDUSE header Maxime Coquelin
@ 2024-10-09 8:58 ` Maxime Coquelin
2024-10-15 17:10 ` Stephen Hemminger
2024-10-09 10:29 ` [PATCH v1 0/3] Import Kernel uAPI header files Morten Brørup
3 siblings, 1 reply; 11+ messages in thread
From: Maxime Coquelin @ 2024-10-09 8:58 UTC (permalink / raw)
To: dev, techboard, david.marchand, thomas, mb, stephen, ferruh.yigit
Cc: Maxime Coquelin
This patch makes use of the imported VDUSE headers.
The VDUSE support is now systematically built on Linux
systems, even if the build system does not support its
ioctl().
Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
---
lib/vhost/meson.build | 5 +----
lib/vhost/vduse.c | 2 +-
lib/vhost/vduse.h | 22 ----------------------
3 files changed, 2 insertions(+), 27 deletions(-)
diff --git a/lib/vhost/meson.build b/lib/vhost/meson.build
index 41b622a9be..5c2528ff8c 100644
--- a/lib/vhost/meson.build
+++ b/lib/vhost/meson.build
@@ -23,16 +23,13 @@ sources = files(
'iotlb.c',
'socket.c',
'vdpa.c',
+ 'vduse.c',
'vhost.c',
'vhost_crypto.c',
'vhost_user.c',
'virtio_net.c',
'virtio_net_ctrl.c',
)
-if cc.has_header('linux/vduse.h')
- sources += files('vduse.c')
- cflags += '-DVHOST_HAS_VDUSE'
-endif
headers = files(
'rte_vdpa.h',
'rte_vhost.h',
diff --git a/lib/vhost/vduse.c b/lib/vhost/vduse.c
index c66602905c..a41ff2024c 100644
--- a/lib/vhost/vduse.c
+++ b/lib/vhost/vduse.c
@@ -8,7 +8,7 @@
#include <fcntl.h>
-#include <linux/vduse.h>
+#include <uapi/linux/vduse.h>
#include <linux/virtio_net.h>
#include <sys/ioctl.h>
diff --git a/lib/vhost/vduse.h b/lib/vhost/vduse.h
index 0d8f3f1205..47ca97a064 100644
--- a/lib/vhost/vduse.h
+++ b/lib/vhost/vduse.h
@@ -9,29 +9,7 @@
#define VDUSE_NET_SUPPORTED_FEATURES VIRTIO_NET_SUPPORTED_FEATURES
-#ifdef VHOST_HAS_VDUSE
-
int vduse_device_create(const char *path, bool compliant_ol_flags);
int vduse_device_destroy(const char *path);
-#else
-
-static inline int
-vduse_device_create(const char *path, bool compliant_ol_flags)
-{
- RTE_SET_USED(compliant_ol_flags);
-
- VHOST_CONFIG_LOG(path, ERR, "VDUSE support disabled at build time");
- return -1;
-}
-
-static inline int
-vduse_device_destroy(const char *path)
-{
- VHOST_CONFIG_LOG(path, ERR, "VDUSE support disabled at build time");
- return -1;
-}
-
-#endif /* VHOST_HAS_VDUSE */
-
#endif /* _VDUSE_H */
--
2.46.2
^ permalink raw reply [flat|nested] 11+ messages in thread* Re: [PATCH v1 3/3] vduse: use imported VDUSE uAPI header
2024-10-09 8:58 ` [PATCH v1 3/3] vduse: use imported VDUSE uAPI header Maxime Coquelin
@ 2024-10-15 17:10 ` Stephen Hemminger
0 siblings, 0 replies; 11+ messages in thread
From: Stephen Hemminger @ 2024-10-15 17:10 UTC (permalink / raw)
To: Maxime Coquelin; +Cc: dev, techboard, david.marchand, thomas, mb, ferruh.yigit
On Wed, 9 Oct 2024 10:58:05 +0200
Maxime Coquelin <maxime.coquelin@redhat.com> wrote:
> This patch makes use of the imported VDUSE headers.
> The VDUSE support is now systematically built on Linux
> systems, even if the build system does not support its
> ioctl().
>
> Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> ---
Recheck-request: iol-compile-amd64-testing
^ permalink raw reply [flat|nested] 11+ messages in thread
* RE: [PATCH v1 0/3] Import Kernel uAPI header files
2024-10-09 8:58 [PATCH v1 0/3] Import Kernel uAPI header files Maxime Coquelin
` (2 preceding siblings ...)
2024-10-09 8:58 ` [PATCH v1 3/3] vduse: use imported VDUSE uAPI header Maxime Coquelin
@ 2024-10-09 10:29 ` Morten Brørup
3 siblings, 0 replies; 11+ messages in thread
From: Morten Brørup @ 2024-10-09 10:29 UTC (permalink / raw)
To: Maxime Coquelin, dev, techboard, david.marchand, thomas, stephen,
ferruh.yigit
For the series,
Acked-by: Morten Brørup <mb@smartsharesystems.com>
^ permalink raw reply [flat|nested] 11+ messages in thread