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;
373 int ret = 0, is_time = 0;
374 const struct value_pair *vp;
375 struct value_pair posval[PARSE_MAX_VP];
376 int i, len, all_skipped = 1;
378 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
381 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
382 log_err("Option %s requires an argument\n", o->name);
388 case FIO_OPT_STR_MULTI: {
389 fio_opt_str_fn *fn = o->cb;
391 posval_sort(o, posval);
394 for (i = 0; i < PARSE_MAX_VP; i++) {
396 if (!vp->ival || vp->ival[0] == '\0')
399 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
403 *(unsigned int *) o->roff1 |= vp->oval;
405 *(unsigned int *) o->roff1 = vp->oval;
409 val_store(ilp, vp->oval, o->off1, vp->or, data);
415 if (ret && !all_skipped)
416 show_option_values(o);
421 case FIO_OPT_STR_VAL_TIME:
424 case FIO_OPT_STR_VAL: {
425 fio_opt_str_val_fn *fn = o->cb;
428 strncpy(tmp, ptr, sizeof(tmp) - 1);
429 p = strchr(tmp, ',');
434 ret = check_str_time(tmp, &ull);
436 ret = check_str_bytes(tmp, &ull, data);
441 if (o->maxval && ull > o->maxval) {
442 log_err("max value out of range: %llu"
443 " (%u max)\n", ull, o->maxval);
446 if (o->minval && ull < o->minval) {
447 log_err("min value out of range: %llu"
448 " (%u min)\n", ull, o->minval);
453 ret = fn(data, &ull);
455 if (o->type == FIO_OPT_INT) {
458 *(unsigned int *) o->roff1 = ull;
460 val_store(ilp, ull, o->off1, 0, data);
464 *(unsigned int *) o->roff2 = ull;
466 val_store(ilp, ull, o->off2, 0, data);
470 *(unsigned int *) o->roff3 = ull;
472 val_store(ilp, ull, o->off3, 0, data);
477 *(unsigned int *) o->roff2 = ull;
479 val_store(ilp, ull, o->off2, 0, data);
483 *(unsigned int *) o->roff3 = ull;
485 val_store(ilp, ull, o->off3, 0, data);
491 *(unsigned long long *) o->roff1 = ull;
493 val_store(ullp, ull, o->off1, 0, data);
497 *(unsigned long long *) o->roff2 = ull;
499 val_store(ullp, ull, o->off2, 0, data);
505 case FIO_OPT_FLOAT_LIST: {
508 ** Initialize precision to 0 and zero out list
509 ** in case specified list is shorter than default
512 ilp = td_var(data, o->off2);
515 flp = td_var(data, o->off1);
516 for(i = 0; i < o->maxlen; i++)
519 if (curr >= o->maxlen) {
520 log_err("the list exceeding max length %d\n",
524 if (!str_to_float(ptr, &uf)) {
525 log_err("not a floating point value: %s\n", ptr);
529 log_err("value out of range: %f"
530 " (range max: %f)\n", uf, o->maxfp);
534 log_err("value out of range: %f"
535 " (range min: %f)\n", uf, o->minfp);
539 flp = td_var(data, o->off1);
543 ** Calculate precision for output by counting
544 ** number of digits after period. Find first
545 ** period in entire remaining list each time
547 cp2 = strchr(ptr, '.');
551 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
554 ilp = td_var(data, o->off2);
561 case FIO_OPT_STR_STORE: {
562 fio_opt_str_fn *fn = o->cb;
564 if (o->roff1 || o->off1) {
566 cp = (char **) o->roff1;
568 cp = td_var(data, o->off1);
575 else if (o->posval[0].ival) {
576 posval_sort(o, posval);
579 for (i = 0; i < PARSE_MAX_VP; i++) {
581 if (!vp->ival || vp->ival[0] == '\0')
584 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
590 rest = strstr(*cp ?: ptr, ":");
604 show_option_values(o);
613 case FIO_OPT_RANGE: {
617 strncpy(tmp, ptr, sizeof(tmp) - 1);
619 /* Handle bsrange with separate read,write values: */
620 p1 = strchr(tmp, ',');
624 p1 = strchr(tmp, '-');
626 p1 = strchr(tmp, ':');
638 if (!check_range_bytes(p1, &ul1, data) &&
639 !check_range_bytes(p2, &ul2, data)) {
642 unsigned long foo = ul1;
650 *(unsigned int *) o->roff1 = ul1;
652 val_store(ilp, ul1, o->off1, 0, data);
654 *(unsigned int *) o->roff2 = ul2;
656 val_store(ilp, ul2, o->off2, 0, data);
659 if (o->roff3 && o->roff4) {
660 *(unsigned int *) o->roff3 = ul1;
661 *(unsigned int *) o->roff4 = ul2;
662 } else if (o->off3 && o->off4) {
663 val_store(ilp, ul1, o->off3, 0, data);
664 val_store(ilp, ul2, o->off4, 0, data);
668 if (o->roff5 && o->roff6) {
669 *(unsigned int *) o->roff5 = ul1;
670 *(unsigned int *) o->roff6 = ul2;
671 } else if (o->off5 && o->off6) {
672 val_store(ilp, ul1, o->off5, 0, data);
673 val_store(ilp, ul2, o->off6, 0, data);
678 if (o->roff3 && o->roff4) {
679 *(unsigned int *) o->roff3 = ul1;
680 *(unsigned int *) o->roff4 = ul2;
681 } else if (o->off3 && o->off4) {
682 val_store(ilp, ul1, o->off3, 0, data);
683 val_store(ilp, ul2, o->off4, 0, data);
687 if (o->roff5 && o->roff6) {
688 *(unsigned int *) o->roff5 = ul1;
689 *(unsigned int *) o->roff6 = ul2;
690 } else if (o->off5 && o->off6) {
691 val_store(ilp, ul1, o->off5, 0, data);
692 val_store(ilp, ul2, o->off6, 0, data);
701 case FIO_OPT_STR_SET: {
702 fio_opt_int_fn *fn = o->cb;
705 ret = check_int(ptr, &il);
706 else if (o->type == FIO_OPT_BOOL)
714 if (o->maxval && il > (int) o->maxval) {
715 log_err("max value out of range: %d (%d max)\n",
719 if (o->minval && il < o->minval) {
720 log_err("min value out of range: %d (%d min)\n",
733 *(unsigned int *)o->roff1 = il;
735 val_store(ilp, il, o->off1, 0, data);
739 *(unsigned int *) o->roff2 = il;
741 val_store(ilp, il, o->off2, 0, data);
746 case FIO_OPT_DEPRECATED:
747 log_info("Option %s is deprecated\n", o->name);
750 log_err("Bad option type %u\n", o->type);
758 ret = o->verify(o, data);
760 log_err("Correct format for offending option\n");
761 log_err("%20s: %s\n", o->name, o->help);
762 show_option_help(o, 1);
769 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
771 char *o_ptr, *ptr, *ptr2;
774 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
778 o_ptr = ptr = strdup(__ptr);
781 * See if we have another set of parameters, hidden after a comma.
782 * Do this before parsing this round, to check if we should
783 * copy set 1 options to set 2.
792 (o->type != FIO_OPT_STR_STORE) &&
793 (o->type != FIO_OPT_STR) &&
794 (o->type != FIO_OPT_FLOAT_LIST)) {
795 ptr2 = strchr(ptr, ',');
796 if (ptr2 && *(ptr2 + 1) == '\0')
798 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
800 ptr2 = strchr(ptr, ':');
802 ptr2 = strchr(ptr, '-');
804 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
805 ptr2 = strchr(ptr, ':');
809 * Don't return early if parsing the first option fails - if
810 * we are doing multiple arguments, we can allow the first one
813 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
829 static struct fio_option *get_option(char *opt,
830 struct fio_option *options, char **post)
832 struct fio_option *o;
835 ret = strchr(opt, '=');
841 strip_blank_end(ret);
842 o = find_option(options, ret);
844 o = find_option(options, opt);
851 static int opt_cmp(const void *p1, const void *p2)
853 struct fio_option *o;
860 s = strdup(*((char **) p1));
861 o = get_option(s, fio_options, &foo);
867 s = strdup(*((char **) p2));
868 o = get_option(s, fio_options, &foo);
874 return prio2 - prio1;
877 void sort_options(char **opts, struct fio_option *options, int num_opts)
879 fio_options = options;
880 qsort(opts, num_opts, sizeof(char *), opt_cmp);
884 int parse_cmd_option(const char *opt, const char *val,
885 struct fio_option *options, void *data)
887 struct fio_option *o;
889 o = find_option(options, opt);
891 log_err("Bad option <%s>\n", opt);
895 if (!handle_option(o, val, data))
898 log_err("fio: failed parsing %s=%s\n", opt, val);
902 int parse_option(char *opt, const char *input,
903 struct fio_option *options, struct fio_option **o, void *data)
908 log_err("fio: failed parsing %s\n", input);
913 *o = get_option(opt, options, &post);
916 int len = strlen(opt);
917 if (opt + len + 1 != post)
918 memmove(opt + len + 1, post, strlen(post));
924 if (!handle_option(*o, post, data)) {
928 log_err("fio: failed parsing %s\n", input);
933 * Option match, levenshtein distance. Handy for not quite remembering what
934 * the option name is.
936 static int string_distance(const char *s1, const char *s2)
938 unsigned int s1_len = strlen(s1);
939 unsigned int s2_len = strlen(s2);
940 unsigned int *p, *q, *r;
943 p = malloc(sizeof(unsigned int) * (s2_len + 1));
944 q = malloc(sizeof(unsigned int) * (s2_len + 1));
947 for (i = 1; i <= s2_len; i++)
950 for (i = 1; i <= s1_len; i++) {
952 for (j = 1; j <= s2_len; j++) {
953 unsigned int sub = p[j - 1];
955 if (s1[i - 1] != s2[j - 1])
958 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
971 static struct fio_option *find_child(struct fio_option *options,
972 struct fio_option *o)
974 struct fio_option *__o;
976 for (__o = options + 1; __o->name; __o++)
977 if (__o->parent && !strcmp(__o->parent, o->name))
983 static void __print_option(struct fio_option *o, struct fio_option *org,
997 p += sprintf(p, "%s", " ");
999 sprintf(p, "%s", o->name);
1001 log_info("%-24s: %s\n", name, o->help);
1004 static void print_option(struct fio_option *o)
1006 struct fio_option *parent;
1007 struct fio_option *__o;
1008 unsigned int printed;
1011 __print_option(o, NULL, 0);
1018 while ((__o = find_child(o, parent)) != NULL) {
1019 __print_option(__o, o, level);
1028 int show_cmd_help(struct fio_option *options, const char *name)
1030 struct fio_option *o, *closest;
1031 unsigned int best_dist = -1U;
1035 if (!name || !strcmp(name, "all"))
1040 for (o = &options[0]; o->name; o++) {
1043 if (o->type == FIO_OPT_DEPRECATED)
1045 if (!exec_profile && o->prof_name)
1049 if (!strcmp(name, o->name) ||
1050 (o->alias && !strcmp(name, o->alias)))
1055 dist = string_distance(name, o->name);
1056 if (dist < best_dist) {
1063 if (show_all || match) {
1066 log_info("%20s: %s\n", o->name, o->help);
1077 show_option_help(o, 0);
1083 log_err("No such command: %s", name);
1086 * Only print an appropriately close option, one where the edit
1087 * distance isn't too big. Otherwise we get crazy matches.
1089 if (closest && best_dist < 3) {
1090 log_info(" - showing closest match\n");
1091 log_info("%20s: %s\n", closest->name, closest->help);
1092 show_option_help(closest, 0);
1100 * Handle parsing of default parameters.
1102 void fill_default_options(void *data, struct fio_option *options)
1104 struct fio_option *o;
1106 dprint(FD_PARSE, "filling default options\n");
1108 for (o = &options[0]; o->name; o++)
1110 handle_option(o, o->def, data);
1113 void option_init(struct fio_option *o)
1115 if (o->type == FIO_OPT_DEPRECATED)
1117 if (o->type == FIO_OPT_BOOL) {
1121 if (o->type == FIO_OPT_INT) {
1123 o->maxval = UINT_MAX;
1125 if (o->type == FIO_OPT_FLOAT_LIST) {
1129 if (o->type == FIO_OPT_STR_SET && o->def) {
1130 log_err("Option %s: string set option with"
1131 " default will always be true\n", o->name);
1133 if (!o->cb && (!o->off1 && !o->roff1))
1134 log_err("Option %s: neither cb nor offset given\n", o->name);
1135 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1136 o->type == FIO_OPT_STR_MULTI)
1138 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1139 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1140 log_err("Option %s: both cb and offset given\n", o->name);
1145 * Sanitize the options structure. For now it just sets min/max for bool
1146 * values and whether both callback and offsets are given.
1148 void options_init(struct fio_option *options)
1150 struct fio_option *o;
1152 dprint(FD_PARSE, "init options\n");
1154 for (o = &options[0]; o->name; o++)
1158 void options_free(struct fio_option *options, void *data)
1160 struct fio_option *o;
1163 dprint(FD_PARSE, "free options\n");
1165 for (o = &options[0]; o->name; o++) {
1166 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1169 ptr = td_var(data, o->off1);