2 * This file contains the ini and command liner parser main.
18 #include "lib/ieee754.h"
20 static struct fio_option *fio_options;
21 extern unsigned int fio_get_kb_base(void *);
23 static int vp_cmp(const void *p1, const void *p2)
25 const struct value_pair *vp1 = p1;
26 const struct value_pair *vp2 = p2;
28 return strlen(vp2->ival) - strlen(vp1->ival);
31 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
33 const struct value_pair *vp;
36 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
38 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
39 vp = &o->posval[entries];
40 if (!vp->ival || vp->ival[0] == '\0')
43 memcpy(&vpmap[entries], vp, sizeof(*vp));
46 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
49 static void show_option_range(struct fio_option *o,
50 int (*logger)(const char *format, ...))
52 if (o->type == FIO_OPT_FLOAT_LIST){
53 if (isnan(o->minfp) && isnan(o->maxfp))
56 logger("%20s: min=%f", "range", o->minfp);
58 logger(", max=%f", o->maxfp);
61 if (!o->minval && !o->maxval)
64 logger("%20s: min=%d", "range", o->minval);
66 logger(", max=%d", o->maxval);
71 static void show_option_values(struct fio_option *o)
75 for (i = 0; i < PARSE_MAX_VP; i++) {
76 const struct value_pair *vp = &o->posval[i];
81 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
83 log_info(" %s", vp->help);
91 static void show_option_help(struct fio_option *o, int is_err)
93 const char *typehelp[] = {
97 "string with possible k/m/g postfix (opt=4k)",
98 "string with time postfix (opt=10s)",
100 "string with dual range (opt=1k-4k,4k-8k)",
101 "integer value (opt=100)",
102 "boolean value (opt=1)",
103 "list of floating point values separated by ':' (opt=5.9:7.8)",
107 int (*logger)(const char *format, ...);
115 logger("%20s: %s\n", "alias", o->alias);
117 logger("%20s: %s\n", "type", typehelp[o->type]);
118 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
120 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
121 show_option_range(o, logger);
122 show_option_values(o);
125 static unsigned long get_mult_time(char c)
142 static unsigned long long __get_mult_bytes(const char *p, void *data,
145 unsigned int kb_base = fio_get_kb_base(data);
146 unsigned long long ret = 1;
147 unsigned int i, pow = 0, mult = kb_base;
155 for (i = 0; i < strlen(c); i++)
156 c[i] = tolower(c[i]);
158 if (!strcmp("pib", c)) {
161 } else if (!strcmp("tib", c)) {
164 } else if (!strcmp("gib", c)) {
167 } else if (!strcmp("mib", c)) {
170 } else if (!strcmp("kib", c)) {
173 } else if (!strcmp("p", c) || !strcmp("pb", c))
175 else if (!strcmp("t", c) || !strcmp("tb", c))
177 else if (!strcmp("g", c) || !strcmp("gb", c))
179 else if (!strcmp("m", c) || !strcmp("mb", c))
181 else if (!strcmp("k", c) || !strcmp("kb", c))
183 else if (!strcmp("%", c)) {
190 ret *= (unsigned long long) mult;
196 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
203 return __get_mult_bytes(str, data, percent);
206 * Go forward until we hit a non-digit, or +/- sign
208 while ((p - str) <= len) {
209 if (!isdigit((int) *p) &&
210 (((*p != '+') && (*p != '-')) || digit_seen))
212 digit_seen |= isdigit((int) *p);
216 if (!isalpha((int) *p) && (*p != '%'))
219 return __get_mult_bytes(p, data, percent);
223 * Convert string into a floating number. Return 1 for success and 0 otherwise.
225 int str_to_float(const char *str, double *val)
227 return (1 == sscanf(str, "%lf", val));
231 * convert string into decimal value, noting any size suffix
233 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
241 if (strstr(str, "0x") || strstr(str, "0X"))
246 *val = strtoll(str, NULL, base);
247 if (*val == LONG_MAX && errno == ERANGE)
251 unsigned long long mult;
254 mult = get_mult_bytes(str, len, data, &perc);
260 *val *= get_mult_time(str[len - 1]);
265 static int check_str_bytes(const char *p, long long *val, void *data)
267 return str_to_decimal(p, val, 1, data);
270 static int check_str_time(const char *p, long long *val)
272 return str_to_decimal(p, val, 0, NULL);
275 void strip_blank_front(char **p)
281 while (isspace((int) *s))
287 void strip_blank_end(char *p)
304 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
310 static int check_range_bytes(const char *str, long *val, void *data)
314 if (!str_to_decimal(str, &__val, 1, data)) {
322 static int check_int(const char *p, int *val)
326 if (strstr(p, "0x") || strstr(p, "0X")) {
327 if (sscanf(p, "%x", val) == 1)
330 if (sscanf(p, "%u", val) == 1)
337 static int opt_len(const char *str)
341 postfix = strchr(str, ':');
345 return (int)(postfix - str);
348 static int str_match_len(const struct value_pair *vp, const char *str)
350 return max(strlen(vp->ival), opt_len(str));
353 #define val_store(ptr, val, off, or, data) \
355 ptr = td_var((data), (off)); \
362 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
363 int first, int more, int curr)
367 long long ull, *ullp;
371 int ret = 0, is_time = 0;
372 const struct value_pair *vp;
373 struct value_pair posval[PARSE_MAX_VP];
374 int i, all_skipped = 1;
376 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
379 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
380 log_err("Option %s requires an argument\n", o->name);
386 case FIO_OPT_STR_MULTI: {
387 fio_opt_str_fn *fn = o->cb;
389 posval_sort(o, posval);
392 for (i = 0; i < PARSE_MAX_VP; i++) {
394 if (!vp->ival || vp->ival[0] == '\0')
397 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
401 *(unsigned int *) o->roff1 |= vp->oval;
403 *(unsigned int *) o->roff1 = vp->oval;
407 val_store(ilp, vp->oval, o->off1, vp->or, data);
413 if (ret && !all_skipped)
414 show_option_values(o);
419 case FIO_OPT_STR_VAL_TIME:
422 case FIO_OPT_STR_VAL: {
423 fio_opt_str_val_fn *fn = o->cb;
426 strncpy(tmp, ptr, sizeof(tmp) - 1);
427 p = strchr(tmp, ',');
432 ret = check_str_time(tmp, &ull);
434 ret = check_str_bytes(tmp, &ull, data);
439 if (o->maxval && ull > o->maxval) {
440 log_err("max value out of range: %llu"
441 " (%u max)\n", ull, o->maxval);
444 if (o->minval && ull < o->minval) {
445 log_err("min value out of range: %llu"
446 " (%u min)\n", ull, o->minval);
451 ret = fn(data, &ull);
453 if (o->type == FIO_OPT_INT) {
456 *(unsigned int *) o->roff1 = ull;
458 val_store(ilp, ull, o->off1, 0, data);
462 *(unsigned int *) o->roff2 = ull;
464 val_store(ilp, ull, o->off2, 0, data);
468 *(unsigned int *) o->roff3 = ull;
470 val_store(ilp, ull, o->off3, 0, data);
475 *(unsigned int *) o->roff2 = ull;
477 val_store(ilp, ull, o->off2, 0, data);
481 *(unsigned int *) o->roff3 = ull;
483 val_store(ilp, ull, o->off3, 0, data);
489 *(unsigned long long *) o->roff1 = ull;
491 val_store(ullp, ull, o->off1, 0, data);
495 *(unsigned long long *) o->roff2 = ull;
497 val_store(ullp, ull, o->off2, 0, data);
503 case FIO_OPT_FLOAT_LIST: {
504 if (curr >= o->maxlen) {
505 log_err("the list exceeding max length %d\n",
509 if (!str_to_float(ptr, &uf)){
510 log_err("not a floating point value: %s\n", ptr);
513 if (!isnan(o->maxfp) && uf > o->maxfp) {
514 log_err("value out of range: %f"
515 " (range max: %f)\n", uf, o->maxfp);
518 if (!isnan(o->minfp) && uf < o->minfp) {
519 log_err("value out of range: %f"
520 " (range min: %f)\n", uf, o->minfp);
524 flp = td_var(data, o->off1);
529 case FIO_OPT_STR_STORE: {
530 fio_opt_str_fn *fn = o->cb;
532 if (o->roff1 || o->off1) {
534 cp = (char **) o->roff1;
536 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, str_match_len(vp, 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);
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)) {
896 log_err("fio: failed parsing %s\n", input);
901 * Option match, levenshtein distance. Handy for not quite remembering what
902 * the option name is.
904 static int string_distance(const char *s1, const char *s2)
906 unsigned int s1_len = strlen(s1);
907 unsigned int s2_len = strlen(s2);
908 unsigned int *p, *q, *r;
911 p = malloc(sizeof(unsigned int) * (s2_len + 1));
912 q = malloc(sizeof(unsigned int) * (s2_len + 1));
915 for (i = 1; i <= s2_len; i++)
918 for (i = 1; i <= s1_len; i++) {
920 for (j = 1; j <= s2_len; j++) {
921 unsigned int sub = p[j - 1];
923 if (s1[i - 1] != s2[j - 1])
926 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
939 static struct fio_option *find_child(struct fio_option *options,
940 struct fio_option *o)
942 struct fio_option *__o;
944 for (__o = options + 1; __o->name; __o++)
945 if (__o->parent && !strcmp(__o->parent, o->name))
951 static void __print_option(struct fio_option *o, struct fio_option *org,
965 p += sprintf(p, "%s", " ");
967 sprintf(p, "%s", o->name);
969 log_info("%-24s: %s\n", name, o->help);
972 static void print_option(struct fio_option *o)
974 struct fio_option *parent;
975 struct fio_option *__o;
976 unsigned int printed;
979 __print_option(o, NULL, 0);
986 while ((__o = find_child(o, parent)) != NULL) {
987 __print_option(__o, o, level);
996 int show_cmd_help(struct fio_option *options, const char *name)
998 struct fio_option *o, *closest;
999 unsigned int best_dist = -1U;
1003 if (!name || !strcmp(name, "all"))
1008 for (o = &options[0]; o->name; o++) {
1011 if (o->type == FIO_OPT_DEPRECATED)
1013 if (!exec_profile && o->prof_name)
1017 if (!strcmp(name, o->name) ||
1018 (o->alias && !strcmp(name, o->alias)))
1023 dist = string_distance(name, o->name);
1024 if (dist < best_dist) {
1031 if (show_all || match) {
1034 log_info("%20s: %s\n", o->name, o->help);
1045 show_option_help(o, 0);
1051 log_err("No such command: %s", name);
1054 * Only print an appropriately close option, one where the edit
1055 * distance isn't too big. Otherwise we get crazy matches.
1057 if (closest && best_dist < 3) {
1058 log_info(" - showing closest match\n");
1059 log_info("%20s: %s\n", closest->name, closest->help);
1060 show_option_help(closest, 0);
1068 * Handle parsing of default parameters.
1070 void fill_default_options(void *data, struct fio_option *options)
1072 struct fio_option *o;
1074 dprint(FD_PARSE, "filling default options\n");
1076 for (o = &options[0]; o->name; o++)
1078 handle_option(o, o->def, data);
1081 void option_init(struct fio_option *o)
1083 if (o->type == FIO_OPT_DEPRECATED)
1085 if (o->type == FIO_OPT_BOOL) {
1089 if (o->type == FIO_OPT_INT) {
1091 o->maxval = UINT_MAX;
1093 if (o->type == FIO_OPT_FLOAT_LIST) {
1095 #define NAN __builtin_nanf("")
1100 if (o->type == FIO_OPT_STR_SET && o->def) {
1101 log_err("Option %s: string set option with"
1102 " default will always be true\n", o->name);
1104 if (!o->cb && (!o->off1 && !o->roff1))
1105 log_err("Option %s: neither cb nor offset given\n", o->name);
1106 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1107 o->type == FIO_OPT_STR_MULTI)
1109 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1110 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1111 log_err("Option %s: both cb and offset given\n", o->name);
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++)
1129 void options_free(struct fio_option *options, void *data)
1131 struct fio_option *o;
1134 dprint(FD_PARSE, "free options\n");
1136 for (o = &options[0]; o->name; o++) {
1137 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1140 ptr = td_var(data, o->off1);