From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
To: Ferruh Yigit <ferruh.yigit@amd.com>,
Dongdong Liu <liudongdong3@huawei.com>,
dev@dpdk.org, thomas@monjalon.net, ferruh.yigit@xilinx.com,
stephen@networkplumber.org, mdr@ashroe.eu
Cc: "Min Hu (Connor)" <humin29@huawei.com>
Subject: Re: [PATCH v4 1/3] ethdev: introduce ethdev desc dump API
Date: Tue, 4 Oct 2022 10:05:16 +0300 [thread overview]
Message-ID: <16a8fa5e-16b5-1499-f225-18a55d4e1b5d@oktetlabs.ru> (raw)
In-Reply-To: <32e4a2fe-e75f-e832-278c-651d5081324a@amd.com>
On 10/4/22 01:40, Ferruh Yigit wrote:
> On 9/23/2022 8:43 AM, Dongdong Liu wrote:
>
>>
>> From: "Min Hu (Connor)" <humin29@huawei.com>
>>
>> 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
>
> Overall OK to have these new APIs, please find comments below.
>
> Do you think does it worth to list this as one of the PMD future in
> future list, in 'doc/guides/nics/features.rst' ?
IMHO it does not deserve entry in features.
It is a deep debugging using vendor-specific information.
>
> between NICs, the new API is introduced.
>>
>> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
>> Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
>> Acked-by: Ray Kinsella <mdr@ashroe.eu>
>
> <...>
>
>> 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);
>
> There are other HW desc related APIs, like
> 'rte_eth_rx_descriptor_status()'.
> Should this APIs follow same naming convention:
> 'rte_eth_rx_descriptor_dump()'
> 'rte_eth_tx_descriptor_dump()'
+1 on naming, it should not be bound to HW. SW parts could be
interesting as well.
>
>> +
>> +/**
>> + * @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);
>
> 'num' is provided, does it assume it starts from offset 0, what do you
> think to provide 'offset' as parameter?
> It may be a use case to start from where tail/head pointer is.
>
>> +
>> +
>> #include <rte_ethdev_core.h>
>>
>> /**
>> 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;
>
> These new APIs should go after "# added in 22.11" comment, if you rebase
> on top of latest HEAD, comment is already there.
>
next prev parent reply other threads:[~2022-10-04 7:05 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-05-27 2:33 [PATCH 0/4] support HW Rx/Tx descriptor dump Min Hu (Connor)
2022-05-27 2:33 ` [PATCH 1/4] ethdev: introduce ethdev HW desc dump PI Min Hu (Connor)
2022-05-27 15:34 ` Stephen Hemminger
2022-05-28 2:21 ` Min Hu (Connor)
2022-05-30 9:17 ` Ray Kinsella
2022-05-30 11:00 ` Min Hu (Connor)
2022-05-30 11:15 ` Ray Kinsella
2022-05-27 2:33 ` [PATCH 2/4] net/hns3: rename hns3 dump files Min Hu (Connor)
2022-05-27 2:33 ` [PATCH 3/4] net/hns3: support Rx/Tx bd dump Min Hu (Connor)
2022-05-27 15:36 ` Stephen Hemminger
2022-05-28 1:47 ` Min Hu (Connor)
2022-05-27 2:33 ` [PATCH 4/4] app/procinfo: support descriptor dump Min Hu (Connor)
2022-05-28 2:19 ` [PATCH v2 0/4] support HW Rx/Tx " Min Hu (Connor)
2022-05-28 2:19 ` [PATCH v2 1/4] ethdev: introduce ethdev HW desc dump PI Min Hu (Connor)
2022-05-28 2:19 ` [PATCH v2 2/4] net/hns3: rename hns3 dump files Min Hu (Connor)
2022-05-28 2:19 ` [PATCH v2 3/4] net/hns3: support Rx/Tx bd dump Min Hu (Connor)
2022-05-28 2:19 ` [PATCH v2 4/4] app/procinfo: support descriptor dump Min Hu (Connor)
2022-06-01 7:49 ` [PATCH v3 0/4] support HW Rx/Tx " Min Hu (Connor)
2022-06-01 7:49 ` [PATCH v3 1/4] ethdev: introduce ethdev HW desc dump PI Min Hu (Connor)
2022-06-01 19:53 ` Andrew Rybchenko
2022-06-07 13:59 ` Dongdong Liu
2022-06-08 10:09 ` Andrew Rybchenko
2022-06-11 9:04 ` Dongdong Liu
2022-06-01 7:49 ` [PATCH v3 2/4] net/hns3: rename hns3 dump files Min Hu (Connor)
2022-06-01 7:49 ` [PATCH v3 3/4] net/hns3: support Rx/Tx bd dump Min Hu (Connor)
2022-06-01 7:49 ` [PATCH v3 4/4] app/procinfo: support descriptor dump Min Hu (Connor)
2022-06-01 18:26 ` [PATCH v3 0/4] support HW Rx/Tx " Andrew Rybchenko
2022-06-01 18:48 ` Ray Kinsella
2022-06-07 14:02 ` Dongdong Liu
2022-06-02 13:27 ` Andrew Rybchenko
2022-06-07 14:01 ` Dongdong Liu
2022-09-23 7:43 ` [PATCH v4 0/3] support ethdev " Dongdong Liu
2022-09-23 7:43 ` [PATCH v4 1/3] ethdev: introduce ethdev desc dump API Dongdong Liu
2022-10-03 22:40 ` Ferruh Yigit
2022-10-04 7:05 ` Andrew Rybchenko [this message]
2022-10-06 8:26 ` Dongdong Liu
2022-10-06 17:13 ` Stephen Hemminger
2022-10-07 11:24 ` Ferruh Yigit
2022-09-23 7:43 ` [PATCH v4 2/3] net/hns3: support Rx/Tx bd dump Dongdong Liu
2022-09-23 7:43 ` [PATCH v4 3/3] app/procinfo: support descriptor dump Dongdong Liu
2022-09-23 12:18 ` Pattan, Reshma
2022-09-24 8:41 ` Dongdong Liu
2022-10-06 12:05 ` [PATCH v5 0/3] support ethdev Rx/Tx " Dongdong Liu
2022-10-06 12:05 ` [PATCH v5 1/3] ethdev: introduce ethdev desc dump API Dongdong Liu
2022-10-06 16:39 ` Ferruh Yigit
2022-10-06 12:05 ` [PATCH v5 2/3] net/hns3: support Rx/Tx bd dump Dongdong Liu
2022-10-06 16:40 ` Ferruh Yigit
2022-10-06 12:05 ` [PATCH v5 3/3] app/procinfo: support descriptor dump Dongdong Liu
2022-10-07 14:43 ` Pattan, Reshma
2022-10-08 9:46 ` Dongdong Liu
2022-10-06 16:42 ` [PATCH v5 0/3] support ethdev Rx/Tx " Ferruh Yigit
2022-10-08 11:11 ` Dongdong Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=16a8fa5e-16b5-1499-f225-18a55d4e1b5d@oktetlabs.ru \
--to=andrew.rybchenko@oktetlabs.ru \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@amd.com \
--cc=ferruh.yigit@xilinx.com \
--cc=humin29@huawei.com \
--cc=liudongdong3@huawei.com \
--cc=mdr@ashroe.eu \
--cc=stephen@networkplumber.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).