diff mbox series

[3/4] net/hns3: support Rx/Tx bd dump

Message ID 20220527023351.40577-4-humin29@huawei.com (mailing list archive)
State Superseded
Delegated to: Andrew Rybchenko
Headers show
Series support HW Rx/Tx descriptor dump | expand

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Min Hu (Connor) May 27, 2022, 2:33 a.m. UTC
This patch support query HW descriptor from hns3 device. HW descriptor
is also called BD(buffer description) which is shared memory between
software and hardware.

Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
---
 drivers/net/hns3/hns3_dump.c      | 64 +++++++++++++++++++++++++++++++
 drivers/net/hns3/hns3_dump.h      |  4 ++
 drivers/net/hns3/hns3_ethdev.c    |  2 +
 drivers/net/hns3/hns3_ethdev_vf.c |  2 +
 4 files changed, 72 insertions(+)

Comments

Stephen Hemminger May 27, 2022, 3:36 p.m. UTC | #1
On Fri, 27 May 2022 10:33:50 +0800
"Min Hu (Connor)" <humin29@huawei.com> wrote:

> +	for (i = 0; i < HNS3_BD_DW_NUM; i++) {
> +		/*
> +		 * For the sake of security, first 8 bytes of BD which stands
> +		 * for physical address of packet should not be shown.
> +		 */
> +		if (i < HNS3_BD_ADDRESS_LAST_DW) {
> +			fprintf(file, "TX BD WORD[%d]:0x%08x\n", i, 0);
> +			continue;
> +		}
> +
> +		fprintf(file, "Tx BD WORD[%d]:0x%08x\n", i, *(bd_data + i));

Use hex dump that exists?
Also this is not the kernel so leaking physical address values is not a real
security concern.
Min Hu (Connor) May 28, 2022, 1:47 a.m. UTC | #2
Hi, Stephen,

在 2022/5/27 23:36, Stephen Hemminger 写道:
> On Fri, 27 May 2022 10:33:50 +0800
> "Min Hu (Connor)" <humin29@huawei.com> wrote:
> 
>> +	for (i = 0; i < HNS3_BD_DW_NUM; i++) {
>> +		/*
>> +		 * For the sake of security, first 8 bytes of BD which stands
>> +		 * for physical address of packet should not be shown.
>> +		 */
>> +		if (i < HNS3_BD_ADDRESS_LAST_DW) {
>> +			fprintf(file, "TX BD WORD[%d]:0x%08x\n", i, 0);
>> +			continue;
>> +		}
>> +
>> +		fprintf(file, "Tx BD WORD[%d]:0x%08x\n", i, *(bd_data + i));
> 
> Use hex dump that exists?
I redefine the dump style because it'd better be consistent with the
layout of decription for HW buffer. Like this :
### NIC descriptor for port 0 ###
Rx queue id:0 BD id:1
RX BD WORD[0]:0x00000000
RX BD WORD[1]:0x00000000
RX BD WORD[2]:0x00000000
RX BD WORD[3]:0x00000000
RX BD WORD[4]:0x00000000
RX BD WORD[5]:0x00000000
RX BD WORD[6]:0x00000000
RX BD WORD[7]:0x00000000

The style is more readable.


> Also this is not the kernel so leaking physical address values is not a real
> security concern.
This address is physical address of packet. It will be used illegal like
tamper with packets. This is unsafe to do so.

> .
>
diff mbox series

Patch

diff --git a/drivers/net/hns3/hns3_dump.c b/drivers/net/hns3/hns3_dump.c
index 2cfab429af..f5de5be4eb 100644
--- a/drivers/net/hns3/hns3_dump.c
+++ b/drivers/net/hns3/hns3_dump.c
@@ -8,6 +8,9 @@ 
 #include "hns3_rxtx.h"
 #include "hns3_dump.h"
 
+#define HNS3_BD_DW_NUM 8
+#define HNS3_BD_ADDRESS_LAST_DW 2
+
 static const char *
 get_adapter_state_name(enum hns3_adapter_state state)
 {
@@ -911,3 +914,64 @@  hns3_eth_dev_priv_dump(struct rte_eth_dev *dev, FILE *file)
 
 	return 0;
 }
+
+int hns3_rx_hw_desc_dump(FILE *file, struct rte_eth_dev *dev, uint16_t queue_id,
+			 uint16_t desc_id)
+{
+	struct hns3_hw *hw = HNS3_DEV_PRIVATE_TO_HW(dev->data->dev_private);
+	struct hns3_rx_queue *rxq = dev->data->rx_queues[queue_id];
+	uint32_t *bd_data;
+	int i;
+
+	if (desc_id >= rxq->nb_rx_desc) {
+		hns3_err(hw, "Invalid Rx BD id=%u\n", desc_id);
+		return -EINVAL;
+	}
+
+	bd_data = (uint32_t *)rxq->rx_ring;
+	fprintf(file, "Rx queue id:%u BD id:%u\n", queue_id, desc_id);
+	for (i = 0; i < HNS3_BD_DW_NUM; i++) {
+		/*
+		 * For the sake of security, first 8 bytes of BD which stands
+		 * for physical address of packet should not be shown.
+		 */
+		if (i < HNS3_BD_ADDRESS_LAST_DW) {
+			fprintf(file, "RX BD WORD[%d]:0x%08x\n", i, 0);
+			continue;
+		}
+		fprintf(file, "RX BD WORD[%d]:0x%08x\n", i, *(bd_data + i));
+	}
+
+	return 0;
+}
+
+int hns3_tx_hw_desc_dump(FILE *file, struct rte_eth_dev *dev, uint16_t queue_id,
+			 uint16_t desc_id)
+{
+	struct hns3_hw *hw = HNS3_DEV_PRIVATE_TO_HW(dev->data->dev_private);
+	struct hns3_tx_queue *txq = dev->data->tx_queues[queue_id];
+	uint32_t *bd_data;
+	int i;
+
+	if (desc_id >= txq->nb_tx_desc) {
+		hns3_err(hw, "Invalid Tx BD id=%u\n", desc_id);
+		return -EINVAL;
+	}
+
+	bd_data = (uint32_t *)txq->tx_ring;
+	fprintf(file, "Tx queue id:%u BD id:%u\n", queue_id, desc_id);
+	for (i = 0; i < HNS3_BD_DW_NUM; i++) {
+		/*
+		 * For the sake of security, first 8 bytes of BD which stands
+		 * for physical address of packet should not be shown.
+		 */
+		if (i < HNS3_BD_ADDRESS_LAST_DW) {
+			fprintf(file, "TX BD WORD[%d]:0x%08x\n", i, 0);
+			continue;
+		}
+
+		fprintf(file, "Tx BD WORD[%d]:0x%08x\n", i, *(bd_data + i));
+	}
+
+	return 0;
+}
diff --git a/drivers/net/hns3/hns3_dump.h b/drivers/net/hns3/hns3_dump.h
index b0fe37ee21..7cc0b36834 100644
--- a/drivers/net/hns3/hns3_dump.h
+++ b/drivers/net/hns3/hns3_dump.h
@@ -10,4 +10,8 @@ 
 #include <ethdev_driver.h>
 
 int hns3_eth_dev_priv_dump(struct rte_eth_dev *dev, FILE *file);
+int hns3_rx_hw_desc_dump(FILE *file, struct rte_eth_dev *dev, uint16_t queue_id,
+			 uint16_t desc_id);
+int hns3_tx_hw_desc_dump(FILE *file, struct rte_eth_dev *dev, uint16_t queue_id,
+			 uint16_t desc_id);
 #endif /* _HNS3_DUMP_H_ */
diff --git a/drivers/net/hns3/hns3_ethdev.c b/drivers/net/hns3/hns3_ethdev.c
index 6fa07c4c94..ad5018f8a1 100644
--- a/drivers/net/hns3/hns3_ethdev.c
+++ b/drivers/net/hns3/hns3_ethdev.c
@@ -6562,6 +6562,8 @@  static const struct eth_dev_ops hns3_eth_dev_ops = {
 	.timesync_read_time         = hns3_timesync_read_time,
 	.timesync_write_time        = hns3_timesync_write_time,
 	.eth_dev_priv_dump          = hns3_eth_dev_priv_dump,
+	.eth_rx_hw_desc_dump        = hns3_rx_hw_desc_dump,
+	.eth_tx_hw_desc_dump        = hns3_tx_hw_desc_dump,
 };
 
 static const struct hns3_reset_ops hns3_reset_ops = {
diff --git a/drivers/net/hns3/hns3_ethdev_vf.c b/drivers/net/hns3/hns3_ethdev_vf.c
index 5fc6515de9..26173442b2 100644
--- a/drivers/net/hns3/hns3_ethdev_vf.c
+++ b/drivers/net/hns3/hns3_ethdev_vf.c
@@ -2288,6 +2288,8 @@  static const struct eth_dev_ops hns3vf_eth_dev_ops = {
 	.dev_supported_ptypes_get = hns3_dev_supported_ptypes_get,
 	.tx_done_cleanup    = hns3_tx_done_cleanup,
 	.eth_dev_priv_dump  = hns3_eth_dev_priv_dump,
+	.eth_rx_hw_desc_dump = hns3_rx_hw_desc_dump,
+	.eth_tx_hw_desc_dump = hns3_tx_hw_desc_dump,
 };
 
 static const struct hns3_reset_ops hns3vf_reset_ops = {