argparse additions and rework
cover argparse additions and rework
This patchset is based off the work to adjust how we do argument parsing inside EAL. To enable argparse to be effectively used for EAL, we have new features and some changes in the first two patches, which are relatively small - though are ABI/API affecting.
These add support for saving off strings and boolean values, have argparse stop parsing at a "--", and finally have argparse return the number of arguments actually parsed on success.
The third patch is a bigger change. It was inspired by the fact that when adding the boolean and string support we had to update some "MAX" value defines used in the code. This is obviously not good from an ABI/API perspective, once the library becomes part of the stable ABI. In order to remove these MAX values, patch 3 looks to replace the #define values with enums - which means some rework splitting the various flags into separate categories, and similarly splitting the single "flags" field with separate fields specifying if an argument value is required, what type that value should have, and then a final smaller field for any additional modifiers.
Bruce Richardson (3):
argparse: add support for string and boolean args
argparse: make argparse EAL-args compatible
argparse: use enums to remove max-value defines in lists
app/test/test_argparse.c | 235 ++++++++++++++----------- doc/guides/rel_notes/release_25_07.rst | 49 ++++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 184 ++++++++++++------- lib/argparse/rte_argparse.h | 91 +++++----- 6 files changed, 352 insertions(+), 231 deletions(-)
Signature · 1 line
2.48.1
PATCH 1/3 argparse: add support for string and boolean args
Sometimes we don't want to parse the string at all, when doing arg parsing, and just save it off for later. Add support for that.
Also, rather than assuming boolean values have to be the same size as uint8 (or some other size), add an explicitly type for that - which also allows checking for true/false and 0/1 values explicitly.
--- app/test/test_argparse.c | 25 +++++++++++++++++++ doc/guides/rel_notes/release_25_07.rst | 5 ++++ lib/argparse/rte_argparse.c | 34 ++++++++++++++++++++++++++ lib/argparse/rte_argparse.h | 6 ++++- 4 files changed, 69 insertions(+), 1 deletion(-)
app/test/test_argparse.c +25 -0
@@ -761,6 +761,12 @@ test_argparse_parse_type(void)char *str_erange_u8 =test_strdup ("256" );char *str_invalid =test_strdup ("1a" );char *str_ok =test_strdup ("123" ); +char *bool_true =test_strdup ("true" ); +char *bool_false =test_strdup ("false" ); +char *bool_invalid =test_strdup ("invalid" ); +char *bool_numeric_true =test_strdup ("1" ); +char *bool_numeric_false =test_strdup ("0" ); +char *bool_numeric_invalid =test_strdup ("2" );uint16_t val_u16;uint32_t val_u32;uint64_t val_u64;
@@ -823,6 +829,25 @@ test_argparse_parse_type(void)TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" ); +/* test for string parsing - all it does is save string, so all are valid */ +const char *val_str; + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); +TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" ); + +/* test for boolean parsing */ +bool val_bool = false; + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/rel_notes/release_25_07.rst +5 -0
@@ -55,6 +55,11 @@ New Features Also, make sure to start the actual text at the margin. ======================================================= +* **Added support for string and boolean types to the "argparse" library.** + + The "argparse" library now supports parsing of string and boolean types. + String values are simply saved as-is, + while the boolean support allows for values "true", "false", "1" or "0". Removed Items -------------
lib/argparse/rte_argparse.c +34 -0
@@ -508,6 +508,38 @@ parse_arg_u64(struct rte_argparse_arg *arg, const char *value)return 0 ; } +static int +parse_arg_str (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(char **)arg->val_saver = arg->val_set; +return 0 ; + } + *(const char **)arg->val_saver = value; + +return 0 ; +} + +static int +parse_arg_bool (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(bool *)arg->val_saver = (arg->val_set !=NULL ); +return 0 ; + } + +if (strcmp (value,"true" ) ==0 ||strcmp (value,"1" ) ==0 ) + *(bool *)arg->val_saver = true; +else if (strcmp (value,"false" ) ==0 ||strcmp (value,"0" ) ==0 ) + *(bool *)arg->val_saver = false; +else { +ARGPARSE_LOG (ERR ,"argument %s expects a boolean (true/false, 0/1) value!" , arg->name_long); +return -EINVAL ; + } + +return 0 ; +} +static int parse_arg_autosave (struct rte_argparse_arg *arg,const char *value) {
@@ -521,6 +553,8 @@ parse_arg_autosave(struct rte_argparse_arg *arg, const char *value) { parse_arg_u16 }, { parse_arg_u32 }, { parse_arg_u64 }, + { parse_arg_str}, + { parse_arg_bool }, };uint32_t index =arg_attr_val_type (arg);int ret = -EINVAL ;
lib/argparse/rte_argparse.h +5 -1
@@ -60,8 +60,12 @@ extern "C" {#define RTE_ARGPARSE_ARG_VALUE_U32 RTE_SHIFT_VAL64(4, 2)/** The argument's value is uint64 type. */ #define RTE_ARGPARSE_ARG_VALUE_U64 RTE_SHIFT_VAL64(5, 2) +/** The argument's value is string type. */ +#define RTE_ARGPARSE_ARG_VALUE_STR RTE_SHIFT_VAL64(6, 2) +/** The argument's value is boolean flag type. */ +#define RTE_ARGPARSE_ARG_VALUE_BOOL RTE_SHIFT_VAL64(7, 2)/** Max value type. */ -#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(6, 2) +#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(8, 2)/** * Flag for that argument support occur multiple times. * This flag can be set only when the argument is optional.
Signature · 1 line
2.48.1
Re: [PATCH 1/3] argparse: add support for string and boolean args
Quoted 8 lines · Bruce Richardson
Sometimes we don't want to parse the string at all, when doing arg parsing, and just save it off for later. Add support for that.
Also, rather than assuming boolean values have to be the same size as uint8 (or some other size), add an explicitly type for that - which also allows checking for true/false and 0/1 values explicitly.
Signed-off-by Bruce Richardson <[email protected]>
PATCH 2/3 argparse: make argparse EAL-args compatible
In reply to Bruce RichardsonThe 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.
--- app/test/test_argparse.c | 46 +++++++++++++------------- doc/guides/rel_notes/release_25_07.rst | 9 +++++ lib/argparse/rte_argparse.c | 12 +++++-- lib/argparse/rte_argparse.h | 3 +- 4 files changed, 43 insertions(+), 27 deletions(-)
app/test/test_argparse.c +23 -23
@@ -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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"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 >=0 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver[1 ] ==100 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver[2 ] ==200 ,"Argparse parse expect success!" );
@@ -780,7 +780,7 @@ test_argparse_parse_type(void) ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); -TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" ); +TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_int ==123 ,"Argparse parse type expect failed!" );/* test for u8 parsing */
@@ -792,7 +792,7 @@ test_argparse_parse_type(void)TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u8 =0 ; ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); -TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" ); +TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u8 ==123 ,"Argparse parse type expect failed!" );/* test for u16 parsing */
@@ -804,7 +804,7 @@ test_argparse_parse_type(void)TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u16 =0 ; ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); -TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" ); +TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u16 ==123 ,"Argparse parse type expect failed!" );/* test for u32 parsing */
@@ -816,7 +816,7 @@ test_argparse_parse_type(void)TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u32 =0 ; ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); -TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" ); +TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u32 ==123 ,"Argparse parse type expect failed!" );/* test for u64 parsing */
@@ -826,7 +826,7 @@ test_argparse_parse_type(void)TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u64 =0 ; ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); -TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" ); +TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" );/* test for string parsing - all it does is save string, so all are valid */
doc/guides/rel_notes/release_25_07.rst +9 -0
@@ -109,6 +109,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 ------------
lib/argparse/rte_argparse.c +9 -3
@@ -605,6 +605,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++;
@@ -668,7 +674,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
@@ -784,7 +790,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) {
@@ -792,7 +798,7 @@ rte_argparse_parse(struct rte_argparse *obj, int argc, char **argv)exit (0 ); } -return 0 ; +return ret; error:if (obj->exit_on_error)
lib/argparse/rte_argparse.h +2 -1
@@ -183,7 +183,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);
Signature · 1 line
2.48.1
Re: [PATCH 2/3] argparse: make argparse EAL-args compatible
Quoted 23 lines · Bruce Richardson
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 parsedFix 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 <[email protected]>--- app/test/test_argparse.c | 46 +++++++++++++------------- doc/guides/rel_notes/release_25_07.rst | 9 +++++ lib/argparse/rte_argparse.c | 12 +++++-- lib/argparse/rte_argparse.h | 3 +- 4 files changed, 43 insertions(+), 27 deletions(-)app/test/test_argparse.c +0
-0
app/test/test_argparse.c test_argparse_opt_autosave_parse_int_of_no_val(void) · line 363
Quoted 5 lines
app/test/test_argparse.c +1
-1@@ -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 >=0 ,"Argparse parse expect success!" );
Please compared with specific number, eg. TEST_ASSERT(ret == 2, "xxx");
...
app/test/test_argparse.c test_argparse_parse_type(void) · line 783
Quoted 7 lines
app/test/test_argparse.c +1
-1@@ -780,7 +780,7 @@ test_argparse_parse_type(void) ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); -TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" ); +TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );
No need for rte_argparse_parse_type() API, this API still return 0 if success.
...
lib/argparse/rte_argparse.h struct rte_argparse { · line 187
Quoted 11 lines
lib/argparse/rte_argparse.h +2
-1@@ -183,7 +183,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.
Please add note for "stops processing arguments when a ``--`` argument is encountered".
Quoted 3 lines
lib/argparse/rte_argparse.h +0
-0*/ __rte_experimental int rte_argparse_parse(struct rte_argparse *obj, int argc, char **argv);
Re: [PATCH 2/3] argparse: make argparse EAL-args compatible
Quoted 46 lines · fengchengwen
Quoted 23 lines · Bruce Richardson
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 parsedFix 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 <[email protected]>--- app/test/test_argparse.c | 46 +++++++++++++------------- doc/guides/rel_notes/release_25_07.rst | 9 +++++ lib/argparse/rte_argparse.c | 12 +++++-- lib/argparse/rte_argparse.h | 3 +- 4 files changed, 43 insertions(+), 27 deletions(-)app/test/test_argparse.c +0
-0app/test/test_argparse.c test_argparse_opt_autosave_parse_int_of_no_val(void) · line 363
Quoted 5 lines
app/test/test_argparse.c +1
-1@@ -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 >=0 ,"Argparse parse expect success!" );Please compared with specific number, eg.
TEST_ASSERT(ret == 2, "xxx");...
app/test/test_argparse.c test_argparse_parse_type(void) · line 783
Quoted 7 lines
app/test/test_argparse.c +1
-1@@ -780,7 +780,7 @@ test_argparse_parse_type(void) ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); -TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" ); +TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );No need for
rte_argparse_parse_type()API, this API still return 0 if success....
Quoted 14 lines
lib/argparse/rte_argparse.h struct rte_argparse { · line 187
Quoted 11 lines
lib/argparse/rte_argparse.h +2
-1@@ -183,7 +183,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. Please add note for "stops processing arguments when a ``--`` argument is encountered".
Thanks for the review. All 3 comments fixed in v2 patchset.
PATCH 3/3 argparse: use enums to remove max-value defines in lists
In reply to Bruce RichardsonThe use of lists of #defines with _MAX entries at the end causes issues for ABI compatibility as those MAX values often leak through to applications and can cause issues when changed.
We can rework the code to increase type safety by splitting the flags field and using enums for each set of values explicitly:
* One enum for whether an argument takes a parameter or not (or optionally takes one)
* One enum for the type of the argument.
* A separate flags field for any additional info - right now this is only to indicate an argument can appear more than once.
The use of the MAX field is no longer necessary using the enums as we can use an inline function with a switch statement to check for valid values. Compilers like GCC will warn when an enum value is missing from the switch statement, easing future maintenance if enum values are added.
--- app/test/test_argparse.c | 178 ++++++++++++------------- doc/guides/rel_notes/release_25_07.rst | 35 +++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 144 ++++++++++---------- lib/argparse/rte_argparse.h | 92 +++++++------ 6 files changed, 255 insertions(+), 218 deletions(-)
app/test/test_argparse.c +87 -91
@@ -79,8 +79,8 @@ test_argparse_callback(uint32_t index, const char *value, void *opaque) .exit_on_error = false, \ .callback = test_argparse_callback, \ .args = { \ - { "--abc", "-a", "abc argument", (void *)1, (void *)1, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ - { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ + { "--abc", "-a", "abc argument", (void *)1, (void *)1, RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ + { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ ARGPARSE_ARG_END(), \ }, \ }
@@ -188,27 +188,20 @@ test_argparse_invalid_arg_help(void)static int test_argparse_invalid_has_val (void ) { -uint64_t set_mask[] = {0 , -RTE_ARGPARSE_ARG_NO_VALUE , -RTE_ARGPARSE_ARG_OPTIONAL_VALUE - }; +uint64_t invalid_values[] = { +RTE_ARGPARSE_VALUE_NONE , +RTE_ARGPARSE_VALUE_OPTIONAL , + };struct rte_argparse *obj;uint32_t index;int ret; -/* test optional arg don't config has-value. */ - obj =test_argparse_init_obj (); - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); -/* test positional arg don't config required-value. */ -for (index =0 ; index <RTE_DIM (set_mask); index++) { +for (index =0 ; index <RTE_DIM (invalid_values); index++) { obj =test_argparse_init_obj (); obj->args[0 ].name_long ="abc" ; obj->args[0 ].name_short =NULL ; - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - obj->args[0 ].flags |= set_mask[index]; + obj->args[0 ].value_required = invalid_values[index]; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); }
@@ -225,14 +218,15 @@ test_argparse_invalid_arg_saver(void)/* test saver == NULL with val-type != 0. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test saver == NULL with callback is NULL. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->callback =NULL ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -241,15 +235,7 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - -/* test saver != NULL with val-type is max. */ - obj =test_argparse_init_obj (); - obj->args[0 ].val_saver = (void *)1 ; - obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_MAX ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -257,7 +243,8 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -272,9 +259,7 @@ test_argparse_invalid_arg_flags(void)/* test set unused bits. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |= ~(RTE_ARGPARSE_HAS_VAL_BITMASK | -RTE_ARGPARSE_VAL_TYPE_BITMASK | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ); + obj->args[0 ].flags |= ~(RTE_ARGPARSE_FLAG_SUPPORT_MULTI ); ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -284,14 +269,15 @@ test_argparse_invalid_arg_flags(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test optional arg enabled multiple but prased by autosave. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |=RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -344,7 +330,6 @@ test_argparse_invalid_option(void)static int test_argparse_opt_autosave_parse_int_of_no_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -355,7 +340,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -363,7 +349,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)TEST_ASSERT (ret >=0 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -376,7 +363,6 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)static int test_argparse_opt_autosave_parse_int_of_required_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -387,7 +373,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -396,7 +383,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (ret >=0 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -404,7 +392,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test invalid value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); argv[2 ] =test_strdup ("100a" );
@@ -417,7 +406,6 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)static int test_argparse_opt_autosave_parse_int_of_optional_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -429,14 +417,16 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; 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 (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -444,13 +434,15 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; 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 (val_saver ==200 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -458,12 +450,14 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==200 ,"Argparse parse expect success!" );/* test with option value, but with wrong value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=200a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200a" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -498,7 +492,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -506,7 +500,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void)TEST_ASSERT (ret >=0 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -549,7 +543,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -558,7 +552,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void)TEST_ASSERT (ret >=0 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -566,12 +560,12 @@ test_argparse_opt_callback_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test no more parameters. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -613,7 +607,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -621,7 +615,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (ret >=0 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==10 ,"Argparse parse expect success!" ); - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -629,13 +623,13 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==10 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; 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 (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t=100" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -643,7 +637,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; argv[1 ] =test_strdup ("-t=100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -654,7 +648,6 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)static int test_argparse_pos_autosave_parse_int (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -666,7 +659,8 @@ test_argparse_pos_autosave_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -675,14 +669,16 @@ test_argparse_pos_autosave_parse_int(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test positional autosave parse failed. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test too much position parameters. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; argv[1 ] =test_strdup ("100" ); argv[2 ] =test_strdup ("200" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -727,12 +723,12 @@ test_argparse_pos_callback_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long ="test-long2" ; obj->args[1 ].name_short =NULL ; obj->args[1 ].val_saver =NULL ; obj->args[1 ].val_set = (void *)2 ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[2 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -743,8 +739,8 @@ test_argparse_pos_callback_parse_int(void)TEST_ASSERT (val_saver[2 ] ==200 ,"Argparse parse expect success!" );/* test positional callback parse failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("200a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -775,78 +771,78 @@ test_argparse_parse_type(void)int ret;/* test for int parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_int ==123 ,"Argparse parse type expect failed!" );/* test for u8 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u8 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u8 ==123 ,"Argparse parse type expect failed!" );/* test for u16 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u16 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u16 ==123 ,"Argparse parse type expect failed!" );/* test for u32 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u32 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u32 ==123 ,"Argparse parse type expect failed!" );/* test for u64 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u64 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret >=0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" );/* test for string parsing - all it does is save string, so all are valid */ const char *val_str; - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_STR , &val_str);TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" );/* test for boolean parsing */ bool val_bool = false; - ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); - ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); - ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); - ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/rel_notes/release_25_07.rst +35 -0
@@ -91,6 +91,10 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* argparse: The ``rte_argparse_arg`` structure used for defining arguments has been updated. + See next section, :ref:`ABI-Changes` for details. + +.. _ABI-Changes: ABI Changes -----------
@@ -117,6 +121,37 @@ ABI Changes ``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. + * The ``rte_argparse_arg`` structure used for defining arguments has been updated + to separate out into separate fields the options for: + + #. Whether the argument is required or optional. + #. What the type of the argument is (in case of saving the parameters automatically). + #. Any other flags - of which there is only one, ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI``, at this time. + + * With the splitting of the flags into separate enums for categories, + the names of the flags have been changed to better reflect their purpose. + The flags/enum values are: + + * For the ``value_required`` field: + + * ``RTE_ARGPARSE_VALUE_NONE`` + * ``RTE_ARGPARSE_VALUE_REQUIRED`` + * ``RTE_ARGPARSE_VALUE_OPTIONAL`` + + * For the ``value_type`` field: + + * ``RTE_ARGPARSE_VALUE_TYPE_NONE`` (No argument value type is specified, callback is to be used for processing.) + * ``RTE_ARGPARSE_VALUE_TYPE_INT`` + * ``RTE_ARGPARSE_VALUE_TYPE_U8`` + * ``RTE_ARGPARSE_VALUE_TYPE_U16`` + * ``RTE_ARGPARSE_VALUE_TYPE_U32`` + * ``RTE_ARGPARSE_VALUE_TYPE_U64`` + * ``RTE_ARGPARSE_VALUE_TYPE_STR`` + * ``RTE_ARGPARSE_VALUE_TYPE_BOOL`` + + * Other flags: + + * ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI`` (Allows the argument to be specified multiple times.) Known Issues
examples/dma/dmafwd.c +10 -10
@@ -644,43 +644,43 @@ dma_parse_args(int argc, char **argv, unsigned int nb_ports) .args = { { "--mac-updating", NULL, "Enable MAC addresses updating", &mac_updating, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--no-mac-updating", NULL, "Disable MAC addresses updating", &mac_updating, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--portmask", "-p", "hexadecimal bitmask of ports to configure", NULL, (void *)CMD_LINE_OPT_PORTMASK_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--nb-queue", "-q", "number of RX queues per port (default is 1)", &nb_queues, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--copy-type", "-c", "type of copy: sw|hw", NULL, (void *)CMD_LINE_OPT_COPY_TYPE_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--ring-size", "-s", "size of dmadev descriptor ring for hardware copy mode or rte_ring for software copy mode", &ring_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--dma-batch-size", "-b", "number of requests per DMA batch", &dma_batch_sz, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--max-frame-size", "-f", "max frame size", &max_frame_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--force-min-copy-size", "-m", "force a minimum copy length, even for smaller packets", &force_min_copy_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--stats-interval", "-i", "interval, in seconds, between stats prints (default is 1)", &stats_interval, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, ARGPARSE_ARG_END(), },
examples/flow_filtering/main.c +2 -2
@@ -274,11 +274,11 @@ flow_filtering_parse_args(int argc, char **argv) .args = { { "--template", NULL, "Enable template API flow", &use_template_api, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--non-template", NULL, "Enable non template API flow", &use_template_api, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, ARGPARSE_ARG_END(), },
lib/argparse/rte_argparse.c +76 -68
246 lines not on this page · raw message
lib/argparse/rte_argparse.h +45 -47
119 lines not on this page · raw message
Signature · 1 line
2.48.1
Re: [PATCH 3/3] argparse: use enums to remove max-value defines in lists
It looks more clear and user-friendly for splitting the flag.
Quoted 20 lines · Bruce Richardson
The use of lists of #defines with
_MAXentries at the end causes issues for ABI compatibility as those MAX values often leak through to applications and can cause issues when changed.We can rework the code to increase type safety by splitting the flags field and using enums for each set of values explicitly:
* One enum for whether an argument takes a parameter or not (or optionally takes one)
* One enum for the type of the argument.
* A separate flags field for any additional info - right now this is only to indicate an argument can appear more than once.The use of the MAX field is no longer necessary using the enums as we can use an inline function with a switch statement to check for valid values. Compilers like GCC will warn when an enum value is missing from the switch statement, easing future maintenance if enum values are added.
Signed-off-by Bruce Richardson <[email protected]>
Quoted 20 lines · Bruce Richardson
This patchset is based off the work to adjust how we do argument parsing inside EAL. To enable argparse to be effectively used for EAL, we have new features and some changes in the first two patches, which are relatively small - though are ABI/API affecting.
These add support for saving off strings and boolean values, have argparse stop parsing at a "--", and finally have argparse return the number of arguments actually parsed on success.
The third patch is a bigger change. It was inspired by the fact that when adding the boolean and string support we had to update some "MAX" value defines used in the code. This is obviously not good from an ABI/API perspective, once the library becomes part of the stable ABI. In order to remove these MAX values, patch 3 looks to replace the #define values with enums - which means some rework splitting the various flags into separate categories, and similarly splitting the single "flags" field with separate fields specifying if an argument value is required, what type that value should have, and then a final smaller field for any additional modifiers.
Quoted 5 lines
Bruce Richardson (3):
argparse: add support for string and boolean args
argparse: make argparse EAL-args compatible
argparse: use enums to remove max-value defines in lists
Ping for review.
Chengwen, as maintainer of argparse, can you perhaps take a look at this set and give your feedback? I'm hoping to do some rework of EAL argument parsing using argparse (see [1]), which requires some of the changes in this patchset.
Thanks,
/Bruce
[1] https://patches.dpdk.org/project/dpdk/list/?series=35256&state=*
v2 cover argparse additions and rework
In reply to Bruce RichardsonThis patchset is based off the work to adjust how we do argument parsing inside EAL. To enable argparse to be effectively used for EAL, we have new features and some changes in the first two patches, which are relatively small - though are ABI/API affecting.
These add support for saving off strings and boolean values, have argparse stop parsing at a "--", and finally have argparse return the number of arguments actually parsed on success.
The third patch is a bigger change. It was inspired by the fact that when adding the boolean and string support we had to update some "MAX" value defines used in the code. This is obviously not good from an ABI/API perspective, once the library becomes part of the stable ABI. In order to remove these MAX values, patch 3 looks to replace the #define values with enums - which means some rework splitting the various flags into separate categories, and similarly splitting the single "flags" field with separate fields specifying if an argument value is required, what type that value should have, and then a final smaller field for any additional modifiers.
v2: minor changes to patch 2 (see log at end of that patch)
Bruce Richardson (3):
argparse: add support for string and boolean args
argparse: make argparse EAL-args compatible
argparse: use enums to remove max-value defines in lists
app/test/test_argparse.c | 229 ++++++++++++++----------- doc/guides/rel_notes/release_25_07.rst | 50 ++++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 184 ++++++++++++-------- lib/argparse/rte_argparse.h | 94 +++++----- 6 files changed, 355 insertions(+), 226 deletions(-)
--
2.48.1
PATCH v2 1/3 argparse: add support for string and boolean args
Sometimes we don't want to parse the string at all, when doing arg parsing, and just save it off for later. Add support for that.
Also, rather than assuming boolean values have to be the same size as uint8 (or some other size), add an explicitly type for that - which also allows checking for true/false and 0/1 values explicitly.
--- app/test/test_argparse.c | 25 ++++++++++++++++++ doc/guides/rel_notes/release_25_07.rst | 6 +++++ lib/argparse/rte_argparse.c | 35 ++++++++++++++++++++++++++ lib/argparse/rte_argparse.h | 6 ++++- 4 files changed, 71 insertions(+), 1 deletion(-)
app/test/test_argparse.c +25 -0
@@ -761,6 +761,12 @@ test_argparse_parse_type(void)char *str_erange_u8 =test_strdup ("256" );char *str_invalid =test_strdup ("1a" );char *str_ok =test_strdup ("123" ); +char *bool_true =test_strdup ("true" ); +char *bool_false =test_strdup ("false" ); +char *bool_invalid =test_strdup ("invalid" ); +char *bool_numeric_true =test_strdup ("1" ); +char *bool_numeric_false =test_strdup ("0" ); +char *bool_numeric_invalid =test_strdup ("2" );uint16_t val_u16;uint32_t val_u32;uint64_t val_u64;
@@ -823,6 +829,25 @@ test_argparse_parse_type(void)TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" ); +/* test for string parsing - all it does is save string, so all are valid */ +const char *val_str; + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); +TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" ); + +/* test for boolean parsing */ +bool val_bool = false; + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/rel_notes/release_25_07.rst +6 -0
@@ -83,6 +83,12 @@ New Features See the :doc:`../cryptodevs/zsda` guide for more details on the new driver. +* **Added support for string and boolean types to the "argparse" library.** + + The "argparse" library now supports parsing of string and boolean types. + String values are simply saved as-is, + while the boolean support allows for values "true", "false", "1" or "0". + Removed Items -------------
lib/argparse/rte_argparse.c +35 -0
@@ -508,6 +508,39 @@ parse_arg_u64(struct rte_argparse_arg *arg, const char *value)return 0 ; } +static int +parse_arg_str (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(char **)arg->val_saver = arg->val_set; +return 0 ; + } + *(const char **)arg->val_saver = value; + +return 0 ; +} + +static int +parse_arg_bool (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(bool *)arg->val_saver = (arg->val_set !=NULL ); +return 0 ; + } + +if (strcmp (value,"true" ) ==0 ||strcmp (value,"1" ) ==0 ) + *(bool *)arg->val_saver = true; +else if (strcmp (value,"false" ) ==0 ||strcmp (value,"0" ) ==0 ) + *(bool *)arg->val_saver = false; +else { +ARGPARSE_LOG (ERR ,"argument %s expects a boolean (true/false, 0/1) value!" , + arg->name_long); +return -EINVAL ; + } + +return 0 ; +} +static int parse_arg_autosave (struct rte_argparse_arg *arg,const char *value) {
@@ -521,6 +554,8 @@ parse_arg_autosave(struct rte_argparse_arg *arg, const char *value) { parse_arg_u16 }, { parse_arg_u32 }, { parse_arg_u64 }, + { parse_arg_str}, + { parse_arg_bool }, };uint32_t index =arg_attr_val_type (arg);int ret = -EINVAL ;
lib/argparse/rte_argparse.h +5 -1
@@ -60,8 +60,12 @@ extern "C" {#define RTE_ARGPARSE_ARG_VALUE_U32 RTE_SHIFT_VAL64(4, 2)/** The argument's value is uint64 type. */ #define RTE_ARGPARSE_ARG_VALUE_U64 RTE_SHIFT_VAL64(5, 2) +/** The argument's value is string type. */ +#define RTE_ARGPARSE_ARG_VALUE_STR RTE_SHIFT_VAL64(6, 2) +/** The argument's value is boolean flag type. */ +#define RTE_ARGPARSE_ARG_VALUE_BOOL RTE_SHIFT_VAL64(7, 2)/** Max value type. */ -#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(6, 2) +#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(8, 2)/** * Flag for that argument support occur multiple times. * This flag can be set only when the argument is optional.
Signature · 1 line
2.48.1
PATCH v2 2/3 argparse: make argparse EAL-args compatible
In reply to Bruce RichardsonThe 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.
---
v2:
* change tests to check for correct number of parameters parsed, not just >= 0
* revert unnecessary changes to the parse_type() function tests
* added doxygen comment that the parse() function stops on "--"
--- 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(-)
app/test/test_argparse.c +18 -18
@@ -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!" );
doc/guides/rel_notes/release_25_07.rst +9 -0
@@ -138,6 +138,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 ------------
lib/argparse/rte_argparse.c +9 -3
@@ -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)
lib/argparse/rte_argparse.h +4 -2
@@ -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);
Signature · 1 line
2.48.1
PATCH v2 3/3 argparse: use enums to remove max-value defines in lists
In reply to Bruce RichardsonThe use of lists of #defines with _MAX entries at the end causes issues for ABI compatibility as those MAX values often leak through to applications and can cause issues when changed.
We can rework the code to increase type safety by splitting the flags field and using enums for each set of values explicitly:
* One enum for whether an argument takes a parameter or not (or optionally takes one)
* One enum for the type of the argument.
* A separate flags field for any additional info - right now this is only to indicate an argument can appear more than once.
The use of the MAX field is no longer necessary using the enums as we can use an inline function with a switch statement to check for valid values. Compilers like GCC will warn when an enum value is missing from the switch statement, easing future maintenance if enum values are added.
--- app/test/test_argparse.c | 182 ++++++++++++------------- doc/guides/rel_notes/release_25_07.rst | 35 +++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 143 ++++++++++--------- lib/argparse/rte_argparse.h | 92 ++++++------- 6 files changed, 259 insertions(+), 217 deletions(-)
app/test/test_argparse.c +91 -91
@@ -79,8 +79,10 @@ test_argparse_callback(uint32_t index, const char *value, void *opaque) .exit_on_error = false, \ .callback = test_argparse_callback, \ .args = { \ - { "--abc", "-a", "abc argument", (void *)1, (void *)1, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ - { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ + { "--abc", "-a", "abc argument", (void *)1, (void *)1, \ + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ + { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, \ + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ ARGPARSE_ARG_END(), \ }, \ }
@@ -188,27 +190,20 @@ test_argparse_invalid_arg_help(void)static int test_argparse_invalid_has_val (void ) { -uint64_t set_mask[] = {0 , -RTE_ARGPARSE_ARG_NO_VALUE , -RTE_ARGPARSE_ARG_OPTIONAL_VALUE - }; +uint64_t invalid_values[] = { +RTE_ARGPARSE_VALUE_NONE , +RTE_ARGPARSE_VALUE_OPTIONAL , + };struct rte_argparse *obj;uint32_t index;int ret; -/* test optional arg don't config has-value. */ - obj =test_argparse_init_obj (); - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); -/* test positional arg don't config required-value. */ -for (index =0 ; index <RTE_DIM (set_mask); index++) { +for (index =0 ; index <RTE_DIM (invalid_values); index++) { obj =test_argparse_init_obj (); obj->args[0 ].name_long ="abc" ; obj->args[0 ].name_short =NULL ; - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - obj->args[0 ].flags |= set_mask[index]; + obj->args[0 ].value_required = invalid_values[index]; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); }
@@ -225,14 +220,15 @@ test_argparse_invalid_arg_saver(void)/* test saver == NULL with val-type != 0. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test saver == NULL with callback is NULL. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->callback =NULL ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -241,15 +237,7 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - -/* test saver != NULL with val-type is max. */ - obj =test_argparse_init_obj (); - obj->args[0 ].val_saver = (void *)1 ; - obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_MAX ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -257,7 +245,8 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -272,9 +261,7 @@ test_argparse_invalid_arg_flags(void)/* test set unused bits. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |= ~(RTE_ARGPARSE_HAS_VAL_BITMASK | -RTE_ARGPARSE_VAL_TYPE_BITMASK | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ); + obj->args[0 ].flags |= ~(RTE_ARGPARSE_FLAG_SUPPORT_MULTI ); ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -284,14 +271,15 @@ test_argparse_invalid_arg_flags(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test optional arg enabled multiple but prased by autosave. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |=RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -344,7 +332,6 @@ test_argparse_invalid_option(void)static int test_argparse_opt_autosave_parse_int_of_no_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -355,7 +342,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -363,7 +351,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -376,7 +365,6 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)static int test_argparse_opt_autosave_parse_int_of_required_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -387,7 +375,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -396,7 +385,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (ret ==3 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -404,7 +394,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test invalid value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); argv[2 ] =test_strdup ("100a" );
@@ -417,7 +408,6 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)static int test_argparse_opt_autosave_parse_int_of_optional_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -429,14 +419,16 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -444,13 +436,15 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=200" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==200 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -458,12 +452,14 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==200 ,"Argparse parse expect success!" );/* test with option value, but with wrong value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=200a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200a" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -498,7 +494,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -506,7 +502,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -549,7 +545,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -558,7 +554,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -566,12 +562,12 @@ test_argparse_opt_callback_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test no more parameters. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -613,7 +609,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -621,7 +617,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -629,13 +625,13 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==10 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=100" ); ret =rte_argparse_parse (obj,2 , argv);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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t=100" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -643,7 +639,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; argv[1 ] =test_strdup ("-t=100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -654,7 +650,6 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)static int test_argparse_pos_autosave_parse_int (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -666,7 +661,8 @@ test_argparse_pos_autosave_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -675,14 +671,16 @@ test_argparse_pos_autosave_parse_int(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test positional autosave parse failed. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test too much position parameters. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; argv[1 ] =test_strdup ("100" ); argv[2 ] =test_strdup ("200" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -727,12 +725,12 @@ test_argparse_pos_callback_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long ="test-long2" ; obj->args[1 ].name_short =NULL ; obj->args[1 ].val_saver =NULL ; obj->args[1 ].val_set = (void *)2 ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[2 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -743,8 +741,8 @@ test_argparse_pos_callback_parse_int(void)TEST_ASSERT (val_saver[2 ] ==200 ,"Argparse parse expect success!" );/* test positional callback parse failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("200a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -775,78 +773,80 @@ test_argparse_parse_type(void)int ret;/* test for int parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_int ==123 ,"Argparse parse type expect failed!" );/* test for u8 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u8 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u8 ==123 ,"Argparse parse type expect failed!" );/* test for u16 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u16 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u16 ==123 ,"Argparse parse type expect failed!" );/* test for u32 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u32 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u32 ==123 ,"Argparse parse type expect failed!" );/* test for u64 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u64 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" );/* test for string parsing - all it does is save string, so all are valid */ const char *val_str; - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_STR , &val_str);TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" );/* test for boolean parsing */ bool val_bool = false; - ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); - ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); - ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); - ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , + &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , + &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/rel_notes/release_25_07.rst +35 -0
@@ -120,6 +120,10 @@ API Changes Also, make sure to start the actual text at the margin. ======================================================= +* argparse: The ``rte_argparse_arg`` structure used for defining arguments has been updated. + See next section, :ref:`ABI-Changes` for details. + +.. _ABI-Changes: ABI Changes -----------
@@ -146,6 +150,37 @@ ABI Changes ``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. + * The ``rte_argparse_arg`` structure used for defining arguments has been updated + to separate out into separate fields the options for: + + #. Whether the argument is required or optional. + #. What the type of the argument is (in case of saving the parameters automatically). + #. Any other flags - of which there is only one, ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI``, at this time. + + * With the splitting of the flags into separate enums for categories, + the names of the flags have been changed to better reflect their purpose. + The flags/enum values are: + + * For the ``value_required`` field: + + * ``RTE_ARGPARSE_VALUE_NONE`` + * ``RTE_ARGPARSE_VALUE_REQUIRED`` + * ``RTE_ARGPARSE_VALUE_OPTIONAL`` + + * For the ``value_type`` field: + + * ``RTE_ARGPARSE_VALUE_TYPE_NONE`` (No argument value type is specified, callback is to be used for processing.) + * ``RTE_ARGPARSE_VALUE_TYPE_INT`` + * ``RTE_ARGPARSE_VALUE_TYPE_U8`` + * ``RTE_ARGPARSE_VALUE_TYPE_U16`` + * ``RTE_ARGPARSE_VALUE_TYPE_U32`` + * ``RTE_ARGPARSE_VALUE_TYPE_U64`` + * ``RTE_ARGPARSE_VALUE_TYPE_STR`` + * ``RTE_ARGPARSE_VALUE_TYPE_BOOL`` + + * Other flags: + + * ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI`` (Allows the argument to be specified multiple times.) Known Issues
examples/dma/dmafwd.c +10 -10
@@ -644,43 +644,43 @@ dma_parse_args(int argc, char **argv, unsigned int nb_ports) .args = { { "--mac-updating", NULL, "Enable MAC addresses updating", &mac_updating, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--no-mac-updating", NULL, "Disable MAC addresses updating", &mac_updating, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--portmask", "-p", "hexadecimal bitmask of ports to configure", NULL, (void *)CMD_LINE_OPT_PORTMASK_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--nb-queue", "-q", "number of RX queues per port (default is 1)", &nb_queues, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--copy-type", "-c", "type of copy: sw|hw", NULL, (void *)CMD_LINE_OPT_COPY_TYPE_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--ring-size", "-s", "size of dmadev descriptor ring for hardware copy mode or rte_ring for software copy mode", &ring_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--dma-batch-size", "-b", "number of requests per DMA batch", &dma_batch_sz, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--max-frame-size", "-f", "max frame size", &max_frame_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--force-min-copy-size", "-m", "force a minimum copy length, even for smaller packets", &force_min_copy_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--stats-interval", "-i", "interval, in seconds, between stats prints (default is 1)", &stats_interval, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, ARGPARSE_ARG_END(), },
examples/flow_filtering/main.c +2 -2
@@ -274,11 +274,11 @@ flow_filtering_parse_args(int argc, char **argv) .args = { { "--template", NULL, "Enable template API flow", &use_template_api, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--non-template", NULL, "Enable non template API flow", &use_template_api, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, ARGPARSE_ARG_END(), },
lib/argparse/rte_argparse.c +76 -67
246 lines not on this page · raw message
lib/argparse/rte_argparse.h +45 -47
119 lines not on this page · raw message
Signature · 1 line
2.48.1
Thanks for this patchset, Bruce.
Quoted 38 lines · Bruce Richardson
This patchset is based off the work to adjust how we do argument parsing inside EAL. To enable argparse to be effectively used for EAL, we have new features and some changes in the first two patches, which are relatively small - though are ABI/API affecting.
These add support for saving off strings and boolean values, have argparse stop parsing at a "--", and finally have argparse return the number of arguments actually parsed on success.
The third patch is a bigger change. It was inspired by the fact that when adding the boolean and string support we had to update some "MAX" value defines used in the code. This is obviously not good from an ABI/API perspective, once the library becomes part of the stable ABI. In order to remove these MAX values, patch 3 looks to replace the #define values with enums - which means some rework splitting the various flags into separate categories, and similarly splitting the single "flags" field with separate fields specifying if an argument value is required, what type that value should have, and then a final smaller field for any additional modifiers.
v2: minor changes to patch 2 (see log at end of that patch)
Bruce Richardson (3):
argparse: add support for string and boolean args
argparse: make argparse EAL-args compatible
argparse: use enums to remove max-value defines in listsapp/test/test_argparse.c | 229 ++++++++++++++----------- doc/guides/rel_notes/release_25_07.rst | 50 ++++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 184 ++++++++++++-------- lib/argparse/rte_argparse.h | 94 +++++----- 6 files changed, 355 insertions(+), 226 deletions(-)--
2.48.1
v3 cover argparse additions and rework
In reply to Bruce RichardsonThis patchset is based off the work to adjust how we do argument parsing inside EAL. To enable argparse to be effectively used for EAL, we have new features and some changes in the first two patches, which are relatively small - though are ABI/API affecting.
These add support for saving off strings and boolean values, have argparse stop parsing at a "--", and finally have argparse return the number of arguments actually parsed on success.
The third patch is a bigger change. It was inspired by the fact that when adding the boolean and string support we had to update some "MAX" value defines used in the code. This is obviously not good from an ABI/API perspective, once the library becomes part of the stable ABI. In order to remove these MAX values, patch 3 looks to replace the #define values with enums - which means some rework splitting the various flags into separate categories, and similarly splitting the single "flags" field with separate fields specifying if an argument value is required, what type that value should have, and then a final smaller field for any additional modifiers.
v3: additional doc updates to patch 3
v2: minor changes to patch 2 (see log at end of that patch)
Bruce Richardson (3):
argparse: add support for string and boolean args
argparse: make argparse EAL-args compatible
argparse: use enums to remove max-value defines in lists
app/test/test_argparse.c | 229 ++++++++++++++----------- doc/guides/prog_guide/argparse_lib.rst | 36 ++-- doc/guides/rel_notes/release_25_07.rst | 50 ++++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 184 ++++++++++++-------- lib/argparse/rte_argparse.h | 97 ++++++----- 7 files changed, 379 insertions(+), 241 deletions(-)
--
2.48.1
PATCH v3 1/3 argparse: add support for string and boolean args
Sometimes we don't want to parse the string at all, when doing arg parsing, and just save it off for later. Add support for that.
Also, rather than assuming boolean values have to be the same size as uint8 (or some other size), add an explicitly type for that - which also allows checking for true/false and 0/1 values explicitly.
--- app/test/test_argparse.c | 25 ++++++++++++++++++ doc/guides/rel_notes/release_25_07.rst | 6 +++++ lib/argparse/rte_argparse.c | 35 ++++++++++++++++++++++++++ lib/argparse/rte_argparse.h | 6 ++++- 4 files changed, 71 insertions(+), 1 deletion(-)
app/test/test_argparse.c +25 -0
@@ -761,6 +761,12 @@ test_argparse_parse_type(void)char *str_erange_u8 =test_strdup ("256" );char *str_invalid =test_strdup ("1a" );char *str_ok =test_strdup ("123" ); +char *bool_true =test_strdup ("true" ); +char *bool_false =test_strdup ("false" ); +char *bool_invalid =test_strdup ("invalid" ); +char *bool_numeric_true =test_strdup ("1" ); +char *bool_numeric_false =test_strdup ("0" ); +char *bool_numeric_invalid =test_strdup ("2" );uint16_t val_u16;uint32_t val_u32;uint64_t val_u64;
@@ -823,6 +829,25 @@ test_argparse_parse_type(void)TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" ); +/* test for string parsing - all it does is save string, so all are valid */ +const char *val_str; + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); +TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" ); + +/* test for boolean parsing */ +bool val_bool = false; + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/rel_notes/release_25_07.rst +6 -0
@@ -113,6 +113,12 @@ New Features See the :doc:`../prog_guide/eventdev/event_vector_adapter` guide for more details on the new library. +* **Added support for string and boolean types to the "argparse" library.** + + The "argparse" library now supports parsing of string and boolean types. + String values are simply saved as-is, + while the boolean support allows for values "true", "false", "1" or "0". + Removed Items -------------
lib/argparse/rte_argparse.c +35 -0
@@ -508,6 +508,39 @@ parse_arg_u64(struct rte_argparse_arg *arg, const char *value)return 0 ; } +static int +parse_arg_str (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(char **)arg->val_saver = arg->val_set; +return 0 ; + } + *(const char **)arg->val_saver = value; + +return 0 ; +} + +static int +parse_arg_bool (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(bool *)arg->val_saver = (arg->val_set !=NULL ); +return 0 ; + } + +if (strcmp (value,"true" ) ==0 ||strcmp (value,"1" ) ==0 ) + *(bool *)arg->val_saver = true; +else if (strcmp (value,"false" ) ==0 ||strcmp (value,"0" ) ==0 ) + *(bool *)arg->val_saver = false; +else { +ARGPARSE_LOG (ERR ,"argument %s expects a boolean (true/false, 0/1) value!" , + arg->name_long); +return -EINVAL ; + } + +return 0 ; +} +static int parse_arg_autosave (struct rte_argparse_arg *arg,const char *value) {
@@ -521,6 +554,8 @@ parse_arg_autosave(struct rte_argparse_arg *arg, const char *value) { parse_arg_u16 }, { parse_arg_u32 }, { parse_arg_u64 }, + { parse_arg_str}, + { parse_arg_bool }, };uint32_t index =arg_attr_val_type (arg);int ret = -EINVAL ;
lib/argparse/rte_argparse.h +5 -1
@@ -60,8 +60,12 @@ extern "C" {#define RTE_ARGPARSE_ARG_VALUE_U32 RTE_SHIFT_VAL64(4, 2)/** The argument's value is uint64 type. */ #define RTE_ARGPARSE_ARG_VALUE_U64 RTE_SHIFT_VAL64(5, 2) +/** The argument's value is string type. */ +#define RTE_ARGPARSE_ARG_VALUE_STR RTE_SHIFT_VAL64(6, 2) +/** The argument's value is boolean flag type. */ +#define RTE_ARGPARSE_ARG_VALUE_BOOL RTE_SHIFT_VAL64(7, 2)/** Max value type. */ -#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(6, 2) +#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(8, 2)/** * Flag for that argument support occur multiple times. * This flag can be set only when the argument is optional.
Signature · 1 line
2.48.1
PATCH v3 2/3 argparse: make argparse EAL-args compatible
In reply to Bruce RichardsonThe 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.
--- 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(-)
app/test/test_argparse.c +18 -18
@@ -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!" );
doc/guides/rel_notes/release_25_07.rst +9 -0
@@ -170,6 +170,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 ------------
lib/argparse/rte_argparse.c +9 -3
@@ -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)
lib/argparse/rte_argparse.h +4 -2
@@ -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);
Signature · 1 line
2.48.1
PATCH v3 3/3 argparse: use enums to remove max-value defines in lists
In reply to Bruce RichardsonThe use of lists of #defines with _MAX entries at the end causes issues for ABI compatibility as those MAX values often leak through to applications and can cause issues when changed.
We can rework the code to increase type safety by splitting the flags field and using enums for each set of values explicitly:
* One enum for whether an argument takes a parameter or not (or optionally takes one)
* One enum for the type of the argument.
* A separate flags field for any additional info - right now this is only to indicate an argument can appear more than once.
The use of the MAX field is no longer necessary using the enums as we can use an inline function with a switch statement to check for valid values. Compilers like GCC will warn when an enum value is missing from the switch statement, easing future maintenance if enum values are added.
---
v3:
* Update the argparse programmers guide doc.
* Document RTE_ARGPARSE_FLAG_SUPPORT_MULTI for doxygen
* Fix old doxygen cross reference
--- app/test/test_argparse.c | 182 ++++++++++++------------- doc/guides/prog_guide/argparse_lib.rst | 36 +++-- doc/guides/rel_notes/release_25_07.rst | 35 +++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 143 ++++++++++--------- lib/argparse/rte_argparse.h | 95 +++++++------ 7 files changed, 283 insertions(+), 232 deletions(-)
app/test/test_argparse.c +91 -91
@@ -79,8 +79,10 @@ test_argparse_callback(uint32_t index, const char *value, void *opaque) .exit_on_error = false, \ .callback = test_argparse_callback, \ .args = { \ - { "--abc", "-a", "abc argument", (void *)1, (void *)1, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ - { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ + { "--abc", "-a", "abc argument", (void *)1, (void *)1, \ + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ + { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, \ + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ ARGPARSE_ARG_END(), \ }, \ }
@@ -188,27 +190,20 @@ test_argparse_invalid_arg_help(void)static int test_argparse_invalid_has_val (void ) { -uint64_t set_mask[] = {0 , -RTE_ARGPARSE_ARG_NO_VALUE , -RTE_ARGPARSE_ARG_OPTIONAL_VALUE - }; +uint64_t invalid_values[] = { +RTE_ARGPARSE_VALUE_NONE , +RTE_ARGPARSE_VALUE_OPTIONAL , + };struct rte_argparse *obj;uint32_t index;int ret; -/* test optional arg don't config has-value. */ - obj =test_argparse_init_obj (); - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); -/* test positional arg don't config required-value. */ -for (index =0 ; index <RTE_DIM (set_mask); index++) { +for (index =0 ; index <RTE_DIM (invalid_values); index++) { obj =test_argparse_init_obj (); obj->args[0 ].name_long ="abc" ; obj->args[0 ].name_short =NULL ; - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - obj->args[0 ].flags |= set_mask[index]; + obj->args[0 ].value_required = invalid_values[index]; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); }
@@ -225,14 +220,15 @@ test_argparse_invalid_arg_saver(void)/* test saver == NULL with val-type != 0. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test saver == NULL with callback is NULL. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->callback =NULL ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -241,15 +237,7 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - -/* test saver != NULL with val-type is max. */ - obj =test_argparse_init_obj (); - obj->args[0 ].val_saver = (void *)1 ; - obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_MAX ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -257,7 +245,8 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -272,9 +261,7 @@ test_argparse_invalid_arg_flags(void)/* test set unused bits. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |= ~(RTE_ARGPARSE_HAS_VAL_BITMASK | -RTE_ARGPARSE_VAL_TYPE_BITMASK | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ); + obj->args[0 ].flags |= ~(RTE_ARGPARSE_FLAG_SUPPORT_MULTI ); ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -284,14 +271,15 @@ test_argparse_invalid_arg_flags(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test optional arg enabled multiple but prased by autosave. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |=RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -344,7 +332,6 @@ test_argparse_invalid_option(void)static int test_argparse_opt_autosave_parse_int_of_no_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -355,7 +342,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -363,7 +351,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -376,7 +365,6 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)static int test_argparse_opt_autosave_parse_int_of_required_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -387,7 +375,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -396,7 +385,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (ret ==3 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -404,7 +394,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test invalid value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); argv[2 ] =test_strdup ("100a" );
@@ -417,7 +408,6 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)static int test_argparse_opt_autosave_parse_int_of_optional_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -429,14 +419,16 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -444,13 +436,15 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=200" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==200 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -458,12 +452,14 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==200 ,"Argparse parse expect success!" );/* test with option value, but with wrong value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=200a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200a" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -498,7 +494,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -506,7 +502,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -549,7 +545,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -558,7 +554,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -566,12 +562,12 @@ test_argparse_opt_callback_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test no more parameters. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -613,7 +609,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -621,7 +617,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -629,13 +625,13 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==10 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=100" ); ret =rte_argparse_parse (obj,2 , argv);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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t=100" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -643,7 +639,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; argv[1 ] =test_strdup ("-t=100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -654,7 +650,6 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)static int test_argparse_pos_autosave_parse_int (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -666,7 +661,8 @@ test_argparse_pos_autosave_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -675,14 +671,16 @@ test_argparse_pos_autosave_parse_int(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test positional autosave parse failed. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test too much position parameters. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; argv[1 ] =test_strdup ("100" ); argv[2 ] =test_strdup ("200" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -727,12 +725,12 @@ test_argparse_pos_callback_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long ="test-long2" ; obj->args[1 ].name_short =NULL ; obj->args[1 ].val_saver =NULL ; obj->args[1 ].val_set = (void *)2 ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[2 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -743,8 +741,8 @@ test_argparse_pos_callback_parse_int(void)TEST_ASSERT (val_saver[2 ] ==200 ,"Argparse parse expect success!" );/* test positional callback parse failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("200a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -775,78 +773,80 @@ test_argparse_parse_type(void)int ret;/* test for int parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_int ==123 ,"Argparse parse type expect failed!" );/* test for u8 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u8 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u8 ==123 ,"Argparse parse type expect failed!" );/* test for u16 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u16 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u16 ==123 ,"Argparse parse type expect failed!" );/* test for u32 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u32 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u32 ==123 ,"Argparse parse type expect failed!" );/* test for u64 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u64 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" );/* test for string parsing - all it does is save string, so all are valid */ const char *val_str; - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_STR , &val_str);TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" );/* test for boolean parsing */ bool val_bool = false; - ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); - ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); - ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); - ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , + &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , + &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/prog_guide/argparse_lib.rst +22 -14
@@ -70,14 +70,14 @@ The following code demonstrates how to use: .exit_on_error = true, .callback = argparse_user_callback, .args = { - { "--aaa", "-a", "aaa argument", &aaa_val, (void *)100, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "--bbb", "-b", "bbb argument", &bbb_val, NULL, RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "--ccc", "-c", "ccc argument", &ccc_val, (void *)200, RTE_ARGPARSE_ARG_OPTIONAL_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "--ddd", "-d", "ddd argument", NULL, (void *)1, RTE_ARGPARSE_ARG_NO_VALUE }, - { "--eee", "-e", "eee argument", NULL, (void *)2, RTE_ARGPARSE_ARG_REQUIRED_VALUE }, - { "--fff", "-f", "fff argument", NULL, (void *)3, RTE_ARGPARSE_ARG_OPTIONAL_VALUE }, - { "ooo", NULL, "ooo argument", &ooo_val, NULL, RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "ppp", NULL, "ppp argument", NULL, (void *)300, RTE_ARGPARSE_ARG_REQUIRED_VALUE }, + { "--aaa", "-a", "aaa argument", &aaa_val, (void *)100, RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "--bbb", "-b", "bbb argument", &bbb_val, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "--ccc", "-c", "ccc argument", &ccc_val, (void *)200, RTE_ARGPARSE_VALUE_OPTIONAL, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "--ddd", "-d", "ddd argument", NULL, (void *)1, RTE_ARGPARSE_VALUE_NONE }, + { "--eee", "-e", "eee argument", NULL, (void *)2, RTE_ARGPARSE_VALUE_REQUIRED }, + { "--fff", "-f", "fff argument", NULL, (void *)3, RTE_ARGPARSE_VALUE_OPTIONAL }, + { "ooo", NULL, "ooo argument", &ooo_val, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "ppp", NULL, "ppp argument", NULL, (void *)300, RTE_ARGPARSE_VALUE_REQUIRED }, }, };
@@ -95,12 +95,12 @@ and the arguments which don't start with a hyphen (-) are positional arguments (they're ``ooo``/``ppp``). Every argument must be set whether to carry a value (one of -``RTE_ARGPARSE_ARG_NO_VALUE``, ``RTE_ARGPARSE_ARG_REQUIRED_VALUE`` and -``RTE_ARGPARSE_ARG_OPTIONAL_VALUE``). +``RTE_ARGPARSE_VALUE_NONE``, ``RTE_ARGPARSE_VALUE_REQUIRED`` and +``RTE_ARGPARSE_VALUE_OPTIONAL``). .. note:: - Positional argument must set ``RTE_ARGPARSE_ARG_REQUIRED_VALUE``. + Positional argument must set ``RTE_ARGPARSE_VALUE_REQUIRED``. User Input Requirements ~~~~~~~~~~~~~~~~~~~~~~~
@@ -135,7 +135,7 @@ their values are parsing in the order defined. Parsing by autosave way ~~~~~~~~~~~~~~~~~~~~~~~ -Argument of known value type (e.g. ``RTE_ARGPARSE_ARG_VALUE_INT``) +Argument of known value type (e.g. ``RTE_ARGPARSE_VALUE_TYPE_INT``) could be parsed using this autosave way, and its result will save in the ``val_saver`` field.
@@ -172,12 +172,20 @@ Multiple times argument ~~~~~~~~~~~~~~~~~~~~~~~ If want to support the ability to enter the same argument multiple times, -then should mark ``RTE_ARGPARSE_ARG_SUPPORT_MULTI`` in the ``flags`` field. +then should mark ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI`` in the ``flags`` field. For example: .. code-block:: C - { "--xyz", "-x", "xyz argument", NULL, (void *)10, RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_SUPPORT_MULTI }, + { + .long_name = "--xyz", + .short_name = "-x", + .desc = "xyz argument", + .val_set = (void *)10, + .val_mode = RTE_ARGPARSE_VALUE_REQUIRED, + // val_type is implicitly RTE_ARGPARSE_VALUE_TYPE_NONE, + .flags = RTE_ARGPARSE_FLAG_SUPPORT_MULTI, + }, Then the user input could contain multiple ``--xyz`` arguments.
doc/guides/rel_notes/release_25_07.rst +35 -0
@@ -152,6 +152,10 @@ API Changes * graph: Added ``graph`` field to the ``rte_node.dispatch`` structure. +* argparse: The ``rte_argparse_arg`` structure used for defining arguments has been updated. + See next section, :ref:`ABI-Changes` for details. + +.. _ABI-Changes: ABI Changes -----------
@@ -178,6 +182,37 @@ ABI Changes ``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. + * The ``rte_argparse_arg`` structure used for defining arguments has been updated + to separate out into separate fields the options for: + + #. Whether the argument is required or optional. + #. What the type of the argument is (in case of saving the parameters automatically). + #. Any other flags - of which there is only one, ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI``, at this time. + + * With the splitting of the flags into separate enums for categories, + the names of the flags have been changed to better reflect their purpose. + The flags/enum values are: + + * For the ``value_required`` field: + + * ``RTE_ARGPARSE_VALUE_NONE`` + * ``RTE_ARGPARSE_VALUE_REQUIRED`` + * ``RTE_ARGPARSE_VALUE_OPTIONAL`` + + * For the ``value_type`` field: + + * ``RTE_ARGPARSE_VALUE_TYPE_NONE`` (No argument value type is specified, callback is to be used for processing.) + * ``RTE_ARGPARSE_VALUE_TYPE_INT`` + * ``RTE_ARGPARSE_VALUE_TYPE_U8`` + * ``RTE_ARGPARSE_VALUE_TYPE_U16`` + * ``RTE_ARGPARSE_VALUE_TYPE_U32`` + * ``RTE_ARGPARSE_VALUE_TYPE_U64`` + * ``RTE_ARGPARSE_VALUE_TYPE_STR`` + * ``RTE_ARGPARSE_VALUE_TYPE_BOOL`` + + * Other flags: + + * ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI`` (Allows the argument to be specified multiple times.) Known Issues
examples/dma/dmafwd.c +10 -10
@@ -644,43 +644,43 @@ dma_parse_args(int argc, char **argv, unsigned int nb_ports) .args = { { "--mac-updating", NULL, "Enable MAC addresses updating", &mac_updating, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--no-mac-updating", NULL, "Disable MAC addresses updating", &mac_updating, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--portmask", "-p", "hexadecimal bitmask of ports to configure", NULL, (void *)CMD_LINE_OPT_PORTMASK_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--nb-queue", "-q", "number of RX queues per port (default is 1)", &nb_queues, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--copy-type", "-c", "type of copy: sw|hw", NULL, (void *)CMD_LINE_OPT_COPY_TYPE_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--ring-size", "-s", "size of dmadev descriptor ring for hardware copy mode or rte_ring for software copy mode", &ring_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--dma-batch-size", "-b", "number of requests per DMA batch", &dma_batch_sz, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--max-frame-size", "-f", "max frame size", &max_frame_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--force-min-copy-size", "-m", "force a minimum copy length, even for smaller packets", &force_min_copy_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--stats-interval", "-i", "interval, in seconds, between stats prints (default is 1)", &stats_interval, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, ARGPARSE_ARG_END(), },
examples/flow_filtering/main.c +2 -2
@@ -274,11 +274,11 @@ flow_filtering_parse_args(int argc, char **argv) .args = { { "--template", NULL, "Enable template API flow", &use_template_api, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--non-template", NULL, "Enable non template API flow", &use_template_api, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, ARGPARSE_ARG_END(), },
lib/argparse/rte_argparse.c +76 -67
246 lines not on this page · raw message
lib/argparse/rte_argparse.h +47 -48
128 lines not on this page · raw message
--
2.48.1
v4 cover argparse additions and rework
In reply to Bruce RichardsonThis patchset is based off the work to adjust how we do argument parsing inside EAL. To enable argparse to be effectively used for EAL, we have new features and some changes in the first two patches, which are relatively small - though are ABI/API affecting.
These add support for saving off strings and boolean values, have argparse stop parsing at a "--", and finally have argparse return the number of arguments actually parsed on success.
The third patch is a bigger change. It was inspired by the fact that when adding the boolean and string support we had to update some "MAX" value defines used in the code. This is obviously not good from an ABI/API perspective, once the library becomes part of the stable ABI. In order to remove these MAX values, patch 3 looks to replace the #define values with enums - which means some rework splitting the various flags into separate categories, and similarly splitting the single "flags" field with separate fields specifying if an argument value is required, what type that value should have, and then a final smaller field for any additional modifiers.
v4: rebase on main to avoid CI errors
v3: additional doc updates to patch 3
v2: minor changes to patch 2
Bruce Richardson (3):
argparse: add support for string and boolean args
argparse: make argparse EAL-args compatible
argparse: use enums to remove max-value defines in lists
app/test/test_argparse.c | 229 ++++++++++++++----------- doc/guides/prog_guide/argparse_lib.rst | 36 ++-- doc/guides/rel_notes/release_25_07.rst | 50 ++++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 184 ++++++++++++-------- lib/argparse/rte_argparse.h | 97 ++++++----- 7 files changed, 379 insertions(+), 241 deletions(-)
--
2.48.1
PATCH v4 1/3 argparse: add support for string and boolean args
Sometimes we don't want to parse the string at all, when doing arg parsing, and just save it off for later. Add support for that.
Also, rather than assuming boolean values have to be the same size as uint8 (or some other size), add an explicitly type for that - which also allows checking for true/false and 0/1 values explicitly.
--- app/test/test_argparse.c | 25 ++++++++++++++++++ doc/guides/rel_notes/release_25_07.rst | 6 +++++ lib/argparse/rte_argparse.c | 35 ++++++++++++++++++++++++++ lib/argparse/rte_argparse.h | 6 ++++- 4 files changed, 71 insertions(+), 1 deletion(-)
app/test/test_argparse.c +25 -0
@@ -761,6 +761,12 @@ test_argparse_parse_type(void)char *str_erange_u8 =test_strdup ("256" );char *str_invalid =test_strdup ("1a" );char *str_ok =test_strdup ("123" ); +char *bool_true =test_strdup ("true" ); +char *bool_false =test_strdup ("false" ); +char *bool_invalid =test_strdup ("invalid" ); +char *bool_numeric_true =test_strdup ("1" ); +char *bool_numeric_false =test_strdup ("0" ); +char *bool_numeric_invalid =test_strdup ("2" );uint16_t val_u16;uint32_t val_u32;uint64_t val_u64;
@@ -823,6 +829,25 @@ test_argparse_parse_type(void)TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" ); +/* test for string parsing - all it does is save string, so all are valid */ +const char *val_str; + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); +TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" ); + +/* test for boolean parsing */ +bool val_bool = false; + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); +TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/rel_notes/release_25_07.rst +6 -0
@@ -123,6 +123,12 @@ New Features * Added ``ip4 output`` feature arc processing in ``ip4_rewrite`` node. +* **Added support for string and boolean types to the "argparse" library.** + + The "argparse" library now supports parsing of string and boolean types. + String values are simply saved as-is, + while the boolean support allows for values "true", "false", "1" or "0". + Removed Items -------------
lib/argparse/rte_argparse.c +35 -0
@@ -508,6 +508,39 @@ parse_arg_u64(struct rte_argparse_arg *arg, const char *value)return 0 ; } +static int +parse_arg_str (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(char **)arg->val_saver = arg->val_set; +return 0 ; + } + *(const char **)arg->val_saver = value; + +return 0 ; +} + +static int +parse_arg_bool (struct rte_argparse_arg *arg,const char *value) +{ +if (value ==NULL ) { + *(bool *)arg->val_saver = (arg->val_set !=NULL ); +return 0 ; + } + +if (strcmp (value,"true" ) ==0 ||strcmp (value,"1" ) ==0 ) + *(bool *)arg->val_saver = true; +else if (strcmp (value,"false" ) ==0 ||strcmp (value,"0" ) ==0 ) + *(bool *)arg->val_saver = false; +else { +ARGPARSE_LOG (ERR ,"argument %s expects a boolean (true/false, 0/1) value!" , + arg->name_long); +return -EINVAL ; + } + +return 0 ; +} +static int parse_arg_autosave (struct rte_argparse_arg *arg,const char *value) {
@@ -521,6 +554,8 @@ parse_arg_autosave(struct rte_argparse_arg *arg, const char *value) { parse_arg_u16 }, { parse_arg_u32 }, { parse_arg_u64 }, + { parse_arg_str}, + { parse_arg_bool }, };uint32_t index =arg_attr_val_type (arg);int ret = -EINVAL ;
lib/argparse/rte_argparse.h +5 -1
@@ -60,8 +60,12 @@ extern "C" {#define RTE_ARGPARSE_ARG_VALUE_U32 RTE_SHIFT_VAL64(4, 2)/** The argument's value is uint64 type. */ #define RTE_ARGPARSE_ARG_VALUE_U64 RTE_SHIFT_VAL64(5, 2) +/** The argument's value is string type. */ +#define RTE_ARGPARSE_ARG_VALUE_STR RTE_SHIFT_VAL64(6, 2) +/** The argument's value is boolean flag type. */ +#define RTE_ARGPARSE_ARG_VALUE_BOOL RTE_SHIFT_VAL64(7, 2)/** Max value type. */ -#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(6, 2) +#define RTE_ARGPARSE_ARG_VALUE_MAX RTE_SHIFT_VAL64(8, 2)/** * Flag for that argument support occur multiple times. * This flag can be set only when the argument is optional.
Signature · 1 line
2.48.1
PATCH v4 2/3 argparse: make argparse EAL-args compatible
In reply to Bruce RichardsonThe 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.
--- 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(-)
app/test/test_argparse.c +18 -18
@@ -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!" );
doc/guides/rel_notes/release_25_07.rst +9 -0
@@ -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 ------------
lib/argparse/rte_argparse.c +9 -3
@@ -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)
lib/argparse/rte_argparse.h +4 -2
@@ -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);
Signature · 1 line
2.48.1
PATCH v4 3/3 argparse: use enums to remove max-value defines in lists
In reply to Bruce RichardsonThe use of lists of #defines with _MAX entries at the end causes issues for ABI compatibility as those MAX values often leak through to applications and can cause issues when changed.
We can rework the code to increase type safety by splitting the flags field and using enums for each set of values explicitly:
* One enum for whether an argument takes a parameter or not (or optionally takes one)
* One enum for the type of the argument.
* A separate flags field for any additional info - right now this is only to indicate an argument can appear more than once.
The use of the MAX field is no longer necessary using the enums as we can use an inline function with a switch statement to check for valid values. Compilers like GCC will warn when an enum value is missing from the switch statement, easing future maintenance if enum values are added.
--- app/test/test_argparse.c | 182 ++++++++++++------------- doc/guides/prog_guide/argparse_lib.rst | 36 +++-- doc/guides/rel_notes/release_25_07.rst | 35 +++++ examples/dma/dmafwd.c | 20 +-- examples/flow_filtering/main.c | 4 +- lib/argparse/rte_argparse.c | 143 ++++++++++--------- lib/argparse/rte_argparse.h | 95 +++++++------ 7 files changed, 283 insertions(+), 232 deletions(-)
app/test/test_argparse.c +91 -91
@@ -79,8 +79,10 @@ test_argparse_callback(uint32_t index, const char *value, void *opaque) .exit_on_error = false, \ .callback = test_argparse_callback, \ .args = { \ - { "--abc", "-a", "abc argument", (void *)1, (void *)1, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ - { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, \ + { "--abc", "-a", "abc argument", (void *)1, (void *)1, \ + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ + { "--xyz", "-x", "xyz argument", (void *)1, (void *)2, \ + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_NONE }, \ ARGPARSE_ARG_END(), \ }, \ }
@@ -188,27 +190,20 @@ test_argparse_invalid_arg_help(void)static int test_argparse_invalid_has_val (void ) { -uint64_t set_mask[] = {0 , -RTE_ARGPARSE_ARG_NO_VALUE , -RTE_ARGPARSE_ARG_OPTIONAL_VALUE - }; +uint64_t invalid_values[] = { +RTE_ARGPARSE_VALUE_NONE , +RTE_ARGPARSE_VALUE_OPTIONAL , + };struct rte_argparse *obj;uint32_t index;int ret; -/* test optional arg don't config has-value. */ - obj =test_argparse_init_obj (); - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); -/* test positional arg don't config required-value. */ -for (index =0 ; index <RTE_DIM (set_mask); index++) { +for (index =0 ; index <RTE_DIM (invalid_values); index++) { obj =test_argparse_init_obj (); obj->args[0 ].name_long ="abc" ; obj->args[0 ].name_short =NULL ; - obj->args[0 ].flags &= ~RTE_ARGPARSE_HAS_VAL_BITMASK ; - obj->args[0 ].flags |= set_mask[index]; + obj->args[0 ].value_required = invalid_values[index]; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); }
@@ -225,14 +220,15 @@ test_argparse_invalid_arg_saver(void)/* test saver == NULL with val-type != 0. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test saver == NULL with callback is NULL. */ obj =test_argparse_init_obj (); obj->args[0 ].val_saver =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->callback =NULL ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -241,15 +237,7 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; - ret =rte_argparse_parse (obj, default_argc, default_argv); -TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - -/* test saver != NULL with val-type is max. */ - obj =test_argparse_init_obj (); - obj->args[0 ].val_saver = (void *)1 ; - obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_MAX ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -257,7 +245,8 @@ test_argparse_invalid_arg_saver(void) obj =test_argparse_init_obj (); obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -272,9 +261,7 @@ test_argparse_invalid_arg_flags(void)/* test set unused bits. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |= ~(RTE_ARGPARSE_HAS_VAL_BITMASK | -RTE_ARGPARSE_VAL_TYPE_BITMASK | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ); + obj->args[0 ].flags |= ~(RTE_ARGPARSE_FLAG_SUPPORT_MULTI ); ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -284,14 +271,15 @@ test_argparse_invalid_arg_flags(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)1 ; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT | -RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test optional arg enabled multiple but prased by autosave. */ obj =test_argparse_init_obj (); - obj->args[0 ].flags |=RTE_ARGPARSE_ARG_SUPPORT_MULTI ; + obj->args[0 ].flags |=RTE_ARGPARSE_FLAG_SUPPORT_MULTI ; ret =rte_argparse_parse (obj, default_argc, default_argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -344,7 +332,6 @@ test_argparse_invalid_option(void)static int test_argparse_opt_autosave_parse_int_of_no_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_NO_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -355,7 +342,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -363,7 +351,8 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -376,7 +365,6 @@ test_argparse_opt_autosave_parse_int_of_no_val(void)static int test_argparse_opt_autosave_parse_int_of_required_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -387,7 +375,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -396,7 +385,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (ret ==3 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -404,7 +394,8 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test invalid value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); argv[2 ] =test_strdup ("100a" );
@@ -417,7 +408,6 @@ test_argparse_opt_autosave_parse_int_of_required_val(void)static int test_argparse_opt_autosave_parse_int_of_optional_val (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[2 ];
@@ -429,14 +419,16 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set = (void *)100 ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -444,13 +436,15 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=200" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret ==2 ,"Argparse parse expect success!" );TEST_ASSERT (val_saver ==200 ,"Argparse parse expect success!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -458,12 +452,14 @@ test_argparse_opt_autosave_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==200 ,"Argparse parse expect success!" );/* test with option value, but with wrong value. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=200a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" ); - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("-t=200a" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -498,7 +494,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_NO_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -506,7 +502,7 @@ test_argparse_opt_callback_parse_int_of_no_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_NONE ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -549,7 +545,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -558,7 +554,7 @@ test_argparse_opt_callback_parse_int_of_required_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -566,12 +562,12 @@ test_argparse_opt_callback_parse_int_of_required_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test no more parameters. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -613,7 +609,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void) obj->args[0 ].name_short ="-t" ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("--test-long" );
@@ -621,7 +617,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -629,13 +625,13 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==10 ,"Argparse parse expect success!" );/* test with value. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("--test-long=100" ); ret =rte_argparse_parse (obj,2 , argv);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 ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; val_saver =0 ; argv[1 ] =test_strdup ("-t=100" ); ret =rte_argparse_parse (obj,2 , argv);
@@ -643,7 +639,7 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test callback return failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_OPTIONAL_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_OPTIONAL ; argv[1 ] =test_strdup ("-t=100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -654,7 +650,6 @@ test_argparse_opt_callback_parse_int_of_optional_val(void)static int test_argparse_pos_autosave_parse_int (void ) { -uint64_t flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE |RTE_ARGPARSE_ARG_VALUE_INT ;struct rte_argparse *obj;int val_saver =0 ;char *argv[3 ];
@@ -666,7 +661,8 @@ test_argparse_pos_autosave_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver = (void *)&val_saver; obj->args[0 ].val_set =NULL ; - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; obj->args[1 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -675,14 +671,16 @@ test_argparse_pos_autosave_parse_int(void)TEST_ASSERT (val_saver ==100 ,"Argparse parse expect success!" );/* test positional autosave parse failed. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; val_saver =0 ; argv[1 ] =test_strdup ("100a" ); ret =rte_argparse_parse (obj,2 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );/* test too much position parameters. */ - obj->args[0 ].flags = flags; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[0 ].value_type =RTE_ARGPARSE_VALUE_TYPE_INT ; argv[1 ] =test_strdup ("100" ); argv[2 ] =test_strdup ("200" ); ret =rte_argparse_parse (obj,3 , argv);
@@ -727,12 +725,12 @@ test_argparse_pos_callback_parse_int(void) obj->args[0 ].name_short =NULL ; obj->args[0 ].val_saver =NULL ; obj->args[0 ].val_set = (void *)1 ; - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[1 ].name_long ="test-long2" ; obj->args[1 ].name_short =NULL ; obj->args[1 ].val_saver =NULL ; obj->args[1 ].val_set = (void *)2 ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; obj->args[2 ].name_long =NULL ; argv[0 ] =test_strdup (obj->prog_name); argv[1 ] =test_strdup ("100" );
@@ -743,8 +741,8 @@ test_argparse_pos_callback_parse_int(void)TEST_ASSERT (val_saver[2 ] ==200 ,"Argparse parse expect success!" );/* test positional callback parse failed. */ - obj->args[0 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; - obj->args[1 ].flags =RTE_ARGPARSE_ARG_REQUIRED_VALUE ; + obj->args[0 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; + obj->args[1 ].value_required =RTE_ARGPARSE_VALUE_REQUIRED ; argv[2 ] =test_strdup ("200a" ); ret =rte_argparse_parse (obj,3 , argv);TEST_ASSERT (ret == -EINVAL ,"Argparse parse expect failed!" );
@@ -775,78 +773,80 @@ test_argparse_parse_type(void)int ret;/* test for int parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_INT , &val_int); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_INT , &val_int);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_int ==123 ,"Argparse parse type expect failed!" );/* test for u8 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_erange_u8,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u8 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U8 , &val_u8); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U8 , &val_u8);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u8 ==123 ,"Argparse parse type expect failed!" );/* test for u16 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_erange_u16,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u16 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U16 , &val_u16); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U16 , &val_u16);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u16 ==123 ,"Argparse parse type expect failed!" );/* test for u32 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_erange_u32,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u32 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U32 , &val_u32); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U32 , &val_u32);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u32 ==123 ,"Argparse parse type expect failed!" );/* test for u64 parsing */ - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); - ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_invalid,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret !=0 ,"Argparse parse type expect failed!" ); val_u64 =0 ; - ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_ARG_VALUE_U64 , &val_u64); + ret =rte_argparse_parse_type (str_ok,RTE_ARGPARSE_VALUE_TYPE_U64 , &val_u64);TEST_ASSERT (ret ==0 ,"Argparse parse type expect failed!" );TEST_ASSERT (val_u64 ==123 ,"Argparse parse type expect failed!" );/* test for string parsing - all it does is save string, so all are valid */ const char *val_str; - ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_ARG_VALUE_STR , &val_str); + ret =rte_argparse_parse_type (str_erange,RTE_ARGPARSE_VALUE_TYPE_STR , &val_str);TEST_ASSERT (ret ==0 ,"Argparse parse a string failed unexpectedly!" );/* test for boolean parsing */ bool val_bool = false; - ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (true) failed!" ); - ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (false) failed!" ); - ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (invalid) passed unexpectedly!" ); - ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_true,RTE_ARGPARSE_VALUE_TYPE_BOOL , &val_bool);TEST_ASSERT (ret ==0 && val_bool == true,"Argparse parse type for bool (numeric true) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_false,RTE_ARGPARSE_VALUE_TYPE_BOOL , + &val_bool);TEST_ASSERT (ret ==0 && val_bool == false,"Argparse parse type for bool (numeric false) failed!" ); - ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_ARG_VALUE_BOOL , &val_bool); + ret =rte_argparse_parse_type (bool_numeric_invalid,RTE_ARGPARSE_VALUE_TYPE_BOOL , + &val_bool);TEST_ASSERT (ret !=0 ,"Argparse parse type for bool (numeric invalid) passed unexpectedly!" );return 0 ; }
doc/guides/prog_guide/argparse_lib.rst +22 -14
@@ -70,14 +70,14 @@ The following code demonstrates how to use: .exit_on_error = true, .callback = argparse_user_callback, .args = { - { "--aaa", "-a", "aaa argument", &aaa_val, (void *)100, RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "--bbb", "-b", "bbb argument", &bbb_val, NULL, RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "--ccc", "-c", "ccc argument", &ccc_val, (void *)200, RTE_ARGPARSE_ARG_OPTIONAL_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "--ddd", "-d", "ddd argument", NULL, (void *)1, RTE_ARGPARSE_ARG_NO_VALUE }, - { "--eee", "-e", "eee argument", NULL, (void *)2, RTE_ARGPARSE_ARG_REQUIRED_VALUE }, - { "--fff", "-f", "fff argument", NULL, (void *)3, RTE_ARGPARSE_ARG_OPTIONAL_VALUE }, - { "ooo", NULL, "ooo argument", &ooo_val, NULL, RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_INT }, - { "ppp", NULL, "ppp argument", NULL, (void *)300, RTE_ARGPARSE_ARG_REQUIRED_VALUE }, + { "--aaa", "-a", "aaa argument", &aaa_val, (void *)100, RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "--bbb", "-b", "bbb argument", &bbb_val, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "--ccc", "-c", "ccc argument", &ccc_val, (void *)200, RTE_ARGPARSE_VALUE_OPTIONAL, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "--ddd", "-d", "ddd argument", NULL, (void *)1, RTE_ARGPARSE_VALUE_NONE }, + { "--eee", "-e", "eee argument", NULL, (void *)2, RTE_ARGPARSE_VALUE_REQUIRED }, + { "--fff", "-f", "fff argument", NULL, (void *)3, RTE_ARGPARSE_VALUE_OPTIONAL }, + { "ooo", NULL, "ooo argument", &ooo_val, NULL, RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_INT }, + { "ppp", NULL, "ppp argument", NULL, (void *)300, RTE_ARGPARSE_VALUE_REQUIRED }, }, };
@@ -95,12 +95,12 @@ and the arguments which don't start with a hyphen (-) are positional arguments (they're ``ooo``/``ppp``). Every argument must be set whether to carry a value (one of -``RTE_ARGPARSE_ARG_NO_VALUE``, ``RTE_ARGPARSE_ARG_REQUIRED_VALUE`` and -``RTE_ARGPARSE_ARG_OPTIONAL_VALUE``). +``RTE_ARGPARSE_VALUE_NONE``, ``RTE_ARGPARSE_VALUE_REQUIRED`` and +``RTE_ARGPARSE_VALUE_OPTIONAL``). .. note:: - Positional argument must set ``RTE_ARGPARSE_ARG_REQUIRED_VALUE``. + Positional argument must set ``RTE_ARGPARSE_VALUE_REQUIRED``. User Input Requirements ~~~~~~~~~~~~~~~~~~~~~~~
@@ -135,7 +135,7 @@ their values are parsing in the order defined. Parsing by autosave way ~~~~~~~~~~~~~~~~~~~~~~~ -Argument of known value type (e.g. ``RTE_ARGPARSE_ARG_VALUE_INT``) +Argument of known value type (e.g. ``RTE_ARGPARSE_VALUE_TYPE_INT``) could be parsed using this autosave way, and its result will save in the ``val_saver`` field.
@@ -172,12 +172,20 @@ Multiple times argument ~~~~~~~~~~~~~~~~~~~~~~~ If want to support the ability to enter the same argument multiple times, -then should mark ``RTE_ARGPARSE_ARG_SUPPORT_MULTI`` in the ``flags`` field. +then should mark ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI`` in the ``flags`` field. For example: .. code-block:: C - { "--xyz", "-x", "xyz argument", NULL, (void *)10, RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_SUPPORT_MULTI }, + { + .long_name = "--xyz", + .short_name = "-x", + .desc = "xyz argument", + .val_set = (void *)10, + .val_mode = RTE_ARGPARSE_VALUE_REQUIRED, + // val_type is implicitly RTE_ARGPARSE_VALUE_TYPE_NONE, + .flags = RTE_ARGPARSE_FLAG_SUPPORT_MULTI, + }, Then the user input could contain multiple ``--xyz`` arguments.
doc/guides/rel_notes/release_25_07.rst +35 -0
@@ -162,6 +162,10 @@ API Changes * graph: Added ``graph`` field to the ``rte_node.dispatch`` structure. +* argparse: The ``rte_argparse_arg`` structure used for defining arguments has been updated. + See next section, :ref:`ABI-Changes` for details. + +.. _ABI-Changes: ABI Changes -----------
@@ -188,6 +192,37 @@ ABI Changes ``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. + * The ``rte_argparse_arg`` structure used for defining arguments has been updated + to separate out into separate fields the options for: + + #. Whether the argument is required or optional. + #. What the type of the argument is (in case of saving the parameters automatically). + #. Any other flags - of which there is only one, ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI``, at this time. + + * With the splitting of the flags into separate enums for categories, + the names of the flags have been changed to better reflect their purpose. + The flags/enum values are: + + * For the ``value_required`` field: + + * ``RTE_ARGPARSE_VALUE_NONE`` + * ``RTE_ARGPARSE_VALUE_REQUIRED`` + * ``RTE_ARGPARSE_VALUE_OPTIONAL`` + + * For the ``value_type`` field: + + * ``RTE_ARGPARSE_VALUE_TYPE_NONE`` (No argument value type is specified, callback is to be used for processing.) + * ``RTE_ARGPARSE_VALUE_TYPE_INT`` + * ``RTE_ARGPARSE_VALUE_TYPE_U8`` + * ``RTE_ARGPARSE_VALUE_TYPE_U16`` + * ``RTE_ARGPARSE_VALUE_TYPE_U32`` + * ``RTE_ARGPARSE_VALUE_TYPE_U64`` + * ``RTE_ARGPARSE_VALUE_TYPE_STR`` + * ``RTE_ARGPARSE_VALUE_TYPE_BOOL`` + + * Other flags: + + * ``RTE_ARGPARSE_FLAG_SUPPORT_MULTI`` (Allows the argument to be specified multiple times.) Known Issues
examples/dma/dmafwd.c +10 -10
@@ -644,43 +644,43 @@ dma_parse_args(int argc, char **argv, unsigned int nb_ports) .args = { { "--mac-updating", NULL, "Enable MAC addresses updating", &mac_updating, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--no-mac-updating", NULL, "Disable MAC addresses updating", &mac_updating, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--portmask", "-p", "hexadecimal bitmask of ports to configure", NULL, (void *)CMD_LINE_OPT_PORTMASK_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--nb-queue", "-q", "number of RX queues per port (default is 1)", &nb_queues, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--copy-type", "-c", "type of copy: sw|hw", NULL, (void *)CMD_LINE_OPT_COPY_TYPE_INDEX, - RTE_ARGPARSE_ARG_REQUIRED_VALUE, + RTE_ARGPARSE_VALUE_REQUIRED, }, { "--ring-size", "-s", "size of dmadev descriptor ring for hardware copy mode or rte_ring for software copy mode", &ring_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, { "--dma-batch-size", "-b", "number of requests per DMA batch", &dma_batch_sz, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--max-frame-size", "-f", "max frame size", &max_frame_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--force-min-copy-size", "-m", "force a minimum copy length, even for smaller packets", &force_min_copy_size, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U32, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U32, }, { "--stats-interval", "-i", "interval, in seconds, between stats prints (default is 1)", &stats_interval, NULL, - RTE_ARGPARSE_ARG_REQUIRED_VALUE | RTE_ARGPARSE_ARG_VALUE_U16, + RTE_ARGPARSE_VALUE_REQUIRED, RTE_ARGPARSE_VALUE_TYPE_U16, }, ARGPARSE_ARG_END(), },
examples/flow_filtering/main.c +2 -2
@@ -274,11 +274,11 @@ flow_filtering_parse_args(int argc, char **argv) .args = { { "--template", NULL, "Enable template API flow", &use_template_api, (void *)1, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, { "--non-template", NULL, "Enable non template API flow", &use_template_api, (void *)0, - RTE_ARGPARSE_ARG_NO_VALUE | RTE_ARGPARSE_ARG_VALUE_INT, + RTE_ARGPARSE_VALUE_NONE, RTE_ARGPARSE_VALUE_TYPE_INT, }, ARGPARSE_ARG_END(), },
lib/argparse/rte_argparse.c +76 -67
246 lines not on this page · raw message
lib/argparse/rte_argparse.h +47 -48
128 lines not on this page · raw message
Signature · 1 line
2.48.1
Thomas Monjalon
AppliedQuoted 4 lines
Bruce Richardson (3):
argparse: add support for string and boolean args
argparse: make argparse EAL-args compatible
argparse: use enums to remove max-value defines in lists
Applied, thanks.