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);
60 } else if (!o->posval[0].ival) {
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 int is_separator(char c)
155 static unsigned long long __get_mult_bytes(const char *p, void *data,
158 unsigned int kb_base = fio_get_kb_base(data);
159 unsigned long long ret = 1;
160 unsigned int i, pow = 0, mult = kb_base;
168 for (i = 0; i < strlen(c); i++) {
169 c[i] = tolower(c[i]);
170 if (is_separator(c[i])) {
176 if (!strncmp("pib", c, 3)) {
179 } else if (!strncmp("tib", c, 3)) {
182 } else if (!strncmp("gib", c, 3)) {
185 } else if (!strncmp("mib", c, 3)) {
188 } else if (!strncmp("kib", c, 3)) {
191 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
193 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
195 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
197 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
199 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
201 else if (!strncmp("%", c, 1)) {
208 ret *= (unsigned long long) mult;
214 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
221 return __get_mult_bytes(str, data, percent);
224 * Go forward until we hit a non-digit, or +/- sign
226 while ((p - str) <= len) {
227 if (!isdigit((int) *p) &&
228 (((*p != '+') && (*p != '-')) || digit_seen))
230 digit_seen |= isdigit((int) *p);
234 if (!isalpha((int) *p) && (*p != '%'))
237 return __get_mult_bytes(p, data, percent);
241 * Convert string into a floating number. Return 1 for success and 0 otherwise.
243 int str_to_float(const char *str, double *val)
245 return (1 == sscanf(str, "%lf", val));
249 * convert string into decimal value, noting any size suffix
251 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
259 if (strstr(str, "0x") || strstr(str, "0X"))
264 *val = strtoll(str, NULL, base);
265 if (*val == LONG_MAX && errno == ERANGE)
269 unsigned long long mult;
272 mult = get_mult_bytes(str, len, data, &perc);
278 *val *= get_mult_time(str[len - 1]);
283 int check_str_bytes(const char *p, long long *val, void *data)
285 return str_to_decimal(p, val, 1, data);
288 int check_str_time(const char *p, long long *val)
290 return str_to_decimal(p, val, 0, NULL);
293 void strip_blank_front(char **p)
299 while (isspace((int) *s))
305 void strip_blank_end(char *p)
322 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
328 static int check_range_bytes(const char *str, long *val, void *data)
332 if (!str_to_decimal(str, &__val, 1, data)) {
340 static int check_int(const char *p, int *val)
344 if (strstr(p, "0x") || strstr(p, "0X")) {
345 if (sscanf(p, "%x", val) == 1)
348 if (sscanf(p, "%u", val) == 1)
355 static int opt_len(const char *str)
359 postfix = strchr(str, ':');
363 return (int)(postfix - str);
366 static int str_match_len(const struct value_pair *vp, const char *str)
368 return max(strlen(vp->ival), opt_len(str));
371 #define val_store(ptr, val, off, or, data, o) \
373 ptr = td_var((data), (o), (off)); \
380 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
381 int first, int more, int curr)
385 long long ull, *ullp;
389 int ret = 0, is_time = 0;
390 const struct value_pair *vp;
391 struct value_pair posval[PARSE_MAX_VP];
392 int i, all_skipped = 1;
394 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
397 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
398 log_err("Option %s requires an argument\n", o->name);
404 case FIO_OPT_STR_MULTI: {
405 fio_opt_str_fn *fn = o->cb;
407 posval_sort(o, posval);
410 for (i = 0; i < PARSE_MAX_VP; i++) {
412 if (!vp->ival || vp->ival[0] == '\0')
415 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
418 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
423 if (ret && !all_skipped)
424 show_option_values(o);
429 case FIO_OPT_STR_VAL_TIME:
432 case FIO_OPT_STR_VAL: {
433 fio_opt_str_val_fn *fn = o->cb;
436 strncpy(tmp, ptr, sizeof(tmp) - 1);
437 p = strchr(tmp, ',');
442 ret = check_str_time(tmp, &ull);
444 ret = check_str_bytes(tmp, &ull, data);
446 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
451 if (o->maxval && ull > o->maxval) {
452 log_err("max value out of range: %llu"
453 " (%u max)\n", ull, o->maxval);
456 if (o->minval && ull < o->minval) {
457 log_err("min value out of range: %llu"
458 " (%u min)\n", ull, o->minval);
461 if (o->posval[0].ival) {
462 posval_sort(o, posval);
465 for (i = 0; i < PARSE_MAX_VP; i++) {
467 if (!vp->ival || vp->ival[0] == '\0')
469 if (vp->oval == ull) {
475 log_err("fio: value %llu not allowed:\n", ull);
476 show_option_values(o);
482 ret = fn(data, &ull);
484 if (o->type == FIO_OPT_INT) {
486 val_store(ilp, ull, o->off1, 0, data, o);
489 val_store(ilp, ull, o->off2, 0, data, o);
493 val_store(ilp, ull, o->off3, 0, data, o);
498 val_store(ilp, ull, o->off2, 0, data, o);
502 val_store(ilp, ull, o->off3, 0, data, o);
507 val_store(ullp, ull, o->off1, 0, data, o);
510 val_store(ullp, ull, o->off2, 0, data, o);
516 case FIO_OPT_FLOAT_LIST: {
521 ** Initialize precision to 0 and zero out list
522 ** in case specified list is shorter than default
526 ilp = td_var(data, o, o->off2);
530 flp = td_var(data, o, o->off1);
531 for(i = 0; i < o->maxlen; i++)
534 if (curr >= o->maxlen) {
535 log_err("the list exceeding max length %d\n",
539 if (!str_to_float(ptr, &uf)) {
540 log_err("not a floating point value: %s\n", ptr);
544 log_err("value out of range: %f"
545 " (range max: %f)\n", uf, o->maxfp);
549 log_err("value out of range: %f"
550 " (range min: %f)\n", uf, o->minfp);
554 flp = td_var(data, o, o->off1);
557 dprint(FD_PARSE, " out=%f\n", uf);
560 ** Calculate precision for output by counting
561 ** number of digits after period. Find first
562 ** period in entire remaining list each time
564 cp2 = strchr(ptr, '.');
568 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
572 ilp = td_var(data, o, o->off2);
580 case FIO_OPT_STR_STORE: {
581 fio_opt_str_fn *fn = o->cb;
584 cp = td_var(data, o, o->off1);
590 else if (o->posval[0].ival) {
591 posval_sort(o, posval);
594 for (i = 0; i < PARSE_MAX_VP; i++) {
596 if (!vp->ival || vp->ival[0] == '\0')
599 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
605 rest = strstr(*cp ?: ptr, ":");
619 show_option_values(o);
628 case FIO_OPT_RANGE: {
632 strncpy(tmp, ptr, sizeof(tmp) - 1);
634 /* Handle bsrange with separate read,write values: */
635 p1 = strchr(tmp, ',');
639 p1 = strchr(tmp, '-');
641 p1 = strchr(tmp, ':');
653 if (!check_range_bytes(p1, &ul1, data) &&
654 !check_range_bytes(p2, &ul2, data)) {
657 unsigned long foo = ul1;
664 val_store(ilp, ul1, o->off1, 0, data, o);
665 val_store(ilp, ul2, o->off2, 0, data, o);
668 if (o->off3 && o->off4) {
669 val_store(ilp, ul1, o->off3, 0, data, o);
670 val_store(ilp, ul2, o->off4, 0, data, o);
674 if (o->off5 && o->off6) {
675 val_store(ilp, ul1, o->off5, 0, data, o);
676 val_store(ilp, ul2, o->off6, 0, data, o);
681 if (o->off3 && o->off4) {
682 val_store(ilp, ul1, o->off3, 0, data, o);
683 val_store(ilp, ul2, o->off4, 0, data, o);
687 if (o->off5 && o->off6) {
688 val_store(ilp, ul1, o->off5, 0, data, o);
689 val_store(ilp, ul2, o->off6, 0, data, o);
698 case FIO_OPT_STR_SET: {
699 fio_opt_int_fn *fn = o->cb;
702 ret = check_int(ptr, &il);
703 else if (o->type == FIO_OPT_BOOL)
708 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
713 if (o->maxval && il > (int) o->maxval) {
714 log_err("max value out of range: %d (%d max)\n",
718 if (o->minval && il < o->minval) {
719 log_err("min value out of range: %d (%d min)\n",
731 val_store(ilp, il, o->off1, 0, data, o);
734 val_store(ilp, il, o->off2, 0, data, o);
739 case FIO_OPT_DEPRECATED:
740 log_info("Option %s is deprecated\n", o->name);
744 log_err("Bad option type %u\n", o->type);
752 ret = o->verify(o, data);
754 log_err("Correct format for offending option\n");
755 log_err("%20s: %s\n", o->name, o->help);
756 show_option_help(o, 1);
763 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
765 char *o_ptr, *ptr, *ptr2;
768 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
772 o_ptr = ptr = strdup(__ptr);
775 * See if we have another set of parameters, hidden after a comma.
776 * Do this before parsing this round, to check if we should
777 * copy set 1 options to set 2.
786 (o->type != FIO_OPT_STR_STORE) &&
787 (o->type != FIO_OPT_STR) &&
788 (o->type != FIO_OPT_FLOAT_LIST)) {
789 ptr2 = strchr(ptr, ',');
790 if (ptr2 && *(ptr2 + 1) == '\0')
792 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
794 ptr2 = strchr(ptr, ':');
796 ptr2 = strchr(ptr, '-');
798 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
799 ptr2 = strchr(ptr, ':');
803 * Don't return early if parsing the first option fails - if
804 * we are doing multiple arguments, we can allow the first one
807 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
823 static struct fio_option *get_option(char *opt,
824 struct fio_option *options, char **post)
826 struct fio_option *o;
829 ret = strchr(opt, '=');
835 strip_blank_end(ret);
836 o = find_option(options, ret);
838 o = find_option(options, opt);
845 static int opt_cmp(const void *p1, const void *p2)
847 struct fio_option *o;
854 s = strdup(*((char **) p1));
855 o = get_option(s, __fio_options, &foo);
861 s = strdup(*((char **) p2));
862 o = get_option(s, __fio_options, &foo);
868 return prio2 - prio1;
871 void sort_options(char **opts, struct fio_option *options, int num_opts)
873 __fio_options = options;
874 qsort(opts, num_opts, sizeof(char *), opt_cmp);
875 __fio_options = NULL;
878 int parse_cmd_option(const char *opt, const char *val,
879 struct fio_option *options, void *data)
881 struct fio_option *o;
883 o = find_option(options, opt);
885 log_err("Bad option <%s>\n", opt);
889 if (!handle_option(o, val, data))
892 log_err("fio: failed parsing %s=%s\n", opt, val);
896 int parse_option(char *opt, const char *input,
897 struct fio_option *options, struct fio_option **o, void *data,
903 log_err("fio: failed parsing %s\n", input);
908 *o = get_option(opt, options, &post);
911 int len = strlen(opt);
912 if (opt + len + 1 != post)
913 memmove(opt + len + 1, post, strlen(post));
919 if (handle_option(*o, post, data)) {
920 log_err("fio: failed parsing %s\n", input);
927 if (!strcmp("description", (*o)->name))
932 log_info("--%s%s", (*o)->name, post ? "" : " ");
934 log_info("=%s%s%s ", delim, post, delim);
941 * Option match, levenshtein distance. Handy for not quite remembering what
942 * the option name is.
944 static int string_distance(const char *s1, const char *s2)
946 unsigned int s1_len = strlen(s1);
947 unsigned int s2_len = strlen(s2);
948 unsigned int *p, *q, *r;
951 p = malloc(sizeof(unsigned int) * (s2_len + 1));
952 q = malloc(sizeof(unsigned int) * (s2_len + 1));
955 for (i = 1; i <= s2_len; i++)
958 for (i = 1; i <= s1_len; i++) {
960 for (j = 1; j <= s2_len; j++) {
961 unsigned int sub = p[j - 1];
963 if (s1[i - 1] != s2[j - 1])
966 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
979 static struct fio_option *find_child(struct fio_option *options,
980 struct fio_option *o)
982 struct fio_option *__o;
984 for (__o = options + 1; __o->name; __o++)
985 if (__o->parent && !strcmp(__o->parent, o->name))
991 static void __print_option(struct fio_option *o, struct fio_option *org,
1005 p += sprintf(p, "%s", " ");
1007 sprintf(p, "%s", o->name);
1009 log_info("%-24s: %s\n", name, o->help);
1012 static void print_option(struct fio_option *o)
1014 struct fio_option *parent;
1015 struct fio_option *__o;
1016 unsigned int printed;
1019 __print_option(o, NULL, 0);
1026 while ((__o = find_child(o, parent)) != NULL) {
1027 __print_option(__o, o, level);
1036 int show_cmd_help(struct fio_option *options, const char *name)
1038 struct fio_option *o, *closest;
1039 unsigned int best_dist = -1U;
1043 if (!name || !strcmp(name, "all"))
1048 for (o = &options[0]; o->name; o++) {
1051 if (o->type == FIO_OPT_DEPRECATED)
1053 if (!exec_profile && o->prof_name)
1055 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1059 if (!strcmp(name, o->name) ||
1060 (o->alias && !strcmp(name, o->alias)))
1065 dist = string_distance(name, o->name);
1066 if (dist < best_dist) {
1073 if (show_all || match) {
1076 log_info("%20s: %s\n", o->name, o->help);
1087 show_option_help(o, 0);
1093 log_err("No such command: %s", name);
1096 * Only print an appropriately close option, one where the edit
1097 * distance isn't too big. Otherwise we get crazy matches.
1099 if (closest && best_dist < 3) {
1100 log_info(" - showing closest match\n");
1101 log_info("%20s: %s\n", closest->name, closest->help);
1102 show_option_help(closest, 0);
1110 * Handle parsing of default parameters.
1112 void fill_default_options(void *data, struct fio_option *options)
1114 struct fio_option *o;
1116 dprint(FD_PARSE, "filling default options\n");
1118 for (o = &options[0]; o->name; o++)
1120 handle_option(o, o->def, data);
1123 void option_init(struct fio_option *o)
1125 if (o->type == FIO_OPT_DEPRECATED)
1127 if (o->type == FIO_OPT_BOOL) {
1131 if (o->type == FIO_OPT_INT) {
1133 o->maxval = UINT_MAX;
1135 if (o->type == FIO_OPT_FLOAT_LIST) {
1139 if (o->type == FIO_OPT_STR_SET && o->def) {
1140 log_err("Option %s: string set option with"
1141 " default will always be true\n", o->name);
1143 if (!o->cb && !o->off1)
1144 log_err("Option %s: neither cb nor offset given\n", o->name);
1146 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1147 o->category = FIO_OPT_C_GENERAL;
1148 o->group = FIO_OPT_G_INVALID;
1150 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1151 o->type == FIO_OPT_STR_MULTI)
1153 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
1154 log_err("Option %s: both cb and offset given\n", o->name);
1158 * Sanitize the options structure. For now it just sets min/max for bool
1159 * values and whether both callback and offsets are given.
1161 void options_init(struct fio_option *options)
1163 struct fio_option *o;
1165 dprint(FD_PARSE, "init options\n");
1167 for (o = &options[0]; o->name; o++) {
1170 o->inv_opt = find_option(options, o->inverse);
1174 void options_free(struct fio_option *options, void *data)
1176 struct fio_option *o;
1179 dprint(FD_PARSE, "free options\n");
1181 for (o = &options[0]; o->name; o++) {
1182 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1185 ptr = td_var(data, o, o->off1);