Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/134782/?format=api
{ "id": 134782, "url": "http://patches.dpdk.org/api/patches/134782/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231204075048.894-3-fengchengwen@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": "<20231204075048.894-3-fengchengwen@huawei.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20231204075048.894-3-fengchengwen@huawei.com", "date": "2023-12-04T07:50:44", "name": "[RFC,v2,2/6] argparse: support verify argument config", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "a07ee5c577e4b0052f35cd231dc0f640b82e9d92", "submitter": { "id": 2146, "url": "http://patches.dpdk.org/api/people/2146/?format=api", "name": "fengchengwen", "email": "fengchengwen@huawei.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231204075048.894-3-fengchengwen@huawei.com/mbox/", "series": [ { "id": 30348, "url": "http://patches.dpdk.org/api/series/30348/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30348", "date": "2023-11-21T12:26:51", "name": "[24.03,RFC] argparse: add argparse library", "version": 1, "mbox": "http://patches.dpdk.org/series/30348/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/134782/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/134782/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 EAF954365D;\n\tMon, 4 Dec 2023 08:53:59 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id C542540693;\n\tMon, 4 Dec 2023 08:53:59 +0100 (CET)", "from szxga03-in.huawei.com (szxga03-in.huawei.com [45.249.212.189])\n by mails.dpdk.org (Postfix) with ESMTP id 0A61D402AE\n for <dev@dpdk.org>; Mon, 4 Dec 2023 08:53:57 +0100 (CET)", "from dggpeml500024.china.huawei.com (unknown [172.30.72.57])\n by szxga03-in.huawei.com (SkyGuard) with ESMTP id 4SkG574qbwz14L6p;\n Mon, 4 Dec 2023 15:48:59 +0800 (CST)", "from localhost.localdomain (10.50.165.33) by\n dggpeml500024.china.huawei.com (7.185.36.10) with Microsoft SMTP Server\n (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id\n 15.1.2507.35; Mon, 4 Dec 2023 15:53:55 +0800" ], "From": "Chengwen Feng <fengchengwen@huawei.com>", "To": "<dev@dpdk.org>, <thomas@monjalon.net>, <ferruh.yigit@amd.com>,\n <stephen@networkplumber.org>", "CC": "<tangkunshan@huawei.com>", "Subject": "[RFC v2 2/6] argparse: support verify argument config", "Date": "Mon, 4 Dec 2023 07:50:44 +0000", "Message-ID": "<20231204075048.894-3-fengchengwen@huawei.com>", "X-Mailer": "git-send-email 2.17.1", "In-Reply-To": "<20231204075048.894-1-fengchengwen@huawei.com>", "References": "<20231121122651.7078-1-fengchengwen@huawei.com>\n <20231204075048.894-1-fengchengwen@huawei.com>", "MIME-Version": "1.0", "Content-Type": "text/plain", "X-Originating-IP": "[10.50.165.33]", "X-ClientProxiedBy": "dggems701-chm.china.huawei.com (10.3.19.178) To\n dggpeml500024.china.huawei.com (7.185.36.10)", "X-CFilter-Loop": "Reflected", "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 commit supports verify argument config.\n\nSigned-off-by: Chengwen Feng <fengchengwen@huawei.com>\n---\n lib/argparse/rte_argparse.c | 310 +++++++++++++++++++++++++++++++++++-\n 1 file changed, 309 insertions(+), 1 deletion(-)", "diff": "diff --git a/lib/argparse/rte_argparse.c b/lib/argparse/rte_argparse.c\nindex bf14c56858..eff504a778 100644\n--- a/lib/argparse/rte_argparse.c\n+++ b/lib/argparse/rte_argparse.c\n@@ -2,13 +2,321 @@\n * Copyright(c) 2023 HiSilicon Limited\n */\n \n+#include <errno.h>\n+#include <stdlib.h>\n+#include <string.h>\n+\n+#include <rte_log.h>\n+\n #include \"rte_argparse.h\"\n \n+RTE_LOG_REGISTER_DEFAULT(rte_argparse_logtype, INFO);\n+#define ARGPARSE_LOG(level, ...) \\\n+\trte_log(RTE_LOG_ ## level, rte_argparse_logtype, RTE_FMT(\"argparse: \" \\\n+\t\tRTE_FMT_HEAD(__VA_ARGS__,) \"\\n\", RTE_FMT_TAIL(__VA_ARGS__,)))\n+\n+#define BIT(x)\t(1ul << (x))\n+#define GENMASK_U32(h, l) \\\n+\t\t(((~0u) << (l)) & (~0u >> (31 - (h))))\n+#define BF_SHF(x) (__builtin_ffsll(x) - 1)\n+#define FIELD_GET(mask, reg) \\\n+\t\t((typeof(mask))(((reg) & (mask)) >> BF_SHF(mask)))\n+\n+#define ARG_ATTR_HAS_VAL_MASK\t\tGENMASK_U32(1, 0)\n+#define ARG_ATTR_HAS_VAL_SHIFT\t\t0\n+#define ARG_ATTR_VAL_TYPE_MASK\t\tGENMASK_U32(10, 2)\n+#define ARG_ATTR_VAL_TYPE_SHIFT\t\t2\n+#define ARG_ATTR_SUPPORT_MULTI_MASK\tBIT(16)\n+#define ARG_ATTR_SUPPORT_MULTI_SHIFT\t16\n+#define ARG_ATTR_FLAG_PARSED_MASK\tBIT(31)\n+#define ARG_ATTR_FLAG_PARSED_SHIFT\t31\n+\n+static inline bool\n+is_arg_optional(const struct rte_argparse_arg *arg)\n+{\n+\treturn arg->name_long[0] == '-';\n+}\n+\n+static inline bool\n+is_arg_positional(const struct rte_argparse_arg *arg)\n+{\n+\treturn arg->name_long[0] != '-';\n+}\n+\n+static inline uint32_t\n+arg_attr_has_val(const struct rte_argparse_arg *arg)\n+{\n+\treturn FIELD_GET(ARG_ATTR_HAS_VAL_MASK, arg->flags);\n+}\n+\n+static inline uint32_t\n+arg_attr_val_type(const struct rte_argparse_arg *arg)\n+{\n+\treturn FIELD_GET(ARG_ATTR_VAL_TYPE_MASK, arg->flags);\n+}\n+\n+static inline bool\n+arg_attr_flag_multi(const struct rte_argparse_arg *arg)\n+{\n+\treturn FIELD_GET(ARG_ATTR_SUPPORT_MULTI_MASK, arg->flags);\n+}\n+\n+static inline uint32_t\n+arg_attr_unused_bits(const struct rte_argparse_arg *arg)\n+{\n+#define USED_BIT_MASK\t(ARG_ATTR_HAS_VAL_MASK | ARG_ATTR_VAL_TYPE_MASK | \\\n+\t\t\t ARG_ATTR_SUPPORT_MULTI_MASK)\n+\treturn arg->flags & ~USED_BIT_MASK;\n+}\n+\n+static int\n+verify_arg_name(const struct rte_argparse_arg *arg)\n+{\n+\tif (is_arg_optional(arg)) {\n+\t\tif (strlen(arg->name_long) <= 3) {\n+\t\t\tARGPARSE_LOG(ERR, \"optional long name %s too short!\", arg->name_long);\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\t\tif (arg->name_long[1] != '-') {\n+\t\t\tARGPARSE_LOG(ERR, \"optional long name %s must only start with '--'\",\n+\t\t\t\t arg->name_long);\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\t\tif (arg->name_long[2] == '-') {\n+\t\t\tARGPARSE_LOG(ERR, \"optional long name %s should not start with '---'\",\n+\t\t\t\t arg->name_long);\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\t}\n+\n+\tif (arg->name_short == NULL)\n+\t\treturn 0;\n+\n+\tif (!is_arg_optional(arg)) {\n+\t\tARGPARSE_LOG(ERR, \"short name %s corresponding long name must be optional!\",\n+\t\t\t arg->name_short);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tif (strlen(arg->name_short) != 2 || arg->name_short[0] != '-' ||\n+\t\targ->name_short[1] == '-') {\n+\t\tARGPARSE_LOG(ERR, \"short name %s must start with a hyphen (-) followed by an English letter\",\n+\t\t\t arg->name_short);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static int\n+verify_arg_help(const struct rte_argparse_arg *arg)\n+{\n+\tif (arg->help == NULL) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s must have help info!\", arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static int\n+verify_arg_has_val(const struct rte_argparse_arg *arg)\n+{\n+\tuint32_t has_val = arg_attr_has_val(arg);\n+\n+\tif (is_arg_positional(arg)) {\n+\t\tif (has_val == RTE_ARGPARSE_ARG_REQUIRED_VALUE)\n+\t\t\treturn 0;\n+\t\tARGPARSE_LOG(ERR, \"argument %s is positional, should has zero or required-val!\",\n+\t\t\t arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tif (has_val == 0) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s is optional, has-val config wrong!\",\n+\t\t\t arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static int\n+verify_arg_saver(const struct rte_argparse *obj, uint32_t index)\n+{\n+\tuint32_t cmp_max = FIELD_GET(ARG_ATTR_VAL_TYPE_MASK, RTE_ARGPARSE_ARG_VALUE_MAX);\n+\tconst struct rte_argparse_arg *arg = &obj->args[index];\n+\tuint32_t val_type = arg_attr_val_type(arg);\n+\tuint32_t has_val = arg_attr_has_val(arg);\n+\n+\tif (arg->val_saver == NULL) {\n+\t\tif (val_type != 0) {\n+\t\t\tARGPARSE_LOG(ERR, \"argument %s parse by callback, val-type must be zero!\",\n+\t\t\t\t arg->name_long);\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\n+\t\tif (obj->callback == NULL) {\n+\t\t\tARGPARSE_LOG(ERR, \"argument %s parse by callback, but callback is NULL!\",\n+\t\t\t\t arg->name_long);\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\n+\t\treturn 0;\n+\t}\n+\n+\tif (val_type == 0 || val_type >= cmp_max) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s val-type config wrong!\", arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tif (has_val == RTE_ARGPARSE_ARG_REQUIRED_VALUE && arg->val_set != NULL) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s has required value, val-set should be NULL!\",\n+\t\t\t arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static int\n+verify_arg_flags(const struct rte_argparse *obj, uint32_t index)\n+{\n+\tconst struct rte_argparse_arg *arg = &obj->args[index];\n+\tuint32_t unused_bits = arg_attr_unused_bits(arg);\n+\n+\tif (unused_bits != 0) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s flags set wrong!\", arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tif (!(arg->flags & RTE_ARGPARSE_ARG_SUPPORT_MULTI))\n+\t\treturn 0;\n+\n+\tif (is_arg_positional(arg)) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s is positional, don't support multiple times!\",\n+\t\t\t arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tif (arg->val_saver != NULL) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s could occur multiple times, should use callback to parse!\",\n+\t\t\t arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tif (obj->callback == NULL) {\n+\t\tARGPARSE_LOG(ERR, \"argument %s should use callback to parse, but callback is NULL!\",\n+\t\t\t arg->name_long);\n+\t\treturn -EINVAL;\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static int\n+verify_arg_repeat(const struct rte_argparse *self, uint32_t index)\n+{\n+\tconst struct rte_argparse_arg *arg = &self->args[index];\n+\tuint32_t i;\n+\n+\tfor (i = 0; i < index; i++) {\n+\t\tif (!strcmp(arg->name_long, self->args[i].name_long)) {\n+\t\t\tARGPARSE_LOG(ERR, \"argument %s repeat!\", arg->name_long);\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\t}\n+\n+\tif (arg->name_short == NULL)\n+\t\treturn 0;\n+\n+\tfor (i = 0; i < index; i++) {\n+\t\tif (self->args[i].name_short == NULL)\n+\t\t\tcontinue;\n+\t\tif (!strcmp(arg->name_short, self->args[i].name_short)) {\n+\t\t\tARGPARSE_LOG(ERR, \"argument %s repeat!\", arg->name_short);\n+\t\t\treturn -EINVAL;\n+\t\t}\n+\t}\n+\n+\treturn 0;\n+}\n+\n+static int\n+verify_argparse_arg(const struct rte_argparse *obj, uint32_t index)\n+{\n+\tconst struct rte_argparse_arg *arg = &obj->args[index];\n+\tint ret;\n+\n+\tret = verify_arg_name(arg);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\tret = verify_arg_help(arg);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\tret = verify_arg_has_val(arg);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\tret = verify_arg_saver(obj, index);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\tret = verify_arg_flags(obj, index);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\tret = verify_arg_repeat(obj, index);\n+\tif (ret != 0)\n+\t\treturn ret;\n+\n+\treturn 0;\n+}\n+\n+static int\n+verify_argparse(const struct rte_argparse *obj)\n+{\n+\tuint32_t idx = 0;\n+\tint ret;\n+\n+\tif (obj->prog_name == NULL) {\n+\t\tARGPARSE_LOG(ERR, \"program name is NULL!\");\n+\t\treturn -EINVAL;\n+\t}\n+\n+\tif (obj->usage == NULL) {\n+\t\tARGPARSE_LOG(ERR, \"usage is NULL!\");\n+\t\treturn -EINVAL;\n+\t}\n+\n+\twhile (obj->args[idx].name_long != NULL) {\n+\t\tret = verify_argparse_arg(obj, idx);\n+\t\tif (ret != 0)\n+\t\t\treturn ret;\n+\t\tidx++;\n+\t}\n+\n+\treturn 0;\n+}\n+\n int\n rte_argparse_parse(struct rte_argparse *obj, int argc, char **argv)\n {\n-\t(void)obj;\n+\tint ret;\n+\n \t(void)argc;\n \t(void)argv;\n+\n+\tret = verify_argparse(obj);\n+\tif (ret != 0)\n+\t\tgoto error;\n+\n \treturn 0;\n+\n+error:\n+\tif (obj->exit_on_error)\n+\t\texit(ret);\n+\treturn ret;\n }\n", "prefixes": [ "RFC", "v2", "2/6" ] }