From 218be0345961b79f42af2be76e72e2429f62001f Mon Sep 17 00:00:00 2001 From: Timothy McDaniel Date: Sun, 1 Nov 2020 17:29:53 -0600 Subject: [PATCH] event/dlb: add documentation and build infrastructure Note that config/rte_config.h contains several configuration switches, providing for fine control of the PMD's runtime behaviour. The meson infrastructure is expanded as additional files are added to this patchset. Adds announcement of availability of the new driver for Intel Dynamic Load Balancer 1.0 hardware. Signed-off-by: Timothy McDaniel Reviewed-by: Gage Eads --- MAINTAINERS | 5 ++++ config/rte_config.h | 6 +++++ doc/guides/eventdevs/dlb.rst | 36 ++++++++++++++++++++++++++ doc/guides/eventdevs/index.rst | 1 + doc/guides/rel_notes/release_20_11.rst | 5 ++++ drivers/event/dlb/meson.build | 15 +++++++++++ drivers/event/dlb/version.map | 3 +++ drivers/event/meson.build | 2 +- 8 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 doc/guides/eventdevs/dlb.rst create mode 100644 drivers/event/dlb/meson.build create mode 100644 drivers/event/dlb/version.map diff --git a/MAINTAINERS b/MAINTAINERS index c67fa74523..295a471f60 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1176,6 +1176,11 @@ Cavium OCTEON TX timvf M: Pavan Nikhilesh F: drivers/event/octeontx/timvf_* +Intel DLB +M: Timothy McDaniel +F: drivers/event/dlb/ +F: doc/guides/eventdevs/dlb.rst + Intel DLB2 M: Timothy McDaniel F: drivers/event/dlb2/ diff --git a/config/rte_config.h b/config/rte_config.h index 64aa333a09..25219f04af 100644 --- a/config/rte_config.h +++ b/config/rte_config.h @@ -135,6 +135,12 @@ /* QEDE PMD defines */ #define RTE_LIBRTE_QEDE_FW "" +/* DLB PMD defines */ +#define RTE_LIBRTE_PMD_DLB_POLL_INTERVAL 1000 +#define RTE_LIBRTE_PMD_DLB_UMWAIT_CTL_STATE 0 +#undef RTE_LIBRTE_PMD_DLB_QUELL_STATS +#define RTE_LIBRTE_PMD_DLB_SW_CREDIT_QUANTA 32 + /* DLB2 defines */ #define RTE_LIBRTE_PMD_DLB2_POLL_INTERVAL 1000 #define RTE_LIBRTE_PMD_DLB2_UMWAIT_CTL_STATE 0 diff --git a/doc/guides/eventdevs/dlb.rst b/doc/guides/eventdevs/dlb.rst new file mode 100644 index 0000000000..c71d22ae7d --- /dev/null +++ b/doc/guides/eventdevs/dlb.rst @@ -0,0 +1,36 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2020 Intel Corporation. + +Driver for the Intel® Dynamic Load Balancer (DLB) +================================================= + +The DPDK dlb poll mode driver supports the Intel® Dynamic Load Balancer. + +Prerequisites +------------- + +Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup +the basic DPDK environment. + +Configuration +------------- + +The DLB 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 DLB provides the functions of a DPDK event device; specifically, it +supports atomic, ordered, and parallel scheduling events from queues to ports. +However, the DLB hardware is not a perfect match to the eventdev API. Some DLB +features are abstracted by the PMD (e.g. directed ports), some are only +accessible as vdev command-line parameters, and certain eventdev features are +not supported (e.g. the event flow ID is not maintained during scheduling). + +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 DLB misalign. + diff --git a/doc/guides/eventdevs/index.rst b/doc/guides/eventdevs/index.rst index 738788d9e7..f5b69b39da 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: + dlb dlb2 dpaa dpaa2 diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst index e1b9cc1112..f1a6925678 100644 --- a/doc/guides/rel_notes/release_20_11.rst +++ b/doc/guides/rel_notes/release_20_11.rst @@ -295,6 +295,11 @@ New Features Added performance tuning arguments to allow tuning the scheduler for better throughtput in high core count use cases. +* **Added a new driver for the Intel Dynamic Load Balancer v1.0 device.** + + Added the new ``dlb`` eventdev driver for the Intel DLB V1.0 device. See the + :doc:`../eventdevs/dlb` eventdev guide for more details on this new driver. + * **Added a new driver for the Intel Dynamic Load Balancer v2.0 device.** Added the new ``dlb2`` eventdev driver for the Intel DLB V2.0 device. See the diff --git a/drivers/event/dlb/meson.build b/drivers/event/dlb/meson.build new file mode 100644 index 0000000000..68cb0aede3 --- /dev/null +++ b/drivers/event/dlb/meson.build @@ -0,0 +1,15 @@ +# 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( +) + +headers = files() + +deps += ['mbuf', 'mempool', 'ring', 'pci', 'bus_pci'] diff --git a/drivers/event/dlb/version.map b/drivers/event/dlb/version.map new file mode 100644 index 0000000000..4a76d1d52d --- /dev/null +++ b/drivers/event/dlb/version.map @@ -0,0 +1,3 @@ +DPDK_21 { + local: *; +}; diff --git a/drivers/event/meson.build b/drivers/event/meson.build index c433c10c6a..c1a6990a04 100644 --- a/drivers/event/meson.build +++ b/drivers/event/meson.build @@ -5,7 +5,7 @@ if is_windows subdir_done() endif -drivers = ['dlb2', 'dpaa', 'dpaa2', 'octeontx2', 'opdl', 'skeleton', 'sw', +drivers = ['dlb', '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')) -- 2.20.1