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 long get_mult_time(const char *str, int len)
129 unsigned long long mult = 1000;
132 * Go forward until we hit a non-digit, or +/- sign
134 while ((p - str) <= len) {
135 if (!isdigit((int) *p) && (*p != '+') && (*p != '-'))
140 if (!isalpha((int) *p))
144 for (int i = 0; i < strlen(c); i++)
145 c[i] = tolower(c[i]);
147 if (!strncmp("ms", c, 2))
149 else if (!strcmp("s", c))
151 else if (!strcmp("m", c))
153 else if (!strcmp("h", c))
154 mult = 60 * 60 * 1000;
155 else if (!strcmp("d", c))
156 mult = 24 * 60 * 60 * 1000;
162 static int is_separator(char c)
175 static unsigned long long __get_mult_bytes(const char *p, void *data,
178 unsigned int kb_base = fio_get_kb_base(data);
179 unsigned long long ret = 1;
180 unsigned int i, pow = 0, mult = kb_base;
188 for (i = 0; i < strlen(c); i++) {
189 c[i] = tolower(c[i]);
190 if (is_separator(c[i])) {
196 if (!strncmp("pib", c, 3)) {
199 } else if (!strncmp("tib", c, 3)) {
202 } else if (!strncmp("gib", c, 3)) {
205 } else if (!strncmp("mib", c, 3)) {
208 } else if (!strncmp("kib", c, 3)) {
211 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
213 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
215 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
217 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
219 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
221 else if (!strncmp("%", c, 1)) {
228 ret *= (unsigned long long) mult;
234 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
241 return __get_mult_bytes(str, data, percent);
244 * Go forward until we hit a non-digit, or +/- sign
246 while ((p - str) <= len) {
247 if (!isdigit((int) *p) &&
248 (((*p != '+') && (*p != '-')) || digit_seen))
250 digit_seen |= isdigit((int) *p);
254 if (!isalpha((int) *p) && (*p != '%'))
257 return __get_mult_bytes(p, data, percent);
261 * Convert string into a floating number. Return 1 for success and 0 otherwise.
263 int str_to_float(const char *str, double *val)
265 return (1 == sscanf(str, "%lf", val));
269 * convert string into decimal value, noting any size suffix
271 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
279 if (strstr(str, "0x") || strstr(str, "0X"))
284 *val = strtoll(str, NULL, base);
285 if (*val == LONG_MAX && errno == ERANGE)
289 unsigned long long mult;
292 mult = get_mult_bytes(str, len, data, &perc);
298 *val *= get_mult_time(str, len);
303 int check_str_bytes(const char *p, long long *val, void *data)
305 return str_to_decimal(p, val, 1, data);
308 int check_str_time(const char *p, long long *val)
310 return str_to_decimal(p, val, 0, NULL);
313 void strip_blank_front(char **p)
319 while (isspace((int) *s))
325 void strip_blank_end(char *p)
342 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
348 static int check_range_bytes(const char *str, long *val, void *data)
352 if (!str_to_decimal(str, &__val, 1, data)) {
360 static int check_int(const char *p, int *val)
364 if (strstr(p, "0x") || strstr(p, "0X")) {
365 if (sscanf(p, "%x", val) == 1)
368 if (sscanf(p, "%u", val) == 1)
375 static int opt_len(const char *str)
379 postfix = strchr(str, ':');
383 return (int)(postfix - str);
386 static int str_match_len(const struct value_pair *vp, const char *str)
388 return max(strlen(vp->ival), opt_len(str));
391 #define val_store(ptr, val, off, or, data, o) \
393 ptr = td_var((data), (o), (off)); \
400 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
401 int first, int more, int curr)
405 long long ull, *ullp;
409 int ret = 0, is_time = 0;
410 const struct value_pair *vp;
411 struct value_pair posval[PARSE_MAX_VP];
412 int i, all_skipped = 1;
414 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
417 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
418 log_err("Option %s requires an argument\n", o->name);
424 case FIO_OPT_STR_MULTI: {
425 fio_opt_str_fn *fn = o->cb;
427 posval_sort(o, posval);
430 for (i = 0; i < PARSE_MAX_VP; i++) {
432 if (!vp->ival || vp->ival[0] == '\0')
435 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
438 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
443 if (ret && !all_skipped)
444 show_option_values(o);
449 case FIO_OPT_STR_VAL_TIME:
452 case FIO_OPT_STR_VAL: {
453 fio_opt_str_val_fn *fn = o->cb;
456 strncpy(tmp, ptr, sizeof(tmp) - 1);
457 p = strchr(tmp, ',');
462 ret = check_str_time(tmp, &ull);
464 ret = check_str_bytes(tmp, &ull, data);
466 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
471 if (o->maxval && ull > o->maxval) {
472 log_err("max value out of range: %llu"
473 " (%u max)\n", ull, o->maxval);
476 if (o->minval && ull < o->minval) {
477 log_err("min value out of range: %llu"
478 " (%u min)\n", ull, o->minval);
481 if (o->posval[0].ival) {
482 posval_sort(o, posval);
485 for (i = 0; i < PARSE_MAX_VP; i++) {
487 if (!vp->ival || vp->ival[0] == '\0')
489 if (vp->oval == ull) {
495 log_err("fio: value %llu not allowed:\n", ull);
496 show_option_values(o);
502 ret = fn(data, &ull);
504 if (o->type == FIO_OPT_INT) {
506 val_store(ilp, ull, o->off1, 0, data, o);
509 val_store(ilp, ull, o->off2, 0, data, o);
513 val_store(ilp, ull, o->off3, 0, data, o);
518 val_store(ilp, ull, o->off2, 0, data, o);
522 val_store(ilp, ull, o->off3, 0, data, o);
527 val_store(ullp, ull, o->off1, 0, data, o);
530 val_store(ullp, ull, o->off2, 0, data, o);
536 case FIO_OPT_FLOAT_LIST: {
541 ** Initialize precision to 0 and zero out list
542 ** in case specified list is shorter than default
546 ilp = td_var(data, o, o->off2);
550 flp = td_var(data, o, o->off1);
551 for(i = 0; i < o->maxlen; i++)
554 if (curr >= o->maxlen) {
555 log_err("the list exceeding max length %d\n",
559 if (!str_to_float(ptr, &uf)) {
560 log_err("not a floating point value: %s\n", ptr);
564 log_err("value out of range: %f"
565 " (range max: %f)\n", uf, o->maxfp);
569 log_err("value out of range: %f"
570 " (range min: %f)\n", uf, o->minfp);
574 flp = td_var(data, o, o->off1);
577 dprint(FD_PARSE, " out=%f\n", uf);
580 ** Calculate precision for output by counting
581 ** number of digits after period. Find first
582 ** period in entire remaining list each time
584 cp2 = strchr(ptr, '.');
588 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
592 ilp = td_var(data, o, o->off2);
600 case FIO_OPT_STR_STORE: {
601 fio_opt_str_fn *fn = o->cb;
604 cp = td_var(data, o, o->off1);
610 else if (o->posval[0].ival) {
611 posval_sort(o, posval);
614 for (i = 0; i < PARSE_MAX_VP; i++) {
616 if (!vp->ival || vp->ival[0] == '\0')
619 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
625 rest = strstr(*cp ?: ptr, ":");
639 show_option_values(o);
648 case FIO_OPT_RANGE: {
652 strncpy(tmp, ptr, sizeof(tmp) - 1);
654 /* Handle bsrange with separate read,write values: */
655 p1 = strchr(tmp, ',');
659 p1 = strchr(tmp, '-');
661 p1 = strchr(tmp, ':');
673 if (!check_range_bytes(p1, &ul1, data) &&
674 !check_range_bytes(p2, &ul2, data)) {
677 unsigned long foo = ul1;
684 val_store(ilp, ul1, o->off1, 0, data, o);
685 val_store(ilp, ul2, o->off2, 0, data, o);
688 if (o->off3 && o->off4) {
689 val_store(ilp, ul1, o->off3, 0, data, o);
690 val_store(ilp, ul2, o->off4, 0, data, o);
694 if (o->off5 && o->off6) {
695 val_store(ilp, ul1, o->off5, 0, data, o);
696 val_store(ilp, ul2, o->off6, 0, data, o);
701 if (o->off3 && o->off4) {
702 val_store(ilp, ul1, o->off3, 0, data, o);
703 val_store(ilp, ul2, o->off4, 0, data, o);
707 if (o->off5 && o->off6) {
708 val_store(ilp, ul1, o->off5, 0, data, o);
709 val_store(ilp, ul2, o->off6, 0, data, o);
718 case FIO_OPT_STR_SET: {
719 fio_opt_int_fn *fn = o->cb;
722 ret = check_int(ptr, &il);
723 else if (o->type == FIO_OPT_BOOL)
728 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
733 if (o->maxval && il > (int) o->maxval) {
734 log_err("max value out of range: %d (%d max)\n",
738 if (o->minval && il < o->minval) {
739 log_err("min value out of range: %d (%d min)\n",
751 val_store(ilp, il, o->off1, 0, data, o);
754 val_store(ilp, il, o->off2, 0, data, o);
759 case FIO_OPT_DEPRECATED:
760 log_info("Option %s is deprecated\n", o->name);
764 log_err("Bad option type %u\n", o->type);
772 ret = o->verify(o, data);
774 log_err("Correct format for offending option\n");
775 log_err("%20s: %s\n", o->name, o->help);
776 show_option_help(o, 1);
783 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
785 char *o_ptr, *ptr, *ptr2;
788 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
792 o_ptr = ptr = strdup(__ptr);
795 * See if we have another set of parameters, hidden after a comma.
796 * Do this before parsing this round, to check if we should
797 * copy set 1 options to set 2.
806 (o->type != FIO_OPT_STR_STORE) &&
807 (o->type != FIO_OPT_STR) &&
808 (o->type != FIO_OPT_FLOAT_LIST)) {
809 ptr2 = strchr(ptr, ',');
810 if (ptr2 && *(ptr2 + 1) == '\0')
812 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
814 ptr2 = strchr(ptr, ':');
816 ptr2 = strchr(ptr, '-');
818 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
819 ptr2 = strchr(ptr, ':');
823 * Don't return early if parsing the first option fails - if
824 * we are doing multiple arguments, we can allow the first one
827 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
843 static struct fio_option *get_option(char *opt,
844 struct fio_option *options, char **post)
846 struct fio_option *o;
849 ret = strchr(opt, '=');
855 strip_blank_end(ret);
856 o = find_option(options, ret);
858 o = find_option(options, opt);
865 static int opt_cmp(const void *p1, const void *p2)
867 struct fio_option *o;
874 s = strdup(*((char **) p1));
875 o = get_option(s, __fio_options, &foo);
881 s = strdup(*((char **) p2));
882 o = get_option(s, __fio_options, &foo);
888 return prio2 - prio1;
891 void sort_options(char **opts, struct fio_option *options, int num_opts)
893 __fio_options = options;
894 qsort(opts, num_opts, sizeof(char *), opt_cmp);
895 __fio_options = NULL;
898 int parse_cmd_option(const char *opt, const char *val,
899 struct fio_option *options, void *data)
901 struct fio_option *o;
903 o = find_option(options, opt);
905 log_err("Bad option <%s>\n", opt);
909 if (!handle_option(o, val, data))
912 log_err("fio: failed parsing %s=%s\n", opt, val);
916 int parse_option(char *opt, const char *input,
917 struct fio_option *options, struct fio_option **o, void *data,
923 log_err("fio: failed parsing %s\n", input);
928 *o = get_option(opt, options, &post);
931 int len = strlen(opt);
932 if (opt + len + 1 != post)
933 memmove(opt + len + 1, post, strlen(post));
939 if (handle_option(*o, post, data)) {
940 log_err("fio: failed parsing %s\n", input);
947 if (!strcmp("description", (*o)->name))
952 log_info("--%s%s", (*o)->name, post ? "" : " ");
954 log_info("=%s%s%s ", delim, post, delim);
961 * Option match, levenshtein distance. Handy for not quite remembering what
962 * the option name is.
964 static int string_distance(const char *s1, const char *s2)
966 unsigned int s1_len = strlen(s1);
967 unsigned int s2_len = strlen(s2);
968 unsigned int *p, *q, *r;
971 p = malloc(sizeof(unsigned int) * (s2_len + 1));
972 q = malloc(sizeof(unsigned int) * (s2_len + 1));
975 for (i = 1; i <= s2_len; i++)
978 for (i = 1; i <= s1_len; i++) {
980 for (j = 1; j <= s2_len; j++) {
981 unsigned int sub = p[j - 1];
983 if (s1[i - 1] != s2[j - 1])
986 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
999 static struct fio_option *find_child(struct fio_option *options,
1000 struct fio_option *o)
1002 struct fio_option *__o;
1004 for (__o = options + 1; __o->name; __o++)
1005 if (__o->parent && !strcmp(__o->parent, o->name))
1011 static void __print_option(struct fio_option *o, struct fio_option *org,
1025 p += sprintf(p, "%s", " ");
1027 sprintf(p, "%s", o->name);
1029 log_info("%-24s: %s\n", name, o->help);
1032 static void print_option(struct fio_option *o)
1034 struct fio_option *parent;
1035 struct fio_option *__o;
1036 unsigned int printed;
1039 __print_option(o, NULL, 0);
1046 while ((__o = find_child(o, parent)) != NULL) {
1047 __print_option(__o, o, level);
1056 int show_cmd_help(struct fio_option *options, const char *name)
1058 struct fio_option *o, *closest;
1059 unsigned int best_dist = -1U;
1063 if (!name || !strcmp(name, "all"))
1068 for (o = &options[0]; o->name; o++) {
1071 if (o->type == FIO_OPT_DEPRECATED)
1073 if (!exec_profile && o->prof_name)
1075 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1079 if (!strcmp(name, o->name) ||
1080 (o->alias && !strcmp(name, o->alias)))
1085 dist = string_distance(name, o->name);
1086 if (dist < best_dist) {
1093 if (show_all || match) {
1096 log_info("%20s: %s\n", o->name, o->help);
1107 show_option_help(o, 0);
1113 log_err("No such command: %s", name);
1116 * Only print an appropriately close option, one where the edit
1117 * distance isn't too big. Otherwise we get crazy matches.
1119 if (closest && best_dist < 3) {
1120 log_info(" - showing closest match\n");
1121 log_info("%20s: %s\n", closest->name, closest->help);
1122 show_option_help(closest, 0);
1130 * Handle parsing of default parameters.
1132 void fill_default_options(void *data, struct fio_option *options)
1134 struct fio_option *o;
1136 dprint(FD_PARSE, "filling default options\n");
1138 for (o = &options[0]; o->name; o++)
1140 handle_option(o, o->def, data);
1143 void option_init(struct fio_option *o)
1145 if (o->type == FIO_OPT_DEPRECATED)
1147 if (o->type == FIO_OPT_BOOL) {
1151 if (o->type == FIO_OPT_INT) {
1153 o->maxval = UINT_MAX;
1155 if (o->type == FIO_OPT_FLOAT_LIST) {
1159 if (o->type == FIO_OPT_STR_SET && o->def) {
1160 log_err("Option %s: string set option with"
1161 " default will always be true\n", o->name);
1163 if (!o->cb && !o->off1)
1164 log_err("Option %s: neither cb nor offset given\n", o->name);
1166 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1167 o->category = FIO_OPT_C_GENERAL;
1168 o->group = FIO_OPT_G_INVALID;
1170 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1171 o->type == FIO_OPT_STR_MULTI)
1173 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
1174 log_err("Option %s: both cb and offset given\n", o->name);
1178 * Sanitize the options structure. For now it just sets min/max for bool
1179 * values and whether both callback and offsets are given.
1181 void options_init(struct fio_option *options)
1183 struct fio_option *o;
1185 dprint(FD_PARSE, "init options\n");
1187 for (o = &options[0]; o->name; o++) {
1190 o->inv_opt = find_option(options, o->inverse);
1194 void options_free(struct fio_option *options, void *data)
1196 struct fio_option *o;
1199 dprint(FD_PARSE, "free options\n");
1201 for (o = &options[0]; o->name; o++) {
1202 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1205 ptr = td_var(data, o, o->off1);