[v4,3/3] app/procinfo: support descriptor dump

Message ID 20220923074316.25077-4-liudongdong3@huawei.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series support ethdev Rx/Tx descriptor dump |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation warning apply issues

Commit Message

Dongdong Liu Sept. 23, 2022, 7:43 a.m. UTC
  From: "Min Hu (Connor)" <humin29@huawei.com>

This patch support HW Rx/Tx descriptor dump

The command is like:
dpdk-proc-info -a xxxx:xx:xx.x --file-prefix=xxx -- --
--show-rx-descriptor queue_id:num

dpdk-proc-info -a xxxx:xx:xx.x --file-prefix=xxx -- --
--show-tx-descriptor queue_id:num

Signed-off-by: Min Hu (Connor) <humin29@huawei.com>
Signed-off-by: Dongdong Liu <liudongdong3@huawei.com>
---
 app/proc-info/main.c | 80 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 80 insertions(+)
  

Comments

Pattan, Reshma Sept. 23, 2022, 12:18 p.m. UTC | #1
> -----Original Message-----
> From: Dongdong Liu <liudongdong3@huawei.com>
> Subject: [PATCH v4 3/3] app/procinfo: support descriptor dump
> 
> From: "Min Hu (Connor)" <humin29@huawei.com>
> 
> This patch support HW Rx/Tx descriptor dump
> 
> The command is like:
> dpdk-proc-info -a xxxx:xx:xx.x --file-prefix=xxx -- -- --show-rx-descriptor
> queue_id:num


What is num here?  You need to describe about this in commit message.
Is num means number of descriptors? Better use the descriptor word here in num

> 
> dpdk-proc-info -a xxxx:xx:xx.x --file-prefix=xxx -- -- --show-tx-descriptor
> queue_id:num

Same here.

> +/* Enable dump buffer descriptor. */
> +#define MAX_NB_ITEM 2
> +static uint16_t rx_nb_item;
> +static uint16_t tx_nb_item;
> +static uint16_t rx_item_opt[MAX_NB_ITEM]; static uint16_t


Instead of using array to keep queid and number of descriptors info , better have structure with 2 parameters one for queue and one for the number of descriptors.
And You can use  the same structure to declare tx_item.

> +tx_item_opt[MAX_NB_ITEM];
> 

> +		"  --show-rx-descriptor queue_id:num: to display ports Rx
> buffer description by queue id and num\n"
> +		"  --show-tx-descriptor queue_id:num: to display ports Tx
> buffer description by queue id and num\n"

Here also use enough description what is num means or use the another name.

>+				if (ret < MAX_NB_ITEM) {

You can check ret < 0 no need to use MAX_NB_ITEM again.
>+					printf("Rx descriptor param parse error.\n");
>+					return -1;
>+				}

Instead of saying parse error. You might need to give clear reason of failure.
That is invalid queueid:num passed by user or user passed more than one pair.

>+				int ret = parse_descriptor_param(optarg,
>+								 rx_item_opt,
>+								 MAX_NB_ITEM);

Do we need to really pass the MAX_NB_ITEM> I don't think we need you can directly use the macro in the called function.


>+				if (ret < MAX_NB_ITEM) {

You can check ret < 0 no need to use MAX_NB_ITEM again.

>+					printf("Tx descriptor param parse error.\n");
>+					return -1;
>+				}

Same here.

Thanks,
Reshma
  
Dongdong Liu Sept. 24, 2022, 8:41 a.m. UTC | #2
Hi Reshma

Many thanks for your view.
On 2022/9/23 20:18, Pattan, Reshma wrote:
>
>
>> -----Original Message-----
>> From: Dongdong Liu <liudongdong3@huawei.com>
>> Subject: [PATCH v4 3/3] app/procinfo: support descriptor dump
>>
>> From: "Min Hu (Connor)" <humin29@huawei.com>
>>
>> This patch support HW Rx/Tx descriptor dump
>>
>> The command is like:
>> dpdk-proc-info -a xxxx:xx:xx.x --file-prefix=xxx -- -- --show-rx-descriptor
>> queue_id:num
>
>
> What is num here?  You need to describe about this in commit message.
> Is num means number of descriptors? Better use the descriptor word here in num

