parse: enable options to be marked dont-free
[fio.git] / parse.c
diff --git a/parse.c b/parse.c
index f82bca3fdccc22af2c704eb15e9ff98e2162f537..ecce8b89dba99f5bd8af7120d10a2843fac056cf 100644 (file)
--- a/parse.c
+++ b/parse.c
 #include "parse.h"
 #include "debug.h"
 #include "options.h"
+#include "optgroup.h"
 #include "minmax.h"
 #include "lib/ieee754.h"
+#include "lib/pow2.h"
+
+#ifdef CONFIG_ARITHMETIC
+#include "y.tab.h"
+#endif
 
 static struct fio_option *__fio_options;
 
@@ -47,7 +53,7 @@ static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
 }
 
 static void show_option_range(struct fio_option *o,
-                               int (*logger)(const char *format, ...))
+                             size_t (*logger)(const char *format, ...))
 {
        if (o->type == FIO_OPT_FLOAT_LIST) {
                if (o->minfp == DBL_MIN && o->maxfp == DBL_MAX)
@@ -103,8 +109,9 @@ static void show_option_help(struct fio_option *o, int is_err)
                "list of floating point values separated by ':' (opt=5.9:7.8)",
                "no argument (opt)",
                "deprecated",
+               "unsupported",
        };
-       int (*logger)(const char *format, ...);
+       size_t (*logger)(const char *format, ...);
 
        if (is_err)
                logger = log_err;
@@ -122,21 +129,49 @@ static void show_option_help(struct fio_option *o, int is_err)
        show_option_values(o);
 }
 
-static unsigned long get_mult_time(char c)
+static unsigned long long get_mult_time(const char *str, int len,
+                                       int is_seconds)
 {
-       switch (c) {
-       case 'm':
-       case 'M':
-               return 60;
-       case 'h':
-       case 'H':
-               return 60 * 60;
-       case 'd':
-       case 'D':
-               return 24 * 60 * 60;
-       default:
-               return 1;
+       const char *p = str;
+       char *c;
+       unsigned long long mult = 1;
+       int i;
+
+       /*
+         * Go forward until we hit a non-digit, or +/- sign
+         */
+       while ((p - str) <= len) {
+               if (!isdigit((int) *p) && (*p != '+') && (*p != '-'))
+                       break;
+               p++;
        }
+
+       if (!isalpha((int) *p)) {
+               if (is_seconds)
+                       return 1000000UL;
+               else
+                       return 1;
+       }
+
+       c = strdup(p);
+       for (i = 0; i < strlen(c); i++)
+               c[i] = tolower(c[i]);
+
+       if (!strncmp("us", c, 2) || !strncmp("usec", c, 4))
+               mult = 1;
+       else if (!strncmp("ms", c, 2) || !strncmp("msec", c, 4))
+               mult = 1000;
+       else if (!strcmp("s", c))
+               mult = 1000000;
+       else if (!strcmp("m", c))
+               mult = 60 * 1000000UL;
+       else if (!strcmp("h", c))
+               mult = 60 * 60 * 1000000UL;
+       else if (!strcmp("d", c))
+               mult = 24 * 60 * 60 * 1000000ULL;
+
+       free(c);
+       return mult;
 }
 
 static int is_separator(char c)
@@ -173,32 +208,50 @@ static unsigned long long __get_mult_bytes(const char *p, void *data,
                }
        }
 
