DPDK patches and discussions
 help / color / mirror / Atom feed
* [RFC] ethdev: introduce ethdev dump API
@ 2022-01-11 11:54 Min Hu (Connor)
  2022-01-11 12:10 ` Morten Brørup
                   ` (3 more replies)
  0 siblings, 4 replies; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-11 11:54 UTC (permalink / raw)
  To: dev; +Cc: ferruh.yigit, thomas

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) <humin29@huawei.com>
---
 doc/guides/rel_notes/release_22_03.rst |  6 ++++++
 lib/ethdev/ethdev_driver.h             | 17 +++++++++++++++++
 lib/ethdev/rte_ethdev.c                | 15 +++++++++++++++
 lib/ethdev/rte_ethdev.h                | 16 ++++++++++++++++
 4 files changed, 54 insertions(+)

diff --git a/doc/guides/rel_notes/release_22_03.rst b/doc/guides/rel_notes/release_22_03.rst
index 6d99d1eaa9..9b51da899a 100644
--- a/doc/guides/rel_notes/release_22_03.rst
+++ b/doc/guides/rel_notes/release_22_03.rst
@@ -55,6 +55,12 @@ New Features
      Also, make sure to start the actual text at the margin.
      =======================================================
 
+   * **Added the ethdev dump API, for query private info of ethdev.**
+
+     Added the 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..ac7fa5eae2 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
+ * Get ethdev private info.
+ *
+ * @param dev
+ *   Port (ethdev) handle.
+ * @param file
+ *   A pointer to a file for output.
+ *
+ * @return
+ *   Negative errno value on error, positive value on success.
+ */
+typedef int (*eth_dev_dump_t)(struct rte_eth_dev *dev, FILE *file);
+
 /**
  * @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_dump_t eth_dev_dump;
 };
 
 /**
diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index a1d475a292..4bbe444045 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_dump(uint16_t port_id, FILE *file)
+{
+	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_dump, -ENOTSUP);
+	ret = (*dev->dev_ops->eth_dev_dump)(dev, file);
+
+	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..918bd3116f 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
+ *
+ * Get ethdev private info.
+ *
+ * @param port_id
+ *   The port identifier of the Ethernet device.
+ * @param file
+ *   A pointer to a file for output.
+ * @return
+ *   Negative errno value on error, positive value on success.
+ */
+__rte_experimental
+int rte_eth_dev_dump(uint16_t port_id, FILE *file);
+
 #ifdef __cplusplus
 }
 #endif
-- 
2.33.0


^ permalink raw reply	[flat|nested] 20+ messages in thread

* RE: [RFC] ethdev: introduce ethdev dump API
  2022-01-11 11:54 [RFC] ethdev: introduce ethdev dump API Min Hu (Connor)
@ 2022-01-11 12:10 ` Morten Brørup
  2022-01-12  2:40   ` Min Hu (Connor)
  2022-01-11 12:48 ` Thomas Monjalon
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 20+ messages in thread
From: Morten Brørup @ 2022-01-11 12:10 UTC (permalink / raw)
  To: Min Hu (Connor); +Cc: ferruh.yigit, thomas, dev

> From: Min Hu (Connor) [mailto:humin29@huawei.com]
> Sent: Tuesday, 11 January 2022 12.55
> 
> 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) <humin29@huawei.com>
> ---
>  doc/guides/rel_notes/release_22_03.rst |  6 ++++++
>  lib/ethdev/ethdev_driver.h             | 17 +++++++++++++++++
>  lib/ethdev/rte_ethdev.c                | 15 +++++++++++++++
>  lib/ethdev/rte_ethdev.h                | 16 ++++++++++++++++
>  4 files changed, 54 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_22_03.rst
> b/doc/guides/rel_notes/release_22_03.rst
> index 6d99d1eaa9..9b51da899a 100644
> --- a/doc/guides/rel_notes/release_22_03.rst
> +++ b/doc/guides/rel_notes/release_22_03.rst
> @@ -55,6 +55,12 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =======================================================
> 
> +   * **Added the ethdev dump API, for query private info of ethdev.**
> +
> +     Added the 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..ac7fa5eae2 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
> + * Get ethdev private info.
> + *
> + * @param dev
> + *   Port (ethdev) handle.
> + * @param file
> + *   A pointer to a file for output.
> + *
> + * @return
> + *   Negative errno value on error, positive value on success.
> + */
> +typedef int (*eth_dev_dump_t)(struct rte_eth_dev *dev, FILE *file);
> +
>  /**
>   * @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_dump_t eth_dev_dump;
>  };
> 
>  /**
> diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
> index a1d475a292..4bbe444045 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_dump(uint16_t port_id, FILE *file)
> +{
> +	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_dump, -ENOTSUP);
> +	ret = (*dev->dev_ops->eth_dev_dump)(dev, file);
> +
> +	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..918bd3116f 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
> + *
> + * Get ethdev private info.
> + *
> + * @param port_id
> + *   The port identifier of the Ethernet device.
> + * @param file
> + *   A pointer to a file for output.
> + * @return
> + *   Negative errno value on error, positive value on success.
> + */
> +__rte_experimental
> +int rte_eth_dev_dump(uint16_t port_id, FILE *file);
> +
>  #ifdef __cplusplus
>  }
>  #endif
> --
> 2.33.0
> 

Good idea.

Two comments:

1. This function dumps private ethdev information. It should be named and described as such, e.g. eth_dev_priv_dump().

It should be a generic ethdev dump function, which dumps the common ethdev information, and also calls the eth_dev_priv_dump() function, if present.

2. Please make FILE* the first parameter, like similar dump functions.



^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC] ethdev: introduce ethdev dump API
  2022-01-11 11:54 [RFC] ethdev: introduce ethdev dump API Min Hu (Connor)
  2022-01-11 12:10 ` Morten Brørup
