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 if ((o)->prof_opts) \
374 ptr = td_var((o)->prof_opts, (off)); \
376 ptr = td_var((data), (off)); \
383 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
384 int first, int more, int curr)
388 long long ull, *ullp;
392 int ret = 0, is_time = 0;
393 const struct value_pair *vp;
394 struct value_pair posval[PARSE_MAX_VP];
395 int i, all_skipped = 1;
397 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
400 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
401 log_err("Option %s requires an argument\n", o->name);
407 case FIO_OPT_STR_MULTI: {
408 fio_opt_str_fn *fn = o->cb;
410 posval_sort(o, posval);
413 for (i = 0; i < PARSE_MAX_VP; i++) {
415 if (!vp->ival || vp->ival[0] == '\0')
418 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
421 val_store(ilp, vp->oval, o->off1, vp->or, data, o);
426 if (ret && !all_skipped)
427 show_option_values(o);
432 case FIO_OPT_STR_VAL_TIME:
435 case FIO_OPT_STR_VAL: {
436 fio_opt_str_val_fn *fn = o->cb;
439 strncpy(tmp, ptr, sizeof(tmp) - 1);
440 p = strchr(tmp, ',');
445 ret = check_str_time(tmp, &ull);
447 ret = check_str_bytes(tmp, &ull, data);
449 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
454 if (o->maxval && ull > o->maxval) {
455 log_err("max value out of range: %llu"
456 " (%u max)\n", ull, o->maxval);
459 if (o->minval && ull < o->minval) {
460 log_err("min value out of range: %llu"
461 " (%u min)\n", ull, o->minval);
464 if (o->posval[0].ival) {
465 posval_sort(o, posval);
468 for (i = 0; i < PARSE_MAX_VP; i++) {
470 if (!vp->ival || vp->ival[0] == '\0')
472 if (vp->oval == ull) {
478 log_err("fio: value %llu not allowed:\n", ull);
479 show_option_values(o);
485 ret = fn(data, &ull);
487 if (o->type == FIO_OPT_INT) {
489 val_store(ilp, ull, o->off1, 0, data, o);
492 val_store(ilp, ull, o->off2, 0, data, o);
496 val_store(ilp, ull, o->off3, 0, data, o);
501 val_store(ilp, ull, o->off2, 0, data, o);
505 val_store(ilp, ull, o->off3, 0, data, o);
510 val_store(ullp, ull, o->off1, 0, data, o);
513 val_store(ullp, ull, o->off2, 0, data, o);
519 case FIO_OPT_FLOAT_LIST: {
524 ** Initialize precision to 0 and zero out list
525 ** in case specified list is shorter than default
530 ilp = td_var(o->prof_opts, o->off2);
532 ilp = td_var(data, o->off2);
537 flp = td_var(o->prof_opts, o->off1);
539 flp = td_var(data, o->off1);
540 for(i = 0; i < o->maxlen; i++)
543 if (curr >= o->maxlen) {
544 log_err("the list exceeding max length %d\n",
548 if (!str_to_float(ptr, &uf)) {
549 log_err("not a floating point value: %s\n", ptr);
553 log_err("value out of range: %f"
554 " (range max: %f)\n", uf, o->maxfp);
558 log_err("value out of range: %f"
559 " (range min: %f)\n", uf, o->minfp);
564 flp = td_var(o->prof_opts, o->off1);
566 flp = td_var(data, o->off1);
569 dprint(FD_PARSE, " out=%f\n", uf);
572 ** Calculate precision for output by counting
573 ** number of digits after period. Find first
574 ** period in entire remaining list each time
576 cp2 = strchr(ptr, '.');
580 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
585 ilp = td_var(o->prof_opts, o->off2);
587 ilp = td_var(data, o->off2);
595 case FIO_OPT_STR_STORE: {
596 fio_opt_str_fn *fn = o->cb;
600 cp = td_var(o->prof_opts, o->off1);
602 cp = td_var(data, o->off1);
609 else if (o->posval[0].ival) {
610 posval_sort(o, posval);
613 for (i = 0; i < PARSE_MAX_VP; i++) {
615 if (!vp->ival || vp->ival[0] == '\0')
618 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
624 rest = strstr(*cp ?: ptr, ":");
638 show_option_values(o);
647 case FIO_OPT_RANGE: {
651 strncpy(tmp, ptr, sizeof(tmp) - 1);
653 /* Handle bsrange with separate read,write values: */
654 p1 = strchr(tmp, ',');
658 p1 = strchr(tmp, '-');
660 p1 = strchr(tmp, ':');
672 if (!check_range_bytes(p1, &ul1, data) &&
673 !check_range_bytes(p2, &ul2, data)) {
676 unsigned long foo = ul1;
683 val_store(ilp, ul1, o->off1, 0, data, o);
684 val_store(ilp, ul2, o->off2, 0, data, o);
687 if (o->off3 && o->off4) {
688 val_store(ilp, ul1, o->off3, 0, data, o);
689 val_store(ilp, ul2, o->off4, 0, data, o);
693 if (o->off5 && o->off6) {
694 val_store(ilp, ul1, o->off5, 0, data, o);
695 val_store(ilp, ul2, o->off6, 0, data, o);
700 if (o->off3 && o->off4) {
701 val_store(ilp, ul1, o->off3, 0, data, o);
702 val_store(ilp, ul2, o->off4, 0, data, o);
706 if (o->off5 && o->off6) {
707 val_store(ilp, ul1, o->off5, 0, data, o);
708 val_store(ilp, ul2, o->off6, 0, data, o);
717 case FIO_OPT_STR_SET: {
718 fio_opt_int_fn *fn = o->cb;
721 ret = check_int(ptr, &il);
722 else if (o->type == FIO_OPT_BOOL)
727 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
732 if (o->maxval && il > (int) o->maxval) {
733 log_err("max value out of range: %d (%d max)\n",
737 if (o->minval && il < o->minval) {
738 log_err("min value out of range: %d (%d min)\n",
750 val_store(ilp, il, o->off1, 0, data, o);
753 val_store(ilp, il, o->off2, 0, data, o);
758 case FIO_OPT_DEPRECATED:
759 log_info("Option %s is deprecated\n", o->name);
763 log_err("Bad option type %u\n", o->type);
771 ret = o->verify(o, data);
773 log_err("Correct format for offending option\n");
774 log_err("%20s: %s\n", o->name, o->help);
775 show_option_help(o, 1);
782 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
784 char *o_ptr, *ptr, *ptr2;
787 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
791 o_ptr = ptr = strdup(__ptr);
794 * See if we have another set of parameters, hidden after a comma.
795 * Do this before parsing this round, to check if we should
796 * copy set 1 options to set 2.
805 (o->type != FIO_OPT_STR_STORE) &&
806 (o->type != FIO_OPT_STR) &&
807 (o->type != FIO_OPT_FLOAT_LIST)) {
808 ptr2 = strchr(ptr, ',');
809 if (ptr2 && *(ptr2 + 1) == '\0')
811 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
813 ptr2 = strchr(ptr, ':');
815 ptr2 = strchr(ptr, '-');
817 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
818 ptr2 = strchr(ptr, ':');
822 * Don't return early if parsing the first option fails - if
823 * we are doing multiple arguments, we can allow the first one
826 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
842 static struct fio_option *get_option(char *opt,
843 struct fio_option *options, char **post)
845 struct fio_option *o;
848 ret = strchr(opt, '=');
854 strip_blank_end(ret);
855 o = find_option(options, ret);
857 o = find_option(options, opt);
864 static int opt_cmp(const void *p1, const void *p2)
866 struct fio_option *o;
873 s = strdup(*((char **) p1));
874 o = get_option(s, __fio_options, &foo);
880 s = strdup(*((char **) p2));
881 o = get_option(s, __fio_options, &foo);
887 return prio2 - prio1;
890 void sort_options(char **opts, struct fio_option *options, int num_opts)
892 __fio_options = options;
893 qsort(opts, num_opts, sizeof(char *), opt_cmp);
894 __fio_options = NULL;
897 int parse_cmd_option(const char *opt, const char *val,
898 struct fio_option *options, void *data)
900 struct fio_option *o;
902 o = find_option(options, opt);
904 log_err("Bad option <%s>\n", opt);
908 if (!handle_option(o, val, data))
911 log_err("fio: failed parsing %s=%s\n", opt, val);
915 int parse_option(char *opt, const char *input,
916 struct fio_option *options, struct fio_option **o, void *data,
922 log_err("fio: failed parsing %s\n", input);
927 *o = get_option(opt, options, &post);
930 int len = strlen(opt);
931 if (opt + len + 1 != post)
932 memmove(opt + len + 1, post, strlen(post));
938 if (handle_option(*o, post, data)) {
939 log_err("fio: failed parsing %s\n", input);
946 if (!strcmp("description", (*o)->name))
951 log_info("--%s%s", (*o)->name, post ? "" : " ");
953 log_info("=%s%s%s ", delim, post, delim);
960 * Option match, levenshtein distance. Handy for not quite remembering what
961 * the option name is.
963 static int string_distance(const char *s1, const char *s2)
965 unsigned int s1_len = strlen(s1);
966 unsigned int s2_len = strlen(s2);
967 unsigned int *p, *q, *r;
970 p = malloc(sizeof(unsigned int) * (s2_len + 1));
971 q = malloc(sizeof(unsigned int) * (s2_len + 1));
974 for (i = 1; i <= s2_len; i++)
977 for (i = 1; i <= s1_len; i++) {
979 for (j = 1; j <= s2_len; j++) {
980 unsigned int sub = p[j - 1];
982 if (s1[i - 1] != s2[j - 1])
985 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
998 static struct fio_option *find_child(struct fio_option *options,
999 struct fio_option *o)
1001 struct fio_option *__o;
1003 for (__o = options + 1; __o->name; __o++)
1004 if (__o->parent && !strcmp(__o->parent, o->name))
1010 static void __print_option(struct fio_option *o, struct fio_option *org,
1024 p += sprintf(p, "%s", " ");
1026 sprintf(p, "%s", o->name);
1028 log_info("%-24s: %s\n", name, o->help);
1031 static void print_option(struct fio_option *o)
1033 struct fio_option *parent;
1034 struct fio_option *__o;
1035 unsigned int printed;
1038 __print_option(o, NULL, 0);
1045 while ((__o = find_child(o, parent)) != NULL) {
1046 __print_option(__o, o, level);
1055 int show_cmd_help(struct fio_option *options, const char *name)
1057 struct fio_option *o, *closest;
1058 unsigned int best_dist = -1U;
1062 if (!name || !strcmp(name, "all"))
1067 for (o = &options[0]; o->name; o++) {
1070 if (o->type == FIO_OPT_DEPRECATED)
1072 if (!exec_profile && o->prof_name)
1074 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1078 if (!strcmp(name, o->name) ||
1079 (o->alias && !strcmp(name, o->alias)))
1084 dist = string_distance(name, o->name);
1085 if (dist < best_dist) {
1092 if (show_all || match) {
1095 log_info("%20s: %s\n", o->name, o->help);
1106 show_option_help(o, 0);
1112 log_err("No such command: %s", name);
1115 * Only print an appropriately close option, one where the edit
1116 * distance isn't too big. Otherwise we get crazy matches.
1118 if (closest && best_dist < 3) {
1119 log_info(" - showing closest match\n");
1120 log_info("%20s: %s\n", closest->name, closest->help);
1121 show_option_help(closest, 0);
1129 * Handle parsing of default parameters.
1131 void fill_default_options(void *data, struct fio_option *options)
1133 struct fio_option *o;
1135 dprint(FD_PARSE, "filling default options\n");
1137 for (o = &options[0]; o->name; o++)
1139 handle_option(o, o->def, data);
1142 void option_init(struct fio_option *o)
1144 if (o->type == FIO_OPT_DEPRECATED)
1146 if (o->type == FIO_OPT_BOOL) {
1150 if (o->type == FIO_OPT_INT) {
1152 o->maxval = UINT_MAX;
1154 if (o->type == FIO_OPT_FLOAT_LIST) {
1158 if (o->type == FIO_OPT_STR_SET && o->def) {
1159 log_err("Option %s: string set option with"
1160 " default will always be true\n", o->name);
1162 if (!o->cb && !o->off1)
1163 log_err("Option %s: neither cb nor offset given\n", o->name);
1165 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1166 o->category = FIO_OPT_C_GENERAL;
1167 o->group = FIO_OPT_G_INVALID;
1169 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1170 o->type == FIO_OPT_STR_MULTI)
1172 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
1173 log_err("Option %s: both cb and offset given\n", o->name);
1177 * Sanitize the options structure. For now it just sets min/max for bool
1178 * values and whether both callback and offsets are given.
1180 void options_init(struct fio_option *options)
1182 struct fio_option *o;
1184 dprint(FD_PARSE, "init options\n");
1186 for (o = &options[0]; o->name; o++) {
1189 o->inv_opt = find_option(options, o->inverse);
1193 void options_free(struct fio_option *options, void *data)
1195 struct fio_option *o;
1198 dprint(FD_PARSE, "free options\n");
1200 for (o = &options[0]; o->name; o++) {
1201 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1205 ptr = td_var(o->prof_opts, o->off1);
1207 ptr = td_var(data, o->off1);