2 * This file contains the ini and command liner parser main.
19 #include "lib/ieee754.h"
21 static struct fio_option *__fio_options;
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 (o->minfp == DBL_MIN && o->maxfp == DBL_MAX)
56 logger("%20s: min=%f", "range", o->minfp);
57 if (o->maxfp != DBL_MAX)
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 (!strncmp("pib", c, 3)) {
161 } else if (!strncmp("tib", c, 3)) {
164 } else if (!strncmp("gib", c, 3)) {
167 } else if (!strncmp("mib", c, 3)) {
170 } else if (!strncmp("kib", c, 3)) {
173 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
175 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
177 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
179 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
181 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
183 else if (!strncmp("%", c, 1)) {
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 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: {
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);
881 __fio_options = NULL;
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))
927 log_err("fio: failed parsing %s\n", input);
932 * Option match, levenshtein distance. Handy for not quite remembering what
933 * the option name is.
935 static int string_distance(const char *s1, const char *s2)
937 unsigned int s1_len = strlen(s1);
938 unsigned int s2_len = strlen(s2);
939 unsigned int *p, *q, *r;
942 p = malloc(sizeof(unsigned int) * (s2_len + 1));
943 q = malloc(sizeof(unsigned int) * (s2_len + 1));
946 for (i = 1; i <= s2_len; i++)
949 for (i = 1; i <= s1_len; i++) {
951 for (j = 1; j <= s2_len; j++) {
952 unsigned int sub = p[j - 1];
954 if (s1[i - 1] != s2[j - 1])
957 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
970 static struct fio_option *find_child(struct fio_option *options,
971 struct fio_option *o)
973 struct fio_option *__o;
975 for (__o = options + 1; __o->name; __o++)
976 if (__o->parent && !strcmp(__o->parent, o->name))
982 static void __print_option(struct fio_option *o, struct fio_option *org,
996 p += sprintf(p, "%s", " ");
998 sprintf(p, "%s", o->name);
1000 log_info("%-24s: %s\n", name, o->help);
1003 static void print_option(struct fio_option *o)
1005 struct fio_option *parent;
1006 struct fio_option *__o;
1007 unsigned int printed;
1010 __print_option(o, NULL, 0);
1017 while ((__o = find_child(o, parent)) != NULL) {
1018 __print_option(__o, o, level);
1027 int show_cmd_help(struct fio_option *options, const char *name)
1029 struct fio_option *o, *closest;
1030 unsigned int best_dist = -1U;
1034 if (!name || !strcmp(name, "all"))
1039 for (o = &options[0]; o->name; o++) {
1042 if (o->type == FIO_OPT_DEPRECATED)
1044 if (!exec_profile && o->prof_name)
1048 if (!strcmp(name, o->name) ||
1049 (o->alias && !strcmp(name, o->alias)))
1054 dist = string_distance(name, o->name);
1055 if (dist < best_dist) {
1062 if (show_all || match) {
1065 log_info("%20s: %s\n", o->name, o->help);
1076 show_option_help(o, 0);
1082 log_err("No such command: %s", name);
1085 * Only print an appropriately close option, one where the edit
1086 * distance isn't too big. Otherwise we get crazy matches.
1088 if (closest && best_dist < 3) {
1089 log_info(" - showing closest match\n");
1090 log_info("%20s: %s\n", closest->name, closest->help);
1091 show_option_help(closest, 0);
1099 * Handle parsing of default parameters.
1101 void fill_default_options(void *data, struct fio_option *options)
1103 struct fio_option *o;
1105 dprint(FD_PARSE, "filling default options\n");
1107 for (o = &options[0]; o->name; o++)
1109 handle_option(o, o->def, data);
1112 void option_init(struct fio_option *o)
1114 if (o->type == FIO_OPT_DEPRECATED)
1116 if (o->type == FIO_OPT_BOOL) {
1120 if (o->type == FIO_OPT_INT) {
1122 o->maxval = UINT_MAX;
1124 if (o->type == FIO_OPT_FLOAT_LIST) {
1128 if (o->type == FIO_OPT_STR_SET && o->def) {
1129 log_err("Option %s: string set option with"
1130 " default will always be true\n", o->name);
1132 if (!o->cb && (!o->off1 && !o->roff1))
1133 log_err("Option %s: neither cb nor offset given\n", o->name);
1134 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1135 o->type == FIO_OPT_STR_MULTI)
1137 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1138 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1139 log_err("Option %s: both cb and offset given\n", o->name);
1142 log_info("Options %s: no category defined. Setting to misc\n", o->name);
1143 o->category = FIO_OPT_C_GENERAL;
1148 * Sanitize the options structure. For now it just sets min/max for bool
1149 * values and whether both callback and offsets are given.
1151 void options_init(struct fio_option *options)
1153 struct fio_option *o;
1155 dprint(FD_PARSE, "init options\n");
1157 for (o = &options[0]; o->name; o++) {
1160 o->inv_opt = find_option(options, o->inverse);
1164 void options_free(struct fio_option *options, void *data)
1166 struct fio_option *o;
1169 dprint(FD_PARSE, "free options\n");
1171 for (o = &options[0]; o->name; o++) {
1172 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1175 ptr = td_var(data, o->off1);