@ 2022-01-11 12:48 ` Thomas Monjalon
  2022-01-12  2:41   ` Min Hu (Connor)
  2022-01-12  2:44   ` Min Hu (Connor)
  2022-01-12  2:40 ` [RFC v2] " Min Hu (Connor)
  2022-01-12 11:14 ` [RFC v3] " Min Hu (Connor)
  3 siblings, 2 replies; 20+ messages in thread
From: Thomas Monjalon @ 2022-01-11 12:48 UTC (permalink / raw)
  To: Min Hu (Connor); +Cc: dev, ferruh.yigit, andrew.rybchenko

Please use --cc-cmd devtools/get-maintainer.sh so all maintainers are Cc'ed.

11/01/2022 12:54, Min Hu (Connor):
> --- a/doc/guides/rel_notes/release_22_03.rst
> +++ b/doc/guides/rel_notes/release_22_03.rst
> @@ -55,6 +55,12 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =======================================================
>  
> +   * **Added the ethdev dump API, for query private info of ethdev.**
> +
> +     Added the 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.
>  

A blank line is missing.
Also please check the comment above asking to start the actual text at the margin.

[...]
> +typedef int (*eth_dev_dump_t)(struct rte_eth_dev *dev, FILE *file);

There is a dump function for rte_flow: rte_flow_dev_dump().
This one should have a clear scope: private device infos?




^ permalink raw reply	[flat|nested] 20+ messages in thread

* [RFC v2] ethdev: introduce ethdev dump API
  2022-01-11 11:54 [RFC] ethdev: introduce ethdev dump API Min Hu (Connor)
  2022-01-11 12:10 ` Morten Brørup
  2022-01-11 12:48 ` Thomas Monjalon
@ 2022-01-12  2:40 ` Min Hu (Connor)
  2022-01-12  7:20   ` Morten Brørup
  2022-01-12 11:14 ` [RFC v3] " Min Hu (Connor)
  3 siblings, 1 reply; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-12  2:40 UTC (permalink / raw)
  To: dev; +Cc: ferruh.yigit, thomas

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) <humin29@huawei.com>
---
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 ++++++++++++++++
 4 files changed, 55 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..e75ff3f15b 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
+ * Get ethdev private info.
+ *
+ * @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..8e33e6927f 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
+ *
+ * Get ethdev private info.
+ *
+ * @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
-- 
2.33.0


^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC] ethdev: introduce ethdev dump API
  2022-01-11 12:10 ` Morten Brørup
@ 2022-01-12  2:40   ` Min Hu (Connor)
  0 siblings, 0 replies; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-12  2:40 UTC (permalink / raw)
  To: Morten Brørup; +Cc: ferruh.yigit, thomas, dev

Hi, Morten,
	thanks for your reply, all is fixed in v2.

