Skip to contentSkip to conversation

ethdev: support congestion management

RFC PATCH In review [email protected] 10 participants 20 messages May 30, 2022 – Oct 4, 2022 Arm/Amlogic Meson SoC support

lore
Share & tools
lore
#0 lore raw

RFC PATCH 1/1 ethdev: support congestion management

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

---
 doc/guides/nics/features.rst         |  12 +++
 doc/guides/nics/features/default.ini |   1 +
 lib/eal/include/meson.build          |   1 +
 lib/eal/include/rte_cman.h           |  51 ++++++++++
 lib/ethdev/rte_ethdev.h              | 145 +++++++++++++++++++++++++++
 5 files changed, 210 insertions(+)
 create mode 100644 lib/eal/include/rte_cman.h
doc/guides/nics/features.rst +12 -0
index 21bedb743f..ffcc2bcc92 100644
@@ -727,6 +727,18 @@ Supports configuring per-queue stat counter mapping.
   ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 
 
+.. _nic_features_congestion_management
+
+Congestion management
+---------------------
+
+Supports congestion management.
+
+* **[implements] eth_dev_ops**: ``cman_info_get``, ``cman_config_set``, ``cman_config_get``.
+* **[related]    API**: ``rte_eth_cman_info_get()``, ``rte_eth_cman_config_init()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
+
+
 .. _nic_features_fw_version:
 
 FW version
doc/guides/nics/features/default.ini +1 -0
index b1d18ac62c..060497e41f 100644
@@ -60,6 +60,7 @@ Tx descriptor status =
 Basic stats          =
 Extended stats       =
 Stats per queue      =
+Congestion management =
 FW version           =
 EEPROM dump          =
 Module EEPROM dump   =