+       /* If kb_base is 1000, use true units.
+        * If kb_base is 1024, use opposite units.
+        */
        if (!strncmp("pib", c, 3)) {
                pow = 5;
-               mult = 1000;
+               if (kb_base == 1000)
+                       mult = 1024;
+               else if (kb_base == 1024)
+                       mult = 1000;
        } else if (!strncmp("tib", c, 3)) {
                pow = 4;
-               mult = 1000;
+               if (kb_base == 1000)
+                       mult = 1024;
+               else if (kb_base == 1024)
+                       mult = 1000;
        } else if (!strncmp("gib", c, 3)) {
                pow = 3;
-               mult = 1000;
+               if (kb_base == 1000)
+                       mult = 1024;
+               else if (kb_base == 1024)
+                       mult = 1000;
        } else if (!strncmp("mib", c, 3)) {
                pow = 2;
-               mult = 1000;
+               if (kb_base == 1000)
+                       mult = 1024;
+               else if (kb_base == 1024)
+                       mult = 1000;
        } else if (!strncmp("kib", c, 3)) {
                pow = 1;
-               mult = 1000;
-       } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2))
+               if (kb_base == 1000)
+                       mult = 1024;
+               else if (kb_base == 1024)
+                       mult = 1000;
+       } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2)) {
                pow = 5;
-       else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2))
+       } else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2)) {
                pow = 4;
-       else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2))
+       } else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2)) {
                pow = 3;
-       else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2))
+       } else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2)) {
                pow = 2;
-       else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2))
+       } else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2)) {
                pow = 1;
-       else if (!strncmp("%", c, 1)) {
+       else if (!strncmp("%", c, 1)) {
                *percent = 1;
                free(c);
                return ret;
@@ -237,33 +290,72 @@ static unsigned long long get_mult_bytes(const char *str, int len, void *data,
        return __get_mult_bytes(p, data, percent);
 }
 
+extern int evaluate_arithmetic_expression(const char *buffer, long long *ival,
+                                         double *dval, double implied_units,
+                                         int is_time);
+
 /*
  * Convert string into a floating number. Return 1 for success and 0 otherwise.
  */
-int str_to_float(const char *str, double *val)
+int str_to_float(const char *str, double *val, int is_time)
 {
-       return (1 == sscanf(str, "%lf", val));
+#ifdef CONFIG_ARITHMETIC
+       int rc;
+       long long ival;
+       double dval;
+
+       if (str[0] == '(') {
+               rc = evaluate_arithmetic_expression(str, &ival, &dval, 1.0, is_time);
+               if (!rc) {
+                       *val = dval;
+                       return 1;
+               }
+       }
+#endif
+       return 1 == sscanf(str, "%lf", val);
 }
 
 /*
  * convert string into decimal value, noting any size suffix
  */
-int str_to_decimal(const char *str, long long *val, int kilo, void *data)
+int str_to_decimal(const char *str, long long *val, int kilo, void *data,
+                  int is_seconds, int is_time)
 {
        int len, base;
+       int rc = 1;
+#ifdef CONFIG_ARITHMETIC
+       long long ival;
+       double dval;
+       double implied_units = 1.0;
+#endif
 
        len = strlen(str);
        if (!len)
                return 1;
 
-       if (strstr(str, "0x") || strstr(str, "0X"))
-               base = 16;
-       else
-               base = 10;
+#ifdef CONFIG_ARITHMETIC
+       if (is_seconds)
+               implied_units = 1000000.0;
+       if (str[0] == '(')
+               rc = evaluate_arithmetic_expression(str, &ival, &dval, implied_units, is_time);
+       if (str[0] == '(' && !rc) {
+               if (!kilo && is_seconds)
+                       *val = ival / 1000000LL;
+               else
+                       *val = ival;
+       }
+#endif
 
-       *val = strtoll(str, NULL, base);
-       if (*val == LONG_MAX && errno == ERANGE)
-               return 1;
+       if (rc == 1) {
+               if (strstr(str, "0x") || strstr(str, "0X"))
+                       base = 16;
+               else
+                       base = 10;
+
+               *val = strtoll(str, NULL, base);
+               if (*val == LONG_MAX && errno == ERANGE)
+                       return 1;
+       }
 
        if (kilo) {
                unsigned long long mult;
@@ -275,19 +367,19 @@ int str_to_decimal(const char *str, long long *val, int kilo, void *data)
                else
                        *val *= mult;
        } else
-               *val *= get_mult_time(str[len - 1]);
+               *val *= get_mult_time(str, len, is_seconds);
 
        return 0;
 }
 
 int check_str_bytes(const char *p, long long *val, void *data)
 {
-       return str_to_decimal(p, val, 1, data);
+       return str_to_decimal(p, val, 1, data, 0, 0);
 }
 
-int check_str_time(const char *p, long long *val)
+int check_str_time(const char *p, long long *val, int is_seconds)
 {
-       return str_to_decimal(p, val, 0, NULL);
+       return str_to_decimal(p, val, 0, NULL, is_seconds, 1);
 }
 
 void strip_blank_front(char **p)
@@ -329,7 +421,7 @@ static int check_range_bytes(const char *str, long *val, void *data)
 {
        long long __val;
 
-       if (!str_to_decimal(str, &__val, 1, data)) {
+       if (!str_to_decimal(str, &__val, 1, data, 0, 0)) {
                *val = __val;
                return 0;
        }
@@ -352,7 +444,7 @@ static int check_int(const char *p, int *val)
        return 1;
 }
 
-static int opt_len(const char *str)
+static size_t opt_len(const char *str)
 {
        char *postfix;
 
@@ -368,16 +460,13 @@ static int str_match_len(const struct value_pair *vp, const char *str)
        return max(strlen(vp->ival), opt_len(str));
 }
 
-#define val_store(ptr, val, off, or, data, o)                  \
-       do {                                                    \
-               if ((o)->prof_opts)                             \
-                       ptr = td_var((o)->prof_opts, (off));    \
-               else                                            \
-                       ptr = td_var((data), (off));            \
-               if ((or))                                       \
-                       *ptr |= (val);                          \
-               else                                            \
-                       *ptr = (val);                           \
+#define val_store(ptr, val, off, or, data, o)          \
+       do {                                            \
+               ptr = td_var((data), (o), (off));       \
+               if ((or))                               \
+                       *ptr |= (val);                  \
+               else                                    \
+                       *ptr = (val);                   \
        } while (0)
 
 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
@@ -415,10 +504,12 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                        if (!vp->ival || vp->ival[0] == '\0')
                                continue;
                        all_skipped = 0;
+                       if (!ptr)
+                               break;
                        if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
                                ret = 0;
                                if (o->off1)
-                                       val_store(ilp, vp->oval, o->off1, vp->or, data, o);
+                                       val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
                                continue;
                        }
                }
@@ -436,13 +527,17 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                fio_opt_str_val_fn *fn = o->cb;
                char tmp[128], *p;
 
+               if (!is_time && o->is_time)
+                       is_time = o->is_time;
+
+               tmp[sizeof(tmp) - 1] = '\0';
                strncpy(tmp, ptr, sizeof(tmp) - 1);
                p = strchr(tmp, ',');
                if (p)
                        *p = '\0';
 
                if (is_time)
-                       ret = check_str_time(tmp, &ull);
+                       ret = check_str_time(tmp, &ull, o->is_seconds);
                else
                        ret = check_str_bytes(tmp, &ull, data);
 
@@ -450,6 +545,10 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
 
                if (ret)
                        break;
+               if (o->pow2 && !is_power_of_2(ull)) {
+                       log_err("%s: must be a power-of-2\n", o->name);
+                       return 1;
+               }
 
                if (o->maxval && ull > o->maxval) {
                        log_err("max value out of range: %llu"
@@ -526,17 +625,11 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                        */
                        if (o->off2) {
                                ul2 = 0;
-                               if (o->prof_opts)
-                                       ilp = td_var(o->prof_opts, o->off2);
-                               else
-                                       ilp = td_var(data, o->off2);
+                               ilp = td_var(data, o, o->off2);
                                *ilp = ul2;
                        }
 
-                       if (o->prof_opts)
-                               flp = td_var(o->prof_opts, o->off1);
-                       else
-                               flp = td_var(data, o->off1);
+                       flp = td_var(data, o, o->off1);
                        for(i = 0; i < o->maxlen; i++)
                                flp[i].u.f = 0.0;
                }
@@ -545,7 +638,7 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                                        o->maxlen);
                        return 1;
                }
-               if (!str_to_float(ptr, &uf)) {
+               if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
                        log_err("not a floating point value: %s\n", ptr);
                        return 1;
                }
@@ -560,10 +653,7 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                        return 1;
                }
 
-               if (o->prof_opts)
-                       flp = td_var(o->prof_opts, o->off1);
-               else
-                       flp = td_var(data, o->off1);
+               flp = td_var(data, o, o->off1);
                flp[curr].u.f = uf;
 
                dprint(FD_PARSE, "  out=%f\n", uf);
@@ -581,10 +671,7 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                                len++;
 
                        if (o->off2) {
-                               if (o->prof_opts)
-                                       ilp = td_var(o->prof_opts, o->off2);
-                               else
-                                       ilp = td_var(data, o->off2);
+                               ilp = td_var(data, o, o->off2);
                                if (len > *ilp)
                                        *ilp = len;
                        }
@@ -595,12 +682,11 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
        case FIO_OPT_STR_STORE: {
                fio_opt_str_fn *fn = o->cb;
 
-               if (o->off1) {
-                       if (o->prof_opts)
-                               cp = td_var(o->prof_opts, o->off1);
-                       else
-                               cp = td_var(data, o->off1);
+               if (!strlen(ptr))
+                       return 1;
 
+               if (o->off1) {
+                       cp = td_var(data, o, o->off1);
                        *cp = strdup(ptr);
                }
 
@@ -612,7 +698,7 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                        ret = 1;
                        for (i = 0; i < PARSE_MAX_VP; i++) {
                                vp = &posval[i];
-                               if (!vp->ival || vp->ival[0] == '\0')
+                               if (!vp->ival || vp->ival[0] == '\0' || !cp)
                                        continue;
                                all_skipped = 0;
                                if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
@@ -648,6 +734,7 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                char tmp[128];
                char *p1, *p2;
 
+               tmp[sizeof(tmp) - 1] = '\0';
                strncpy(tmp, ptr, sizeof(tmp) - 1);
 
                /* Handle bsrange with separate read,write values: */
@@ -839,6 +926,25 @@ static int handle_option(struct fio_option *o, const char *__ptr, void *data)
        return ret;
 }
 
+struct fio_option *find_option(struct fio_option *options, const char *opt)
+{
+       struct fio_option *o;
+
+       for (o = &options[0]; o->name; o++) {
+               if (!o_match(o, opt))
+                       continue;
+               if (o->type == FIO_OPT_UNSUPPORTED) {
+                       log_err("Option <%s>: %s\n", o->name, o->help);
+                       continue;
+               }
+
+               return o;
+       }
+
+       return NULL;
+}
+
+
 static struct fio_option *get_option(char *opt,
                                     struct fio_option *options, char **post)
 {
@@ -894,8 +1000,27 @@ void sort_options(char **opts, struct fio_option *options, int num_opts)
        __fio_options = NULL;
 }
 
+static void add_to_dump_list(struct fio_option *o, struct flist_head *dump_list,
+                            const char *post)
+{
+       struct print_option *p;
+
+       if (!dump_list)
+               return;
+
+       p = malloc(sizeof(*p));
+       p->name = strdup(o->name);
+       if (post)
+               p->value = strdup(post);
+       else
+               p->value = NULL;
+
+       flist_add_tail(&p->list, dump_list);
+}
+
 int parse_cmd_option(const char *opt, const char *val,
-                    struct fio_option *options, void *data)
+                    struct fio_option *options, void *data,
+                    struct flist_head *dump_list)
 {
        struct fio_option *o;
 
@@ -905,16 +1030,18 @@ int parse_cmd_option(const char *opt, const char *val,
                return 1;
        }
 
-       if (!handle_option(o, val, data))
-               return 0;
+       if (handle_option(o, val, data)) {
+               log_err("fio: failed parsing %s=%s\n", opt, val);
+               return 1;
+       }
 
-       log_err("fio: failed parsing %s=%s\n", opt, val);
-       return 1;
+       add_to_dump_list(o, dump_list, val);
+       return 0;
 }
 
 int parse_option(char *opt, const char *input,
                 struct fio_option *options, struct fio_option **o, void *data,
-                int dump_cmdline)
+                struct flist_head *dump_list)
 {
        char *post;
 
@@ -940,19 +1067,7 @@ int parse_option(char *opt, const char *input,
                return 1;
        }
 
-       if (dump_cmdline) {
-               const char *delim;
-
-               if (!strcmp("description", (*o)->name))
-                       delim = "\"";
-               else
-                       delim = "";
-
-               log_info("--%s%s", (*o)->name, post ? "" : " ");
-               if (post)
-                       log_info("=%s%s%s ", delim, post, delim);
-       }
-
+       add_to_dump_list(*o, dump_list, post);
        return 0;
 }
 
@@ -960,7 +1075,7 @@ int parse_option(char *opt, const char *input,
  * Option match, levenshtein distance. Handy for not quite remembering what
  * the option name is.
  */
-static int string_distance(const char *s1, const char *s2)
+int string_distance(const char *s1, const char *s2)
 {
        unsigned int s1_len = strlen(s1);
        unsigned int s2_len = strlen(s2);
@@ -978,11 +1093,13 @@ static int string_distance(const char *s1, const char *s2)
                q[0] = p[0] + 1;
                for (j = 1; j <= s2_len; j++) {
                        unsigned int sub = p[j - 1];
+                       unsigned int pmin;
 
                        if (s1[i - 1] != s2[j - 1])
                                sub++;
 
-                       q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
+                       pmin = min(q[j - 1] + 1, sub);
+                       q[j] = min(p[j] + 1, pmin);
                }
                r = p;
                p = q;
@@ -995,6 +1112,19 @@ static int string_distance(const char *s1, const char *s2)
        return i;
 }
 
+/*
+ * Make a guess of whether the distance from 's1' is significant enough
+ * to warrant printing the guess. We set this to a 1/2 match.
+ */
+int string_distance_ok(const char *opt, int distance)
+{
+       size_t len;
+
+       len = strlen(opt);
+       len = (len + 1) / 2;
+       return distance <= len;
+}
+
 static struct fio_option *find_child(struct fio_option *options,
                                     struct fio_option *o)
 {
@@ -1139,10 +1269,12 @@ void fill_default_options(void *data, struct fio_option *options)
                        handle_option(o, o->def, data);
 }
 
-void option_init(struct fio_option *o)
+static void option_init(struct fio_option *o)
 {
-       if (o->type == FIO_OPT_DEPRECATED)
+       if (o->type == FIO_OPT_DEPRECATED || o->type == FIO_OPT_UNSUPPORTED)
                return;
+       if (o->name && !o->lname)
+               log_err("Option %s: missing long option name\n", o->name);
        if (o->type == FIO_OPT_BOOL) {
                o->minval = 0;
                o->maxval = 1;
@@ -1155,7 +1287,7 @@ void option_init(struct fio_option *o)
                o->minfp = DBL_MIN;
                o->maxfp = DBL_MAX;
        }
-       if (o->type == FIO_OPT_STR_SET && o->def) {
+       if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
                log_err("Option %s: string set option with"
                                " default will always be true\n", o->name);
        }
@@ -1169,8 +1301,6 @@ void option_init(struct fio_option *o)
        if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
            o->type == FIO_OPT_STR_MULTI)
                return;
-       if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
-               log_err("Option %s: both cb and offset given\n", o->name);
 }
 
 /*
@@ -1190,6 +1320,23 @@ void options_init(struct fio_option *options)
        }
 }
 
+void options_mem_dupe(struct fio_option *options, void *data)
+{
+       struct fio_option *o;
+       char **ptr;
+
+       dprint(FD_PARSE, "dup options\n");
+
+       for (o = &options[0]; o->name; o++) {
+               if (o->type != FIO_OPT_STR_STORE)
+                       continue;
+
+               ptr = td_var(data, o, o->off1);
+               if (*ptr)
+                       *ptr = strdup(*ptr);
+       }
+}
+
 void options_free(struct fio_option *options, void *data)
 {
        struct fio_option *o;
@@ -1198,13 +1345,10 @@ void options_free(struct fio_option *options, void *data)
        dprint(FD_PARSE, "free options\n");
 
        for (o = &options[0]; o->name; o++) {
-               if (o->type != FIO_OPT_STR_STORE || !o->off1)
+               if (o->type != FIO_OPT_STR_STORE || !o->off1 || o->no_free)
                        continue;
 
-               if (o->prof_opts)
-                       ptr = td_var(o->prof_opts, o->off1);
-               else
-                       ptr = td_var(data, o->off1);
+               ptr = td_var(data, o, o->off1);
                if (*ptr) {
                        free(*ptr);
                        *ptr = NULL;