在 2022/1/11 20:10, Morten Brørup 写道:
>> From: Min Hu (Connor) [mailto:humin29@huawei.com]
>> Sent: Tuesday, 11 January 2022 12.55
>>
>> 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) <humin29@huawei.com>
>> ---
>>   doc/guides/rel_notes/release_22_03.rst |  6 ++++++
>>   lib/ethdev/ethdev_driver.h             | 17 +++++++++++++++++
>>   lib/ethdev/rte_ethdev.c                | 15 +++++++++++++++
>>   lib/ethdev/rte_ethdev.h                | 16 ++++++++++++++++
>>   4 files changed, 54 insertions(+)
>>
>> diff --git a/doc/guides/rel_notes/release_22_03.rst
>> b/doc/guides/rel_notes/release_22_03.rst
>> index 6d99d1eaa9..9b51da899a 100644
>> --- a/doc/guides/rel_notes/release_22_03.rst
>> +++ b/doc/guides/rel_notes/release_22_03.rst
>> @@ -55,6 +55,12 @@ New Features
>>        Also, make sure to start the actual text at the margin.
>>        =======================================================
>>
>> +   * **Added the ethdev dump API, for query private info of ethdev.**
>> +
>> +     Added the 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..ac7fa5eae2 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
>> + * Get ethdev private info.
>> + *
>> + * @param dev
>> + *   Port (ethdev) handle.
>> + * @param file
>> + *   A pointer to a file for output.
>> + *
>> + * @return
>> + *   Negative errno value on error, positive value on success.
>> + */
>> +typedef int (*eth_dev_dump_t)(struct rte_eth_dev *dev, FILE *file);
>> +
>>   /**
>>    * @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_dump_t eth_dev_dump;
>>   };
>>
>>   /**
>> diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
>> index a1d475a292..4bbe444045 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_dump(uint16_t port_id, FILE *file)
>> +{
>> +	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_dump, -ENOTSUP);
>> +	ret = (*dev->dev_ops->eth_dev_dump)(dev, file);
>> +
>> +	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..918bd3116f 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
>> + *
>> + * Get ethdev private info.
>> + *
>> + * @param port_id
>> + *   The port identifier of the Ethernet device.
>> + * @param file
>> + *   A pointer to a file for output.
>> + * @return
>> + *   Negative errno value on error, positive value on success.
>> + */
>> +__rte_experimental
>> +int rte_eth_dev_dump(uint16_t port_id, FILE *file);
>> +
>>   #ifdef __cplusplus
>>   }
>>   #endif
>> --
>> 2.33.0
>>
> 
> Good idea.
> 
> Two comments:
> 
> 1. This function dumps private ethdev information. It should be named and described as such, e.g. eth_dev_priv_dump().
> 
> It should be a generic ethdev dump function, which dumps the common ethdev information, and also calls the eth_dev_priv_dump() function, if present.
> 
> 2. Please make FILE* the first parameter, like similar dump functions.
> 
> 
> .
> 

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC] ethdev: introduce ethdev dump API
  2022-01-11 12:48 ` Thomas Monjalon
@ 2022-01-12  2:41   ` Min Hu (Connor)
  2022-01-12  2:44   ` Min Hu (Connor)
  1 sibling, 0 replies; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-12  2:41 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev, ferruh.yigit, andrew.rybchenko

Hi, Thomas,
	fixed in v2, thanks.

在 2022/1/11 20:48, Thomas Monjalon 写道:
> Please use --cc-cmd devtools/get-maintainer.sh so all maintainers are Cc'ed.
> 
> 11/01/2022 12:54, Min Hu (Connor):
>> --- a/doc/guides/rel_notes/release_22_03.rst
>> +++ b/doc/guides/rel_notes/release_22_03.rst
>> @@ -55,6 +55,12 @@ New Features
>>        Also, make sure to start the actual text at the margin.
>>        =======================================================
>>   
>> +   * **Added the ethdev dump API, for query private info of ethdev.**
>> +
>> +     Added the 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.
>>   
> 
> A blank line is missing.
> Also please check the comment above asking to start the actual text at the margin.
> 
> [...]
>> +typedef int (*eth_dev_dump_t)(struct rte_eth_dev *dev, FILE *file);
> 
> There is a dump function for rte_flow: rte_flow_dev_dump().
> This one should have a clear scope: private device infos?
> 
> 
> 
> .
> 

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC] ethdev: introduce ethdev dump API
  2022-01-11 12:48 ` Thomas Monjalon
  2022-01-12  2:41   ` Min Hu (Connor)
@ 2022-01-12  2:44   ` Min Hu (Connor)
  2022-01-12 10:13     ` Thomas Monjalon
  1 sibling, 1 reply; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-12  2:44 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev, ferruh.yigit, andrew.rybchenko

Hi, Thomas,

在 2022/1/11 20:48, Thomas Monjalon 写道:
> Please use --cc-cmd devtools/get-maintainer.sh so all maintainers are Cc'edlike this ?
  git send-email -to dev@dpdk.org -cc ferruh.yigit@intel.com -cc 
thomas@monjalon.net --cc-cmd devtools/get-maintainer.sh  *.patch 
--suppress-cc=all

I did this, but it doesn't work. It only Cc ferruh and you.


> 
> 11/01/2022 12:54, Min Hu (Connor):
>> --- a/doc/guides/rel_notes/release_22_03.rst
>> +++ b/doc/guides/rel_notes/release_22_03.rst
>> @@ -55,6 +55,12 @@ New Features
>>        Also, make sure to start the actual text at the margin.
>>        =======================================================
>>   
>> +   * **Added the ethdev dump API, for query private info of ethdev.**
>> +
>> +     Added the 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.
>>   
> 
> A blank line is missing.
> Also please check the comment above asking to start the actual text at the margin.
> 
> [...]
>> +typedef int (*eth_dev_dump_t)(struct rte_eth_dev *dev, FILE *file);
> 
> There is a dump function for rte_flow: rte_flow_dev_dump().
> This one should have a clear scope: private device infos?
> 
> 
> 
> .
> 

^ permalink raw reply	[flat|nested] 20+ messages in thread

* RE: [RFC v2] ethdev: introduce ethdev dump API
  2022-01-12  2:40 ` [RFC v2] " Min Hu (Connor)
