From: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
To: Dongdong Liu <liudongdong3@huawei.com>,
"Min Hu (Connor)" <humin29@huawei.com>,
dev@dpdk.org
Cc: Ferruh Yigit <ferruh.yigit@xilinx.com>,
Thomas Monjalon <thomas@monjalon.net>,
Slava Ovsiienko <viacheslavo@nvidia.com>,
Matan Azrad <matan@nvidia.com>,
Jerin Jacob Kollanukkaran <jerinj@marvell.com>,
Qiming Yang <qiming.yang@intel.com>,
Qi Zhang <qi.z.zhang@intel.com>,
Beilei Xing <beilei.xing@intel.com>,
Nithin Dabilpuram <ndabilpuram@marvell.com>,
Kiran Kumar K <kirankumark@marvell.com>,
Sunil Kumar Kori <skori@marvell.com>,
Satha Rao <skoteshwar@marvell.com>,
Stephen Hemminger <sthemmin@microsoft.com>,
Long Li <longli@microsoft.com>,
Ajit Khaparde <ajit.khaparde@broadcom.com>,
Somnath Kotur <somnath.kotur@broadcom.com>
Subject: Re: [PATCH v3 1/4] ethdev: introduce ethdev HW desc dump PI
Date: Wed, 8 Jun 2022 13:09:41 +0300 [thread overview]
Message-ID: <90c20152-9dc7-95f6-4229-434bcbf7cfb8@oktetlabs.ru> (raw)
In-Reply-To: <c877d41c-70f5-e7bf-067d-794c395a7d7a@huawei.com>
Cc various driver maintainers looking for opinion about API discussion
below
On 6/7/22 16:59, Dongdong Liu wrote:
> Hi Andrew
>
> Many thanks for your review.
>
> On 2022/6/2 3:53, Andrew Rybchenko wrote:
>> On 6/1/22 10:49, Min Hu (Connor) wrote:
>>> Added the ethdev HW Rx desc dump API which provides functions for query
>>> HW 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) <humin29@huawei.com>
>>> ---
>>> doc/guides/rel_notes/release_22_07.rst | 7 ++++
>>> lib/ethdev/ethdev_driver.h | 42 ++++++++++++++++++++++++
>>> lib/ethdev/rte_ethdev.c | 44 ++++++++++++++++++++++++++
>>> lib/ethdev/rte_ethdev.h | 44 ++++++++++++++++++++++++++
>>> lib/ethdev/version.map | 2 ++
>>> 5 files changed, 139 insertions(+)
>>>
>>> diff --git a/doc/guides/rel_notes/release_22_07.rst
>>> b/doc/guides/rel_notes/release_22_07.rst
>>> index 8932a1d478..56c675121a 100644
>>> --- a/doc/guides/rel_notes/release_22_07.rst
>>> +++ b/doc/guides/rel_notes/release_22_07.rst
>>> @@ -137,6 +137,13 @@ New Features
>>> * ``RTE_EVENT_QUEUE_ATTR_WEIGHT``
>>> * ``RTE_EVENT_QUEUE_ATTR_AFFINITY``
>>> +* **Added ethdev HW desc dump API, to dump Rx/Tx HW desc info from
>>> device.**
>>> +
>>> + Added the ethdev HW Rx desc dump API which provides functions for
>>> query
>>> + HW 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.
>>> +
>>> Removed Items
>>> -------------
>>> diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
>>> index 69d9dc21d8..9c1726eb2d 100644
>>> --- a/lib/ethdev/ethdev_driver.h
>>> +++ b/lib/ethdev/ethdev_driver.h
>>> @@ -1073,6 +1073,42 @@ typedef int
>>> (*eth_ip_reassembly_conf_set_t)(struct rte_eth_dev *dev,
>>> */
>>> typedef int (*eth_dev_priv_dump_t)(struct rte_eth_dev *dev, FILE
>>> *file);
>>> +/**
>>> + * @internal
>>> + * Dump ethdev Rx descriptor info to a file.
>>
>> ethdev is not required in the description above. It is an ethdev
>> operation type.
>
> Will remove it.
>>
>> Is there any limitations on caller context? Should be it the same
>> CPU core (since typically it is the case for per-queue API) which
>> polls the queue? The answer must be in the API function description.
>
> "[PATCH v3 4/4] app/procinfo: support descriptor dump" shows how to use
> the API. It is used for debug, not a dataplane API, no special
> limitations on caller context.
Please, be explicit in the ethdev API documentation.
>>
>>> + *
>>> + * @param file
>>> + * A pointer to a file for output.
>>> + * @param dev
>>> + * Port (ethdev) handle.
>>> + * @param queue_id
>>> + * The selected queue.
>>> + * @param desc_id
>>> + * The selected descriptor.
>>
>> Is it an ID in the ring regardless of the current position or
>> is it offset relative to current position in the ring?
>> It should be clarified in any case.
>> I'd say that it should be an offset to be consistent with
>> descriptor status API.
>
> It is an ID in the ring regardless of the current position.
IMHO, it is inconvenient since typically it is interesting
what happens nearby current position.
>>
>> It would be useful to be able to dump many descriptor at once.
> This can be done by the appliacation.
Yes, that's true, but easy to do in the driver as well. It would
be especially important if ID semantics changes.
>>
>>> + * @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 desc_id);
>>> +
>>> +/**
>>> + * @internal
>>> + * Dump ethdev Tx descriptor info to a file.
>>> + *
>>> + * @param file
>>> + * A pointer to a file for output.
>>> + * @param dev
>>> + * Port (ethdev) handle.
>>> + * @param queue_id
>>> + * The selected queue.
>>> + * @param desc_id
>>> + * The selected descriptor.
>>> + * @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 desc_id);
>>> +
>>> /**
>>> * @internal A structure containing the functions exported by an
>>> Ethernet driver.
>>> */
>>> @@ -1283,6 +1319,12 @@ struct eth_dev_ops {
>>> /** Dump private info from device */
>>> eth_dev_priv_dump_t eth_dev_priv_dump;
>>> +
>>> + /** Dump ethdev Rx descriptor info */\\
>>
>> It is an ethdev operations. So, 'ethdev' is not necessary in the
>> description.
> Will fix.
>>
>>> + eth_rx_hw_desc_dump_t eth_rx_hw_desc_dump;
>>> +
>>> + /** Dump ethdev 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 46c088dc88..bbd8439fa0 100644
>>> --- a/lib/ethdev/rte_ethdev.c
>>> +++ b/lib/ethdev/rte_ethdev.c
>>> @@ -5876,6 +5876,50 @@ 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 desc_id)
>>> +{
>>> + struct rte_eth_dev *dev;
>>> + int ret;
>>> +
>>> + RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
>>> + dev = &rte_eth_devices[port_id];
>>
>> Shouldn't we check file vs null?
> Yes, will do.
>>
>>> +
>>> + if (queue_id >= dev->data->nb_rx_queues) {
>>> + RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
>>> + return -EINVAL;
>>> + }
>>
>> Don't we need a check vs queue size?
>
> This need to be done in pmd as "[PATCH v3 3/4] net/hns3: support Rx/Tx
> bd dump" shows.
All applicable generic checks must be done on ethdev level to avoid code
duplication and missing checks in PMDs.
Andrew.
next prev parent reply other threads:[~2022-06-08 10:09 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 [this message]
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
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=90c20152-9dc7-95f6-4229-434bcbf7cfb8@oktetlabs.ru \
--to=andrew.rybchenko@oktetlabs.ru \
--cc=ajit.khaparde@broadcom.com \
--cc=beilei.xing@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@xilinx.com \
--cc=humin29@huawei.com \
--cc=jerinj@marvell.com \
--cc=kirankumark@marvell.com \
--cc=liudongdong3@huawei.com \
--cc=longli@microsoft.com \
--cc=matan@nvidia.com \
--cc=ndabilpuram@marvell.com \
--cc=qi.z.zhang@intel.com \
--cc=qiming.yang@intel.com \
--cc=skori@marvell.com \
--cc=skoteshwar@marvell.com \
--cc=somnath.kotur@broadcom.com \
--cc=sthemmin@microsoft.com \
--cc=thomas@monjalon.net \
--cc=viacheslavo@nvidia.com \
/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).