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 static int str_match_len(const struct value_pair *vp, const char *str)
349 return max(strlen(vp->ival), opt_len(str));
352 #define val_store(ptr, val, off, or, data) \
354 ptr = td_var((data), (off)); \
361 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
362 int first, int more, int curr)
366 long long ull, *ullp;
370 int ret = 0, is_time = 0;
371 const struct value_pair *vp;
372 struct value_pair posval[PARSE_MAX_VP];
373 int i, all_skipped = 1;
375 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
378 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
379 log_err("Option %s requires an argument\n", o->name);
385 case FIO_OPT_STR_MULTI: {
386 fio_opt_str_fn *fn = o->cb;
388 posval_sort(o, posval);
391 for (i = 0; i < PARSE_MAX_VP; i++) {
393 if (!vp->ival || vp->ival[0] == '\0')
396 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
400 *(unsigned int *) o->roff1 |= vp->oval;
402 *(unsigned int *) o->roff1 = vp->oval;
406 val_store(ilp, vp->oval, o->off1, vp->or, data);
412 if (ret && !all_skipped)
413 show_option_values(o);
418 case FIO_OPT_STR_VAL_TIME:
421 case FIO_OPT_STR_VAL: {
422 fio_opt_str_val_fn *fn = o->cb;
425 strncpy(tmp, ptr, sizeof(tmp) - 1);
426 p = strchr(tmp, ',');
431 ret = check_str_time(tmp, &ull);
433 ret = check_str_bytes(tmp, &ull, data);
438 if (o->maxval && ull > o->maxval) {
439 log_err("max value out of range: %llu"
440 " (%u max)\n", ull, o->maxval);
443 if (o->minval && ull < o->minval) {
444 log_err("min value out of range: %llu"
445 " (%u min)\n", ull, o->minval);
450 ret = fn(data, &ull);
452 if (o->type == FIO_OPT_INT) {
455 *(unsigned int *) o->roff1 = ull;
457 val_store(ilp, ull, o->off1, 0, data);
461 *(unsigned int *) o->roff2 = ull;
463 val_store(ilp, ull, o->off2, 0, data);
467 *(unsigned int *) o->roff3 = ull;
469 val_store(ilp, ull, o->off3, 0, data);
474 *(unsigned int *) o->roff2 = ull;
476 val_store(ilp, ull, o->off2, 0, data);
480 *(unsigned int *) o->roff3 = ull;
482 val_store(ilp, ull, o->off3, 0, data);
488 *(unsigned long long *) o->roff1 = ull;
490 val_store(ullp, ull, o->off1, 0, data);
494 *(unsigned long long *) o->roff2 = ull;
496 val_store(ullp, ull, o->off2, 0, data);
502 case FIO_OPT_FLOAT_LIST: {
506 ilp = td_var(data, o->off2);
509 if (curr >= o->maxlen) {
510 log_err("the list exceeding max length %d\n",
514 if (!str_to_float(ptr, &uf)){
515 log_err("not a floating point value: %s\n", ptr);
518 if (!isnan(o->maxfp) && uf > o->maxfp) {
519 log_err("value out of range: %f"
520 " (range max: %f)\n", uf, o->maxfp);
523 if (!isnan(o->minfp) && uf < o->minfp) {
524 log_err("value out of range: %f"
525 " (range min: %f)\n", uf, o->minfp);
529 flp = td_var(data, o->off1);
534 case FIO_OPT_STR_STORE: {
535 fio_opt_str_fn *fn = o->cb;
537 if (o->roff1 || o->off1) {
539 cp = (char **) o->roff1;
541 cp = td_var(data, o->off1);
548 else if (o->posval[0].ival) {
549 posval_sort(o, posval);
552 for (i = 0; i < PARSE_MAX_VP; i++) {
554 if (!vp->ival || vp->ival[0] == '\0')
557 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
563 rest = strstr(*cp ?: ptr, ":");
577 show_option_values(o);
586 case FIO_OPT_RANGE: {
590 strncpy(tmp, ptr, sizeof(tmp) - 1);
592 /* Handle bsrange with separate read,write values: */
593 p1 = strchr(tmp, ',');
597 p1 = strchr(tmp, '-');
599 p1 = strchr(tmp, ':');
611 if (!check_range_bytes(p1, &ul1, data) &&
612 !check_range_bytes(p2, &ul2, data)) {
615 unsigned long foo = ul1;
623 *(unsigned int *) o->roff1 = ul1;
625 val_store(ilp, ul1, o->off1, 0, data);
627 *(unsigned int *) o->roff2 = ul2;
629 val_store(ilp, ul2, o->off2, 0, data);
632 if (o->roff3 && o->roff4) {
633 *(unsigned int *) o->roff3 = ul1;
634 *(unsigned int *) o->roff4 = ul2;
635 } else if (o->off3 && o->off4) {
636 val_store(ilp, ul1, o->off3, 0, data);
637 val_store(ilp, ul2, o->off4, 0, data);
641 if (o->roff5 && o->roff6) {
642 *(unsigned int *) o->roff5 = ul1;
643 *(unsigned int *) o->roff6 = ul2;
644 } else if (o->off5 && o->off6) {
645 val_store(ilp, ul1, o->off5, 0, data);
646 val_store(ilp, ul2, o->off6, 0, data);
651 if (o->roff3 && o->roff4) {
652 *(unsigned int *) o->roff3 = ul1;
653 *(unsigned int *) o->roff4 = ul2;
654 } else if (o->off3 && o->off4) {
655 val_store(ilp, ul1, o->off3, 0, data);
656 val_store(ilp, ul2, o->off4, 0, data);
660 if (o->roff5 && o->roff6) {
661 *(unsigned int *) o->roff5 = ul1;
662 *(unsigned int *) o->roff6 = ul2;
663 } else if (o->off5 && o->off6) {
664 val_store(ilp, ul1, o->off5, 0, data);
665 val_store(ilp, ul2, o->off6, 0, data);
674 case FIO_OPT_STR_SET: {
675 fio_opt_int_fn *fn = o->cb;
678 ret = check_int(ptr, &il);
679 else if (o->type == FIO_OPT_BOOL)
687 if (o->maxval && il > (int) o->maxval) {
688 log_err("max value out of range: %d (%d max)\n",
692 if (o->minval && il < o->minval) {
693 log_err("min value out of range: %d (%d min)\n",
706 *(unsigned int *)o->roff1 = il;
708 val_store(ilp, il, o->off1, 0, data);
712 *(unsigned int *) o->roff2 = il;
714 val_store(ilp, il, o->off2, 0, data);
719 case FIO_OPT_DEPRECATED:
720 log_info("Option %s is deprecated\n", o->name);
723 log_err("Bad option type %u\n", o->type);
731 ret = o->verify(o, data);
733 log_err("Correct format for offending option\n");
734 log_err("%20s: %s\n", o->name, o->help);
735 show_option_help(o, 1);
742 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
744 char *o_ptr, *ptr, *ptr2;
747 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
751 o_ptr = ptr = strdup(__ptr);
754 * See if we have another set of parameters, hidden after a comma.
755 * Do this before parsing this round, to check if we should
756 * copy set 1 options to set 2.
765 (o->type != FIO_OPT_STR_STORE) &&
766 (o->type != FIO_OPT_STR) &&
767 (o->type != FIO_OPT_FLOAT_LIST)) {
768 ptr2 = strchr(ptr, ',');
769 if (ptr2 && *(ptr2 + 1) == '\0')
771 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
773 ptr2 = strchr(ptr, ':');
775 ptr2 = strchr(ptr, '-');
777 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
778 ptr2 = strchr(ptr, ':');
782 * Don't return early if parsing the first option fails - if
783 * we are doing multiple arguments, we can allow the first one
786 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
802 static struct fio_option *get_option(char *opt,
803 struct fio_option *options, char **post)
805 struct fio_option *o;
808 ret = strchr(opt, '=');
814 strip_blank_end(ret);
815 o = find_option(options, ret);
817 o = find_option(options, opt);
824 static int opt_cmp(const void *p1, const void *p2)
826 struct fio_option *o;
833 s = strdup(*((char **) p1));
834 o = get_option(s, fio_options, &foo);
840 s = strdup(*((char **) p2));
841 o = get_option(s, fio_options, &foo);
847 return prio2 - prio1;
850 void sort_options(char **opts, struct fio_option *options, int num_opts)
852 fio_options = options;
853 qsort(opts, num_opts, sizeof(char *), opt_cmp);
857 int parse_cmd_option(const char *opt, const char *val,
858 struct fio_option *options, void *data)
860 struct fio_option *o;
862 o = find_option(options, opt);
864 log_err("Bad option <%s>\n", opt);
868 if (!handle_option(o, val, data))
871 log_err("fio: failed parsing %s=%s\n", opt, val);
875 int parse_option(char *opt, const char *input,
876 struct fio_option *options, struct fio_option **o, void *data)
881 log_err("fio: failed parsing %s\n", input);
886 *o = get_option(opt, options, &post);
889 int len = strlen(opt);
890 if (opt + len + 1 != post)
891 memmove(opt + len + 1, post, strlen(post));
897 if (!handle_option(*o, post, data)) {
901 log_err("fio: failed parsing %s\n", input);
906 * Option match, levenshtein distance. Handy for not quite remembering what
907 * the option name is.
909 static int string_distance(const char *s1, const char *s2)
911 unsigned int s1_len = strlen(s1);
912 unsigned int s2_len = strlen(s2);
913 unsigned int *p, *q, *r;
916 p = malloc(sizeof(unsigned int) * (s2_len + 1));
917 q = malloc(sizeof(unsigned int) * (s2_len + 1));
920 for (i = 1; i <= s2_len; i++)
923 for (i = 1; i <= s1_len; i++) {
925 for (j = 1; j <= s2_len; j++) {
926 unsigned int sub = p[j - 1];
928 if (s1[i - 1] != s2[j - 1])
931 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
944 static struct fio_option *find_child(struct fio_option *options,
945 struct fio_option *o)
947 struct fio_option *__o;
949 for (__o = options + 1; __o->name; __o++)
950 if (__o->parent && !strcmp(__o->parent, o->name))
956 static void __print_option(struct fio_option *o, struct fio_option *org,
970 p += sprintf(p, "%s", " ");
972 sprintf(p, "%s", o->name);
974 log_info("%-24s: %s\n", name, o->help);
977 static void print_option(struct fio_option *o)
979 struct fio_option *parent;
980 struct fio_option *__o;
981 unsigned int printed;
984 __print_option(o, NULL, 0);
991 while ((__o = find_child(o, parent)) != NULL) {
992 __print_option(__o, o, level);
1001 int show_cmd_help(struct fio_option *options, const char *name)
1003 struct fio_option *o, *closest;
1004 unsigned int best_dist = -1U;
1008 if (!name || !strcmp(name, "all"))
1013 for (o = &options[0]; o->name; o++) {
1016 if (o->type == FIO_OPT_DEPRECATED)
1018 if (!exec_profile && o->prof_name)
1022 if (!strcmp(name, o->name) ||
1023 (o->alias && !strcmp(name, o->alias)))
1028 dist = string_distance(name, o->name);
1029 if (dist < best_dist) {
1036 if (show_all || match) {
1039 log_info("%20s: %s\n", o->name, o->help);
1050 show_option_help(o, 0);
1056 log_err("No such command: %s", name);
1059 * Only print an appropriately close option, one where the edit
1060 * distance isn't too big. Otherwise we get crazy matches.
1062 if (closest && best_dist < 3) {
1063 log_info(" - showing closest match\n");
1064 log_info("%20s: %s\n", closest->name, closest->help);
1065 show_option_help(closest, 0);
1073 * Handle parsing of default parameters.
1075 void fill_default_options(void *data, struct fio_option *options)
1077 struct fio_option *o;
1079 dprint(FD_PARSE, "filling default options\n");
1081 for (o = &options[0]; o->name; o++)
1083 handle_option(o, o->def, data);
1086 void option_init(struct fio_option *o)
1088 if (o->type == FIO_OPT_DEPRECATED)
1090 if (o->type == FIO_OPT_BOOL) {
1094 if (o->type == FIO_OPT_INT) {
1096 o->maxval = UINT_MAX;
1098 if (o->type == FIO_OPT_FLOAT_LIST) {
1102 if (o->type == FIO_OPT_STR_SET && o->def) {
1103 log_err("Option %s: string set option with"
1104 " default will always be true\n", o->name);
1106 if (!o->cb && (!o->off1 && !o->roff1))
1107 log_err("Option %s: neither cb nor offset given\n", o->name);
1108 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1109 o->type == FIO_OPT_STR_MULTI)
1111 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1112 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1113 log_err("Option %s: both cb and offset given\n", o->name);
1118 * Sanitize the options structure. For now it just sets min/max for bool
1119 * values and whether both callback and offsets are given.
1121 void options_init(struct fio_option *options)
1123 struct fio_option *o;
1125 dprint(FD_PARSE, "init options\n");
1127 for (o = &options[0]; o->name; o++)
1131 void options_free(struct fio_option *options, void *data)
1133 struct fio_option *o;
1136 dprint(FD_PARSE, "free options\n");
1138 for (o = &options[0]; o->name; o++) {
1139 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1142 ptr = td_var(data, o->off1);