@ 2022-01-12  7:20   ` Morten Brørup
  2022-01-12 11:15     ` Min Hu (Connor)
  0 siblings, 1 reply; 20+ messages in thread
From: Morten Brørup @ 2022-01-12  7:20 UTC (permalink / raw)
  To: Min Hu (Connor), dev; +Cc: ferruh.yigit, thomas

> From: Min Hu (Connor) [mailto:humin29@huawei.com]
> Sent: Wednesday, 12 January 2022 03.40
> 
> 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) <humin29@huawei.com>
> ---
> 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 ++++++++++++++++
>  4 files changed, 55 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..e75ff3f15b 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
> + * Get ethdev private info.

Suggestion: 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..8e33e6927f 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
> + *
> + * Get ethdev private info.

Suggestion: 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
> --
> 2.33.0
> 

You should probably also add rte_eth_dev_priv_dump to the EXPERIMENTAL section of the version.map file.

Acked-by: Morten Brørup <mb@smartsharesystems.com>


^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC] ethdev: introduce ethdev dump API
  2022-01-12  2:44   ` Min Hu (Connor)
@ 2022-01-12 10:13     ` Thomas Monjalon
  2022-01-12 10:56       ` Min Hu (Connor)
  0 siblings, 1 reply; 20+ messages in thread
From: Thomas Monjalon @ 2022-01-12 10:13 UTC (permalink / raw)
  To: Min Hu (Connor); +Cc: dev, ferruh.yigit, andrew.rybchenko

12/01/2022 03:44, Min Hu (Connor):
> Hi, Thomas,
> 
> 在 2022/1/11 20:48, Thomas Monjalon 写道:
> > Please use --cc-cmd devtools/get-maintainer.sh so all maintainers are Cc'edlike this ?
>   git send-email -to dev@dpdk.org -cc ferruh.yigit@intel.com -cc 
> thomas@monjalon.net --cc-cmd devtools/get-maintainer.sh  *.patch 
> --suppress-cc=all
> 
> I did this, but it doesn't work. It only Cc ferruh and you.

You should read the documentation about the tools:
https://doc.dpdk.org/guides/contributing/patches.html#checking-the-patches

In my file ~/.config/dpdk/devel.config, I have these lines:
export DPDK_GETMAINTAINER_PATH=$root/linux/scripts/get_maintainer.pl
export DPDK_CHECKPATCH_PATH=$root/linux/scripts/checkpatch.pl
export DPDK_CHECKPATCH_CODESPELL=$root/codespell/dictionary.txt

Did you set DPDK_GETMAINTAINER_PATH?



^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC] ethdev: introduce ethdev dump API
  2022-01-12 10:13     ` Thomas Monjalon