Yes, It means number of descriptors. How about rename it to desc_num.
>
>>
>> dpdk-proc-info -a xxxx:xx:xx.x --file-prefix=xxx -- -- --show-tx-descriptor
>> queue_id:num
>
> Same here.
Will fix.
>
>> +/* Enable dump buffer descriptor. */
>> +#define MAX_NB_ITEM 2
>> +static uint16_t rx_nb_item;
>> +static uint16_t tx_nb_item;
>> +static uint16_t rx_item_opt[MAX_NB_ITEM]; static uint16_t
>
>
> Instead of using array to keep queid and number of descriptors info , better have structure with 2 parameters one for queue and one for the number of descriptors.
> And You can use  the same structure to declare tx_item.
Good point, will do.
>
>> +tx_item_opt[MAX_NB_ITEM];
>>
>
>> +		"  --show-rx-descriptor queue_id:num: to display ports Rx
>> buffer description by queue id and num\n"
>> +		"  --show-tx-descriptor queue_id:num: to display ports Tx
>> buffer description by queue id and num\n"
>
> Here also use enough description what is num means or use the another name.
Will do.
>
>> +				if (ret < MAX_NB_ITEM) {
>
> You can check ret < 0 no need to use MAX_NB_ITEM again.
>> +					printf("Rx descriptor param parse error.\n");
>> +					return -1;
>> +				}
>
> Instead of saying parse error. You might need to give clear reason of failure.
> That is invalid queueid:num passed by user or user passed more than one pair.
Will do.
>
>> +				int ret = parse_descriptor_param(optarg,
>> +								 rx_item_opt,
>> +								 MAX_NB_ITEM);
>
> Do we need to really pass the MAX_NB_ITEM> I don't think we need you can directly use the macro in the called function.
>
>
>> +				if (ret < MAX_NB_ITEM) {
>
> You can check ret < 0 no need to use MAX_NB_ITEM again.
Will fix.
>
>> +					printf("Tx descriptor param parse error.\n");
>> +					return -1;
>> +				}
>
> Same here.
Will do.

Thanks,
Dongdong
>
> Thanks,
> Reshma
>
>
> .
>
  

Patch

diff --git a/app/proc-info/main.c b/app/proc-info/main.c
index 1bfba5f60d..3907af3213 100644
--- a/app/proc-info/main.c
+++ b/app/proc-info/main.c
@@ -48,6 +48,9 @@ 
 #define STATS_BDR_STR(w, s) printf("%.*s%s%.*s\n", w, \
 	STATS_BDR_FMT, s, w, STATS_BDR_FMT)
 
+typedef int (*desc_dump_t)(FILE *file, uint16_t port_id, uint16_t queue_id,
+			   uint16_t num);
+
 /**< mask of enabled ports */
 static unsigned long enabled_port_mask;
 /**< Enable stats. */
@@ -102,6 +105,12 @@  static char *mempool_iter_name;
 /**< Enable dump regs. */
 static uint32_t enable_dump_regs;
 static char *dump_regs_file_prefix;
+/* Enable dump buffer descriptor. */
+#define MAX_NB_ITEM 2
+static uint16_t rx_nb_item;
+static uint16_t tx_nb_item;
+static uint16_t rx_item_opt[MAX_NB_ITEM];
+static uint16_t tx_item_opt[MAX_NB_ITEM];
 
 /**< display usage */
 static void
@@ -130,6 +139,8 @@  proc_info_usage(const char *prgname)
 		"  --show-crypto: to display crypto information\n"
 		"  --show-ring[=name]: to display ring information\n"
 		"  --show-mempool[=name]: to display mempool information\n"
