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) \
373 ptr = td_var((data), (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))) {
419 *(unsigned int *) o->roff1 |= vp->oval;
421 *(unsigned int *) o->roff1 = vp->oval;
425 val_store(ilp, vp->oval, o->off1, vp->or, data);
431 if (ret && !all_skipped)
432 show_option_values(o);
437 case FIO_OPT_STR_VAL_TIME:
440 case FIO_OPT_STR_VAL: {
441 fio_opt_str_val_fn *fn = o->cb;
444 strncpy(tmp, ptr, sizeof(tmp) - 1);
445 p = strchr(tmp, ',');
450 ret = check_str_time(tmp, &ull);
452 ret = check_str_bytes(tmp, &ull, data);
454 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
459 if (o->maxval && ull > o->maxval) {
460 log_err("max value out of range: %llu"
461 " (%u max)\n", ull, o->maxval);
464 if (o->minval && ull < o->minval) {
465 log_err("min value out of range: %llu"
466 " (%u min)\n", ull, o->minval);
469 if (o->posval[0].ival) {
470 posval_sort(o, posval);
473 for (i = 0; i < PARSE_MAX_VP; i++) {
475 if (!vp->ival || vp->ival[0] == '\0')
477 if (vp->oval == ull) {
483 log_err("fio: value %llu not allowed:\n", ull);
484 show_option_values(o);
490 ret = fn(data, &ull);
492 if (o->type == FIO_OPT_INT) {
495 *(unsigned int *) o->roff1 = ull;
497 val_store(ilp, ull, o->off1, 0, data);
501 *(unsigned int *) o->roff2 = ull;
503 val_store(ilp, ull, o->off2, 0, data);
507 *(unsigned int *) o->roff3 = ull;
509 val_store(ilp, ull, o->off3, 0, data);
514 *(unsigned int *) o->roff2 = ull;
516 val_store(ilp, ull, o->off2, 0, data);
520 *(unsigned int *) o->roff3 = ull;
522 val_store(ilp, ull, o->off3, 0, data);
528 *(unsigned long long *) o->roff1 = ull;
530 val_store(ullp, ull, o->off1, 0, data);
534 *(unsigned long long *) o->roff2 = ull;
536 val_store(ullp, ull, o->off2, 0, data);
542 case FIO_OPT_FLOAT_LIST: {
547 ** Initialize precision to 0 and zero out list
548 ** in case specified list is shorter than default
552 ilp = td_var(data, o->off2);
556 flp = td_var(data, o->off1);
557 for(i = 0; i < o->maxlen; i++)
560 if (curr >= o->maxlen) {
561 log_err("the list exceeding max length %d\n",
565 if (!str_to_float(ptr, &uf)) {
566 log_err("not a floating point value: %s\n", ptr);
570 log_err("value out of range: %f"
571 " (range max: %f)\n", uf, o->maxfp);
575 log_err("value out of range: %f"
576 " (range min: %f)\n", uf, o->minfp);
580 flp = td_var(data, o->off1);
583 dprint(FD_PARSE, " out=%f\n", uf);
586 ** Calculate precision for output by counting
587 ** number of digits after period. Find first
588 ** period in entire remaining list each time
590 cp2 = strchr(ptr, '.');
594 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
598 ilp = td_var(data, o->off2);
606 case FIO_OPT_STR_STORE: {
607 fio_opt_str_fn *fn = o->cb;
609 if (o->roff1 || o->off1) {
611 cp = (char **) o->roff1;
613 cp = td_var(data, o->off1);
620 else if (o->posval[0].ival) {
621 posval_sort(o, posval);
624 for (i = 0; i < PARSE_MAX_VP; i++) {
626 if (!vp->ival || vp->ival[0] == '\0')
629 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
635 rest = strstr(*cp ?: ptr, ":");
649 show_option_values(o);
658 case FIO_OPT_RANGE: {
662 strncpy(tmp, ptr, sizeof(tmp) - 1);
664 /* Handle bsrange with separate read,write values: */
665 p1 = strchr(tmp, ',');
669 p1 = strchr(tmp, '-');
671 p1 = strchr(tmp, ':');
683 if (!check_range_bytes(p1, &ul1, data) &&
684 !check_range_bytes(p2, &ul2, data)) {
687 unsigned long foo = ul1;
695 *(unsigned int *) o->roff1 = ul1;
697 val_store(ilp, ul1, o->off1, 0, data);
699 *(unsigned int *) o->roff2 = ul2;
701 val_store(ilp, ul2, o->off2, 0, data);
704 if (o->roff3 && o->roff4) {
705 *(unsigned int *) o->roff3 = ul1;
706 *(unsigned int *) o->roff4 = ul2;
707 } else if (o->off3 && o->off4) {
708 val_store(ilp, ul1, o->off3, 0, data);
709 val_store(ilp, ul2, o->off4, 0, data);
713 if (o->roff5 && o->roff6) {
714 *(unsigned int *) o->roff5 = ul1;
715 *(unsigned int *) o->roff6 = ul2;
716 } else if (o->off5 && o->off6) {
717 val_store(ilp, ul1, o->off5, 0, data);
718 val_store(ilp, ul2, o->off6, 0, data);
723 if (o->roff3 && o->roff4) {
724 *(unsigned int *) o->roff3 = ul1;
725 *(unsigned int *) o->roff4 = ul2;
726 } else if (o->off3 && o->off4) {
727 val_store(ilp, ul1, o->off3, 0, data);
728 val_store(ilp, ul2, o->off4, 0, data);
732 if (o->roff5 && o->roff6) {
733 *(unsigned int *) o->roff5 = ul1;
734 *(unsigned int *) o->roff6 = ul2;
735 } else if (o->off5 && o->off6) {
736 val_store(ilp, ul1, o->off5, 0, data);
737 val_store(ilp, ul2, o->off6, 0, data);
746 case FIO_OPT_STR_SET: {
747 fio_opt_int_fn *fn = o->cb;
750 ret = check_int(ptr, &il);
751 else if (o->type == FIO_OPT_BOOL)
756 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
761 if (o->maxval && il > (int) o->maxval) {
762 log_err("max value out of range: %d (%d max)\n",
766 if (o->minval && il < o->minval) {
767 log_err("min value out of range: %d (%d min)\n",
780 *(unsigned int *)o->roff1 = il;
782 val_store(ilp, il, o->off1, 0, data);
786 *(unsigned int *) o->roff2 = il;
788 val_store(ilp, il, o->off2, 0, data);
793 case FIO_OPT_DEPRECATED:
794 log_info("Option %s is deprecated\n", o->name);
798 log_err("Bad option type %u\n", o->type);
806 ret = o->verify(o, data);
808 log_err("Correct format for offending option\n");
809 log_err("%20s: %s\n", o->name, o->help);
810 show_option_help(o, 1);
817 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
819 char *o_ptr, *ptr, *ptr2;
822 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
826 o_ptr = ptr = strdup(__ptr);
829 * See if we have another set of parameters, hidden after a comma.
830 * Do this before parsing this round, to check if we should
831 * copy set 1 options to set 2.
840 (o->type != FIO_OPT_STR_STORE) &&
841 (o->type != FIO_OPT_STR) &&
842 (o->type != FIO_OPT_FLOAT_LIST)) {
843 ptr2 = strchr(ptr, ',');
844 if (ptr2 && *(ptr2 + 1) == '\0')
846 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
848 ptr2 = strchr(ptr, ':');
850 ptr2 = strchr(ptr, '-');
852 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
853 ptr2 = strchr(ptr, ':');
857 * Don't return early if parsing the first option fails - if
858 * we are doing multiple arguments, we can allow the first one
861 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
877 static struct fio_option *get_option(char *opt,
878 struct fio_option *options, char **post)
880 struct fio_option *o;
883 ret = strchr(opt, '=');
889 strip_blank_end(ret);
890 o = find_option(options, ret);
892 o = find_option(options, opt);
899 static int opt_cmp(const void *p1, const void *p2)
901 struct fio_option *o;
908 s = strdup(*((char **) p1));
909 o = get_option(s, __fio_options, &foo);
915 s = strdup(*((char **) p2));
916 o = get_option(s, __fio_options, &foo);
922 return prio2 - prio1;
925 void sort_options(char **opts, struct fio_option *options, int num_opts)
927 __fio_options = options;
928 qsort(opts, num_opts, sizeof(char *), opt_cmp);
929 __fio_options = NULL;
932 int parse_cmd_option(const char *opt, const char *val,
933 struct fio_option *options, void *data)
935 struct fio_option *o;
937 o = find_option(options, opt);
939 log_err("Bad option <%s>\n", opt);
943 if (!handle_option(o, val, data))
946 log_err("fio: failed parsing %s=%s\n", opt, val);
950 int parse_option(char *opt, const char *input,
951 struct fio_option *options, struct fio_option **o, void *data,
957 log_err("fio: failed parsing %s\n", input);
962 *o = get_option(opt, options, &post);
965 int len = strlen(opt);
966 if (opt + len + 1 != post)
967 memmove(opt + len + 1, post, strlen(post));
973 if (handle_option(*o, post, data)) {
974 log_err("fio: failed parsing %s\n", input);
981 if (!strcmp("description", (*o)->name))
986 log_info("--%s%s", (*o)->name, post ? "" : " ");
988 log_info("=%s%s%s ", delim, post, delim);
995 * Option match, levenshtein distance. Handy for not quite remembering what
996 * the option name is.
998 static int string_distance(const char *s1, const char *s2)
1000 unsigned int s1_len = strlen(s1);
1001 unsigned int s2_len = strlen(s2);
1002 unsigned int *p, *q, *r;
1005 p = malloc(sizeof(unsigned int) * (s2_len + 1));
1006 q = malloc(sizeof(unsigned int) * (s2_len + 1));
1009 for (i = 1; i <= s2_len; i++)
1010 p[i] = p[i - 1] + 1;
1012 for (i = 1; i <= s1_len; i++) {
1014 for (j = 1; j <= s2_len; j++) {
1015 unsigned int sub = p[j - 1];
1017 if (s1[i - 1] != s2[j - 1])
1020 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
1033 static struct fio_option *find_child(struct fio_option *options,
1034 struct fio_option *o)
1036 struct fio_option *__o;
1038 for (__o = options + 1; __o->name; __o++)
1039 if (__o->parent && !strcmp(__o->parent, o->name))
1045 static void __print_option(struct fio_option *o, struct fio_option *org,
1059 p += sprintf(p, "%s", " ");
1061 sprintf(p, "%s", o->name);
1063 log_info("%-24s: %s\n", name, o->help);
1066 static void print_option(struct fio_option *o)
1068 struct fio_option *parent;
1069 struct fio_option *__o;
1070 unsigned int printed;
1073 __print_option(o, NULL, 0);
1080 while ((__o = find_child(o, parent)) != NULL) {
1081 __print_option(__o, o, level);
1090 int show_cmd_help(struct fio_option *options, const char *name)
1092 struct fio_option *o, *closest;
1093 unsigned int best_dist = -1U;
1097 if (!name || !strcmp(name, "all"))
1102 for (o = &options[0]; o->name; o++) {
1105 if (o->type == FIO_OPT_DEPRECATED)
1107 if (!exec_profile && o->prof_name)
1109 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1113 if (!strcmp(name, o->name) ||
1114 (o->alias && !strcmp(name, o->alias)))
1119 dist = string_distance(name, o->name);
1120 if (dist < best_dist) {
1127 if (show_all || match) {
1130 log_info("%20s: %s\n", o->name, o->help);
1141 show_option_help(o, 0);
1147 log_err("No such command: %s", name);
1150 * Only print an appropriately close option, one where the edit
1151 * distance isn't too big. Otherwise we get crazy matches.
1153 if (closest && best_dist < 3) {
1154 log_info(" - showing closest match\n");
1155 log_info("%20s: %s\n", closest->name, closest->help);
1156 show_option_help(closest, 0);
1164 * Handle parsing of default parameters.
1166 void fill_default_options(void *data, struct fio_option *options)
1168 struct fio_option *o;
1170 dprint(FD_PARSE, "filling default options\n");
1172 for (o = &options[0]; o->name; o++)
1174 handle_option(o, o->def, data);
1177 void option_init(struct fio_option *o)
1179 if (o->type == FIO_OPT_DEPRECATED)
1181 if (o->type == FIO_OPT_BOOL) {
1185 if (o->type == FIO_OPT_INT) {
1187 o->maxval = UINT_MAX;
1189 if (o->type == FIO_OPT_FLOAT_LIST) {
1193 if (o->type == FIO_OPT_STR_SET && o->def) {
1194 log_err("Option %s: string set option with"
1195 " default will always be true\n", o->name);
1197 if (!o->cb && (!o->off1 && !o->roff1))
1198 log_err("Option %s: neither cb nor offset given\n", o->name);
1200 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1201 o->category = FIO_OPT_C_GENERAL;
1202 o->group = FIO_OPT_G_INVALID;
1204 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1205 o->type == FIO_OPT_STR_MULTI)
1207 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1208 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1209 log_err("Option %s: both cb and offset given\n", o->name);
1214 * Sanitize the options structure. For now it just sets min/max for bool
1215 * values and whether both callback and offsets are given.
1217 void options_init(struct fio_option *options)
1219 struct fio_option *o;
1221 dprint(FD_PARSE, "init options\n");
1223 for (o = &options[0]; o->name; o++) {
1226 o->inv_opt = find_option(options, o->inverse);
1230 void options_free(struct fio_option *options, void *data)
1232 struct fio_option *o;
1235 dprint(FD_PARSE, "free options\n");
1237 for (o = &options[0]; o->name; o++) {
1238 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1241 ptr = td_var(data, o->off1);