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)
276 while (isspace((int) *s))
282 void strip_blank_end(char *p)
296 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
302 static int check_range_bytes(const char *str, long *val, void *data)
306 if (!str_to_decimal(str, &__val, 1, data)) {
314 static int check_int(const char *p, int *val)
318 if (strstr(p, "0x") || strstr(p, "0X")) {
319 if (sscanf(p, "%x", val) == 1)
322 if (sscanf(p, "%u", val) == 1)
329 static int opt_len(const char *str)
333 postfix = strchr(str, ':');
337 return (int)(postfix - str);
340 #define val_store(ptr, val, off, or, data) \
342 ptr = td_var((data), (off)); \
349 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
350 int first, int more, int curr)
354 long long ull, *ullp;
358 int ret = 0, is_time = 0;
359 const struct value_pair *vp;
360 struct value_pair posval[PARSE_MAX_VP];
361 int i, all_skipped = 1;
363 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
366 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
367 fprintf(stderr, "Option %s requires an argument\n", o->name);
373 case FIO_OPT_STR_MULTI: {
374 fio_opt_str_fn *fn = o->cb;
376 posval_sort(o, posval);
379 for (i = 0; i < PARSE_MAX_VP; i++) {
381 if (!vp->ival || vp->ival[0] == '\0')
384 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
388 *(unsigned int *) o->roff1 |= vp->oval;
390 *(unsigned int *) o->roff1 = vp->oval;
394 val_store(ilp, vp->oval, o->off1, vp->or, data);
400 if (ret && !all_skipped)
401 show_option_values(o);
406 case FIO_OPT_STR_VAL_TIME:
409 case FIO_OPT_STR_VAL: {
410 fio_opt_str_val_fn *fn = o->cb;
413 ret = check_str_time(ptr, &ull);
415 ret = check_str_bytes(ptr, &ull, data);
420 if (o->maxval && ull > o->maxval) {
421 fprintf(stderr, "max value out of range: %lld"
422 " (%d max)\n", ull, o->maxval);
425 if (o->minval && ull < o->minval) {
426 fprintf(stderr, "min value out of range: %lld"
427 " (%d min)\n", ull, o->minval);
432 ret = fn(data, &ull);
434 if (o->type == FIO_OPT_INT) {
437 *(unsigned int *) o->roff1 = ull;
439 val_store(ilp, ull, o->off1, 0, data);
443 *(unsigned int *) o->roff2 = ull;
445 val_store(ilp, ull, o->off2, 0, data);
450 *(unsigned long long *) o->roff1 = ull;
452 val_store(ullp, ull, o->off1, 0, data);
456 *(unsigned long long *) o->roff2 = ull;
458 val_store(ullp, ull, o->off2, 0, data);
464 case FIO_OPT_FLOAT_LIST: {
468 ilp = td_var(data, o->off2);
471 if (curr >= o->maxlen) {
472 fprintf(stderr, "the list exceeding max length %d\n",
476 if(!str_to_float(ptr, &uf)){
477 fprintf(stderr, "not a floating point value: %s\n",
481 if (!isnan(o->maxfp) && uf > o->maxfp) {
482 fprintf(stderr, "value out of range: %f"
483 " (range max: %f)\n", uf, o->maxfp);
486 if (!isnan(o->minfp) && uf < o->minfp) {
487 fprintf(stderr, "value out of range: %f"
488 " (range min: %f)\n", uf, o->minfp);
492 flp = td_var(data, o->off1);
497 case FIO_OPT_STR_STORE: {
498 fio_opt_str_fn *fn = o->cb;
500 posval_sort(o, posval);
502 if (!o->posval[0].ival) {
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))) {
521 cp = (char **) o->roff1;
523 cp = td_var(data, o->off1);
525 rest = strstr(*cp, ":");
529 } else if (vp && vp->cb)
535 if (ret && !all_skipped)
536 show_option_values(o);
542 case FIO_OPT_RANGE: {
546 strncpy(tmp, ptr, sizeof(tmp) - 1);
548 /* Handle bsrange with separate read,write values: */
549 p1 = strchr(tmp, ',');
553 p1 = strchr(tmp, '-');
555 p1 = strchr(tmp, ':');
567 if (!check_range_bytes(p1, &ul1, data) &&
568 !check_range_bytes(p2, &ul2, data)) {
571 unsigned long foo = ul1;
579 *(unsigned int *) o->roff1 = ul1;
581 val_store(ilp, ul1, o->off1, 0, data);
583 *(unsigned int *) o->roff2 = ul2;
585 val_store(ilp, ul2, o->off2, 0, data);
587 if (o->roff3 && o->roff4) {
588 *(unsigned int *) o->roff3 = ul1;
589 *(unsigned int *) o->roff4 = ul2;
590 } else if (o->off3 && o->off4) {
591 val_store(ilp, ul1, o->off3, 0, data);
592 val_store(ilp, ul2, o->off4, 0, data);
599 case FIO_OPT_STR_SET: {
600 fio_opt_int_fn *fn = o->cb;
603 ret = check_int(ptr, &il);
604 else if (o->type == FIO_OPT_BOOL)
612 if (o->maxval && il > (int) o->maxval) {
613 fprintf(stderr, "max value out of range: %d (%d max)\n",
617 if (o->minval && il < o->minval) {
618 fprintf(stderr, "min value out of range: %d (%d min)\n",
631 *(unsigned int *)o->roff1 = il;
633 val_store(ilp, il, o->off1, 0, data);
637 *(unsigned int *) o->roff2 = il;
639 val_store(ilp, il, o->off2, 0, data);
644 case FIO_OPT_DEPRECATED:
645 log_info("Option %s is deprecated\n", o->name);
648 log_err("Bad option type %u\n", o->type);
656 ret = o->verify(o, data);
658 fprintf(stderr,"Correct format for offending option\n");
659 fprintf(stderr, "%20s: %s\n", o->name, o->help);
660 show_option_help(o, 1);
667 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
669 char *o_ptr, *ptr, *ptr2;
672 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
676 o_ptr = ptr = strdup(__ptr);
679 * See if we have another set of parameters, hidden after a comma.
680 * Do this before parsing this round, to check if we should
681 * copy set 1 options to set 2.
690 (o->type != FIO_OPT_STR_STORE) &&
691 (o->type != FIO_OPT_STR) &&
692 (o->type != FIO_OPT_FLOAT_LIST)) {
693 ptr2 = strchr(ptr, ',');
694 if (ptr2 && *(ptr2 + 1) == '\0')
696 if (o->type != FIO_OPT_STR_MULTI) {
698 ptr2 = strchr(ptr, ':');
700 ptr2 = strchr(ptr, '-');
702 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
703 ptr2 = strchr(ptr, ':');
707 * Don't return early if parsing the first option fails - if
708 * we are doing multiple arguments, we can allow the first one
711 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
727 static struct fio_option *get_option(const char *opt,
728 struct fio_option *options, char **post)
730 struct fio_option *o;
733 ret = strchr(opt, '=');
739 strip_blank_end(ret);
740 o = find_option(options, ret);
742 o = find_option(options, opt);
749 static int opt_cmp(const void *p1, const void *p2)
751 struct fio_option *o1, *o2;
755 s1 = strdup(*((char **) p1));
756 s2 = strdup(*((char **) p2));
758 o1 = get_option(s1, fio_options, &foo);
759 o2 = get_option(s2, fio_options, &foo);
769 return prio2 - prio1;
772 void sort_options(char **opts, struct fio_option *options, int num_opts)
774 fio_options = options;
775 qsort(opts, num_opts, sizeof(char *), opt_cmp);
779 int parse_cmd_option(const char *opt, const char *val,
780 struct fio_option *options, void *data)
782 struct fio_option *o;
784 o = find_option(options, opt);
786 log_err("Bad option <%s>\n", opt);
790 if (!handle_option(o, val, data))
793 log_err("fio: failed parsing %s=%s\n", opt, val);
798 * Return a copy of the input string with substrings of the form ${VARNAME}
799 * substituted with the value of the environment variable VARNAME. The
800 * substitution always occurs, even if VARNAME is empty or the corresponding
801 * environment variable undefined.
803 static char *option_dup_subs(const char *opt)
805 char out[OPT_LEN_MAX+1];
806 char in[OPT_LEN_MAX+1];
809 char *ch1, *ch2, *env;
810 ssize_t nchr = OPT_LEN_MAX;
813 if (strlen(opt) + 1 > OPT_LEN_MAX) {
814 fprintf(stderr, "OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
818 in[OPT_LEN_MAX] = '\0';
819 strncpy(in, opt, OPT_LEN_MAX);
821 while (*inptr && nchr > 0) {
822 if (inptr[0] == '$' && inptr[1] == '{') {
823 ch2 = strchr(inptr, '}');
824 if (ch2 && inptr+1 < ch2) {
831 envlen = strlen(env);
832 if (envlen <= nchr) {
833 memcpy(outptr, env, envlen);
843 *outptr++ = *inptr++;
851 int parse_option(const char *opt, struct fio_option *options, void *data)
853 struct fio_option *o;
856 tmp = option_dup_subs(opt);
860 o = get_option(tmp, options, &post);
862 log_err("Bad option <%s>\n", tmp);
867 if (!handle_option(o, post, data)) {
872 log_err("fio: failed parsing %s\n", opt);
878 * Option match, levenshtein distance. Handy for not quite remembering what
879 * the option name is.
881 static int string_distance(const char *s1, const char *s2)
883 unsigned int s1_len = strlen(s1);
884 unsigned int s2_len = strlen(s2);
885 unsigned int *p, *q, *r;
888 p = malloc(sizeof(unsigned int) * (s2_len + 1));
889 q = malloc(sizeof(unsigned int) * (s2_len + 1));
892 for (i = 1; i <= s2_len; i++)
895 for (i = 1; i <= s1_len; i++) {
897 for (j = 1; j <= s2_len; j++) {
898 unsigned int sub = p[j - 1];
900 if (s1[i - 1] != s2[j - 1])
903 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
916 static struct fio_option *find_child(struct fio_option *options,
917 struct fio_option *o)
919 struct fio_option *__o;
921 for (__o = options + 1; __o->name; __o++)
922 if (__o->parent && !strcmp(__o->parent, o->name))
928 static void __print_option(struct fio_option *o, struct fio_option *org,
942 p += sprintf(p, "%s", " ");
944 sprintf(p, "%s", o->name);
946 printf("%-24s: %s\n", name, o->help);
949 static void print_option(struct fio_option *o)
951 struct fio_option *parent;
952 struct fio_option *__o;
953 unsigned int printed;
956 __print_option(o, NULL, 0);
963 while ((__o = find_child(o, parent)) != NULL) {
964 __print_option(__o, o, level);
973 int show_cmd_help(struct fio_option *options, const char *name)
975 struct fio_option *o, *closest;
976 unsigned int best_dist = -1U;
980 if (!name || !strcmp(name, "all"))
985 for (o = &options[0]; o->name; o++) {
988 if (o->type == FIO_OPT_DEPRECATED)
990 if (!exec_profile && o->prof_name)
994 if (!strcmp(name, o->name) ||
995 (o->alias && !strcmp(name, o->alias)))
1000 dist = string_distance(name, o->name);
1001 if (dist < best_dist) {
1008 if (show_all || match) {
1011 printf("%20s: %s\n", o->name, o->help);
1022 show_option_help(o, 0);
1028 printf("No such command: %s", name);
1031 * Only print an appropriately close option, one where the edit
1032 * distance isn't too big. Otherwise we get crazy matches.
1034 if (closest && best_dist < 3) {
1035 printf(" - showing closest match\n");
1036 printf("%20s: %s\n", closest->name, closest->help);
1037 show_option_help(closest, 0);
1045 * Handle parsing of default parameters.
1047 void fill_default_options(void *data, struct fio_option *options)
1049 struct fio_option *o;
1051 dprint(FD_PARSE, "filling default options\n");
1053 for (o = &options[0]; o->name; o++)
1055 handle_option(o, o->def, data);
1058 void option_init(struct fio_option *o)
1060 if (o->type == FIO_OPT_DEPRECATED)
1062 if (o->type == FIO_OPT_BOOL) {
1066 if (o->type == FIO_OPT_FLOAT_LIST) {
1070 if (o->type == FIO_OPT_STR_SET && o->def) {
1071 log_err("Option %s: string set option with"
1072 " default will always be true\n", o->name);
1074 if (!o->cb && (!o->off1 && !o->roff1))
1075 log_err("Option %s: neither cb nor offset given\n", o->name);
1076 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1077 o->type == FIO_OPT_STR_MULTI)
1079 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1080 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1081 log_err("Option %s: both cb and offset given\n", o->name);
1086 * Sanitize the options structure. For now it just sets min/max for bool
1087 * values and whether both callback and offsets are given.
1089 void options_init(struct fio_option *options)
1091 struct fio_option *o;
1093 dprint(FD_PARSE, "init options\n");
1095 for (o = &options[0]; o->name; o++)