DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: david.marchand@redhat.com, Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH v11 07/21] argparse: allow optional flag reordering
Date: Thu,  9 Oct 2025 14:00:42 +0100	[thread overview]
Message-ID: <20251009130056.2630343-8-bruce.richardson@intel.com> (raw)
In-Reply-To: <20251009130056.2630343-1-bruce.richardson@intel.com>

Allow argparse to behave like getopt in ignoring non-flag arguments and
moving them to the end of the list. This will allow use in DPDK for EAL
args where, for example:

  ./dpdk-test -l 1,2 lcores_autotest --no-huge -- argparse_autotest

will return from getopt processing in rte_eal_init as:

  ./dpdk-test -l 1,2 --no-huge -- lcores_autotest argparse_autotest

with EAL init function then replacing the "--" with argv[0] before
returning to the app with the return value of 5, for the 5 args
(including the "--") processed.

Since this is a significant behavioural change for argparse, which,
unlike getopt, has the idea of positional arguments, we place this
behaviour behind a new flag for argparse. If this new
"ignore_non_flag_args" option is set, then positional arguments are
disallowed and getopt behaviour is used for non-flag args.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 app/test/test_argparse.c               | 376 +++++++++++++++++++++++++
 doc/guides/prog_guide/argparse_lib.rst |  17 ++
 lib/argparse/rte_argparse.c            |  62 +++-
 lib/argparse/rte_argparse.h            |   6 +
 4 files changed, 453 insertions(+), 8 deletions(-)

diff --git a/app/test/test_argparse.c b/app/test/test_argparse.c
index 8d70166cfa..cce637ce22 100644
--- a/app/test/test_argparse.c
+++ b/app/test/test_argparse.c
@@ -1077,6 +1077,371 @@ test_argparse_parse_type(void)
 	return 0;
 }
 
