[v3,01/23] event/dlb2: add documentation and meson build infrastructure
diff mbox series

Message ID 1603477826-31374-2-git-send-email-timothy.mcdaniel@intel.com
State Superseded
Delegated to: Jerin Jacob
Headers show
Series
  • Add DLB2 PMD
Related show

Checks

Context Check Description
ci/Performance-Testing fail build patch failure
ci/checkpatch warning coding style issues

Commit Message

Timothy McDaniel Oct. 23, 2020, 6:30 p.m. UTC
Adds the meson build infrastructure, which includes
compile-time constants in rte_config.h. DLB2 is
only supported on Linux X86 platforms at this time.

Signed-off-by: Timothy McDaniel <timothy.mcdaniel@intel.com>
Reviewed-by: Gage Eads <gage.eads@intel.com>
---
 MAINTAINERS                                       |  5 +++
 config/rte_config.h                               |  7 ++++
 doc/guides/eventdevs/dlb2.rst                     | 40 +++++++++++++++++++++++
 doc/guides/eventdevs/index.rst                    |  1 +
 drivers/event/dlb2/meson.build                    | 13 ++++++++
 drivers/event/dlb2/rte_pmd_dlb2_event_version.map |  3 ++
 drivers/event/meson.build                         |  3 +-
 7 files changed, 71 insertions(+), 1 deletion(-)
 create mode 100644 doc/guides/eventdevs/dlb2.rst
 create mode 100644 drivers/event/dlb2/meson.build
 create mode 100644 drivers/event/dlb2/rte_pmd_dlb2_event_version.map

Comments

Jerin Jacob Oct. 24, 2020, 12:58 p.m. UTC | #1
On Fri, Oct 23, 2020 at 11:59 PM Timothy McDaniel
<timothy.mcdaniel@intel.com> wrote:
>
> Adds the meson build infrastructure, which includes
> compile-time constants in rte_config.h. DLB2 is
> only supported on Linux X86 platforms at this time.
>
> Signed-off-by: Timothy McDaniel <timothy.mcdaniel@intel.com>
> Reviewed-by: Gage Eads <gage.eads@intel.com>

There is the following build error[1] with this patch when testing
with the latest dpdk-next-eventdev branch.

Timothy, Please check ./devtools/test-meson-builds.sh for each patch
before sending the next version of DLB and DLB2 to avoid delay in
pulling this series.


[1]
Message: Disabling mlx5 [drivers/vdpa/mlx5]: missing internal
dependency "common_mlx5"
drivers/meson.build:179: WARNING: Custom target input
'/export/dpdk-next-eventdev/drivers/event/dlb2/version.map' can't be
converted to File object(s).
This will become a hard error in the future.
drivers/meson.build:184: WARNING: Custom target input
'/export/dpdk-next-eventdev/drivers/event/dlb2/version.map' can't be
converted to File object(s).
This will become a hard error in the future.

drivers/meson.build:207:3: ERROR: File
/export/dpdk-next-eventdev/drivers/event/dlb2/version.map does not
exist.