@ 2022-01-12 10:56       ` Min Hu (Connor)
  0 siblings, 0 replies; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-12 10:56 UTC (permalink / raw)
  To: Thomas Monjalon; +Cc: dev, ferruh.yigit, andrew.rybchenko

Thanks Thomas, I will have a try.

在 2022/1/12 18:13, Thomas Monjalon 写道:
> 12/01/2022 03:44, Min Hu (Connor):
>> Hi, Thomas,
>>
>> 在 2022/1/11 20:48, Thomas Monjalon 写道:
>>> Please use --cc-cmd devtools/get-maintainer.sh so all maintainers are Cc'edlike this ?
>>    git send-email -to dev@dpdk.org -cc ferruh.yigit@intel.com -cc
>> thomas@monjalon.net --cc-cmd devtools/get-maintainer.sh  *.patch
>> --suppress-cc=all
>>
>> I did this, but it doesn't work. It only Cc ferruh and you.
> 
> You should read the documentation about the tools:
> https://doc.dpdk.org/guides/contributing/patches.html#checking-the-patches
> 
> In my file ~/.config/dpdk/devel.config, I have these lines:
> export DPDK_GETMAINTAINER_PATH=$root/linux/scripts/get_maintainer.pl
> export DPDK_CHECKPATCH_PATH=$root/linux/scripts/checkpatch.pl
> export DPDK_CHECKPATCH_CODESPELL=$root/codespell/dictionary.txt
> 
> Did you set DPDK_GETMAINTAINER_PATH?
> 
> 
> .
> 

^ permalink raw reply	[flat|nested] 20+ messages in thread

* [RFC v3] ethdev: introduce ethdev dump API
  2022-01-11 11:54 [RFC] ethdev: introduce ethdev dump API Min Hu (Connor)
                   ` (2 preceding siblings ...)
  2022-01-12  2:40 ` [RFC v2] " Min Hu (Connor)
@ 2022-01-12 11:14 ` Min Hu (Connor)
  2022-01-12 12:05   ` Ray Kinsella
  3 siblings, 1 reply; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-12 11:14 UTC (permalink / raw)
  To: dev
  Cc: Min Hu (Connor),
	Morten Brørup, Thomas Monjalon, Ferruh Yigit,
	Andrew Rybchenko, Ray Kinsella

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset="y", Size: 4529 bytes --]

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) <humin29@huawei.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
---
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 {
-- 
2.33.0


^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v2] ethdev: introduce ethdev dump API
  2022-01-12  7:20   ` Morten Brørup
@ 2022-01-12 11:15     ` Min Hu (Connor)
  2022-01-14 17:56       ` Ajit Khaparde
  0 siblings, 1 reply; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-12 11:15 UTC (permalink / raw)
  To: Morten Brørup, dev; +Cc: ferruh.yigit, thomas

Thanks Morten, fixed in v3.

在 2022/1/12 15:20, Morten Brørup 写道:
>> From: Min Hu (Connor) [mailto:humin29@huawei.com]
>> Sent: Wednesday, 12 January 2022 03.40
>>
>> 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) <humin29@huawei.com>
>> ---
>> 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 ++++++++++++++++
>>   4 files changed, 55 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..e75ff3f15b 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
>> + * Get ethdev private info.
> 
> Suggestion: 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..8e33e6927f 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
>> + *
>> + * Get ethdev private info.
> 
> Suggestion: 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
>> --
>> 2.33.0
>>
> 
> You should probably also add rte_eth_dev_priv_dump to the EXPERIMENTAL section of the version.map file.
> 
> Acked-by: Morten Brørup <mb@smartsharesystems.com>
> 
> .
> 

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v3] ethdev: introduce ethdev dump API
  2022-01-12 11:14 ` [RFC v3] " Min Hu (Connor)
@ 2022-01-12 12:05   ` Ray Kinsella
  2022-01-18 15:34     ` Ajit Khaparde
  0 siblings, 1 reply; 20+ messages in thread
From: Ray Kinsella @ 2022-01-12 12:05 UTC (permalink / raw)
  To: Min Hu (Connor)
  Cc: dev, Morten Brørup, Thomas Monjalon, Ferruh Yigit, Andrew Rybchenko


Min Hu (Connor) <humin29@huawei.com> writes:

> 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) <humin29@huawei.com>
> Acked-by: Morten BrÞrup <mb@smartsharesystems.com>
> ---
> 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(+)
>

Acked-by: Ray Kinsella <mdr@ashroe.eu>

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v2] ethdev: introduce ethdev dump API
  2022-01-12 11:15     ` Min Hu (Connor)
@ 2022-01-14 17:56       ` Ajit Khaparde
  2022-01-15  0:24         ` Min Hu (Connor)
  0 siblings, 1 reply; 20+ messages in thread
From: Ajit Khaparde @ 2022-01-14 17:56 UTC (permalink / raw)
  To: Min Hu (Connor)
  Cc: Morten Brørup, dpdk-dev, Ferruh Yigit, Thomas Monjalon

On Wed, Jan 12, 2022 at 3:15 AM Min Hu (Connor) <humin29@huawei.com> wrote:
>
> Thanks Morten, fixed in v3.
>
> 在 2022/1/12 15:20, Morten Brørup 写道:
> >> From: Min Hu (Connor) [mailto:humin29@huawei.com]
> >> Sent: Wednesday, 12 January 2022 03.40
> >>
> >> 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.
Do you have any changes to testpmd to use this API?

