2 * This file contains the ini and command liner parser main.
19 #include "lib/ieee754.h"
21 #ifdef CONFIG_ARITHMETIC
25 static struct fio_option *__fio_options;
27 static int vp_cmp(const void *p1, const void *p2)
29 const struct value_pair *vp1 = p1;
30 const struct value_pair *vp2 = p2;
32 return strlen(vp2->ival) - strlen(vp1->ival);
35 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
37 const struct value_pair *vp;
40 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
42 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
43 vp = &o->posval[entries];
44 if (!vp->ival || vp->ival[0] == '\0')
47 memcpy(&vpmap[entries], vp, sizeof(*vp));
50 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
53 static void show_option_range(struct fio_option *o,
54 int (*logger)(const char *format, ...))
56 if (o->type == FIO_OPT_FLOAT_LIST) {
57 if (o->minfp == DBL_MIN && o->maxfp == DBL_MAX)
60 logger("%20s: min=%f", "range", o->minfp);
61 if (o->maxfp != DBL_MAX)
62 logger(", max=%f", o->maxfp);
64 } else if (!o->posval[0].ival) {
65 if (!o->minval && !o->maxval)
68 logger("%20s: min=%d", "range", o->minval);
70 logger(", max=%d", o->maxval);
75 static void show_option_values(struct fio_option *o)
79 for (i = 0; i < PARSE_MAX_VP; i++) {
80 const struct value_pair *vp = &o->posval[i];
85 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
87 log_info(" %s", vp->help);
95 static void show_option_help(struct fio_option *o, int is_err)
97 const char *typehelp[] = {
101 "string with possible k/m/g postfix (opt=4k)",
102 "string with time postfix (opt=10s)",
104 "string with dual range (opt=1k-4k,4k-8k)",
105 "integer value (opt=100)",
106 "boolean value (opt=1)",
107 "list of floating point values separated by ':' (opt=5.9:7.8)",
111 int (*logger)(const char *format, ...);
119 logger("%20s: %s\n", "alias", o->alias);
121 logger("%20s: %s\n", "type", typehelp[o->type]);
122 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
124 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
125 show_option_range(o, logger);
126 show_option_values(o);
129 static unsigned long long get_mult_time(const char *str, int len,
134 unsigned long long mult = 1;
137 * Go forward until we hit a non-digit, or +/- sign
139 while ((p - str) <= len) {
140 if (!isdigit((int) *p) && (*p != '+') && (*p != '-'))
145 if (!isalpha((int) *p)) {
153 for (int i = 0; i < strlen(c); i++)
154 c[i] = tolower(c[i]);
156 if (!strncmp("us", c, 2) || !strncmp("usec", c, 4))
158 else if (!strncmp("ms", c, 2) || !strncmp("msec", c, 4))
160 else if (!strcmp("s", c))
162 else if (!strcmp("m", c))
163 mult = 60 * 1000000UL;
164 else if (!strcmp("h", c))
165 mult = 60 * 60 * 1000000UL;
166 else if (!strcmp("d", c))
167 mult = 24 * 60 * 60 * 1000000UL;
173 static int is_separator(char c)
186 static unsigned long long __get_mult_bytes(const char *p, void *data,
189 unsigned int kb_base = fio_get_kb_base(data);
190 unsigned long long ret = 1;
191 unsigned int i, pow = 0, mult = kb_base;
199 for (i = 0; i < strlen(c); i++) {
200 c[i] = tolower(c[i]);
201 if (is_separator(c[i])) {
207 if (!strncmp("pib", c, 3)) {
210 } else if (!strncmp("tib", c, 3)) {
213 } else if (!strncmp("gib", c, 3)) {
216 } else if (!strncmp("mib", c, 3)) {
219 } else if (!strncmp("kib", c, 3)) {
222 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
224 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
226 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
228 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
230 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
232 else if (!strncmp("%", c, 1)) {
239 ret *= (unsigned long long) mult;
245 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
252 return __get_mult_bytes(str, data, percent);
255 * Go forward until we hit a non-digit, or +/- sign
257 while ((p - str) <= len) {
258 if (!isdigit((int) *p) &&
259 (((*p != '+') && (*p != '-')) || digit_seen))
261 digit_seen |= isdigit((int) *p);
265 if (!isalpha((int) *p) && (*p != '%'))
268 return __get_mult_bytes(p, data, percent);
271 extern int evaluate_arithmetic_expression(const char *buffer, long long *ival,
272 double *dval, double implied_units);
274 #ifdef CONFIG_ARITHMETIC
276 * These two verification functions are just to gain confidence that
277 * the arithmetic processing code is always getting the same answer as the
278 * original number parsing code. Once sufficiently sure that the arithmetic
279 * code is always getting the right answers, these can be removed.
281 static void verify_exp_parser_float(const char *str, double implied_units)
286 if (sscanf(str, "%lf", &tmpval) != 1)
289 if (evaluate_arithmetic_expression(str, &ival, &dval, implied_units) != 0) {
290 log_info("Arithmetic failed on '%s'\n", str);
293 if (dval != tmpval) {
294 log_info("Arithmetic failed on: '%s' got %lf, expected %lf\n",
299 static void verify_exp_parser_decimal(const char *str, long long val, int kilo, int is_seconds)
304 double implied_units = 1.0;
307 implied_units = 1000000.0;
309 rc = evaluate_arithmetic_expression(str, &ival, &dval, implied_units);
312 log_info("Arithmetic failed on '%s', expected %lld, got %lld\n",
315 log_info("Arithmetic failed on '%s'\n", str);
321 * Convert string into a floating number. Return 1 for success and 0 otherwise.
323 int str_to_float(const char *str, double *val)
325 #ifdef CONFIG_ARITHMETIC
331 rc = evaluate_arithmetic_expression(str, &ival, &dval, 1.0);
337 verify_exp_parser_float(str, 1.0);
340 return 1 == sscanf(str, "%lf", val);
344 * convert string into decimal value, noting any size suffix
346 int str_to_decimal(const char *str, long long *val, int kilo, void *data,
351 #ifdef CONFIG_ARITHMETIC
354 double implied_units = 1.0;
361 #ifdef CONFIG_ARITHMETIC
363 implied_units = 1000000.0;
365 rc = evaluate_arithmetic_expression(str, &ival, &dval, implied_units);
366 if (str[0] == '(' && !rc) {
367 if (!kilo && is_seconds)
368 *val = ival / 1000000LL;
375 if (strstr(str, "0x") || strstr(str, "0X"))
380 *val = strtoll(str, NULL, base);
381 if (*val == LONG_MAX && errno == ERANGE)
386 unsigned long long mult;
389 mult = get_mult_bytes(str, len, data, &perc);
395 *val *= get_mult_time(str, len, is_seconds);
396 #ifdef CONFIG_ARITHMETIC
397 verify_exp_parser_decimal(str, *val, kilo, is_seconds);
402 int check_str_bytes(const char *p, long long *val, void *data)
404 return str_to_decimal(p, val, 1, data, 0);
407 int check_str_time(const char *p, long long *val, int is_seconds)
409 return str_to_decimal(p, val, 0, NULL, is_seconds);
412 void strip_blank_front(char **p)
418 while (isspace((int) *s))
424 void strip_blank_end(char *p)
441 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
447 static int check_range_bytes(const char *str, long *val, void *data)
451 if (!str_to_decimal(str, &__val, 1, data, 0)) {
459 static int check_int(const char *p, int *val)
463 if (strstr(p, "0x") || strstr(p, "0X")) {
464 if (sscanf(p, "%x", val) == 1)
467 if (sscanf(p, "%u", val) == 1)
474 static size_t opt_len(const char *str)
478 postfix = strchr(str, ':');
482 return (int)(postfix - str);
485 static int str_match_len(const struct value_pair *vp, const char *str)
487 return max(strlen(vp->ival), opt_len(str));
490 #define val_store(ptr, val, off, or, data, o) \
492 ptr = td_var((data), (o), (off)); \
499 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
500 int first, int more, int curr)
504 long long ull, *ullp;
508 int ret = 0, is_time = 0;
509 const struct value_pair *vp;
510 struct value_pair posval[PARSE_MAX_VP];
511 int i, all_skipped = 1;
513 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
516 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
517 log_err("Option %s requires an argument\n", o->name);
523 case FIO_OPT_STR_MULTI: {
524 fio_opt_str_fn *fn = o->cb;
526 posval_sort(o, posval);
529 for (i = 0; i < PARSE_MAX_VP; i++) {
531 if (!vp->ival || vp->ival[0] == '\0')
534 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
537 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
542 if (ret && !all_skipped)
543 show_option_values(o);
548 case FIO_OPT_STR_VAL_TIME:
551 case FIO_OPT_STR_VAL: {
552 fio_opt_str_val_fn *fn = o->cb;
555 strncpy(tmp, ptr, sizeof(tmp) - 1);
556 p = strchr(tmp, ',');
561 ret = check_str_time(tmp, &ull, o->is_seconds);
563 ret = check_str_bytes(tmp, &ull, data);
565 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
570 if (o->maxval && ull > o->maxval) {
571 log_err("max value out of range: %llu"
572 " (%u max)\n", ull, o->maxval);
575 if (o->minval && ull < o->minval) {
576 log_err("min value out of range: %llu"
577 " (%u min)\n", ull, o->minval);
580 if (o->posval[0].ival) {
581 posval_sort(o, posval);
584 for (i = 0; i < PARSE_MAX_VP; i++) {
586 if (!vp->ival || vp->ival[0] == '\0')
588 if (vp->oval == ull) {
594 log_err("fio: value %llu not allowed:\n", ull);
595 show_option_values(o);
601 ret = fn(data, &ull);
603 if (o->type == FIO_OPT_INT) {
605 val_store(ilp, ull, o->off1, 0, data, o);
608 val_store(ilp, ull, o->off2, 0, data, o);
612 val_store(ilp, ull, o->off3, 0, data, o);
617 val_store(ilp, ull, o->off2, 0, data, o);
621 val_store(ilp, ull, o->off3, 0, data, o);
626 val_store(ullp, ull, o->off1, 0, data, o);
629 val_store(ullp, ull, o->off2, 0, data, o);
635 case FIO_OPT_FLOAT_LIST: {
640 ** Initialize precision to 0 and zero out list
641 ** in case specified list is shorter than default
645 ilp = td_var(data, o, o->off2);
649 flp = td_var(data, o, o->off1);
650 for(i = 0; i < o->maxlen; i++)
653 if (curr >= o->maxlen) {
654 log_err("the list exceeding max length %d\n",
658 if (!str_to_float(ptr, &uf)) {
659 log_err("not a floating point value: %s\n", ptr);
663 log_err("value out of range: %f"
664 " (range max: %f)\n", uf, o->maxfp);
668 log_err("value out of range: %f"
669 " (range min: %f)\n", uf, o->minfp);
673 flp = td_var(data, o, o->off1);
676 dprint(FD_PARSE, " out=%f\n", uf);
679 ** Calculate precision for output by counting
680 ** number of digits after period. Find first
681 ** period in entire remaining list each time
683 cp2 = strchr(ptr, '.');
687 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
691 ilp = td_var(data, o, o->off2);
699 case FIO_OPT_STR_STORE: {
700 fio_opt_str_fn *fn = o->cb;
706 cp = td_var(data, o, o->off1);
712 else if (o->posval[0].ival) {
713 posval_sort(o, posval);
716 for (i = 0; i < PARSE_MAX_VP; i++) {
718 if (!vp->ival || vp->ival[0] == '\0' || !cp)
721 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
727 rest = strstr(*cp ?: ptr, ":");
741 show_option_values(o);
750 case FIO_OPT_RANGE: {
754 strncpy(tmp, ptr, sizeof(tmp) - 1);
756 /* Handle bsrange with separate read,write values: */
757 p1 = strchr(tmp, ',');
761 p1 = strchr(tmp, '-');
763 p1 = strchr(tmp, ':');
775 if (!check_range_bytes(p1, &ul1, data) &&
776 !check_range_bytes(p2, &ul2, data)) {
779 unsigned long foo = ul1;
786 val_store(ilp, ul1, o->off1, 0, data, o);
787 val_store(ilp, ul2, o->off2, 0, data, o);
790 if (o->off3 && o->off4) {
791 val_store(ilp, ul1, o->off3, 0, data, o);
792 val_store(ilp, ul2, o->off4, 0, data, o);
796 if (o->off5 && o->off6) {
797 val_store(ilp, ul1, o->off5, 0, data, o);
798 val_store(ilp, ul2, o->off6, 0, data, o);
803 if (o->off3 && o->off4) {
804 val_store(ilp, ul1, o->off3, 0, data, o);
805 val_store(ilp, ul2, o->off4, 0, data, o);
809 if (o->off5 && o->off6) {
810 val_store(ilp, ul1, o->off5, 0, data, o);
811 val_store(ilp, ul2, o->off6, 0, data, o);
820 case FIO_OPT_STR_SET: {
821 fio_opt_int_fn *fn = o->cb;
824 ret = check_int(ptr, &il);
825 else if (o->type == FIO_OPT_BOOL)
830 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
835 if (o->maxval && il > (int) o->maxval) {
836 log_err("max value out of range: %d (%d max)\n",
840 if (o->minval && il < o->minval) {
841 log_err("min value out of range: %d (%d min)\n",
853 val_store(ilp, il, o->off1, 0, data, o);
856 val_store(ilp, il, o->off2, 0, data, o);
861 case FIO_OPT_DEPRECATED:
862 log_info("Option %s is deprecated\n", o->name);
866 log_err("Bad option type %u\n", o->type);
874 ret = o->verify(o, data);
876 log_err("Correct format for offending option\n");
877 log_err("%20s: %s\n", o->name, o->help);
878 show_option_help(o, 1);
885 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
887 char *o_ptr, *ptr, *ptr2;
890 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
894 o_ptr = ptr = strdup(__ptr);
897 * See if we have another set of parameters, hidden after a comma.
898 * Do this before parsing this round, to check if we should
899 * copy set 1 options to set 2.
908 (o->type != FIO_OPT_STR_STORE) &&
909 (o->type != FIO_OPT_STR) &&
910 (o->type != FIO_OPT_FLOAT_LIST)) {
911 ptr2 = strchr(ptr, ',');
912 if (ptr2 && *(ptr2 + 1) == '\0')
914 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
916 ptr2 = strchr(ptr, ':');
918 ptr2 = strchr(ptr, '-');
920 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
921 ptr2 = strchr(ptr, ':');
925 * Don't return early if parsing the first option fails - if
926 * we are doing multiple arguments, we can allow the first one
929 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
945 static struct fio_option *get_option(char *opt,
946 struct fio_option *options, char **post)
948 struct fio_option *o;
951 ret = strchr(opt, '=');
957 strip_blank_end(ret);
958 o = find_option(options, ret);
960 o = find_option(options, opt);
967 static int opt_cmp(const void *p1, const void *p2)
969 struct fio_option *o;
976 s = strdup(*((char **) p1));
977 o = get_option(s, __fio_options, &foo);
983 s = strdup(*((char **) p2));
984 o = get_option(s, __fio_options, &foo);
990 return prio2 - prio1;
993 void sort_options(char **opts, struct fio_option *options, int num_opts)
995 __fio_options = options;
996 qsort(opts, num_opts, sizeof(char *), opt_cmp);
997 __fio_options = NULL;
1000 int parse_cmd_option(const char *opt, const char *val,
1001 struct fio_option *options, void *data)
1003 struct fio_option *o;
1005 o = find_option(options, opt);
1007 log_err("Bad option <%s>\n", opt);
1011 if (!handle_option(o, val, data))
1014 log_err("fio: failed parsing %s=%s\n", opt, val);
1018 int parse_option(char *opt, const char *input,
1019 struct fio_option *options, struct fio_option **o, void *data,
1025 log_err("fio: failed parsing %s\n", input);
1030 *o = get_option(opt, options, &post);
1033 int len = strlen(opt);
1034 if (opt + len + 1 != post)
1035 memmove(opt + len + 1, post, strlen(post));
1041 if (handle_option(*o, post, data)) {
1042 log_err("fio: failed parsing %s\n", input);
1049 if (!strcmp("description", (*o)->name))
1054 log_info("--%s%s", (*o)->name, post ? "" : " ");
1056 log_info("=%s%s%s ", delim, post, delim);
1063 * Option match, levenshtein distance. Handy for not quite remembering what
1064 * the option name is.
1066 static int string_distance(const char *s1, const char *s2)
1068 unsigned int s1_len = strlen(s1);
1069 unsigned int s2_len = strlen(s2);
1070 unsigned int *p, *q, *r;
1073 p = malloc(sizeof(unsigned int) * (s2_len + 1));
1074 q = malloc(sizeof(unsigned int) * (s2_len + 1));
1077 for (i = 1; i <= s2_len; i++)
1078 p[i] = p[i - 1] + 1;
1080 for (i = 1; i <= s1_len; i++) {
1082 for (j = 1; j <= s2_len; j++) {
1083 unsigned int sub = p[j - 1];
1085 if (s1[i - 1] != s2[j - 1])
1088 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
1101 static struct fio_option *find_child(struct fio_option *options,
1102 struct fio_option *o)
1104 struct fio_option *__o;
1106 for (__o = options + 1; __o->name; __o++)
1107 if (__o->parent && !strcmp(__o->parent, o->name))
1113 static void __print_option(struct fio_option *o, struct fio_option *org,
1127 p += sprintf(p, "%s", " ");
1129 sprintf(p, "%s", o->name);
1131 log_info("%-24s: %s\n", name, o->help);
1134 static void print_option(struct fio_option *o)
1136 struct fio_option *parent;
1137 struct fio_option *__o;
1138 unsigned int printed;
1141 __print_option(o, NULL, 0);
1148 while ((__o = find_child(o, parent)) != NULL) {
1149 __print_option(__o, o, level);
1158 int show_cmd_help(struct fio_option *options, const char *name)
1160 struct fio_option *o, *closest;
1161 unsigned int best_dist = -1U;
1165 if (!name || !strcmp(name, "all"))
1170 for (o = &options[0]; o->name; o++) {
1173 if (o->type == FIO_OPT_DEPRECATED)
1175 if (!exec_profile && o->prof_name)
1177 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1181 if (!strcmp(name, o->name) ||
1182 (o->alias && !strcmp(name, o->alias)))
1187 dist = string_distance(name, o->name);
1188 if (dist < best_dist) {
1195 if (show_all || match) {
1198 log_info("%20s: %s\n", o->name, o->help);
1209 show_option_help(o, 0);
1215 log_err("No such command: %s", name);
1218 * Only print an appropriately close option, one where the edit
1219 * distance isn't too big. Otherwise we get crazy matches.
1221 if (closest && best_dist < 3) {
1222 log_info(" - showing closest match\n");
1223 log_info("%20s: %s\n", closest->name, closest->help);
1224 show_option_help(closest, 0);
1232 * Handle parsing of default parameters.
1234 void fill_default_options(void *data, struct fio_option *options)
1236 struct fio_option *o;
1238 dprint(FD_PARSE, "filling default options\n");
1240 for (o = &options[0]; o->name; o++)
1242 handle_option(o, o->def, data);
1245 void option_init(struct fio_option *o)
1247 if (o->type == FIO_OPT_DEPRECATED)
1249 if (o->type == FIO_OPT_BOOL) {
1253 if (o->type == FIO_OPT_INT) {
1255 o->maxval = UINT_MAX;
1257 if (o->type == FIO_OPT_FLOAT_LIST) {
1261 if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
1262 log_err("Option %s: string set option with"
1263 " default will always be true\n", o->name);
1265 if (!o->cb && !o->off1)
1266 log_err("Option %s: neither cb nor offset given\n", o->name);
1268 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1269 o->category = FIO_OPT_C_GENERAL;
1270 o->group = FIO_OPT_G_INVALID;
1272 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1273 o->type == FIO_OPT_STR_MULTI)
1275 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
1276 log_err("Option %s: both cb and offset given\n", o->name);
1280 * Sanitize the options structure. For now it just sets min/max for bool
1281 * values and whether both callback and offsets are given.
1283 void options_init(struct fio_option *options)
1285 struct fio_option *o;
1287 dprint(FD_PARSE, "init options\n");
1289 for (o = &options[0]; o->name; o++) {
1292 o->inv_opt = find_option(options, o->inverse);
1296 void options_free(struct fio_option *options, void *data)
1298 struct fio_option *o;
1301 dprint(FD_PARSE, "free options\n");
1303 for (o = &options[0]; o->name; o++) {
1304 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1307 ptr = td_var(data, o, o->off1);