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 int posval_sort(struct fio_option *o, struct value_pair *vpmap)
31 const struct value_pair *vp;
34 if (!o->posval[0].ival)
37 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
39 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
40 vp = &o->posval[entries];
41 if (!vp->ival || vp->ival[0] == '\0')
44 memcpy(&vpmap[entries], vp, sizeof(*vp));
47 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
51 static void show_option_range(struct fio_option *o, FILE *out)
53 if (o->type == FIO_OPT_FLOAT_LIST){
54 if (isnan(o->minfp) && isnan(o->maxfp))
57 fprintf(out, "%20s: min=%f", "range", o->minfp);
59 fprintf(out, ", max=%f", o->maxfp);
62 if (!o->minval && !o->maxval)
65 fprintf(out, "%20s: min=%d", "range", o->minval);
67 fprintf(out, ", max=%d", o->maxval);
72 static void show_option_values(struct fio_option *o)
76 for (i = 0; i < PARSE_MAX_VP; i++) {
77 const struct value_pair *vp = &o->posval[i];
82 printf("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
84 printf(" %s", vp->help);
92 static void show_option_help(struct fio_option *o, FILE *out)
94 const char *typehelp[] = {
98 "string with possible k/m/g postfix (opt=4k)",
99 "string with time postfix (opt=10s)",
101 "string with dual range (opt=1k-4k,4k-8k)",
102 "integer value (opt=100)",
103 "boolean value (opt=1)",
104 "list of floating point values separated by ':' (opt=5.9:7.8)",
110 fprintf(out, "%20s: %s\n", "alias", o->alias);
112 fprintf(out, "%20s: %s\n", "type", typehelp[o->type]);
113 fprintf(out, "%20s: %s\n", "default", o->def ? o->def : "no default");
115 fprintf(out, "%20s: only for profile '%s'\n", "valid", o->prof_name);
116 show_option_range(o, stdout);
117 show_option_values(o);
120 static unsigned long get_mult_time(char c)
137 static unsigned long long __get_mult_bytes(const char *p, void *data,
140 unsigned int kb_base = fio_get_kb_base(data);
141 unsigned long long ret = 1;
142 unsigned int i, pow = 0, mult = kb_base;
150 for (i = 0; i < strlen(c); i++)
151 c[i] = tolower(c[i]);
153 if (!strcmp("pib", c)) {
156 } else if (!strcmp("tib", c)) {
159 } else if (!strcmp("gib", c)) {
162 } else if (!strcmp("mib", c)) {
165 } else if (!strcmp("kib", c)) {
168 } else if (!strcmp("p", c) || !strcmp("pb", c))
170 else if (!strcmp("t", c) || !strcmp("tb", c))
172 else if (!strcmp("g", c) || !strcmp("gb", c))
174 else if (!strcmp("m", c) || !strcmp("mb", c))
176 else if (!strcmp("k", c) || !strcmp("kb", c))
178 else if (!strcmp("%", c)) {
184 ret *= (unsigned long long) mult;
190 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
196 return __get_mult_bytes(str, data, percent);
199 * Go forward until we hit a non-digit
201 while ((p - str) <= len) {
202 if (!isdigit((int) *p))
207 if (!isalpha((int) *p) && (*p != '%'))
210 return __get_mult_bytes(p, data, percent);
214 * Convert string into a floating number. Return 1 for success and 0 otherwise.
216 int str_to_float(const char *str, double *val)
218 return (1 == sscanf(str, "%lf", val));
222 * convert string into decimal value, noting any size suffix
224 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
232 if (strstr(str, "0x") || strstr(str, "0X"))
237 *val = strtoll(str, NULL, base);
238 if (*val == LONG_MAX && errno == ERANGE)
242 unsigned long long mult;
245 mult = get_mult_bytes(str, len, data, &perc);
251 *val *= get_mult_time(str[len - 1]);
256 static int check_str_bytes(const char *p, long long *val, void *data)
258 return str_to_decimal(p, val, 1, data);
261 static int check_str_time(const char *p, long long *val)
263 return str_to_decimal(p, val, 0, NULL);
266 void strip_blank_front(char **p)
270 while (isspace((int) *s))
276 void strip_blank_end(char *p)
290 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
296 static int check_range_bytes(const char *str, long *val, void *data)
300 if (!str_to_decimal(str, &__val, 1, data)) {
308 static int check_int(const char *p, int *val)
312 if (strstr(p, "0x") || strstr(p, "0X")) {
313 if (sscanf(p, "%x", val) == 1)
316 if (sscanf(p, "%u", val) == 1)
323 static int opt_len(const char *str)
327 postfix = strchr(str, ':');
331 return (int)(postfix - str);
334 #define val_store(ptr, val, off, or, data) \
336 ptr = td_var((data), (off)); \
343 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
344 int first, int more, int curr)
348 long long ull, *ullp;
352 int ret = 0, is_time = 0;
353 const struct value_pair *vp;
354 struct value_pair posval[PARSE_MAX_VP];
355 int i, all_skipped = 1;
357 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
360 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
361 fprintf(stderr, "Option %s requires an argument\n", o->name);
367 case FIO_OPT_STR_MULTI: {
368 fio_opt_str_fn *fn = o->cb;
370 posval_sort(o, posval);
373 for (i = 0; i < PARSE_MAX_VP; i++) {
375 if (!vp->ival || vp->ival[0] == '\0')
378 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
382 *(unsigned int *) o->roff1 |= vp->oval;
384 *(unsigned int *) o->roff1 = vp->oval;
388 val_store(ilp, vp->oval, o->off1, vp->or, data);
394 if (ret && !all_skipped)
395 show_option_values(o);
400 case FIO_OPT_STR_VAL_TIME:
403 case FIO_OPT_STR_VAL: {
404 fio_opt_str_val_fn *fn = o->cb;
407 ret = check_str_time(ptr, &ull);
409 ret = check_str_bytes(ptr, &ull, data);
414 if (o->maxval && ull > o->maxval) {
415 fprintf(stderr, "max value out of range: %lld"
416 " (%d max)\n", ull, o->maxval);
419 if (o->minval && ull < o->minval) {
420 fprintf(stderr, "min value out of range: %lld"
421 " (%d min)\n", ull, o->minval);
426 ret = fn(data, &ull);
428 if (o->type == FIO_OPT_INT) {
431 *(unsigned int *) o->roff1 = ull;
433 val_store(ilp, ull, o->off1, 0, data);
437 *(unsigned int *) o->roff2 = ull;
439 val_store(ilp, ull, o->off2, 0, data);
444 *(unsigned long long *) o->roff1 = ull;
446 val_store(ullp, ull, o->off1, 0, data);
450 *(unsigned long long *) o->roff2 = ull;
452 val_store(ullp, ull, o->off2, 0, data);
458 case FIO_OPT_FLOAT_LIST: {
462 ilp = td_var(data, o->off2);
465 if (curr >= o->maxlen) {
466 fprintf(stderr, "the list exceeding max length %d\n",
470 if(!str_to_float(ptr, &uf)){
471 fprintf(stderr, "not a floating point value: %s\n",
475 if (!isnan(o->maxfp) && uf > o->maxfp) {
476 fprintf(stderr, "value out of range: %f"
477 " (range max: %f)\n", uf, o->maxfp);
480 if (!isnan(o->minfp) && uf < o->minfp) {
481 fprintf(stderr, "value out of range: %f"
482 " (range min: %f)\n", uf, o->minfp);
486 flp = td_var(data, o->off1);
491 case FIO_OPT_STR_STORE: {
492 fio_opt_str_fn *fn = o->cb;
494 if (!posval_sort(o, posval)) {
496 cp = (char **) o->roff1;
498 cp = td_var(data, o->off1);
508 for (i = 0; i < PARSE_MAX_VP; i++) {
510 if (!vp->ival || vp->ival[0] == '\0')
513 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
520 cp = (char **) o->roff1;
522 cp = td_var(data, o->off1);
524 rest = strstr(*cp, ":");
534 if (ret && !all_skipped)
535 show_option_values(o);
541 case FIO_OPT_RANGE: {
545 strncpy(tmp, ptr, sizeof(tmp) - 1);
547 /* Handle bsrange with separate read,write values: */
548 p1 = strchr(tmp, ',');
552 p1 = strchr(tmp, '-');
554 p1 = strchr(tmp, ':');
566 if (!check_range_bytes(p1, &ul1, data) &&
567 !check_range_bytes(p2, &ul2, data)) {
570 unsigned long foo = ul1;
578 *(unsigned int *) o->roff1 = ul1;
580 val_store(ilp, ul1, o->off1, 0, data);
582 *(unsigned int *) o->roff2 = ul2;
584 val_store(ilp, ul2, o->off2, 0, data);
586 if (o->roff3 && o->roff4) {
587 *(unsigned int *) o->roff3 = ul1;
588 *(unsigned int *) o->roff4 = ul2;
589 } else if (o->off3 && o->off4) {
590 val_store(ilp, ul1, o->off3, 0, data);
591 val_store(ilp, ul2, o->off4, 0, data);
598 case FIO_OPT_STR_SET: {
599 fio_opt_int_fn *fn = o->cb;
602 ret = check_int(ptr, &il);
603 else if (o->type == FIO_OPT_BOOL)
611 if (o->maxval && il > (int) o->maxval) {
612 fprintf(stderr, "max value out of range: %d (%d max)\n",
616 if (o->minval && il < o->minval) {
617 fprintf(stderr, "min value out of range: %d (%d min)\n",
630 *(unsigned int *)o->roff1 = il;
632 val_store(ilp, il, o->off1, 0, data);
636 *(unsigned int *) o->roff2 = il;
638 val_store(ilp, il, o->off2, 0, data);
643 case FIO_OPT_DEPRECATED:
644 fprintf(stdout, "Option %s is deprecated\n", o->name);
647 fprintf(stderr, "Bad option type %u\n", o->type);
655 ret = o->verify(o, data);
657 fprintf(stderr,"Correct format for offending option\n");
658 fprintf(stderr, "%20s: %s\n", o->name, o->help);
659 show_option_help(o, stderr);
666 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
668 char *o_ptr, *ptr, *ptr2;
671 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
675 o_ptr = ptr = strdup(__ptr);
678 * See if we have another set of parameters, hidden after a comma.
679 * Do this before parsing this round, to check if we should
680 * copy set 1 options to set 2.
689 (o->type != FIO_OPT_STR_STORE) &&
690 (o->type != FIO_OPT_STR) &&
691 (o->type != FIO_OPT_FLOAT_LIST)) {
692 ptr2 = strchr(ptr, ',');
693 if (ptr2 && *(ptr2 + 1) == '\0')
695 if (o->type != FIO_OPT_STR_MULTI) {
697 ptr2 = strchr(ptr, ':');
699 ptr2 = strchr(ptr, '-');
701 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
702 ptr2 = strchr(ptr, ':');
706 * Don't return early if parsing the first option fails - if
707 * we are doing multiple arguments, we can allow the first one
710 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
726 static struct fio_option *get_option(const char *opt,
727 struct fio_option *options, char **post)
729 struct fio_option *o;
732 ret = strchr(opt, '=');
738 strip_blank_end(ret);
739 o = find_option(options, ret);
741 o = find_option(options, opt);
748 static int opt_cmp(const void *p1, const void *p2)
750 struct fio_option *o1, *o2;
754 s1 = strdup(*((char **) p1));
755 s2 = strdup(*((char **) p2));
757 o1 = get_option(s1, fio_options, &foo);
758 o2 = get_option(s2, fio_options, &foo);
768 return prio2 - prio1;
771 void sort_options(char **opts, struct fio_option *options, int num_opts)
773 fio_options = options;
774 qsort(opts, num_opts, sizeof(char *), opt_cmp);
778 int parse_cmd_option(const char *opt, const char *val,
779 struct fio_option *options, void *data)
781 struct fio_option *o;
783 o = find_option(options, opt);
785 fprintf(stderr, "Bad option <%s>\n", opt);
789 if (!handle_option(o, val, data))
792 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
797 * Return a copy of the input string with substrings of the form ${VARNAME}
798 * substituted with the value of the environment variable VARNAME. The
799 * substitution always occurs, even if VARNAME is empty or the corresponding
800 * environment variable undefined.
802 static char *option_dup_subs(const char *opt)
804 char out[OPT_LEN_MAX+1];
805 char in[OPT_LEN_MAX+1];
808 char *ch1, *ch2, *env;
809 ssize_t nchr = OPT_LEN_MAX;
812 if (strlen(opt) + 1 > OPT_LEN_MAX) {
813 fprintf(stderr, "OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
817 in[OPT_LEN_MAX] = '\0';
818 strncpy(in, opt, OPT_LEN_MAX);
820 while (*inptr && nchr > 0) {
821 if (inptr[0] == '$' && inptr[1] == '{') {
822 ch2 = strchr(inptr, '}');
823 if (ch2 && inptr+1 < ch2) {
830 envlen = strlen(env);
831 if (envlen <= nchr) {
832 memcpy(outptr, env, envlen);
842 *outptr++ = *inptr++;
850 int parse_option(const char *opt, struct fio_option *options, void *data)
852 struct fio_option *o;
855 tmp = option_dup_subs(opt);
859 o = get_option(tmp, options, &post);
861 fprintf(stderr, "Bad option <%s>\n", tmp);
866 if (!handle_option(o, post, data)) {
871 fprintf(stderr, "fio: failed parsing %s\n", opt);
877 * Option match, levenshtein distance. Handy for not quite remembering what
878 * the option name is.
880 static int string_distance(const char *s1, const char *s2)
882 unsigned int s1_len = strlen(s1);
883 unsigned int s2_len = strlen(s2);
884 unsigned int *p, *q, *r;
887 p = malloc(sizeof(unsigned int) * (s2_len + 1));
888 q = malloc(sizeof(unsigned int) * (s2_len + 1));
891 for (i = 1; i <= s2_len; i++)
894 for (i = 1; i <= s1_len; i++) {
896 for (j = 1; j <= s2_len; j++) {
897 unsigned int sub = p[j - 1];
899 if (s1[i - 1] != s2[j - 1])
902 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
915 static struct fio_option *find_child(struct fio_option *options,
916 struct fio_option *o)
918 struct fio_option *__o;
920 for (__o = options + 1; __o->name; __o++)
921 if (__o->parent && !strcmp(__o->parent, o->name))
927 static void __print_option(struct fio_option *o, struct fio_option *org,
941 p += sprintf(p, "%s", " ");
943 sprintf(p, "%s", o->name);
945 printf("%-24s: %s\n", name, o->help);
948 static void print_option(struct fio_option *o)
950 struct fio_option *parent;
951 struct fio_option *__o;
952 unsigned int printed;
955 __print_option(o, NULL, 0);
962 while ((__o = find_child(o, parent)) != NULL) {
963 __print_option(__o, o, level);
972 int show_cmd_help(struct fio_option *options, const char *name)
974 struct fio_option *o, *closest;
975 unsigned int best_dist = -1U;
979 if (!name || !strcmp(name, "all"))
984 for (o = &options[0]; o->name; o++) {
987 if (o->type == FIO_OPT_DEPRECATED)
989 if (!exec_profile && o->prof_name)
993 if (!strcmp(name, o->name) ||
994 (o->alias && !strcmp(name, o->alias)))
999 dist = string_distance(name, o->name);
1000 if (dist < best_dist) {
1007 if (show_all || match) {
1010 printf("%20s: %s\n", o->name, o->help);
1021 show_option_help(o, stdout);
1027 printf("No such command: %s", name);
1030 * Only print an appropriately close option, one where the edit
1031 * distance isn't too big. Otherwise we get crazy matches.
1033 if (closest && best_dist < 3) {
1034 printf(" - showing closest match\n");
1035 printf("%20s: %s\n", closest->name, closest->help);
1036 show_option_help(closest, stdout);
1044 * Handle parsing of default parameters.
1046 void fill_default_options(void *data, struct fio_option *options)
1048 struct fio_option *o;
1050 dprint(FD_PARSE, "filling default options\n");
1052 for (o = &options[0]; o->name; o++)
1054 handle_option(o, o->def, data);
1057 void option_init(struct fio_option *o)
1059 if (o->type == FIO_OPT_DEPRECATED)
1061 if (o->type == FIO_OPT_BOOL) {
1065 if (o->type == FIO_OPT_FLOAT_LIST) {
1069 if (o->type == FIO_OPT_STR_SET && o->def) {
1070 fprintf(stderr, "Option %s: string set option with"
1071 " default will always be true\n", o->name);
1073 if (!o->cb && (!o->off1 && !o->roff1)) {
1074 fprintf(stderr, "Option %s: neither cb nor offset given\n",
1077 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1078 o->type == FIO_OPT_STR_MULTI)
1080 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1081 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1082 fprintf(stderr, "Option %s: both cb and offset given\n",
1088 * Sanitize the options structure. For now it just sets min/max for bool
1089 * values and whether both callback and offsets are given.
1091 void options_init(struct fio_option *options)
1093 struct fio_option *o;
1095 dprint(FD_PARSE, "init options\n");
1097 for (o = &options[0]; o->name; o++)