> >>
> >> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
> >> ---
> >> 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 ++++++++++++++++
> >>   4 files changed, 55 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..e75ff3f15b 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
> >> + * Get ethdev private info.
> >
> > Suggestion: 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..8e33e6927f 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
> >> + *
> >> + * Get ethdev private info.
> >
> > Suggestion: 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
> >> --
> >> 2.33.0
> >>
> >
> > You should probably also add rte_eth_dev_priv_dump to the EXPERIMENTAL section of the version.map file.
> >
> > Acked-by: Morten Brørup <mb@smartsharesystems.com>
> >
> > .
> >

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v2] ethdev: introduce ethdev dump API
  2022-01-14 17:56       ` Ajit Khaparde
@ 2022-01-15  0:24         ` Min Hu (Connor)
  2022-01-18 15:33           ` Ajit Khaparde
  0 siblings, 1 reply; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-15  0:24 UTC (permalink / raw)
  To: Ajit Khaparde; +Cc: Morten Brørup, dpdk-dev, Ferruh Yigit, Thomas Monjalon

Hi, Ajit,

在 2022/1/15 1:56, Ajit Khaparde 写道:
> On Wed, Jan 12, 2022 at 3:15 AM Min Hu (Connor) <humin29@huawei.com> wrote:
>>
>> Thanks Morten, fixed in v3.
>>
>> 在 2022/1/12 15:20, Morten Brørup 写道:
>>>> From: Min Hu (Connor) [mailto:humin29@huawei.com]
>>>> Sent: Wednesday, 12 January 2022 03.40
>>>>
>>>> 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.
> Do you have any changes to testpmd to use this API?
> 
No changes to testpmd.
BTW, I will add some options for proc-info to use this API,
and this is my next-step plan.

>>>>
>>>> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
>>>> ---
>>>> 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 ++++++++++++++++
>>>>    4 files changed, 55 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..e75ff3f15b 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
>>>> + * Get ethdev private info.
>>>
>>> Suggestion: 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..8e33e6927f 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
>>>> + *
>>>> + * Get ethdev private info.
>>>
>>> Suggestion: 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
>>>> --
>>>> 2.33.0
>>>>
>>>
>>> You should probably also add rte_eth_dev_priv_dump to the EXPERIMENTAL section of the version.map file.
>>>
>>> Acked-by: Morten Brørup <mb@smartsharesystems.com>
>>>
>>> .
>>>
> .
> 

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v2] ethdev: introduce ethdev dump API
  2022-01-15  0:24         ` Min Hu (Connor)
@ 2022-01-18 15:33           ` Ajit Khaparde
  0 siblings, 0 replies; 20+ messages in thread
From: Ajit Khaparde @ 2022-01-18 15:33 UTC (permalink / raw)
  To: Min Hu (Connor)
  Cc: Morten Brørup, dpdk-dev, Ferruh Yigit, Thomas Monjalon

On Fri, Jan 14, 2022 at 4:25 PM Min Hu (Connor) <humin29@huawei.com> wrote:
>
> Hi, Ajit,
>
> 在 2022/1/15 1:56, Ajit Khaparde 写道:
> > On Wed, Jan 12, 2022 at 3:15 AM Min Hu (Connor) <humin29@huawei.com> wrote:
> >>
> >> Thanks Morten, fixed in v3.
> >>
> >> 在 2022/1/12 15:20, Morten Brørup 写道:
> >>>> From: Min Hu (Connor) [mailto:humin29@huawei.com]
> >>>> Sent: Wednesday, 12 January 2022 03.40
> >>>>
> >>>> 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.
> > Do you have any changes to testpmd to use this API?
> >
> No changes to testpmd.
> BTW, I will add some options for proc-info to use this API,
> and this is my next-step plan.
Ok. proc-info is a good place for this.

>
> >>>>
> >>>> Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
> >>>> ---
> >>>> 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 ++++++++++++++++
> >>>>    4 files changed, 55 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..e75ff3f15b 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
> >>>> + * Get ethdev private info.
> >>>
> >>> Suggestion: 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..8e33e6927f 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
> >>>> + *
> >>>> + * Get ethdev private info.
> >>>
> >>> Suggestion: 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
> >>>> --
> >>>> 2.33.0
> >>>>
> >>>
> >>> You should probably also add rte_eth_dev_priv_dump to the EXPERIMENTAL section of the version.map file.
> >>>
> >>> Acked-by: Morten Brørup <mb@smartsharesystems.com>
> >>>
> >>> .
> >>>
> > .
> >

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v3] ethdev: introduce ethdev dump API
  2022-01-12 12:05   ` Ray Kinsella
@ 2022-01-18 15:34     ` Ajit Khaparde
  2022-01-25 12:56       ` Ferruh Yigit
  0 siblings, 1 reply; 20+ messages in thread
From: Ajit Khaparde @ 2022-01-18 15:34 UTC (permalink / raw)
  To: Ray Kinsella
  Cc: Min Hu (Connor),
	dpdk-dev, Morten Brørup, Thomas Monjalon, Ferruh Yigit,
	Andrew Rybchenko