> ---
>  MAINTAINERS                                       |  5 +++
>  config/rte_config.h                               |  7 ++++
>  doc/guides/eventdevs/dlb2.rst                     | 40 +++++++++++++++++++++++
>  doc/guides/eventdevs/index.rst                    |  1 +
>  drivers/event/dlb2/meson.build                    | 13 ++++++++
>  drivers/event/dlb2/rte_pmd_dlb2_event_version.map |  3 ++
>  drivers/event/meson.build                         |  3 +-
>  7 files changed, 71 insertions(+), 1 deletion(-)
>  create mode 100644 doc/guides/eventdevs/dlb2.rst
>  create mode 100644 drivers/event/dlb2/meson.build
>  create mode 100644 drivers/event/dlb2/rte_pmd_dlb2_event_version.map
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 3b16d7a..f732f28 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1188,6 +1188,11 @@ M: Peter Mccarthy <peter.mccarthy@intel.com>
>  F: drivers/event/opdl/
>  F: doc/guides/eventdevs/opdl.rst
>
> +Intel DLB2 Eventdev PMD
> +M: Timothy McDaniel <timothy.mcdaniel@intel.com>
> +F: drivers/event/dlb2/
> +F: doc/guides/eventdevs/dlb2.rst
> +
>
>  Rawdev Drivers
>  --------------
> diff --git a/config/rte_config.h b/config/rte_config.h
> index 0bae630..fd1b3c3 100644
> --- a/config/rte_config.h
> +++ b/config/rte_config.h
> @@ -131,4 +131,11 @@
>  /* QEDE PMD defines */
>  #define RTE_LIBRTE_QEDE_FW ""
>
> +/* DLB2 defines */
> +#define RTE_LIBRTE_PMD_DLB2_POLL_INTERVAL 1000
> +#define RTE_LIBRTE_PMD_DLB2_UMWAIT_CTL_STATE  0
> +#undef RTE_LIBRTE_PMD_DLB2_QUELL_STATS
> +#define RTE_LIBRTE_PMD_DLB2_SW_CREDIT_QUANTA 32
> +#define RTE_PMD_DLB2_DEFAULT_DEPTH_THRESH 256
> +
>  #endif /* _RTE_CONFIG_H_ */
> diff --git a/doc/guides/eventdevs/dlb2.rst b/doc/guides/eventdevs/dlb2.rst
> new file mode 100644
> index 0000000..e3091c9
> --- /dev/null
> +++ b/doc/guides/eventdevs/dlb2.rst
> @@ -0,0 +1,40 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2020 Intel Corporation.
> +
> +Driver for the Intel® Dynamic Load Balancer (DLB2)
> +==================================================
> +
> +The DPDK dlb poll mode driver supports the Intel® Dynamic Load Balancer.
> +
> +Prerequisites
> +-------------
> +
> +Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
> +the basic DPDK environment.
> +
> +Configuration
> +-------------
> +
> +The DLB2 PF PMD is a user-space PMD that uses VFIO to gain direct
> +device access. To use this operation mode, the PCIe PF device must be bound
> +to a DPDK-compatible VFIO driver, such as vfio-pci.
> +
> +Eventdev API Notes
> +------------------
> +
> +The DLB2 provides the functions of a DPDK event device; specifically, it
> +supports atomic, ordered, and parallel scheduling events from queues to ports.
> +However, the DLB2 hardware is not a perfect match to the eventdev API. Some DLB2
> +features are abstracted by the PMD such as directed ports.
> +
> +In general the dlb PMD is designed for ease-of-use and does not require a
> +detailed understanding of the hardware, but these details are important when
> +writing high-performance code. This section describes the places where the
> +eventdev API and DLB2 misalign.
> +
> +Flow ID
> +~~~~~~~
> +
> +The flow ID field is preserved in the event when it is scheduled in the
> +DLB2.
> +
> diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst
> index bb66a5e..738788d 100644
> --- a/doc/guides/eventdevs/index.rst
> +++ b/doc/guides/eventdevs/index.rst
> @@ -11,6 +11,7 @@ application through the eventdev API.
>      :maxdepth: 2
>      :numbered:
>
> +    dlb2
>      dpaa
>      dpaa2
>      dsw
> diff --git a/drivers/event/dlb2/meson.build b/drivers/event/dlb2/meson.build
> new file mode 100644
> index 0000000..5324043
> --- /dev/null
> +++ b/drivers/event/dlb2/meson.build
> @@ -0,0 +1,13 @@
> +# SPDX-License-Identifier: BSD-3-Clause
> +# Copyright(c) 2019-2020 Intel Corporation
> +
> +if not is_linux or not dpdk_conf.has('RTE_ARCH_X86_64')
> +        build = false
> +        reason = 'only supported on ARCH_X86_64 Linux'
> +        subdir_done()
> +endif
> +
> +sources = files(
> +)
> +
> +deps += ['mbuf', 'mempool', 'ring', 'pci', 'bus_pci']
> diff --git a/drivers/event/dlb2/rte_pmd_dlb2_event_version.map b/drivers/event/dlb2/rte_pmd_dlb2_event_version.map
> new file mode 100644
> index 0000000..4a76d1d
> --- /dev/null
> +++ b/drivers/event/dlb2/rte_pmd_dlb2_event_version.map
> @@ -0,0 +1,3 @@
> +DPDK_21 {
> +       local: *;
> +};
> diff --git a/drivers/event/meson.build b/drivers/event/meson.build
> index ebe76a7..1a54de4 100644
> --- a/drivers/event/meson.build
> +++ b/drivers/event/meson.build
> @@ -5,7 +5,8 @@ if is_windows
>         subdir_done()
>  endif
>
> -drivers = ['dpaa', 'dpaa2', 'octeontx2', 'opdl', 'skeleton', 'sw', 'dsw']
> +drivers = ['dlb2', 'dpaa', 'dpaa2', 'octeontx2', 'opdl', 'skeleton', 'sw',
> +          'dsw']
>  if not (toolchain == 'gcc' and cc.version().version_compare('<4.8.6') and
>         dpdk_conf.has('RTE_ARCH_ARM64'))
>         drivers += 'octeontx'
> --
> 2.6.4
>

Patch
diff mbox series

diff --git a/MAINTAINERS b/MAINTAINERS
index 3b16d7a..f732f28 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1188,6 +1188,11 @@  M: Peter Mccarthy <peter.mccarthy@intel.com>
 F: drivers/event/opdl/
 F: doc/guides/eventdevs/opdl.rst
 
