2 * This file contains the ini and command liner parser main.
17 static struct fio_option *fio_options;
18 extern unsigned int fio_get_kb_base(void *);
20 static int vp_cmp(const void *p1, const void *p2)
22 const struct value_pair *vp1 = p1;
23 const struct value_pair *vp2 = p2;
25 return strlen(vp2->ival) - strlen(vp1->ival);
28 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
30 const struct value_pair *vp;
33 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
35 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
36 vp = &o->posval[entries];
37 if (!vp->ival || vp->ival[0] == '\0')
40 memcpy(&vpmap[entries], vp, sizeof(*vp));
43 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
46 static void show_option_range(struct fio_option *o, FILE *out)
48 if (!o->minval && !o->maxval)
51 fprintf(out, "%20s: min=%d", "range", o->minval);
53 fprintf(out, ", max=%d", o->maxval);
57 static void show_option_values(struct fio_option *o)
61 for (i = 0; i < PARSE_MAX_VP; i++) {
62 const struct value_pair *vp = &o->posval[i];
67 printf("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
69 printf(" %s", vp->help);
77 static void show_option_help(struct fio_option *o, FILE *out)
79 const char *typehelp[] = {
82 "string with possible k/m/g postfix (opt=4k)",
83 "string with time postfix (opt=10s)",
85 "string with dual range (opt=1k-4k,4k-8k)",
86 "integer value (opt=100)",
87 "boolean value (opt=1)",
93 fprintf(out, "%20s: %s\n", "alias", o->alias);
95 fprintf(out, "%20s: %s\n", "type", typehelp[o->type]);
96 fprintf(out, "%20s: %s\n", "default", o->def ? o->def : "no default");
98 fprintf(out, "%20s: only for profile '%s'\n", "valid", o->prof_name);
99 show_option_range(o, stdout);
100 show_option_values(o);
103 static unsigned long get_mult_time(char c)
120 static unsigned long long get_mult_bytes(char c, void *data)
122 unsigned int kb_base = fio_get_kb_base(data);
123 unsigned long long ret = 1;
130 ret *= (unsigned long long) kb_base;
133 ret *= (unsigned long long) kb_base;
136 ret *= (unsigned long long) kb_base;
139 ret *= (unsigned long long) kb_base;
142 ret *= (unsigned long long) kb_base;
150 * convert string into decimal value, noting any size suffix
152 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
160 if (strstr(str, "0x") || strstr(str, "0X"))
165 *val = strtoll(str, NULL, base);
166 if (*val == LONG_MAX && errno == ERANGE)
172 * if the last char is 'b' or 'B', the user likely used
173 * "1gb" instead of just "1g". If the second to last is also
177 if ((*p == 'b' || *p == 'B') && isalpha(*(p - 1)))
180 *val *= get_mult_bytes(*p, data);
182 *val *= get_mult_time(str[len - 1]);
187 static int check_str_bytes(const char *p, long long *val, void *data)
189 return str_to_decimal(p, val, 1, data);
192 static int check_str_time(const char *p, long long *val)
194 return str_to_decimal(p, val, 0, NULL);
197 void strip_blank_front(char **p)
207 void strip_blank_end(char *p)
221 while ((isspace(*s) || iscntrl(*s)) && (s > start))
227 static int check_range_bytes(const char *str, long *val, void *data)
234 if (sscanf(str, "%lu%c", val, &suffix) == 2) {
235 *val *= get_mult_bytes(suffix, data);
239 if (sscanf(str, "%lu", val) == 1)
245 static int check_int(const char *p, int *val)
249 if (strstr(p, "0x") || strstr(p, "0X")) {
250 if (sscanf(p, "%x", val) == 1)
253 if (sscanf(p, "%u", val) == 1)
260 #define val_store(ptr, val, off, data) \
262 ptr = td_var((data), (off)); \
266 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
270 long long ull, *ullp;
273 int ret = 0, is_time = 0;
275 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
278 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
279 fprintf(stderr, "Option %s requires an argument\n", o->name);
285 fio_opt_str_fn *fn = o->cb;
286 const struct value_pair *vp;
287 struct value_pair posval[PARSE_MAX_VP];
290 posval_sort(o, posval);
292 for (i = 0; i < PARSE_MAX_VP; i++) {
294 if (!vp->ival || vp->ival[0] == '\0')
297 if (!strncmp(vp->ival, ptr, strlen(vp->ival))) {
300 *(unsigned int *) o->roff1 = vp->oval;
304 val_store(ilp, vp->oval, o->off1, data);
311 show_option_values(o);
316 case FIO_OPT_STR_VAL_TIME:
319 case FIO_OPT_STR_VAL: {
320 fio_opt_str_val_fn *fn = o->cb;
323 ret = check_str_time(ptr, &ull);
325 ret = check_str_bytes(ptr, &ull, data);
330 if (o->maxval && ull > o->maxval) {
331 fprintf(stderr, "max value out of range: %lld"
332 " (%d max)\n", ull, o->maxval);
335 if (o->minval && ull < o->minval) {
336 fprintf(stderr, "min value out of range: %lld"
337 " (%d min)\n", ull, o->minval);
342 ret = fn(data, &ull);
344 if (o->type == FIO_OPT_INT) {
347 *(unsigned long long *) o->roff1 = ull;
349 val_store(ilp, ull, o->off1, data);
353 *(unsigned long long *) o->roff2 = ull;
355 val_store(ilp, ull, o->off2, data);
360 *(unsigned long long *) o->roff1 = ull;
362 val_store(ullp, ull, o->off1, data);
366 *(unsigned long long *) o->roff2 = ull;
368 val_store(ullp, ull, o->off2, data);
374 case FIO_OPT_STR_STORE: {
375 fio_opt_str_fn *fn = o->cb;
378 cp = (char **) o->roff1;
380 cp = td_var(data, o->off1);
392 case FIO_OPT_RANGE: {
396 strncpy(tmp, ptr, sizeof(tmp) - 1);
398 p1 = strchr(tmp, '-');
400 p1 = strchr(tmp, ':');
412 if (!check_range_bytes(p1, &ul1, data) &&
413 !check_range_bytes(p2, &ul2, data)) {
416 unsigned long foo = ul1;
424 *(unsigned long *) o->roff1 = ul1;
426 val_store(ilp, ul1, o->off1, data);
428 *(unsigned long *) o->roff2 = ul2;
430 val_store(ilp, ul2, o->off2, data);
432 if (o->roff3 && o->roff4) {
433 *(unsigned long *) o->roff3 = ul1;
434 *(unsigned long *) o->roff4 = ul2;
435 } else if (o->off3 && o->off4) {
436 val_store(ilp, ul1, o->off3, data);
437 val_store(ilp, ul2, o->off4, data);
444 fio_opt_int_fn *fn = o->cb;
446 ret = check_int(ptr, &il);
450 if (o->maxval && il > (int) o->maxval) {
451 fprintf(stderr, "max value out of range: %d (%d max)\n",
455 if (o->minval && il < o->minval) {
456 fprintf(stderr, "min value out of range: %d (%d min)\n",
469 *(unsigned int *)o->roff1 = il;
471 val_store(ilp, il, o->off1, data);
475 *(unsigned int *) o->roff2 = il;
477 val_store(ilp, il, o->off2, data);
482 case FIO_OPT_STR_SET: {
483 fio_opt_str_set_fn *fn = o->cb;
490 *(unsigned int *) o->roff1 = 1;
492 val_store(ilp, 1, o->off1, data);
496 *(unsigned int *) o->roff2 = 1;
498 val_store(ilp, 1, o->off2, data);
503 case FIO_OPT_DEPRECATED:
504 fprintf(stdout, "Option %s is deprecated\n", o->name);
507 fprintf(stderr, "Bad option type %u\n", o->type);
515 ret = o->verify(o, data);
517 fprintf(stderr,"Correct format for offending option\n");
518 fprintf(stderr, "%20s: %s\n", o->name, o->help);
519 show_option_help(o, stderr);
526 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
528 char *ptr, *ptr2 = NULL;
531 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
538 * See if we have a second set of parameters, hidden after a comma.
539 * Do this before parsing the first round, to check if we should
540 * copy set 1 options to set 2.
543 (o->type != FIO_OPT_STR_STORE) &&
544 (o->type != FIO_OPT_STR)) {
545 ptr2 = strchr(ptr, ',');
546 if (ptr2 && *(ptr2 + 1) == '\0')
549 ptr2 = strchr(ptr, ':');
551 ptr2 = strchr(ptr, '-');
555 * Don't return early if parsing the first option fails - if
556 * we are doing multiple arguments, we can allow the first one
559 r1 = __handle_option(o, ptr, data, 1, !!ptr2);
568 r2 = __handle_option(o, ptr2, data, 0, 0);
575 static struct fio_option *get_option(const char *opt,
576 struct fio_option *options, char **post)
578 struct fio_option *o;
581 ret = strchr(opt, '=');
587 strip_blank_end(ret);
588 o = find_option(options, ret);
590 o = find_option(options, opt);
597 static int opt_cmp(const void *p1, const void *p2)
599 struct fio_option *o1, *o2;
603 s1 = strdup(*((char **) p1));
604 s2 = strdup(*((char **) p2));
606 o1 = get_option(s1, fio_options, &foo);
607 o2 = get_option(s2, fio_options, &foo);
617 return prio2 - prio1;
620 void sort_options(char **opts, struct fio_option *options, int num_opts)
622 fio_options = options;
623 qsort(opts, num_opts, sizeof(char *), opt_cmp);
627 int parse_cmd_option(const char *opt, const char *val,
628 struct fio_option *options, void *data)
630 struct fio_option *o;
632 o = find_option(options, opt);
634 fprintf(stderr, "Bad option <%s>\n", opt);
638 if (!handle_option(o, val, data))
641 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
646 * Return a copy of the input string with substrings of the form ${VARNAME}
647 * substituted with the value of the environment variable VARNAME. The
648 * substitution always occurs, even if VARNAME is empty or the corresponding
649 * environment variable undefined.
651 static char *option_dup_subs(const char *opt)
653 char out[OPT_LEN_MAX+1];
654 char in[OPT_LEN_MAX+1];
657 char *ch1, *ch2, *env;
658 ssize_t nchr = OPT_LEN_MAX;
661 if (strlen(opt) + 1 > OPT_LEN_MAX) {
662 fprintf(stderr, "OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
666 in[OPT_LEN_MAX] = '\0';
667 strncpy(in, opt, OPT_LEN_MAX);
669 while (*inptr && nchr > 0) {
670 if (inptr[0] == '$' && inptr[1] == '{') {
671 ch2 = strchr(inptr, '}');
672 if (ch2 && inptr+1 < ch2) {
679 envlen = strlen(env);
680 if (envlen <= nchr) {
681 memcpy(outptr, env, envlen);
691 *outptr++ = *inptr++;
699 int parse_option(const char *opt, struct fio_option *options, void *data)
701 struct fio_option *o;
704 tmp = option_dup_subs(opt);
708 o = get_option(tmp, options, &post);
710 fprintf(stderr, "Bad option <%s>\n", tmp);
715 if (!handle_option(o, post, data)) {
720 fprintf(stderr, "fio: failed parsing %s\n", opt);
726 * Option match, levenshtein distance. Handy for not quite remembering what
727 * the option name is.
729 static int string_distance(const char *s1, const char *s2)
731 unsigned int s1_len = strlen(s1);
732 unsigned int s2_len = strlen(s2);
733 unsigned int *p, *q, *r;
736 p = malloc(sizeof(unsigned int) * (s2_len + 1));
737 q = malloc(sizeof(unsigned int) * (s2_len + 1));
740 for (i = 1; i <= s2_len; i++)
743 for (i = 1; i <= s1_len; i++) {
745 for (j = 1; j <= s2_len; j++) {
746 unsigned int sub = p[j - 1];
748 if (s1[i - 1] != s2[j - 1])
751 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
764 static struct fio_option *find_child(struct fio_option *options,
765 struct fio_option *o)
767 struct fio_option *__o;
769 for (__o = options + 1; __o->name; __o++)
770 if (__o->parent && !strcmp(__o->parent, o->name))
776 static void __print_option(struct fio_option *o, struct fio_option *org,
790 p += sprintf(p, "%s", " ");
792 sprintf(p, "%s", o->name);
794 printf("%-24s: %s\n", name, o->help);
797 static void print_option(struct fio_option *o)
799 struct fio_option *parent;
800 struct fio_option *__o;
801 unsigned int printed;
804 __print_option(o, NULL, 0);
811 while ((__o = find_child(o, parent)) != NULL) {
812 __print_option(__o, o, level);
821 int show_cmd_help(struct fio_option *options, const char *name)
823 struct fio_option *o, *closest;
824 unsigned int best_dist;
828 if (!name || !strcmp(name, "all"))
833 for (o = &options[0]; o->name; o++) {
836 if (o->type == FIO_OPT_DEPRECATED)
838 if (!exec_profile && o->prof_name)
842 if (!strcmp(name, o->name) ||
843 (o->alias && !strcmp(name, o->alias)))
848 dist = string_distance(name, o->name);
849 if (dist < best_dist) {
856 if (show_all || match) {
859 printf("%20s: %s\n", o->name, o->help);
870 show_option_help(o, stdout);
876 printf("No such command: %s", name);
878 printf(" - showing closest match\n");
879 printf("%20s: %s\n", closest->name, closest->help);
880 show_option_help(closest, stdout);
888 * Handle parsing of default parameters.
890 void fill_default_options(void *data, struct fio_option *options)
892 struct fio_option *o;
894 dprint(FD_PARSE, "filling default options\n");
896 for (o = &options[0]; o->name; o++)
898 handle_option(o, o->def, data);
901 void option_init(struct fio_option *o)
903 if (o->type == FIO_OPT_DEPRECATED)
905 if (o->type == FIO_OPT_BOOL) {
909 if (o->type == FIO_OPT_STR_SET && o->def) {
910 fprintf(stderr, "Option %s: string set option with"
911 " default will always be true\n", o->name);
913 if (!o->cb && (!o->off1 && !o->roff1)) {
914 fprintf(stderr, "Option %s: neither cb nor offset given\n",
917 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE)
919 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
920 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
921 fprintf(stderr, "Option %s: both cb and offset given\n",
927 * Sanitize the options structure. For now it just sets min/max for bool
928 * values and whether both callback and offsets are given.
930 void options_init(struct fio_option *options)
932 struct fio_option *o;
934 dprint(FD_PARSE, "init options\n");
936 for (o = &options[0]; o->name; o++)