2 * This file contains the ini and command liner parser main.
18 static struct fio_option *__fio_options;
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,
47 int (*logger)(const char *format, ...))
49 if (o->type == FIO_OPT_FLOAT_LIST) {
50 if (isnan(o->minfp) && isnan(o->maxfp))
53 logger("%20s: min=%f", "range", o->minfp);
55 logger(", max=%f", o->maxfp);
58 if (!o->minval && !o->maxval)
61 logger("%20s: min=%d", "range", o->minval);
63 logger(", 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 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
80 log_info(" %s", vp->help);
88 static void show_option_help(struct fio_option *o, int is_err)
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)",
104 int (*logger)(const char *format, ...);
112 logger("%20s: %s\n", "alias", o->alias);
114 logger("%20s: %s\n", "type", typehelp[o->type]);
115 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
117 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
118 show_option_range(o, logger);
119 show_option_values(o);
122 static unsigned long get_mult_time(char c)
139 static unsigned long long __get_mult_bytes(const char *p, void *data,
142 unsigned int kb_base = fio_get_kb_base(data);
143 unsigned long long ret = 1;
144 unsigned int i, pow = 0, mult = kb_base;
152 for (i = 0; i < strlen(c); i++)
153 c[i] = tolower(c[i]);
155 if (!strncmp("pib", c, 3)) {
158 } else if (!strncmp("tib", c, 3)) {
161 } else if (!strncmp("gib", c, 3)) {
164 } else if (!strncmp("mib", c, 3)) {
167 } else if (!strncmp("kib", c, 3)) {
170 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
172 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
174 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
176 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
178 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
180 else if (!strncmp("%", c, 1)) {
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 static 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 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)
278 while (isspace((int) *s))
284 void strip_blank_end(char *p)
301 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
307 static int check_range_bytes(const char *str, long *val, void *data)
311 if (!str_to_decimal(str, &__val, 1, data)) {
319 static int check_int(const char *p, int *val)
323 if (strstr(p, "0x") || strstr(p, "0X")) {
324 if (sscanf(p, "%x", val) == 1)
327 if (sscanf(p, "%u", val) == 1)
334 static int opt_len(const char *str)
338 postfix = strchr(str, ':');
342 return (int)(postfix - str);
345 #define val_store(ptr, val, off, or, data) \
347 ptr = td_var((data), (off)); \
354 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
355 int first, int more, int curr)
359 long long ull, *ullp;
363 int ret = 0, is_time = 0;
364 const struct value_pair *vp;
365 struct value_pair posval[PARSE_MAX_VP];
366 int i, all_skipped = 1;
368 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
371 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
372 log_err("Option %s requires an argument\n", o->name);
378 case FIO_OPT_STR_MULTI: {
379 fio_opt_str_fn *fn = o->cb;
381 posval_sort(o, posval);
384 for (i = 0; i < PARSE_MAX_VP; i++) {
386 if (!vp->ival || vp->ival[0] == '\0')
389 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
393 *(unsigned int *) o->roff1 |= vp->oval;
395 *(unsigned int *) o->roff1 = vp->oval;
399 val_store(ilp, vp->oval, o->off1, vp->or, data);
405 if (ret && !all_skipped)
406 show_option_values(o);
411 case FIO_OPT_STR_VAL_TIME:
414 case FIO_OPT_STR_VAL: {
415 fio_opt_str_val_fn *fn = o->cb;
418 ret = check_str_time(ptr, &ull);
420 ret = check_str_bytes(ptr, &ull, data);
425 if (o->maxval && ull > o->maxval) {
426 log_err("max value out of range: %lld"
427 " (%d max)\n", ull, o->maxval);
430 if (o->minval && ull < o->minval) {
431 log_err("min value out of range: %lld"
432 " (%d min)\n", ull, o->minval);
437 ret = fn(data, &ull);
439 if (o->type == FIO_OPT_INT) {
442 *(unsigned int *) o->roff1 = ull;
444 val_store(ilp, ull, o->off1, 0, data);
448 *(unsigned int *) o->roff2 = ull;
450 val_store(ilp, ull, o->off2, 0, data);
455 *(unsigned long long *) o->roff1 = ull;
457 val_store(ullp, ull, o->off1, 0, data);
461 *(unsigned long long *) o->roff2 = ull;
463 val_store(ullp, ull, o->off2, 0, data);
469 case FIO_OPT_FLOAT_LIST: {
473 ilp = td_var(data, o->off2);
476 if (curr >= o->maxlen) {
477 log_err("the list exceeding max length %d\n",
481 if (!str_to_float(ptr, &uf)) {
482 log_err("not a floating point value: %s\n", ptr);
485 if (!isnan(o->maxfp) && uf > o->maxfp) {
486 log_err("value out of range: %f"
487 " (range max: %f)\n", uf, o->maxfp);
490 if (!isnan(o->minfp) && uf < o->minfp) {
491 log_err("value out of range: %f"
492 " (range min: %f)\n", uf, o->minfp);
496 flp = td_var(data, o->off1);
501 case FIO_OPT_STR_STORE: {
502 fio_opt_str_fn *fn = o->cb;
504 if (o->roff1 || o->off1) {
506 cp = (char **) o->roff1;
508 cp = td_var(data, o->off1);
517 else if (o->posval[0].ival) {
518 posval_sort(o, posval);
521 for (i = 0; i < PARSE_MAX_VP; i++) {
523 if (!vp->ival || vp->ival[0] == '\0')
526 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
532 rest = strstr(*cp ?: ptr, ":");
546 show_option_values(o);
555 case FIO_OPT_RANGE: {
559 strncpy(tmp, ptr, sizeof(tmp) - 1);
561 /* Handle bsrange with separate read,write values: */
562 p1 = strchr(tmp, ',');
566 p1 = strchr(tmp, '-');
568 p1 = strchr(tmp, ':');
580 if (!check_range_bytes(p1, &ul1, data) &&
581 !check_range_bytes(p2, &ul2, data)) {
584 unsigned long foo = ul1;
592 *(unsigned int *) o->roff1 = ul1;
594 val_store(ilp, ul1, o->off1, 0, data);
596 *(unsigned int *) o->roff2 = ul2;
598 val_store(ilp, ul2, o->off2, 0, data);
600 if (o->roff3 && o->roff4) {
601 *(unsigned int *) o->roff3 = ul1;
602 *(unsigned int *) o->roff4 = ul2;
603 } else if (o->off3 && o->off4) {
604 val_store(ilp, ul1, o->off3, 0, data);
605 val_store(ilp, ul2, o->off4, 0, data);
612 case FIO_OPT_STR_SET: {
613 fio_opt_int_fn *fn = o->cb;
616 ret = check_int(ptr, &il);
617 else if (o->type == FIO_OPT_BOOL)
625 if (o->maxval && il > (int) o->maxval) {
626 log_err("max value out of range: %d (%d max)\n",
630 if (o->minval && il < o->minval) {
631 log_err("min value out of range: %d (%d min)\n",
644 *(unsigned int *)o->roff1 = il;
646 val_store(ilp, il, o->off1, 0, data);
650 *(unsigned int *) o->roff2 = il;
652 val_store(ilp, il, o->off2, 0, data);
657 case FIO_OPT_DEPRECATED:
658 log_info("Option %s is deprecated\n", o->name);
661 log_err("Bad option type %u\n", o->type);
669 ret = o->verify(o, data);
671 log_err("Correct format for offending option\n");
672 log_err("%20s: %s\n", o->name, o->help);
673 show_option_help(o, 1);
680 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
682 char *o_ptr, *ptr, *ptr2;
685 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
689 o_ptr = ptr = strdup(__ptr);
692 * See if we have another set of parameters, hidden after a comma.
693 * Do this before parsing this round, to check if we should
694 * copy set 1 options to set 2.
703 (o->type != FIO_OPT_STR_STORE) &&
704 (o->type != FIO_OPT_STR) &&
705 (o->type != FIO_OPT_FLOAT_LIST)) {
706 ptr2 = strchr(ptr, ',');
707 if (ptr2 && *(ptr2 + 1) == '\0')
709 if (o->type != FIO_OPT_STR_MULTI) {
711 ptr2 = strchr(ptr, ':');
713 ptr2 = strchr(ptr, '-');
715 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
716 ptr2 = strchr(ptr, ':');
720 * Don't return early if parsing the first option fails - if
721 * we are doing multiple arguments, we can allow the first one
724 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
740 static struct fio_option *get_option(char *opt,
741 struct fio_option *options, char **post)
743 struct fio_option *o;
746 ret = strchr(opt, '=');
752 strip_blank_end(ret);
753 o = find_option(options, ret);
755 o = find_option(options, opt);
762 static int opt_cmp(const void *p1, const void *p2)
764 struct fio_option *o;
771 s = strdup(*((char **) p1));
772 o = get_option(s, __fio_options, &foo);
778 s = strdup(*((char **) p2));
779 o = get_option(s, __fio_options, &foo);
785 return prio2 - prio1;
788 void sort_options(char **opts, struct fio_option *options, int num_opts)
790 __fio_options = options;
791 qsort(opts, num_opts, sizeof(char *), opt_cmp);
792 __fio_options = NULL;
795 int parse_cmd_option(const char *opt, const char *val,
796 struct fio_option *options, void *data)
798 struct fio_option *o;
800 o = find_option(options, opt);
802 log_err("Bad option <%s>\n", opt);
806 if (!handle_option(o, val, data))
809 log_err("fio: failed parsing %s=%s\n", opt, val);
813 int parse_option(char *opt, const char *input,
814 struct fio_option *options, struct fio_option **o, void *data)
819 log_err("fio: failed parsing %s\n", input);
824 *o = get_option(opt, options, &post);
827 int len = strlen(opt);
828 if (opt + len + 1 != post)
829 memmove(opt + len + 1, post, strlen(post));
835 if (!handle_option(*o, post, data))
838 log_err("fio: failed parsing %s\n", input);
843 * Option match, levenshtein distance. Handy for not quite remembering what
844 * the option name is.
846 static int string_distance(const char *s1, const char *s2)
848 unsigned int s1_len = strlen(s1);
849 unsigned int s2_len = strlen(s2);
850 unsigned int *p, *q, *r;
853 p = malloc(sizeof(unsigned int) * (s2_len + 1));
854 q = malloc(sizeof(unsigned int) * (s2_len + 1));
857 for (i = 1; i <= s2_len; i++)
860 for (i = 1; i <= s1_len; i++) {
862 for (j = 1; j <= s2_len; j++) {
863 unsigned int sub = p[j - 1];
865 if (s1[i - 1] != s2[j - 1])
868 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
881 static struct fio_option *find_child(struct fio_option *options,
882 struct fio_option *o)
884 struct fio_option *__o;
886 for (__o = options + 1; __o->name; __o++)
887 if (__o->parent && !strcmp(__o->parent, o->name))
893 static void __print_option(struct fio_option *o, struct fio_option *org,
907 p += sprintf(p, "%s", " ");
909 sprintf(p, "%s", o->name);
911 log_info("%-24s: %s\n", name, o->help);
914 static void print_option(struct fio_option *o)
916 struct fio_option *parent;
917 struct fio_option *__o;
918 unsigned int printed;
921 __print_option(o, NULL, 0);
928 while ((__o = find_child(o, parent)) != NULL) {
929 __print_option(__o, o, level);
938 int show_cmd_help(struct fio_option *options, const char *name)
940 struct fio_option *o, *closest;
941 unsigned int best_dist = -1U;
945 if (!name || !strcmp(name, "all"))
950 for (o = &options[0]; o->name; o++) {
953 if (o->type == FIO_OPT_DEPRECATED)
955 if (!exec_profile && o->prof_name)
959 if (!strcmp(name, o->name) ||
960 (o->alias && !strcmp(name, o->alias)))
965 dist = string_distance(name, o->name);
966 if (dist < best_dist) {
973 if (show_all || match) {
976 log_info("%20s: %s\n", o->name, o->help);
987 show_option_help(o, 0);
993 log_err("No such command: %s", name);
996 * Only print an appropriately close option, one where the edit
997 * distance isn't too big. Otherwise we get crazy matches.
999 if (closest && best_dist < 3) {
1000 log_info(" - showing closest match\n");
1001 log_info("%20s: %s\n", closest->name, closest->help);
1002 show_option_help(closest, 0);
1010 * Handle parsing of default parameters.
1012 void fill_default_options(void *data, struct fio_option *options)
1014 struct fio_option *o;
1016 dprint(FD_PARSE, "filling default options\n");
1018 for (o = &options[0]; o->name; o++)
1020 handle_option(o, o->def, data);
1023 void option_init(struct fio_option *o)
1025 if (o->type == FIO_OPT_DEPRECATED)
1027 if (o->type == FIO_OPT_BOOL) {
1031 if (o->type == FIO_OPT_FLOAT_LIST) {
1035 if (o->type == FIO_OPT_STR_SET && o->def) {
1036 log_err("Option %s: string set option with"
1037 " default will always be true\n", o->name);
1039 if (!o->cb && (!o->off1 && !o->roff1))
1040 log_err("Option %s: neither cb nor offset given\n", o->name);
1041 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1042 o->type == FIO_OPT_STR_MULTI)
1044 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1045 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1046 log_err("Option %s: both cb and offset given\n", o->name);
1049 log_info("Options %s: no category defined. Setting to misc\n", o->name);
1050 o->category = FIO_OPT_C_GENERAL;
1055 * Sanitize the options structure. For now it just sets min/max for bool
1056 * values and whether both callback and offsets are given.
1058 void options_init(struct fio_option *options)
1060 struct fio_option *o;
1062 dprint(FD_PARSE, "init options\n");
1064 for (o = &options[0]; o->name; o++) {
1067 o->inv_opt = find_option(options, o->inverse);
1071 void options_free(struct fio_option *options, void *data)
1073 struct fio_option *o;
1076 dprint(FD_PARSE, "free options\n");
1078 for (o = &options[0]; o->name; o++) {
1079 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1082 ptr = td_var(data, o->off1);