2 * This file contains the ini and command liner parser main.
19 #include "lib/ieee754.h"
21 static struct fio_option *fio_options;
22 extern unsigned int fio_get_kb_base(void *);
24 static int vp_cmp(const void *p1, const void *p2)
26 const struct value_pair *vp1 = p1;
27 const struct value_pair *vp2 = p2;
29 return strlen(vp2->ival) - strlen(vp1->ival);
32 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
34 const struct value_pair *vp;
37 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
39 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
40 vp = &o->posval[entries];
41 if (!vp->ival || vp->ival[0] == '\0')
44 memcpy(&vpmap[entries], vp, sizeof(*vp));
47 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
50 static void show_option_range(struct fio_option *o,
51 int (*logger)(const char *format, ...))
53 if (o->type == FIO_OPT_FLOAT_LIST){
54 if (o->minfp == DBL_MIN && o->maxfp == DBL_MAX)
57 logger("%20s: min=%f", "range", o->minfp);
58 if (o->maxfp != DBL_MAX)
59 logger(", max=%f", o->maxfp);
62 if (!o->minval && !o->maxval)
65 logger("%20s: min=%d", "range", o->minval);
67 logger(", max=%d", o->maxval);
72 static void show_option_values(struct fio_option *o)
76 for (i = 0; i < PARSE_MAX_VP; i++) {
77 const struct value_pair *vp = &o->posval[i];
82 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
84 log_info(" %s", vp->help);
92 static void show_option_help(struct fio_option *o, int is_err)
94 const char *typehelp[] = {
98 "string with possible k/m/g postfix (opt=4k)",
99 "string with time postfix (opt=10s)",
101 "string with dual range (opt=1k-4k,4k-8k)",
102 "integer value (opt=100)",
103 "boolean value (opt=1)",
104 "list of floating point values separated by ':' (opt=5.9:7.8)",
108 int (*logger)(const char *format, ...);
116 logger("%20s: %s\n", "alias", o->alias);
118 logger("%20s: %s\n", "type", typehelp[o->type]);
119 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
121 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
122 show_option_range(o, logger);
123 show_option_values(o);
126 static unsigned long get_mult_time(char c)
143 static unsigned long long __get_mult_bytes(const char *p, void *data,
146 unsigned int kb_base = fio_get_kb_base(data);
147 unsigned long long ret = 1;
148 unsigned int i, pow = 0, mult = kb_base;
156 for (i = 0; i < strlen(c); i++)
157 c[i] = tolower(c[i]);
159 if (!strcmp("pib", c)) {
162 } else if (!strcmp("tib", c)) {
165 } else if (!strcmp("gib", c)) {
168 } else if (!strcmp("mib", c)) {
171 } else if (!strcmp("kib", c)) {
174 } else if (!strcmp("p", c) || !strcmp("pb", c))
176 else if (!strcmp("t", c) || !strcmp("tb", c))
178 else if (!strcmp("g", c) || !strcmp("gb", c))
180 else if (!strcmp("m", c) || !strcmp("mb", c))
182 else if (!strcmp("k", c) || !strcmp("kb", c))
184 else if (!strcmp("%", c)) {
191 ret *= (unsigned long long) mult;
197 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
204 return __get_mult_bytes(str, data, percent);
207 * Go forward until we hit a non-digit, or +/- sign
209 while ((p - str) <= len) {
210 if (!isdigit((int) *p) &&
211 (((*p != '+') && (*p != '-')) || digit_seen))
213 digit_seen |= isdigit((int) *p);
217 if (!isalpha((int) *p) && (*p != '%'))
220 return __get_mult_bytes(p, data, percent);
224 * Convert string into a floating number. Return 1 for success and 0 otherwise.
226 int str_to_float(const char *str, double *val)
228 return (1 == sscanf(str, "%lf", val));
232 * convert string into decimal value, noting any size suffix
234 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
242 if (strstr(str, "0x") || strstr(str, "0X"))
247 *val = strtoll(str, NULL, base);
248 if (*val == LONG_MAX && errno == ERANGE)
252 unsigned long long mult;
255 mult = get_mult_bytes(str, len, data, &perc);
261 *val *= get_mult_time(str[len - 1]);
266 static int check_str_bytes(const char *p, long long *val, void *data)
268 return str_to_decimal(p, val, 1, data);
271 static int check_str_time(const char *p, long long *val)
273 return str_to_decimal(p, val, 0, NULL);
276 void strip_blank_front(char **p)
282 while (isspace((int) *s))
288 void strip_blank_end(char *p)
305 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
311 static int check_range_bytes(const char *str, long *val, void *data)
315 if (!str_to_decimal(str, &__val, 1, data)) {
323 static int check_int(const char *p, int *val)
327 if (strstr(p, "0x") || strstr(p, "0X")) {
328 if (sscanf(p, "%x", val) == 1)
331 if (sscanf(p, "%u", val) == 1)
338 static int opt_len(const char *str)
342 postfix = strchr(str, ':');
346 return (int)(postfix - str);
349 static int str_match_len(const struct value_pair *vp, const char *str)
351 return max(strlen(vp->ival), opt_len(str));
354 #define val_store(ptr, val, off, or, data) \
356 ptr = td_var((data), (off)); \
363 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
364 int first, int more, int curr)
368 long long ull, *ullp;
372 int ret = 0, is_time = 0;
373 const struct value_pair *vp;
374 struct value_pair posval[PARSE_MAX_VP];
375 int i, all_skipped = 1;
377 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
380 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
381 log_err("Option %s requires an argument\n", o->name);
387 case FIO_OPT_STR_MULTI: {
388 fio_opt_str_fn *fn = o->cb;
390 posval_sort(o, posval);
393 for (i = 0; i < PARSE_MAX_VP; i++) {
395 if (!vp->ival || vp->ival[0] == '\0')
398 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
402 *(unsigned int *) o->roff1 |= vp->oval;
404 *(unsigned int *) o->roff1 = vp->oval;
408 val_store(ilp, vp->oval, o->off1, vp->or, data);
414 if (ret && !all_skipped)
415 show_option_values(o);
420 case FIO_OPT_STR_VAL_TIME:
423 case FIO_OPT_STR_VAL: {
424 fio_opt_str_val_fn *fn = o->cb;
427 strncpy(tmp, ptr, sizeof(tmp) - 1);
428 p = strchr(tmp, ',');
433 ret = check_str_time(tmp, &ull);
435 ret = check_str_bytes(tmp, &ull, data);
440 if (o->maxval && ull > o->maxval) {
441 log_err("max value out of range: %llu"
442 " (%u max)\n", ull, o->maxval);
445 if (o->minval && ull < o->minval) {
446 log_err("min value out of range: %llu"
447 " (%u min)\n", ull, o->minval);
452 ret = fn(data, &ull);
454 if (o->type == FIO_OPT_INT) {
457 *(unsigned int *) o->roff1 = ull;
459 val_store(ilp, ull, o->off1, 0, data);
463 *(unsigned int *) o->roff2 = ull;
465 val_store(ilp, ull, o->off2, 0, data);
469 *(unsigned int *) o->roff3 = ull;
471 val_store(ilp, ull, o->off3, 0, data);
476 *(unsigned int *) o->roff2 = ull;
478 val_store(ilp, ull, o->off2, 0, data);
482 *(unsigned int *) o->roff3 = ull;
484 val_store(ilp, ull, o->off3, 0, data);
490 *(unsigned long long *) o->roff1 = ull;
492 val_store(ullp, ull, o->off1, 0, data);
496 *(unsigned long long *) o->roff2 = ull;
498 val_store(ullp, ull, o->off2, 0, data);
504 case FIO_OPT_FLOAT_LIST: {
509 ** Initialize precision to 0 and zero out list
510 ** in case specified list is shorter than default
513 ilp = td_var(data, o->off2);
516 flp = td_var(data, o->off1);
517 for(i = 0; i < o->maxlen; i++)
520 if (curr >= o->maxlen) {
521 log_err("the list exceeding max length %d\n",
525 if (!str_to_float(ptr, &uf)) {
526 log_err("not a floating point value: %s\n", ptr);
530 log_err("value out of range: %f"
531 " (range max: %f)\n", uf, o->maxfp);
535 log_err("value out of range: %f"
536 " (range min: %f)\n", uf, o->minfp);
540 flp = td_var(data, o->off1);
544 ** Calculate precision for output by counting
545 ** number of digits after period. Find first
546 ** period in entire remaining list each time
548 cp2 = strchr(ptr, '.');
552 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
555 ilp = td_var(data, o->off2);
562 case FIO_OPT_STR_STORE: {
563 fio_opt_str_fn *fn = o->cb;
565 if (o->roff1 || o->off1) {
567 cp = (char **) o->roff1;
569 cp = td_var(data, o->off1);
576 else if (o->posval[0].ival) {
577 posval_sort(o, posval);
580 for (i = 0; i < PARSE_MAX_VP; i++) {
582 if (!vp->ival || vp->ival[0] == '\0')
585 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
591 rest = strstr(*cp ?: ptr, ":");
605 show_option_values(o);
614 case FIO_OPT_RANGE: {
618 strncpy(tmp, ptr, sizeof(tmp) - 1);
620 /* Handle bsrange with separate read,write values: */
621 p1 = strchr(tmp, ',');
625 p1 = strchr(tmp, '-');
627 p1 = strchr(tmp, ':');
639 if (!check_range_bytes(p1, &ul1, data) &&
640 !check_range_bytes(p2, &ul2, data)) {
643 unsigned long foo = ul1;
651 *(unsigned int *) o->roff1 = ul1;
653 val_store(ilp, ul1, o->off1, 0, data);
655 *(unsigned int *) o->roff2 = ul2;
657 val_store(ilp, ul2, o->off2, 0, data);
660 if (o->roff3 && o->roff4) {
661 *(unsigned int *) o->roff3 = ul1;
662 *(unsigned int *) o->roff4 = ul2;
663 } else if (o->off3 && o->off4) {
664 val_store(ilp, ul1, o->off3, 0, data);
665 val_store(ilp, ul2, o->off4, 0, data);
669 if (o->roff5 && o->roff6) {
670 *(unsigned int *) o->roff5 = ul1;
671 *(unsigned int *) o->roff6 = ul2;
672 } else if (o->off5 && o->off6) {
673 val_store(ilp, ul1, o->off5, 0, data);
674 val_store(ilp, ul2, o->off6, 0, data);
679 if (o->roff3 && o->roff4) {
680 *(unsigned int *) o->roff3 = ul1;
681 *(unsigned int *) o->roff4 = ul2;
682 } else if (o->off3 && o->off4) {
683 val_store(ilp, ul1, o->off3, 0, data);
684 val_store(ilp, ul2, o->off4, 0, data);
688 if (o->roff5 && o->roff6) {
689 *(unsigned int *) o->roff5 = ul1;
690 *(unsigned int *) o->roff6 = ul2;
691 } else if (o->off5 && o->off6) {
692 val_store(ilp, ul1, o->off5, 0, data);
693 val_store(ilp, ul2, o->off6, 0, data);
702 case FIO_OPT_STR_SET: {
703 fio_opt_int_fn *fn = o->cb;
706 ret = check_int(ptr, &il);
707 else if (o->type == FIO_OPT_BOOL)
715 if (o->maxval && il > (int) o->maxval) {
716 log_err("max value out of range: %d (%d max)\n",
720 if (o->minval && il < o->minval) {
721 log_err("min value out of range: %d (%d min)\n",
734 *(unsigned int *)o->roff1 = il;
736 val_store(ilp, il, o->off1, 0, data);
740 *(unsigned int *) o->roff2 = il;
742 val_store(ilp, il, o->off2, 0, data);
747 case FIO_OPT_DEPRECATED:
748 log_info("Option %s is deprecated\n", o->name);
751 log_err("Bad option type %u\n", o->type);
759 ret = o->verify(o, data);
761 log_err("Correct format for offending option\n");
762 log_err("%20s: %s\n", o->name, o->help);
763 show_option_help(o, 1);
770 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
772 char *o_ptr, *ptr, *ptr2;
775 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
779 o_ptr = ptr = strdup(__ptr);
782 * See if we have another set of parameters, hidden after a comma.
783 * Do this before parsing this round, to check if we should
784 * copy set 1 options to set 2.
793 (o->type != FIO_OPT_STR_STORE) &&
794 (o->type != FIO_OPT_STR) &&
795 (o->type != FIO_OPT_FLOAT_LIST)) {
796 ptr2 = strchr(ptr, ',');
797 if (ptr2 && *(ptr2 + 1) == '\0')
799 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
801 ptr2 = strchr(ptr, ':');
803 ptr2 = strchr(ptr, '-');
805 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
806 ptr2 = strchr(ptr, ':');
810 * Don't return early if parsing the first option fails - if
811 * we are doing multiple arguments, we can allow the first one
814 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
830 static struct fio_option *get_option(char *opt,
831 struct fio_option *options, char **post)
833 struct fio_option *o;
836 ret = strchr(opt, '=');
842 strip_blank_end(ret);
843 o = find_option(options, ret);
845 o = find_option(options, opt);
852 static int opt_cmp(const void *p1, const void *p2)
854 struct fio_option *o;
861 s = strdup(*((char **) p1));
862 o = get_option(s, fio_options, &foo);
868 s = strdup(*((char **) p2));
869 o = get_option(s, fio_options, &foo);
875 return prio2 - prio1;
878 void sort_options(char **opts, struct fio_option *options, int num_opts)
880 fio_options = options;
881 qsort(opts, num_opts, sizeof(char *), opt_cmp);
885 int parse_cmd_option(const char *opt, const char *val,
886 struct fio_option *options, void *data)
888 struct fio_option *o;
890 o = find_option(options, opt);
892 log_err("Bad option <%s>\n", opt);
896 if (!handle_option(o, val, data))
899 log_err("fio: failed parsing %s=%s\n", opt, val);
903 int parse_option(char *opt, const char *input,
904 struct fio_option *options, struct fio_option **o, void *data)
909 log_err("fio: failed parsing %s\n", input);
914 *o = get_option(opt, options, &post);
917 int len = strlen(opt);
918 if (opt + len + 1 != post)
919 memmove(opt + len + 1, post, strlen(post));
925 if (!handle_option(*o, post, data)) {
929 log_err("fio: failed parsing %s\n", input);
934 * Option match, levenshtein distance. Handy for not quite remembering what
935 * the option name is.
937 static int string_distance(const char *s1, const char *s2)
939 unsigned int s1_len = strlen(s1);
940 unsigned int s2_len = strlen(s2);
941 unsigned int *p, *q, *r;
944 p = malloc(sizeof(unsigned int) * (s2_len + 1));
945 q = malloc(sizeof(unsigned int) * (s2_len + 1));
948 for (i = 1; i <= s2_len; i++)
951 for (i = 1; i <= s1_len; i++) {
953 for (j = 1; j <= s2_len; j++) {
954 unsigned int sub = p[j - 1];
956 if (s1[i - 1] != s2[j - 1])
959 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
972 static struct fio_option *find_child(struct fio_option *options,
973 struct fio_option *o)
975 struct fio_option *__o;
977 for (__o = options + 1; __o->name; __o++)
978 if (__o->parent && !strcmp(__o->parent, o->name))
984 static void __print_option(struct fio_option *o, struct fio_option *org,
998 p += sprintf(p, "%s", " ");
1000 sprintf(p, "%s", o->name);
1002 log_info("%-24s: %s\n", name, o->help);
1005 static void print_option(struct fio_option *o)
1007 struct fio_option *parent;
1008 struct fio_option *__o;
1009 unsigned int printed;
1012 __print_option(o, NULL, 0);
1019 while ((__o = find_child(o, parent)) != NULL) {
1020 __print_option(__o, o, level);
1029 int show_cmd_help(struct fio_option *options, const char *name)
1031 struct fio_option *o, *closest;
1032 unsigned int best_dist = -1U;
1036 if (!name || !strcmp(name, "all"))
1041 for (o = &options[0]; o->name; o++) {
1044 if (o->type == FIO_OPT_DEPRECATED)
1046 if (!exec_profile && o->prof_name)
1050 if (!strcmp(name, o->name) ||
1051 (o->alias && !strcmp(name, o->alias)))
1056 dist = string_distance(name, o->name);
1057 if (dist < best_dist) {
1064 if (show_all || match) {
1067 log_info("%20s: %s\n", o->name, o->help);
1078 show_option_help(o, 0);
1084 log_err("No such command: %s", name);
1087 * Only print an appropriately close option, one where the edit
1088 * distance isn't too big. Otherwise we get crazy matches.
1090 if (closest && best_dist < 3) {
1091 log_info(" - showing closest match\n");
1092 log_info("%20s: %s\n", closest->name, closest->help);
1093 show_option_help(closest, 0);
1101 * Handle parsing of default parameters.
1103 void fill_default_options(void *data, struct fio_option *options)
1105 struct fio_option *o;
1107 dprint(FD_PARSE, "filling default options\n");
1109 for (o = &options[0]; o->name; o++)
1111 handle_option(o, o->def, data);
1114 void option_init(struct fio_option *o)
1116 if (o->type == FIO_OPT_DEPRECATED)
1118 if (o->type == FIO_OPT_BOOL) {
1122 if (o->type == FIO_OPT_INT) {
1124 o->maxval = UINT_MAX;
1126 if (o->type == FIO_OPT_FLOAT_LIST) {
1130 if (o->type == FIO_OPT_STR_SET && o->def) {
1131 log_err("Option %s: string set option with"
1132 " default will always be true\n", o->name);
1134 if (!o->cb && (!o->off1 && !o->roff1))
1135 log_err("Option %s: neither cb nor offset given\n", o->name);
1136 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1137 o->type == FIO_OPT_STR_MULTI)
1139 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1140 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1141 log_err("Option %s: both cb and offset given\n", o->name);
1146 * Sanitize the options structure. For now it just sets min/max for bool
1147 * values and whether both callback and offsets are given.
1149 void options_init(struct fio_option *options)
1151 struct fio_option *o;
1153 dprint(FD_PARSE, "init options\n");
1155 for (o = &options[0]; o->name; o++)
1159 void options_free(struct fio_option *options, void *data)
1161 struct fio_option *o;
1164 dprint(FD_PARSE, "free options\n");
1166 for (o = &options[0]; o->name; o++) {
1167 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1170 ptr = td_var(data, o->off1);