[1/3] compress/uadk: Introduce UADK compression driver

Message ID 20240422143102.251-2-zhangfei.gao@linaro.org (mailing list archive)
State Changes Requested
Delegated to: akhil goyal
Headers
Series Introduce UADK compression driver |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Zhangfei Gao April 22, 2024, 2:31 p.m. UTC
  Introduce a new compression & decompression PMD for hardware accelerators
based on UADK [1].

UADK is a framework for user applications to access hardware accelerators.
UADK relies on IOMMU SVA (Shared Virtual Address) feature, which shares
the same page table between IOMMU and MMU.
Thereby user application can directly use the virtual address for the
device DMA, which enhances the performance as well as easy usability.

This patch adds the basic framework.

Test:
sudo dpdk-test --vdev=compress_uadk
RTE>>compressdev_autotest
RTE>>quit

[1] https://github.com/Linaro/uadk

Signed-off-by: Zhangfei Gao <zhangfei.gao@linaro.org>
---
 MAINTAINERS                                   |  6 ++
 doc/guides/compressdevs/features/uadk.ini     | 11 +++
 doc/guides/compressdevs/index.rst             |  1 +
 doc/guides/compressdevs/uadk.rst              | 98 +++++++++++++++++++
 doc/guides/rel_notes/release_24_07.rst        |  5 +
 drivers/compress/meson.build                  |  1 +
 drivers/compress/uadk/meson.build             | 30 ++++++
 drivers/compress/uadk/uadk_compress_pmd.c     | 89 +++++++++++++++++
 .../compress/uadk/uadk_compress_pmd_private.h | 20 ++++
 9 files changed, 261 insertions(+)
 create mode 100644 doc/guides/compressdevs/features/uadk.ini
 create mode 100644 doc/guides/compressdevs/uadk.rst
 create mode 100644 drivers/compress/uadk/meson.build
 create mode 100644 drivers/compress/uadk/uadk_compress_pmd.c
 create mode 100644 drivers/compress/uadk/uadk_compress_pmd_private.h
  

Comments

Stephen Hemminger May 23, 2024, 4:20 p.m. UTC | #1
On Mon, 22 Apr 2024 14:31:00 +0000
Zhangfei Gao <zhangfei.gao@linaro.org> wrote:

> +static struct rte_compressdev_ops uadk_compress_pmd_ops = {
> +		.dev_configure		= NULL,
> +		.dev_start		= NULL,
> +		.dev_stop		= NULL,
> +		.dev_close		= NULL,
> +		.stats_get		= NULL,
> +		.stats_reset		= NULL,
> +		.dev_infos_get		= NULL,
> +		.queue_pair_setup	= NULL,
> +		.queue_pair_release	= NULL,
> +		.private_xform_create	= NULL,
> +		.private_xform_free	= NULL,
> +		.stream_create		= NULL,
> +		.stream_free		= NULL,
> +};

If you just used { } then all the elements are initialized to NULL anyway
  
Konstantin Ananyev May 23, 2024, 4:30 p.m. UTC | #2
> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Sent: Thursday, May 23, 2024 5:21 PM
> To: Zhangfei Gao <zhangfei.gao@linaro.org>
> Cc: Akhil Goyal <gakhil@marvell.com>; Fan Zhang <fanzhang.oss@gmail.com>; Ashish Gupta <ashish.gupta@marvell.com>;
> dev@dpdk.org
> Subject: Re: [PATCH 1/3] compress/uadk: Introduce UADK compression driver
> 
> On Mon, 22 Apr 2024 14:31:00 +0000
> Zhangfei Gao <zhangfei.gao@linaro.org> wrote:
> 
> > +static struct rte_compressdev_ops uadk_compress_pmd_ops = {
> > +		.dev_configure		= NULL,
> > +		.dev_start		= NULL,
> > +		.dev_stop		= NULL,
> > +		.dev_close		= NULL,
> > +		.stats_get		= NULL,
> > +		.stats_reset		= NULL,
> > +		.dev_infos_get		= NULL,
> > +		.queue_pair_setup	= NULL,
> > +		.queue_pair_release	= NULL,
> > +		.private_xform_create	= NULL,
> > +		.private_xform_free	= NULL,
> > +		.stream_create		= NULL,
> > +		.stream_free		= NULL,
> > +};
> 
> If you just used { } then all the elements are initialized to NULL anyway

