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, or, data) \
262 ptr = td_var((data), (off)); \
269 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
273 long long ull, *ullp;
276 int ret = 0, is_time = 0;
278 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
281 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
282 fprintf(stderr, "Option %s requires an argument\n", o->name);
288 case FIO_OPT_STR_MULTI: {
289 fio_opt_str_fn *fn = o->cb;
290 const struct value_pair *vp;
291 struct value_pair posval[PARSE_MAX_VP];
294 posval_sort(o, posval);
297 for (i = 0; i < PARSE_MAX_VP; i++) {
299 if (!vp->ival || vp->ival[0] == '\0')
301 if (!strncmp(vp->ival, ptr, strlen(vp->ival))) {
305 *(unsigned int *) o->roff1 |= vp->oval;
307 *(unsigned int *) o->roff1 = vp->oval;
311 val_store(ilp, vp->oval, o->off1, vp->or, data);
318 show_option_values(o);
323 case FIO_OPT_STR_VAL_TIME:
326 case FIO_OPT_STR_VAL: {
327 fio_opt_str_val_fn *fn = o->cb;
330 ret = check_str_time(ptr, &ull);
332 ret = check_str_bytes(ptr, &ull, data);
337 if (o->maxval && ull > o->maxval) {
338 fprintf(stderr, "max value out of range: %lld"
339 " (%d max)\n", ull, o->maxval);
342 if (o->minval && ull < o->minval) {
343 fprintf(stderr, "min value out of range: %lld"
344 " (%d min)\n", ull, o->minval);
349 ret = fn(data, &ull);
351 if (o->type == FIO_OPT_INT) {
354 *(unsigned long long *) o->roff1 = ull;
356 val_store(ilp, ull, o->off1, 0, data);
360 *(unsigned long long *) o->roff2 = ull;
362 val_store(ilp, ull, o->off2, 0, data);
367 *(unsigned long long *) o->roff1 = ull;
369 val_store(ullp, ull, o->off1, 0, data);
373 *(unsigned long long *) o->roff2 = ull;
375 val_store(ullp, ull, o->off2, 0, data);
381 case FIO_OPT_STR_STORE: {
382 fio_opt_str_fn *fn = o->cb;
385 cp = (char **) o->roff1;
387 cp = td_var(data, o->off1);
399 case FIO_OPT_RANGE: {
403 strncpy(tmp, ptr, sizeof(tmp) - 1);
405 p1 = strchr(tmp, '-');
407 p1 = strchr(tmp, ':');
419 if (!check_range_bytes(p1, &ul1, data) &&
420 !check_range_bytes(p2, &ul2, data)) {
423 unsigned long foo = ul1;
431 *(unsigned long *) o->roff1 = ul1;
433 val_store(ilp, ul1, o->off1, 0, data);
435 *(unsigned long *) o->roff2 = ul2;
437 val_store(ilp, ul2, o->off2, 0, data);
439 if (o->roff3 && o->roff4) {
440 *(unsigned long *) o->roff3 = ul1;
441 *(unsigned long *) o->roff4 = ul2;
442 } else if (o->off3 && o->off4) {
443 val_store(ilp, ul1, o->off3, 0, data);
444 val_store(ilp, ul2, o->off4, 0, data);
451 fio_opt_int_fn *fn = o->cb;
453 ret = check_int(ptr, &il);
457 if (o->maxval && il > (int) o->maxval) {
458 fprintf(stderr, "max value out of range: %d (%d max)\n",
462 if (o->minval && il < o->minval) {
463 fprintf(stderr, "min value out of range: %d (%d min)\n",
476 *(unsigned int *)o->roff1 = il;
478 val_store(ilp, il, o->off1, 0, data);
482 *(unsigned int *) o->roff2 = il;
484 val_store(ilp, il, o->off2, 0, data);
489 case FIO_OPT_STR_SET: {
490 fio_opt_str_set_fn *fn = o->cb;
497 *(unsigned int *) o->roff1 = 1;
499 val_store(ilp, 1, o->off1, 0, data);
503 *(unsigned int *) o->roff2 = 1;
505 val_store(ilp, 1, o->off2, 0, data);
510 case FIO_OPT_DEPRECATED:
511 fprintf(stdout, "Option %s is deprecated\n", o->name);
514 fprintf(stderr, "Bad option type %u\n", o->type);
522 ret = o->verify(o, data);
524 fprintf(stderr,"Correct format for offending option\n");
525 fprintf(stderr, "%20s: %s\n", o->name, o->help);
526 show_option_help(o, stderr);
533 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
535 char *o_ptr, *ptr, *ptr2;
538 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
542 o_ptr = ptr = strdup(__ptr);
545 * See if we have another set of parameters, hidden after a comma.
546 * Do this before parsing this round, to check if we should
547 * copy set 1 options to set 2.
556 (o->type != FIO_OPT_STR_STORE) &&
557 (o->type != FIO_OPT_STR)) {
558 ptr2 = strchr(ptr, ',');
559 if (ptr2 && *(ptr2 + 1) == '\0')
561 if (o->type != FIO_OPT_STR_MULTI) {
563 ptr2 = strchr(ptr, ':');
565 ptr2 = strchr(ptr, '-');
570 * Don't return early if parsing the first option fails - if
571 * we are doing multiple arguments, we can allow the first one
574 __ret = __handle_option(o, ptr, data, !done, !!ptr2);
590 static struct fio_option *get_option(const char *opt,
591 struct fio_option *options, char **post)
593 struct fio_option *o;
596 ret = strchr(opt, '=');
602 strip_blank_end(ret);
603 o = find_option(options, ret);
605 o = find_option(options, opt);
612 static int opt_cmp(const void *p1, const void *p2)
614 struct fio_option *o1, *o2;
618 s1 = strdup(*((char **) p1));
619 s2 = strdup(*((char **) p2));
621 o1 = get_option(s1, fio_options, &foo);
622 o2 = get_option(s2, fio_options, &foo);
632 return prio2 - prio1;
635 void sort_options(char **opts, struct fio_option *options, int num_opts)
637 fio_options = options;
638 qsort(opts, num_opts, sizeof(char *), opt_cmp);
642 int parse_cmd_option(const char *opt, const char *val,
643 struct fio_option *options, void *data)
645 struct fio_option *o;
647 o = find_option(options, opt);
649 fprintf(stderr, "Bad option <%s>\n", opt);
653 if (!handle_option(o, val, data))
656 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
661 * Return a copy of the input string with substrings of the form ${VARNAME}
662 * substituted with the value of the environment variable VARNAME. The
663 * substitution always occurs, even if VARNAME is empty or the corresponding
664 * environment variable undefined.
666 static char *option_dup_subs(const char *opt)
668 char out[OPT_LEN_MAX+1];
669 char in[OPT_LEN_MAX+1];
672 char *ch1, *ch2, *env;
673 ssize_t nchr = OPT_LEN_MAX;
676 if (strlen(opt) + 1 > OPT_LEN_MAX) {
677 fprintf(stderr, "OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
681 in[OPT_LEN_MAX] = '\0';
682 strncpy(in, opt, OPT_LEN_MAX);
684 while (*inptr && nchr > 0) {
685 if (inptr[0] == '$' && inptr[1] == '{') {
686 ch2 = strchr(inptr, '}');
687 if (ch2 && inptr+1 < ch2) {
694 envlen = strlen(env);
695 if (envlen <= nchr) {
696 memcpy(outptr, env, envlen);
706 *outptr++ = *inptr++;
714 int parse_option(const char *opt, struct fio_option *options, void *data)
716 struct fio_option *o;
719 tmp = option_dup_subs(opt);
723 o = get_option(tmp, options, &post);
725 fprintf(stderr, "Bad option <%s>\n", tmp);
730 if (!handle_option(o, post, data)) {
735 fprintf(stderr, "fio: failed parsing %s\n", opt);
741 * Option match, levenshtein distance. Handy for not quite remembering what
742 * the option name is.
744 static int string_distance(const char *s1, const char *s2)
746 unsigned int s1_len = strlen(s1);
747 unsigned int s2_len = strlen(s2);
748 unsigned int *p, *q, *r;
751 p = malloc(sizeof(unsigned int) * (s2_len + 1));
752 q = malloc(sizeof(unsigned int) * (s2_len + 1));
755 for (i = 1; i <= s2_len; i++)
758 for (i = 1; i <= s1_len; i++) {
760 for (j = 1; j <= s2_len; j++) {
761 unsigned int sub = p[j - 1];
763 if (s1[i - 1] != s2[j - 1])
766 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
779 static struct fio_option *find_child(struct fio_option *options,
780 struct fio_option *o)
782 struct fio_option *__o;
784 for (__o = options + 1; __o->name; __o++)
785 if (__o->parent && !strcmp(__o->parent, o->name))
791 static void __print_option(struct fio_option *o, struct fio_option *org,
805 p += sprintf(p, "%s", " ");
807 sprintf(p, "%s", o->name);
809 printf("%-24s: %s\n", name, o->help);
812 static void print_option(struct fio_option *o)
814 struct fio_option *parent;
815 struct fio_option *__o;
816 unsigned int printed;
819 __print_option(o, NULL, 0);
826 while ((__o = find_child(o, parent)) != NULL) {
827 __print_option(__o, o, level);
836 int show_cmd_help(struct fio_option *options, const char *name)
838 struct fio_option *o, *closest;
839 unsigned int best_dist;
843 if (!name || !strcmp(name, "all"))
848 for (o = &options[0]; o->name; o++) {
851 if (o->type == FIO_OPT_DEPRECATED)
853 if (!exec_profile && o->prof_name)
857 if (!strcmp(name, o->name) ||
858 (o->alias && !strcmp(name, o->alias)))
863 dist = string_distance(name, o->name);
864 if (dist < best_dist) {
871 if (show_all || match) {
874 printf("%20s: %s\n", o->name, o->help);
885 show_option_help(o, stdout);
891 printf("No such command: %s", name);
893 printf(" - showing closest match\n");
894 printf("%20s: %s\n", closest->name, closest->help);
895 show_option_help(closest, stdout);
903 * Handle parsing of default parameters.
905 void fill_default_options(void *data, struct fio_option *options)
907 struct fio_option *o;
909 dprint(FD_PARSE, "filling default options\n");
911 for (o = &options[0]; o->name; o++)
913 handle_option(o, o->def, data);
916 void option_init(struct fio_option *o)
918 if (o->type == FIO_OPT_DEPRECATED)
920 if (o->type == FIO_OPT_BOOL) {
924 if (o->type == FIO_OPT_STR_SET && o->def) {
925 fprintf(stderr, "Option %s: string set option with"
926 " default will always be true\n", o->name);
928 if (!o->cb && (!o->off1 && !o->roff1)) {
929 fprintf(stderr, "Option %s: neither cb nor offset given\n",
932 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
933 o->type == FIO_OPT_STR_MULTI)
935 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
936 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
937 fprintf(stderr, "Option %s: both cb and offset given\n",
943 * Sanitize the options structure. For now it just sets min/max for bool
944 * values and whether both callback and offsets are given.
946 void options_init(struct fio_option *options)
948 struct fio_option *o;
950 dprint(FD_PARSE, "init options\n");
952 for (o = &options[0]; o->name; o++)