On Wed, Jan 12, 2022 at 4:06 AM Ray Kinsella <mdr@ashroe.eu> wrote:
>
>
> Min Hu (Connor) <humin29@huawei.com> writes:
>
> > 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) <humin29@huawei.com>
> > Acked-by: Morten BrÞrup <mb@smartsharesystems.com>
> > ---
> > 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(+)
> >
>
> Acked-by: Ray Kinsella <mdr@ashroe.eu>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v3] ethdev: introduce ethdev dump API
  2022-01-18 15:34     ` Ajit Khaparde
@ 2022-01-25 12:56       ` Ferruh Yigit
  2022-01-25 12:58         ` Ferruh Yigit
  0 siblings, 1 reply; 20+ messages in thread
From: Ferruh Yigit @ 2022-01-25 12:56 UTC (permalink / raw)
  To: Ajit Khaparde, Ray Kinsella
  Cc: Min Hu (Connor),
	dpdk-dev, Morten Brørup, Thomas Monjalon, Andrew Rybchenko,
	Loftus, Ciara

On 1/18/2022 3:34 PM, Ajit Khaparde wrote:
> On Wed, Jan 12, 2022 at 4:06 AM Ray Kinsella <mdr@ashroe.eu> wrote:
>>
>>
>> Min Hu (Connor) <humin29@huawei.com> writes:
>>
>>> 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) <humin29@huawei.com>
>>> Acked-by: Morten BrÞrup <mb@smartsharesystems.com>
>>> ---
>>> 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(+)
>>>
>>
>> Acked-by: Ray Kinsella <mdr@ashroe.eu>
> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>


I have a concern and this "private info", it can be useful for debug
but still it will lead to a PMD specific applications, I wonder if some
common information can be provided. Is there any list in your mind what
can be part of this private info?

Also why not use existing xstats or telemetry to get more data from the
drivers?
As synced with Ciara (cc'ed), she mentioned more information can be get
via registering callbacks to ethdev.

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v3] ethdev: introduce ethdev dump API
  2022-01-25 12:56       ` Ferruh Yigit
@ 2022-01-25 12:58         ` Ferruh Yigit
  2022-01-25 13:45           ` Min Hu (Connor)
  0 siblings, 1 reply; 20+ messages in thread
From: Ferruh Yigit @ 2022-01-25 12:58 UTC (permalink / raw)
  To: Ajit Khaparde, Ray Kinsella
  Cc: Min Hu (Connor),
	dpdk-dev, Morten Brørup, Thomas Monjalon, Andrew Rybchenko,
	Loftus, Ciara, Ciara Power

On 1/25/2022 12:56 PM, Ferruh Yigit wrote:
> On 1/18/2022 3:34 PM, Ajit Khaparde wrote:
>> On Wed, Jan 12, 2022 at 4:06 AM Ray Kinsella <mdr@ashroe.eu> wrote:
>>>
>>>
>>> Min Hu (Connor) <humin29@huawei.com> writes:
>>>
>>>> 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) <humin29@huawei.com>
>>>> Acked-by: Morten BrÞrup <mb@smartsharesystems.com>
>>>> ---
>>>> 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(+)
>>>>
>>>
>>> Acked-by: Ray Kinsella <mdr@ashroe.eu>
>> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> 
> 
> I have a concern and this "private info", it can be useful for debug
> but still it will lead to a PMD specific applications, I wonder if some
> common information can be provided. Is there any list in your mind what
> can be part of this private info?
> 
> Also why not use existing xstats or telemetry to get more data from the
> drivers?
> As synced with Ciara (cc'ed), she mentioned more information can be get
> via registering callbacks to ethdev.

Opps, Ciara (Power) cc'ed now.

^ permalink raw reply	[flat|nested] 20+ messages in thread

* Re: [RFC v3] ethdev: introduce ethdev dump API
  2022-01-25 12:58         ` Ferruh Yigit
@ 2022-01-25 13:45           ` Min Hu (Connor)
  0 siblings, 0 replies; 20+ messages in thread
From: Min Hu (Connor) @ 2022-01-25 13:45 UTC (permalink / raw)
  To: Ferruh Yigit, Ajit Khaparde, Ray Kinsella
  Cc: dpdk-dev, Morten Brørup, Thomas Monjalon, Andrew Rybchenko,
	Loftus, Ciara, Ciara Power

Hi, Ferruh,

在 2022/1/25 20:58, Ferruh Yigit 写道:
> On 1/25/2022 12:56 PM, Ferruh Yigit wrote:
>> On 1/18/2022 3:34 PM, Ajit Khaparde wrote:
>>> On Wed, Jan 12, 2022 at 4:06 AM Ray Kinsella <mdr@ashroe.eu> wrote:
>>>>
>>>>
>>>> Min Hu (Connor) <humin29@huawei.com> writes:
>>>>
>>>>> 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) <humin29@huawei.com>
>>>>> Acked-by: Morten BrÞrup <mb@smartsharesystems.com>
>>>>> ---
>>>>> 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(+)
>>>>>
>>>>
>>>> Acked-by: Ray Kinsella <mdr@ashroe.eu>
>>> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
>>
>>
>> I have a concern and this "private info", it can be useful for debug
>> but still it will lead to a PMD specific applications, I wonder if some
>> common information can be provided.
The purpose of introducing the API is to enhance dump ability for NICs.
It will be used in APP proc-info, I will add "show-port-private" option
for it. As for common information, I will add them in "show-port" option
which already exists.


  Is there any list in your mind what
