2 * This file contains the ini and command liner parser main.
18 static struct fio_option *__fio_options;
20 static int vp_cmp(const void *p1, const void *p2)
22 const struct value_pair *vp1 = p1;
23 const struct value_pair *vp2 = p2;
25 return strlen(vp2->ival) - strlen(vp1->ival);
28 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
30 const struct value_pair *vp;
33 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
35 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
36 vp = &o->posval[entries];
37 if (!vp->ival || vp->ival[0] == '\0')
40 memcpy(&vpmap[entries], vp, sizeof(*vp));
43 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
46 static void show_option_range(struct fio_option *o,
47 int (*logger)(const char *format, ...))
49 if (o->type == FIO_OPT_FLOAT_LIST) {
50 if (isnan(o->minfp) && isnan(o->maxfp))
53 logger("%20s: min=%f", "range", o->minfp);
55 logger(", max=%f", o->maxfp);
58 if (!o->minval && !o->maxval)
61 logger("%20s: min=%d", "range", o->minval);
63 logger(", max=%d", o->maxval);
68 static void show_option_values(struct fio_option *o)
72 for (i = 0; i < PARSE_MAX_VP; i++) {
73 const struct value_pair *vp = &o->posval[i];
78 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
80 log_info(" %s", vp->help);
88 static void show_option_help(struct fio_option *o, int is_err)
90 const char *typehelp[] = {
94 "string with possible k/m/g postfix (opt=4k)",
95 "string with time postfix (opt=10s)",
97 "string with dual range (opt=1k-4k,4k-8k)",
98 "integer value (opt=100)",
99 "boolean value (opt=1)",
100 "list of floating point values separated by ':' (opt=5.9:7.8)",
104 int (*logger)(const char *format, ...);
112 logger("%20s: %s\n", "alias", o->alias);
114 logger("%20s: %s\n", "type", typehelp[o->type]);
115 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
117 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
118 show_option_range(o, logger);
119 show_option_values(o);
122 static unsigned long get_mult_time(char c)
139 static unsigned long long __get_mult_bytes(const char *p, void *data,
142 unsigned int kb_base = fio_get_kb_base(data);
143 unsigned long long ret = 1;
144 unsigned int i, pow = 0, mult = kb_base;
152 for (i = 0; i < strlen(c); i++)
153 c[i] = tolower(c[i]);
155 if (!strncmp("pib", c, 3)) {
158 } else if (!strncmp("tib", c, 3)) {
161 } else if (!strncmp("gib", c, 3)) {
164 } else if (!strncmp("mib", c, 3)) {
167 } else if (!strncmp("kib", c, 3)) {
170 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
172 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
174 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
176 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
178 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
180 else if (!strncmp("%", c, 1)) {
187 ret *= (unsigned long long) mult;
193 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
200 return __get_mult_bytes(str, data, percent);
203 * Go forward until we hit a non-digit, or +/- sign
205 while ((p - str) <= len) {
206 if (!isdigit((int) *p) &&
207 (((*p != '+') && (*p != '-')) || digit_seen))
209 digit_seen |= isdigit((int) *p);
213 if (!isalpha((int) *p) && (*p != '%'))
216 return __get_mult_bytes(p, data, percent);
220 * Convert string into a floating number. Return 1 for success and 0 otherwise.
222 static int str_to_float(const char *str, double *val)
224 return (1 == sscanf(str, "%lf", val));
228 * convert string into decimal value, noting any size suffix
230 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
238 if (strstr(str, "0x") || strstr(str, "0X"))
243 *val = strtoll(str, NULL, base);
244 if (*val == LONG_MAX && errno == ERANGE)
248 unsigned long long mult;
251 mult = get_mult_bytes(str, len, data, &perc);
257 *val *= get_mult_time(str[len - 1]);
262 int check_str_bytes(const char *p, long long *val, void *data)
264 return str_to_decimal(p, val, 1, data);
267 static int check_str_time(const char *p, long long *val)
269 return str_to_decimal(p, val, 0, NULL);
272 void strip_blank_front(char **p)
278 while (isspace((int) *s))
284 void strip_blank_end(char *p)
301 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
307 static int check_range_bytes(const char *str, long *val, void *data)
311 if (!str_to_decimal(str, &__val, 1, data)) {
319 static int check_int(const char *p, int *val)
323 if (strstr(p, "0x") || strstr(p, "0X")) {
324 if (sscanf(p, "%x", val) == 1)
327 if (sscanf(p, "%u", val) == 1)
334 static int opt_len(const char *str)
338 postfix = strchr(str, ':');
342 return (int)(postfix - str);
345 #define val_store(ptr, val, off, or, data) \
347 ptr = td_var((data), (off)); \
354 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
355 int first, int more, int curr)
359 long long ull, *ullp;
363 int ret = 0, is_time = 0;
364 const struct value_pair *vp;
365 struct value_pair posval[PARSE_MAX_VP];
366 int i, all_skipped = 1;
368 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
371 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
372 log_err("Option %s requires an argument\n", o->name);
378 case FIO_OPT_STR_MULTI: {
379 fio_opt_str_fn *fn = o->cb;
381 posval_sort(o, posval);
384 for (i = 0; i < PARSE_MAX_VP; i++) {
386 if (!vp->ival || vp->ival[0] == '\0')
389 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
393 *(unsigned int *) o->roff1 |= vp->oval;
395 *(unsigned int *) o->roff1 = vp->oval;
399 val_store(ilp, vp->oval, o->off1, vp->or, data);
405 if (ret && !all_skipped)
406 show_option_values(o);
411 case FIO_OPT_STR_VAL_TIME:
414 case FIO_OPT_STR_VAL: {
415 fio_opt_str_val_fn *fn = o->cb;
418 strncpy(tmp, ptr, sizeof(tmp) - 1);
419 p = strchr(tmp, ',');
424 ret = check_str_time(tmp, &ull);
426 ret = check_str_bytes(tmp, &ull, data);
431 if (o->maxval && ull > o->maxval) {
432 log_err("max value out of range: %llu"
433 " (%u max)\n", ull, o->maxval);
436 if (o->minval && ull < o->minval) {
437 log_err("min value out of range: %llu"
438 " (%u min)\n", ull, o->minval);
443 ret = fn(data, &ull);
445 if (o->type == FIO_OPT_INT) {
448 *(unsigned int *) o->roff1 = ull;
450 val_store(ilp, ull, o->off1, 0, data);
454 *(unsigned int *) o->roff2 = ull;
456 val_store(ilp, ull, o->off2, 0, data);
460 *(unsigned int *) o->roff3 = ull;
462 val_store(ilp, ull, o->off3, 0, data);
467 *(unsigned int *) o->roff2 = ull;
469 val_store(ilp, ull, o->off2, 0, data);
473 *(unsigned int *) o->roff3 = ull;
475 val_store(ilp, ull, o->off3, 0, data);
481 *(unsigned long long *) o->roff1 = ull;
483 val_store(ullp, ull, o->off1, 0, data);
487 *(unsigned long long *) o->roff2 = ull;
489 val_store(ullp, ull, o->off2, 0, data);
495 case FIO_OPT_FLOAT_LIST: {
499 ilp = td_var(data, o->off2);
502 if (curr >= o->maxlen) {
503 log_err("the list exceeding max length %d\n",
507 if (!str_to_float(ptr, &uf)) {
508 log_err("not a floating point value: %s\n", ptr);
511 if (!isnan(o->maxfp) && uf > o->maxfp) {
512 log_err("value out of range: %f"
513 " (range max: %f)\n", uf, o->maxfp);
516 if (!isnan(o->minfp) && uf < o->minfp) {
517 log_err("value out of range: %f"
518 " (range min: %f)\n", uf, o->minfp);
522 flp = td_var(data, o->off1);
527 case FIO_OPT_STR_STORE: {
528 fio_opt_str_fn *fn = o->cb;
530 if (o->roff1 || o->off1) {
532 cp = (char **) o->roff1;
534 cp = td_var(data, o->off1);
543 else if (o->posval[0].ival) {
544 posval_sort(o, posval);
547 for (i = 0; i < PARSE_MAX_VP; i++) {
549 if (!vp->ival || vp->ival[0] == '\0')
552 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
558 rest = strstr(*cp ?: ptr, ":");
572 show_option_values(o);
581 case FIO_OPT_RANGE: {
585 strncpy(tmp, ptr, sizeof(tmp) - 1);
587 /* Handle bsrange with separate read,write values: */
588 p1 = strchr(tmp, ',');
592 p1 = strchr(tmp, '-');
594 p1 = strchr(tmp, ':');
606 if (!check_range_bytes(p1, &ul1, data) &&
607 !check_range_bytes(p2, &ul2, data)) {
610 unsigned long foo = ul1;
618 *(unsigned int *) o->roff1 = ul1;
620 val_store(ilp, ul1, o->off1, 0, data);
622 *(unsigned int *) o->roff2 = ul2;
624 val_store(ilp, ul2, o->off2, 0, data);
627 if (o->roff3 && o->roff4) {
628 *(unsigned int *) o->roff3 = ul1;
629 *(unsigned int *) o->roff4 = ul2;
630 } else if (o->off3 && o->off4) {
631 val_store(ilp, ul1, o->off3, 0, data);
632 val_store(ilp, ul2, o->off4, 0, data);
636 if (o->roff5 && o->roff6) {
637 *(unsigned int *) o->roff5 = ul1;
638 *(unsigned int *) o->roff6 = ul2;
639 } else if (o->off5 && o->off6) {
640 val_store(ilp, ul1, o->off5, 0, data);
641 val_store(ilp, ul2, o->off6, 0, data);
646 if (o->roff3 && o->roff4) {
647 *(unsigned int *) o->roff3 = ul1;
648 *(unsigned int *) o->roff4 = ul2;
649 } else if (o->off3 && o->off4) {
650 val_store(ilp, ul1, o->off3, 0, data);
651 val_store(ilp, ul2, o->off4, 0, data);
655 if (o->roff5 && o->roff6) {
656 *(unsigned int *) o->roff5 = ul1;
657 *(unsigned int *) o->roff6 = ul2;
658 } else if (o->off5 && o->off6) {
659 val_store(ilp, ul1, o->off5, 0, data);
660 val_store(ilp, ul2, o->off6, 0, data);
669 case FIO_OPT_STR_SET: {
670 fio_opt_int_fn *fn = o->cb;
673 ret = check_int(ptr, &il);
674 else if (o->type == FIO_OPT_BOOL)
682 if (o->maxval && il > (int) o->maxval) {
683 log_err("max value out of range: %d (%d max)\n",
687 if (o->minval && il < o->minval) {
688 log_err("min value out of range: %d (%d min)\n",
701 *(unsigned int *)o->roff1 = il;
703 val_store(ilp, il, o->off1, 0, data);
707 *(unsigned int *) o->roff2 = il;
709 val_store(ilp, il, o->off2, 0, data);
714 case FIO_OPT_DEPRECATED:
715 log_info("Option %s is deprecated\n", o->name);
718 log_err("Bad option type %u\n", o->type);
726 ret = o->verify(o, data);
728 log_err("Correct format for offending option\n");
729 log_err("%20s: %s\n", o->name, o->help);
730 show_option_help(o, 1);
737 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
739 char *o_ptr, *ptr, *ptr2;
742 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
746 o_ptr = ptr = strdup(__ptr);
749 * See if we have another set of parameters, hidden after a comma.
750 * Do this before parsing this round, to check if we should
751 * copy set 1 options to set 2.
760 (o->type != FIO_OPT_STR_STORE) &&
761 (o->type != FIO_OPT_STR) &&
762 (o->type != FIO_OPT_FLOAT_LIST)) {
763 ptr2 = strchr(ptr, ',');
764 if (ptr2 && *(ptr2 + 1) == '\0')
766 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
768 ptr2 = strchr(ptr, ':');
770 ptr2 = strchr(ptr, '-');
772 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
773 ptr2 = strchr(ptr, ':');
777 * Don't return early if parsing the first option fails - if
778 * we are doing multiple arguments, we can allow the first one
781 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
797 static struct fio_option *get_option(char *opt,
798 struct fio_option *options, char **post)
800 struct fio_option *o;
803 ret = strchr(opt, '=');
809 strip_blank_end(ret);
810 o = find_option(options, ret);
812 o = find_option(options, opt);
819 static int opt_cmp(const void *p1, const void *p2)
821 struct fio_option *o;
828 s = strdup(*((char **) p1));
829 o = get_option(s, __fio_options, &foo);
835 s = strdup(*((char **) p2));
836 o = get_option(s, __fio_options, &foo);
842 return prio2 - prio1;
845 void sort_options(char **opts, struct fio_option *options, int num_opts)
847 __fio_options = options;
848 qsort(opts, num_opts, sizeof(char *), opt_cmp);
849 __fio_options = NULL;
852 int parse_cmd_option(const char *opt, const char *val,
853 struct fio_option *options, void *data)
855 struct fio_option *o;
857 o = find_option(options, opt);
859 log_err("Bad option <%s>\n", opt);
863 if (!handle_option(o, val, data))
866 log_err("fio: failed parsing %s=%s\n", opt, val);
870 int parse_option(char *opt, const char *input,
871 struct fio_option *options, struct fio_option **o, void *data)
876 log_err("fio: failed parsing %s\n", input);
881 *o = get_option(opt, options, &post);
884 int len = strlen(opt);
885 if (opt + len + 1 != post)
886 memmove(opt + len + 1, post, strlen(post));
892 if (!handle_option(*o, post, data))
895 log_err("fio: failed parsing %s\n", input);
900 * Option match, levenshtein distance. Handy for not quite remembering what
901 * the option name is.
903 static int string_distance(const char *s1, const char *s2)
905 unsigned int s1_len = strlen(s1);
906 unsigned int s2_len = strlen(s2);
907 unsigned int *p, *q, *r;
910 p = malloc(sizeof(unsigned int) * (s2_len + 1));
911 q = malloc(sizeof(unsigned int) * (s2_len + 1));
914 for (i = 1; i <= s2_len; i++)
917 for (i = 1; i <= s1_len; i++) {
919 for (j = 1; j <= s2_len; j++) {
920 unsigned int sub = p[j - 1];
922 if (s1[i - 1] != s2[j - 1])
925 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
938 static struct fio_option *find_child(struct fio_option *options,
939 struct fio_option *o)
941 struct fio_option *__o;
943 for (__o = options + 1; __o->name; __o++)
944 if (__o->parent && !strcmp(__o->parent, o->name))
950 static void __print_option(struct fio_option *o, struct fio_option *org,
964 p += sprintf(p, "%s", " ");
966 sprintf(p, "%s", o->name);
968 log_info("%-24s: %s\n", name, o->help);
971 static void print_option(struct fio_option *o)
973 struct fio_option *parent;
974 struct fio_option *__o;
975 unsigned int printed;
978 __print_option(o, NULL, 0);
985 while ((__o = find_child(o, parent)) != NULL) {
986 __print_option(__o, o, level);
995 int show_cmd_help(struct fio_option *options, const char *name)
997 struct fio_option *o, *closest;
998 unsigned int best_dist = -1U;
1002 if (!name || !strcmp(name, "all"))
1007 for (o = &options[0]; o->name; o++) {
1010 if (o->type == FIO_OPT_DEPRECATED)
1012 if (!exec_profile && o->prof_name)
1016 if (!strcmp(name, o->name) ||
1017 (o->alias && !strcmp(name, o->alias)))
1022 dist = string_distance(name, o->name);
1023 if (dist < best_dist) {
1030 if (show_all || match) {
1033 log_info("%20s: %s\n", o->name, o->help);
1044 show_option_help(o, 0);
1050 log_err("No such command: %s", name);
1053 * Only print an appropriately close option, one where the edit
1054 * distance isn't too big. Otherwise we get crazy matches.
1056 if (closest && best_dist < 3) {
1057 log_info(" - showing closest match\n");
1058 log_info("%20s: %s\n", closest->name, closest->help);
1059 show_option_help(closest, 0);
1067 * Handle parsing of default parameters.
1069 void fill_default_options(void *data, struct fio_option *options)
1071 struct fio_option *o;
1073 dprint(FD_PARSE, "filling default options\n");
1075 for (o = &options[0]; o->name; o++)
1077 handle_option(o, o->def, data);
1080 void option_init(struct fio_option *o)
1082 if (o->type == FIO_OPT_DEPRECATED)
1084 if (o->type == FIO_OPT_BOOL) {
1088 if (o->type == FIO_OPT_INT) {
1090 o->maxval = UINT_MAX;
1092 if (o->type == FIO_OPT_FLOAT_LIST) {
1096 if (o->type == FIO_OPT_STR_SET && o->def) {
1097 log_err("Option %s: string set option with"
1098 " default will always be true\n", o->name);
1100 if (!o->cb && (!o->off1 && !o->roff1))
1101 log_err("Option %s: neither cb nor offset given\n", o->name);
1102 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1103 o->type == FIO_OPT_STR_MULTI)
1105 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1106 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1107 log_err("Option %s: both cb and offset given\n", o->name);
1110 log_info("Options %s: no category defined. Setting to misc\n", o->name);
1111 o->category = FIO_OPT_C_GENERAL;
1116 * Sanitize the options structure. For now it just sets min/max for bool
1117 * values and whether both callback and offsets are given.
1119 void options_init(struct fio_option *options)
1121 struct fio_option *o;
1123 dprint(FD_PARSE, "init options\n");
1125 for (o = &options[0]; o->name; o++) {
1128 o->inv_opt = find_option(options, o->inverse);
1132 void options_free(struct fio_option *options, void *data)
1134 struct fio_option *o;
1137 dprint(FD_PARSE, "free options\n");
1139 for (o = &options[0]; o->name; o++) {
1140 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1143 ptr = td_var(data, o->off1);