+		"  --show-rx-descriptor queue_id:num: to display ports Rx buffer description by queue id and num\n"
+		"  --show-tx-descriptor queue_id:num: to display ports Tx buffer description by queue id and num\n"
 		"  --iter-mempool=name: iterate mempool elements to display content\n"
 		"  --dump-regs=file-prefix: dump registers to file with the file-prefix\n",
 		prgname);
@@ -182,6 +193,34 @@  parse_xstats_ids(char *list, uint64_t *ids, int limit) {
 	return length;
 }
 
+/*
+ * Parse ids value list into array
+ */
+static int
+parse_descriptor_param(char *list, uint16_t *item_opt, int limit)
+{
+	int length;
+	char *token;
+	char *ctx = NULL;
+	char *endptr;
+
+	length = 0;
+	token = strtok_r(list, ":", &ctx);
+	while (token != NULL) {
+		item_opt[length] = strtoul(token, &endptr, 10);
+		if (*endptr != '\0')
+			return -EINVAL;
+
+		length++;
+		if (length > limit)
+			return -E2BIG;
+
+		token = strtok_r(NULL, ":", &ctx);
+	}
+
+	return length;
+}
+
 static int
 proc_info_preparse_args(int argc, char **argv)
 {
@@ -242,6 +281,8 @@  proc_info_parse_args(int argc, char **argv)
 		{"show-mempool", optional_argument, NULL, 0},
 		{"iter-mempool", required_argument, NULL, 0},
 		{"dump-regs", required_argument, NULL, 0},
+		{"show-rx-descriptor", required_argument, NULL, 1},
+		{"show-tx-descriptor", required_argument, NULL, 1},
 		{NULL, 0, 0, 0}
 	};
 
@@ -334,6 +375,26 @@  proc_info_parse_args(int argc, char **argv)
 					return -1;
 				}
 				nb_xstats_ids = ret;
+			} else if (!strncmp(long_option[option_index].name,
+				"show-rx-descriptor", MAX_LONG_OPT_SZ)) {
+				int ret = parse_descriptor_param(optarg,
+								 rx_item_opt,
+								 MAX_NB_ITEM);
+				if (ret < MAX_NB_ITEM) {
+					printf("Rx descriptor param parse error.\n");
+					return -1;
+				}
+				rx_nb_item = ret;
+			} else if (!strncmp(long_option[option_index].name,
+				"show-tx-descriptor", MAX_LONG_OPT_SZ)) {
+				int ret = parse_descriptor_param(optarg,
+								 tx_item_opt,
+								 MAX_NB_ITEM);
+				if (ret < MAX_NB_ITEM) {
+					printf("Tx descriptor param parse error.\n");
+					return -1;
+				}
+				tx_nb_item = ret;
 			}
 			break;
 		default:
@@ -1476,6 +1537,19 @@  dump_regs(char *file_prefix)
 	}
 }
 
+static void
+nic_descriptor_display(uint16_t port_id, uint16_t *item_opt,
+		       desc_dump_t desc_dump)
+{
+	static const char *nic_desc_border = "###";
+	uint16_t queue_id = item_opt[0];
+	uint16_t num = item_opt[1];
+
+	printf("%s NIC descriptor for port %u %s\n",
+		   nic_desc_border, port_id, nic_desc_border);
+
+	desc_dump(stdout, port_id, queue_id, num);
+}
 int
 main(int argc, char **argv)
 {
@@ -1559,6 +1633,12 @@  main(int argc, char **argv)
 		else if (nb_xstats_ids > 0)
 			nic_xstats_by_ids_display(i, xstats_ids,
 						  nb_xstats_ids);
+		else if (rx_nb_item > 0)
+			nic_descriptor_display(i, rx_item_opt,
+					       rte_eth_rx_hw_desc_dump);
+		else if (tx_nb_item > 0)
+			nic_descriptor_display(i, tx_item_opt,
+					       rte_eth_tx_hw_desc_dump);
 #ifdef RTE_LIB_METRICS
 		else if (enable_metrics)
 			metrics_display(i);