2 * This file contains the ini and command liner parser main.
19 static struct fio_option *fio_options;
20 extern unsigned int fio_get_kb_base(void *);
22 static int vp_cmp(const void *p1, const void *p2)
24 const struct value_pair *vp1 = p1;
25 const struct value_pair *vp2 = p2;
27 return strlen(vp2->ival) - strlen(vp1->ival);
30 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
32 const struct value_pair *vp;
35 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
37 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
38 vp = &o->posval[entries];
39 if (!vp->ival || vp->ival[0] == '\0')
42 memcpy(&vpmap[entries], vp, sizeof(*vp));
45 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
48 static void show_option_range(struct fio_option *o,
49 int (*logger)(const char *format, ...))
51 if (o->type == FIO_OPT_FLOAT_LIST){
52 if (isnan(o->minfp) && isnan(o->maxfp))
55 logger("%20s: min=%f", "range", o->minfp);
57 logger(", max=%f", o->maxfp);
60 if (!o->minval && !o->maxval)
63 logger("%20s: min=%d", "range", o->minval);
65 logger(", max=%d", o->maxval);
70 static void show_option_values(struct fio_option *o)
74 for (i = 0; i < PARSE_MAX_VP; i++) {
75 const struct value_pair *vp = &o->posval[i];
80 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
82 log_info(" %s", vp->help);
90 static void show_option_help(struct fio_option *o, int is_err)
92 const char *typehelp[] = {
96 "string with possible k/m/g postfix (opt=4k)",
97 "string with time postfix (opt=10s)",
99 "string with dual range (opt=1k-4k,4k-8k)",
100 "integer value (opt=100)",
101 "boolean value (opt=1)",
102 "list of floating point values separated by ':' (opt=5.9:7.8)",
106 int (*logger)(const char *format, ...);
114 logger("%20s: %s\n", "alias", o->alias);
116 logger("%20s: %s\n", "type", typehelp[o->type]);
117 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
119 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
120 show_option_range(o, logger);
121 show_option_values(o);
124 static unsigned long get_mult_time(char c)
141 static unsigned long long __get_mult_bytes(const char *p, void *data,
144 unsigned int kb_base = fio_get_kb_base(data);
145 unsigned long long ret = 1;
146 unsigned int i, pow = 0, mult = kb_base;
154 for (i = 0; i < strlen(c); i++)
155 c[i] = tolower(c[i]);
157 if (!strcmp("pib", c)) {
160 } else if (!strcmp("tib", c)) {
163 } else if (!strcmp("gib", c)) {
166 } else if (!strcmp("mib", c)) {
169 } else if (!strcmp("kib", c)) {
172 } else if (!strcmp("p", c) || !strcmp("pb", c))
174 else if (!strcmp("t", c) || !strcmp("tb", c))
176 else if (!strcmp("g", c) || !strcmp("gb", c))
178 else if (!strcmp("m", c) || !strcmp("mb", c))
180 else if (!strcmp("k", c) || !strcmp("kb", c))
182 else if (!strcmp("%", c)) {
189 ret *= (unsigned long long) mult;
195 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
202 return __get_mult_bytes(str, data, percent);
205 * Go forward until we hit a non-digit, or +/- sign
207 while ((p - str) <= len) {
208 if (!isdigit((int) *p) &&
209 (((*p != '+') && (*p != '-')) || digit_seen))
211 digit_seen |= isdigit((int) *p);
215 if (!isalpha((int) *p) && (*p != '%'))
218 return __get_mult_bytes(p, data, percent);
222 * Convert string into a floating number. Return 1 for success and 0 otherwise.
224 int str_to_float(const char *str, double *val)
226 return (1 == sscanf(str, "%lf", val));
230 * convert string into decimal value, noting any size suffix
232 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
240 if (strstr(str, "0x") || strstr(str, "0X"))
245 *val = strtoll(str, NULL, base);
246 if (*val == LONG_MAX && errno == ERANGE)
250 unsigned long long mult;
253 mult = get_mult_bytes(str, len, data, &perc);
259 *val *= get_mult_time(str[len - 1]);
264 static int check_str_bytes(const char *p, long long *val, void *data)
266 return str_to_decimal(p, val, 1, data);
269 static int check_str_time(const char *p, long long *val)
271 return str_to_decimal(p, val, 0, NULL);
274 void strip_blank_front(char **p)
280 while (isspace((int) *s))
286 void strip_blank_end(char *p)
303 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
309 static int check_range_bytes(const char *str, long *val, void *data)
313 if (!str_to_decimal(str, &__val, 1, data)) {
321 static int check_int(const char *p, int *val)
325 if (strstr(p, "0x") || strstr(p, "0X")) {
326 if (sscanf(p, "%x", val) == 1)
329 if (sscanf(p, "%u", val) == 1)
336 static int opt_len(const char *str)
340 postfix = strchr(str, ':');
344 return (int)(postfix - str);
347 #define val_store(ptr, val, off, or, data) \
349 ptr = td_var((data), (off)); \
356 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
357 int first, int more, int curr)
361 long long ull, *ullp;
365 int ret = 0, is_time = 0;
366 const struct value_pair *vp;
367 struct value_pair posval[PARSE_MAX_VP];
368 int i, all_skipped = 1;
370 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
373 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
374 log_err("Option %s requires an argument\n", o->name);
380 case FIO_OPT_STR_MULTI: {
381 fio_opt_str_fn *fn = o->cb;
383 posval_sort(o, posval);
386 for (i = 0; i < PARSE_MAX_VP; i++) {
388 if (!vp->ival || vp->ival[0] == '\0')
391 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
395 *(unsigned int *) o->roff1 |= vp->oval;
397 *(unsigned int *) o->roff1 = vp->oval;
401 val_store(ilp, vp->oval, o->off1, vp->or, data);
407 if (ret && !all_skipped)
408 show_option_values(o);
413 case FIO_OPT_STR_VAL_TIME:
416 case FIO_OPT_STR_VAL: {
417 fio_opt_str_val_fn *fn = o->cb;
420 strncpy(tmp, ptr, sizeof(tmp) - 1);
421 p = strchr(tmp, ',');
426 ret = check_str_time(tmp, &ull);
428 ret = check_str_bytes(tmp, &ull, data);
433 if (o->maxval && ull > o->maxval) {
434 log_err("max value out of range: %llu"
435 " (%u max)\n", ull, o->maxval);
438 if (o->minval && ull < o->minval) {
439 log_err("min value out of range: %llu"
440 " (%u min)\n", ull, o->minval);
445 ret = fn(data, &ull);
447 if (o->type == FIO_OPT_INT) {
450 *(unsigned int *) o->roff1 = ull;
452 val_store(ilp, ull, o->off1, 0, data);
456 *(unsigned int *) o->roff2 = ull;
458 val_store(ilp, ull, o->off2, 0, data);
462 *(unsigned int *) o->roff3 = ull;
464 val_store(ilp, ull, o->off3, 0, data);
469 *(unsigned int *) o->roff2 = ull;
471 val_store(ilp, ull, o->off2, 0, data);
475 *(unsigned int *) o->roff3 = ull;
477 val_store(ilp, ull, o->off3, 0, data);
483 *(unsigned long long *) o->roff1 = ull;
485 val_store(ullp, ull, o->off1, 0, data);
489 *(unsigned long long *) o->roff2 = ull;
491 val_store(ullp, ull, o->off2, 0, data);
497 case FIO_OPT_FLOAT_LIST: {
501 ilp = td_var(data, o->off2);
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);
545 else if (o->posval[0].ival) {
546 posval_sort(o, posval);
549 for (i = 0; i < PARSE_MAX_VP; i++) {
551 if (!vp->ival || vp->ival[0] == '\0')
554 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
560 rest = strstr(*cp ?: ptr, ":");
574 show_option_values(o);
583 case FIO_OPT_RANGE: {
587 strncpy(tmp, ptr, sizeof(tmp) - 1);
589 /* Handle bsrange with separate read,write values: */
590 p1 = strchr(tmp, ',');
594 p1 = strchr(tmp, '-');
596 p1 = strchr(tmp, ':');
608 if (!check_range_bytes(p1, &ul1, data) &&
609 !check_range_bytes(p2, &ul2, data)) {
612 unsigned long foo = ul1;
620 *(unsigned int *) o->roff1 = ul1;
622 val_store(ilp, ul1, o->off1, 0, data);
624 *(unsigned int *) o->roff2 = ul2;
626 val_store(ilp, ul2, o->off2, 0, data);
629 if (o->roff3 && o->roff4) {
630 *(unsigned int *) o->roff3 = ul1;
631 *(unsigned int *) o->roff4 = ul2;
632 } else if (o->off3 && o->off4) {
633 val_store(ilp, ul1, o->off3, 0, data);
634 val_store(ilp, ul2, o->off4, 0, data);
638 if (o->roff5 && o->roff6) {
639 *(unsigned int *) o->roff5 = ul1;
640 *(unsigned int *) o->roff6 = ul2;
641 } else if (o->off5 && o->off6) {
642 val_store(ilp, ul1, o->off5, 0, data);
643 val_store(ilp, ul2, o->off6, 0, data);
648 if (o->roff3 && o->roff4) {
649 *(unsigned int *) o->roff3 = ul1;
650 *(unsigned int *) o->roff4 = ul2;
651 } else if (o->off3 && o->off4) {
652 val_store(ilp, ul1, o->off3, 0, data);
653 val_store(ilp, ul2, o->off4, 0, data);
657 if (o->roff5 && o->roff6) {
658 *(unsigned int *) o->roff5 = ul1;
659 *(unsigned int *) o->roff6 = ul2;
660 } else if (o->off5 && o->off6) {
661 val_store(ilp, ul1, o->off5, 0, data);
662 val_store(ilp, ul2, o->off6, 0, data);
671 case FIO_OPT_STR_SET: {
672 fio_opt_int_fn *fn = o->cb;
675 ret = check_int(ptr, &il);
676 else if (o->type == FIO_OPT_BOOL)
684 if (o->maxval && il > (int) o->maxval) {
685 log_err("max value out of range: %d (%d max)\n",
689 if (o->minval && il < o->minval) {
690 log_err("min value out of range: %d (%d min)\n",
703 *(unsigned int *)o->roff1 = il;
705 val_store(ilp, il, o->off1, 0, data);
709 *(unsigned int *) o->roff2 = il;
711 val_store(ilp, il, o->off2, 0, data);
716 case FIO_OPT_DEPRECATED:
717 log_info("Option %s is deprecated\n", o->name);
720 log_err("Bad option type %u\n", o->type);
728 ret = o->verify(o, data);
730 log_err("Correct format for offending option\n");
731 log_err("%20s: %s\n", o->name, o->help);
732 show_option_help(o, 1);
739 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
741 char *o_ptr, *ptr, *ptr2;
744 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
748 o_ptr = ptr = strdup(__ptr);
751 * See if we have another set of parameters, hidden after a comma.
752 * Do this before parsing this round, to check if we should
753 * copy set 1 options to set 2.
762 (o->type != FIO_OPT_STR_STORE) &&
763 (o->type != FIO_OPT_STR) &&
764 (o->type != FIO_OPT_FLOAT_LIST)) {
765 ptr2 = strchr(ptr, ',');
766 if (ptr2 && *(ptr2 + 1) == '\0')
768 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
770 ptr2 = strchr(ptr, ':');
772 ptr2 = strchr(ptr, '-');
774 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
775 ptr2 = strchr(ptr, ':');
779 * Don't return early if parsing the first option fails - if
780 * we are doing multiple arguments, we can allow the first one
783 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
799 static struct fio_option *get_option(char *opt,
800 struct fio_option *options, char **post)
802 struct fio_option *o;
805 ret = strchr(opt, '=');
811 strip_blank_end(ret);
812 o = find_option(options, ret);
814 o = find_option(options, opt);
821 static int opt_cmp(const void *p1, const void *p2)
823 struct fio_option *o;
830 s = strdup(*((char **) p1));
831 o = get_option(s, fio_options, &foo);
837 s = strdup(*((char **) p2));
838 o = get_option(s, fio_options, &foo);
844 return prio2 - prio1;
847 void sort_options(char **opts, struct fio_option *options, int num_opts)
849 fio_options = options;
850 qsort(opts, num_opts, sizeof(char *), opt_cmp);
854 int parse_cmd_option(const char *opt, const char *val,
855 struct fio_option *options, void *data)
857 struct fio_option *o;
859 o = find_option(options, opt);
861 log_err("Bad option <%s>\n", opt);
865 if (!handle_option(o, val, data))
868 log_err("fio: failed parsing %s=%s\n", opt, val);
872 int parse_option(char *opt, const char *input,
873 struct fio_option *options, struct fio_option **o, void *data)
878 log_err("fio: failed parsing %s\n", input);
883 *o = get_option(opt, options, &post);
886 int len = strlen(opt);
887 if (opt + len + 1 != post)
888 memmove(opt + len + 1, post, strlen(post));
894 if (!handle_option(*o, post, data)) {
898 log_err("fio: failed parsing %s\n", input);
903 * Option match, levenshtein distance. Handy for not quite remembering what
904 * the option name is.
906 static int string_distance(const char *s1, const char *s2)
908 unsigned int s1_len = strlen(s1);
909 unsigned int s2_len = strlen(s2);
910 unsigned int *p, *q, *r;
913 p = malloc(sizeof(unsigned int) * (s2_len + 1));
914 q = malloc(sizeof(unsigned int) * (s2_len + 1));
917 for (i = 1; i <= s2_len; i++)
920 for (i = 1; i <= s1_len; i++) {
922 for (j = 1; j <= s2_len; j++) {
923 unsigned int sub = p[j - 1];
925 if (s1[i - 1] != s2[j - 1])
928 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
941 static struct fio_option *find_child(struct fio_option *options,
942 struct fio_option *o)
944 struct fio_option *__o;
946 for (__o = options + 1; __o->name; __o++)
947 if (__o->parent && !strcmp(__o->parent, o->name))
953 static void __print_option(struct fio_option *o, struct fio_option *org,
967 p += sprintf(p, "%s", " ");
969 sprintf(p, "%s", o->name);
971 log_info("%-24s: %s\n", name, o->help);
974 static void print_option(struct fio_option *o)
976 struct fio_option *parent;
977 struct fio_option *__o;
978 unsigned int printed;
981 __print_option(o, NULL, 0);
988 while ((__o = find_child(o, parent)) != NULL) {
989 __print_option(__o, o, level);
998 int show_cmd_help(struct fio_option *options, const char *name)
1000 struct fio_option *o, *closest;
1001 unsigned int best_dist = -1U;
1005 if (!name || !strcmp(name, "all"))
1010 for (o = &options[0]; o->name; o++) {
1013 if (o->type == FIO_OPT_DEPRECATED)
1015 if (!exec_profile && o->prof_name)
1019 if (!strcmp(name, o->name) ||
1020 (o->alias && !strcmp(name, o->alias)))
1025 dist = string_distance(name, o->name);
1026 if (dist < best_dist) {
1033 if (show_all || match) {
1036 log_info("%20s: %s\n", o->name, o->help);
1047 show_option_help(o, 0);
1053 log_err("No such command: %s", name);
1056 * Only print an appropriately close option, one where the edit
1057 * distance isn't too big. Otherwise we get crazy matches.
1059 if (closest && best_dist < 3) {
1060 log_info(" - showing closest match\n");
1061 log_info("%20s: %s\n", closest->name, closest->help);
1062 show_option_help(closest, 0);
1070 * Handle parsing of default parameters.
1072 void fill_default_options(void *data, struct fio_option *options)
1074 struct fio_option *o;
1076 dprint(FD_PARSE, "filling default options\n");
1078 for (o = &options[0]; o->name; o++)
1080 handle_option(o, o->def, data);
1083 void option_init(struct fio_option *o)
1085 if (o->type == FIO_OPT_DEPRECATED)
1087 if (o->type == FIO_OPT_BOOL) {
1091 if (o->type == FIO_OPT_INT) {
1093 o->maxval = UINT_MAX;
1095 if (o->type == FIO_OPT_FLOAT_LIST) {
1099 if (o->type == FIO_OPT_STR_SET && o->def) {
1100 log_err("Option %s: string set option with"
1101 " default will always be true\n", o->name);
1103 if (!o->cb && (!o->off1 && !o->roff1))
1104 log_err("Option %s: neither cb nor offset given\n", o->name);
1105 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1106 o->type == FIO_OPT_STR_MULTI)
1108 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1109 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1110 log_err("Option %s: both cb and offset given\n", o->name);
1115 * Sanitize the options structure. For now it just sets min/max for bool
1116 * values and whether both callback and offsets are given.
1118 void options_init(struct fio_option *options)
1120 struct fio_option *o;
1122 dprint(FD_PARSE, "init options\n");
1124 for (o = &options[0]; o->name; o++)
1128 void options_free(struct fio_option *options, void *data)
1130 struct fio_option *o;
1133 dprint(FD_PARSE, "free options\n");
1135 for (o = &options[0]; o->name; o++) {
1136 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1139 ptr = td_var(data, o->off1);