lib/eal/include/meson.build +1 -0
index 9700494816..40e31e0e6d 100644
@@ -10,6 +10,7 @@ headers += files(
         'rte_branch_prediction.h',
         'rte_bus.h',
         'rte_class.h',
+        'rte_cman.h',
         'rte_common.h',
         'rte_compat.h',
         'rte_debug.h',
lib/eal/include/rte_cman.h new file +51 -0

51 lines not on this page · raw message

lib/ethdev/rte_ethdev.h +145 -0

157 lines not on this page · raw message

Signature · 1 line
2.36.1
#1 lore raw
Quoted 20 lines · On Mon, May 30, 2022 at 6:16 AM <[email protected]> wrote:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Quoted 8 lines

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

Can you also add How all this helps an application? Thanks

Quoted 282 lines
---
 doc/guides/nics/features.rst         |  12 +++
 doc/guides/nics/features/default.ini |   1 +
 lib/eal/include/meson.build          |   1 +
 lib/eal/include/rte_cman.h           |  51 ++++++++++
 lib/ethdev/rte_ethdev.h              | 145 +++++++++++++++++++++++++++
 5 files changed, 210 insertions(+)
 create mode 100644 lib/eal/include/rte_cman.h
doc/guides/nics/features.rst +12 -0
index 21bedb743f..ffcc2bcc92 100644
@@ -727,6 +727,18 @@ Supports configuring per-queue stat counter mapping.
   ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 
 
+.. _nic_features_congestion_management
+
+Congestion management
+---------------------
+
+Supports congestion management.
+
+* **[implements] eth_dev_ops**: ``cman_info_get``, ``cman_config_set``, ``cman_config_get``.
+* **[related]    API**: ``rte_eth_cman_info_get()``, ``rte_eth_cman_config_init()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
+
+
 .. _nic_features_fw_version:
 
 FW version
doc/guides/nics/features/default.ini +1 -0
index b1d18ac62c..060497e41f 100644
@@ -60,6 +60,7 @@ Tx descriptor status =
 Basic stats          =
 Extended stats       =
 Stats per queue      =
+Congestion management =
 FW version           =
 EEPROM dump          =
 Module EEPROM dump   =
lib/eal/include/meson.build +1 -0
index 9700494816..40e31e0e6d 100644
@@ -10,6 +10,7 @@ headers += files(
         'rte_branch_prediction.h',
         'rte_bus.h',
         'rte_class.h',
+        'rte_cman.h',
         'rte_common.h',
         'rte_compat.h',
         'rte_debug.h',
lib/eal/include/rte_cman.h new file +51 -0
new file mode 100644
index 0000000000..e6dad2ebf7
@@ -0,0 +1,51 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2022 Marvell International Ltd.
+ */
+
+#ifndef RTE_CMAN_H
+#define RTE_CMAN_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <rte_bitops.h>
+
+/**
+ * @file
+ * Congestion management related parameters for DPDK.
+ */
+
+/** Congestion management modes */
+enum rte_cman_mode {
+       /** Congestion based on Random Early Detection.
+        *
+        * https://en.wikipedia.org/wiki/Random_early_detection
+        * @see struct rte_cman_red_params
+        */
+       RTE_CMAN_RED = RTE_BIT64(0),
+};
+
+/**
+ * RED based congestion management configuration parameters.
+ */
+struct rte_cman_red_params {
+       /**< Minimum threshold (min_th) value
+        *
+        * Value expressed as percentage. Value must be in 0 to 100(inclusive).
+        */
+       uint8_t min_th;
+       /**< Maximum threshold (max_th) value
+        *
+        * Value expressed as percentage. Value must be in 0 to 100(inclusive).
+        */
+       uint8_t max_th;
+       /** Inverse of packet marking probability maximum value (maxp = 1 / maxp_inv) */
+       uint16_t maxp_inv;
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* RTE_CMAN_H */
lib/ethdev/rte_ethdev.h +145 -1
index 04cff8ee10..7c8718bb2e 100644
@@ -160,6 +160,7 @@ extern "C" {
 #define RTE_ETHDEV_DEBUG_TX
 #endif
 
+#include <rte_cman.h>
 #include <rte_compat.h>
 #include <rte_log.h>
 #include <rte_interrupts.h>
@@ -5452,6 +5453,150 @@ typedef struct {
 __rte_experimental
 int rte_eth_dev_priv_dump(uint16_t port_id, FILE *file);
 
+/* Congestion management */
+
+/** Enumerate list of ethdev congestion management objects */
+enum rte_eth_cman_obj {
+       /** Congestion management based on Rx queue depth */
+       RTE_ETH_CMAN_OBJ_RX_QUEUE = RTE_BIT64(0),
+       /** Congestion management based on mempool depth associated with Rx queue
+        * @see rte_eth_rx_queue_setup()
+        */
+       RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL = RTE_BIT64(1),
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * A structure used to retrieve information of ethdev congestion management.
+ */
+struct rte_eth_cman_info {
+       /** Set of supported congestion management modes
+        * @see enum rte_cman_mode
+        */
+       uint64_t modes_supported;
+       /** Set of supported congestion management objects
+        * @see enum rte_eth_cman_obj
+        */
+       uint64_t objs_supported;
+       /** Reserved for future fields */
+       uint8_t rsvd[64];
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * A structure used to configure the ethdev congestion management.
+ */
+struct rte_eth_cman_config {
+       /** Congestion management object */
+       enum rte_eth_cman_obj obj;
+       /** Congestion management mode */
+       enum rte_cman_mode mode;
+       union {
+               /** Rx queue to configure congestion management.
+                *
+                * Valid when object is RTE_ETH_CMAN_OBJ_RX_QUEUE or
+                * RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL.
+                */
+               uint16_t rx_queue;
+               /** Reserved for future fields */
+               uint8_t rsvd_obj_params[16];
+       } obj_param;
+       union {
+               /** RED configuration parameters.
+                *
+                * Valid when mode is RTE_CMAN_RED.
+                */
+               struct rte_cman_red_params red;
+               /** Reserved for future fields */
+               uint8_t rsvd_mode_params[64];
+       } mode_param;
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Retrieve the information for ethdev congestion management
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param info
+ *   A pointer to a structure of type *rte_eth_cman_info* to be filled with
+ *   the information about congestion management.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if support for cman_info_get does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_info_get(uint16_t port_id, struct rte_eth_cman_info *info);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Initialize the ethdev congestion management configuration structure with default values.
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param config
+ *   A pointer to a structure of type *rte_eth_cman_config* to be initialized
+ *   with default value.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_config_init(uint16_t port_id, struct rte_eth_cman_config *config);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Configure ethdev congestion management
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param config
+ *   A pointer to a structure of type *rte_eth_cman_config* to be configured.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if support for cman_config_set does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_config_set(uint16_t port_id, struct rte_eth_cman_config *config);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Retrieve the applied ethdev congestion management parameters for the given port.
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param config
+ *   A pointer to a structure of type *rte_eth_cman_config* to retrieve
+ *   congestion management parameters for the given object.
+ *   Application must fill all parameters except mode_param parameter in
+ *   struct rte_eth_cman_config.
+ *
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if support for cman_config_get does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_config_get(uint16_t port_id, struct rte_eth_cman_config *config);
+
 #include <rte_ethdev_core.h>
 
 /**
--

2.36.1

#2 lore raw
Quoted 25 lines · Ajit Khaparde
Quoted 23 lines · On Mon, May 30, 2022 at 6:16 AM <[email protected]> wrote:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Quoted 7 lines
Quoted 5 lines

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

Can you also add How all this helps an application? Thanks

Random early detection (RED), also known as random early discard or random early drop is a queuing discipline for a network scheduler suited for congestion avoidance.

In the conventional tail drop algorithm, a router or other network component buffers as many packets as it can, and simply drops the ones it cannot buffer. If buffers are constantly full, the network is congested. Tail drop distributes buffer space unfairly among traffic flows. Tail drop can also lead to TCP global synchronization as all TCP connections "hold back" simultaneously, and then step forward simultaneously. Networks become under-utilized and flooded—alternately, in waves.

RED addresses these issues by pre-emptively dropping packets before the buffer becomes completely full. It uses predictive models to decide which packets to drop.

it is copied from https://en.wikipedia.org/wiki/Random_early_detection
page. I have kept this URL under enum rte_cman_mode:: RTE_CMAN_RED too.
Also I will add original specification URL too,
http://www.aciri.org/floyd/papers/red/red.html.

#3 lore raw
In reply to [email protected]

Hi, jerinj,

Quoted 163 lines · 在 2022/5/30 21:15, [email protected] 写道:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

---
  doc/guides/nics/features.rst         |  12 +++
  doc/guides/nics/features/default.ini |   1 +
  lib/eal/include/meson.build          |   1 +
  lib/eal/include/rte_cman.h           |  51 ++++++++++
  lib/ethdev/rte_ethdev.h              | 145 +++++++++++++++++++++++++++
  5 files changed, 210 insertions(+)

create mode 100644 lib/eal/include/rte_cman.h

doc/guides/nics/features.rst +12 -0
index 21bedb743f..ffcc2bcc92 100644
@@ -727,6 +727,18 @@ Supports configuring per-queue stat counter mapping.
    ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 
 
+.. _nic_features_congestion_management
+
+Congestion management
+---------------------
+
+Supports congestion management.
+
+* **[implements] eth_dev_ops**: ``cman_info_get``, ``cman_config_set``, ``cman_config_get``.
+* **[related]    API**: ``rte_eth_cman_info_get()``, ``rte_eth_cman_config_init()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
+
+
  .. _nic_features_fw_version:
 
  FW version
doc/guides/nics/features/default.ini +1 -0
index b1d18ac62c..060497e41f 100644
@@ -60,6 +60,7 @@ Tx descriptor status =
  Basic stats          =
  Extended stats       =
  Stats per queue      =
+Congestion management =
  FW version           =
  EEPROM dump          =
  Module EEPROM dump   =
lib/eal/include/meson.build +1 -0
index 9700494816..40e31e0e6d 100644
@@ -10,6 +10,7 @@ headers += files(
          'rte_branch_prediction.h',
          'rte_bus.h',
          'rte_class.h',
+        'rte_cman.h',
          'rte_common.h',
          'rte_compat.h',
          'rte_debug.h',
lib/eal/include/rte_cman.h new file +51 -0
new file mode 100644
index 0000000000..e6dad2ebf7
@@ -0,0 +1,51 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2022 Marvell International Ltd.
+ */
+
+#ifndef RTE_CMAN_H
+#define RTE_CMAN_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <rte_bitops.h>
+
+/**
+ * @file
+ * Congestion management related parameters for DPDK.
+ */
+
+/** Congestion management modes */
+enum rte_cman_mode {
+	/** Congestion based on Random Early Detection.
+	 *
+	 * https://en.wikipedia.org/wiki/Random_early_detection
+	 * @see struct rte_cman_red_params
+	 */
+	RTE_CMAN_RED = RTE_BIT64(0),
+};
+
+/**
+ * RED based congestion management configuration parameters.
+ */
+struct rte_cman_red_params {
+	/**< Minimum threshold (min_th) value
+	 *
+	 * Value expressed as percentage. Value must be in 0 to 100(inclusive).
+	 */
+	uint8_t min_th;
+	/**< Maximum threshold (max_th) value
+	 *
+	 * Value expressed as percentage. Value must be in 0 to 100(inclusive).
+	 */
+	uint8_t max_th;
+	/** Inverse of packet marking probability maximum value (maxp = 1 / maxp_inv) */
+	uint16_t maxp_inv;
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* RTE_CMAN_H */
lib/ethdev/rte_ethdev.h +6 -0
index 04cff8ee10..7c8718bb2e 100644
@@ -160,6 +160,7 @@ extern "C" {
  #define RTE_ETHDEV_DEBUG_TX
  #endif
 
+#include <rte_cman.h>
  #include <rte_compat.h>
  #include <rte_log.h>
  #include <rte_interrupts.h>
@@ -5452,6 +5453,150 @@ typedef struct {
  __rte_experimental
  int rte_eth_dev_priv_dump(uint16_t port_id, FILE *file);
 
+/* Congestion management */
+
+/** Enumerate list of ethdev congestion management objects */
+enum rte_eth_cman_obj {
+	/** Congestion management based on Rx queue depth */

lib/ethdev/rte_ethdev.h typedef struct { · line 5470

Quoted 10 lines
lib/ethdev/rte_ethdev.h +10 -0
+	RTE_ETH_CMAN_OBJ_RX_QUEUE = RTE_BIT64(0),
+	/** Congestion management based on mempool depth associated with Rx queue
+	 * @see rte_eth_rx_queue_setup()
+	 */
+	RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL = RTE_BIT64(1),
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice

'API' --> 'structure'

Quoted 9 lines
lib/ethdev/rte_ethdev.h +9 -0
+ *
+ * A structure used to retrieve information of ethdev congestion management.
+ */
+struct rte_eth_cman_info {
+	/** Set of supported congestion management modes
+	 * @see enum rte_cman_mode
+	 */
+	uint64_t modes_supported;
+	/** Set of supported congestion management objects

lib/ethdev/rte_ethdev.h typedef struct { · line 5489

Quoted 10 lines
lib/ethdev/rte_ethdev.h +10 -0
+	 * @see enum rte_eth_cman_obj
+	 */
+	uint64_t objs_supported;
+	/** Reserved for future fields */
+	uint8_t rsvd[64];
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice

'API' --> 'structure'

Quoted 114 lines
lib/ethdev/rte_ethdev.h +110 -0
+ *
+ * A structure used to configure the ethdev congestion management.
+ */
+struct rte_eth_cman_config {
+	/** Congestion management object */
+	enum rte_eth_cman_obj obj;
+	/** Congestion management mode */
+	enum rte_cman_mode mode;
+	union {
+		/** Rx queue to configure congestion management.
+		 *
+		 * Valid when object is RTE_ETH_CMAN_OBJ_RX_QUEUE or
+		 * RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL.
+		 */
+		uint16_t rx_queue;
+		/** Reserved for future fields */
+		uint8_t rsvd_obj_params[16];
+	} obj_param;
+	union {
+		/** RED configuration parameters.
+		 *
+		 * Valid when mode is RTE_CMAN_RED.
+		 */
+		struct rte_cman_red_params red;
+		/** Reserved for future fields */
+		uint8_t rsvd_mode_params[64];
+	} mode_param;
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Retrieve the information for ethdev congestion management
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param info
+ *   A pointer to a structure of type *rte_eth_cman_info* to be filled with
+ *   the information about congestion management.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if support for cman_info_get does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_info_get(uint16_t port_id, struct rte_eth_cman_info *info);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Initialize the ethdev congestion management configuration structure with default values.
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param config
+ *   A pointer to a structure of type *rte_eth_cman_config* to be initialized
+ *   with default value.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_config_init(uint16_t port_id, struct rte_eth_cman_config *config);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Configure ethdev congestion management
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param config
+ *   A pointer to a structure of type *rte_eth_cman_config* to be configured.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if support for cman_config_set does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_config_set(uint16_t port_id, struct rte_eth_cman_config *config);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Retrieve the applied ethdev congestion management parameters for the given port.
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param config
+ *   A pointer to a structure of type *rte_eth_cman_config* to retrieve
+ *   congestion management parameters for the given object.
+ *   Application must fill all parameters except mode_param parameter in
+ *   struct rte_eth_cman_config.
+ *
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if support for cman_config_get does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_config_get(uint16_t port_id, struct rte_eth_cman_config *config);
+
  #include <rte_ethdev_core.h>
 
  /**
#4 lore raw
Quoted 2 lines · Min Hu (Connor)

Hi, jerinj,

HI Min Hu,

Quoted 4 lines
Quoted 3 lines

+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice

'API' --> 'structure'

Will fix it in v1. Thanks

Quoted 12 lines
Quoted 12 lines

+ *
+ * A structure used to retrieve information of ethdev congestion management.
+ */

lib/ethdev/rte_ethdev.h +9 -0
+struct rte_eth_cman_info {
+     /** Set of supported congestion management modes
+      * @see enum rte_cman_mode
+      */
+     uint64_t modes_supported;
+     /** Set of supported congestion management objects
+      * @see enum rte_eth_cman_obj
+      */
+     uint64_t objs_supported;
Quoted 8 lines

lib/ethdev/rte_ethdev.h typedef struct { · line 5489

Quoted 7 lines
lib/ethdev/rte_ethdev.h +7 -0
+     /** Reserved for future fields */
+     uint8_t rsvd[64];
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice

'API' --> 'structure'

Will fix it in v1. Thanks

#5 lore raw
In reply to [email protected]
Quoted 22 lines · On Mon, 30 May 2022 18:45:26 +0530 <[email protected]> wrote:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Quoted 7 lines

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

The concept of supporting hardware queue management is good, but would like to make some suggestions:

The hardware support of QOS should ideally be part of the existing DPDK traffic management. For example, in Linux there are devices that can offload traffic control (TC) to hardware and this is done via flags to existing software infrastructure.

Your implementation makes HW and SW QoS diverge. This will require each application to get even more dependent on a particular hardware device.

Which brings up the bigger picture problem. Don't want to repeat the problems with rte_flow here. Any hardware support needs to have a matching set of software implementation, and test cases. The problem with rte_flow is the semantics are poorly defined and each vendor does it differently; and the SW flow classifier is incomplete and does not match what the HW does.

In an ideal world, there would be:
- an abstract API for defining ingress and egress queue management
- a software implementation of that API
- multiple hardware implementations
- ability to transparently use both SW and HW queue management from application
- complete test suite for that API.

Yes, that is asking a lot. But as trailblazer in this area, you have to do the hard work.

#6 lore raw
Quoted 45 lines · Stephen Hemminger
Quoted 22 lines · On Mon, 30 May 2022 18:45:26 +0530 <[email protected]> wrote:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Quoted 7 lines

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

The concept of supporting hardware queue management is good, but would like to make some suggestions:

The hardware support of QOS should ideally be part of the existing DPDK traffic management. For example, in Linux there are devices that can offload traffic control (TC) to hardware and this is done via flags to existing software infrastructure.

Your implementation makes HW and SW QoS diverge. This will require each application to get even more dependent on a particular hardware device.

Quoted 8 lines

Which brings up the bigger picture problem. Don't want to repeat the problems with rte_flow here. Any hardware support needs to have a matching set of software implementation, and test cases. The problem with rte_flow is the semantics are poorly defined and each vendor does it differently; and the SW flow classifier is incomplete and does not match what the HW does.

In an ideal world, there would be:
- an abstract API for defining ingress and egress queue management

It is already available as rte_tm and rte_mtr API. Only congestion management is missing. That is added in the patch.

Quoted 1 line

- a software implementation of that API

It is already available. See lib/sched/rte_red.h

Quoted 6 lines

- multiple hardware implementations
- ability to transparently use both SW and HW queue management from application
- complete test suite for that API.

Yes, that is asking a lot. But as trailblazer in this area, you have to do the hard work.

None of the new features in rte_flow, rte_ethdev or rte_tm etc NOT going in this path.
If we think, we need to enforce this path(SW driver is a must) for any feature. Let's discuss here and TB meeting and decide and we need to make that policy for any new contribution.

Quoted 1 line
#7 lore raw

PATCH 1/1 ethdev: support congestion management

In reply to [email protected]

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

---

rfc..v1:
- Added RED specification (http://www.aciri.org/floyd/papers/red/red.html) link
- Fixed doxygen comment issue (Min Hu)

 doc/guides/nics/features.rst         |  12 +++
 doc/guides/nics/features/default.ini |   1 +
 lib/eal/include/meson.build          |   1 +
 lib/eal/include/rte_cman.h           |  52 ++++++++++
 lib/ethdev/rte_ethdev.h              | 145 +++++++++++++++++++++++++++
 5 files changed, 211 insertions(+)
 create mode 100644 lib/eal/include/rte_cman.h
doc/guides/nics/features.rst +12 -0
index 7f6cb914a5..aa22d8bb22 100644
@@ -727,6 +727,18 @@ Supports configuring per-queue stat counter mapping.
   ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 
 
+.. _nic_features_congestion_management:
+
+Congestion management
+---------------------
+
+Supports congestion management.
+
+* **[implements] eth_dev_ops**: ``cman_info_get``, ``cman_config_set``, ``cman_config_get``.
+* **[related]    API**: ``rte_eth_cman_info_get()``, ``rte_eth_cman_config_init()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
+
+
 .. _nic_features_fw_version:
 
 FW version
doc/guides/nics/features/default.ini +1 -0
index d1db0c256a..38a5767b06 100644
@@ -60,6 +60,7 @@ Tx descriptor status =
 Basic stats          =
 Extended stats       =
 Stats per queue      =
+Congestion management =
 FW version           =
 EEPROM dump          =
 Module EEPROM dump   =
lib/eal/include/meson.build +1 -0
index fd6e844224..e569ba7cf4 100644
@@ -10,6 +10,7 @@ headers += files(
         'rte_branch_prediction.h',
         'rte_bus.h',
         'rte_class.h',
+        'rte_cman.h',
         'rte_common.h',
         'rte_compat.h',
         'rte_debug.h',
lib/eal/include/rte_cman.h new file +52 -0

52 lines not on this page · raw message

lib/ethdev/rte_ethdev.h +145 -0

157 lines not on this page · raw message

Signature · 1 line
2.37.0
#8 lore raw

PATCH v2 1/1 ethdev: support congestion management

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

---
v1..v2:
- Fix review comments (Akhil Goyal)

rfc..v1:
- Added RED specification (http://www.aciri.org/floyd/papers/red/red.html) link
- Fixed doxygen comment issue (Min Hu)

 doc/guides/nics/features.rst         |  12 +++
 doc/guides/nics/features/default.ini |   1 +
 lib/eal/include/meson.build          |   1 +
 lib/eal/include/rte_cman.h           |  55 ++++++++++
 lib/ethdev/ethdev_driver.h           |  25 +++++
 lib/ethdev/meson.build               |   1 +
 lib/ethdev/rte_cman.c                | 101 ++++++++++++++++++
 lib/ethdev/rte_ethdev.h              | 151 +++++++++++++++++++++++++++
 lib/ethdev/version.map               |   6 ++
 9 files changed, 353 insertions(+)
 create mode 100644 lib/eal/include/rte_cman.h
 create mode 100644 lib/ethdev/rte_cman.c
doc/guides/nics/features.rst +12 -0
index 7f6cb914a5..aa22d8bb22 100644
@@ -727,6 +727,18 @@ Supports configuring per-queue stat counter mapping.
   ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 
 
+.. _nic_features_congestion_management:
+
+Congestion management
+---------------------
+
+Supports congestion management.
+
+* **[implements] eth_dev_ops**: ``cman_info_get``, ``cman_config_set``, ``cman_config_get``.
+* **[related]    API**: ``rte_eth_cman_info_get()``, ``rte_eth_cman_config_init()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
+
+
 .. _nic_features_fw_version:
 
 FW version
doc/guides/nics/features/default.ini +1 -0
index d1db0c256a..38a5767b06 100644
@@ -60,6 +60,7 @@ Tx descriptor status =
 Basic stats          =
 Extended stats       =
 Stats per queue      =
+Congestion management =
 FW version           =
 EEPROM dump          =
 Module EEPROM dump   =
lib/eal/include/meson.build +1 -0
index fd6e844224..e569ba7cf4 100644
@@ -10,6 +10,7 @@ headers += files(
         'rte_branch_prediction.h',
         'rte_bus.h',
         'rte_class.h',
+        'rte_cman.h',
         'rte_common.h',
         'rte_compat.h',
         'rte_debug.h',
lib/eal/include/rte_cman.h new file +55 -0

55 lines not on this page · raw message

lib/ethdev/ethdev_driver.h +25 -0
index 5101868ea7..9b6ad5c5c1 100644
@@ -1093,6 +1093,22 @@ typedef int (*eth_rx_queue_avail_thresh_query_t)(struct rte_eth_dev *dev,
 					uint16_t *rx_queue_id,
 					uint8_t *avail_thresh);
 
+/** @internal Get congestion management information. */
+typedef int (*eth_cman_info_get_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_info *info);
+
+/** @internal Init congestion management structure with default values. */
+typedef int (*eth_cman_config_init_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_config *config);
+
+/** @internal Configure congestion management on a port. */
+typedef int (*eth_cman_config_set_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_config *config);
+
+/** @internal Retrieve congestion management configuration of a port. */
+typedef int (*eth_cman_config_get_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_config *config);
+
 /**
  * @internal A structure containing the functions exported by an Ethernet driver.
  */
@@ -1308,6 +1324,15 @@ struct eth_dev_ops {
 	eth_rx_queue_avail_thresh_set_t rx_queue_avail_thresh_set;
 	/** Query Rx queue available descriptors threshold event */
 	eth_rx_queue_avail_thresh_query_t rx_queue_avail_thresh_query;
+
+	/** Get congestion management information */
+	eth_cman_info_get_t cman_info_get;
+	/** Initialize congestion management structure with default values */
+	eth_cman_config_init_t cman_config_init;
+	/** Configure congestion management */
+	eth_cman_config_set_t cman_config_set;
+	/** Retrieve congestion management configuration */
+	eth_cman_config_get_t cman_config_get;
 };
 
 /**
lib/ethdev/meson.build +1 -0
index 47bb2625b0..59ad49114f 100644
@@ -7,6 +7,7 @@ sources = files(
         'ethdev_profile.c',
         'ethdev_trace_points.c',
         'rte_class_eth.c',
+        'rte_cman.c',
         'rte_ethdev.c',
         'rte_flow.c',
         'rte_mtr.c',
lib/ethdev/rte_cman.c new file +101 -0

101 lines not on this page · raw message

lib/ethdev/rte_ethdev.h +151 -0

163 lines not on this page · raw message

lib/ethdev/version.map +6 -0
index 03f52fee91..ea9b9497ad 100644
@@ -285,6 +285,12 @@ EXPERIMENTAL {
 	rte_mtr_color_in_protocol_priority_get;
 	rte_mtr_color_in_protocol_set;
 	rte_mtr_meter_vlan_table_update;
+
+	# added in 22.11
+	rte_eth_cman_config_get;
+	rte_eth_cman_config_init;
+	rte_eth_cman_config_set;
+	rte_eth_cman_info_get;
 };
 
 INTERNAL {
Signature · 1 line
2.25.1
#9 lore raw

19/09/2022 14:15, [email protected]:

Quoted 11 lines

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

[...]

Quoted 9 lines
 doc/guides/nics/features.rst         |  12 +++
 doc/guides/nics/features/default.ini |   1 +
 lib/eal/include/meson.build          |   1 +
 lib/eal/include/rte_cman.h           |  55 ++++++++++
 lib/ethdev/ethdev_driver.h           |  25 +++++
 lib/ethdev/meson.build               |   1 +
 lib/ethdev/rte_cman.c                | 101 ++++++++++++++++++
 lib/ethdev/rte_ethdev.h              | 151 +++++++++++++++++++++++++++
 lib/ethdev/version.map               |   6 ++

I feel EAL is not the right place for CMAN definitions.

After a discussion with Jerin, I understand we could use the same definitions in other API classes, not only ethdev. However I think this .h file should be better hosted in lib/ethdev/ with its own namespace rte_cman.
Then other libs could include this rte_cman.h without having a strong dependency on ethdev.

Deal?

#10 lore raw
Quoted 25 lines · Thomas Monjalon

19/09/2022 14:15, [email protected]:

Quoted 11 lines

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

[...]

Quoted 9 lines
 doc/guides/nics/features.rst         |  12 +++
 doc/guides/nics/features/default.ini |   1 +
 lib/eal/include/meson.build          |   1 +
 lib/eal/include/rte_cman.h           |  55 ++++++++++
 lib/ethdev/ethdev_driver.h           |  25 +++++
 lib/ethdev/meson.build               |   1 + lib/ethdev/rte_cman.c |
 101 ++++++++++++++++++ lib/ethdev/rte_ethdev.h              | 151
 +++++++++++++++++++++++++++ lib/ethdev/version.map               |   6

++

I feel EAL is not the right place for CMAN definitions.

Quoted 8 lines

After a discussion with Jerin, I understand we could use the same definitions in other API classes, not only ethdev. However I think this .h file should be better hosted in lib/ethdev/ with its own namespace rte_cman. Then other libs could include this rte_cman.h without having a strong dependency on ethdev.

Deal?

Would rte_net also be an option? Alternatively, is this related to the work and structures defined in the meter library header, since it seems also related to congestion management on ingress?

/Bruce

#11 lore raw
Quoted 13 lines · Bruce Richardson
Quoted 10 lines · Thomas Monjalon
Quoted 1 line

++

I feel EAL is not the right place for CMAN definitions.

After a discussion with Jerin, I understand we could use the same definitions in other API classes, not only ethdev. However I think this .h file should be better hosted in lib/ethdev/ with its own namespace rte_cman. Then other libs could include this rte_cman.h without having a strong dependency on ethdev.

Quoted 3 lines
Quoted 2 lines

Deal?

Would rte_net also be an option? Alternatively, is this related to the work

Looks like the net is a good option. Since it is just a header file any place would be OK.

+ @Olivier Matz

Any objections to keeping rte_cman.h to lib/net?

Quoted 4 lines

and structures defined in the meter library header, since it seems also related to congestion management on ingress?

/Bruce

#12 lore raw

28/09/2022 13:14, Jerin Jacob:

Quoted 17 lines
Quoted 15 lines · Bruce Richardson
Quoted 12 lines · Thomas Monjalon
Quoted 1 line

++

I feel EAL is not the right place for CMAN definitions.

After a discussion with Jerin, I understand we could use the same definitions in other API classes, not only ethdev. However I think this .h file should be better hosted in lib/ethdev/ with its own namespace rte_cman. Then other libs could include this rte_cman.h without having a strong dependency on ethdev.

Deal?

Quoted 8 lines
Quoted 1 line

Would rte_net also be an option? Alternatively, is this related to the work

Looks like the net is a good option. Since it is just a header file any place would be OK.

+ @Olivier Matz

Any objections to keeping rte_cman.h to lib/net?

lib/net/ is supposed to be standardized packet headers definitions.

#13 lore raw
Quoted 21 lines · Thomas Monjalon

28/09/2022 13:14, Jerin Jacob:

Quoted 19 lines
Quoted 16 lines · Bruce Richardson
Quoted 4 lines · Thomas Monjalon
Quoted 1 line

++

I feel EAL is not the right place for CMAN definitions.

Quoted 8 lines

After a discussion with Jerin, I understand we could use the same definitions in other API classes, not only ethdev. However I think this .h file should be better hosted in lib/ethdev/ with its own namespace rte_cman. Then other libs could include this rte_cman.h without having a strong dependency on ethdev.

Deal?

Would rte_net also be an option? Alternatively, is this related to the work

Quoted 8 lines
Quoted 6 lines

Looks like the net is a good option. Since it is just a header file any place would be OK.

+ @Olivier Matz

Any objections to keeping rte_cman.h to lib/net?

lib/net/ is supposed to be standardized packet headers definitions.

Since it had lib/net/net_crc.h, I thought it is OK to keep it in lib/net. No strong opinion. I will keep it as lib/ethdev/rte_cman.h then.

Quoted 2 lines
#14 lore raw
Quoted 25 lines · Jerin Jacob
Quoted 24 lines · Thomas Monjalon

28/09/2022 13:14, Jerin Jacob:

Quoted 22 lines
Quoted 13 lines · Bruce Richardson
Quoted 10 lines · Thomas Monjalon
Quoted 1 line

++

I feel EAL is not the right place for CMAN definitions.

After a discussion with Jerin, I understand we could use the same definitions in other API classes, not only ethdev. However I think this .h file should be better hosted in lib/ethdev/ with its own namespace rte_cman. Then other libs could include this rte_cman.h without having a strong dependency on ethdev.

Quoted 3 lines
Quoted 2 lines

Deal?

Would rte_net also be an option? Alternatively, is this related to the work

Looks like the net is a good option. Since it is just a header file any place would be OK.

Quoted 8 lines
Quoted 5 lines
Quoted 3 lines

+ @Olivier Matz

Any objections to keeping rte_cman.h to lib/net?

lib/net/ is supposed to be standardized packet headers definitions.

Since it had lib/net/net_crc.h, I thought it is OK to keep it in lib/net. No strong opinion. I will keep it as lib/ethdev/rte_cman.h then.

lib/ethdev/rte_cman.h looks better to me too.

#15 lore raw
In reply to [email protected]

Cc David. See some kind of reincarnation of RTE_FUNC_PTR_* macro below.

Quoted 29 lines · On 9/19/22 15:15, [email protected] wrote:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

[snip]

Quoted 24 lines
lib/eal/include/rte_cman.h new file +18 -0
new file mode 100644
index 0000000000..1d84ddf0fb
@@ -0,0 +1,55 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2022 Marvell International Ltd.
+ */
+
+#ifndef RTE_CMAN_H
+#define RTE_CMAN_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <rte_bitops.h>
+
+/**
+ * @file
+ * Congestion management related parameters for DPDK.
+ */
+

lib/eal/include/rte_cman.h line 28

Quoted 10 lines
lib/eal/include/rte_cman.h new file +10 -0
+/** Congestion management modes */
+enum rte_cman_mode {
+	/**
+	 * Congestion based on Random Early Detection.
+	 *
+	 * https://en.wikipedia.org/wiki/Random_early_detection
+	 * http://www.aciri.org/floyd/papers/red/red.html
+	 * @see struct rte_cman_red_params
+	 */
+	RTE_CMAN_RED = RTE_BIT64(0),

I believe enums with 64-bit values are bad.

Quoted 57 lines
lib/eal/include/rte_cman.h new file +27 -0
+};
+
+/**
+ * RED based congestion management configuration parameters.
+ */
+struct rte_cman_red_params {
+	/**
+	 * Minimum threshold (min_th) value
+	 *
+	 * Value expressed as percentage. Value must be in 0 to 100(inclusive).
+	 */
+	uint8_t min_th;
+	/**
+	 * Maximum threshold (max_th) value
+	 *
+	 * Value expressed as percentage. Value must be in 0 to 100(inclusive).
+	 */
+	uint8_t max_th;
+	/** Inverse of packet marking probability maximum value (maxp = 1 / maxp_inv) */
+	uint16_t maxp_inv;
+};
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* RTE_CMAN_H */
lib/ethdev/meson.build +1 -0
index 47bb2625b0..59ad49114f 100644
@@ -7,6 +7,7 @@ sources = files(
          'ethdev_profile.c',
          'ethdev_trace_points.c',
          'rte_class_eth.c',
+        'rte_cman.c',
          'rte_ethdev.c',
          'rte_flow.c',
          'rte_mtr.c',
lib/ethdev/rte_cman.c new file +11 -0
new file mode 100644
index 0000000000..2093c247d1
@@ -0,0 +1,101 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2022 Marvell International Ltd.
+ */
+
+#include <stdint.h>
+
+#include <rte_errno.h>
+#include "rte_ethdev.h"
+#include "ethdev_driver.h"
+
+static int

lib/ethdev/rte_cman.c line 21

Quoted 10 lines
lib/ethdev/rte_cman.c new file +10 -0
+eth_err(uint16_t port_id, int ret)
+{
+	if (ret == 0)
+		return 0;
+
+	if (rte_eth_dev_is_removed(port_id))
+		return -EIO;
+
+	return ret;
+}

It is a dup from rte_ethdev.c. I think it should be moved to some internal header.

lib/ethdev/rte_cman.c line 23

Quoted 2 lines
lib/ethdev/rte_cman.c new file +2 -0
+
+#define RTE_CMAN_FUNC_ERR_RET(func)					\

There is nothing CMAN specific in the function except location.

Cc David who deprecated similar macros in the release cycle, but this one have a log message.

Quoted 12 lines
lib/ethdev/rte_cman.c new file +12 -0
+do {									\
+	if (func == NULL) {						\
+		RTE_ETHDEV_LOG(ERR, "Function not implemented\n");	\
+		return -ENOTSUP;					\
+	}								\
+} while (0)
+
+/* Get congestion management information for a port */
+int
+rte_eth_cman_info_get(uint16_t port_id, struct rte_eth_cman_info *info)
+{
+	struct rte_eth_dev *dev;

lib/ethdev/rte_cman.c line 45

Quoted 10 lines
lib/ethdev/rte_cman.c new file +10 -0
+
+	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+	dev = &rte_eth_devices[port_id];
+
+	if (info == NULL) {
+		RTE_ETHDEV_LOG(ERR, "congestion management info is NULL\n");
+		return -EINVAL;
+	}
+
+	RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_info_get);

I think we should memset(&info, 0, sizeof(*info)) here since all drivers must do it anyway.

Quoted 44 lines
lib/ethdev/rte_cman.c new file +44 -0
+	return eth_err(port_id, (*dev->dev_ops->cman_info_get)(dev, info));
+}
+
+/* Initialize congestion management structure with default values */
+int
+rte_eth_cman_config_init(uint16_t port_id, struct rte_eth_cman_config *config)
+{
+	struct rte_eth_dev *dev;
+
+	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+	dev = &rte_eth_devices[port_id];
+
+	if (config == NULL) {
+		RTE_ETHDEV_LOG(ERR, "congestion management config is NULL\n");
+		return -EINVAL;
+	}
+
+	RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_config_init);
+	return eth_err(port_id, (*dev->dev_ops->cman_config_init)(dev, config));
+}
+
+/* Configure congestion management on a port */
+int
+rte_eth_cman_config_set(uint16_t port_id, struct rte_eth_cman_config *config)
+{
+	struct rte_eth_dev *dev;
+
+	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+	dev = &rte_eth_devices[port_id];
+
+	if (config == NULL) {
+		RTE_ETHDEV_LOG(ERR, "congestion management config is NULL\n");
+		return -EINVAL;
+	}
+
+	RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_config_set);
+	return eth_err(port_id, (*dev->dev_ops->cman_config_set)(dev, config));
+}
+
+/* Retrieve congestion management configuration of a port */
+int
+rte_eth_cman_config_get(uint16_t port_id, struct rte_eth_cman_config *config)
+{
+	struct rte_eth_dev *dev;

lib/ethdev/rte_cman.c line 99

Quoted 10 lines
lib/ethdev/rte_cman.c new file +10 -0
+
+	RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+	dev = &rte_eth_devices[port_id];
+
+	if (config == NULL) {
+		RTE_ETHDEV_LOG(ERR, "congestion management config is NULL\n");
+		return -EINVAL;
+	}
+
+	RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_config_get);

memset(&config, 0, sizeof(*config));

Quoted 19 lines
lib/ethdev/rte_cman.c new file +2 -0
+	return eth_err(port_id, (*dev->dev_ops->cman_config_get)(dev, config));
+}
lib/ethdev/rte_ethdev.h +2 -0
index de9e970d4d..f4bb644c6a 100644
@@ -160,6 +160,7 @@ extern "C" {
  #define RTE_ETHDEV_DEBUG_TX
  #endif
 
+#include <rte_cman.h>
  #include <rte_compat.h>
  #include <rte_log.h>
  #include <rte_interrupts.h>
@@ -5506,6 +5507,156 @@ typedef struct {
  __rte_experimental
  int rte_eth_dev_priv_dump(uint16_t port_id, FILE *file);
 
+/* Congestion management */

lib/ethdev/rte_ethdev.h typedef struct { · line 5520

Quoted 10 lines
lib/ethdev/rte_ethdev.h +10 -0
+
+/** Enumerate list of ethdev congestion management objects */
+enum rte_eth_cman_obj {
+	/** Congestion management based on Rx queue depth */
+	RTE_ETH_CMAN_OBJ_RX_QUEUE = RTE_BIT64(0),
+	/**
+	 * Congestion management based on mempool depth associated with Rx queue
+	 * @see rte_eth_rx_queue_setup()
+	 */
+	RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL = RTE_BIT64(1),

Do we really want one more enum with 64-bit initialized member? IMHO, it should be either defines or 32-bit.

Quoted 10 lines
lib/ethdev/rte_ethdev.h +10 -0
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change, or be removed, without prior notice
+ *
+ * A structure used to retrieve information of ethdev congestion management.
+ */
+struct rte_eth_cman_info {
+	/**

lib/ethdev/rte_ethdev.h typedef struct { · line 5540

Quoted 10 lines
lib/ethdev/rte_ethdev.h +10 -0
+	 * Set of supported congestion management modes
+	 * @see enum rte_cman_mode
+	 */
+	uint64_t modes_supported;
+	/**
+	 * Set of supported congestion management objects
+	 * @see enum rte_eth_cman_obj
+	 */
+	uint64_t objs_supported;
+	/** Reserved for future fields */

I think we should highlight that it is set to zeros on get right now.

Quoted 13 lines
lib/ethdev/rte_ethdev.h +13 -0
+	uint8_t rsvd[8];
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change, or be removed, without prior notice
+ *
+ * A structure used to configure the ethdev congestion management.
+ */
+struct rte_eth_cman_config {
+	/** Congestion management object */
+	enum rte_eth_cman_obj obj;
+	/** Congestion management mode */

lib/ethdev/rte_ethdev.h typedef struct { · line 5563

Quoted 10 lines
lib/ethdev/rte_ethdev.h +10 -0
+	enum rte_cman_mode mode;
+	union {
+		/**
+		 * Rx queue to configure congestion management.
+		 *
+		 * Valid when object is RTE_ETH_CMAN_OBJ_RX_QUEUE or
+		 * RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL.
+		 */
+		uint16_t rx_queue;
+		/** Reserved for future fields */

Must be zeros on get and set right now.

lib/ethdev/rte_ethdev.h typedef struct { · line 5574

Quoted 11 lines
lib/ethdev/rte_ethdev.h +11 -0
+		uint8_t rsvd_obj_params[4];
+	} obj_param;
+	union {
+		/**
+		 * RED configuration parameters.
+		 *
+		 * Valid when mode is RTE_CMAN_RED.
+		 */
+		struct rte_cman_red_params red;
+		/** Reserved for future fields */
+		uint8_t rsvd_mode_params[4];

same here.

Quoted 3 lines
lib/ethdev/rte_ethdev.h +3 -0
+	} mode_param;
+};
+

[snip]

Quoted 8 lines
lib/ethdev/rte_ethdev.h +8 -0
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Configure ethdev congestion management
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.

lib/ethdev/rte_ethdev.h typedef struct { · line 5635

Quoted 10 lines
lib/ethdev/rte_ethdev.h +10 -0
+ * @param config
+ *   A pointer to a structure of type *rte_eth_cman_config* to be configured.
+ * @return
+ *   - (0) if successful.
+ *   - (-ENOTSUP) if support for cman_config_set does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.
+ */
+__rte_experimental
+int rte_eth_cman_config_set(uint16_t port_id, struct rte_eth_cman_config *config);

Just a niot, but may be config should be 'const'?

[snip]

#16 lore raw
Quoted 15 lines · Andrew Rybchenko

Cc David. See some kind of reincarnation of RTE_FUNC_PTR_* macro below.

Quoted 10 lines
lib/eal/include/rte_cman.h new file +10 -0
+
+/**
+ * @file
+ * Congestion management related parameters for DPDK.
+ */
+
+/** Congestion management modes */
+enum rte_cman_mode {
+     /**
+      * Congestion based on Random Early Detection.
Quoted 8 lines

lib/eal/include/rte_cman.h line 28

Quoted 6 lines
lib/eal/include/rte_cman.h new file +6 -0
+      *
+      * https://en.wikipedia.org/wiki/Random_early_detection
+      * http://www.aciri.org/floyd/papers/red/red.html
+      * @see struct rte_cman_red_params
+      */
+     RTE_CMAN_RED = RTE_BIT64(0),

I believe enums with 64-bit values are bad.

No strong opinion. Will change to 32bit.

Quoted 19 lines
Quoted 19 lines
lib/ethdev/rte_cman.c new file +16 -0
@@ -0,0 +1,101 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(C) 2022 Marvell International Ltd.
+ */
+
+#include <stdint.h>
+
+#include <rte_errno.h>
+#include "rte_ethdev.h"
+#include "ethdev_driver.h"
+
+static int
+eth_err(uint16_t port_id, int ret)
+{
+     if (ret == 0)
+             return 0;
+
Quoted 8 lines

lib/ethdev/rte_cman.c line 21

Quoted 5 lines
lib/ethdev/rte_cman.c new file +5 -0
+     if (rte_eth_dev_is_removed(port_id))
+             return -EIO;
+
+     return ret;
+}

It is a dup from rte_ethdev.c. I think it should be moved to some internal header.

Ack.

Quoted 8 lines

lib/ethdev/rte_cman.c line 23

Quoted 3 lines
lib/ethdev/rte_cman.c new file +2 -0
+
+#define RTE_CMAN_FUNC_ERR_RET(func)                                  \

There is nothing CMAN specific in the function except location.

Cc David who deprecated similar macros in the release cycle, but this one have a log message.

Yes. It has an additional log function. No strong opinion Will remove this macro.

Quoted 18 lines
Quoted 18 lines
lib/ethdev/rte_cman.c new file +17 -0
+do {                                                                 \
+     if (func == NULL) {                                             \
+             RTE_ETHDEV_LOG(ERR, "Function not implemented\n");      \
+             return -ENOTSUP;                                        \
+     }                                                               \
+} while (0)
+
+/* Get congestion management information for a port */
+int
+rte_eth_cman_info_get(uint16_t port_id, struct rte_eth_cman_info *info)
+{
+     struct rte_eth_dev *dev;
+
+     RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+     dev = &rte_eth_devices[port_id];
+
+     if (info == NULL) {
Quoted 8 lines

lib/ethdev/rte_cman.c line 45

Quoted 5 lines
lib/ethdev/rte_cman.c new file +5 -0
+             RTE_ETHDEV_LOG(ERR, "congestion management info is NULL\n");
+             return -EINVAL;
+     }
+
+     RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_info_get);

I think we should memset(&info, 0, sizeof(*info)) here since all drivers must do it anyway.

Will do.

Quoted 49 lines
Quoted 49 lines
lib/ethdev/rte_cman.c new file +48 -0
+     return eth_err(port_id, (*dev->dev_ops->cman_info_get)(dev, info));
+}
+
+/* Initialize congestion management structure with default values */
+int
+rte_eth_cman_config_init(uint16_t port_id, struct rte_eth_cman_config *config)
+{
+     struct rte_eth_dev *dev;
+
+     RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+     dev = &rte_eth_devices[port_id];
+
+     if (config == NULL) {
+             RTE_ETHDEV_LOG(ERR, "congestion management config is NULL\n");
+             return -EINVAL;
+     }
+
+     RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_config_init);
+     return eth_err(port_id, (*dev->dev_ops->cman_config_init)(dev, config));
+}
+
+/* Configure congestion management on a port */
+int
+rte_eth_cman_config_set(uint16_t port_id, struct rte_eth_cman_config *config)
+{
+     struct rte_eth_dev *dev;
+
+     RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+     dev = &rte_eth_devices[port_id];
+
+     if (config == NULL) {
+             RTE_ETHDEV_LOG(ERR, "congestion management config is NULL\n");
+             return -EINVAL;
+     }
+
+     RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_config_set);
+     return eth_err(port_id, (*dev->dev_ops->cman_config_set)(dev, config));
+}
+
+/* Retrieve congestion management configuration of a port */
+int
+rte_eth_cman_config_get(uint16_t port_id, struct rte_eth_cman_config *config)
+{
+     struct rte_eth_dev *dev;
+
+     RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+     dev = &rte_eth_devices[port_id];
+
Quoted 8 lines

lib/ethdev/rte_cman.c line 99

Quoted 6 lines
lib/ethdev/rte_cman.c new file +6 -0
+     if (config == NULL) {
+             RTE_ETHDEV_LOG(ERR, "congestion management config is NULL\n");
+             return -EINVAL;
+     }
+
+     RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_config_get);

memset(&config, 0, sizeof(*config));

Ack

Quoted 19 lines
Quoted 19 lines
lib/ethdev/rte_cman.c new file +2 -0
+     return eth_err(port_id, (*dev->dev_ops->cman_config_get)(dev, config));
+}
lib/ethdev/rte_ethdev.h +1 -0
index de9e970d4d..f4bb644c6a 100644
@@ -160,6 +160,7 @@ extern "C" {
  #define RTE_ETHDEV_DEBUG_TX
  #endif
 
+#include <rte_cman.h>
  #include <rte_compat.h>
  #include <rte_log.h>
  #include <rte_interrupts.h>
@@ -5506,6 +5507,156 @@ typedef struct {
  __rte_experimental
  int rte_eth_dev_priv_dump(uint16_t port_id, FILE *file);
 
Quoted 14 lines

lib/ethdev/rte_ethdev.h typedef struct { · line 5520

Quoted 11 lines
lib/ethdev/rte_ethdev.h +11 -0
+/* Congestion management */
+
+/** Enumerate list of ethdev congestion management objects */
+enum rte_eth_cman_obj {
+     /** Congestion management based on Rx queue depth */
+     RTE_ETH_CMAN_OBJ_RX_QUEUE = RTE_BIT64(0),
+     /**
+      * Congestion management based on mempool depth associated with Rx queue
+      * @see rte_eth_rx_queue_setup()
+      */
+     RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL = RTE_BIT64(1),

Do we really want one more enum with 64-bit initialized member? IMHO, it should be either defines or 32-bit.

Will keep it 32 bit.

Quoted 16 lines
Quoted 16 lines
lib/ethdev/rte_ethdev.h +15 -0
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change, or be removed, without prior notice
+ *
+ * A structure used to retrieve information of ethdev congestion management.
+ */
+struct rte_eth_cman_info {
+     /**
+      * Set of supported congestion management modes
+      * @see enum rte_cman_mode
+      */
+     uint64_t modes_supported;
+     /**
Quoted 8 lines

lib/ethdev/rte_ethdev.h typedef struct { · line 5540

Quoted 5 lines
lib/ethdev/rte_ethdev.h +5 -0
+      * Set of supported congestion management objects
+      * @see enum rte_eth_cman_obj
+      */
+     uint64_t objs_supported;
+     /** Reserved for future fields */

I think we should highlight that it is set to zeros on get right now.

Will change as "Reserved for future fields. Always return as zero when rte_eth_cman_config_get() invoked"

Quoted 18 lines
Quoted 18 lines
lib/ethdev/rte_ethdev.h +17 -0
+     uint8_t rsvd[8];
+};
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this structure may change, or be removed, without prior notice
+ *
+ * A structure used to configure the ethdev congestion management.
+ */
+struct rte_eth_cman_config {
+     /** Congestion management object */
+     enum rte_eth_cman_obj obj;
+     /** Congestion management mode */
+     enum rte_cman_mode mode;
+     union {
+             /**
+              * Rx queue to configure congestion management.
Quoted 8 lines

lib/ethdev/rte_ethdev.h typedef struct { · line 5563

Quoted 6 lines
lib/ethdev/rte_ethdev.h +6 -0
+              *
+              * Valid when object is RTE_ETH_CMAN_OBJ_RX_QUEUE or
+              * RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL.
+              */
+             uint16_t rx_queue;
+             /** Reserved for future fields */

Must be zeros on get and set right now.

Will change as "Reserved for future fields. Must be set to zero on get and set operation "

Quoted 13 lines

lib/ethdev/rte_ethdev.h typedef struct { · line 5574

Quoted 12 lines
lib/ethdev/rte_ethdev.h +11 -0
+             uint8_t rsvd_obj_params[4];
+     } obj_param;
+     union {
+             /**
+              * RED configuration parameters.
+              *
+              * Valid when mode is RTE_CMAN_RED.
+              */
+             struct rte_cman_red_params red;
+             /** Reserved for future fields */
+             uint8_t rsvd_mode_params[4];
Quoted 1 line

same here.

Ack

Quoted 18 lines
Quoted 3 lines
lib/ethdev/rte_ethdev.h +3 -0
+     } mode_param;
+};
+

[snip]

Quoted 12 lines

+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Configure ethdev congestion management
+ *
+ * @param port_id
+ * The port identifier of the Ethernet device.
+ * @param config
+ * A pointer to a structure of type *rte_eth_cman_config* to be configured.
+ * @return
+ * - (0) if successful.

Quoted 8 lines

lib/ethdev/rte_ethdev.h

Quoted 6 lines
+ *   - (-ENOTSUP) if support for cman_config_set does not exist.
+ *   - (-ENODEV) if *port_id* invalid.
+ *   - (-EINVAL) if bad parameter.

+ */

lib/ethdev/rte_ethdev.h +2 -0
+__rte_experimental
+int rte_eth_cman_config_set(uint16_t port_id, struct rte_eth_cman_config *config);

Just a niot, but may be config should be 'const'?

Yes. We can keep as const.

Quoted 2 lines

[snip]

#17 lore raw

PATCH v3 1/1 ethdev: support congestion management

In reply to [email protected]

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the applied configuration.

---
v2..v3:
- Rename rte_cman.c to rte_ethdev_cman.c
- Move lib/eal/include/rte_cman.h to lib/ethdev/rte_cman.h
- Fix review comments (Andrew Rybchenko)
- Add release notes

v1..v2:
- Fix review comments (Akhil Goyal)

rfc..v1:
- Added RED specification (http://www.aciri.org/floyd/papers/red/red.html) link
- Fixed doxygen comment issue (Min Hu)

 doc/guides/nics/features.rst           |  12 ++
 doc/guides/nics/features/default.ini   |   1 +
 doc/guides/rel_notes/release_22_11.rst |   6 +
 lib/ethdev/ethdev_driver.h             |  25 ++++
 lib/ethdev/ethdev_private.c            |  12 ++
 lib/ethdev/ethdev_private.h            |   2 +
 lib/ethdev/meson.build                 |   2 +
 lib/ethdev/rte_cman.h                  |  55 +++++++++
 lib/ethdev/rte_ethdev.h                | 164 +++++++++++++++++++++++++
 lib/ethdev/rte_ethdev_cman.c           | 101 +++++++++++++++
 lib/ethdev/version.map                 |   6 +
 11 files changed, 386 insertions(+)
 create mode 100644 lib/ethdev/rte_cman.h
 create mode 100644 lib/ethdev/rte_ethdev_cman.c
doc/guides/nics/features.rst +12 -0
index b4a8e9881c..70ca46e651 100644
@@ -727,6 +727,18 @@ Supports configuring per-queue stat counter mapping.
   ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 
 
+.. _nic_features_congestion_management:
+
+Congestion management
+---------------------
+
+Supports congestion management.
+
+* **[implements] eth_dev_ops**: ``cman_info_get``, ``cman_config_set``, ``cman_config_get``.
+* **[related]    API**: ``rte_eth_cman_info_get()``, ``rte_eth_cman_config_init()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
+
+
 .. _nic_features_fw_version:
 
 FW version
doc/guides/nics/features/default.ini +1 -0
index f7192cb0da..a9c0008ebd 100644
@@ -60,6 +60,7 @@ Tx descriptor status =
 Basic stats          =
 Extended stats       =
 Stats per queue      =
+Congestion management =
 FW version           =
 EEPROM dump          =
 Module EEPROM dump   =
doc/guides/rel_notes/release_22_11.rst +6 -0
index 0231959874..ea9908e578 100644
@@ -81,6 +81,12 @@ New Features
   * Added AES-CCM support in lookaside protocol (IPsec) for CN9K & CN10K.
   * Added AES & DES DOCSIS algorithm support in lookaside crypto for CN9K.
 
+* **Added support for congestion management for ethdev.**
+
+  Added new APIs ``rte_eth_cman_config_init()``, ``rte_eth_cman_config_get()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_info_get()``
+  to support congestion management.
+
 * **Added eventdev adapter instance get API.**
 
   * Added ``rte_event_eth_rx_adapter_instance_get`` to get Rx adapter
lib/ethdev/ethdev_driver.h +25 -0
index 8cd8eb8685..e1e2d10a35 100644
@@ -1094,6 +1094,22 @@ typedef int (*eth_rx_queue_avail_thresh_query_t)(struct rte_eth_dev *dev,
 					uint16_t *rx_queue_id,
 					uint8_t *avail_thresh);
 
+/** @internal Get congestion management information. */
+typedef int (*eth_cman_info_get_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_info *info);
+
+/** @internal Init congestion management structure with default values. */
+typedef int (*eth_cman_config_init_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_config *config);
+
+/** @internal Configure congestion management on a port. */
+typedef int (*eth_cman_config_set_t)(struct rte_eth_dev *dev,
+				const struct rte_eth_cman_config *config);
+
+/** @internal Retrieve congestion management configuration of a port. */
+typedef int (*eth_cman_config_get_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_config *config);
+
 /**
  * @internal A structure containing the functions exported by an Ethernet driver.
  */
@@ -1309,6 +1325,15 @@ struct eth_dev_ops {
 	eth_rx_queue_avail_thresh_set_t rx_queue_avail_thresh_set;
 	/** Query Rx queue available descriptors threshold event */
 	eth_rx_queue_avail_thresh_query_t rx_queue_avail_thresh_query;
+
+	/** Get congestion management information */
+	eth_cman_info_get_t cman_info_get;
+	/** Initialize congestion management structure with default values */
+	eth_cman_config_init_t cman_config_init;
+	/** Configure congestion management */
+	eth_cman_config_set_t cman_config_set;
+	/** Retrieve congestion management configuration */
+	eth_cman_config_get_t cman_config_get;
 };
 
 /**
lib/ethdev/ethdev_private.c +12 -0
index 48090c879a..8787c3985e 100644
@@ -27,6 +27,18 @@ eth_dev_to_id(const struct rte_eth_dev *dev)
 	return dev - rte_eth_devices;
 }
 
+int32_t
+eth_check_err(struct rte_eth_dev *dev, int ret)
+{
+	if (ret == 0)
+		return 0;
+
+	if (rte_eth_dev_is_removed(eth_dev_to_id(dev)))
+		return -EIO;
+
+	return ret;
+}
+
 struct rte_eth_dev *
 eth_find_device(const struct rte_eth_dev *start, rte_eth_cmp_t cmp,
 		const void *data)
lib/ethdev/ethdev_private.h +2 -0
index cc9879907c..c7ac074029 100644
@@ -69,4 +69,6 @@ void eth_dev_txq_release(struct rte_eth_dev *dev, uint16_t qid);
 int eth_dev_rx_queue_config(struct rte_eth_dev *dev, uint16_t nb_queues);
 int eth_dev_tx_queue_config(struct rte_eth_dev *dev, uint16_t nb_queues);
 
+int32_t eth_check_err(struct rte_eth_dev *dev, int ret);
+
 #endif /* _ETH_PRIVATE_H_ */
lib/ethdev/meson.build +2 -0
index 47bb2625b0..39250b5da1 100644
@@ -8,6 +8,7 @@ sources = files(
         'ethdev_trace_points.c',
         'rte_class_eth.c',
         'rte_ethdev.c',
+        'rte_ethdev_cman.c',
         'rte_flow.c',
         'rte_mtr.c',
         'rte_tm.c',
@@ -19,6 +20,7 @@ sources = files(
 )
 
 headers = files(
+        'rte_cman.h',
         'rte_ethdev.h',
         'rte_ethdev_trace.h',
         'rte_ethdev_trace_fp.h',
lib/ethdev/rte_cman.h new file +55 -0

55 lines not on this page · raw message

lib/ethdev/rte_ethdev.h +164 -0

176 lines not on this page · raw message

lib/ethdev/rte_ethdev_cman.c new file +101 -0

101 lines not on this page · raw message

lib/ethdev/version.map +6 -0
index 25e54f9d3e..a974ce7140 100644
@@ -285,6 +285,12 @@ EXPERIMENTAL {
 	rte_mtr_color_in_protocol_priority_get;
 	rte_mtr_color_in_protocol_set;
 	rte_mtr_meter_vlan_table_update;
+
+	# added in 22.11
+	rte_eth_cman_config_get;
+	rte_eth_cman_config_init;
+	rte_eth_cman_config_set;
+	rte_eth_cman_info_get;
 };
 
 INTERNAL {
Signature · 1 line
2.25.1
#18 lore raw
Quoted 5 lines · On 9/29/22 12:35, [email protected] wrote:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Quoted 8 lines

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and

This patch adds -> Add

Quoted 3 lines

RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure

Introduce

Quoted 4 lines

backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as

Add

Quoted 3 lines

supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs

Add

Quoted 3 lines

to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the

add

Quoted 4 lines

applied configuration.

I'll send v4 with few minor correction.

Quoted 69 lines

---
v2..v3:
- Rename rte_cman.c to rte_ethdev_cman.c
- Move lib/eal/include/rte_cman.h to lib/ethdev/rte_cman.h
- Fix review comments (Andrew Rybchenko)
- Add release notes

v1..v2:
- Fix review comments (Akhil Goyal)

rfc..v1:
- Added RED specification (http://www.aciri.org/floyd/papers/red/red.html) link
- Fixed doxygen comment issue (Min Hu)

  doc/guides/nics/features.rst           |  12 ++
  doc/guides/nics/features/default.ini   |   1 +
  doc/guides/rel_notes/release_22_11.rst |   6 +
  lib/ethdev/ethdev_driver.h             |  25 ++++
  lib/ethdev/ethdev_private.c            |  12 ++
  lib/ethdev/ethdev_private.h            |   2 +
  lib/ethdev/meson.build                 |   2 +
  lib/ethdev/rte_cman.h                  |  55 +++++++++
  lib/ethdev/rte_ethdev.h                | 164 +++++++++++++++++++++++++
  lib/ethdev/rte_ethdev_cman.c           | 101 +++++++++++++++
  lib/ethdev/version.map                 |   6 +
  11 files changed, 386 insertions(+)

create mode 100644 lib/ethdev/rte_cman.h
create mode 100644 lib/ethdev/rte_ethdev_cman.c

doc/guides/nics/features.rst +12 -0
index b4a8e9881c..70ca46e651 100644
@@ -727,6 +727,18 @@ Supports configuring per-queue stat counter mapping.
    ``rte_eth_dev_set_tx_queue_stats_mapping()``.
 
 
+.. _nic_features_congestion_management:
+
+Congestion management
+---------------------
+
+Supports congestion management.
+
+* **[implements] eth_dev_ops**: ``cman_info_get``, ``cman_config_set``, ``cman_config_get``.
+* **[related]    API**: ``rte_eth_cman_info_get()``, ``rte_eth_cman_config_init()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_config_get()``.
+
+
  .. _nic_features_fw_version:
 
  FW version
doc/guides/nics/features/default.ini +1 -0
index f7192cb0da..a9c0008ebd 100644
@@ -60,6 +60,7 @@ Tx descriptor status =
  Basic stats          =
  Extended stats       =
  Stats per queue      =
+Congestion management =
  FW version           =
  EEPROM dump          =
  Module EEPROM dump   =
doc/guides/rel_notes/release_22_11.rst +0 -0
index 0231959874..ea9908e578 100644

doc/guides/rel_notes/release_22_11.rst New Features · line 89

Quoted 9 lines
doc/guides/rel_notes/release_22_11.rst +6 -0
@@ -81,6 +81,12 @@ New Features
    * Added AES-CCM support in lookaside protocol (IPsec) for CN9K & CN10K.
    * Added AES & DES DOCSIS algorithm support in lookaside crypto for CN9K.
 
+* **Added support for congestion management for ethdev.**
+
+  Added new APIs ``rte_eth_cman_config_init()``, ``rte_eth_cman_config_get()``,
+  ``rte_eth_cman_config_set()``, ``rte_eth_cman_info_get()``
+  to support congestion management.
+

The position is a bit incorrect. It should go after ethdev items.

Quoted 55 lines
doc/guides/rel_notes/release_22_11.rst +0 -0
  * **Added eventdev adapter instance get API.**
 
    * Added ``rte_event_eth_rx_adapter_instance_get`` to get Rx adapter
lib/ethdev/ethdev_driver.h +25 -0
index 8cd8eb8685..e1e2d10a35 100644
@@ -1094,6 +1094,22 @@ typedef int (*eth_rx_queue_avail_thresh_query_t)(struct rte_eth_dev *dev,
  					uint16_t *rx_queue_id,
  					uint8_t *avail_thresh);
 
+/** @internal Get congestion management information. */
+typedef int (*eth_cman_info_get_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_info *info);
+
+/** @internal Init congestion management structure with default values. */
+typedef int (*eth_cman_config_init_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_config *config);
+
+/** @internal Configure congestion management on a port. */
+typedef int (*eth_cman_config_set_t)(struct rte_eth_dev *dev,
+				const struct rte_eth_cman_config *config);
+
+/** @internal Retrieve congestion management configuration of a port. */
+typedef int (*eth_cman_config_get_t)(struct rte_eth_dev *dev,
+				struct rte_eth_cman_config *config);
+
  /**
   * @internal A structure containing the functions exported by an Ethernet driver.
   */
@@ -1309,6 +1325,15 @@ struct eth_dev_ops {
  	eth_rx_queue_avail_thresh_set_t rx_queue_avail_thresh_set;
  	/** Query Rx queue available descriptors threshold event */
  	eth_rx_queue_avail_thresh_query_t rx_queue_avail_thresh_query;
+
+	/** Get congestion management information */
+	eth_cman_info_get_t cman_info_get;
+	/** Initialize congestion management structure with default values */
+	eth_cman_config_init_t cman_config_init;
+	/** Configure congestion management */
+	eth_cman_config_set_t cman_config_set;
+	/** Retrieve congestion management configuration */
+	eth_cman_config_get_t cman_config_get;
  };
 
  /**
lib/ethdev/ethdev_private.c +1 -0
index 48090c879a..8787c3985e 100644
@@ -27,6 +27,18 @@ eth_dev_to_id(const struct rte_eth_dev *dev)
  	return dev - rte_eth_devices;
  }
 
+int32_t

lib/ethdev/ethdev_private.c eth_dev_to_id(const struct rte_eth_dev *dev) · line 40

Quoted 10 lines
lib/ethdev/ethdev_private.c +10 -0
+eth_check_err(struct rte_eth_dev *dev, int ret)
+{
+	if (ret == 0)
+		return 0;
+
+	if (rte_eth_dev_is_removed(eth_dev_to_id(dev)))
+		return -EIO;
+
+	return ret;
+}

It still duplicates eth_err(). I realize the difference in the first argument, but I think it is better to stick to eth_err(). Anyway eth_check_err() gets port_id by device and it is the only usage of the device in the function.

[snip]

#19 lore raw
Quoted 40 lines · Andrew Rybchenko
Quoted 5 lines · On 9/29/22 12:35, [email protected] wrote:

From: Jerin Jacob <[email protected]>

NIC HW controllers often come with congestion management support on various HW objects such as Rx queue depth or mempool queue depth.

Quoted 8 lines

Also, it can support various modes of operation such as RED (Random early discard), WRED etc on those HW objects.

This patch adds a framework to express such modes(enum rte_cman_mode) and introduce (enum rte_eth_cman_obj) to enumerate the different objects where the modes can operate on.

This patch adds RTE_CMAN_RED mode of operation and

This patch adds -> Add

Quoted 3 lines

RTE_ETH_CMAN_OBJ_RX_QUEUE, RTE_ETH_CMAN_OBJ_RX_QUEUE_MEMPOOL object.

Introduced reserved fields in configuration structure

Introduce

Quoted 4 lines

backed by rte_eth_cman_config_init() to add new configuration parameters without ABI breakage.

Added rte_eth_cman_info_get() API to get the information such as

Add

Quoted 3 lines

supported modes and objects.

Added rte_eth_cman_config_init(), rte_eth_cman_config_set() APIs

Add

Quoted 3 lines

to configure congestion management on those object with associated mode.

Finally, Added rte_eth_cman_config_get() API to retrieve the

Quoted 8 lines

add

Quoted 4 lines

applied configuration.

I'll send v4 with few minor correction.

Done, but I'm sorry I forgot to specify --in-reply-to.