From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B7FD8A00C3; Mon, 19 Sep 2022 14:18:05 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BC7B440E0F; Mon, 19 Sep 2022 14:18:04 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by mails.dpdk.org (Postfix) with ESMTP id 3020C40141 for ; Mon, 19 Sep 2022 14:18:03 +0200 (CEST) Received: from pps.filterd (m0045849.ppops.net [127.0.0.1]) by mx0a-0016f401.pphosted.com (8.17.1.5/8.17.1.5) with ESMTP id 28J5Ehoh027218; Mon, 19 Sep 2022 05:15:45 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding : content-type; s=pfpt0220; bh=WD1fVuVO8vPWgE8SPv4S5hIAngtc7ReK8BIYPbeWg3U=; b=ZMBFma3WC45gkNOwtBdOX/gc+SR9g7/U72aIDyo4I2FseXz7gjhvd62skVohc+CJ9G3d 8LyeRZFUTNJCGghn/L5eejORK12AhNJ5pp009JVAGVLJw6KpsSsw6hU3C9EBkfhbBkdQ g2ZdBDXitacd4FpkSY8Jjic9uPaprVEP2jVdePTjtUuaEV7J3yJyRt17+CdXtSOZrSrK HEgVzZ6njBKJ8AHSaUHldC5NASH1T9U5fKi8YoohyNLUgdpTu6cAUhAq4VeWjvEU8t64 t1eX+kTpucfMYqNpqRHWQeDGisGJQOoROb8QrnfRM+GhXCAlgZv8j5aVR1FOQewEr7QK GA== Received: from dc5-exch02.marvell.com ([199.233.59.182]) by mx0a-0016f401.pphosted.com (PPS) with ESMTPS id 3jnbkppkgx-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Mon, 19 Sep 2022 05:15:44 -0700 Received: from DC5-EXCH02.marvell.com (10.69.176.39) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server (TLS) id 15.0.1497.18; Mon, 19 Sep 2022 05:15:43 -0700 Received: from maili.marvell.com (10.69.176.80) by DC5-EXCH02.marvell.com (10.69.176.39) with Microsoft SMTP Server id 15.0.1497.18 via Frontend Transport; Mon, 19 Sep 2022 05:15:43 -0700 Received: from localhost.localdomain (unknown [10.28.34.25]) by maili.marvell.com (Postfix) with ESMTP id 701AC3F703F; Mon, 19 Sep 2022 05:15:41 -0700 (PDT) From: To: Ferruh Yigit , Thomas Monjalon , Andrew Rybchenko , "Ray Kinsella" CC: , Jerin Jacob Subject: [PATCH v2 1/1] ethdev: support congestion management Date: Mon, 19 Sep 2022 17:45:34 +0530 Message-ID: <20220919121534.1058884-1-skori@marvell.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20220713130340.2886839-1-jerinj@marvell.com> References: <20220713130340.2886839-1-jerinj@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-ORIG-GUID: Q4HaTol78AcIEsPGKMc4y3G2zDhbskgC X-Proofpoint-GUID: Q4HaTol78AcIEsPGKMc4y3G2zDhbskgC X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.895,Hydra:6.0.528,FMLib:17.11.122.1 definitions=2022-09-19_05,2022-09-16_01,2022-06-22_01 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org From: Jerin Jacob 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. Signed-off-by: Jerin Jacob --- 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 diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index 7f6cb914a5..aa22d8bb22 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -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 diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini index d1db0c256a..38a5767b06 100644 --- a/doc/guides/nics/features/default.ini +++ b/doc/guides/nics/features/default.ini @@ -60,6 +60,7 @@ Tx descriptor status = Basic stats = Extended stats = Stats per queue = +Congestion management = FW version = EEPROM dump = Module EEPROM dump = diff --git a/lib/eal/include/meson.build b/lib/eal/include/meson.build index fd6e844224..e569ba7cf4 100644 --- a/lib/eal/include/meson.build +++ b/lib/eal/include/meson.build @@ -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', diff --git a/lib/eal/include/rte_cman.h b/lib/eal/include/rte_cman.h new file mode 100644 index 0000000000..1d84ddf0fb --- /dev/null +++ b/lib/eal/include/rte_cman.h @@ -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 + +/** + * @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 + * http://www.aciri.org/floyd/papers/red/red.html + * @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 */ diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h index 5101868ea7..9b6ad5c5c1 100644 --- a/lib/ethdev/ethdev_driver.h +++ b/lib/ethdev/ethdev_driver.h @@ -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; }; /** diff --git a/lib/ethdev/meson.build b/lib/ethdev/meson.build index 47bb2625b0..59ad49114f 100644 --- a/lib/ethdev/meson.build +++ b/lib/ethdev/meson.build @@ -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', diff --git a/lib/ethdev/rte_cman.c b/lib/ethdev/rte_cman.c new file mode 100644 index 0000000000..2093c247d1 --- /dev/null +++ b/lib/ethdev/rte_cman.c @@ -0,0 +1,101 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright(C) 2022 Marvell International Ltd. + */ + +#include + +#include +#include "rte_ethdev.h" +#include "ethdev_driver.h" + +static int +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; +} + +#define RTE_CMAN_FUNC_ERR_RET(func) \ +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) { + RTE_ETHDEV_LOG(ERR, "congestion management info is NULL\n"); + return -EINVAL; + } + + RTE_CMAN_FUNC_ERR_RET(dev->dev_ops->cman_info_get); + 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]; + + 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); + return eth_err(port_id, (*dev->dev_ops->cman_config_get)(dev, config)); +} diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h index de9e970d4d..f4bb644c6a 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -160,6 +160,7 @@ extern "C" { #define RTE_ETHDEV_DEBUG_TX #endif +#include #include #include #include @@ -5506,6 +5507,156 @@ 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 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; + /** + * Set of supported congestion management objects + * @see enum rte_eth_cman_obj + */ + uint64_t objs_supported; + /** Reserved for future fields */ + 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. + * + * 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[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]; + } 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. + * - (-ENOTSUP) if support for cman_config_init does not exist. + * - (-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 /** diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map index 03f52fee91..ea9b9497ad 100644 --- a/lib/ethdev/version.map +++ b/lib/ethdev/version.map @@ -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 { -- 2.25.1