2 * This file contains the ini and command liner parser main.
19 #include "lib/ieee754.h"
22 #ifdef CONFIG_ARITHMETIC
26 static struct fio_option *__fio_options;
28 static int vp_cmp(const void *p1, const void *p2)
30 const struct value_pair *vp1 = p1;
31 const struct value_pair *vp2 = p2;
33 return strlen(vp2->ival) - strlen(vp1->ival);
36 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
38 const struct value_pair *vp;
41 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
43 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
44 vp = &o->posval[entries];
45 if (!vp->ival || vp->ival[0] == '\0')
48 memcpy(&vpmap[entries], vp, sizeof(*vp));
51 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
54 static void show_option_range(struct fio_option *o,
55 size_t (*logger)(const char *format, ...))
57 if (o->type == FIO_OPT_FLOAT_LIST) {
58 if (o->minfp == DBL_MIN && o->maxfp == DBL_MAX)
61 logger("%20s: min=%f", "range", o->minfp);
62 if (o->maxfp != DBL_MAX)
63 logger(", max=%f", o->maxfp);
65 } else if (!o->posval[0].ival) {
66 if (!o->minval && !o->maxval)
69 logger("%20s: min=%d", "range", o->minval);
71 logger(", max=%d", o->maxval);
76 static void show_option_values(struct fio_option *o)
80 for (i = 0; i < PARSE_MAX_VP; i++) {
81 const struct value_pair *vp = &o->posval[i];
86 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
88 log_info(" %s", vp->help);
96 static void show_option_help(struct fio_option *o, int is_err)
98 const char *typehelp[] = {
102 "string with possible k/m/g postfix (opt=4k)",
103 "string with time postfix (opt=10s)",
105 "string with dual range (opt=1k-4k,4k-8k)",
106 "integer value (opt=100)",
107 "boolean value (opt=1)",
108 "list of floating point values separated by ':' (opt=5.9:7.8)",
112 size_t (*logger)(const char *format, ...);
120 logger("%20s: %s\n", "alias", o->alias);
122 logger("%20s: %s\n", "type", typehelp[o->type]);
123 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
125 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
126 show_option_range(o, logger);
127 show_option_values(o);
130 static unsigned long long get_mult_time(const char *str, int len,
135 unsigned long long mult = 1;
138 * Go forward until we hit a non-digit, or +/- sign
140 while ((p - str) <= len) {
141 if (!isdigit((int) *p) && (*p != '+') && (*p != '-'))
146 if (!isalpha((int) *p)) {
154 for (int i = 0; i < strlen(c); i++)
155 c[i] = tolower(c[i]);
157 if (!strncmp("us", c, 2) || !strncmp("usec", c, 4))
159 else if (!strncmp("ms", c, 2) || !strncmp("msec", c, 4))
161 else if (!strcmp("s", c))
163 else if (!strcmp("m", c))
164 mult = 60 * 1000000UL;
165 else if (!strcmp("h", c))
166 mult = 60 * 60 * 1000000UL;
167 else if (!strcmp("d", c))
168 mult = 24 * 60 * 60 * 1000000UL;
174 static int is_separator(char c)
187 static unsigned long long __get_mult_bytes(const char *p, void *data,
190 unsigned int kb_base = fio_get_kb_base(data);
191 unsigned long long ret = 1;
192 unsigned int i, pow = 0, mult = kb_base;
200 for (i = 0; i < strlen(c); i++) {
201 c[i] = tolower(c[i]);
202 if (is_separator(c[i])) {
208 if (!strncmp("pib", c, 3)) {
211 } else if (!strncmp("tib", c, 3)) {
214 } else if (!strncmp("gib", c, 3)) {
217 } else if (!strncmp("mib", c, 3)) {
220 } else if (!strncmp("kib", c, 3)) {
223 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
225 else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
227 else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
229 else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
231 else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
233 else if (!strncmp("%", c, 1)) {
240 ret *= (unsigned long long) mult;
246 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
253 return __get_mult_bytes(str, data, percent);
256 * Go forward until we hit a non-digit, or +/- sign
258 while ((p - str) <= len) {
259 if (!isdigit((int) *p) &&
260 (((*p != '+') && (*p != '-')) || digit_seen))
262 digit_seen |= isdigit((int) *p);
266 if (!isalpha((int) *p) && (*p != '%'))
269 return __get_mult_bytes(p, data, percent);
272 extern int evaluate_arithmetic_expression(const char *buffer, long long *ival,
273 double *dval, double implied_units,
277 * Convert string into a floating number. Return 1 for success and 0 otherwise.
279 int str_to_float(const char *str, double *val, int is_time)
281 #ifdef CONFIG_ARITHMETIC
287 rc = evaluate_arithmetic_expression(str, &ival, &dval, 1.0, is_time);
294 return 1 == sscanf(str, "%lf", val);
298 * convert string into decimal value, noting any size suffix
300 int str_to_decimal(const char *str, long long *val, int kilo, void *data,
301 int is_seconds, int is_time)
305 #ifdef CONFIG_ARITHMETIC
308 double implied_units = 1.0;
315 #ifdef CONFIG_ARITHMETIC
317 implied_units = 1000000.0;
319 rc = evaluate_arithmetic_expression(str, &ival, &dval, implied_units, is_time);
320 if (str[0] == '(' && !rc) {
321 if (!kilo && is_seconds)
322 *val = ival / 1000000LL;
329 if (strstr(str, "0x") || strstr(str, "0X"))
334 *val = strtoll(str, NULL, base);
335 if (*val == LONG_MAX && errno == ERANGE)
340 unsigned long long mult;
343 mult = get_mult_bytes(str, len, data, &perc);
349 *val *= get_mult_time(str, len, is_seconds);
354 int check_str_bytes(const char *p, long long *val, void *data)
356 return str_to_decimal(p, val, 1, data, 0, 0);
359 int check_str_time(const char *p, long long *val, int is_seconds)
361 return str_to_decimal(p, val, 0, NULL, is_seconds, 1);
364 void strip_blank_front(char **p)
370 while (isspace((int) *s))
376 void strip_blank_end(char *p)
393 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
399 static int check_range_bytes(const char *str, long *val, void *data)
403 if (!str_to_decimal(str, &__val, 1, data, 0, 0)) {
411 static int check_int(const char *p, int *val)
415 if (strstr(p, "0x") || strstr(p, "0X")) {
416 if (sscanf(p, "%x", val) == 1)
419 if (sscanf(p, "%u", val) == 1)
426 static size_t opt_len(const char *str)
430 postfix = strchr(str, ':');
434 return (int)(postfix - str);
437 static int str_match_len(const struct value_pair *vp, const char *str)
439 return max(strlen(vp->ival), opt_len(str));
442 #define val_store(ptr, val, off, or, data, o) \
444 ptr = td_var((data), (o), (off)); \
451 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
452 int first, int more, int curr)
456 long long ull, *ullp;
460 int ret = 0, is_time = 0;
461 const struct value_pair *vp;
462 struct value_pair posval[PARSE_MAX_VP];
463 int i, all_skipped = 1;
465 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
468 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
469 log_err("Option %s requires an argument\n", o->name);
475 case FIO_OPT_STR_MULTI: {
476 fio_opt_str_fn *fn = o->cb;
478 posval_sort(o, posval);
481 for (i = 0; i < PARSE_MAX_VP; i++) {
483 if (!vp->ival || vp->ival[0] == '\0')
488 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
491 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
496 if (ret && !all_skipped)
497 show_option_values(o);
502 case FIO_OPT_STR_VAL_TIME:
505 case FIO_OPT_STR_VAL: {
506 fio_opt_str_val_fn *fn = o->cb;
509 if (!is_time && o->is_time)
510 is_time = o->is_time;
512 tmp[sizeof(tmp) - 1] = '\0';
513 strncpy(tmp, ptr, sizeof(tmp) - 1);
514 p = strchr(tmp, ',');
519 ret = check_str_time(tmp, &ull, o->is_seconds);
521 ret = check_str_bytes(tmp, &ull, data);
523 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
527 if (o->pow2 && !is_power_of_2(ull)) {
528 log_err("%s: must be a power-of-2\n", o->name);
532 if (o->maxval && ull > o->maxval) {
533 log_err("max value out of range: %llu"
534 " (%u max)\n", ull, o->maxval);
537 if (o->minval && ull < o->minval) {
538 log_err("min value out of range: %llu"
539 " (%u min)\n", ull, o->minval);
542 if (o->posval[0].ival) {
543 posval_sort(o, posval);
546 for (i = 0; i < PARSE_MAX_VP; i++) {
548 if (!vp->ival || vp->ival[0] == '\0')
550 if (vp->oval == ull) {
556 log_err("fio: value %llu not allowed:\n", ull);
557 show_option_values(o);
563 ret = fn(data, &ull);
565 if (o->type == FIO_OPT_INT) {
567 val_store(ilp, ull, o->off1, 0, data, o);
570 val_store(ilp, ull, o->off2, 0, data, o);
574 val_store(ilp, ull, o->off3, 0, data, o);
579 val_store(ilp, ull, o->off2, 0, data, o);
583 val_store(ilp, ull, o->off3, 0, data, o);
588 val_store(ullp, ull, o->off1, 0, data, o);
591 val_store(ullp, ull, o->off2, 0, data, o);
597 case FIO_OPT_FLOAT_LIST: {
602 ** Initialize precision to 0 and zero out list
603 ** in case specified list is shorter than default
607 ilp = td_var(data, o, o->off2);
611 flp = td_var(data, o, o->off1);
612 for(i = 0; i < o->maxlen; i++)
615 if (curr >= o->maxlen) {
616 log_err("the list exceeding max length %d\n",
620 if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
621 log_err("not a floating point value: %s\n", ptr);
625 log_err("value out of range: %f"
626 " (range max: %f)\n", uf, o->maxfp);
630 log_err("value out of range: %f"
631 " (range min: %f)\n", uf, o->minfp);
635 flp = td_var(data, o, o->off1);
638 dprint(FD_PARSE, " out=%f\n", uf);
641 ** Calculate precision for output by counting
642 ** number of digits after period. Find first
643 ** period in entire remaining list each time
645 cp2 = strchr(ptr, '.');
649 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
653 ilp = td_var(data, o, o->off2);
661 case FIO_OPT_STR_STORE: {
662 fio_opt_str_fn *fn = o->cb;
668 cp = td_var(data, o, o->off1);
674 else if (o->posval[0].ival) {
675 posval_sort(o, posval);
678 for (i = 0; i < PARSE_MAX_VP; i++) {
680 if (!vp->ival || vp->ival[0] == '\0' || !cp)
683 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
689 rest = strstr(*cp ?: ptr, ":");
703 show_option_values(o);
712 case FIO_OPT_RANGE: {
716 tmp[sizeof(tmp) - 1] = '\0';
717 strncpy(tmp, ptr, sizeof(tmp) - 1);
719 /* Handle bsrange with separate read,write values: */
720 p1 = strchr(tmp, ',');
724 p1 = strchr(tmp, '-');
726 p1 = strchr(tmp, ':');
738 if (!check_range_bytes(p1, &ul1, data) &&
739 !check_range_bytes(p2, &ul2, data)) {
742 unsigned long foo = ul1;
749 val_store(ilp, ul1, o->off1, 0, data, o);
750 val_store(ilp, ul2, o->off2, 0, data, o);
753 if (o->off3 && o->off4) {
754 val_store(ilp, ul1, o->off3, 0, data, o);
755 val_store(ilp, ul2, o->off4, 0, data, o);
759 if (o->off5 && o->off6) {
760 val_store(ilp, ul1, o->off5, 0, data, o);
761 val_store(ilp, ul2, o->off6, 0, data, o);
766 if (o->off3 && o->off4) {
767 val_store(ilp, ul1, o->off3, 0, data, o);
768 val_store(ilp, ul2, o->off4, 0, data, o);
772 if (o->off5 && o->off6) {
773 val_store(ilp, ul1, o->off5, 0, data, o);
774 val_store(ilp, ul2, o->off6, 0, data, o);
783 case FIO_OPT_STR_SET: {
784 fio_opt_int_fn *fn = o->cb;
787 ret = check_int(ptr, &il);
788 else if (o->type == FIO_OPT_BOOL)
793 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
798 if (o->maxval && il > (int) o->maxval) {
799 log_err("max value out of range: %d (%d max)\n",
803 if (o->minval && il < o->minval) {
804 log_err("min value out of range: %d (%d min)\n",
816 val_store(ilp, il, o->off1, 0, data, o);
819 val_store(ilp, il, o->off2, 0, data, o);
824 case FIO_OPT_DEPRECATED:
825 log_info("Option %s is deprecated\n", o->name);
829 log_err("Bad option type %u\n", o->type);
837 ret = o->verify(o, data);
839 log_err("Correct format for offending option\n");
840 log_err("%20s: %s\n", o->name, o->help);
841 show_option_help(o, 1);
848 static int handle_option(struct fio_option *o, const char *__ptr, void *data)
850 char *o_ptr, *ptr, *ptr2;
853 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
857 o_ptr = ptr = strdup(__ptr);
860 * See if we have another set of parameters, hidden after a comma.
861 * Do this before parsing this round, to check if we should
862 * copy set 1 options to set 2.
871 (o->type != FIO_OPT_STR_STORE) &&
872 (o->type != FIO_OPT_STR) &&
873 (o->type != FIO_OPT_FLOAT_LIST)) {
874 ptr2 = strchr(ptr, ',');
875 if (ptr2 && *(ptr2 + 1) == '\0')
877 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
879 ptr2 = strchr(ptr, ':');
881 ptr2 = strchr(ptr, '-');
883 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
884 ptr2 = strchr(ptr, ':');
888 * Don't return early if parsing the first option fails - if
889 * we are doing multiple arguments, we can allow the first one
892 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
908 static struct fio_option *get_option(char *opt,
909 struct fio_option *options, char **post)
911 struct fio_option *o;
914 ret = strchr(opt, '=');
920 strip_blank_end(ret);
921 o = find_option(options, ret);
923 o = find_option(options, opt);
930 static int opt_cmp(const void *p1, const void *p2)
932 struct fio_option *o;
939 s = strdup(*((char **) p1));
940 o = get_option(s, __fio_options, &foo);
946 s = strdup(*((char **) p2));
947 o = get_option(s, __fio_options, &foo);
953 return prio2 - prio1;
956 void sort_options(char **opts, struct fio_option *options, int num_opts)
958 __fio_options = options;
959 qsort(opts, num_opts, sizeof(char *), opt_cmp);
960 __fio_options = NULL;
963 static void add_to_dump_list(struct fio_option *o, struct flist_head *dump_list,
966 struct print_option *p;
971 p = malloc(sizeof(*p));
972 p->name = strdup(o->name);
974 p->value = strdup(post);
978 flist_add_tail(&p->list, dump_list);
981 int parse_cmd_option(const char *opt, const char *val,
982 struct fio_option *options, void *data,
983 struct flist_head *dump_list)
985 struct fio_option *o;
987 o = find_option(options, opt);
989 log_err("Bad option <%s>\n", opt);
993 if (handle_option(o, val, data)) {
994 log_err("fio: failed parsing %s=%s\n", opt, val);
998 add_to_dump_list(o, dump_list, val);
1002 int parse_option(char *opt, const char *input,
1003 struct fio_option *options, struct fio_option **o, void *data,
1004 struct flist_head *dump_list)
1009 log_err("fio: failed parsing %s\n", input);
1014 *o = get_option(opt, options, &post);
1017 int len = strlen(opt);
1018 if (opt + len + 1 != post)
1019 memmove(opt + len + 1, post, strlen(post));
1025 if (handle_option(*o, post, data)) {
1026 log_err("fio: failed parsing %s\n", input);
1030 add_to_dump_list(*o, dump_list, post);
1035 * Option match, levenshtein distance. Handy for not quite remembering what
1036 * the option name is.
1038 int string_distance(const char *s1, const char *s2)
1040 unsigned int s1_len = strlen(s1);
1041 unsigned int s2_len = strlen(s2);
1042 unsigned int *p, *q, *r;
1045 p = malloc(sizeof(unsigned int) * (s2_len + 1));
1046 q = malloc(sizeof(unsigned int) * (s2_len + 1));
1049 for (i = 1; i <= s2_len; i++)
1050 p[i] = p[i - 1] + 1;
1052 for (i = 1; i <= s1_len; i++) {
1054 for (j = 1; j <= s2_len; j++) {
1055 unsigned int sub = p[j - 1];
1058 if (s1[i - 1] != s2[j - 1])
1061 pmin = min(q[j - 1] + 1, sub);
1062 q[j] = min(p[j] + 1, pmin);
1076 * Make a guess of whether the distance from 's1' is significant enough
1077 * to warrant printing the guess. We set this to a 1/2 match.
1079 int string_distance_ok(const char *opt, int distance)
1084 len = (len + 1) / 2;
1085 return distance <= len;
1088 static struct fio_option *find_child(struct fio_option *options,
1089 struct fio_option *o)
1091 struct fio_option *__o;
1093 for (__o = options + 1; __o->name; __o++)
1094 if (__o->parent && !strcmp(__o->parent, o->name))
1100 static void __print_option(struct fio_option *o, struct fio_option *org,
1114 p += sprintf(p, "%s", " ");
1116 sprintf(p, "%s", o->name);
1118 log_info("%-24s: %s\n", name, o->help);
1121 static void print_option(struct fio_option *o)
1123 struct fio_option *parent;
1124 struct fio_option *__o;
1125 unsigned int printed;
1128 __print_option(o, NULL, 0);
1135 while ((__o = find_child(o, parent)) != NULL) {
1136 __print_option(__o, o, level);
1145 int show_cmd_help(struct fio_option *options, const char *name)
1147 struct fio_option *o, *closest;
1148 unsigned int best_dist = -1U;
1152 if (!name || !strcmp(name, "all"))
1157 for (o = &options[0]; o->name; o++) {
1160 if (o->type == FIO_OPT_DEPRECATED)
1162 if (!exec_profile && o->prof_name)
1164 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1168 if (!strcmp(name, o->name) ||
1169 (o->alias && !strcmp(name, o->alias)))
1174 dist = string_distance(name, o->name);
1175 if (dist < best_dist) {
1182 if (show_all || match) {
1185 log_info("%20s: %s\n", o->name, o->help);
1196 show_option_help(o, 0);
1202 log_err("No such command: %s", name);
1205 * Only print an appropriately close option, one where the edit
1206 * distance isn't too big. Otherwise we get crazy matches.
1208 if (closest && best_dist < 3) {
1209 log_info(" - showing closest match\n");
1210 log_info("%20s: %s\n", closest->name, closest->help);
1211 show_option_help(closest, 0);
1219 * Handle parsing of default parameters.
1221 void fill_default_options(void *data, struct fio_option *options)
1223 struct fio_option *o;
1225 dprint(FD_PARSE, "filling default options\n");
1227 for (o = &options[0]; o->name; o++)
1229 handle_option(o, o->def, data);
1232 void option_init(struct fio_option *o)
1234 if (o->type == FIO_OPT_DEPRECATED)
1236 if (o->type == FIO_OPT_BOOL) {
1240 if (o->type == FIO_OPT_INT) {
1242 o->maxval = UINT_MAX;
1244 if (o->type == FIO_OPT_FLOAT_LIST) {
1248 if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
1249 log_err("Option %s: string set option with"
1250 " default will always be true\n", o->name);
1252 if (!o->cb && !o->off1)
1253 log_err("Option %s: neither cb nor offset given\n", o->name);
1255 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1256 o->category = FIO_OPT_C_GENERAL;
1257 o->group = FIO_OPT_G_INVALID;
1259 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1260 o->type == FIO_OPT_STR_MULTI)
1265 * Sanitize the options structure. For now it just sets min/max for bool
1266 * values and whether both callback and offsets are given.
1268 void options_init(struct fio_option *options)
1270 struct fio_option *o;
1272 dprint(FD_PARSE, "init options\n");
1274 for (o = &options[0]; o->name; o++) {
1277 o->inv_opt = find_option(options, o->inverse);
1281 void options_free(struct fio_option *options, void *data)
1283 struct fio_option *o;
1286 dprint(FD_PARSE, "free options\n");
1288 for (o = &options[0]; o->name; o++) {
1289 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1292 ptr = td_var(data, o, o->off1);