From patchwork Wed Jan 12 11:14:24 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: "humin (Q)" X-Patchwork-Id: 105749 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7F40DA0350; Wed, 12 Jan 2022 12:14:18 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 11950426F1; Wed, 12 Jan 2022 12:14:18 +0100 (CET) Received: from szxga01-in.huawei.com (szxga01-in.huawei.com [45.249.212.187]) by mails.dpdk.org (Postfix) with ESMTP id 2FAC440040 for ; Wed, 12 Jan 2022 12:14:16 +0100 (CET) Received: from dggeme756-chm.china.huawei.com (unknown [172.30.72.53]) by szxga01-in.huawei.com (SkyGuard) with ESMTP id 4JYlL53zM3zcbKV; Wed, 12 Jan 2022 19:13:33 +0800 (CST) Received: from localhost.localdomain (10.69.192.56) by dggeme756-chm.china.huawei.com (10.3.19.102) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.2308.20; Wed, 12 Jan 2022 19:14:12 +0800 From: "Min Hu (Connor)" To: CC: "Min Hu (Connor)" , =?utf-8?q?Morten_Br=C3=B8rup?= , Thomas Monjalon , Ferruh Yigit , Andrew Rybchenko , Ray Kinsella Subject: [RFC v3] ethdev: introduce ethdev dump API Date: Wed, 12 Jan 2022 19:14:24 +0800 Message-ID: <20220112111424.20594-1-humin29@huawei.com> X-Mailer: git-send-email 2.33.0 In-Reply-To: <20220111115437.32855-1-humin29@huawei.com> References: <20220111115437.32855-1-humin29@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.69.192.56] X-ClientProxiedBy: dggems701-chm.china.huawei.com (10.3.19.178) To dggeme756-chm.china.huawei.com (10.3.19.102) 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 Added the ethdev dump API which provides functions for query private info from device. There exists many private properties in different PMD drivers, such as adapter state, Rx/Tx func algorithm in hns3 PMD. The information of these properties is important for debug. As the information is private, the new API is introduced. Signed-off-by: Min Hu (Connor) Acked-by: Morten Brørup Acked-by: Ray Kinsella Acked-by: Ajit Khaparde --- v3: * fix comment. * add rte_eth_dev_priv_dump to version.map file. v2: * fix dump API name * adjust description in doc. --- doc/guides/rel_notes/release_22_03.rst | 7 +++++++ lib/ethdev/ethdev_driver.h | 17 +++++++++++++++++ lib/ethdev/rte_ethdev.c | 15 +++++++++++++++ lib/ethdev/rte_ethdev.h | 16 ++++++++++++++++ lib/ethdev/version.map | 3 +++ 5 files changed, 58 insertions(+) diff --git a/doc/guides/rel_notes/release_22_03.rst b/doc/guides/rel_notes/release_22_03.rst index 6d99d1eaa9..4f97df942d 100644 --- a/doc/guides/rel_notes/release_22_03.rst +++ b/doc/guides/rel_notes/release_22_03.rst @@ -55,6 +55,13 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added the private ethdev dump API, for query private info of ethdev.** + + Added the private ethdev dump API which provides functions for query + private info from device. There exists many private properties in + different PMD drivers. The information of these properties is important + for debug. As the information is private, the new API is introduced. + Removed Items ------------- diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h index d95605a355..0e3d99b07e 100644 --- a/lib/ethdev/ethdev_driver.h +++ b/lib/ethdev/ethdev_driver.h @@ -990,6 +990,20 @@ typedef int (*eth_representor_info_get_t)(struct rte_eth_dev *dev, typedef int (*eth_rx_metadata_negotiate_t)(struct rte_eth_dev *dev, uint64_t *features); +/** + * @internal + * Dump ethdev private info to a file. + * + * @param file + * A pointer to a file for output. + * @param dev + * Port (ethdev) handle. + * + * @return + * Negative errno value on error, positive value on success. + */ +typedef int (*eth_dev_priv_dump_t)(FILE *file, struct rte_eth_dev *dev); + /** * @internal A structure containing the functions exported by an Ethernet driver. */ @@ -1186,6 +1200,9 @@ struct eth_dev_ops { * kinds of metadata to the PMD */ eth_rx_metadata_negotiate_t rx_metadata_negotiate; + + /** Dump ethdev private info */ + eth_dev_priv_dump_t eth_dev_priv_dump; }; /** diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c index a1d475a292..9fc6d91d76 100644 --- a/lib/ethdev/rte_ethdev.c +++ b/lib/ethdev/rte_ethdev.c @@ -6472,6 +6472,21 @@ rte_eth_rx_metadata_negotiate(uint16_t port_id, uint64_t *features) (*dev->dev_ops->rx_metadata_negotiate)(dev, features)); } +int +rte_eth_dev_priv_dump(FILE *file, uint16_t port_id) +{ + struct rte_eth_dev *dev; + int ret; + + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV); + dev = &rte_eth_devices[port_id]; + + RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->eth_dev_priv_dump, -ENOTSUP); + ret = (*dev->dev_ops->eth_dev_priv_dump)(file, dev); + + 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 fa299c8ad7..d17e0f177d 100644 --- a/lib/ethdev/rte_ethdev.h +++ b/lib/ethdev/rte_ethdev.h @@ -5888,6 +5888,22 @@ rte_eth_tx_buffer(uint16_t port_id, uint16_t queue_id, return rte_eth_tx_buffer_flush(port_id, queue_id, buffer); } +/** + * @warning + * @b EXPERIMENTAL: this API may change, or be removed, without prior notice + * + * Dump ethdev private info to a file. + * + * @param file + * A pointer to a file for output. + * @param port_id + * The port identifier of the Ethernet device. + * @return + * Negative errno value on error, positive value on success. + */ +__rte_experimental +int rte_eth_dev_priv_dump(FILE *file, uint16_t port_id); + #ifdef __cplusplus } #endif diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map index c2fb0669a4..f29c60eda4 100644 --- a/lib/ethdev/version.map +++ b/lib/ethdev/version.map @@ -256,6 +256,9 @@ EXPERIMENTAL { rte_flow_flex_item_create; rte_flow_flex_item_release; rte_flow_pick_transfer_proxy; + + # added in 22.03 + rte_eth_dev_priv_dump; }; INTERNAL {