get:
Show a patch.

patch:
Update a patch.

put:
Update a patch.

GET /api/patches/138073/?format=api
HTTP 200 OK
Allow: GET, PUT, PATCH, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "id": 138073,
    "url": "http://patches.dpdk.org/api/patches/138073/?format=api",
    "web_url": "http://patches.dpdk.org/project/dpdk/patch/20240307030247.599394-3-haijie1@huawei.com/",
    "project": {
        "id": 1,
        "url": "http://patches.dpdk.org/api/projects/1/?format=api",
        "name": "DPDK",
        "link_name": "dpdk",
        "list_id": "dev.dpdk.org",
        "list_email": "dev@dpdk.org",
        "web_url": "http://core.dpdk.org",
        "scm_url": "git://dpdk.org/dpdk",
        "webscm_url": "http://git.dpdk.org/dpdk",
        "list_archive_url": "https://inbox.dpdk.org/dev",
        "list_archive_url_format": "https://inbox.dpdk.org/dev/{}",
        "commit_url_format": ""
    },
    "msgid": "<20240307030247.599394-3-haijie1@huawei.com>",
    "list_archive_url": "https://inbox.dpdk.org/dev/20240307030247.599394-3-haijie1@huawei.com",
    "date": "2024-03-07T03:02:42",
    "name": "[v5,2/7] ethdev: add telemetry cmd for registers",
    "commit_ref": null,
    "pull_url": null,
    "state": "new",
    "archived": false,
    "hash": "01a2182856d297a17161aa2e2c13e91649309739",
    "submitter": {
        "id": 2935,
        "url": "http://patches.dpdk.org/api/people/2935/?format=api",
        "name": "Jie Hai",
        "email": "haijie1@huawei.com"
    },
    "delegate": {
        "id": 319,
        "url": "http://patches.dpdk.org/api/users/319/?format=api",
        "username": "fyigit",
        "first_name": "Ferruh",
        "last_name": "Yigit",
        "email": "ferruh.yigit@amd.com"
    },
    "mbox": "http://patches.dpdk.org/project/dpdk/patch/20240307030247.599394-3-haijie1@huawei.com/mbox/",
    "series": [
        {
            "id": 31410,
            "url": "http://patches.dpdk.org/api/series/31410/?format=api",
            "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=31410",
            "date": "2024-03-07T03:02:40",
            "name": "support dump reigser names and filter them",
            "version": 5,
            "mbox": "http://patches.dpdk.org/series/31410/mbox/"
        }
    ],
    "comments": "http://patches.dpdk.org/api/patches/138073/comments/",
    "check": "success",
    "checks": "http://patches.dpdk.org/api/patches/138073/checks/",
    "tags": {},
    "related": [],
    "headers": {
        "Return-Path": "<dev-bounces@dpdk.org>",
        "X-Original-To": "patchwork@inbox.dpdk.org",
        "Delivered-To": "patchwork@inbox.dpdk.org",
        "Received": [
            "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id 29C0143B5E;\n\tThu,  7 Mar 2024 04:07:13 +0100 (CET)",
            "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 8C01342D87;\n\tThu,  7 Mar 2024 04:07:08 +0100 (CET)",
            "from szxga07-in.huawei.com (szxga07-in.huawei.com [45.249.212.35])\n by mails.dpdk.org (Postfix) with ESMTP id 65F52402F2\n for <dev@dpdk.org>; Thu,  7 Mar 2024 04:07:05 +0100 (CET)",
            "from mail.maildlp.com (unknown [172.19.88.234])\n by szxga07-in.huawei.com (SkyGuard) with ESMTP id 4TqvKj2jK4z1Q9lc;\n Thu,  7 Mar 2024 11:04:41 +0800 (CST)",
            "from kwepemd100004.china.huawei.com (unknown [7.221.188.31])\n by mail.maildlp.com (Postfix) with ESMTPS id 6D94C1402E0;\n Thu,  7 Mar 2024 11:07:03 +0800 (CST)",
            "from localhost.localdomain (10.67.165.2) by\n kwepemd100004.china.huawei.com (7.221.188.31) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id\n 15.2.1258.28; Thu, 7 Mar 2024 11:07:02 +0800"
        ],
        "From": "Jie Hai <haijie1@huawei.com>",
        "To": "<dev@dpdk.org>, Thomas Monjalon <thomas@monjalon.net>, Ferruh Yigit\n <ferruh.yigit@amd.com>, Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>",
        "CC": "<lihuisong@huawei.com>, <fengchengwen@huawei.com>, <haijie1@huawei.com>",
        "Subject": "[PATCH v5 2/7] ethdev: add telemetry cmd for registers",
        "Date": "Thu, 7 Mar 2024 11:02:42 +0800",
        "Message-ID": "<20240307030247.599394-3-haijie1@huawei.com>",
        "X-Mailer": "git-send-email 2.30.0",
        "In-Reply-To": "<20240307030247.599394-1-haijie1@huawei.com>",
        "References": "<20231214015650.3738578-1-haijie1@huawei.com>\n <20240307030247.599394-1-haijie1@huawei.com>",
        "MIME-Version": "1.0",
        "Content-Transfer-Encoding": "8bit",
        "Content-Type": "text/plain",
        "X-Originating-IP": "[10.67.165.2]",
        "X-ClientProxiedBy": "dggems701-chm.china.huawei.com (10.3.19.178) To\n kwepemd100004.china.huawei.com (7.221.188.31)",
        "X-BeenThere": "dev@dpdk.org",
        "X-Mailman-Version": "2.1.29",
        "Precedence": "list",
        "List-Id": "DPDK patches and discussions <dev.dpdk.org>",
        "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <mailto:dev-request@dpdk.org?subject=unsubscribe>",
        "List-Archive": "<http://mails.dpdk.org/archives/dev/>",
        "List-Post": "<mailto:dev@dpdk.org>",
        "List-Help": "<mailto:dev-request@dpdk.org?subject=help>",
        "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n <mailto:dev-request@dpdk.org?subject=subscribe>",
        "Errors-To": "dev-bounces@dpdk.org"
    },
    "content": "This patch adds a telemetry command for registers dump,\nand supports get registers with specified names.\nThe length of the string exported by telemetry is limited\nby MAX_OUTPUT_LEN. Therefore, the filter should be more\nprecise.\n\nAn example usage is shown below:\n--> /ethdev/regs,0,INTR\n{\n  \"/ethdev/regs\": {\n    \"registers_length\": 318,\n    \"registers_width\": 4,\n    \"register_offset\": \"0x0\",\n    \"version\": \"0x1140011\",\n    \"group_0\": {\n      \"HNS3_CMDQ_INTR_STS_REG\": \"0x0\",\n      \"HNS3_CMDQ_INTR_EN_REG\": \"0x2\",\n      \"HNS3_CMDQ_INTR_GEN_REG\": \"0x0\",\n      \"queue_0_HNS3_TQP_INTR_CTRL_REG\": \"0x0\",\n      \"queue_0_HNS3_TQP_INTR_GL0_REG\": \"0xa\",\n      \"queue_0_HNS3_TQP_INTR_GL1_REG\": \"0xa\",\n      \"queue_0_HNS3_TQP_INTR_GL2_REG\": \"0x0\",\n      ...\n      },\n    \"group_1\": {\n        ...\n    },\n    ...\n}\n\nor as below if the number of registers not exceed the\nRTE_TEL_MAX_DICT_ENTRIES:\n--> /ethdev/regs,0,ppp\n{\n  \"/ethdev/regs\": {\n    \"registers_length\": 156,\n    \"registers_width\": 4,\n    \"register_offset\": \"0x0\",\n    \"version\": \"0x1140011\",\n    \"ppp_key_drop_num\": \"0x0\",\n    \"ppp_rlt_drop_num\": \"0x0\",\n    \"ssu_ppp_mac_key_num_l\": \"0x1\",\n    \"ssu_ppp_mac_key_num_h\": \"0x0\",\n    \"ssu_ppp_host_key_num_l\": \"0x1\",\n    \"ssu_ppp_host_key_num_h\": \"0x0\",\n    \"ppp_ssu_mac_rlt_num_l\": \"0x1\",\n        ...\n   }\n}\n\nSigned-off-by: Jie Hai <haijie1@huawei.com>\n---\n lib/ethdev/rte_ethdev_telemetry.c | 158 ++++++++++++++++++++++++++++++\n 1 file changed, 158 insertions(+)",
    "diff": "diff --git a/lib/ethdev/rte_ethdev_telemetry.c b/lib/ethdev/rte_ethdev_telemetry.c\nindex 6b873e7abe68..0c570792fb5f 100644\n--- a/lib/ethdev/rte_ethdev_telemetry.c\n+++ b/lib/ethdev/rte_ethdev_telemetry.c\n@@ -5,6 +5,7 @@\n #include <ctype.h>\n #include <stdlib.h>\n \n+#include <rte_malloc.h>\n #include <rte_kvargs.h>\n #include <rte_telemetry.h>\n \n@@ -1395,6 +1396,161 @@ eth_dev_handle_port_tm_node_caps(const char *cmd __rte_unused,\n \treturn ret;\n }\n \n+static void\n+eth_dev_add_u32_hex(struct rte_tel_data *d, const char *name, uint32_t **data)\n+{\n+\tif (*data == NULL)\n+\t\treturn;\n+\trte_tel_data_add_dict_uint_hex(d, name, **data, 0);\n+\t(*data)++;\n+}\n+\n+static void\n+eth_dev_add_u64_hex(struct rte_tel_data *d, const char *name, uint64_t **data)\n+{\n+\tif (*data == NULL)\n+\t\treturn;\n+\trte_tel_data_add_dict_uint_hex(d, name, **data, 0);\n+\t(*data)++;\n+}\n+\n+static int\n+eth_dev_store_regs(struct rte_tel_data *d, struct rte_dev_reg_info *reg_info)\n+{\n+\tstruct rte_tel_data *groups[RTE_TEL_MAX_DICT_ENTRIES];\n+\tchar group_name[RTE_TEL_MAX_STRING_LEN] = {0};\n+\tstruct rte_tel_data *group = NULL;\n+\tuint32_t *data0 = NULL;\n+\tuint64_t *data1 = NULL;\n+\tuint32_t grp_num = 0;\n+\tint ret = 0;\n+\tuint32_t i;\n+\n+\trte_tel_data_start_dict(d);\n+\trte_tel_data_add_dict_uint(d, \"register_length\", reg_info->length);\n+\trte_tel_data_add_dict_uint(d, \"register_width\", reg_info->width);\n+\trte_tel_data_add_dict_uint_hex(d, \"register_offset\", reg_info->offset, 0);\n+\trte_tel_data_add_dict_uint_hex(d, \"version\", reg_info->version, 0);\n+\n+\tif (reg_info->width == sizeof(uint32_t))\n+\t\tdata0 = reg_info->data;\n+\telse\n+\t\tdata1 = reg_info->data;\n+\n+\tif (reg_info->length <= RTE_TEL_MAX_DICT_ENTRIES) {\n+\t\tfor (i = 0; i < reg_info->length; i++) {\n+\t\t\teth_dev_add_u32_hex(d, reg_info->names[i].name, &data0);\n+\t\t\teth_dev_add_u64_hex(d, reg_info->names[i].name, &data1);\n+\t\t}\n+\t\treturn 0;\n+\t}\n+\n+\tfor (i = 0; i < reg_info->length; i++) {\n+\t\tif (i % RTE_TEL_MAX_DICT_ENTRIES == 0) {\n+\t\t\tgroup = rte_tel_data_alloc();\n+\t\t\tif (group == NULL) {\n+\t\t\t\tret = -ENOMEM;\n+\t\t\t\tgoto out;\n+\t\t\t}\n+\t\t\tgroups[grp_num++] = group;\n+\t\t\trte_tel_data_start_dict(group);\n+\t\t}\n+\t\teth_dev_add_u32_hex(group, reg_info->names[i].name, &data0);\n+\t\teth_dev_add_u64_hex(group, reg_info->names[i].name, &data1);\n+\t}\n+\n+\tfor (i = 0; i < grp_num; i++) {\n+\t\tsnprintf(group_name, RTE_TEL_MAX_STRING_LEN,\n+\t\t\t\t\t\"group_%u\", i);\n+\t\trte_tel_data_add_dict_container(d, group_name, groups[i], 0);\n+\t}\n+\treturn 0;\n+out:\n+\tfor (i = 0; i < grp_num; i++)\n+\t\trte_tel_data_free(groups[i]);\n+\n+\treturn ret;\n+}\n+\n+static int\n+eth_dev_get_port_regs(int port_id, struct rte_tel_data *d, char *filter)\n+{\n+\tstruct rte_dev_reg_info reg_info;\n+\tuint32_t max_length;\n+\tint ret;\n+\n+\tmemset(&reg_info, 0, sizeof(reg_info));\n+\treg_info.filter = filter;\n+\n+\tret = rte_eth_dev_get_reg_info_ext(port_id, &reg_info);\n+\tif (ret != 0) {\n+\t\tRTE_ETHDEV_LOG_LINE(ERR,\n+\t\t\t\"Error getting device reg info: %d\", ret);\n+\t\treturn ret;\n+\t}\n+\n+\t/* 4 is space for other information of registers. */\n+\tmax_length = RTE_TEL_MAX_DICT_ENTRIES *\n+\t\t\t(RTE_TEL_MAX_DICT_ENTRIES - 4);\n+\tif (reg_info.length > max_length) {\n+\t\tRTE_ETHDEV_LOG_LINE(WARNING,\n+\t\t\t\"Reduced register number to be obtained from %u to %u due to limited memory\",\n+\t\t\treg_info.length, max_length);\n+\t\treg_info.length = max_length;\n+\t}\n+\n+\treg_info.data = calloc(reg_info.length, reg_info.width);\n+\tif (reg_info.data == NULL) {\n+\t\tRTE_ETHDEV_LOG_LINE(ERR,\n+\t\t\t\"Fail to allocate memory for reg_info.data\");\n+\t\treturn -ENOMEM;\n+\t}\n+\n+\treg_info.names = calloc(reg_info.length, sizeof(struct rte_eth_reg_name));\n+\tif (reg_info.names == NULL) {\n+\t\tRTE_ETHDEV_LOG_LINE(ERR,\n+\t\t\t\"Fail to allocate memory for reg_info.names\");\n+\t\tfree(reg_info.data);\n+\t\treturn -ENOMEM;\n+\t}\n+\n+\tret = rte_eth_dev_get_reg_info_ext(port_id, &reg_info);\n+\tif (ret != 0) {\n+\t\tRTE_ETHDEV_LOG_LINE(ERR,\n+\t\t\t\"Error getting regs from device: %d\", ret);\n+\t\tret = -EINVAL;\n+\t\tgoto out;\n+\t}\n+\n+\tret = eth_dev_store_regs(d, &reg_info);\n+out:\n+\tfree(reg_info.data);\n+\tfree(reg_info.names);\n+\n+\treturn ret;\n+}\n+\n+static int\n+eth_dev_handle_port_regs(const char *cmd __rte_unused,\n+\t\tconst char *params,\n+\t\tstruct rte_tel_data *d)\n+{\n+\tchar *filter = NULL;\n+\tuint16_t port_id;\n+\tchar *end_param;\n+\tint ret;\n+\n+\tret = eth_dev_parse_port_params(params, &port_id, &end_param, true);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\tfilter = strtok(end_param, \",\");\n+\tif (filter != NULL && strlen(filter) == 0)\n+\t\tfilter = NULL;\n+\n+\treturn eth_dev_get_port_regs(port_id, d, filter);\n+}\n+\n RTE_INIT(ethdev_init_telemetry)\n {\n \trte_telemetry_register_cmd(\"/ethdev/list\", eth_dev_handle_port_list,\n@@ -1436,4 +1592,6 @@ RTE_INIT(ethdev_init_telemetry)\n \t\t\t\"Returns TM Level Capabilities info for a port. Parameters: int port_id, int level_id (see tm_capability for the max)\");\n \trte_telemetry_register_cmd(\"/ethdev/tm_node_capability\", eth_dev_handle_port_tm_node_caps,\n \t\t\t\"Returns TM Node Capabilities info for a port. Parameters: int port_id, int node_id (see tm_capability for the max)\");\n+\trte_telemetry_register_cmd(\"/ethdev/regs\", eth_dev_handle_port_regs,\n+\t\t\t\"Returns regs for a port. Parameters: int port_id, string filter\");\n }\n",
    "prefixes": [
        "v5",
        "2/7"
    ]
}