>> can be part of this private info?
Private info for NICs, take HNS3 PMD NICS as an example,
   - Dev Capability:
           -- support DCB: no
           -- support COPPER: no
           -- support FD QUEUE REGION: no
           -- support PTP: no
           -- support TX PUSH: no
           -- support INDEP TXRX: no
           -- support STASH: no
           -- support SIMPLE BD: no
           -- support RXD Advanced Layout: no
           -- support OUTER UDP CKSUM: no
           -- support RAS IMP: no
           -- support TM: no
           -- support VF VLAN FILTER MOD: no
   - VLAN Config Info:
           -- Port VLAN filter configuration
                nic_ingress           :Disable
                nic_egress            :Disable
           -- VF VLAN filter configuration
                nic_ingress           :Disable
                nic_egress            :Disable
           -- RX VLAN configuration
                vlan1_strip_en        :Disable
                vlan2_strip_en        :Disable
                vlan1_vlan_prionly    :Disable
                vlan2_vlan_prionly    :Disable
                vlan1_strip_discard   :Disable
                vlan2_strip_discard   :Disable
           -- TX VLAN configuration
                accept_tag1           :Enable
                accept_untag1         :Enable
                insert_tag1_en        :Disable
                default_vlan_tag1 = 0, qos = 0
                accept_tag2           :Enable
                accept_untag2         :Enable
                insert_tag2_en        :Disable
                default_vlan_tag2 = 0, qos = 0
                vlan_shift_mode       :Disable
           -- pvid status: off
   - Fdir Info:
           -- mode=0 max_key_len=400 rule_num:512 cnt_num:32
           -- key_sel=1 tuple_active=0x3bdfd890 meta_data_active=0xd0
           -- ipv6_word_en: in_s=3 in_d=3 out_s=0 out_d=0
....

These info is private for hns3 PMD.


>>
>> Also why not use existing xstats or telemetry to get more data from the
>> drivers?
Xstats is used to query statistics rather than state. Like above info,
many keys is "enable" or "disable". It is not appropriated to put the
date in xstats.

Telemetry is used to query common info for NICs, not for private info.
  It is not also appropriated to put private date in telemetry.



>> As synced with Ciara (cc'ed), she mentioned more information can be get
>> via registering callbacks to ethdev.
> 
> Opps, Ciara (Power) cc'ed now.
> .

^ permalink raw reply	[flat|nested] 20+ messages in thread

end of thread, other threads:[~2022-01-25 13:45 UTC | newest]

Thread overview: 20+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-11 11:54 [RFC] ethdev: introduce ethdev dump API Min Hu (Connor)
2022-01-11 12:10 ` Morten Brørup
2022-01-12  2:40   ` Min Hu (Connor)
2022-01-11 12:48 ` Thomas Monjalon
2022-01-12  2:41   ` Min Hu (Connor)
2022-01-12  2:44   ` Min Hu (Connor)
2022-01-12 10:13     ` Thomas Monjalon
2022-01-12 10:56       ` Min Hu (Connor)
2022-01-12  2:40 ` [RFC v2] " Min Hu (Connor)
2022-01-12  7:20   ` Morten Brørup
2022-01-12 11:15     ` Min Hu (Connor)
2022-01-14 17:56       ` Ajit Khaparde
2022-01-15  0:24         ` Min Hu (Connor)
2022-01-18 15:33           ` Ajit Khaparde
2022-01-12 11:14 ` [RFC v3] " Min Hu (Connor)
2022-01-12 12:05   ` Ray Kinsella
2022-01-18 15:34     ` Ajit Khaparde
2022-01-25 12:56       ` Ferruh Yigit
2022-01-25 12:58         ` Ferruh Yigit
2022-01-25 13:45           ` Min Hu (Connor)

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git