Or even 
static struct rte_compressdev_ops uadk_compress_pmd_ops;
should do the same.
  
Tyler Retzlaff May 23, 2024, 4:42 p.m. UTC | #3
On Thu, May 23, 2024 at 04:30:30PM +0000, Konstantin Ananyev wrote:
> 
> 
> > -----Original Message-----
> > From: Stephen Hemminger <stephen@networkplumber.org>
> > Sent: Thursday, May 23, 2024 5:21 PM
> > To: Zhangfei Gao <zhangfei.gao@linaro.org>
> > Cc: Akhil Goyal <gakhil@marvell.com>; Fan Zhang <fanzhang.oss@gmail.com>; Ashish Gupta <ashish.gupta@marvell.com>;
> > dev@dpdk.org
> > Subject: Re: [PATCH 1/3] compress/uadk: Introduce UADK compression driver
> > 
> > On Mon, 22 Apr 2024 14:31:00 +0000
> > Zhangfei Gao <zhangfei.gao@linaro.org> wrote:
> > 
> > > +static struct rte_compressdev_ops uadk_compress_pmd_ops = {
> > > +		.dev_configure		= NULL,
> > > +		.dev_start		= NULL,
> > > +		.dev_stop		= NULL,
> > > +		.dev_close		= NULL,
> > > +		.stats_get		= NULL,
> > > +		.stats_reset		= NULL,
> > > +		.dev_infos_get		= NULL,
> > > +		.queue_pair_setup	= NULL,
> > > +		.queue_pair_release	= NULL,
> > > +		.private_xform_create	= NULL,
> > > +		.private_xform_free	= NULL,
> > > +		.stream_create		= NULL,
> > > +		.stream_free		= NULL,
> > > +};
> > 
> > If you just used { } then all the elements are initialized to NULL anyway
> 
> Or even 
> static struct rte_compressdev_ops uadk_compress_pmd_ops;
> should do the same.

+1

>
  
Zhangfei Gao May 24, 2024, 9:43 a.m. UTC | #4
On Fri, 24 May 2024 at 00:30, Konstantin Ananyev
<konstantin.ananyev@huawei.com> wrote:
>
>
>
> > -----Original Message-----
> > From: Stephen Hemminger <stephen@networkplumber.org>
> > Sent: Thursday, May 23, 2024 5:21 PM
> > To: Zhangfei Gao <zhangfei.gao@linaro.org>
> > Cc: Akhil Goyal <gakhil@marvell.com>; Fan Zhang <fanzhang.oss@gmail.com>; Ashish Gupta <ashish.gupta@marvell.com>;
> > dev@dpdk.org
> > Subject: Re: [PATCH 1/3] compress/uadk: Introduce UADK compression driver
> >
> > On Mon, 22 Apr 2024 14:31:00 +0000
> > Zhangfei Gao <zhangfei.gao@linaro.org> wrote:
> >
> > > +static struct rte_compressdev_ops uadk_compress_pmd_ops = {
> > > +           .dev_configure          = NULL,
> > > +           .dev_start              = NULL,
> > > +           .dev_stop               = NULL,
> > > +           .dev_close              = NULL,
> > > +           .stats_get              = NULL,
> > > +           .stats_reset            = NULL,
> > > +           .dev_infos_get          = NULL,
> > > +           .queue_pair_setup       = NULL,
> > > +           .queue_pair_release     = NULL,
> > > +           .private_xform_create   = NULL,
> > > +           .private_xform_free     = NULL,
> > > +           .stream_create          = NULL,
> > > +           .stream_free            = NULL,
> > > +};
> >
> > If you just used { } then all the elements are initialized to NULL anyway
>
> Or even
> static struct rte_compressdev_ops uadk_compress_pmd_ops;
> should do the same.

