2 * This file contains the ini and command liner parser main.
20 #include "lib/ieee754.h"
23 #ifdef CONFIG_ARITHMETIC
27 static struct fio_option *__fio_options;
29 static int vp_cmp(const void *p1, const void *p2)
31 const struct value_pair *vp1 = p1;
32 const struct value_pair *vp2 = p2;
34 return strlen(vp2->ival) - strlen(vp1->ival);
37 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
39 const struct value_pair *vp;
42 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
44 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
45 vp = &o->posval[entries];
46 if (!vp->ival || vp->ival[0] == '\0')
49 memcpy(&vpmap[entries], vp, sizeof(*vp));
52 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
55 static void show_option_range(struct fio_option *o,
56 size_t (*logger)(const char *format, ...))
58 if (o->type == FIO_OPT_FLOAT_LIST) {
59 if (o->minfp == DBL_MIN && o->maxfp == DBL_MAX)
62 logger("%20s: min=%f", "range", o->minfp);
63 if (o->maxfp != DBL_MAX)
64 logger(", max=%f", o->maxfp);
66 } else if (!o->posval[0].ival) {
67 if (!o->minval && !o->maxval)
70 logger("%20s: min=%d", "range", o->minval);
72 logger(", max=%d", o->maxval);
77 static void show_option_values(struct fio_option *o)
81 for (i = 0; i < PARSE_MAX_VP; i++) {
82 const struct value_pair *vp = &o->posval[i];
87 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
89 log_info(" %s", vp->help);
97 static void show_option_help(struct fio_option *o, int is_err)
99 const char *typehelp[] = {
103 "string with possible k/m/g postfix (opt=4k)",
104 "string with time postfix (opt=10s)",
106 "string with dual range (opt=1k-4k,4k-8k)",
107 "integer value (opt=100)",
108 "boolean value (opt=1)",
109 "list of floating point values separated by ':' (opt=5.9:7.8)",
113 size_t (*logger)(const char *format, ...);
121 logger("%20s: %s\n", "alias", o->alias);
123 logger("%20s: %s\n", "type", typehelp[o->type]);
124 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
126 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
127 show_option_range(o, logger);
128 show_option_values(o);
131 static unsigned long long get_mult_time(const char *str, int len,
136 unsigned long long mult = 1;
139 * Go forward until we hit a non-digit, or +/- sign
141 while ((p - str) <= len) {
142 if (!isdigit((int) *p) && (*p != '+') && (*p != '-'))
147 if (!isalpha((int) *p)) {
155 for (int i = 0; i < strlen(c); i++)
156 c[i] = tolower(c[i]);
158 if (!strncmp("us", c, 2) || !strncmp("usec", c, 4))
160 else if (!strncmp("ms", c, 2) || !strncmp("msec", c, 4))
162 else if (!strcmp("s", c))
164 else if (!strcmp("m", c))
165 mult = 60 * 1000000UL;
166 else if (!strcmp("h", c))
167 mult = 60 * 60 * 1000000UL;
168 else if (!strcmp("d", c))
169 mult = 24 * 60 * 60 * 1000000UL;
175 static int is_separator(char c)
188 static unsigned long long __get_mult_bytes(const char *p, void *data,
191 unsigned int kb_base = fio_get_kb_base(data);
192 unsigned long long ret = 1;
193 unsigned int i, pow = 0, mult = kb_base;
201 for (i = 0; i < strlen(c); i++) {
202 c[i] = tolower(c[i]);
203 if (is_separator(c[i])) {
209 if (!strncmp("pib", c, 3)) {
212 } else if (!strncmp("tib", c, 3)) {
215 } else if (!strncmp("gib", c, 3)) {
218 } else if (!strncmp("mib", c, 3)) {
221 } else if (!strncmp("kib", c, 3)) {
224 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
226 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
228 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
230 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
232 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
234 else if (!strncmp("%", c, 1)) {
241 ret *= (unsigned long long) mult;
247 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
254 return __get_mult_bytes(str, data, percent);
257 * Go forward until we hit a non-digit, or +/- sign
259 while ((p - str) <= len) {
260 if (!isdigit((int) *p) &&
261 (((*p != '+') && (*p != '-')) || digit_seen))
263 digit_seen |= isdigit((int) *p);
267 if (!isalpha((int) *p) && (*p != '%'))
270 return __get_mult_bytes(p, data, percent);
273 extern int evaluate_arithmetic_expression(const char *buffer, long long *ival,
274 double *dval, double implied_units,
278 * Convert string into a floating number. Return 1 for success and 0 otherwise.
280 int str_to_float(const char *str, double *val, int is_time)
282 #ifdef CONFIG_ARITHMETIC
288 rc = evaluate_arithmetic_expression(str, &ival, &dval, 1.0, is_time);
295 return 1 == sscanf(str, "%lf", val);
299 * convert string into decimal value, noting any size suffix
301 int str_to_decimal(const char *str, long long *val, int kilo, void *data,
302 int is_seconds, int is_time)
306 #ifdef CONFIG_ARITHMETIC
309 double implied_units = 1.0;
316 #ifdef CONFIG_ARITHMETIC
318 implied_units = 1000000.0;
320 rc = evaluate_arithmetic_expression(str, &ival, &dval, implied_units, is_time);
321 if (str[0] == '(' && !rc) {
322 if (!kilo && is_seconds)
323 *val = ival / 1000000LL;
330 if (strstr(str, "0x") || strstr(str, "0X"))
335 *val = strtoll(str, NULL, base);
336 if (*val == LONG_MAX && errno == ERANGE)
341 unsigned long long mult;
344 mult = get_mult_bytes(str, len, data, &perc);
350 *val *= get_mult_time(str, len, is_seconds);
355 int check_str_bytes(const char *p, long long *val, void *data)
357 return str_to_decimal(p, val, 1, data, 0, 0);
360 int check_str_time(const char *p, long long *val, int is_seconds)
362 return str_to_decimal(p, val, 0, NULL, is_seconds, 1);
365 void strip_blank_front(char **p)
371 while (isspace((int) *s))
377 void strip_blank_end(char *p)
394 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
400 static int check_range_bytes(const char *str, long *val, void *data)
404 if (!str_to_decimal(str, &__val, 1, data, 0, 0)) {
412 static int check_int(const char *p, int *val)
416 if (strstr(p, "0x") || strstr(p, "0X")) {
417 if (sscanf(p, "%x", val) == 1)
420 if (sscanf(p, "%u", val) == 1)
427 static size_t opt_len(const char *str)
431 postfix = strchr(str, ':');
435 return (int)(postfix - str);
438 static int str_match_len(const struct value_pair *vp, const char *str)
440 return max(strlen(vp->ival), opt_len(str));
443 #define val_store(ptr, val, off, or, data, o) \
445 ptr = td_var((data), (o), (off)); \
452 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
453 int first, int more, int curr)
457 long long ull, *ullp;
461 int ret = 0, is_time = 0;
462 const struct value_pair *vp;
463 struct value_pair posval[PARSE_MAX_VP];
464 int i, all_skipped = 1;
466 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
469 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
470 log_err("Option %s requires an argument\n", o->name);
476 case FIO_OPT_STR_MULTI: {
477 fio_opt_str_fn *fn = o->cb;
479 posval_sort(o, posval);
482 for (i = 0; i < PARSE_MAX_VP; i++) {
484 if (!vp->ival || vp->ival[0] == '\0')
489 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
492 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
497 if (ret && !all_skipped)
498 show_option_values(o);
503 case FIO_OPT_STR_VAL_TIME:
506 case FIO_OPT_STR_VAL: {
507 fio_opt_str_val_fn *fn = o->cb;
510 if (!is_time && o->is_time)
511 is_time = o->is_time;
513 tmp[sizeof(tmp) - 1] = '\0';
514 strncpy(tmp, ptr, sizeof(tmp) - 1);
515 p = strchr(tmp, ',');
520 ret = check_str_time(tmp, &ull, o->is_seconds);
522 ret = check_str_bytes(tmp, &ull, data);
524 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
528 if (o->pow2 && !is_power_of_2(ull)) {
529 log_err("%s: must be a power-of-2\n", o->name);
533 if (o->maxval && ull > o->maxval) {
534 log_err("max value out of range: %llu"
535 " (%u max)\n", ull, o->maxval);
538 if (o->minval && ull < o->minval) {
539 log_err("min value out of range: %llu"
540 " (%u min)\n", ull, o->minval);
543 if (o->posval[0].ival) {
544 posval_sort(o, posval);
547 for (i = 0; i < PARSE_MAX_VP; i++) {
549 if (!vp->ival || vp->ival[0] == '\0')
551 if (vp->oval == ull) {
557 log_err("fio: value %llu not allowed:\n", ull);
558 show_option_values(o);
564 ret = fn(data, &ull);
566 if (o->type == FIO_OPT_INT) {
568 val_store(ilp, ull, o->off1, 0, data, o);
571 val_store(ilp, ull, o->off2, 0, data, o);
575 val_store(ilp, ull, o->off3, 0, data, o);
580 val_store(ilp, ull, o->off2, 0, data, o);
584 val_store(ilp, ull, o->off3, 0, data, o);
589 val_store(ullp, ull, o->off1, 0, data, o);
592 val_store(ullp, ull, o->off2, 0, data, o);
598 case FIO_OPT_FLOAT_LIST: {
603 ** Initialize precision to 0 and zero out list
604 ** in case specified list is shorter than default
608 ilp = td_var(data, o, o->off2);
612 flp = td_var(data, o, o->off1);
613 for(i = 0; i < o->maxlen; i++)
616 if (curr >= o->maxlen) {
617 log_err("the list exceeding max length %d\n",
621 if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
622 log_err("not a floating point value: %s\n", ptr);
626 log_err("value out of range: %f"
627 " (range max: %f)\n", uf, o->maxfp);
631 log_err("value out of range: %f"
632 " (range min: %f)\n", uf, o->minfp);
636 flp = td_var(data, o, o->off1);
639 dprint(FD_PARSE, " out=%f\n", uf);
642 ** Calculate precision for output by counting
643 ** number of digits after period. Find first
644 ** period in entire remaining list each time
646 cp2 = strchr(ptr, '.');
650 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
654 ilp = td_var(data, o, o->off2);
662 case FIO_OPT_STR_STORE: {
663 fio_opt_str_fn *fn = o->cb;
669 cp = td_var(data, o, o->off1);
675 else if (o->posval[0].ival) {
676 posval_sort(o, posval);
679 for (i = 0; i < PARSE_MAX_VP; i++) {
681 if (!vp->ival || vp->ival[0] == '\0' || !cp)
684 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
690 rest = strstr(*cp ?: ptr, ":");
704 show_option_values(o);
713 case FIO_OPT_RANGE: {
717 tmp[sizeof(tmp) - 1] = '\0';
718 strncpy(tmp, ptr, sizeof(tmp) - 1);
720 /* Handle bsrange with separate read,write values: */
721 p1 = strchr(tmp, ',');
725 p1 = strchr(tmp, '-');
727 p1 = strchr(tmp, ':');
739 if (!check_range_bytes(p1, &ul1, data) &&
740 !check_range_bytes(p2, &ul2, data)) {
743 unsigned long foo = ul1;
750 val_store(ilp, ul1, o->off1, 0, data, o);
751 val_store(ilp, ul2, o->off2, 0, data, o);
754 if (o->off3 && o->off4) {
755 val_store(ilp, ul1, o->off3, 0, data, o);
756 val_store(ilp, ul2, o->off4, 0, data, o);
760 if (o->off5 && o->off6) {
761 val_store(ilp, ul1, o->off5, 0, data, o);
762 val_store(ilp, ul2, o->off6, 0, data, o);
767 if (o->off3 && o->off4) {
768 val_store(ilp, ul1, o->off3, 0, data, o);
769 val_store(ilp, ul2, o->off4, 0, data, o);
773 if (o->off5 && o->off6) {
774 val_store(ilp, ul1, o->off5, 0, data, o);
775 val_store(ilp, ul2, o->off6, 0, data, o);
784 case FIO_OPT_STR_SET: {
785 fio_opt_int_fn *fn = o->cb;
788 ret = check_int(ptr, &il);
789 else if (o->type == FIO_OPT_BOOL)
794 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
799 if (o->maxval && il > (int) o->maxval) {
800 log_err("max value out of range: %d (%d max)\n",
804 if (o->minval && il < o->minval) {
805 log_err("min value out of range: %d (%d min)\n",
817 val_store(ilp, il, o->off1, 0, data, o);
820 val_store(ilp, il, o->off2, 0, data, o);
825 case FIO_OPT_DEPRECATED:
826 log_info("Option %s is deprecated\n", o->name);
830 log_err("Bad option type %u\n", o->type);
838 ret = o->verify(o, data);
840 log_err("Correct format for offending option\n");
841 log_err("%20s: %s\n", o->name, o->help);
842 show_option_help(o, 1);
849 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
851 char *o_ptr, *ptr, *ptr2;
854 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
858 o_ptr = ptr = strdup(__ptr);
861 * See if we have another set of parameters, hidden after a comma.
862 * Do this before parsing this round, to check if we should
863 * copy set 1 options to set 2.
872 (o->type != FIO_OPT_STR_STORE) &&
873 (o->type != FIO_OPT_STR) &&
874 (o->type != FIO_OPT_FLOAT_LIST)) {
875 ptr2 = strchr(ptr, ',');
876 if (ptr2 && *(ptr2 + 1) == '\0')
878 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
880 ptr2 = strchr(ptr, ':');
882 ptr2 = strchr(ptr, '-');
884 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
885 ptr2 = strchr(ptr, ':');
889 * Don't return early if parsing the first option fails - if
890 * we are doing multiple arguments, we can allow the first one
893 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
909 struct fio_option *find_option(struct fio_option *options, const char *opt)
911 struct fio_option *o;
913 for (o = &options[0]; o->name; o++) {
914 if (!o_match(o, opt))
916 if (o->type == FIO_OPT_UNSUPPORTED) {
917 log_err("Option <%s>: %s\n", o->name, o->help);
928 static struct fio_option *get_option(char *opt,
929 struct fio_option *options, char **post)
931 struct fio_option *o;
934 ret = strchr(opt, '=');
940 strip_blank_end(ret);
941 o = find_option(options, ret);
943 o = find_option(options, opt);
950 static int opt_cmp(const void *p1, const void *p2)
952 struct fio_option *o;
959 s = strdup(*((char **) p1));
960 o = get_option(s, __fio_options, &foo);
966 s = strdup(*((char **) p2));
967 o = get_option(s, __fio_options, &foo);
973 return prio2 - prio1;
976 void sort_options(char **opts, struct fio_option *options, int num_opts)
978 __fio_options = options;
979 qsort(opts, num_opts, sizeof(char *), opt_cmp);
980 __fio_options = NULL;
983 static void add_to_dump_list(struct fio_option *o, struct flist_head *dump_list,
986 struct print_option *p;
991 p = malloc(sizeof(*p));
992 p->name = strdup(o->name);
994 p->value = strdup(post);
998 flist_add_tail(&p->list, dump_list);
1001 int parse_cmd_option(const char *opt, const char *val,
1002 struct fio_option *options, void *data,
1003 struct flist_head *dump_list)
1005 struct fio_option *o;
1007 o = find_option(options, opt);
1009 log_err("Bad option <%s>\n", opt);
1013 if (handle_option(o, val, data)) {
1014 log_err("fio: failed parsing %s=%s\n", opt, val);
1018 add_to_dump_list(o, dump_list, val);
1022 int parse_option(char *opt, const char *input,
1023 struct fio_option *options, struct fio_option **o, void *data,
1024 struct flist_head *dump_list)
1029 log_err("fio: failed parsing %s\n", input);
1034 *o = get_option(opt, options, &post);
1037 int len = strlen(opt);
1038 if (opt + len + 1 != post)
1039 memmove(opt + len + 1, post, strlen(post));
1045 if (handle_option(*o, post, data)) {
1046 log_err("fio: failed parsing %s\n", input);
1050 add_to_dump_list(*o, dump_list, post);
1055 * Option match, levenshtein distance. Handy for not quite remembering what
1056 * the option name is.
1058 int string_distance(const char *s1, const char *s2)
1060 unsigned int s1_len = strlen(s1);
1061 unsigned int s2_len = strlen(s2);
1062 unsigned int *p, *q, *r;
1065 p = malloc(sizeof(unsigned int) * (s2_len + 1));
1066 q = malloc(sizeof(unsigned int) * (s2_len + 1));
1069 for (i = 1; i <= s2_len; i++)
1070 p[i] = p[i - 1] + 1;
1072 for (i = 1; i <= s1_len; i++) {
1074 for (j = 1; j <= s2_len; j++) {
1075 unsigned int sub = p[j - 1];
1078 if (s1[i - 1] != s2[j - 1])
1081 pmin = min(q[j - 1] + 1, sub);
1082 q[j] = min(p[j] + 1, pmin);
1096 * Make a guess of whether the distance from 's1' is significant enough
1097 * to warrant printing the guess. We set this to a 1/2 match.
1099 int string_distance_ok(const char *opt, int distance)
1104 len = (len + 1) / 2;
1105 return distance <= len;
1108 static struct fio_option *find_child(struct fio_option *options,
1109 struct fio_option *o)
1111 struct fio_option *__o;
1113 for (__o = options + 1; __o->name; __o++)
1114 if (__o->parent && !strcmp(__o->parent, o->name))
1120 static void __print_option(struct fio_option *o, struct fio_option *org,
1134 p += sprintf(p, "%s", " ");
1136 sprintf(p, "%s", o->name);
1138 log_info("%-24s: %s\n", name, o->help);
1141 static void print_option(struct fio_option *o)
1143 struct fio_option *parent;
1144 struct fio_option *__o;
1145 unsigned int printed;
1148 __print_option(o, NULL, 0);
1155 while ((__o = find_child(o, parent)) != NULL) {
1156 __print_option(__o, o, level);
1165 int show_cmd_help(struct fio_option *options, const char *name)
1167 struct fio_option *o, *closest;
1168 unsigned int best_dist = -1U;
1172 if (!name || !strcmp(name, "all"))
1177 for (o = &options[0]; o->name; o++) {
1180 if (o->type == FIO_OPT_DEPRECATED)
1182 if (!exec_profile && o->prof_name)
1184 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1188 if (!strcmp(name, o->name) ||
1189 (o->alias && !strcmp(name, o->alias)))
1194 dist = string_distance(name, o->name);
1195 if (dist < best_dist) {
1202 if (show_all || match) {
1205 log_info("%20s: %s\n", o->name, o->help);
1216 show_option_help(o, 0);
1222 log_err("No such command: %s", name);
1225 * Only print an appropriately close option, one where the edit
1226 * distance isn't too big. Otherwise we get crazy matches.
1228 if (closest && best_dist < 3) {
1229 log_info(" - showing closest match\n");
1230 log_info("%20s: %s\n", closest->name, closest->help);
1231 show_option_help(closest, 0);
1239 * Handle parsing of default parameters.
1241 void fill_default_options(void *data, struct fio_option *options)
1243 struct fio_option *o;
1245 dprint(FD_PARSE, "filling default options\n");
1247 for (o = &options[0]; o->name; o++)
1249 handle_option(o, o->def, data);
1252 void option_init(struct fio_option *o)
1254 if (o->type == FIO_OPT_DEPRECATED || o->type == FIO_OPT_UNSUPPORTED)
1256 if (o->name && !o->lname)
1257 log_err("Option %s: missing long option name\n", o->name);
1258 if (o->type == FIO_OPT_BOOL) {
1262 if (o->type == FIO_OPT_INT) {
1264 o->maxval = UINT_MAX;
1266 if (o->type == FIO_OPT_FLOAT_LIST) {
1270 if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
1271 log_err("Option %s: string set option with"
1272 " default will always be true\n", o->name);
1274 if (!o->cb && !o->off1)
1275 log_err("Option %s: neither cb nor offset given\n", o->name);
1277 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1278 o->category = FIO_OPT_C_GENERAL;
1279 o->group = FIO_OPT_G_INVALID;
1281 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1282 o->type == FIO_OPT_STR_MULTI)
1287 * Sanitize the options structure. For now it just sets min/max for bool
1288 * values and whether both callback and offsets are given.
1290 void options_init(struct fio_option *options)
1292 struct fio_option *o;
1294 dprint(FD_PARSE, "init options\n");
1296 for (o = &options[0]; o->name; o++) {
1299 o->inv_opt = find_option(options, o->inverse);
1303 void options_free(struct fio_option *options, void *data)
1305 struct fio_option *o;
1308 dprint(FD_PARSE, "free options\n");
1310 for (o = &options[0]; o->name; o++) {
1311 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1314 ptr = td_var(data, o, o->off1);