[v2,2/7] ethdev: add telemetry cmd for registers
Checks
Commit Message
This patch adds a telemetry command for registers dump,
and supports get registers with specified names.
The length of the string exported by telemetry is limited
by MAX_OUTPUT_LEN. Therefore, the filter should be more
precise.
An example usage is shown below:
--> /ethdev/regs,0,INTR
{
"/ethdev/regs": {
"registers_length": 318,
"registers_width": 4,
"register_offset": "0x0",
"version": "0x1140011",
"group_0": {
"HNS3_CMDQ_INTR_STS_REG": "0x0",
"HNS3_CMDQ_INTR_EN_REG": "0x2",
"HNS3_CMDQ_INTR_GEN_REG": "0x0",
"queue_0_HNS3_TQP_INTR_CTRL_REG": "0x0",
"queue_0_HNS3_TQP_INTR_GL0_REG": "0xa",
"queue_0_HNS3_TQP_INTR_GL1_REG": "0xa",
"queue_0_HNS3_TQP_INTR_GL2_REG": "0x0",
...
},
"group_1": {
...
},
...
}
or as below if the number of registers not exceed the
RTE_TEL_MAX_DICT_ENTRIES:
--> /ethdev/regs,0,ppp
{
"/ethdev/regs": {
"registers_length": 156,
"registers_width": 4,
"register_offset": "0x0",
"version": "0x1140011",
"ppp_key_drop_num": "0x0",
"ppp_rlt_drop_num": "0x0",
"ssu_ppp_mac_key_num_l": "0x1",
"ssu_ppp_mac_key_num_h": "0x0",
"ssu_ppp_host_key_num_l": "0x1",
"ssu_ppp_host_key_num_h": "0x0",
"ppp_ssu_mac_rlt_num_l": "0x1",
...
}
}
Signed-off-by: Jie Hai <haijie1@huawei.com>
---
lib/ethdev/rte_ethdev_telemetry.c | 126 ++++++++++++++++++++++++++++++
1 file changed, 126 insertions(+)
Comments
On 2/5/2024 10:51 AM, Jie Hai wrote:
> This patch adds a telemetry command for registers dump,
> and supports get registers with specified names.
> The length of the string exported by telemetry is limited
> by MAX_OUTPUT_LEN. Therefore, the filter should be more
> precise.
>
> An example usage is shown below:
> --> /ethdev/regs,0,INTR
> {
> "/ethdev/regs": {
> "registers_length": 318,
> "registers_width": 4,
> "register_offset": "0x0",
> "version": "0x1140011",
> "group_0": {
> "HNS3_CMDQ_INTR_STS_REG": "0x0",
> "HNS3_CMDQ_INTR_EN_REG": "0x2",
> "HNS3_CMDQ_INTR_GEN_REG": "0x0",
> "queue_0_HNS3_TQP_INTR_CTRL_REG": "0x0",
> "queue_0_HNS3_TQP_INTR_GL0_REG": "0xa",
> "queue_0_HNS3_TQP_INTR_GL1_REG": "0xa",
> "queue_0_HNS3_TQP_INTR_GL2_REG": "0x0",
> ...
> },
> "group_1": {
> ...
> },
> ...
> }
>
What is the intention of 'RTE_TEL_MAX_DICT_ENTRIES' and grouping above?
> or as below if the number of registers not exceed the
> RTE_TEL_MAX_DICT_ENTRIES:
> --> /ethdev/regs,0,ppp
> {
> "/ethdev/regs": {
> "registers_length": 156,
> "registers_width": 4,
> "register_offset": "0x0",
> "version": "0x1140011",
> "ppp_key_drop_num": "0x0",
> "ppp_rlt_drop_num": "0x0",
> "ssu_ppp_mac_key_num_l": "0x1",
> "ssu_ppp_mac_key_num_h": "0x0",
> "ssu_ppp_host_key_num_l": "0x1",
> "ssu_ppp_host_key_num_h": "0x0",
> "ppp_ssu_mac_rlt_num_l": "0x1",
> ...
> }
> }
>
> Signed-off-by: Jie Hai <haijie1@huawei.com>
On 2024/2/8 1:03, Ferruh Yigit wrote:
> On 2/5/2024 10:51 AM, Jie Hai wrote:
>> This patch adds a telemetry command for registers dump,
>> and supports get registers with specified names.
>> The length of the string exported by telemetry is limited
>> by MAX_OUTPUT_LEN. Therefore, the filter should be more
>> precise.
>>
>> An example usage is shown below:
>> --> /ethdev/regs,0,INTR
>> {
>> "/ethdev/regs": {
>> "registers_length": 318,
>> "registers_width": 4,
>> "register_offset": "0x0",
>> "version": "0x1140011",
>> "group_0": {
>> "HNS3_CMDQ_INTR_STS_REG": "0x0",
>> "HNS3_CMDQ_INTR_EN_REG": "0x2",
>> "HNS3_CMDQ_INTR_GEN_REG": "0x0",
>> "queue_0_HNS3_TQP_INTR_CTRL_REG": "0x0",
>> "queue_0_HNS3_TQP_INTR_GL0_REG": "0xa",
>> "queue_0_HNS3_TQP_INTR_GL1_REG": "0xa",
>> "queue_0_HNS3_TQP_INTR_GL2_REG": "0x0",
>> ...
>> },
>> "group_1": {
>> ...
>> },
>> ...
>> }
>>
>
> What is the intention of 'RTE_TEL_MAX_DICT_ENTRIES' and grouping above?
>
For a dict in telemetry, the total num of elements is
RTE_TEL_MAX_DICT_ENTRIES which is 256.
The number of registers may be greater than that.
One option is to seperate the registers in different groups,
each group can be stored in a dict A and can be an entry of another dict B.
RTE_TEL_MAX_DICT_ENTRIES is used so that B has as less as possible
elements and to make full use of the memory allocated.
>> or as below if the number of registers not exceed the
>> RTE_TEL_MAX_DICT_ENTRIES:
>> --> /ethdev/regs,0,ppp
>> {
>> "/ethdev/regs": {
>> "registers_length": 156,
>> "registers_width": 4,
>> "register_offset": "0x0",
>> "version": "0x1140011",
>> "ppp_key_drop_num": "0x0",
>> "ppp_rlt_drop_num": "0x0",
>> "ssu_ppp_mac_key_num_l": "0x1",
>> "ssu_ppp_mac_key_num_h": "0x0",
>> "ssu_ppp_host_key_num_l": "0x1",
>> "ssu_ppp_host_key_num_h": "0x0",
>> "ppp_ssu_mac_rlt_num_l": "0x1",
>> ...
>> }
>> }
>>
>> Signed-off-by: Jie Hai <haijie1@huawei.com>
>
> .
@@ -5,6 +5,7 @@
#include <ctype.h>
#include <stdlib.h>
+#include <rte_malloc.h>
#include <rte_kvargs.h>
#include <rte_telemetry.h>
@@ -1395,6 +1396,129 @@ eth_dev_handle_port_tm_node_caps(const char *cmd __rte_unused,
return ret;
}
+static int
+eth_dev_store_regs(struct rte_tel_data *d, struct rte_dev_reg_info *reg_info)
+{
+ struct rte_tel_data *groups[RTE_TEL_MAX_DICT_ENTRIES] = {NULL};
+ char group_name[RTE_TEL_MAX_STRING_LEN] = {0};
+ struct rte_tel_data *group = NULL;
+ uint32_t grp_num = 0;
+ uint32_t *data;
+ int ret = 0;
+ uint32_t i;
+
+ rte_tel_data_start_dict(d);
+ rte_tel_data_add_dict_uint(d, "register_length", reg_info->length);
+ rte_tel_data_add_dict_uint(d, "register_width", reg_info->width);
+ rte_tel_data_add_dict_uint_hex(d, "register_offset", reg_info->offset, 0);
+ rte_tel_data_add_dict_uint_hex(d, "version", reg_info->version, 0);
+
+ data = reg_info->data;
+ if (reg_info->length <= RTE_TEL_MAX_DICT_ENTRIES) {
+ for (i = 0; i < reg_info->length; i++, data++)
+ rte_tel_data_add_dict_uint_hex(d,
+ reg_info->names[i].name, *data, 0);
+ return 0;
+ }
+
+ for (i = 0; i < reg_info->length; i++, data++) {
+ if (i % RTE_TEL_MAX_DICT_ENTRIES == 0) {
+ if (i != 0)
+ rte_tel_data_add_dict_container(d, group_name,
+ group, 0);
+
+ group = rte_tel_data_alloc();
+ if (group == NULL) {
+ ret = -ENOMEM;
+ goto out;
+ }
+ rte_tel_data_start_dict(group);
+ snprintf(group_name, RTE_TEL_MAX_STRING_LEN,
+ "group_%u", grp_num);
+ if (grp_num >= RTE_TEL_MAX_DICT_ENTRIES) {
+ RTE_ETHDEV_LOG_LINE(NOTICE,
+ "Too many regs, please filter");
+ return 0;
+ }
+ groups[grp_num++] = group;
+ }
+ rte_tel_data_add_dict_uint_hex(group, reg_info->names[i].name,
+ *data, 0);
+ }
+ if (i % RTE_TEL_MAX_DICT_ENTRIES != 0)
+ rte_tel_data_add_dict_container(d, group_name, group, 0);
+
+ return 0;
+out:
+ for (i = 0; i < grp_num; i++)
+ rte_tel_data_free(groups[i]);
+
+ return ret;
+}
+
+static int
+eth_dev_get_port_regs(int port_id, struct rte_tel_data *d, char *filter)
+{
+ struct rte_dev_reg_info reg_info;
+ int ret;
+
+ memset(®_info, 0, sizeof(reg_info));
+ reg_info.filter = filter;
+
+ ret = rte_eth_dev_get_reg_info_ext(port_id, ®_info);
+ if (ret != 0) {
+ RTE_ETHDEV_LOG_LINE(ERR,
+ "Error getting device reg info: %d", ret);
+ return ret;
+ }
+
+ reg_info.data = calloc(reg_info.length, reg_info.width);
+ if (!reg_info.data)
+ return -ENOMEM;
+
+ reg_info.names = calloc(reg_info.length, sizeof(struct rte_eth_reg_name));
+ if (!reg_info.names) {
+ free(reg_info.data);
+ return -ENOMEM;
+ }
+
+ ret = rte_eth_dev_get_reg_info_ext(port_id, ®_info);
+ if (ret != 0) {
+ RTE_ETHDEV_LOG_LINE(ERR,
+ "Error getting regs from device: %d", ret);
+ ret = -EINVAL;
+ goto out;
+ }
+
+ ret = eth_dev_store_regs(d, ®_info);
+out:
+ free(reg_info.data);
+ free(reg_info.names);
+
+ return ret;
+}
+
+static int
+eth_dev_handle_port_regs(const char *cmd __rte_unused,
+ const char *params,
+ struct rte_tel_data *d)
+{
+ char *filter = NULL;
+ uint16_t port_id;
+ char *end_param;
+ int ret;
+
+ ret = eth_dev_parse_port_params(params, &port_id, &end_param, true);
+ if (ret != 0)
+ return ret;
+
+ filter = strtok(end_param, ",");
+ if (filter != NULL && strlen(filter) == 0)
+ filter = NULL;
+
+ return eth_dev_get_port_regs(port_id, d, filter);
+}
+
RTE_INIT(ethdev_init_telemetry)
{
rte_telemetry_register_cmd("/ethdev/list", eth_dev_handle_port_list,
@@ -1436,4 +1560,6 @@ RTE_INIT(ethdev_init_telemetry)
"Returns TM Level Capabilities info for a port. Parameters: int port_id, int level_id (see tm_capability for the max)");
rte_telemetry_register_cmd("/ethdev/tm_node_capability", eth_dev_handle_port_tm_node_caps,
"Returns TM Node Capabilities info for a port. Parameters: int port_id, int node_id (see tm_capability for the max)");
+ rte_telemetry_register_cmd("/ethdev/regs", eth_dev_handle_port_regs,
+ "Returns regs for a port. Parameters: int port_id, string filter");
}