+Intel DLB2 Eventdev PMD
+M: Timothy McDaniel <timothy.mcdaniel@intel.com>
+F: drivers/event/dlb2/
+F: doc/guides/eventdevs/dlb2.rst
+
 
 Rawdev Drivers
 --------------
diff --git a/config/rte_config.h b/config/rte_config.h
index 0bae630..fd1b3c3 100644
--- a/config/rte_config.h
+++ b/config/rte_config.h
@@ -131,4 +131,11 @@ 
 /* QEDE PMD defines */
 #define RTE_LIBRTE_QEDE_FW ""
 
+/* DLB2 defines */
+#define RTE_LIBRTE_PMD_DLB2_POLL_INTERVAL 1000
+#define RTE_LIBRTE_PMD_DLB2_UMWAIT_CTL_STATE  0
+#undef RTE_LIBRTE_PMD_DLB2_QUELL_STATS
+#define RTE_LIBRTE_PMD_DLB2_SW_CREDIT_QUANTA 32
+#define RTE_PMD_DLB2_DEFAULT_DEPTH_THRESH 256
+
 #endif /* _RTE_CONFIG_H_ */
diff --git a/doc/guides/eventdevs/dlb2.rst b/doc/guides/eventdevs/dlb2.rst
new file mode 100644
index 0000000..e3091c9
--- /dev/null
+++ b/doc/guides/eventdevs/dlb2.rst
@@ -0,0 +1,40 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2020 Intel Corporation.
+
+Driver for the Intel® Dynamic Load Balancer (DLB2)
+==================================================
+
+The DPDK dlb poll mode driver supports the Intel® Dynamic Load Balancer.
+
+Prerequisites
+-------------
+
+Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
+the basic DPDK environment.
+
+Configuration
+-------------
+
+The DLB2 PF PMD is a user-space PMD that uses VFIO to gain direct
+device access. To use this operation mode, the PCIe PF device must be bound
+to a DPDK-compatible VFIO driver, such as vfio-pci.
+
+Eventdev API Notes
+------------------
+
+The DLB2 provides the functions of a DPDK event device; specifically, it
+supports atomic, ordered, and parallel scheduling events from queues to ports.
+However, the DLB2 hardware is not a perfect match to the eventdev API. Some DLB2
+features are abstracted by the PMD such as directed ports.
+
+In general the dlb PMD is designed for ease-of-use and does not require a
+detailed understanding of the hardware, but these details are important when
+writing high-performance code. This section describes the places where the
+eventdev API and DLB2 misalign.
+
+Flow ID
+~~~~~~~
+
+The flow ID field is preserved in the event when it is scheduled in the
+DLB2.
+
diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst
index bb66a5e..738788d 100644
--- a/doc/guides/eventdevs/index.rst
+++ b/doc/guides/eventdevs/index.rst
@@ -11,6 +11,7 @@  application through the eventdev API.
     :maxdepth: 2
     :numbered:
 
+    dlb2
     dpaa
     dpaa2
     dsw
diff --git a/drivers/event/dlb2/meson.build b/drivers/event/dlb2/meson.build
new file mode 100644
index 0000000..5324043
--- /dev/null
+++ b/drivers/event/dlb2/meson.build
@@ -0,0 +1,13 @@ 
+# SPDX-License-Identifier: BSD-3-Clause
+# Copyright(c) 2019-2020 Intel Corporation
+
+if not is_linux or not dpdk_conf.has('RTE_ARCH_X86_64')
+        build = false
+        reason = 'only supported on ARCH_X86_64 Linux'
+        subdir_done()
+endif
+
+sources = files(
+)
+
+deps += ['mbuf', 'mempool', 'ring', 'pci', 'bus_pci']
diff --git a/drivers/event/dlb2/rte_pmd_dlb2_event_version.map b/drivers/event/dlb2/rte_pmd_dlb2_event_version.map
new file mode 100644
index 0000000..4a76d1d
--- /dev/null
+++ b/drivers/event/dlb2/rte_pmd_dlb2_event_version.map
@@ -0,0 +1,3 @@ 
+DPDK_21 {
+	local: *;
+};
diff --git a/drivers/event/meson.build b/drivers/event/meson.build
index ebe76a7..1a54de4 100644
--- a/drivers/event/meson.build
+++ b/drivers/event/meson.build
@@ -5,7 +5,8 @@  if is_windows
 	subdir_done()
 endif
 
-drivers = ['dpaa', 'dpaa2', 'octeontx2', 'opdl', 'skeleton', 'sw', 'dsw']
+drivers = ['dlb2', 'dpaa', 'dpaa2', 'octeontx2', 'opdl', 'skeleton', 'sw',
+	   'dsw']
 if not (toolchain == 'gcc' and cc.version().version_compare('<4.8.6') and
 	dpdk_conf.has('RTE_ARCH_ARM64'))
 	drivers += 'octeontx'