2 * This file contains the ini and command liner parser main.
19 #include "lib/ieee754.h"
21 static struct fio_option *__fio_options;
23 static int vp_cmp(const void *p1, const void *p2)
25 const struct value_pair *vp1 = p1;
26 const struct value_pair *vp2 = p2;
28 return strlen(vp2->ival) - strlen(vp1->ival);
31 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
33 const struct value_pair *vp;
36 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
38 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
39 vp = &o->posval[entries];
40 if (!vp->ival || vp->ival[0] == '\0')
43 memcpy(&vpmap[entries], vp, sizeof(*vp));
46 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
49 static void show_option_range(struct fio_option *o,
50 int (*logger)(const char *format, ...))
52 if (o->type == FIO_OPT_FLOAT_LIST){
53 if (o->minfp == DBL_MIN && o->maxfp == DBL_MAX)
56 logger("%20s: min=%f", "range", o->minfp);
57 if (o->maxfp != DBL_MAX)
58 logger(", max=%f", o->maxfp);
61 if (!o->minval && !o->maxval)
64 logger("%20s: min=%d", "range", o->minval);
66 logger(", max=%d", o->maxval);
71 static void show_option_values(struct fio_option *o)
75 for (i = 0; i < PARSE_MAX_VP; i++) {
76 const struct value_pair *vp = &o->posval[i];
81 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
83 log_info(" %s", vp->help);
91 static void show_option_help(struct fio_option *o, int is_err)
93 const char *typehelp[] = {
97 "string with possible k/m/g postfix (opt=4k)",
98 "string with time postfix (opt=10s)",
100 "string with dual range (opt=1k-4k,4k-8k)",
101 "integer value (opt=100)",
102 "boolean value (opt=1)",
103 "list of floating point values separated by ':' (opt=5.9:7.8)",
107 int (*logger)(const char *format, ...);
115 logger("%20s: %s\n", "alias", o->alias);
117 logger("%20s: %s\n", "type", typehelp[o->type]);
118 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
120 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
121 show_option_range(o, logger);
122 show_option_values(o);
125 static unsigned long get_mult_time(char c)
142 static int is_separator(char c)
155 static unsigned long long __get_mult_bytes(const char *p, void *data,
158 unsigned int kb_base = fio_get_kb_base(data);
159 unsigned long long ret = 1;
160 unsigned int i, pow = 0, mult = kb_base;
168 for (i = 0; i < strlen(c); i++) {
169 c[i] = tolower(c[i]);
170 if (is_separator(c[i])) {
176 if (!strncmp("pib", c, 3)) {
179 } else if (!strncmp("tib", c, 3)) {
182 } else if (!strncmp("gib", c, 3)) {
185 } else if (!strncmp("mib", c, 3)) {
188 } else if (!strncmp("kib", c, 3)) {
191 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
193 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
195 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
197 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
199 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
201 else if (!strncmp("%", c, 1)) {
208 ret *= (unsigned long long) mult;
214 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
221 return __get_mult_bytes(str, data, percent);
224 * Go forward until we hit a non-digit, or +/- sign
226 while ((p - str) <= len) {
227 if (!isdigit((int) *p) &&
228 (((*p != '+') && (*p != '-')) || digit_seen))
230 digit_seen |= isdigit((int) *p);
234 if (!isalpha((int) *p) && (*p != '%'))
237 return __get_mult_bytes(p, data, percent);
241 * Convert string into a floating number. Return 1 for success and 0 otherwise.
243 int str_to_float(const char *str, double *val)
245 return (1 == sscanf(str, "%lf", val));
249 * convert string into decimal value, noting any size suffix
251 int str_to_decimal(const char *str, long long *val, int kilo, void *data)
259 if (strstr(str, "0x") || strstr(str, "0X"))
264 *val = strtoll(str, NULL, base);
265 if (*val == LONG_MAX && errno == ERANGE)
269 unsigned long long mult;
272 mult = get_mult_bytes(str, len, data, &perc);
278 *val *= get_mult_time(str[len - 1]);
283 int check_str_bytes(const char *p, long long *val, void *data)
285 return str_to_decimal(p, val, 1, data);
288 static int check_str_time(const char *p, long long *val)
290 return str_to_decimal(p, val, 0, NULL);
293 void strip_blank_front(char **p)
299 while (isspace((int) *s))
305 void strip_blank_end(char *p)
322 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
328 static int check_range_bytes(const char *str, long *val, void *data)
332 if (!str_to_decimal(str, &__val, 1, data)) {
340 static int check_int(const char *p, int *val)
344 if (strstr(p, "0x") || strstr(p, "0X")) {
345 if (sscanf(p, "%x", val) == 1)
348 if (sscanf(p, "%u", val) == 1)
355 static int opt_len(const char *str)
359 postfix = strchr(str, ':');
363 return (int)(postfix - str);
366 static int str_match_len(const struct value_pair *vp, const char *str)
368 return max(strlen(vp->ival), opt_len(str));
371 #define val_store(ptr, val, off, or, data) \
373 ptr = td_var((data), (off)); \
380 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
381 int first, int more, int curr)
385 long long ull, *ullp;
389 int ret = 0, is_time = 0;
390 const struct value_pair *vp;
391 struct value_pair posval[PARSE_MAX_VP];
392 int i, all_skipped = 1;
394 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
397 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
398 log_err("Option %s requires an argument\n", o->name);
404 case FIO_OPT_STR_MULTI: {
405 fio_opt_str_fn *fn = o->cb;
407 posval_sort(o, posval);
410 for (i = 0; i < PARSE_MAX_VP; i++) {
412 if (!vp->ival || vp->ival[0] == '\0')
415 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
419 *(unsigned int *) o->roff1 |= vp->oval;
421 *(unsigned int *) o->roff1 = vp->oval;
425 val_store(ilp, vp->oval, o->off1, vp->or, data);
431 if (ret && !all_skipped)
432 show_option_values(o);
437 case FIO_OPT_STR_VAL_TIME:
440 case FIO_OPT_STR_VAL: {
441 fio_opt_str_val_fn *fn = o->cb;
444 strncpy(tmp, ptr, sizeof(tmp) - 1);
445 p = strchr(tmp, ',');
450 ret = check_str_time(tmp, &ull);
452 ret = check_str_bytes(tmp, &ull, data);
457 if (o->maxval && ull > o->maxval) {
458 log_err("max value out of range: %llu"
459 " (%u max)\n", ull, o->maxval);
462 if (o->minval && ull < o->minval) {
463 log_err("min value out of range: %llu"
464 " (%u min)\n", ull, o->minval);
467 if (o->posval[0].ival) {
468 posval_sort(o, posval);
471 for (i = 0; i < PARSE_MAX_VP; i++) {
473 if (!vp->ival || vp->ival[0] == '\0')
475 if (vp->oval == ull) {
481 log_err("value %d not in allowed range\n",ull);
487 ret = fn(data, &ull);
489 if (o->type == FIO_OPT_INT) {
492 *(unsigned int *) o->roff1 = ull;
494 val_store(ilp, ull, o->off1, 0, data);
498 *(unsigned int *) o->roff2 = ull;
500 val_store(ilp, ull, o->off2, 0, data);
504 *(unsigned int *) o->roff3 = ull;
506 val_store(ilp, ull, o->off3, 0, data);
511 *(unsigned int *) o->roff2 = ull;
513 val_store(ilp, ull, o->off2, 0, data);
517 *(unsigned int *) o->roff3 = ull;
519 val_store(ilp, ull, o->off3, 0, data);
525 *(unsigned long long *) o->roff1 = ull;
527 val_store(ullp, ull, o->off1, 0, data);
531 *(unsigned long long *) o->roff2 = ull;
533 val_store(ullp, ull, o->off2, 0, data);
539 case FIO_OPT_FLOAT_LIST: {
544 ** Initialize precision to 0 and zero out list
545 ** in case specified list is shorter than default
548 ilp = td_var(data, o->off2);
551 flp = td_var(data, o->off1);
552 for(i = 0; i < o->maxlen; i++)
555 if (curr >= o->maxlen) {
556 log_err("the list exceeding max length %d\n",
560 if (!str_to_float(ptr, &uf)) {
561 log_err("not a floating point value: %s\n", ptr);
565 log_err("value out of range: %f"
566 " (range max: %f)\n", uf, o->maxfp);
570 log_err("value out of range: %f"
571 " (range min: %f)\n", uf, o->minfp);
575 flp = td_var(data, o->off1);
579 ** Calculate precision for output by counting
580 ** number of digits after period. Find first
581 ** period in entire remaining list each time
583 cp2 = strchr(ptr, '.');
587 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
590 ilp = td_var(data, o->off2);
597 case FIO_OPT_STR_STORE: {
598 fio_opt_str_fn *fn = o->cb;
600 if (o->roff1 || o->off1) {
602 cp = (char **) o->roff1;
604 cp = td_var(data, o->off1);
611 else if (o->posval[0].ival) {
612 posval_sort(o, posval);
615 for (i = 0; i < PARSE_MAX_VP; i++) {
617 if (!vp->ival || vp->ival[0] == '\0')
620 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
626 rest = strstr(*cp ?: ptr, ":");
640 show_option_values(o);
649 case FIO_OPT_RANGE: {
653 strncpy(tmp, ptr, sizeof(tmp) - 1);
655 /* Handle bsrange with separate read,write values: */
656 p1 = strchr(tmp, ',');
660 p1 = strchr(tmp, '-');
662 p1 = strchr(tmp, ':');
674 if (!check_range_bytes(p1, &ul1, data) &&
675 !check_range_bytes(p2, &ul2, data)) {
678 unsigned long foo = ul1;
686 *(unsigned int *) o->roff1 = ul1;
688 val_store(ilp, ul1, o->off1, 0, data);
690 *(unsigned int *) o->roff2 = ul2;
692 val_store(ilp, ul2, o->off2, 0, data);
695 if (o->roff3 && o->roff4) {
696 *(unsigned int *) o->roff3 = ul1;
697 *(unsigned int *) o->roff4 = ul2;
698 } else if (o->off3 && o->off4) {
699 val_store(ilp, ul1, o->off3, 0, data);
700 val_store(ilp, ul2, o->off4, 0, data);
704 if (o->roff5 && o->roff6) {
705 *(unsigned int *) o->roff5 = ul1;
706 *(unsigned int *) o->roff6 = ul2;
707 } else if (o->off5 && o->off6) {
708 val_store(ilp, ul1, o->off5, 0, data);
709 val_store(ilp, ul2, o->off6, 0, data);
714 if (o->roff3 && o->roff4) {
715 *(unsigned int *) o->roff3 = ul1;
716 *(unsigned int *) o->roff4 = ul2;
717 } else if (o->off3 && o->off4) {
718 val_store(ilp, ul1, o->off3, 0, data);
719 val_store(ilp, ul2, o->off4, 0, data);
723 if (o->roff5 && o->roff6) {
724 *(unsigned int *) o->roff5 = ul1;
725 *(unsigned int *) o->roff6 = ul2;
726 } else if (o->off5 && o->off6) {
727 val_store(ilp, ul1, o->off5, 0, data);
728 val_store(ilp, ul2, o->off6, 0, data);
737 case FIO_OPT_STR_SET: {
738 fio_opt_int_fn *fn = o->cb;
741 ret = check_int(ptr, &il);
742 else if (o->type == FIO_OPT_BOOL)
750 if (o->maxval && il > (int) o->maxval) {
751 log_err("max value out of range: %d (%d max)\n",
755 if (o->minval && il < o->minval) {
756 log_err("min value out of range: %d (%d min)\n",
769 *(unsigned int *)o->roff1 = il;
771 val_store(ilp, il, o->off1, 0, data);
775 *(unsigned int *) o->roff2 = il;
777 val_store(ilp, il, o->off2, 0, data);
782 case FIO_OPT_DEPRECATED:
783 log_info("Option %s is deprecated\n", o->name);
786 log_err("Bad option type %u\n", o->type);
794 ret = o->verify(o, data);
796 log_err("Correct format for offending option\n");
797 log_err("%20s: %s\n", o->name, o->help);
798 show_option_help(o, 1);
805 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
807 char *o_ptr, *ptr, *ptr2;
810 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
814 o_ptr = ptr = strdup(__ptr);
817 * See if we have another set of parameters, hidden after a comma.
818 * Do this before parsing this round, to check if we should
819 * copy set 1 options to set 2.
828 (o->type != FIO_OPT_STR_STORE) &&
829 (o->type != FIO_OPT_STR) &&
830 (o->type != FIO_OPT_FLOAT_LIST)) {
831 ptr2 = strchr(ptr, ',');
832 if (ptr2 && *(ptr2 + 1) == '\0')
834 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
836 ptr2 = strchr(ptr, ':');
838 ptr2 = strchr(ptr, '-');
840 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
841 ptr2 = strchr(ptr, ':');
845 * Don't return early if parsing the first option fails - if
846 * we are doing multiple arguments, we can allow the first one
849 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
865 static struct fio_option *get_option(char *opt,
866 struct fio_option *options, char **post)
868 struct fio_option *o;
871 ret = strchr(opt, '=');
877 strip_blank_end(ret);
878 o = find_option(options, ret);
880 o = find_option(options, opt);
887 static int opt_cmp(const void *p1, const void *p2)
889 struct fio_option *o;
896 s = strdup(*((char **) p1));
897 o = get_option(s, __fio_options, &foo);
903 s = strdup(*((char **) p2));
904 o = get_option(s, __fio_options, &foo);
910 return prio2 - prio1;
913 void sort_options(char **opts, struct fio_option *options, int num_opts)
915 __fio_options = options;
916 qsort(opts, num_opts, sizeof(char *), opt_cmp);
917 __fio_options = NULL;
920 int parse_cmd_option(const char *opt, const char *val,
921 struct fio_option *options, void *data)
923 struct fio_option *o;
925 o = find_option(options, opt);
927 log_err("Bad option <%s>\n", opt);
931 if (!handle_option(o, val, data))
934 log_err("fio: failed parsing %s=%s\n", opt, val);
938 int parse_option(char *opt, const char *input,
939 struct fio_option *options, struct fio_option **o, void *data)
944 log_err("fio: failed parsing %s\n", input);
949 *o = get_option(opt, options, &post);
952 int len = strlen(opt);
953 if (opt + len + 1 != post)
954 memmove(opt + len + 1, post, strlen(post));
960 if (!handle_option(*o, post, data))
963 log_err("fio: failed parsing %s\n", input);
968 * Option match, levenshtein distance. Handy for not quite remembering what
969 * the option name is.
971 static int string_distance(const char *s1, const char *s2)
973 unsigned int s1_len = strlen(s1);
974 unsigned int s2_len = strlen(s2);
975 unsigned int *p, *q, *r;
978 p = malloc(sizeof(unsigned int) * (s2_len + 1));
979 q = malloc(sizeof(unsigned int) * (s2_len + 1));
982 for (i = 1; i <= s2_len; i++)
985 for (i = 1; i <= s1_len; i++) {
987 for (j = 1; j <= s2_len; j++) {
988 unsigned int sub = p[j - 1];
990 if (s1[i - 1] != s2[j - 1])
993 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
1006 static struct fio_option *find_child(struct fio_option *options,
1007 struct fio_option *o)
1009 struct fio_option *__o;
1011 for (__o = options + 1; __o->name; __o++)
1012 if (__o->parent && !strcmp(__o->parent, o->name))
1018 static void __print_option(struct fio_option *o, struct fio_option *org,
1032 p += sprintf(p, "%s", " ");
1034 sprintf(p, "%s", o->name);
1036 log_info("%-24s: %s\n", name, o->help);
1039 static void print_option(struct fio_option *o)
1041 struct fio_option *parent;
1042 struct fio_option *__o;
1043 unsigned int printed;
1046 __print_option(o, NULL, 0);
1053 while ((__o = find_child(o, parent)) != NULL) {
1054 __print_option(__o, o, level);
1063 int show_cmd_help(struct fio_option *options, const char *name)
1065 struct fio_option *o, *closest;
1066 unsigned int best_dist = -1U;
1070 if (!name || !strcmp(name, "all"))
1075 for (o = &options[0]; o->name; o++) {
1078 if (o->type == FIO_OPT_DEPRECATED)
1080 if (!exec_profile && o->prof_name)
1084 if (!strcmp(name, o->name) ||
1085 (o->alias && !strcmp(name, o->alias)))
1090 dist = string_distance(name, o->name);
1091 if (dist < best_dist) {
1098 if (show_all || match) {
1101 log_info("%20s: %s\n", o->name, o->help);
1112 show_option_help(o, 0);
1118 log_err("No such command: %s", name);
1121 * Only print an appropriately close option, one where the edit
1122 * distance isn't too big. Otherwise we get crazy matches.
1124 if (closest && best_dist < 3) {
1125 log_info(" - showing closest match\n");
1126 log_info("%20s: %s\n", closest->name, closest->help);
1127 show_option_help(closest, 0);
1135 * Handle parsing of default parameters.
1137 void fill_default_options(void *data, struct fio_option *options)
1139 struct fio_option *o;
1141 dprint(FD_PARSE, "filling default options\n");
1143 for (o = &options[0]; o->name; o++)
1145 handle_option(o, o->def, data);
1148 void option_init(struct fio_option *o)
1150 if (o->type == FIO_OPT_DEPRECATED)
1152 if (o->type == FIO_OPT_BOOL) {
1156 if (o->type == FIO_OPT_INT) {
1158 o->maxval = UINT_MAX;
1160 if (o->type == FIO_OPT_FLOAT_LIST) {
1164 if (o->type == FIO_OPT_STR_SET && o->def) {
1165 log_err("Option %s: string set option with"
1166 " default will always be true\n", o->name);
1168 if (!o->cb && (!o->off1 && !o->roff1))
1169 log_err("Option %s: neither cb nor offset given\n", o->name);
1170 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1171 o->type == FIO_OPT_STR_MULTI)
1173 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1174 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
1175 log_err("Option %s: both cb and offset given\n", o->name);
1178 log_info("Options %s: no category defined. Setting to misc\n", o->name);
1179 o->category = FIO_OPT_C_GENERAL;
1184 * Sanitize the options structure. For now it just sets min/max for bool
1185 * values and whether both callback and offsets are given.
1187 void options_init(struct fio_option *options)
1189 struct fio_option *o;
1191 dprint(FD_PARSE, "init options\n");
1193 for (o = &options[0]; o->name; o++) {
1196 o->inv_opt = find_option(options, o->inverse);
1200 void options_free(struct fio_option *options, void *data)
1202 struct fio_option *o;
1205 dprint(FD_PARSE, "free options\n");
1207 for (o = &options[0]; o->name; o++) {
1208 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1211 ptr = td_var(data, o->off1);