2 * This file contains the ini and command liner parser main.
18 static struct fio_option *fio_options;
19 extern unsigned int fio_get_kb_base(void *);
21 static int vp_cmp(const void *p1, const void *p2)
23 const struct value_pair *vp1 = p1;
24 const struct value_pair *vp2 = p2;
26 return strlen(vp2->ival) - strlen(vp1->ival);
29 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
31 const struct value_pair *vp;
34 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
36 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
37 vp = &o->posval[entries];
38 if (!vp->ival || vp->ival[0] == '\0')
41 memcpy(&vpmap[entries], vp, sizeof(*vp));
44 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
47 static void show_option_range(struct fio_option *o,
48 int (*logger)(const char *format, ...))
50 if (o->type == FIO_OPT_FLOAT_LIST){
51 if (isnan(o->minfp) && isnan(o->maxfp))
54 logger("%20s: min=%f", "range", o->minfp);
56 logger(", max=%f", o->maxfp);
59 if (!o->minval && !o->maxval)
62 logger("%20s: min=%d", "range", o->minval);
64 logger(", max=%d", o->maxval);
69 static void show_option_values(struct fio_option *o)
73 for (i = 0; i < PARSE_MAX_VP; i++) {
74 const struct value_pair *vp = &o->posval[i];
79 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
81 log_info(" %s", vp->help);
89 static void show_option_help(struct fio_option *o, int is_err)
91 const char *typehelp[] = {
95 "string with possible k/m/g postfix (opt=4k)",
96 "string with time postfix (opt=10s)",
98 "string with dual range (opt=1k-4k,4k-8k)",
99 "integer value (opt=100)",
100 "boolean value (opt=1)",
101 "list of floating point values separated by ':' (opt=5.9:7.8)",
105 int (*logger)(const char *format, ...);
113 logger("%20s: %s\n", "alias", o->alias);
115 logger("%20s: %s\n", "type", typehelp[o->type]);
116 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
118 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
119 show_option_range(o, logger);
120 show_option_values(o);
123 static unsigned long get_mult_time(char c)
140 static unsigned long long __get_mult_bytes(const char *p, void *data,
143 unsigned int kb_base = fio_get_kb_base(data);
144 unsigned long long ret = 1;
145 unsigned int i, pow = 0, mult = kb_base;
153 for (i = 0; i < strlen(c); i++)
154 c[i] = tolower(c[i]);
156 if (!strcmp("pib", c)) {
159 } else if (!strcmp("tib", c)) {
162 } else if (!strcmp("gib", c)) {
165 } else if (!strcmp("mib", c)) {
168 } else if (!strcmp("kib", c)) {
171 } else if (!strcmp("p", c) || !strcmp("pb", c))
173 else if (!strcmp("t", c) || !strcmp("tb", c))
175 else if (!strcmp("g", c) || !strcmp("gb", c))
177 else if (!strcmp("m", c) || !strcmp("mb", c))
179 else if (!strcmp("k", c) || !strcmp("kb", c))
181 else if (!strcmp("%", c)) {
187 ret *= (unsigned long long) mult;
193 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
200 return __get_mult_bytes(str, data, percent);
203 * Go forward until we hit a non-digit, or +/- sign
205 while ((p - str) <= len) {
206 if (!isdigit((int) *p) &&
207 (((*p != '+') && (*p != '-')) || digit_seen))
209 digit_seen |= isdigit((int) *p);
213 if (!isalpha((int) *p) && (*p != '%'))
216 return __get_mult_bytes(p, data, percent);
220 * Convert string into a floating number. Return 1 for success and 0 otherwise.
222 int str_to_float(const char *str, double *val)
224 return (1 == sscanf(str, "%lf", val));
228 * convert string into decimal value, noting any size suffix
230 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
238 if (strstr(str, "0x") || strstr(str, "0X"))
243 *val = strtoll(str, NULL, base);
244 if (*val == LONG_MAX && errno == ERANGE)
248 unsigned long long mult;
251 mult = get_mult_bytes(str, len, data, &perc);
257 *val *= get_mult_time(str[len - 1]);
262 static int check_str_bytes(const char *p, long long *val, void *data)
264 return str_to_decimal(p, val, 1, data);
267 static int check_str_time(const char *p, long long *val)
269 return str_to_decimal(p, val, 0, NULL);
272 void strip_blank_front(char **p)
278 while (isspace((int) *s))
284 void strip_blank_end(char *p)
301 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
307 static int check_range_bytes(const char *str, long *val, void *data)
311 if (!str_to_decimal(str, &__val, 1, data)) {
319 static int check_int(const char *p, int *val)
323 if (strstr(p, "0x") || strstr(p, "0X")) {
324 if (sscanf(p, "%x", val) == 1)
327 if (sscanf(p, "%u", val) == 1)
334 static int opt_len(const char *str)
338 postfix = strchr(str, ':');
342 return (int)(postfix - str);
345 #define val_store(ptr, val, off, or, data) \
347 ptr = td_var((data), (off)); \
354 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
355 int first, int more, int curr)
359 long long ull, *ullp;
363 int ret = 0, is_time = 0;
364 const struct value_pair *vp;
365 struct value_pair posval[PARSE_MAX_VP];
366 int i, all_skipped = 1;
368 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
371 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
372 log_err("Option %s requires an argument\n", o->name);
378 case FIO_OPT_STR_MULTI: {
379 fio_opt_str_fn *fn = o->cb;
381 posval_sort(o, posval);
384 for (i = 0; i < PARSE_MAX_VP; i++) {
386 if (!vp->ival || vp->ival[0] == '\0')
389 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
393 *(unsigned int *) o->roff1 |= vp->oval;
395 *(unsigned int *) o->roff1 = vp->oval;
399 val_store(ilp, vp->oval, o->off1, vp->or, data);
405 if (ret && !all_skipped)
406 show_option_values(o);
411 case FIO_OPT_STR_VAL_TIME:
414 case FIO_OPT_STR_VAL: {
415 fio_opt_str_val_fn *fn = o->cb;
418 ret = check_str_time(ptr, &ull);
420 ret = check_str_bytes(ptr, &ull, data);
425 if (o->maxval && ull > o->maxval) {
426 log_err("max value out of range: %lld"
427 " (%d max)\n", ull, o->maxval);
430 if (o->minval && ull < o->minval) {
431 log_err("min value out of range: %lld"
432 " (%d min)\n", ull, o->minval);
437 ret = fn(data, &ull);
439 if (o->type == FIO_OPT_INT) {
442 *(unsigned int *) o->roff1 = ull;
444 val_store(ilp, ull, o->off1, 0, data);
448 *(unsigned int *) o->roff2 = ull;
450 val_store(ilp, ull, o->off2, 0, data);
455 *(unsigned long long *) o->roff1 = ull;
457 val_store(ullp, ull, o->off1, 0, data);
461 *(unsigned long long *) o->roff2 = ull;
463 val_store(ullp, ull, o->off2, 0, data);
469 case FIO_OPT_FLOAT_LIST: {
473 ilp = td_var(data, o->off2);
476 if (curr >= o->maxlen) {
477 log_err("the list exceeding max length %d\n",
481 if(!str_to_float(ptr, &uf)){
482 log_err("not a floating point value: %s\n", ptr);
485 if (!isnan(o->maxfp) && uf > o->maxfp) {
486 log_err("value out of range: %f"
487 " (range max: %f)\n", uf, o->maxfp);
490 if (!isnan(o->minfp) && uf < o->minfp) {
491 log_err("value out of range: %f"
492 " (range min: %f)\n", uf, o->minfp);
496 flp = td_var(data, o->off1);
501 case FIO_OPT_STR_STORE: {
502 fio_opt_str_fn *fn = o->cb;
504 posval_sort(o, posval);
506 if (!o->posval[0].ival) {
512 for (i = 0; i < PARSE_MAX_VP; i++) {
514 if (!vp->ival || vp->ival[0] == '\0')
517 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
525 cp = (char **) o->roff1;
527 cp = td_var(data, o->off1);
529 rest = strstr(*cp, ":");
533 } else if (vp && vp->cb)
539 if (ret && !all_skipped)
540 show_option_values(o);
546 case FIO_OPT_RANGE: {
550 strncpy(tmp, ptr, sizeof(tmp) - 1);
552 /* Handle bsrange with separate read,write values: */
553 p1 = strchr(tmp, ',');
557 p1 = strchr(tmp, '-');
559 p1 = strchr(tmp, ':');
571 if (!check_range_bytes(p1, &ul1, data) &&
572 !check_range_bytes(p2, &ul2, data)) {
575 unsigned long foo = ul1;
583 *(unsigned int *) o->roff1 = ul1;
585 val_store(ilp, ul1, o->off1, 0, data);
587 *(unsigned int *) o->roff2 = ul2;
589 val_store(ilp, ul2, o->off2, 0, data);
591 if (o->roff3 && o->roff4) {
592 *(unsigned int *) o->roff3 = ul1;
593 *(unsigned int *) o->roff4 = ul2;
594 } else if (o->off3 && o->off4) {
595 val_store(ilp, ul1, o->off3, 0, data);
596 val_store(ilp, ul2, o->off4, 0, data);
603 case FIO_OPT_STR_SET: {
604 fio_opt_int_fn *fn = o->cb;
607 ret = check_int(ptr, &il);
608 else if (o->type == FIO_OPT_BOOL)
616 if (o->maxval && il > (int) o->maxval) {
617 log_err("max value out of range: %d (%d max)\n",
621 if (o->minval && il < o->minval) {
622 log_err("min value out of range: %d (%d min)\n",
635 *(unsigned int *)o->roff1 = il;
637 val_store(ilp, il, o->off1, 0, data);
641 *(unsigned int *) o->roff2 = il;
643 val_store(ilp, il, o->off2, 0, data);
648 case FIO_OPT_DEPRECATED:
649 log_info("Option %s is deprecated\n", o->name);
652 log_err("Bad option type %u\n", o->type);
660 ret = o->verify(o, data);
662 log_err("Correct format for offending option\n");
663 log_err("%20s: %s\n", o->name, o->help);
664 show_option_help(o, 1);
671 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
673 char *o_ptr, *ptr, *ptr2;
676 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
680 o_ptr = ptr = strdup(__ptr);
683 * See if we have another set of parameters, hidden after a comma.
684 * Do this before parsing this round, to check if we should
685 * copy set 1 options to set 2.
694 (o->type != FIO_OPT_STR_STORE) &&
695 (o->type != FIO_OPT_STR) &&
696 (o->type != FIO_OPT_FLOAT_LIST)) {
697 ptr2 = strchr(ptr, ',');
698 if (ptr2 && *(ptr2 + 1) == '\0')
700 if (o->type != FIO_OPT_STR_MULTI) {
702 ptr2 = strchr(ptr, ':');
704 ptr2 = strchr(ptr, '-');
706 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
707 ptr2 = strchr(ptr, ':');
711 * Don't return early if parsing the first option fails - if
712 * we are doing multiple arguments, we can allow the first one
715 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
731 static struct fio_option *get_option(const char *opt,
732 struct fio_option *options, char **post)
734 struct fio_option *o;
737 ret = strchr(opt, '=');
743 strip_blank_end(ret);
744 o = find_option(options, ret);
746 o = find_option(options, opt);
753 static int opt_cmp(const void *p1, const void *p2)
755 struct fio_option *o1, *o2;
759 s1 = strdup(*((char **) p1));
760 s2 = strdup(*((char **) p2));
762 o1 = get_option(s1, fio_options, &foo);
763 o2 = get_option(s2, fio_options, &foo);
773 return prio2 - prio1;
776 void sort_options(char **opts, struct fio_option *options, int num_opts)
778 fio_options = options;
779 qsort(opts, num_opts, sizeof(char *), opt_cmp);
783 int parse_cmd_option(const char *opt, const char *val,
784 struct fio_option *options, void *data)
786 struct fio_option *o;
788 o = find_option(options, opt);
790 log_err("Bad option <%s>\n", opt);
794 if (!handle_option(o, val, data))
797 log_err("fio: failed parsing %s=%s\n", opt, val);
802 * Return a copy of the input string with substrings of the form ${VARNAME}
803 * substituted with the value of the environment variable VARNAME. The
804 * substitution always occurs, even if VARNAME is empty or the corresponding
805 * environment variable undefined.
807 static char *option_dup_subs(const char *opt)
809 char out[OPT_LEN_MAX+1];
810 char in[OPT_LEN_MAX+1];
813 char *ch1, *ch2, *env;
814 ssize_t nchr = OPT_LEN_MAX;
817 if (strlen(opt) + 1 > OPT_LEN_MAX) {
818 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
822 in[OPT_LEN_MAX] = '\0';
823 strncpy(in, opt, OPT_LEN_MAX);
825 while (*inptr && nchr > 0) {
826 if (inptr[0] == '$' && inptr[1] == '{') {
827 ch2 = strchr(inptr, '}');
828 if (ch2 && inptr+1 < ch2) {
835 envlen = strlen(env);
836 if (envlen <= nchr) {
837 memcpy(outptr, env, envlen);
847 *outptr++ = *inptr++;
855 int parse_option(const char *opt, struct fio_option *options, void *data)
857 struct fio_option *o;
860 tmp = option_dup_subs(opt);
864 o = get_option(tmp, options, &post);
866 log_err("Bad option <%s>\n", tmp);
871 if (!handle_option(o, post, data)) {
876 log_err("fio: failed parsing %s\n", opt);
882 * Option match, levenshtein distance. Handy for not quite remembering what
883 * the option name is.
885 static int string_distance(const char *s1, const char *s2)
887 unsigned int s1_len = strlen(s1);
888 unsigned int s2_len = strlen(s2);
889 unsigned int *p, *q, *r;
892 p = malloc(sizeof(unsigned int) * (s2_len + 1));
893 q = malloc(sizeof(unsigned int) * (s2_len + 1));
896 for (i = 1; i <= s2_len; i++)
899 for (i = 1; i <= s1_len; i++) {
901 for (j = 1; j <= s2_len; j++) {
902 unsigned int sub = p[j - 1];
904 if (s1[i - 1] != s2[j - 1])
907 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
920 static struct fio_option *find_child(struct fio_option *options,
921 struct fio_option *o)
923 struct fio_option *__o;
925 for (__o = options + 1; __o->name; __o++)
926 if (__o->parent && !strcmp(__o->parent, o->name))
932 static void __print_option(struct fio_option *o, struct fio_option *org,
946 p += sprintf(p, "%s", " ");
948 sprintf(p, "%s", o->name);
950 log_info("%-24s: %s\n", name, o->help);
953 static void print_option(struct fio_option *o)
955 struct fio_option *parent;
956 struct fio_option *__o;
957 unsigned int printed;
960 __print_option(o, NULL, 0);
967 while ((__o = find_child(o, parent)) != NULL) {
968 __print_option(__o, o, level);
977 int show_cmd_help(struct fio_option *options, const char *name)
979 struct fio_option *o, *closest;
980 unsigned int best_dist = -1U;
984 if (!name || !strcmp(name, "all"))
989 for (o = &options[0]; o->name; o++) {
992 if (o->type == FIO_OPT_DEPRECATED)
994 if (!exec_profile && o->prof_name)
998 if (!strcmp(name, o->name) ||
999 (o->alias && !strcmp(name, o->alias)))
1004 dist = string_distance(name, o->name);
1005 if (dist < best_dist) {
1012 if (show_all || match) {
1015 log_info("%20s: %s\n", o->name, o->help);
1026 show_option_help(o, 0);
1032 log_err("No such command: %s", name);
1035 * Only print an appropriately close option, one where the edit
1036 * distance isn't too big. Otherwise we get crazy matches.
1038 if (closest && best_dist < 3) {
1039 log_info(" - showing closest match\n");
1040 log_info("%20s: %s\n", closest->name, closest->help);
1041 show_option_help(closest, 0);
1049 * Handle parsing of default parameters.
1051 void fill_default_options(void *data, struct fio_option *options)
1053 struct fio_option *o;
1055 dprint(FD_PARSE, "filling default options\n");
1057 for (o = &options[0]; o->name; o++)
1059 handle_option(o, o->def, data);
1062 void option_init(struct fio_option *o)
1064 if (o->type == FIO_OPT_DEPRECATED)
1066 if (o->type == FIO_OPT_BOOL) {
1070 if (o->type == FIO_OPT_FLOAT_LIST) {
1074 if (o->type == FIO_OPT_STR_SET && o->def) {
1075 log_err("Option %s: string set option with"
1076 " default will always be true\n", o->name);
1078 if (!o->cb && (!o->off1 && !o->roff1))
1079 log_err("Option %s: neither cb nor offset given\n", o->name);
1080 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1081 o->type == FIO_OPT_STR_MULTI)
1083 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1084 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1085 log_err("Option %s: both cb and offset given\n", o->name);
1090 * Sanitize the options structure. For now it just sets min/max for bool
1091 * values and whether both callback and offsets are given.
1093 void options_init(struct fio_option *options)
1095 struct fio_option *o;
1097 dprint(FD_PARSE, "init options\n");
1099 for (o = &options[0]; o->name; o++)
1103 void options_free(struct fio_option *options, void *data)
1105 struct fio_option *o;
1108 dprint(FD_PARSE, "free options\n");
1110 for (o = &options[0]; o->name; o++) {
1111 if (o->type != FIO_OPT_STR_STORE)
1114 ptr = td_var(data, o->off1);