Yes, good idea
Thanks Konstantin
  

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index 7abb3aee49..4f1f640004 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1212,6 +1212,12 @@  F: drivers/compress/octeontx/
 F: doc/guides/compressdevs/octeontx.rst
 F: doc/guides/compressdevs/features/octeontx.ini
 
+HiSilicon UADK compress
+M: Zhangfei Gao <zhangfei.gao@linaro.org>
+F: drivers/compress/uadk/
+F: doc/guides/compressdevs/uadk.rst
+F: doc/guides/compressdevs/features/uadk.ini
+
 Intel QuickAssist
 M: Kai Ji <kai.ji@intel.com>
 F: drivers/compress/qat/
diff --git a/doc/guides/compressdevs/features/uadk.ini b/doc/guides/compressdevs/features/uadk.ini
new file mode 100644
index 0000000000..0bbdb6c5cf
--- /dev/null
+++ b/doc/guides/compressdevs/features/uadk.ini
@@ -0,0 +1,11 @@ 
+;
+; Refer to default.ini for the full list of available PMD features.
+;
+; Supported features of 'uadk' compression driver.
+;
+[Features]
+HW Accelerated = Y
+Deflate        = Y
+Crc32          = N
+Fixed          = Y
+Dynamic        = Y
diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst
index 849f211688..87ed4f72a4 100644
--- a/doc/guides/compressdevs/index.rst
+++ b/doc/guides/compressdevs/index.rst
@@ -15,4 +15,5 @@  Compression Device Drivers
     nitrox
     octeontx
     qat_comp
+    uadk
     zlib
diff --git a/doc/guides/compressdevs/uadk.rst b/doc/guides/compressdevs/uadk.rst
new file mode 100644
index 0000000000..7e7f9f2548
--- /dev/null
+++ b/doc/guides/compressdevs/uadk.rst
@@ -0,0 +1,98 @@ 
+.. SPDX-License-Identifier: BSD-3-Clause
+   Copyright 2024-2025 Huawei Technologies Co.,Ltd. All rights reserved.
+   Copyright 2024-2025 Linaro ltd.
+
+UADK Compression Poll Mode Driver
+=================================
+
+UADK compression PMD provides poll mode compression & decompression driver
+All compression operations are using UADK library compression API, which is
+algorithm-level API, abstracting accelerators' low-level implementations.
+
+UADK compression PMD relies on `UADK library <https://github.com/Linaro/uadk>`_.
+
+UADK is a framework for user applications to access hardware accelerators.
+UADK relies on IOMMU SVA (Shared Virtual Address) feature,
+which shares the same page table between IOMMU and MMU.
+As a result, the user application can directly use the virtual address for
+device DMA, which enhances performance as well as easy usability.
+
+
+Features
+--------
+
+UADK compression PMD has support for:
+
+Compression/Decompression algorithm:
+
+    * DEFLATE - using Fixed and Dynamic Huffman encoding
+
+Window size support:
+
+    * 32K
+
+
+Test steps
+----------
+
+#. Build UADK
+
+   .. code-block:: console
+
+      git clone https://github.com/Linaro/uadk.git
+      cd uadk
+      mkdir build
+      ./autogen.sh
+      ./configure --prefix=$PWD/build
+      make
+      make install
+
+   .. note::
+
+      Without ``--prefix``, UADK will be installed to ``/usr/local/lib`` by default.
+
+   .. note::
+
+      If get error: "cannot find -lnuma", please install the libnuma-dev.
+
+#. Run pkg-config libwd to ensure env is setup correctly
+
+   .. code-block:: console
+
+      export PKG_CONFIG_PATH=$PWD/build/lib/pkgconfig
+      pkg-config libwd --cflags --libs -I/usr/local/include -L/usr/local/lib -lwd
+
+   .. note::
+
+      export ``PKG_CONFIG_PATH`` is required on demand,
+      not needed if UADK is installed to ``/usr/local/lib``.
+
+#. Build DPDK
+
+   .. code-block:: console
+
+      cd dpdk
+      mkdir build
+      meson setup build (--reconfigure)
+      cd build
+      ninja
+      sudo ninja install
+
+#. Prepare hugepages for DPDK (see also :doc:`../tools/hugepages`)
+
+   .. code-block:: console
+
+      echo 1024 > /sys/devices/system/node/node0/hugepages/hugepages-2048kB/nr_hugepages
+      echo 1024 > /sys/devices/system/node/node1/hugepages/hugepages-2048kB/nr_hugepages
+      echo 1024 > /sys/devices/system/node/node2/hugepages/hugepages-2048kB/nr_hugepages
+      echo 1024 > /sys/devices/system/node/node3/hugepages/hugepages-2048kB/nr_hugepages
+      mkdir -p /mnt/huge_2mb
+      mount -t hugetlbfs none /mnt/huge_2mb -o pagesize=2MB
+
+#. Run test app
+
+   .. code-block:: console
+
+	sudo dpdk-test --vdev=compress_uadk
+	RTE>>compressdev_autotest
+	RTE>>quit
diff --git a/doc/guides/rel_notes/release_24_07.rst b/doc/guides/rel_notes/release_24_07.rst
index a69f24cf99..a7574045f0 100644
--- a/doc/guides/rel_notes/release_24_07.rst
+++ b/doc/guides/rel_notes/release_24_07.rst
@@ -24,6 +24,11 @@  DPDK Release 24.07
 New Features
 ------------
 
