From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 3E0DD468D6; Wed, 11 Jun 2025 14:37:08 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 327B8406FF; Wed, 11 Jun 2025 14:37:01 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.15]) by mails.dpdk.org (Postfix) with ESMTP id C174840691 for ; Wed, 11 Jun 2025 14:36:57 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1749645418; x=1781181418; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=oO3SlGtUJ1k/Z3fy8b4jvQUNB0Ew0uQCfdzGdsvJ+eE=; b=GrEjM6ILEfJFrFR95Ar6/yLGgt340jtu6CgnnxYlCOHxXDjyEtpZ2rtU KqVIqSYqM+bOOLGuD7wRXWdXspcWNzFjLnw/ZiYmb5wwFQ44eavCyiuK2 cAWHMj+l3t+qKWi2+SXoKlULoPqSF2sal7+YjUy0c2JeKSSqtr8T0a1xL uLnU1Hq4vN2OmYXSSNyeC1bKsaoX5Z3qMbzKM7v9Akf5V5WtfjanNV3KI N3m6bFp9HZwM/O7IV62qKBtIou/pOszgIrWljhDXd2m+L7nwUJkKLo/i5 6DJw9CqpF9Wv3WCIfX9/ZZF45a6r+i3g8aD3GxZNN74gXi8XeQBBUyN+P w==; X-CSE-ConnectionGUID: i7iIGjBRTs66EfetqPUT+Q== X-CSE-MsgGUID: 9bKSqaiOTqqNcV/RX7MlOQ== X-IronPort-AV: E=McAfee;i="6800,10657,11461"; a="51934446" X-IronPort-AV: E=Sophos;i="6.16,227,1744095600"; d="scan'208";a="51934446" Received: from fmviesa003.fm.intel.com ([10.60.135.143]) by fmvoesa109.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 11 Jun 2025 05:36:58 -0700 X-CSE-ConnectionGUID: inWCmdaTTei71O5/APUcwg== X-CSE-MsgGUID: Y8XzmKERRZeJWLKMCqhftw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.16,227,1744095600"; d="scan'208";a="150984498" Received: from unknown (HELO silpixa00401385.ir.intel.com) ([10.237.214.33]) by fmviesa003.fm.intel.com with ESMTP; 11 Jun 2025 05:36:56 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Chengwen Feng Subject: [PATCH v4 2/3] argparse: make argparse EAL-args compatible Date: Wed, 11 Jun 2025 13:36:30 +0100 Message-ID: <20250611123649.481811-3-bruce.richardson@intel.com> X-Mailer: git-send-email 2.48.1 In-Reply-To: <20250611123649.481811-1-bruce.richardson@intel.com> References: <20250527092113.903910-1-bruce.richardson@intel.com> <20250611123649.481811-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org The argparse library was missing two key features which made it unsuitable for use by EAL or any program wanting similar behaviour. 1. It didn't stop parsing arguments when it hit a "--" character 2. It never returned the number of arguments parsed Fix both these issues - the latter is a change to the ABI, since we now return >= 0 rather than == 0 on success. However, the ABI is still experimental so we can make exactly these sorts of tweaks to it. Signed-off-by: Bruce Richardson Acked-by: Chengwen Feng --- app/test/test_argparse.c | 36 +++++++++++++------------- doc/guides/rel_notes/release_25_07.rst | 9 +++++++ lib/argparse/rte_argparse.c | 12 ++++++--- lib/argparse/rte_argparse.h | 6 +++-- 4 files changed, 40 insertions(+), 23 deletions(-) diff --git a/app/test/test_argparse.c b/app/test/test_argparse.c index 6b0d1524b5..382b6250b3 100644 --- a/app/test/test_argparse.c +++ b/app/test/test_argparse.c @@ -360,14 +360,14 @@ test_argparse_opt_autosave_parse_int_of_no_val(void) argv[0] = test_strdup(obj->prog_name); argv[1] = test_strdup("--test-long"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); obj->args[0].flags = flags; val_saver = 0; argv[1] = test_strdup("-t"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); return 0; @@ -393,14 +393,14 @@ test_argparse_opt_autosave_parse_int_of_required_val(void) argv[1] = test_strdup("--test-long"); argv[2] = test_strdup("100"); ret = rte_argparse_parse(obj, 3, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 3, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); obj->args[0].flags = flags; val_saver = 0; argv[1] = test_strdup("-t"); ret = rte_argparse_parse(obj, 3, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 3, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); /* test invalid value. */ @@ -434,13 +434,13 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void) argv[0] = test_strdup(obj->prog_name); argv[1] = test_strdup("--test-long"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); obj->args[0].flags = flags; val_saver = 0; argv[1] = test_strdup("-t"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); /* test with value. */ @@ -448,13 +448,13 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void) val_saver = 0; argv[1] = test_strdup("--test-long=200"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 200, "Argparse parse expect success!"); obj->args[0].flags = flags; val_saver = 0; argv[1] = test_strdup("-t=200"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 200, "Argparse parse expect success!"); /* test with option value, but with wrong value. */ @@ -503,14 +503,14 @@ test_argparse_opt_callback_parse_int_of_no_val(void) argv[0] = test_strdup(obj->prog_name); argv[1] = test_strdup("--test-long"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); obj->args[0].flags = RTE_ARGPARSE_ARG_NO_VALUE; val_saver = 0; argv[1] = test_strdup("-t"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); return 0; @@ -555,14 +555,14 @@ test_argparse_opt_callback_parse_int_of_required_val(void) argv[1] = test_strdup("--test-long"); argv[2] = test_strdup("100"); ret = rte_argparse_parse(obj, 3, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 3, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); obj->args[0].flags = RTE_ARGPARSE_ARG_REQUIRED_VALUE; val_saver = 0; argv[1] = test_strdup("-t"); ret = rte_argparse_parse(obj, 3, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 3, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); /* test no more parameters. */ @@ -618,14 +618,14 @@ test_argparse_opt_callback_parse_int_of_optional_val(void) argv[0] = test_strdup(obj->prog_name); argv[1] = test_strdup("--test-long"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 10, "Argparse parse expect success!"); obj->args[0].flags = RTE_ARGPARSE_ARG_OPTIONAL_VALUE; val_saver = 0; argv[1] = test_strdup("-t"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 10, "Argparse parse expect success!"); /* test with value. */ @@ -633,13 +633,13 @@ test_argparse_opt_callback_parse_int_of_optional_val(void) val_saver = 0; argv[1] = test_strdup("--test-long=100"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); obj->args[0].flags = RTE_ARGPARSE_ARG_OPTIONAL_VALUE; val_saver = 0; argv[1] = test_strdup("-t=100"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); /* test callback return failed. */ @@ -671,7 +671,7 @@ test_argparse_pos_autosave_parse_int(void) argv[0] = test_strdup(obj->prog_name); argv[1] = test_strdup("100"); ret = rte_argparse_parse(obj, 2, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 2, "Argparse parse expect success!"); TEST_ASSERT(val_saver == 100, "Argparse parse expect success!"); /* test positional autosave parse failed. */ @@ -738,7 +738,7 @@ test_argparse_pos_callback_parse_int(void) argv[1] = test_strdup("100"); argv[2] = test_strdup("200"); ret = rte_argparse_parse(obj, 3, argv); - TEST_ASSERT(ret == 0, "Argparse parse expect success!"); + TEST_ASSERT(ret == 3, "Argparse parse expect success!"); TEST_ASSERT(val_saver[1] == 100, "Argparse parse expect success!"); TEST_ASSERT(val_saver[2] == 200, "Argparse parse expect success!"); diff --git a/doc/guides/rel_notes/release_25_07.rst b/doc/guides/rel_notes/release_25_07.rst index f52675c3d0..b67a504680 100644 --- a/doc/guides/rel_notes/release_25_07.rst +++ b/doc/guides/rel_notes/release_25_07.rst @@ -180,6 +180,15 @@ ABI Changes * No ABI change that would break compatibility with 24.11. +* argparse: The experimental "argparse" library has had the following updates: + * The main parsing function, ``rte_argparse_parse()``, + now returns the number of arguments parsed on success, rather than zero. + It still returns a negative value on error. + * When parsing a list of arguments, + ``rte_argparse_parse()`` stops processing arguments when a ``--`` argument is encountered. + This behaviour mirrors the behaviour of the ``getopt()`` function, + as well as the behaviour of ``rte_eal_init()`` function. + Known Issues ------------ diff --git a/lib/argparse/rte_argparse.c b/lib/argparse/rte_argparse.c index 49485861e3..13a3f4d9eb 100644 --- a/lib/argparse/rte_argparse.c +++ b/lib/argparse/rte_argparse.c @@ -606,6 +606,12 @@ parse_args(struct rte_argparse *obj, int argc, char **argv, bool *show_help) for (i = 1; i < argc; i++) { curr_argv = argv[i]; + + if (strcmp(argv[i], "--") == 0) { + i++; + break; + } + if (curr_argv[0] != '-') { /* process positional parameters. */ position_index++; @@ -669,7 +675,7 @@ parse_args(struct rte_argparse *obj, int argc, char **argv, bool *show_help) arg->flags |= ARG_ATTR_FLAG_PARSED_MASK; } - return 0; + return i; } static uint32_t @@ -785,7 +791,7 @@ rte_argparse_parse(struct rte_argparse *obj, int argc, char **argv) goto error; ret = parse_args(obj, argc, argv, &show_help); - if (ret != 0) + if (ret < 0) goto error; if (show_help) { @@ -793,7 +799,7 @@ rte_argparse_parse(struct rte_argparse *obj, int argc, char **argv) exit(0); } - return 0; + return ret; error: if (obj->exit_on_error) diff --git a/lib/argparse/rte_argparse.h b/lib/argparse/rte_argparse.h index 332184302e..fd5c33b319 100644 --- a/lib/argparse/rte_argparse.h +++ b/lib/argparse/rte_argparse.h @@ -173,7 +173,8 @@ struct rte_argparse { * @warning * @b EXPERIMENTAL: this API may change without prior notice. * - * Parse parameters. + * Parse parameters passed until all are processed, + * or until a "--" parameter is encountered. * * @param obj * Parser object. @@ -183,7 +184,8 @@ struct rte_argparse { * Array of parameters points. * * @return - * 0 on success. Otherwise negative value is returned. + * number of arguments parsed (>= 0) on success. + * Otherwise negative error code is returned. */ __rte_experimental int rte_argparse_parse(struct rte_argparse *obj, int argc, char **argv); -- 2.48.1