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, FILE *out)
49 if (o->type == FIO_OPT_FLOAT_LIST){
50 if (isnan(o->minfp) && isnan(o->maxfp))
53 fprintf(out, "%20s: min=%f", "range", o->minfp);
55 fprintf(out, ", max=%f", o->maxfp);
58 if (!o->minval && !o->maxval)
61 fprintf(out, "%20s: min=%d", "range", o->minval);
63 fprintf(out, ", max=%d", o->maxval);
68 static void show_option_values(struct fio_option *o)
72 for (i = 0; i < PARSE_MAX_VP; i++) {
73 const struct value_pair *vp = &o->posval[i];
78 printf("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
80 printf(" %s", vp->help);
88 static void show_option_help(struct fio_option *o, FILE *out)
90 const char *typehelp[] = {
94 "string with possible k/m/g postfix (opt=4k)",
95 "string with time postfix (opt=10s)",
97 "string with dual range (opt=1k-4k,4k-8k)",
98 "integer value (opt=100)",
99 "boolean value (opt=1)",
100 "list of floating point values separated by ':' (opt=5.9:7.8)",
106 fprintf(out, "%20s: %s\n", "alias", o->alias);
108 fprintf(out, "%20s: %s\n", "type", typehelp[o->type]);
109 fprintf(out, "%20s: %s\n", "default", o->def ? o->def : "no default");
111 fprintf(out, "%20s: only for profile '%s'\n", "valid", o->prof_name);
112 show_option_range(o, stdout);
113 show_option_values(o);
116 static unsigned long get_mult_time(char c)
133 static unsigned long long __get_mult_bytes(const char *p, void *data,
136 unsigned int kb_base = fio_get_kb_base(data);
137 unsigned long long ret = 1;
138 unsigned int i, pow = 0, mult = kb_base;
146 for (i = 0; i < strlen(c); i++)
147 c[i] = tolower(c[i]);
149 if (!strcmp("pib", c)) {
152 } else if (!strcmp("tib", c)) {
155 } else if (!strcmp("gib", c)) {
158 } else if (!strcmp("mib", c)) {
161 } else if (!strcmp("kib", c)) {
164 } else if (!strcmp("p", c) || !strcmp("pb", c))
166 else if (!strcmp("t", c) || !strcmp("tb", c))
168 else if (!strcmp("g", c) || !strcmp("gb", c))
170 else if (!strcmp("m", c) || !strcmp("mb", c))
172 else if (!strcmp("k", c) || !strcmp("kb", c))
174 else if (!strcmp("%", c)) {
180 ret *= (unsigned long long) mult;
186 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
187 int *percent, int is_range)
192 return __get_mult_bytes(str, data, percent);
195 * Go forward until we hit a non-digit, or +/- sign
197 while ((p - str) <= len) {
198 if (!isdigit((int) *p) && (*p != '+'))
200 if (!is_range && (*p != '-'))
205 if (!isalpha((int) *p) && (*p != '%'))
208 return __get_mult_bytes(p, data, percent);
212 * Convert string into a floating number. Return 1 for success and 0 otherwise.
214 int str_to_float(const char *str, double *val)
216 return (1 == sscanf(str, "%lf", val));
220 * convert string into decimal value, noting any size suffix
222 int str_to_decimal(const char *str, long long *val, int kilo, int is_range, void *data)
230 if (strstr(str, "0x") || strstr(str, "0X"))
235 *val = strtoll(str, NULL, base);
236 if (*val == LONG_MAX && errno == ERANGE)
240 unsigned long long mult;
243 mult = get_mult_bytes(str, len, data, &perc, is_range);
249 *val *= get_mult_time(str[len - 1]);
254 static int check_str_bytes(const char *p, long long *val, int is_range, void *data)
256 return str_to_decimal(p, val, 1, is_range, data);
259 static int check_str_time(const char *p, long long *val)
261 return str_to_decimal(p, val, 0, 0, NULL);
264 void strip_blank_front(char **p)
268 while (isspace((int) *s))
274 void strip_blank_end(char *p)
288 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
294 static int check_range_bytes(const char *str, long *val, void *data)
298 if (!str_to_decimal(str, &__val, 1, 1, data)) {
306 static int check_int(const char *p, int *val)
310 if (strstr(p, "0x") || strstr(p, "0X")) {
311 if (sscanf(p, "%x", val) == 1)
314 if (sscanf(p, "%u", val) == 1)
321 static int opt_len(const char *str)
325 postfix = strchr(str, ':');
329 return (int)(postfix - str);
332 #define val_store(ptr, val, off, or, data) \
334 ptr = td_var((data), (off)); \
341 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
342 int first, int more, int curr)
346 long long ull, *ullp;
350 int ret = 0, is_time = 0;
351 const struct value_pair *vp;
352 struct value_pair posval[PARSE_MAX_VP];
353 int i, all_skipped = 1;
355 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
358 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
359 fprintf(stderr, "Option %s requires an argument\n", o->name);
365 case FIO_OPT_STR_MULTI: {
366 fio_opt_str_fn *fn = o->cb;
368 posval_sort(o, posval);
371 for (i = 0; i < PARSE_MAX_VP; i++) {
373 if (!vp->ival || vp->ival[0] == '\0')
376 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
380 *(unsigned int *) o->roff1 |= vp->oval;
382 *(unsigned int *) o->roff1 = vp->oval;
386 val_store(ilp, vp->oval, o->off1, vp->or, data);
392 if (ret && !all_skipped)
393 show_option_values(o);
398 case FIO_OPT_STR_VAL_TIME:
401 case FIO_OPT_STR_VAL: {
402 fio_opt_str_val_fn *fn = o->cb;
405 ret = check_str_time(ptr, &ull);
407 ret = check_str_bytes(ptr, &ull, 0, data);
412 if (o->maxval && ull > o->maxval) {
413 fprintf(stderr, "max value out of range: %lld"
414 " (%d max)\n", ull, o->maxval);
417 if (o->minval && ull < o->minval) {
418 fprintf(stderr, "min value out of range: %lld"
419 " (%d min)\n", ull, o->minval);
424 ret = fn(data, &ull);
426 if (o->type == FIO_OPT_INT) {
429 *(unsigned int *) o->roff1 = ull;
431 val_store(ilp, ull, o->off1, 0, data);
435 *(unsigned int *) o->roff2 = ull;
437 val_store(ilp, ull, o->off2, 0, data);
442 *(unsigned long long *) o->roff1 = ull;
444 val_store(ullp, ull, o->off1, 0, data);
448 *(unsigned long long *) o->roff2 = ull;
450 val_store(ullp, ull, o->off2, 0, data);
456 case FIO_OPT_FLOAT_LIST: {
460 ilp = td_var(data, o->off2);
463 if (curr >= o->maxlen) {
464 fprintf(stderr, "the list exceeding max length %d\n",
468 if(!str_to_float(ptr, &uf)){
469 fprintf(stderr, "not a floating point value: %s\n",
473 if (!isnan(o->maxfp) && uf > o->maxfp) {
474 fprintf(stderr, "value out of range: %f"
475 " (range max: %f)\n", uf, o->maxfp);
478 if (!isnan(o->minfp) && uf < o->minfp) {
479 fprintf(stderr, "value out of range: %f"
480 " (range min: %f)\n", uf, o->minfp);
484 flp = td_var(data, o->off1);
489 case FIO_OPT_STR_STORE: {
490 fio_opt_str_fn *fn = o->cb;
492 posval_sort(o, posval);
494 if (!o->posval[0].ival) {
500 for (i = 0; i < PARSE_MAX_VP; i++) {
502 if (!vp->ival || vp->ival[0] == '\0')
505 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
513 cp = (char **) o->roff1;
515 cp = td_var(data, o->off1);
517 rest = strstr(*cp, ":");
521 } else if (vp && vp->cb)
527 if (ret && !all_skipped)
528 show_option_values(o);
534 case FIO_OPT_RANGE: {
538 strncpy(tmp, ptr, sizeof(tmp) - 1);
540 /* Handle bsrange with separate read,write values: */
541 p1 = strchr(tmp, ',');
545 p1 = strchr(tmp, '-');
547 p1 = strchr(tmp, ':');
559 if (!check_range_bytes(p1, &ul1, data) &&
560 !check_range_bytes(p2, &ul2, data)) {
563 unsigned long foo = ul1;
571 *(unsigned int *) o->roff1 = ul1;
573 val_store(ilp, ul1, o->off1, 0, data);
575 *(unsigned int *) o->roff2 = ul2;
577 val_store(ilp, ul2, o->off2, 0, data);
579 if (o->roff3 && o->roff4) {
580 *(unsigned int *) o->roff3 = ul1;
581 *(unsigned int *) o->roff4 = ul2;
582 } else if (o->off3 && o->off4) {
583 val_store(ilp, ul1, o->off3, 0, data);
584 val_store(ilp, ul2, o->off4, 0, data);
591 case FIO_OPT_STR_SET: {
592 fio_opt_int_fn *fn = o->cb;
595 ret = check_int(ptr, &il);
596 else if (o->type == FIO_OPT_BOOL)
604 if (o->maxval && il > (int) o->maxval) {
605 fprintf(stderr, "max value out of range: %d (%d max)\n",
609 if (o->minval && il < o->minval) {
610 fprintf(stderr, "min value out of range: %d (%d min)\n",
623 *(unsigned int *)o->roff1 = il;
625 val_store(ilp, il, o->off1, 0, data);
629 *(unsigned int *) o->roff2 = il;
631 val_store(ilp, il, o->off2, 0, data);
636 case FIO_OPT_DEPRECATED:
637 fprintf(stdout, "Option %s is deprecated\n", o->name);
640 fprintf(stderr, "Bad option type %u\n", o->type);
648 ret = o->verify(o, data);
650 fprintf(stderr,"Correct format for offending option\n");
651 fprintf(stderr, "%20s: %s\n", o->name, o->help);
652 show_option_help(o, stderr);
659 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
661 char *o_ptr, *ptr, *ptr2;
664 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
668 o_ptr = ptr = strdup(__ptr);
671 * See if we have another set of parameters, hidden after a comma.
672 * Do this before parsing this round, to check if we should
673 * copy set 1 options to set 2.
682 (o->type != FIO_OPT_STR_STORE) &&
683 (o->type != FIO_OPT_STR) &&
684 (o->type != FIO_OPT_FLOAT_LIST)) {
685 ptr2 = strchr(ptr, ',');
686 if (ptr2 && *(ptr2 + 1) == '\0')
688 if (o->type != FIO_OPT_STR_MULTI) {
690 ptr2 = strchr(ptr, ':');
692 ptr2 = strchr(ptr, '-');
694 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
695 ptr2 = strchr(ptr, ':');
699 * Don't return early if parsing the first option fails - if
700 * we are doing multiple arguments, we can allow the first one
703 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
719 static struct fio_option *get_option(const char *opt,
720 struct fio_option *options, char **post)
722 struct fio_option *o;
725 ret = strchr(opt, '=');
731 strip_blank_end(ret);
732 o = find_option(options, ret);
734 o = find_option(options, opt);
741 static int opt_cmp(const void *p1, const void *p2)
743 struct fio_option *o1, *o2;
747 s1 = strdup(*((char **) p1));
748 s2 = strdup(*((char **) p2));
750 o1 = get_option(s1, fio_options, &foo);
751 o2 = get_option(s2, fio_options, &foo);
761 return prio2 - prio1;
764 void sort_options(char **opts, struct fio_option *options, int num_opts)
766 fio_options = options;
767 qsort(opts, num_opts, sizeof(char *), opt_cmp);
771 int parse_cmd_option(const char *opt, const char *val,
772 struct fio_option *options, void *data)
774 struct fio_option *o;
776 o = find_option(options, opt);
778 fprintf(stderr, "Bad option <%s>\n", opt);
782 if (!handle_option(o, val, data))
785 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
790 * Return a copy of the input string with substrings of the form ${VARNAME}
791 * substituted with the value of the environment variable VARNAME. The
792 * substitution always occurs, even if VARNAME is empty or the corresponding
793 * environment variable undefined.
795 static char *option_dup_subs(const char *opt)
797 char out[OPT_LEN_MAX+1];
798 char in[OPT_LEN_MAX+1];
801 char *ch1, *ch2, *env;
802 ssize_t nchr = OPT_LEN_MAX;
805 if (strlen(opt) + 1 > OPT_LEN_MAX) {
806 fprintf(stderr, "OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
810 in[OPT_LEN_MAX] = '\0';
811 strncpy(in, opt, OPT_LEN_MAX);
813 while (*inptr && nchr > 0) {
814 if (inptr[0] == '$' && inptr[1] == '{') {
815 ch2 = strchr(inptr, '}');
816 if (ch2 && inptr+1 < ch2) {
823 envlen = strlen(env);
824 if (envlen <= nchr) {
825 memcpy(outptr, env, envlen);
835 *outptr++ = *inptr++;
843 int parse_option(const char *opt, struct fio_option *options, void *data)
845 struct fio_option *o;
848 tmp = option_dup_subs(opt);
852 o = get_option(tmp, options, &post);
854 fprintf(stderr, "Bad option <%s>\n", tmp);
859 if (!handle_option(o, post, data)) {
864 fprintf(stderr, "fio: failed parsing %s\n", opt);
870 * Option match, levenshtein distance. Handy for not quite remembering what
871 * the option name is.
873 static int string_distance(const char *s1, const char *s2)
875 unsigned int s1_len = strlen(s1);
876 unsigned int s2_len = strlen(s2);
877 unsigned int *p, *q, *r;
880 p = malloc(sizeof(unsigned int) * (s2_len + 1));
881 q = malloc(sizeof(unsigned int) * (s2_len + 1));
884 for (i = 1; i <= s2_len; i++)
887 for (i = 1; i <= s1_len; i++) {
889 for (j = 1; j <= s2_len; j++) {
890 unsigned int sub = p[j - 1];
892 if (s1[i - 1] != s2[j - 1])
895 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
908 static struct fio_option *find_child(struct fio_option *options,
909 struct fio_option *o)
911 struct fio_option *__o;
913 for (__o = options + 1; __o->name; __o++)
914 if (__o->parent && !strcmp(__o->parent, o->name))
920 static void __print_option(struct fio_option *o, struct fio_option *org,
934 p += sprintf(p, "%s", " ");
936 sprintf(p, "%s", o->name);
938 printf("%-24s: %s\n", name, o->help);
941 static void print_option(struct fio_option *o)
943 struct fio_option *parent;
944 struct fio_option *__o;
945 unsigned int printed;
948 __print_option(o, NULL, 0);
955 while ((__o = find_child(o, parent)) != NULL) {
956 __print_option(__o, o, level);
965 int show_cmd_help(struct fio_option *options, const char *name)
967 struct fio_option *o, *closest;
968 unsigned int best_dist = -1U;
972 if (!name || !strcmp(name, "all"))
977 for (o = &options[0]; o->name; o++) {
980 if (o->type == FIO_OPT_DEPRECATED)
982 if (!exec_profile && o->prof_name)
986 if (!strcmp(name, o->name) ||
987 (o->alias && !strcmp(name, o->alias)))
992 dist = string_distance(name, o->name);
993 if (dist < best_dist) {
1000 if (show_all || match) {
1003 printf("%20s: %s\n", o->name, o->help);
1014 show_option_help(o, stdout);
1020 printf("No such command: %s", name);
1023 * Only print an appropriately close option, one where the edit
1024 * distance isn't too big. Otherwise we get crazy matches.
1026 if (closest && best_dist < 3) {
1027 printf(" - showing closest match\n");
1028 printf("%20s: %s\n", closest->name, closest->help);
1029 show_option_help(closest, stdout);
1037 * Handle parsing of default parameters.
1039 void fill_default_options(void *data, struct fio_option *options)
1041 struct fio_option *o;
1043 dprint(FD_PARSE, "filling default options\n");
1045 for (o = &options[0]; o->name; o++)
1047 handle_option(o, o->def, data);
1050 void option_init(struct fio_option *o)
1052 if (o->type == FIO_OPT_DEPRECATED)
1054 if (o->type == FIO_OPT_BOOL) {
1058 if (o->type == FIO_OPT_FLOAT_LIST) {
1062 if (o->type == FIO_OPT_STR_SET && o->def) {
1063 fprintf(stderr, "Option %s: string set option with"
1064 " default will always be true\n", o->name);
1066 if (!o->cb && (!o->off1 && !o->roff1)) {
1067 fprintf(stderr, "Option %s: neither cb nor offset given\n",
1070 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1071 o->type == FIO_OPT_STR_MULTI)
1073 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1074 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1075 fprintf(stderr, "Option %s: both cb and offset given\n",
1081 * Sanitize the options structure. For now it just sets min/max for bool
1082 * values and whether both callback and offsets are given.
1084 void options_init(struct fio_option *options)
1086 struct fio_option *o;
1088 dprint(FD_PARSE, "init options\n");
1090 for (o = &options[0]; o->name; o++)