+* **Added UADK compress driver.**
+
+  Added a new compress driver for the UADK library. See the
+  :doc:`../compressdevs/uadk` guide for more details on this new driver.
+
 .. This section should contain new features added in this release.
    Sample format:
 
diff --git a/drivers/compress/meson.build b/drivers/compress/meson.build
index b91195b27d..91d7800a4a 100644
--- a/drivers/compress/meson.build
+++ b/drivers/compress/meson.build
@@ -10,6 +10,7 @@  drivers = [
         'mlx5',
         'nitrox',
         'octeontx',
+        'uadk',
         'zlib',
 ]
 
diff --git a/drivers/compress/uadk/meson.build b/drivers/compress/uadk/meson.build
new file mode 100644
index 0000000000..704833bbcf
--- /dev/null
+++ b/drivers/compress/uadk/meson.build
@@ -0,0 +1,30 @@ 
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright 2024-2025 Huawei Technologies Co.,Ltd. All rights reserved.
+# Copyright 2024-2025 Linaro ltd.
+
+if not is_linux
+    build = false
+    reason = 'only supported on Linux'
+    subdir_done()
+endif
+
+sources = files(
+        'uadk_compress_pmd.c',
+)
+
+deps += 'bus_vdev'
+dep = dependency('libwd_comp', required: false, method: 'pkg-config')
+if not dep.found()
+	build = false
+	reason = 'missing dependency, "libwd_comp"'
+else
+	ext_deps += dep
+endif
+
+dep = dependency('libwd', required: false, method: 'pkg-config')
+if not dep.found()
+    build = false
+    reason = 'missing dependency, "libwd"'
+else
+    ext_deps += dep
+endif
diff --git a/drivers/compress/uadk/uadk_compress_pmd.c b/drivers/compress/uadk/uadk_compress_pmd.c
new file mode 100644
index 0000000000..d73524ce84
--- /dev/null
+++ b/drivers/compress/uadk/uadk_compress_pmd.c
@@ -0,0 +1,89 @@ 
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2024-2025 Huawei Technologies Co.,Ltd. All rights reserved.
+ * Copyright 2024-2025 Linaro ltd.
+ */
+
+#include <bus_vdev_driver.h>
+#include <rte_compressdev_pmd.h>
+#include <rte_malloc.h>
+
+#include <uadk/wd_comp.h>
+#include <uadk/wd_sched.h>
+
+#include "uadk_compress_pmd_private.h"
+
+static struct rte_compressdev_ops uadk_compress_pmd_ops = {
+		.dev_configure		= NULL,
+		.dev_start		= NULL,
+		.dev_stop		= NULL,
+		.dev_close		= NULL,
+		.stats_get		= NULL,
+		.stats_reset		= NULL,
+		.dev_infos_get		= NULL,
+		.queue_pair_setup	= NULL,
+		.queue_pair_release	= NULL,
+		.private_xform_create	= NULL,
+		.private_xform_free	= NULL,
+		.stream_create		= NULL,
+		.stream_free		= NULL,
+};
+
+static int
+uadk_compress_probe(struct rte_vdev_device *vdev)
+{
+	struct rte_compressdev_pmd_init_params init_params = {
+		"",
+		rte_socket_id(),
+	};
+	struct rte_compressdev *compressdev;
+	struct uacce_dev *udev;
+	const char *name;
+
+	udev = wd_get_accel_dev("deflate");
+	if (!udev)
+		return -ENODEV;
+
+	name = rte_vdev_device_name(vdev);
+	if (name == NULL)
+		return -EINVAL;
+
+	compressdev = rte_compressdev_pmd_create(name, &vdev->device,
+			sizeof(struct uadk_compress_priv), &init_params);
+	if (compressdev == NULL) {
+		UADK_LOG(ERR, "driver %s: create failed", init_params.name);
+		return -ENODEV;
+	}
+
+	compressdev->dev_ops = &uadk_compress_pmd_ops;
+	compressdev->dequeue_burst = NULL;
+	compressdev->enqueue_burst = NULL;
+	compressdev->feature_flags = RTE_COMPDEV_FF_HW_ACCELERATED;
+
+	return 0;
+}
+
+static int
+uadk_compress_remove(struct rte_vdev_device *vdev)
+{
+	struct rte_compressdev *compressdev;
+	const char *name;
+
+	name = rte_vdev_device_name(vdev);
+	if (name == NULL)
+		return -EINVAL;
+
+	compressdev = rte_compressdev_pmd_get_named_dev(name);
+	if (compressdev == NULL)
+		return -ENODEV;
+
+	return rte_compressdev_pmd_destroy(compressdev);
+}
+
+static struct rte_vdev_driver uadk_compress_pmd = {
+	.probe = uadk_compress_probe,
+	.remove = uadk_compress_remove,
+};
+
+#define UADK_COMPRESS_DRIVER_NAME compress_uadk
+RTE_PMD_REGISTER_VDEV(UADK_COMPRESS_DRIVER_NAME, uadk_compress_pmd);
+RTE_LOG_REGISTER_DEFAULT(uadk_compress_logtype, INFO);
diff --git a/drivers/compress/uadk/uadk_compress_pmd_private.h b/drivers/compress/uadk/uadk_compress_pmd_private.h
new file mode 100644
index 0000000000..a96aea7c73
--- /dev/null
+++ b/drivers/compress/uadk/uadk_compress_pmd_private.h
@@ -0,0 +1,20 @@ 
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright 2024-2025 Huawei Technologies Co.,Ltd. All rights reserved.
+ * Copyright 2024-2025 Linaro ltd.
+ */
+
+#ifndef _UADK_COMPRESS_PMD_PRIVATE_H_
+#define _UADK_COMPRESS_PMD_PRIVATE_H_
+
+struct uadk_compress_priv {
+	struct rte_mempool *mp;
+};
+
+extern int uadk_compress_logtype;
+
+#define UADK_LOG(level, fmt, ...)  \
+	rte_log(RTE_LOG_ ## level, uadk_compress_logtype,  \
+		"%s() line %u: " fmt "\n", __func__, __LINE__,  \
+		## __VA_ARGS__)
+
+#endif /* _UADK_COMPRESS_PMD_PRIVATE_H_ */