1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979
|
/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2024 HiSilicon Limited
*/
#include <errno.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <eal_export.h>
#include <rte_log.h>
#include <rte_os.h>
#include "rte_argparse.h"
RTE_LOG_REGISTER_DEFAULT(rte_argparse_logtype, INFO);
#define RTE_LOGTYPE_ARGPARSE rte_argparse_logtype
#define ARGPARSE_LOG(level, ...) \
RTE_LOG_LINE(level, ARGPARSE, "" __VA_ARGS__)
static inline bool
is_arg_optional(const struct rte_argparse_arg *arg)
{
return arg->name_long[0] == '-';
}
static inline bool
is_arg_positional(const struct rte_argparse_arg *arg)
{
return arg->name_long[0] != '-';
}
static inline bool
is_valid_has_value_field(const struct rte_argparse_arg *arg)
{
switch (arg->value_required) {
case RTE_ARGPARSE_VALUE_NONE:
case RTE_ARGPARSE_VALUE_OPTIONAL:
case RTE_ARGPARSE_VALUE_REQUIRED:
return true;
/* omit default case so compiler warns on any missing enum values */
}
return false;
}
static inline bool
is_valid_value_type_field(const struct rte_argparse_arg *arg)
{
switch (arg->value_type) {
case RTE_ARGPARSE_VALUE_TYPE_NONE:
case RTE_ARGPARSE_VALUE_TYPE_INT:
case RTE_ARGPARSE_VALUE_TYPE_U8:
case RTE_ARGPARSE_VALUE_TYPE_U16:
case RTE_ARGPARSE_VALUE_TYPE_U32:
case RTE_ARGPARSE_VALUE_TYPE_U64:
case RTE_ARGPARSE_VALUE_TYPE_STR:
case RTE_ARGPARSE_VALUE_TYPE_BOOL:
case RTE_ARGPARSE_VALUE_TYPE_CORELIST:
return true;
/* omit default case so compiler warns on any missing enum values */
}
return false;
}
static inline bool
arg_attr_flag_multi(const struct rte_argparse_arg *arg)
{
return (arg->flags & RTE_ARGPARSE_FLAG_SUPPORT_MULTI) != 0;
}
static inline uint64_t
arg_attr_unused_bits(const struct rte_argparse_arg *arg)
{
#define USED_BIT_MASK (RTE_ARGPARSE_FLAG_SUPPORT_MULTI)
return arg->flags & ~USED_BIT_MASK;
}
static int
verify_arg_name(const struct rte_argparse_arg *arg)
{
if (is_arg_optional(arg)) {
if (strlen(arg->name_long) <= 3) {
ARGPARSE_LOG(ERR, "optional long name %s too short!", arg->name_long);
return -EINVAL;
}
if (arg->name_long[1] != '-') {
ARGPARSE_LOG(ERR, "optional long name %s doesn't start with '--'",
arg->name_long);
return -EINVAL;
}
if (arg->name_long[2] == '-') {
ARGPARSE_LOG(ERR, "optional long name %s should not start with '---'",
arg->name_long);
return -EINVAL;
}
}
if (arg->name_short == NULL)
return 0;
if (!is_arg_optional(arg)) {
ARGPARSE_LOG(ERR, "short name %s corresponding long name must be optional!",
arg->name_short);
return -EINVAL;
}
if (strlen(arg->name_short) != 2 || arg->name_short[0] != '-' ||
arg->name_short[1] == '-') {
ARGPARSE_LOG(ERR, "short name %s must start with a hyphen (-) followed by an English letter",
arg->name_short);
return -EINVAL;
}
return 0;
}
static int
verify_arg_help(const struct rte_argparse_arg *arg)
{
if (arg->help == NULL) {
ARGPARSE_LOG(ERR, "argument %s doesn't have help info!", arg->name_long);
return -EINVAL;
}
return 0;
}
static int
verify_arg_has_val(const struct rte_argparse_arg *arg)
{
if (!is_valid_has_value_field(arg)) {
ARGPARSE_LOG(ERR, "argument %s has invalid value field!", arg->name_long);
return -EINVAL;
}
if (is_arg_positional(arg)) {
if (arg->value_required == RTE_ARGPARSE_VALUE_REQUIRED)
return 0;
ARGPARSE_LOG(ERR, "argument %s is positional, must config required-val!",
arg->name_long);
return -EINVAL;
}
return 0;
}
static int
verify_arg_saver(const struct rte_argparse *obj, uint32_t index)
{
const struct rte_argparse_arg *arg = &obj->args[index];
if (arg->val_saver == NULL) {
if (arg->value_type != RTE_ARGPARSE_VALUE_TYPE_NONE) {
ARGPARSE_LOG(ERR, "argument %s parsed by callback, value-type should not be set!",
arg->name_long);
return -EINVAL;
}
if (obj->callback == NULL) {
ARGPARSE_LOG(ERR, "argument %s parsed by callback, but callback is NULL!",
arg->name_long);
return -EINVAL;
}
return 0;
}
/* check value_type field */
if (!is_valid_value_type_field(arg)) {
ARGPARSE_LOG(ERR, "argument %s has invalid value-type field!", arg->name_long);
return -EINVAL;
}
if (arg->value_type == RTE_ARGPARSE_VALUE_TYPE_NONE) {
ARGPARSE_LOG(ERR, "missing value-type for argument %s!", arg->name_long);
return -EINVAL;
}
if (arg->value_required == RTE_ARGPARSE_VALUE_REQUIRED && arg->val_set != NULL) {
ARGPARSE_LOG(ERR, "argument %s has required value, value-set should be NULL!",
arg->name_long);
return -EINVAL;
}
return 0;
}
static int
verify_arg_flags(const struct rte_argparse *obj, uint32_t index)
{
const struct rte_argparse_arg *arg = &obj->args[index];
uint64_t unused_bits = arg_attr_unused_bits(arg);
if (unused_bits != 0) {
ARGPARSE_LOG(ERR, "argument %s flags unused bits should not be set!",
arg->name_long);
return -EINVAL;
}
if (!(arg->flags & RTE_ARGPARSE_FLAG_SUPPORT_MULTI))
return 0;
if (is_arg_positional(arg)) {
ARGPARSE_LOG(ERR, "argument %s is positional, don't support multiple times!",
arg->name_long);
return -EINVAL;
}
if (arg->val_saver != NULL) {
ARGPARSE_LOG(ERR, "argument %s supports multiple times, should use callback to parse!",
arg->name_long);
return -EINVAL;
}
return 0;
}
static int
verify_arg_repeat(const struct rte_argparse *self, uint32_t index)
{
const struct rte_argparse_arg *arg = &self->args[index];
uint32_t i;
for (i = 0; i < index; i++) {
if (!strcmp(arg->name_long, self->args[i].name_long)) {
ARGPARSE_LOG(ERR, "argument %s repeat!", arg->name_long);
return -EINVAL;
}
}
if (arg->name_short == NULL)
return 0;
for (i = 0; i < index; i++) {
if (self->args[i].name_short == NULL)
continue;
if (!strcmp(arg->name_short, self->args[i].name_short)) {
ARGPARSE_LOG(ERR, "argument %s repeat!", arg->name_short);
return -EINVAL;
}
}
return 0;
}
static int
verify_argparse_arg(const struct rte_argparse *obj, uint32_t index)
{
const struct rte_argparse_arg *arg = &obj->args[index];
int ret;
ret = verify_arg_name(arg);
if (ret != 0)
return ret;
ret = verify_arg_help(arg);
if (ret != 0)
return ret;
ret = verify_arg_has_val(arg);
if (ret != 0)
return ret;
ret = verify_arg_saver(obj, index);
if (ret != 0)
return ret;
ret = verify_arg_flags(obj, index);
if (ret != 0)
return ret;
ret = verify_arg_repeat(obj, index);
if (ret != 0)
return ret;
return 0;
}
static int
verify_argparse(const struct rte_argparse *obj, size_t *nb_args)
{
size_t idx;
int ret;
if (obj->prog_name == NULL) {
ARGPARSE_LOG(ERR, "program name is NULL!");
return -EINVAL;
}
if (obj->usage == NULL) {
ARGPARSE_LOG(ERR, "usage is NULL!");
return -EINVAL;
}
for (idx = 0; idx < RTE_DIM(obj->reserved_flags); idx++) {
if (obj->reserved_flags[idx]) {
ARGPARSE_LOG(ERR, "reserved flags cannot be set!");
return -EINVAL;
}
}
for (idx = 0; idx < RTE_DIM(obj->reserved); idx++) {
if (obj->reserved[idx] != 0) {
ARGPARSE_LOG(ERR, "reserved field must be zero!");
return -EINVAL;
}
}
idx = 0;
while (obj->args[idx].name_long != NULL) {
if (is_arg_positional(&obj->args[idx]) && obj->ignore_non_flag_args) {
ARGPARSE_LOG(ERR, "Error validating argparse object: positional args are not allowed when ignore_non_flag_args is set!");
return -EINVAL;
}
ret = verify_argparse_arg(obj, idx);
if (ret != 0)
return ret;
idx++;
}
*nb_args = idx;
return 0;
}
static uint32_t
calc_position_count(const struct rte_argparse *obj)
{
const struct rte_argparse_arg *arg;
uint32_t count = 0;
uint32_t i;
for (i = 0; /* NULL */; i++) {
arg = &obj->args[i];
if (obj->args[i].name_long == NULL)
break;
if (is_arg_positional(arg))
count++;
}
return count;
}
static const struct rte_argparse_arg *
find_position_arg(const struct rte_argparse *obj, uint32_t index)
{
const struct rte_argparse_arg *arg;
uint32_t count = 0;
uint32_t i;
for (i = 0; /* NULL */; i++) {
arg = &obj->args[i];
if (arg->name_long == NULL)
break;
if (!is_arg_positional(arg))
continue;
count++;
if (count == index)
return arg;
}
return NULL;
}
static bool
is_arg_match(const struct rte_argparse_arg *arg, const char *curr_argv, uint32_t len)
{
if (strlen(arg->name_long) == len && strncmp(arg->name_long, curr_argv, len) == 0)
return true;
if (arg->name_short == NULL)
return false;
if (strlen(arg->name_short) == len && strncmp(arg->name_short, curr_argv, len) == 0)
return true;
return false;
}
static const struct rte_argparse_arg *
find_option_arg(const struct rte_argparse *obj, uint32_t *idx,
const char *curr_argv, const char *has_equal, const char **arg_name)
{
uint32_t len = strlen(curr_argv) - (has_equal != NULL ? strlen(has_equal) : 0);
const struct rte_argparse_arg *arg;
uint32_t i;
bool match;
for (i = 0; /* nothing */; i++) {
arg = &obj->args[i];
if (arg->name_long == NULL)
break;
match = is_arg_match(arg, curr_argv, len);
if (match) {
/* Obtains the exact matching name (long or short). */
*arg_name = len > 2 ? arg->name_long : arg->name_short;
*idx = i;
return arg;
}
}
return NULL;
}
static int
parse_arg_int(const struct rte_argparse_arg *arg, const char *value)
{
char *s = NULL;
if (value == NULL) {
*(int *)arg->val_saver = (int)(intptr_t)arg->val_set;
return 0;
}
errno = 0;
*(int *)arg->val_saver = strtol(value, &s, 0);
if (errno == ERANGE) {
ARGPARSE_LOG(ERR, "argument %s numerical out of range!", arg->name_long);
return -EINVAL;
}
if (s[0] != '\0') {
ARGPARSE_LOG(ERR, "argument %s expect an integer value!", arg->name_long);
return -EINVAL;
}
return 0;
}
static int
parse_arg_u8(const struct rte_argparse_arg *arg, const char *value)
{
unsigned long val;
char *s = NULL;
if (value == NULL) {
*(uint8_t *)arg->val_saver = (uint8_t)(intptr_t)arg->val_set;
return 0;
}
errno = 0;
val = strtoul(value, &s, 0);
if (errno == ERANGE || val > UINT8_MAX) {
ARGPARSE_LOG(ERR, "argument %s numerical out of range!", arg->name_long);
return -EINVAL;
}
if (s[0] != '\0') {
ARGPARSE_LOG(ERR, "argument %s expect an uint8 value!", arg->name_long);
return -EINVAL;
}
*(uint8_t *)arg->val_saver = val;
return 0;
}
static int
parse_arg_u16(const struct rte_argparse_arg *arg, const char *value)
{
unsigned long val;
char *s = NULL;
if (value == NULL) {
*(uint16_t *)arg->val_saver = (uint16_t)(intptr_t)arg->val_set;
return 0;
}
errno = 0;
val = strtoul(value, &s, 0);
if (errno == ERANGE || val > UINT16_MAX) {
ARGPARSE_LOG(ERR, "argument %s numerical out of range!", arg->name_long);
return -EINVAL;
}
if (s[0] != '\0') {
ARGPARSE_LOG(ERR, "argument %s expect an uint16 value!", arg->name_long);
return -EINVAL;
}
*(uint16_t *)arg->val_saver = val;
return 0;
}
static int
parse_arg_u32(const struct rte_argparse_arg *arg, const char *value)
{
unsigned long val;
char *s = NULL;
if (value == NULL) {
*(uint32_t *)arg->val_saver = (uint32_t)(intptr_t)arg->val_set;
return 0;
}
errno = 0;
val = strtoul(value, &s, 0);
if (errno == ERANGE || val > UINT32_MAX) {
ARGPARSE_LOG(ERR, "argument %s numerical out of range!", arg->name_long);
return -EINVAL;
}
if (s[0] != '\0') {
ARGPARSE_LOG(ERR, "argument %s expect an uint32 value!", arg->name_long);
return -EINVAL;
}
*(uint32_t *)arg->val_saver = val;
return 0;
}
static int
parse_arg_u64(const struct rte_argparse_arg *arg, const char *value)
{
unsigned long val;
char *s = NULL;
if (value == NULL) {
*(uint64_t *)arg->val_saver = (uint64_t)(intptr_t)arg->val_set;
return 0;
}
errno = 0;
val = strtoull(value, &s, 0);
if (errno == ERANGE) {
ARGPARSE_LOG(ERR, "argument %s numerical out of range!", arg->name_long);
return -EINVAL;
}
if (s[0] != '\0') {
ARGPARSE_LOG(ERR, "argument %s expect an uint64 value!", arg->name_long);
return -EINVAL;
}
*(uint64_t *)arg->val_saver = val;
return 0;
}
static int
parse_arg_str(const 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(const 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_corelist(const struct rte_argparse_arg *arg, const char *value)
{
rte_cpuset_t *cpuset = arg->val_saver;
const char *last = value;
int min = -1;
if (value == NULL) {
*cpuset = *(rte_cpuset_t *)arg->val_set;
return 0;
}
CPU_ZERO(cpuset);
while (*last != '\0') {
char *end;
int64_t idx;
int32_t max;
while (isblank(*value))
value++;
if (!isdigit(*value)) {
ARGPARSE_LOG(ERR, "argument %s has an unexpected non digit character!",
arg->name_long);
return -EINVAL;
}
errno = 0;
idx = strtol(value, &end, 10);
last = end;
if (errno || idx > UINT16_MAX) {
ARGPARSE_LOG(ERR, "argument %s contains a numerical value out of range!",
arg->name_long);
return -EINVAL;
}
if (*end == '-') {
if (min != -1) { /* can't have '-' within a range */
ARGPARSE_LOG(ERR, "argument %s has an unexpected - character!",
arg->name_long);
return -EINVAL;
}
min = idx; /* start of range, move to next loop stage */
} else if (*end == ',' || *end == '\0') {
/* single value followed by comma or end (min is set only by '-') */
if (min == -1) {
min = max = idx;
} else if (min > idx) {
/* we have range from high to low */
max = min;
min = idx;
} else {
/* range from low to high */
max = idx;
}
for (; min <= max; min++)
CPU_SET(min, cpuset);
min = -1; /* no longer in a range */
} else {
/* end is an unexpected character, return error */
ARGPARSE_LOG(ERR, "argument %s has an unexpected character!",
arg->name_long);
return -EINVAL;
}
value = last + 1;
}
return 0;
}
static int
parse_arg_autosave(const struct rte_argparse_arg *arg, const char *value)
{
switch (arg->value_type) {
case RTE_ARGPARSE_VALUE_TYPE_NONE:
ARGPARSE_LOG(ERR, "argument %s doesn't specify a value-type!", arg->name_long);
return -EINVAL;
case RTE_ARGPARSE_VALUE_TYPE_INT:
return parse_arg_int(arg, value);
case RTE_ARGPARSE_VALUE_TYPE_U8:
return parse_arg_u8(arg, value);
case RTE_ARGPARSE_VALUE_TYPE_U16:
return parse_arg_u16(arg, value);
case RTE_ARGPARSE_VALUE_TYPE_U32:
return parse_arg_u32(arg, value);
case RTE_ARGPARSE_VALUE_TYPE_U64:
return parse_arg_u64(arg, value);
case RTE_ARGPARSE_VALUE_TYPE_STR:
return parse_arg_str(arg, value);
case RTE_ARGPARSE_VALUE_TYPE_BOOL:
return parse_arg_bool(arg, value);
case RTE_ARGPARSE_VALUE_TYPE_CORELIST:
return parse_arg_corelist(arg, value);
/* omit default case so compiler warns on missing enum values */
}
return -EINVAL;
}
/* arg_parse indicates the name entered by the user, which can be long-name or short-name. */
static int
parse_arg_val(const struct rte_argparse *obj, const char *arg_name,
const struct rte_argparse_arg *arg, char *value)
{
int ret;
if (arg->val_saver == NULL)
ret = obj->callback((uint32_t)(uintptr_t)arg->val_set, value, obj->opaque);
else
ret = parse_arg_autosave(arg, value);
if (ret != 0) {
ARGPARSE_LOG(ERR, "argument %s parse value fail!", arg_name);
return ret;
}
return 0;
}
static bool
is_help(const char *curr_argv)
{
return strcmp(curr_argv, "-h") == 0 || strcmp(curr_argv, "--help") == 0;
}
static int
parse_args(const struct rte_argparse *obj, bool *arg_parsed,
int argc, char **argv, bool *show_help)
{
uint32_t position_count = calc_position_count(obj);
const struct rte_argparse_arg *arg;
uint32_t position_index = 0;
const char *arg_name;
size_t n_args_to_move;
char **args_to_move;
uint32_t arg_idx;
char *curr_argv;
char *value;
int ret;
int i;
n_args_to_move = 0;
args_to_move = calloc(argc, sizeof(args_to_move[0]));
if (args_to_move == NULL) {
ARGPARSE_LOG(ERR, "failed to allocate memory for internal flag processing!");
return -ENOMEM;
}
for (i = 1; i < argc; i++) {
curr_argv = argv[i];
if (strcmp(argv[i], "--") == 0) {
i++;
break;
}
if (curr_argv[0] != '-') {
if (obj->ignore_non_flag_args) {
/* Move non-flag args to args_to_move array. */
args_to_move[n_args_to_move++] = curr_argv;
argv[i] = NULL;
continue;
}
/* process positional parameters. */
position_index++;
if (position_index > position_count) {
ARGPARSE_LOG(ERR, "too many positional arguments %s!", curr_argv);
ret = -EINVAL;
goto err_out;
}
arg = find_position_arg(obj, position_index);
ret = parse_arg_val(obj, arg->name_long, arg, curr_argv);
if (ret != 0)
goto err_out;
continue;
}
/* process optional parameters. */
if (is_help(curr_argv)) {
*show_help = true;
continue;
}
value = strchr(curr_argv, '=');
if (value == NULL && curr_argv[1] != '-' && strlen(curr_argv) > 2)
value = &curr_argv[2];
arg_name = NULL;
arg = find_option_arg(obj, &arg_idx, curr_argv, value, &arg_name);
if (arg == NULL || arg_name == NULL) {
ARGPARSE_LOG(ERR, "unknown argument %s!", curr_argv);
ret = -EINVAL;
goto err_out;
}
if (arg_parsed[arg_idx] && !arg_attr_flag_multi(arg)) {
ARGPARSE_LOG(ERR, "argument %s should not occur multiple times!", arg_name);
ret = -EINVAL;
goto err_out;
}
if (value != NULL && value[0] == '=')
value++; /* skip '=' */
if (arg->value_required == RTE_ARGPARSE_VALUE_NONE) {
if (value != NULL) {
ARGPARSE_LOG(ERR, "argument %s should not take value!", arg_name);
ret = -EINVAL;
goto err_out;
}
} else if (arg->value_required == RTE_ARGPARSE_VALUE_REQUIRED) {
if (value == NULL) {
if (i >= argc - 1) {
ARGPARSE_LOG(ERR, "argument %s doesn't have value!",
arg_name);
ret = -EINVAL;
goto err_out;
}
/* Set value and make i move next. */
value = argv[++i];
}
} else {
/* Do nothing, because it's optional value, only support arg=val or arg. */
}
ret = parse_arg_val(obj, arg_name, arg, value);
if (ret != 0)
goto err_out;
/* This argument parsed success! then mark it parsed. */
arg_parsed[arg_idx] = true;
}
ret = i;
if (n_args_to_move > 0) {
/* Close the gaps in argv array by moving elements down filling in the NULLs. */
int j = 1;
for (i = 1; i < ret; i++) {
if (argv[i] != NULL)
argv[j++] = argv[i];
}
ret = j; /* only return args actually handled */
/* Then put contents of the args_to_move array into the argv in the space left. */
for (i = 0; i < (int)n_args_to_move; i++)
argv[j++] = args_to_move[i];
}
err_out:
free(args_to_move);
return ret;
}
static uint32_t
calc_help_align(const struct rte_argparse *obj)
{
const struct rte_argparse_arg *arg;
uint32_t width = 12; /* Default "-h, --help " len. */
uint32_t len;
uint32_t i;
for (i = 0; /* NULL */; i++) {
arg = &obj->args[i];
if (arg->name_long == NULL)
break;
len = strlen(arg->name_long);
if (is_arg_optional(arg) && arg->name_short != NULL) {
len += strlen(", ");
len += strlen(arg->name_short);
}
width = RTE_MAX(width, 1 + len + 2); /* start with 1 & end with 2 space. */
}
return width;
}
static void
show_oneline_help(FILE *stream, const struct rte_argparse_arg *arg, uint32_t width)
{
uint32_t len = 0;
uint32_t i;
if (arg->name_short != NULL)
len = fprintf(stream, " %s,", arg->name_short);
len += fprintf(stream, " %s", arg->name_long);
for (i = len; i < width; i++)
fprintf(stream, " ");
fprintf(stream, "%s\n", arg->help);
}
static void
show_args_pos_help(FILE *stream, const struct rte_argparse *obj, uint32_t align)
{
uint32_t position_count = calc_position_count(obj);
const struct rte_argparse_arg *arg;
uint32_t i;
if (position_count == 0)
return;
fprintf(stream, "\npositional arguments:\n");
for (i = 0; /* NULL */; i++) {
arg = &obj->args[i];
if (arg->name_long == NULL)
break;
if (!is_arg_positional(arg))
continue;
show_oneline_help(stream, arg, align);
}
}
static void
show_args_opt_help(FILE *stream, const struct rte_argparse *obj, uint32_t align)
{
static const struct rte_argparse_arg help = {
.name_long = "--help",
.name_short = "-h",
.help = "show this help message and exit.",
};
const struct rte_argparse_arg *arg;
uint32_t i;
fprintf(stream, "\noptions:\n");
show_oneline_help(stream, &help, align);
for (i = 0; /* NULL */; i++) {
arg = &obj->args[i];
if (arg->name_long == NULL)
break;
if (!is_arg_optional(arg))
continue;
show_oneline_help(stream, arg, align);
}
}
RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_argparse_print_help, 25.11)
void
rte_argparse_print_help(FILE *stream, const struct rte_argparse *obj)
{
uint32_t align = calc_help_align(obj);
fprintf(stream, "usage: %s %s\n", obj->prog_name, obj->usage);
if (obj->descriptor != NULL)
fprintf(stream, "\ndescriptor: %s\n", obj->descriptor);
show_args_pos_help(stream, obj, align);
show_args_opt_help(stream, obj, align);
if (obj->epilog != NULL)
fprintf(stream, "\n%s\n", obj->epilog);
else
fprintf(stream, "\n");
}
RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_argparse_parse, 24.03)
int
rte_argparse_parse(const struct rte_argparse *obj, int argc, char **argv)
{
bool *arg_parsed = NULL;
bool show_help = false;
size_t nb_args = 0;
int ret;
ret = verify_argparse(obj, &nb_args);
if (ret != 0)
goto error;
/* allocate the flags array to indicate what arguments are parsed or not */
arg_parsed = calloc(nb_args, sizeof(*arg_parsed));
if (arg_parsed == NULL) {
ARGPARSE_LOG(ERR, "failed to allocate memory for argument flags!");
ret = -ENOMEM;
goto error;
}
ret = parse_args(obj, arg_parsed, argc, argv, &show_help);
free(arg_parsed);
if (ret < 0)
goto error;
if (show_help) {
if (obj->print_help != NULL)
obj->print_help(obj);
else
rte_argparse_print_help(stdout, obj);
exit(0);
}
return ret;
error:
if (obj->exit_on_error)
exit(ret);
return ret;
}
RTE_EXPORT_EXPERIMENTAL_SYMBOL(rte_argparse_parse_type, 24.03)
int
rte_argparse_parse_type(const char *str, enum rte_argparse_value_type val_type, void *val)
{
struct rte_argparse_arg arg = {
.name_long = str,
.name_short = NULL,
.val_saver = val,
.val_set = NULL,
.value_type = val_type,
};
if (val_type == RTE_ARGPARSE_VALUE_TYPE_NONE) {
ARGPARSE_LOG(ERR, "argument %s doesn't have value-type!", str);
return -EINVAL;
}
return parse_arg_autosave(&arg, str);
}
|