Added the ethdev Rx/Tx desc dump API which provides functions for query
descriptor from device. HW descriptor info differs in different NICs.
The information demonstrates I/O process which is important for debug.
As the information is different between NICs, the new API is introduced.
Signed-off-by: Min Hu (Connor) <humi...@huawei.com>
Signed-off-by: Dongdong Liu <liudongdo...@huawei.com>
---
doc/guides/rel_notes/release_22_11.rst | 6 +++
lib/ethdev/ethdev_driver.h | 53 +++++++++++++++++++++++++
lib/ethdev/rte_ethdev.c | 52 ++++++++++++++++++++++++
lib/ethdev/rte_ethdev.h | 55 ++++++++++++++++++++++++++
lib/ethdev/version.map | 2 +
5 files changed, 168 insertions(+)
diff --git a/doc/guides/rel_notes/release_22_11.rst
b/doc/guides/rel_notes/release_22_11.rst
index f1cc129933..453562fe69 100644
--- a/doc/guides/rel_notes/release_22_11.rst
+++ b/doc/guides/rel_notes/release_22_11.rst
@@ -144,6 +144,12 @@ New Features
into single event containing ``rte_event_vector``
whose event type is ``RTE_EVENT_TYPE_CRYPTODEV_VECTOR``.
+* **Added ethdev desc dump API, to dump Rx/Tx desc info from device.**
+ Added the ethdev Rx/Tx desc dump API which provides functions for query
+ descriptor from device. The 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.
+ The dump format is vendor-specific.
Removed Items
-------------
diff --git a/lib/ethdev/ethdev_driver.h b/lib/ethdev/ethdev_driver.h
index ea93f0418a..6505772a24 100644
--- a/lib/ethdev/ethdev_driver.h
+++ b/lib/ethdev/ethdev_driver.h
@@ -1094,6 +1094,54 @@ typedef int (*eth_rx_queue_avail_thresh_query_t)(struct
rte_eth_dev *dev,
uint16_t *rx_queue_id,
uint8_t *avail_thresh);
+/**
+ * @internal
+ * Dump Rx descriptor info to a file.
+ *
+ * It is used for debugging, not a dataplane API.
+ *
+ * @param dev
+ * Port (ethdev) handle.
+ * @param queue_id
+ * A Rx queue identifier on this port.
+ * @param offset
+ * The offset of the descriptor starting from tail. (0 is the next
+ * packet to be received by the driver).
+ * @param num
+ * The number of the descriptors to dump.
+ * @param file
+ * A pointer to a file for output.
+ * @return
+ * Negative errno value on error, zero on success.
+ */
+typedef int (*eth_rx_descriptor_dump_t)(const struct rte_eth_dev *dev,
+ uint16_t queue_id, uint16_t offset,
+ uint16_t num, FILE *file);
+
+/**
+ * @internal
+ * Dump Tx descriptor info to a file.
+ *
+ * This API is used for debugging, not a dataplane API.
+ *
+ * @param dev
+ * Port (ethdev) handle.
+ * @param queue_id
+ * A Tx queue identifier on this port.
+ * @param offset
+ * The offset of the descriptor starting from tail. (0 is the place where
+ * the next packet will be send).
+ * @param num
+ * The number of the descriptors to dump.
+ * @param file
+ * A pointer to a file for output.
+ * @return
+ * Negative errno value on error, zero on success.
+ */
+typedef int (*eth_tx_descriptor_dump_t)(const struct rte_eth_dev *dev,
+ uint16_t queue_id, uint16_t offset,
+ uint16_t num, FILE *file);
+
/**
* @internal A structure containing the functions exported by an Ethernet
driver.
*/
@@ -1309,6 +1357,11 @@ struct eth_dev_ops {
eth_rx_queue_avail_thresh_set_t rx_queue_avail_thresh_set;
/** Query Rx queue available descriptors threshold event */
eth_rx_queue_avail_thresh_query_t rx_queue_avail_thresh_query;
+
+ /** Dump Rx descriptor info */
+ eth_rx_descriptor_dump_t eth_rx_descriptor_dump;
+ /** Dump Tx descriptor info */
+ eth_tx_descriptor_dump_t eth_tx_descriptor_dump;
};
/**
diff --git a/lib/ethdev/rte_ethdev.c b/lib/ethdev/rte_ethdev.c
index 01c141a039..c34d943631 100644
--- a/lib/ethdev/rte_ethdev.c
+++ b/lib/ethdev/rte_ethdev.c
@@ -6044,6 +6044,58 @@ 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_descriptor_dump(uint16_t port_id, uint16_t queue_id,
+ uint16_t offset, uint16_t num, FILE *file)
+{
+ struct rte_eth_dev *dev;
+
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+ dev = &rte_eth_devices[port_id];
+
+ if (queue_id >= dev->data->nb_rx_queues) {
+ RTE_ETHDEV_LOG(ERR, "Invalid Rx queue_id=%u\n", queue_id);
+ return -EINVAL;
+ }
+
+ if (file == NULL) {
+ RTE_ETHDEV_LOG(ERR, "Invalid file (NULL)\n");
+ return -EINVAL;
+ }
+
+ if (*dev->dev_ops->eth_rx_descriptor_dump == NULL)
+ return -ENOTSUP;
+
+ return eth_err(port_id, (*dev->dev_ops->eth_rx_descriptor_dump)(dev,
+ queue_id, offset, num, file));
+}
+
+int
+rte_eth_tx_descriptor_dump(uint16_t port_id, uint16_t queue_id,
+ uint16_t offset, uint16_t num, FILE *file)
+{
+ struct rte_eth_dev *dev;
+
+ RTE_ETH_VALID_PORTID_OR_ERR_RET(port_id, -ENODEV);
+ dev = &rte_eth_devices[port_id];
+
+ if (queue_id >= dev->data->nb_tx_queues) {
+ RTE_ETHDEV_LOG(ERR, "Invalid Tx queue_id=%u\n", queue_id);
+ return -EINVAL;
+ }
+
+ if (file == NULL) {
+ RTE_ETHDEV_LOG(ERR, "Invalid file (NULL)\n");
+ return -EINVAL;
+ }
+
+ if (*dev->dev_ops->eth_tx_descriptor_dump == NULL)
+ return -ENOTSUP;
+
+ return eth_err(port_id, (*dev->dev_ops->eth_tx_descriptor_dump)(dev,
+ queue_id, offset, num, file));
+}
+
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 e0158480dd..7e6571b25a 100644
--- a/lib/ethdev/rte_ethdev.h
+++ b/lib/ethdev/rte_ethdev.h
@@ -5312,6 +5312,61 @@ typedef struct {
__rte_experimental
int rte_eth_dev_priv_dump(uint16_t port_id, FILE *file);
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Dump ethdev Rx descriptor info to a file.
+ *
+ * This API is used for debugging, not a dataplane API.
+ *
+ * @param port_id
+ * The port identifier of the Ethernet device.
+ * @param queue_id
+ * A Rx queue identifier on this port.
+ * @param offset
+ * The offset of the descriptor starting from tail. (0 is the next
+ * packet to be received by the driver).
+ * @param num
+ * The number of the descriptors to dump.
+ * @param file
+ * A pointer to a file for output.
+ * @return
+ * - On success, zero.
+ * - On failure, a negative value.
+ */
+__rte_experimental
+int rte_eth_rx_descriptor_dump(uint16_t port_id, uint16_t queue_id,
+ uint16_t offset, uint16_t num, FILE *file);
+
+/**
+ * @warning
+ * @b EXPERIMENTAL: this API may change, or be removed, without prior notice
+ *
+ * Dump ethdev Tx descriptor info to a file.
+ *
+ * This API is used for debugging, not a dataplane API.
+ *
+ * @param port_id
+ * The port identifier of the Ethernet device.
+ * @param queue_id
+ * A Tx queue identifier on this port.
+ * @param offset
+ * The offset of the descriptor starting from tail. (0 is the place where
+ * the next packet will be send).
+ * @param num
+ * The number of the descriptors to dump.
+ * @param file
+ * A pointer to a file for output.
+ * @return
+ * - On success, zero.
+ * - On failure, a negative value.
+ */
+__rte_experimental
+int rte_eth_tx_descriptor_dump(uint16_t port_id, uint16_t queue_id,
+ uint16_t offset, uint16_t num, FILE *file);
+
+
#include <rte_ethdev_core.h>
/**
diff --git a/lib/ethdev/version.map b/lib/ethdev/version.map
index 3651ceb234..375e30adeb 100644
--- a/lib/ethdev/version.map
+++ b/lib/ethdev/version.map
@@ -290,6 +290,8 @@ EXPERIMENTAL {
rte_flow_async_action_handle_query;
rte_mtr_meter_policy_get;
rte_mtr_meter_profile_get;
+ rte_eth_rx_descriptor_dump;
+ rte_eth_tx_descriptor_dump;
};
INTERNAL {
--
2.22.0
