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 D12B0A0544; Fri, 23 Sep 2022 09:45:08 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 377164282D; Fri, 23 Sep 2022 09:45:00 +0200 (CEST) Received: from szxga01-in.huawei.com (szxga01-in.huawei.com [45.249.212.187]) by mails.dpdk.org (Postfix) with ESMTP id D748E400D7 for ; Fri, 23 Sep 2022 09:44:56 +0200 (CEST) Received: from kwepemi500017.china.huawei.com (unknown [172.30.72.56]) by szxga01-in.huawei.com (SkyGuard) with ESMTP id 4MYkbJ1lB7zlWN0; Fri, 23 Sep 2022 15:40:44 +0800 (CST) Received: from localhost.localdomain (10.28.79.22) by kwepemi500017.china.huawei.com (7.221.188.110) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.31; Fri, 23 Sep 2022 15:44:53 +0800 From: Dongdong Liu To: , , , , , CC: "Min Hu (Connor)" , Dongdong Liu Subject: [PATCH v4 1/3] ethdev: introduce ethdev desc dump API Date: Fri, 23 Sep 2022 15:43:14 +0800 Message-ID: <20220923074316.25077-2-liudongdong3@huawei.com> X-Mailer: git-send-email 2.22.0 In-Reply-To: <20220923074316.25077-1-liudongdong3@huawei.com> References: <20220527023351.40577-1-humin29@huawei.com> <20220923074316.25077-1-liudongdong3@huawei.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Originating-IP: [10.28.79.22] X-ClientProxiedBy: dggems702-chm.china.huawei.com (10.3.19.179) To kwepemi500017.china.huawei.com (7.221.188.110) X-CFilter-Loop: Reflected 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: "Min Hu (Connor)" Added the ethdev Rx/Tx desc dump API which provides functions for query descriptor from device. HW descriptor info differs in different NICs. The information demonstrates I/O process which is important for debug. As the information is different between NICs, the new API is introduced. Signed-off-by: Min Hu (Connor) Signed-off-by: Dongdong Liu Acked-by: Ray Kinsella --- doc/guides/rel_notes/release_22_11.rst | 7 ++++ lib/ethdev/ethdev_driver.h | 46 +++++++++++++++++++++++ lib/ethdev/rte_ethdev.c | 52 ++++++++++++++++++++++++++ lib/ethdev/rte_ethdev.h | 49 ++++++++++++++++++++++++ lib/ethdev/version.map | 2 + 5 files changed, 156 insertions(+) diff --git a/doc/guides/rel_notes/release_22_11.rst b/doc/guides/rel_notes/release_22_11.rst index f60161765b..d3f3f2e50c 100644 --- a/doc/guides/rel_notes/release_22_11.rst +++ b/doc/guides/rel_notes/release_22_11.rst @@ -55,6 +55,13 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added ethdev desc dump API, to dump Rx/Tx desc info from device.** + +Added the ethdev Rx/Tx desc dump API which provides functions for query +descriptor from device. The descriptor info differs in different NICs. +The information demonstrates I/O process which is important for debug. +As the information is different between NICs, the new API is introduced. +The dump format is vendor-specific. Removed Items ------------- diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h index a0e0b2ae88..76808dae89 100644 --- a/lib/ethdev/ethdev_driver.h +++ b/lib/ethdev/ethdev_driver.h @@ -1093,6 +1093,47 @@ typedef int (*eth_rx_queue_avail_thresh_query_t)(struct rte_eth_dev *dev, uint16_t *rx_queue_id, uint8_t *avail_thresh); + +/** + * @internal + * Dump Rx descriptor info to a file. + * + * It is used for debugging, not a dataplane API. + * + * @param file + * A pointer to a file for output. + * @param dev + * Port (ethdev) handle. + * @param queue_id + * The selected queue. + * @param num + * The number of the descriptors to dump. + * @return + * Negative errno value on error, zero on success. + */ +typedef int (*eth_rx_hw_desc_dump_t)(FILE *file, const struct rte_eth_dev *dev, + uint16_t queue_id, uint16_t num); + +/** + * @internal + * Dump Tx descriptor info to a file. + * + * This API is used for debugging, not a dataplane API. + * + * @param file + * A pointer to a file for output. + * @param dev + * Port (ethdev) handle. + * @param queue_id + * The selected queue. + * @param num + * The number of the descriptors to dump. + * @return + * Negative errno value on error, zero on success. + */ +typedef int (*eth_tx_hw_desc_dump_t)(FILE *file, const struct rte_eth_dev *dev, + uint16_t queue_id, uint16_t num); + /** * @internal A structure containing the functions exported by an Ethernet driver. */ @@ -1308,6 +1349,11 @@ 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; + + /** Dump Rx descriptor info */ + eth_rx_hw_desc_dump_t eth_rx_hw_desc_dump; + /** Dump Tx descriptor info */ + eth_tx_hw_desc_dump_t eth_tx_hw_desc_dump; }; /** diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c index 1979dc0850..2093275d87 100644 --- a/lib/ethdev/rte_ethdev.c +++ b/lib/ethdev/rte_ethdev.c @@ -5917,6 +5917,58 @@ rte_eth_dev_priv_dump(uint16_t port_id, FILE *file) return eth_err(port_id, (*dev->dev_ops->eth_dev_priv_dump)(dev, file)); } +int +rte_eth_rx_hw_desc_dump(FILE *file, uint16_t port_id, uint16_t queue_id, + uint16_t num) +{ + struct rte_eth_dev *dev; + int ret; + + if (file == NULL) { + RTE_ETHDEV_LOG(ERR, "Invalid file (NULL)\n"); + return -EINVAL; + } + + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); + dev = &rte_eth_devices[port_id]; + + if (queue_id >= dev->data->nb_rx_queues) { + RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id); + return -EINVAL; + } + + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->eth_rx_hw_desc_dump, -ENOTSUP); + ret = (*dev->dev_ops->eth_rx_hw_desc_dump)(file, dev, queue_id, num); + + return ret; +} + +int +rte_eth_tx_hw_desc_dump(FILE *file, uint16_t port_id, uint16_t queue_id, + uint16_t num) +{ + struct rte_eth_dev *dev; + int ret; + + if (file == NULL) { + RTE_ETHDEV_LOG(ERR, "Invalid file (NULL)\n"); + return -EINVAL; + } + + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); + dev = &rte_eth_devices[port_id]; + + if (queue_id >= dev->data->nb_tx_queues) { + RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", queue_id); + return -EINVAL; + } + + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->eth_tx_hw_desc_dump, -ENOTSUP); + ret = (*dev->dev_ops->eth_tx_hw_desc_dump)(file, dev, queue_id, num); + + return ret; +} + RTE_LOG_REGISTER_DEFAULT(rte_eth_dev_logtype, INFO); RTE_INIT(ethdev_init_telemetry) diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h index b62ac5bb6f..4671e6b28e 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -5221,6 +5221,55 @@ typedef struct { __rte_experimental int rte_eth_dev_priv_dump(uint16_t port_id, FILE *file); +/** + * @warning + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice + * + * Dump ethdev Rx descriptor info to a file. + * + * This API is used for debugging, not a dataplane API. + * + * @param file + * A pointer to a file for output. + * @param dev + * Port (ethdev) handle. + * @param queue_id + * The selected queue. + * @param num + * The number of the descriptors to dump. + * @return + * - On success, zero. + * - On failure, a negative value. + */ +__rte_experimental +int rte_eth_rx_hw_desc_dump(FILE *file, uint16_t port_id, uint16_t queue_id, + uint16_t num); + +/** + * @warning + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice + * + * Dump ethdev Tx descriptor info to a file. + * + * This API is used for debugging, not a dataplane API. + * + * @param file + * A pointer to a file for output. + * @param dev + * Port (ethdev) handle. + * @param queue_id + * The selected queue. + * @param num + * The number of the descriptors to dump. + * @return + * - On success, zero. + * - On failure, a negative value. + */ +__rte_experimental +int rte_eth_tx_hw_desc_dump(FILE *file, uint16_t port_id, uint16_t queue_id, + uint16_t num); + + #include /** diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map index 03f52fee91..3c7c75b582 100644 --- a/lib/ethdev/version.map +++ b/lib/ethdev/version.map @@ -285,6 +285,8 @@ EXPERIMENTAL { rte_mtr_color_in_protocol_priority_get; rte_mtr_color_in_protocol_set; rte_mtr_meter_vlan_table_update; + rte_eth_rx_hw_desc_dump; + rte_eth_tx_hw_desc_dump; }; INTERNAL { -- 2.22.0