+static int
+test_argparse_ignore_non_flag_args_disabled(void)
+{
+	struct rte_argparse *obj;
+	char *argv[6];
+	int ret;
+
+	/* Test that without ignore_non_flag_args, non-flag args cause an error */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = false;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("nonflagvalue");
+	argv[3] = test_strdup("-x");
+	ret = rte_argparse_parse(obj, 4, argv);
+	TEST_ASSERT(ret == -EINVAL, "Argparse should fail with non-flag arg when flag is disabled!");
+
+	/* Test with non-flag args mixed with flags */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = false;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("nonflagvalue1");
+	argv[2] = test_strdup("-a");
+	argv[3] = test_strdup("-x");
+	argv[4] = test_strdup("nonflagvalue2");
+	ret = rte_argparse_parse(obj, 5, argv);
+	TEST_ASSERT(ret == -EINVAL, "Argparse should fail with non-flag args when flag is disabled!");
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_basic(void)
+{
+	struct rte_argparse *obj;
+	char *argv[8];
+	int ret;
+
+	/* Test basic reordering: ['app', '-a', 'nonflagvalue', '-x']
+	 * Should process -a and -x, return 2 processed args, move nonflagvalue to end
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("nonflagvalue");
+	argv[3] = test_strdup("-x");
+	ret = rte_argparse_parse(obj, 4, argv);
+	TEST_ASSERT(ret == 3, "Argparse should return 3 (processed all but 1 non-flag), got %d!",
+			ret);
+	TEST_ASSERT(strcmp(argv[3], "nonflagvalue") == 0,
+		"Non-flag arg should be moved to end, but argv[3]='%s'!", argv[3]);
+
+	/* Test with multiple non-flag args:
+	 * ['app', '-a', 'nonflag1', '-x', 'nonflag2']
+	 * Should process -a and -x, return 3, reorder to [..., 'nonflag1', 'nonflag2']
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("nonflag1");
+	argv[3] = test_strdup("-x");
+	argv[4] = test_strdup("nonflag2");
+	ret = rte_argparse_parse(obj, 5, argv);
+	TEST_ASSERT(ret == 3, "Argparse should return 3 (processed all but 2 non-flags), got %d!",
+			ret);
+	TEST_ASSERT(strcmp(argv[3], "nonflag1") == 0,
+		"First non-flag arg should be at position 3, but argv[3]='%s'!", argv[3]);
+	TEST_ASSERT(strcmp(argv[4], "nonflag2") == 0,
+		"Second non-flag arg should be at position 4, but argv[4]='%s'!", argv[4]);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_with_values(void)
+{
+	struct rte_argparse *obj;
+	int val_a = 0, val_x = 0;
+	char *argv[10];
+	int ret;
+
+	/* Test with flags that take values:
+	 * ['app', '-a', 'avalue', 'nonflag1', '-x', 'xvalue', 'nonflag2']
+	 * Should process -a avalue and -x xvalue, move non-flags to end
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = (void *)&val_a;
+	obj->args[0].val_set = NULL;
+	obj->args[0].value_required = RTE_ARGPARSE_VALUE_REQUIRED;
+	obj->args[0].value_type = RTE_ARGPARSE_VALUE_TYPE_INT;
+	obj->args[1].val_saver = (void *)&val_x;
+	obj->args[1].val_set = NULL;
+	obj->args[1].value_required = RTE_ARGPARSE_VALUE_REQUIRED;
+	obj->args[1].value_type = RTE_ARGPARSE_VALUE_TYPE_INT;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("100");
+	argv[3] = test_strdup("nonflag1");
+	argv[4] = test_strdup("-x");
+	argv[5] = test_strdup("200");
+	argv[6] = test_strdup("nonflag2");
+	ret = rte_argparse_parse(obj, 7, argv);
+	TEST_ASSERT(ret == 5, "Argparse should return 5 (app + 4 flag-related + 0 non-flags), got %d!",
+			ret);
+	TEST_ASSERT(val_a == 100, "Value for -a should be parsed correctly, got %d!", val_a);
+	TEST_ASSERT(val_x == 200, "Value for -x should be parsed correctly, got %d!", val_x);
+	TEST_ASSERT(strcmp(argv[5], "nonflag1") == 0,
+		"First non-flag arg should be at position 5, but argv[5]='%s'!", argv[5]);
+	TEST_ASSERT(strcmp(argv[6], "nonflag2") == 0,
+		"Second non-flag arg should be at position 6, but argv[6]='%s'!", argv[6]);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_complex_order(void)
+{
+	struct rte_argparse *obj;
+	int val_a = 0;
+	char *argv[10];
+	int ret;
+
+	/* Test complex reordering matching example from requirements:
+	 * ['app', '-a', 'avalue', 'nonflag1', '-x', 'nonflag2']
+	 * Should become: ['app', '-a', 'avalue', '-x', 'nonflag1', 'nonflag2']
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = (void *)&val_a;
+	obj->args[0].val_set = NULL;
+	obj->args[0].value_required = RTE_ARGPARSE_VALUE_REQUIRED;
+	obj->args[0].value_type = RTE_ARGPARSE_VALUE_TYPE_INT;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("50");
+	argv[3] = test_strdup("nonflag1");
+	argv[4] = test_strdup("-x");
+	argv[5] = test_strdup("nonflag2");
+	ret = rte_argparse_parse(obj, 6, argv);
+	TEST_ASSERT(ret == 4, "Argparse should return 4 (app + 3 flag-related), got %d!", ret);
+	TEST_ASSERT(val_a == 50, "Value for -a should be parsed correctly, got %d!", val_a);
+	/* Verify reordering */
+	TEST_ASSERT(strcmp(argv[4], "nonflag1") == 0,
+		"First non-flag should be at position 4, but argv[4]='%s'!", argv[4]);
+	TEST_ASSERT(strcmp(argv[5], "nonflag2") == 0,
+		"Second non-flag should be at position 5, but argv[5]='%s'!", argv[5]);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_only_non_flags(void)
+{
+	struct rte_argparse *obj;
+	char *argv[5];
+	int ret;
+
+	/* Edge case: only non-flag args
+	 * ['app', 'nonflag1', 'nonflag2', 'nonflag3']
+	 * Should return 1 (only app name processed), argv unchanged
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("nonflag1");
+	argv[2] = test_strdup("nonflag2");
+	argv[3] = test_strdup("nonflag3");
+	ret = rte_argparse_parse(obj, 4, argv);
+	TEST_ASSERT(ret == 1, "Argparse should return 1 (only app name processed), got %d!", ret);
+	TEST_ASSERT(strcmp(argv[1], "nonflag1") == 0,
+		"First non-flag should remain at position 1, but argv[1]='%s'!", argv[1]);
+	TEST_ASSERT(strcmp(argv[2], "nonflag2") == 0,
+		"Second non-flag should remain at position 2, but argv[2]='%s'!", argv[2]);
+	TEST_ASSERT(strcmp(argv[3], "nonflag3") == 0,
+		"Third non-flag should remain at position 3, but argv[3]='%s'!", argv[3]);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_no_non_flags(void)
+{
+	struct rte_argparse *obj;
+	char *argv[4];
+	int ret;
+
+	/* Edge case: no non-flag args, only flags
+	 * ['app', '-a', '-x']
+	 * Should process all args normally
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("-x");
+	ret = rte_argparse_parse(obj, 3, argv);
+	TEST_ASSERT(ret == 3, "Argparse should return 3 (all args processed), got %d!", ret);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_with_double_dash(void)
+{
+	struct rte_argparse *obj;
+	char *argv[8];
+	int ret;
+
+	/* Test with -- separator:
+	 * ['app', '-a', 'nonflag1', '--', 'arg1', 'arg2']
+	 * Should process -a, stop at --, and move nonflag1 after --
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("nonflag1");
+	argv[3] = test_strdup("--");
+	argv[4] = test_strdup("arg1");
+	argv[5] = test_strdup("arg2");
+	ret = rte_argparse_parse(obj, 6, argv);
+	/* Should return position of first flag after -- */
+	TEST_ASSERT(ret == 3, "Argparse should return 3 (app + -a, stopped at --), got %d!", ret);
+	TEST_ASSERT(strcmp(argv[2], "--") == 0,
+		"-- should be moved to position 2, but argv[2]='%s'!", argv[2]);
+	TEST_ASSERT(strcmp(argv[3], "nonflag1") == 0,
+		"Non-flag should be moved after --, but argv[3]='%s'!", argv[3]);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_leading_non_flags(void)
+{
+	struct rte_argparse *obj;
+	char *argv[7];
+	int ret;
+
+	/* Test with leading non-flag args:
+	 * ['app', 'nonflag1', 'nonflag2', '-a', '-x']
+	 * Should process -a and -x, move non-flags to end
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("nonflag1");
+	argv[2] = test_strdup("nonflag2");
+	argv[3] = test_strdup("-a");
+	argv[4] = test_strdup("-x");
+	ret = rte_argparse_parse(obj, 5, argv);
+	TEST_ASSERT(ret == 3, "Argparse should return 3 (app + 2 flags), got %d!", ret);
+	TEST_ASSERT(strcmp(argv[3], "nonflag1") == 0,
+		"First non-flag should be at position 3, but argv[3]='%s'!", argv[3]);
+	TEST_ASSERT(strcmp(argv[4], "nonflag2") == 0,
+		"Second non-flag should be at position 4, but argv[4]='%s'!", argv[4]);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_trailing_non_flags(void)
+{
+	struct rte_argparse *obj;
+	char *argv[7];
+	int ret;
+
+	/* Test with trailing non-flag args:
+	 * ['app', '-a', '-x', 'nonflag1', 'nonflag2']
+	 * Should process -a and -x, non-flags already at end
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("-a");
+	argv[2] = test_strdup("-x");
+	argv[3] = test_strdup("nonflag1");
+	argv[4] = test_strdup("nonflag2");
+	ret = rte_argparse_parse(obj, 5, argv);
+	TEST_ASSERT(ret == 3, "Argparse should return 3 (app + 2 flags), got %d!", ret);
+	TEST_ASSERT(strcmp(argv[3], "nonflag1") == 0,
+		"First non-flag should remain at position 3, but argv[3]='%s'!", argv[3]);
+	TEST_ASSERT(strcmp(argv[4], "nonflag2") == 0,
+		"Second non-flag should remain at position 4, but argv[4]='%s'!", argv[4]);
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_with_positional(void)
+{
+	struct rte_argparse *obj;
+	char *argv[5];
+	int ret;
+
+	/* Test that ignore_non_flag_args cannot be used with positional args
+	 * This should fail during validation
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].name_long = "positional";
+	obj->args[0].name_short = NULL;
+	obj->args[0].val_saver = (void *)1;
+	obj->args[0].val_set = NULL;
+	obj->args[0].value_required = RTE_ARGPARSE_VALUE_REQUIRED;
+	obj->args[0].value_type = RTE_ARGPARSE_VALUE_TYPE_INT;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("100");
+	ret = rte_argparse_parse(obj, 2, argv);
+	TEST_ASSERT(ret == -EINVAL,
+		"Argparse should fail when ignore_non_flag_args is used with positional args!");
+
+	return 0;
+}
+
+static int
+test_argparse_ignore_non_flag_args_short_and_long(void)
+{
+	struct rte_argparse *obj;
+	char *argv[8];
+	int ret;
+
+	/* Test with both short and long options:
+	 * ['app', '--abc', 'nonflag1', '-x', 'nonflag2']
+	 */
+	obj = test_argparse_init_obj();
+	obj->ignore_non_flag_args = true;
+	obj->args[0].val_saver = NULL;
+	obj->args[1].val_saver = NULL;
+	argv[0] = test_strdup(obj->prog_name);
+	argv[1] = test_strdup("--abc");
+	argv[2] = test_strdup("nonflag1");
+	argv[3] = test_strdup("-x");
+	argv[4] = test_strdup("nonflag2");
+	ret = rte_argparse_parse(obj, 5, argv);
+	TEST_ASSERT(ret == 3, "Argparse should return 3 (app + 2 flags), got %d!", ret);
+	TEST_ASSERT(strcmp(argv[3], "nonflag1") == 0,
+		"First non-flag should be at position 3, but argv[3]='%s'!", argv[3]);
+	TEST_ASSERT(strcmp(argv[4], "nonflag2") == 0,
+		"Second non-flag should be at position 4, but argv[4]='%s'!", argv[4]);
+
+	return 0;
+}
+
 static struct unit_test_suite argparse_test_suite = {
 	.suite_name = "Argparse Unit Test Suite",
 	.setup = test_argparse_setup,
@@ -1101,6 +1466,17 @@ static struct unit_test_suite argparse_test_suite = {
 		TEST_CASE(test_argparse_pos_autosave_parse_int),
 		TEST_CASE(test_argparse_pos_callback_parse_int),
 		TEST_CASE(test_argparse_parse_type),
+		TEST_CASE(test_argparse_ignore_non_flag_args_disabled),
+		TEST_CASE(test_argparse_ignore_non_flag_args_basic),
+		TEST_CASE(test_argparse_ignore_non_flag_args_with_values),
+		TEST_CASE(test_argparse_ignore_non_flag_args_complex_order),
+		TEST_CASE(test_argparse_ignore_non_flag_args_only_non_flags),
+		TEST_CASE(test_argparse_ignore_non_flag_args_no_non_flags),
+		TEST_CASE(test_argparse_ignore_non_flag_args_with_double_dash),
+		TEST_CASE(test_argparse_ignore_non_flag_args_leading_non_flags),
+		TEST_CASE(test_argparse_ignore_non_flag_args_trailing_non_flags),
+		TEST_CASE(test_argparse_ignore_non_flag_args_with_positional),
+		TEST_CASE(test_argparse_ignore_non_flag_args_short_and_long),
 
 		TEST_CASES_END() /**< NULL terminate unit test array */
 	}
diff --git a/doc/guides/prog_guide/argparse_lib.rst b/doc/guides/prog_guide/argparse_lib.rst
index 7882d910ab..eff8f94a2d 100644
--- a/doc/guides/prog_guide/argparse_lib.rst
+++ b/doc/guides/prog_guide/argparse_lib.rst
@@ -15,6 +15,8 @@ Features and Capabilities
 
 - Support parsing positional argument (which must take with required-value).
 
+- Support getopt-style argument reordering for non-flag arguments as an alternative to positional arguments.
+
 - Support automatic generate usage information.
 
 - Support issue errors when provide with invalid arguments.
@@ -160,6 +162,21 @@ both use this way, the parsing is as follows:
 - For argument ``ooo``, it is positional argument,
   the ``ooo_val`` will be set to user input's value.
 
+Support of non-flag/positional arguments
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For arguments which are not flags (i.e. don't start with a hyphen '-'),
+there are two ways in which they can be handled by the library:
+
+#. Positional arguments: these are defined in the ``args`` array with a NULL ``short_name`` field,
+   and long_name field that does not start with a hyphen '-'.
+   They are parsed as required-value arguments.
+
+#. As ignored, or unhandled arguments: if the ``ignore_non_flag_args`` field in the ``rte_argparse`` object is set to true,
+   then any non-flag arguments will be ignored by the parser and moved to the end of the argument list.
+   In this mode, no positional arguments are allowed.
+   The return value from ``rte_argparse_parse()`` will indicate the position of the first ignored non-flag argument.
+
 Supported Value Types
 ~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/lib/argparse/rte_argparse.c b/lib/argparse/rte_argparse.c
index 8b0fcec4b8..1e320749b4 100644
--- a/lib/argparse/rte_argparse.c
+++ b/lib/argparse/rte_argparse.c
@@ -289,6 +289,13 @@ verify_argparse(const struct rte_argparse *obj, size_t *nb_args)
 		return -EINVAL;
 	}
 
+	for (idx = 0; idx < RTE_DIM(obj->reserved_flags); idx++) {
+		if (obj->reserved_flags[idx]) {
+			ARGPARSE_LOG(ERR, "reserved flags cannot be set!");
+			return -EINVAL;
+		}
+	}
+
 	for (idx = 0; idx < RTE_DIM(obj->reserved); idx++) {
 		if (obj->reserved[idx] != 0) {
 			ARGPARSE_LOG(ERR, "reserved field must be zero!");
@@ -298,6 +305,10 @@ verify_argparse(const struct rte_argparse *obj, size_t *nb_args)
 
 	idx = 0;
 	while (obj->args[idx].name_long != NULL) {
+		if (is_arg_positional(&obj->args[idx]) && obj->ignore_non_flag_args) {
+			ARGPARSE_LOG(ERR, "Error validating argparse object: positional args are not allowed when ignore_non_flag_args is set!");
+			return -EINVAL;
+		}
 		ret = verify_argparse_arg(obj, idx);
 		if (ret != 0)
 			return ret;
@@ -678,6 +689,8 @@ parse_args(const struct rte_argparse *obj, bool *arg_parsed,
 	const struct rte_argparse_arg *arg;
 	uint32_t position_index = 0;
 	const char *arg_name;
+	size_t n_args_to_move;
+	char **args_to_move;
 	uint32_t arg_idx;
 	char *curr_argv;
 	char *has_equal;
@@ -685,6 +698,13 @@ parse_args(const struct rte_argparse *obj, bool *arg_parsed,
 	int ret;
 	int i;
 
+	n_args_to_move = 0;
+	args_to_move = calloc(argc, sizeof(args_to_move[0]));
+	if (args_to_move == NULL) {
+		ARGPARSE_LOG(ERR, "failed to allocate memory for internal flag processing!");
+		return -ENOMEM;
+	}
+
 	for (i = 1; i < argc; i++) {
 		curr_argv = argv[i];
 
@@ -694,16 +714,23 @@ parse_args(const struct rte_argparse *obj, bool *arg_parsed,
 		}
 
 		if (curr_argv[0] != '-') {
+			if (obj->ignore_non_flag_args) {
+				/* Move non-flag args to args_to_move array. */
+				args_to_move[n_args_to_move++] = curr_argv;
+				argv[i] = NULL;
+				continue;
+			}
 			/* process positional parameters. */
 			position_index++;
 			if (position_index > position_count) {
 				ARGPARSE_LOG(ERR, "too many positional arguments %s!", curr_argv);
-				return -EINVAL;
+				ret = -EINVAL;
+				goto err_out;
 			}
 			arg = find_position_arg(obj, position_index);
 			ret = parse_arg_val(obj, arg->name_long, arg, curr_argv);
 			if (ret != 0)
-				return ret;
+				goto err_out;
 			continue;
 		}
 
@@ -718,26 +745,30 @@ parse_args(const struct rte_argparse *obj, bool *arg_parsed,
 		arg = find_option_arg(obj, &arg_idx, curr_argv, has_equal, &arg_name);
 		if (arg == NULL || arg_name == NULL) {
 			ARGPARSE_LOG(ERR, "unknown argument %s!", curr_argv);
-			return -EINVAL;
+			ret = -EINVAL;
+			goto err_out;
 		}
 
 		if (arg_parsed[arg_idx] && !arg_attr_flag_multi(arg)) {
 			ARGPARSE_LOG(ERR, "argument %s should not occur multiple times!", arg_name);
-			return -EINVAL;
+			ret = -EINVAL;
+			goto err_out;
 		}
 
 		value = (has_equal != NULL ? has_equal + 1 : NULL);
 		if (arg->value_required == RTE_ARGPARSE_VALUE_NONE) {
 			if (value != NULL) {
 				ARGPARSE_LOG(ERR, "argument %s should not take value!", arg_name);
-				return -EINVAL;
+				ret = -EINVAL;
+				goto err_out;
 			}
 		} else if (arg->value_required == RTE_ARGPARSE_VALUE_REQUIRED) {
 			if (value == NULL) {
 				if (i >= argc - 1) {
 					ARGPARSE_LOG(ERR, "argument %s doesn't have value!",
 							arg_name);
-					return -EINVAL;
+					ret = -EINVAL;
+					goto err_out;
 				}
 				/* Set value and make i move next. */
 				value = argv[++i];
@@ -748,13 +779,28 @@ parse_args(const struct rte_argparse *obj, bool *arg_parsed,
 
 		ret = parse_arg_val(obj, arg_name, arg, value);
 		if (ret != 0)
-			return ret;
+			goto err_out;
 
 		/* This argument parsed success! then mark it parsed. */
 		arg_parsed[arg_idx] = true;
 	}
 
-	return i;
+	ret = i;
+	if (n_args_to_move > 0) {
+		/* Close the gaps in argv array by moving elements down filling in the NULLs. */
+		int j = 1;
+		for (i = 1; i < ret; i++) {
+			if (argv[i] != NULL)
+				argv[j++] = argv[i];
+		}
+		ret = j; /* only return args actually handled */
+		/* Then put contents of the args_to_move array into the argv in the space left. */
+		for (i = 0; i < (int)n_args_to_move; i++)
+			argv[j++] = args_to_move[i];
+	}
+err_out:
+	free(args_to_move);
+	return ret;
 }
 
 static uint32_t
diff --git a/lib/argparse/rte_argparse.h b/lib/argparse/rte_argparse.h
index 991f084927..ecf04396e9 100644
--- a/lib/argparse/rte_argparse.h
+++ b/lib/argparse/rte_argparse.h
@@ -158,6 +158,12 @@ struct rte_argparse {
 	const char *epilog;
 	/** Whether exit when error. */
 	bool exit_on_error;
+	/** behave like getopt and move non-flag args to the end, ignoring them otherwise.
+	 * If this flag is specified, no positional args are allowed.
+	 */
+	bool ignore_non_flag_args;
+	/* reserved for future flags/other use */
+	bool reserved_flags[6];
 	/** User callback for parsing arguments. */
 	rte_arg_parser_t callback;
 	/** Opaque which used to invoke callback. */
-- 
2.48.1


  parent reply	other threads:[~2025-10-09 13:02 UTC|newest]

Thread overview: 184+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-05-20 16:40 [RFC PATCH 0/7] rework EAL argument parsing in DPDK Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 1/7] eal: add long options for each short option Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 2/7] argparse: add support for string and boolean args Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 3/7] argparse: make argparse EAL-args compatible Bruce Richardson
2025-05-22 10:44   ` Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 4/7] eal: define the EAL parameters in argparse format Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 5/7] eal: gather EAL args before processing Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 6/7] eal: combine parameter validation checks Bruce Richardson
2025-05-20 16:40 ` [RFC PATCH 7/7] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-08 17:20 ` [RFC PATCH v2 0/5] rework EAL argument parsing in DPDK Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 1/5] eal: add long options for each short option Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 2/5] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 3/5] eal: gather EAL args before processing Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 4/5] eal: combine parameter validation checks Bruce Richardson
2025-07-08 17:20   ` [RFC PATCH v2 5/5] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-08 18:41   ` [RFC PATCH v2 0/5] rework EAL argument parsing in DPDK Stephen Hemminger
2025-07-09  7:50     ` Bruce Richardson
2025-07-09 12:30   ` David Marchand
2025-07-09 12:54     ` Bruce Richardson
2025-07-17 10:41   ` David Marchand
2025-07-17 10:54     ` Bruce Richardson
2025-07-18 14:33 ` [PATCH v3 0/9] rework EAL argument parsing Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-21  8:43     ` David Marchand
2025-07-21  9:00       ` Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 4/9] eal: add long options for each short option Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-21  8:41     ` David Marchand
2025-07-21  9:05       ` Bruce Richardson
2025-07-21 12:53         ` Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-18 14:33   ` [PATCH v3 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-18 14:41   ` [PATCH v3 0/9] rework EAL argument parsing Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 " Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 4/9] eal: add long options for each short option Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-21 15:08 ` [PATCH v4 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-21 15:16 ` [PATCH v5 0/9] rework EAL argument parsing Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 4/9] eal: add long options for each short option Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-21 15:16   ` [PATCH v5 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-22 14:03 ` [PATCH v6 0/9] rework EAL argument parsing Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 1/9] build: add define for the OS environment name Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 2/9] argparse: export function to print help text for object Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 3/9] argparse: allow user-override of help printing Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 4/9] eal: add long options for each short option Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 5/9] eal: define the EAL parameters in argparse format Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 6/9] eal: gather EAL args before processing Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 7/9] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 8/9] eal: combine parameter validation checks Bruce Richardson
2025-07-22 14:03   ` [PATCH v6 9/9] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-09-30 13:06   ` [PATCH v6 0/9] rework EAL argument parsing David Marchand
2025-09-30 13:31     ` Bruce Richardson
2025-07-23 16:19 ` [PATCH v7 00/13] Simplify running with high-numbered CPUs Bruce Richardson
2025-07-23 16:19   ` [PATCH v7 01/13] build: add define for the OS environment name Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 02/13] argparse: export function to print help text for object Bruce Richardson
2025-09-30 12:20     ` David Marchand
2025-07-23 16:20   ` [PATCH v7 03/13] argparse: allow user-override of help printing Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 04/13] argparse: add documentation on supported value types Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 05/13] eal: add long options for each short option Bruce Richardson
2025-09-30 12:21     ` David Marchand
2025-07-23 16:20   ` [PATCH v7 06/13] eal: define the EAL parameters in argparse format Bruce Richardson
2025-09-30 12:21     ` David Marchand
2025-09-30 15:12       ` Bruce Richardson
2025-10-01  8:46         ` David Marchand
2025-10-01 10:15           ` Bruce Richardson
2025-09-30 12:45     ` David Marchand
2025-09-30 12:58       ` Bruce Richardson
2025-09-30 13:16         ` David Marchand
2025-07-23 16:20   ` [PATCH v7 07/13] eal: gather EAL args before processing Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 08/13] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 09/13] eal: combine parameter validation checks Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 10/13] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 11/13] argparse: add support for parsing core lists Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 12/13] eal: simplify running CPUs with ids above max lcores Bruce Richardson
2025-07-23 16:20   ` [PATCH v7 13/13] eal: add warnings about ignored options Bruce Richardson
2025-08-29 14:39   ` [PATCH v7 00/13] Simplify running with high-numbered CPUs Bruce Richardson
2025-10-02 17:42 ` [PATCH v8 00/18] " Bruce Richardson
2025-10-02 17:42   ` [PATCH v8 01/18] build: add define for the OS environment name Bruce Richardson
2025-10-02 17:42   ` [PATCH v8 02/18] argparse: export function to print help text for object Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 03/18] argparse: allow user-override of help printing Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 04/18] argparse: add documentation on supported value types Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 05/18] argparse: add support for parsing core lists Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 06/18] eal: add long options for each short option Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 07/18] eal: define the EAL parameters in argparse format Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 08/18] eal: gather EAL args before processing Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 09/18] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 10/18] eal: combine parameter validation checks Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 11/18] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 12/18] eal: automatically init arg list options Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 13/18] eal: add internal fn for converting cpuset to string Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 14/18] eal: use common cpuset to string function Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 15/18] eal: introduce lcore remapping option for coremasks Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 16/18] eal: rework internal coremask parsing to use cpu sets Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 17/18] eal: allow lcore id remapping with core lists Bruce Richardson
2025-10-02 17:43   ` [PATCH v8 18/18] eal: allow lcore remapping with autodetected core affinity Bruce Richardson
2025-10-03  8:13   ` [PATCH v8 00/18] Simplify running with high-numbered CPUs Bruce Richardson
2025-10-06  7:42   ` Morten Brørup
2025-10-06  8:41     ` Bruce Richardson
2025-10-07 15:30       ` Bruce Richardson
2025-10-03  8:14 ` [PATCH v9 " Bruce Richardson
2025-10-03  8:14   ` [PATCH v9 01/18] build: add define for the OS environment name Bruce Richardson
2025-10-03  8:14   ` [PATCH v9 02/18] argparse: export function to print help text for object Bruce Richardson
2025-10-03  8:14   ` [PATCH v9 03/18] argparse: allow user-override of help printing Bruce Richardson
2025-10-03  8:14   ` [PATCH v9 04/18] argparse: add documentation on supported value types Bruce Richardson
2025-10-03  8:14   ` [PATCH v9 05/18] argparse: add support for parsing core lists Bruce Richardson
2025-10-03  8:14   ` [PATCH v9 06/18] eal: add long options for each short option Bruce Richardson
2025-10-03  8:14   ` [PATCH v9 07/18] eal: define the EAL parameters in argparse format Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 08/18] eal: gather EAL args before processing Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 09/18] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 10/18] eal: combine parameter validation checks Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 11/18] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 12/18] eal: automatically init arg list options Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 13/18] eal: add internal fn for converting cpuset to string Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 14/18] eal: use common cpuset to string function Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 15/18] eal: introduce lcore remapping option for coremasks Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 16/18] eal: rework internal coremask parsing to use cpu sets Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 17/18] eal: allow lcore id remapping with core lists Bruce Richardson
2025-10-03  8:15   ` [PATCH v9 18/18] eal: allow lcore remapping with autodetected core affinity Bruce Richardson
2025-10-06 14:10   ` [PATCH v9 00/18] Simplify running with high-numbered CPUs David Marchand
2025-10-06 14:42     ` Bruce Richardson
2025-10-07 16:15     ` Bruce Richardson
2025-10-08  7:53       ` Thomas Monjalon
2025-10-08  8:11         ` Bruce Richardson
2025-10-08 20:42 ` [PATCH v10 00/21] " Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 01/21] build: add define for the OS environment name Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 02/21] test/func_reentrancy: fix args to EAL init call Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 03/21] argparse: export function to print help text for object Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 04/21] argparse: allow user-override of help printing Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 05/21] argparse: add documentation on supported value types Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 06/21] argparse: add support for parsing core lists Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 07/21] argparse: allow optional flag reordering Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 08/21] argparse: support parameters to short options without "=" Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 09/21] eal: add long options for each short option Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 10/21] eal: define the EAL parameters in argparse format Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 11/21] eal: gather EAL args before processing Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 12/21] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 13/21] eal: combine parameter validation checks Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 14/21] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 15/21] eal: automatically init arg list options Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 16/21] eal: add internal fn for converting cpuset to string Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 17/21] eal: use common cpuset to string function Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 18/21] eal: introduce lcore remapping option for coremasks Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 19/21] eal: rework internal coremask parsing to use cpu sets Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 20/21] eal: allow lcore ID remapping with core lists Bruce Richardson
2025-10-08 20:42   ` [PATCH v10 21/21] eal: allow lcore remapping with autodetected core affinity Bruce Richardson
2025-10-09 13:00 ` [PATCH v11 00/21] Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 01/21] build: add define for the OS environment name Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 02/21] test/func_reentrancy: fix args to EAL init call Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 03/21] argparse: export function to print help text for object Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 04/21] argparse: allow user-override of help printing Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 05/21] argparse: add documentation on supported value types Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 06/21] argparse: add support for parsing core lists Bruce Richardson
2025-10-09 13:00   ` Bruce Richardson [this message]
2025-10-09 13:00   ` [PATCH v11 08/21] argparse: support parameters to short options without "=" Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 09/21] eal: add long options for each short option Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 10/21] eal: define the EAL parameters in argparse format Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 11/21] eal: gather EAL args before processing Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 12/21] eal: ensure proper cleanup on EAL init failure Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 13/21] eal: combine parameter validation checks Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 14/21] eal: simplify handling of conflicting cmdline options Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 15/21] eal: automatically init arg list options Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 16/21] eal: add internal fn for converting cpuset to string Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 17/21] eal: use common cpuset to string function Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 18/21] eal: introduce lcore remapping option for coremasks Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 19/21] eal: rework internal coremask parsing to use cpu sets Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 20/21] eal: allow lcore ID remapping with core lists Bruce Richardson
2025-10-09 13:00   ` [PATCH v11 21/21] eal: allow lcore remapping with autodetected core affinity Bruce Richardson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251009130056.2630343-8-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).