[v5,1/7] ethdev: support report register names and filter
Checks
Commit Message
This patch adds "filter" and "names" fields to "rte_dev_reg_info"
structure. Names of registers in data fields can be reported and
the registers can be filtered by their names.
The new API rte_eth_dev_get_reg_info_ext() is added to support
reporting names and filtering by names. And the original API
rte_eth_dev_get_reg_info() does not use the names and filter fields.
A local variable is used in rte_eth_dev_get_reg_info for
compatibility. If the drivers does not report the names, set them
to "offset_XXX".
Signed-off-by: Jie Hai <haijie1@huawei.com>
---
doc/guides/rel_notes/release_24_03.rst | 9 ++++++
lib/ethdev/rte_dev_info.h | 11 ++++++++
lib/ethdev/rte_ethdev.c | 38 ++++++++++++++++++++++++++
lib/ethdev/rte_ethdev.h | 29 ++++++++++++++++++++
lib/ethdev/version.map | 1 +
5 files changed, 88 insertions(+)
Comments
Hi Jie,
With belows to changes,
Acked-by: Huisong Li <lihuisong@huawei.com>
在 2024/3/7 11:02, Jie Hai 写道:
> This patch adds "filter" and "names" fields to "rte_dev_reg_info"
> structure. Names of registers in data fields can be reported and
> the registers can be filtered by their names.
>
> The new API rte_eth_dev_get_reg_info_ext() is added to support
> reporting names and filtering by names. And the original API
> rte_eth_dev_get_reg_info() does not use the names and filter fields.
> A local variable is used in rte_eth_dev_get_reg_info for
> compatibility. If the drivers does not report the names, set them
> to "offset_XXX".
>
> Signed-off-by: Jie Hai <haijie1@huawei.com>
> ---
> doc/guides/rel_notes/release_24_03.rst | 9 ++++++
> lib/ethdev/rte_dev_info.h | 11 ++++++++
> lib/ethdev/rte_ethdev.c | 38 ++++++++++++++++++++++++++
> lib/ethdev/rte_ethdev.h | 29 ++++++++++++++++++++
> lib/ethdev/version.map | 1 +
> 5 files changed, 88 insertions(+)
>
> diff --git a/doc/guides/rel_notes/release_24_03.rst b/doc/guides/rel_notes/release_24_03.rst
> index 78590c047b2e..e491579ca984 100644
> --- a/doc/guides/rel_notes/release_24_03.rst
> +++ b/doc/guides/rel_notes/release_24_03.rst
> @@ -161,6 +161,12 @@ New Features
> * Added power-saving during polling within the ``rte_event_dequeue_burst()`` API.
> * Added support for DMA adapter.
>
<...>
> +int
> +rte_eth_dev_get_reg_info_ext(uint16_t port_id, struct rte_dev_reg_info *info)
> {
> struct rte_eth_dev *dev;
> + uint32_t i;
> int ret;
>
> RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
> @@ -6402,12 +6431,21 @@ rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info)
> return -EINVAL;
> }
>
> + if (info->names != NULL && info->length != 0)
> + memset(info->names, 0,
> + sizeof(struct rte_eth_reg_name) * info->length);
> +
> if (*dev->dev_ops->get_reg == NULL)
> return -ENOTSUP;
> ret = eth_err(port_id, (*dev->dev_ops->get_reg)(dev, info));
>
> rte_ethdev_trace_get_reg_info(port_id, info, ret);
The trace interface in lib/ethdev/ethdev_trace.h should be added these
new fields?
>
Below code shouldn't be executed when ret != 0, right?
> + /* Report the default names if drivers not report. */
> + if (info->names != NULL && strlen(info->names[0].name) == 0)
> + for (i = 0; i < info->length; i++)
> + snprintf(info->names[i].name, RTE_ETH_REG_NAME_SIZE,
> + "offset_%u", info->offset + i * info->width);
> return ret;
> }
>
> diff --git a/lib/ethdev/rte_ethdev.h b/lib/ethdev/rte_ethdev.h
> index ed27360447a3..cd95a0d51038 100644
> --- a/lib/ethdev/rte_ethdev.h
> +++ b/lib/ethdev/rte_ethdev.h
> @@ -5066,6 +5066,35 @@ __rte_experimental
> int rte_eth_get_monitor_addr(uint16_t port_id, uint16_t queue_id,
> struct rte_power_monitor_cond *pmc);
>
> +/**
> + * Retrieve the filtered device registers (values and names) and
> + * register attributes (number of registers and register size)
> + *
> + * @param port_id
> + * The port identifier of the Ethernet device.
> + * @param info
> + * Pointer to rte_dev_reg_info structure to fill in.
> + * - If info->filter is NULL, return info for all registers (seen as filter
> + * none).
> + * - If info->filter is not NULL, return error if the driver does not support
> + * names or filter.
> + * - If info->data is NULL, the function fills in the width and length fields.
> + * - If info->data is not NULL, ethdev considers there are enough spaces to
> + * store the registers, and the values of registers whose name contains the
> + * filter string are put into the buffer pointed at by info->data.
> + * - If info->names is not NULL, drivers should fill it or the ethdev fills it
> + * with default names.
> + * @return
> + * - (0) if successful.
> + * - (-ENOTSUP) if hardware doesn't support.
> + * - (-EINVAL) if bad parameter.
> + * - (-ENODEV) if *port_id* invalid.
> + * - (-EIO) if device is removed.
> + * - others depends on the specific operations implementation.
> + */
> +__rte_experimental
> +int rte_eth_dev_get_reg_info_ext(uint16_t port_id, struct rte_dev_reg_info *info);
> +
> /**
> * Retrieve device registers and register attributes (number of registers and
> * register size)
> diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map
> index 79f6f5293b5c..e5ec2a2a9741 100644
> --- a/lib/ethdev/version.map
> +++ b/lib/ethdev/version.map
> @@ -319,6 +319,7 @@ EXPERIMENTAL {
>
> # added in 24.03
> __rte_eth_trace_tx_queue_count;
> + rte_eth_dev_get_reg_info_ext;
> rte_eth_find_rss_algo;
> rte_flow_async_update_resized;
> rte_flow_calc_encap_hash;
@@ -161,6 +161,12 @@ New Features
* Added power-saving during polling within the ``rte_event_dequeue_burst()`` API.
* Added support for DMA adapter.
+* **Added support for dumping registers with names and filter.**
+
+ * Added new API functions ``rte_eth_dev_get_reg_info_ext()`` to and filter
+ the registers by their names and get the information of registers(names,
+ values and other attributes).
+
Removed Items
-------------
@@ -228,6 +234,9 @@ ABI Changes
* No ABI change that would break compatibility with 23.11.
+* ethdev: Added ``filter`` and ``names`` fields to ``rte_dev_reg_info``
+ structure for reporting names of registers and filtering them by names.
+
Known Issues
------------
@@ -11,6 +11,11 @@ extern "C" {
#include <stdint.h>
+#define RTE_ETH_REG_NAME_SIZE 64
+struct rte_eth_reg_name {
+ char name[RTE_ETH_REG_NAME_SIZE];
+};
+
/*
* Placeholder for accessing device registers
*/
@@ -20,6 +25,12 @@ struct rte_dev_reg_info {
uint32_t length; /**< Number of registers to fetch */
uint32_t width; /**< Size of device register */
uint32_t version; /**< Device version */
+ /**
+ * Filter for target subset of registers.
+ * This field could affects register selection for data/length/names.
+ */
+ const char *filter;
+ struct rte_eth_reg_name *names; /**< Registers name saver */
};
/*
@@ -6388,8 +6388,37 @@ rte_eth_read_clock(uint16_t port_id, uint64_t *clock)
int
rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info)
+{
+ struct rte_dev_reg_info reg_info = { 0 };
+ int ret;
+
+ if (info == NULL) {
+ RTE_ETHDEV_LOG_LINE(ERR,
+ "Cannot get ethdev port %u register info to NULL",
+ port_id);
+ return -EINVAL;
+ }
+
+ reg_info.length = info->length;
+ reg_info.data = info->data;
+
+ ret = rte_eth_dev_get_reg_info_ext(port_id, ®_info);
+ if (ret != 0)
+ return ret;
+
+ info->length = reg_info.length;
+ info->width = reg_info.width;
+ info->version = reg_info.version;
+ info->offset = reg_info.offset;
+
+ return 0;
+}
+
+int
+rte_eth_dev_get_reg_info_ext(uint16_t port_id, struct rte_dev_reg_info *info)
{
struct rte_eth_dev *dev;
+ uint32_t i;
int ret;
RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
@@ -6402,12 +6431,21 @@ rte_eth_dev_get_reg_info(uint16_t port_id, struct rte_dev_reg_info *info)
return -EINVAL;
}
+ if (info->names != NULL && info->length != 0)
+ memset(info->names, 0,
+ sizeof(struct rte_eth_reg_name) * info->length);
+
if (*dev->dev_ops->get_reg == NULL)
return -ENOTSUP;
ret = eth_err(port_id, (*dev->dev_ops->get_reg)(dev, info));
rte_ethdev_trace_get_reg_info(port_id, info, ret);
+ /* Report the default names if drivers not report. */
+ if (info->names != NULL && strlen(info->names[0].name) == 0)
+ for (i = 0; i < info->length; i++)
+ snprintf(info->names[i].name, RTE_ETH_REG_NAME_SIZE,
+ "offset_%u", info->offset + i * info->width);
return ret;
}
@@ -5066,6 +5066,35 @@ __rte_experimental
int rte_eth_get_monitor_addr(uint16_t port_id, uint16_t queue_id,
struct rte_power_monitor_cond *pmc);
+/**
+ * Retrieve the filtered device registers (values and names) and
+ * register attributes (number of registers and register size)
+ *
+ * @param port_id
+ * The port identifier of the Ethernet device.
+ * @param info
+ * Pointer to rte_dev_reg_info structure to fill in.
+ * - If info->filter is NULL, return info for all registers (seen as filter
+ * none).
+ * - If info->filter is not NULL, return error if the driver does not support
+ * names or filter.
+ * - If info->data is NULL, the function fills in the width and length fields.
+ * - If info->data is not NULL, ethdev considers there are enough spaces to
+ * store the registers, and the values of registers whose name contains the
+ * filter string are put into the buffer pointed at by info->data.
+ * - If info->names is not NULL, drivers should fill it or the ethdev fills it
+ * with default names.
+ * @return
+ * - (0) if successful.
+ * - (-ENOTSUP) if hardware doesn't support.
+ * - (-EINVAL) if bad parameter.
+ * - (-ENODEV) if *port_id* invalid.
+ * - (-EIO) if device is removed.
+ * - others depends on the specific operations implementation.
+ */
+__rte_experimental
+int rte_eth_dev_get_reg_info_ext(uint16_t port_id, struct rte_dev_reg_info *info);
+
/**
* Retrieve device registers and register attributes (number of registers and
* register size)
@@ -319,6 +319,7 @@ EXPERIMENTAL {
# added in 24.03
__rte_eth_trace_tx_queue_count;
+ rte_eth_dev_get_reg_info_ext;
rte_eth_find_rss_algo;
rte_flow_async_update_resized;
rte_flow_calc_encap_hash;