Only show maxval in --cmdhelp if it is given
[fio.git] / parse.c
diff --git a/parse.c b/parse.c
index f9e0ebeedc3fd635ccbc8605122f37a795289678..1b38db5c2d789d9cbce07658b325aa066f616e37 100644 (file)
--- a/parse.c
+++ b/parse.c
@@ -8,10 +8,13 @@
 #include <string.h>
 #include <errno.h>
 #include <limits.h>
+#include <stdlib.h>
 
 #include "parse.h"
 #include "debug.h"
 
+static struct fio_option *fio_options;
+
 static int vp_cmp(const void *p1, const void *p2)
 {
        const struct value_pair *vp1 = p1;
@@ -43,7 +46,10 @@ static void show_option_range(struct fio_option *o)
        if (!o->minval && !o->maxval)
                return;
 
-       printf("%20s: min=%d, max=%d\n", "range", o->minval, o->maxval);
+       printf("%20s: min=%d", "range", o->minval);
+       if (o->maxval)
+               printf(", max=%d", o->maxval);
+       printf("\n");
 }
 
 static void show_option_values(struct fio_option *o)
@@ -70,37 +76,37 @@ static void show_option_values(struct fio_option *o)
 static unsigned long get_mult_time(char c)
 {
        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;
+       case 'm':
+       case 'M':
+               return 60;
+       case 'h':
+       case 'H':
+               return 60 * 60;
+       case 'd':
+       case 'D':
+               return 24 * 60 * 60;
+       default:
+               return 1;
        }
 }
 
 static unsigned long get_mult_bytes(char c)
 {
        switch (c) {
-               case 'k':
-               case 'K':
-                       return 1024;
-               case 'm':
-               case 'M':
-                       return 1024 * 1024;
-               case 'g':
-               case 'G':
-                       return 1024 * 1024 * 1024;
-               case 'e':
-               case 'E':
-                       return 1024 * 1024 * 1024 * 1024UL;
-               default:
-                       return 1;
+       case 'k':
+       case 'K':
+               return 1024;
+       case 'm':
+       case 'M':
+               return 1024 * 1024;
+       case 'g':
+       case 'G':
+               return 1024 * 1024 * 1024;
+       case 'e':
+       case 'E':
+               return 1024 * 1024 * 1024 * 1024UL;
+       default:
+               return 1;
        }
 }
 
@@ -109,13 +115,18 @@ static unsigned long get_mult_bytes(char c)
  */
 int str_to_decimal(const char *str, long long *val, int kilo)
 {
-       int len;
+       int len, base;
 
        len = strlen(str);
        if (!len)
                return 1;
 
-       *val = strtoll(str, NULL, 10);
+       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;
 
@@ -149,7 +160,7 @@ void strip_blank_front(char **p)
 
 void strip_blank_end(char *p)
 {
-       char *s;
+       char *start = p, *s;
 
        s = strchr(p, ';');
        if (s)
@@ -161,7 +172,7 @@ void strip_blank_end(char *p)
                p = s;
 
        s = p + strlen(p);
-       while ((isspace(*s) || iscntrl(*s)) && (s > p))
+       while ((isspace(*s) || iscntrl(*s)) && (s > start))
                s--;
 
        *(s + 1) = '\0';
@@ -233,7 +244,7 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
        dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
                                                        o->type, ptr);
 
-       if (!ptr && o->type != FIO_OPT_STR_SET) {
+       if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
                fprintf(stderr, "Option %s requires an argument\n", o->name);
                return 1;
        }
@@ -269,8 +280,8 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
        }
        case FIO_OPT_STR_VAL_TIME:
                is_time = 1;
-       case FIO_OPT_STR_VAL:
-       case FIO_OPT_STR_VAL_INT: {
+       case FIO_OPT_INT:
+       case FIO_OPT_STR_VAL: {
                fio_opt_str_val_fn *fn = o->cb;
 
                if (is_time)
@@ -282,18 +293,20 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                        break;
 
                if (o->maxval && ull > o->maxval) {
-                       fprintf(stderr, "max value out of range: %lld (%d max)\n", ull, o->maxval);
+                       fprintf(stderr, "max value out of range: %lld"
+                                       " (%d max)\n", ull, o->maxval);
                        return 1;
                }
                if (o->minval && ull < o->minval) {
-                       fprintf(stderr, "min value out of range: %lld (%d min)\n", ull, o->minval);
+                       fprintf(stderr, "min value out of range: %lld"
+                                       " (%d min)\n", ull, o->minval);
                        return 1;
                }
 
                if (fn)
                        ret = fn(data, &ull);
                else {
-                       if (o->type == FIO_OPT_STR_VAL_INT) {
+                       if (o->type == FIO_OPT_INT) {
                                if (first)
                                        val_store(ilp, ull, o->off1, data);
                                if (!more && o->off2)
@@ -341,7 +354,8 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                p1 = tmp;
 
                ret = 1;
-               if (!check_range_bytes(p1, &ul1) && !check_range_bytes(p2, &ul2)) {
+               if (!check_range_bytes(p1, &ul1) &&
+                   !check_range_bytes(p2, &ul2)) {
                        ret = 0;
                        if (ul1 > ul2) {
                                unsigned long foo = ul1;
@@ -362,7 +376,6 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
 
                break;
        }
-       case FIO_OPT_INT:
        case FIO_OPT_BOOL: {
                fio_opt_int_fn *fn = o->cb;
 
@@ -371,11 +384,13 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                        break;
 
                if (o->maxval && il > (int) o->maxval) {
-                       fprintf(stderr, "max value out of range: %d (%d max)\n", il, o->maxval);
+                       fprintf(stderr, "max value out of range: %d (%d max)\n",
+                                                               il, o->maxval);
                        return 1;
                }
                if (o->minval && il < o->minval) {
-                       fprintf(stderr, "min value out of range: %d (%d min)\n", il, o->minval);
+                       fprintf(stderr, "min value out of range: %d (%d min)\n",
+                                                               il, o->minval);
                        return 1;
                }
 
@@ -405,6 +420,9 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
                }
                break;
        }
+       case FIO_OPT_DEPRECATED:
+               fprintf(stdout, "Option %s is deprecated\n", o->name);
+               break;
        default:
                fprintf(stderr, "Bad option type %u\n", o->type);
                ret = 1;
@@ -413,12 +431,16 @@ static int __handle_option(struct fio_option *o, const char *ptr, void *data,
        return ret;
 }
 
-static int handle_option(struct fio_option *o, const char *ptr, void *data)
+static int handle_option(struct fio_option *o, const char *__ptr, void *data)
 {
-       const char *ptr2 = NULL;
+       char *ptr, *ptr2 = NULL;
        int r1, r2;
 
-       dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, ptr);
+       dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
+
+       ptr = NULL;
+       if (__ptr)
+               ptr = strdup(__ptr);
 
        /*
         * See if we have a second set of parameters, hidden after a comma.
@@ -429,6 +451,8 @@ static int handle_option(struct fio_option *o, const char *ptr, void *data)
            (o->type != FIO_OPT_STR_STORE) &&
            (o->type != FIO_OPT_STR)) {
                ptr2 = strchr(ptr, ',');
+               if (ptr2 && *(ptr2 + 1) == '\0')
+                       *ptr2 = '\0';
                if (!ptr2)
                        ptr2 = strchr(ptr, ':');
                if (!ptr2)
@@ -442,15 +466,72 @@ static int handle_option(struct fio_option *o, const char *ptr, void *data)
         */
        r1 = __handle_option(o, ptr, data, 1, !!ptr2);
 
-       if (!ptr2)
+       if (!ptr2) {
+               if (ptr)
+                       free(ptr);
                return r1;
+       }
 
        ptr2++;
        r2 = __handle_option(o, ptr2, data, 0, 0);
 
+       if (ptr)
+               free(ptr);
        return r1 && r2;
 }
 
+static struct fio_option *get_option(const char *opt,
+                                    struct fio_option *options, char **post)
+{
+       struct fio_option *o;
+       char *ret;
+
+       ret = strchr(opt, '=');
+       if (ret) {
+               *post = ret;
+               *ret = '\0';
+               ret = (char *) opt;
+               (*post)++;
+               strip_blank_end(ret);
+               o = find_option(options, ret);
+       } else {
+               o = find_option(options, opt);
+               *post = NULL;
+       }
+
+       return o;
+}
+
+static int opt_cmp(const void *p1, const void *p2)
+{
+       struct fio_option *o1, *o2;
+       char *s1, *s2, *foo;
+       int prio1, prio2;
+
+       s1 = strdup(*((char **) p1));
+       s2 = strdup(*((char **) p2));
+
+       o1 = get_option(s1, fio_options, &foo);
+       o2 = get_option(s2, fio_options, &foo);
+       
+       prio1 = prio2 = 0;
+       if (o1)
+               prio1 = o1->prio;
+       if (o2)
+               prio2 = o2->prio;
+
+       free(s1);
+       free(s2);
+       return prio2 - prio1;
+}
+
+void sort_options(char **opts, struct fio_option *options, int num_opts)
+{
+       fio_options = options;
+       qsort(opts, num_opts, sizeof(char *), opt_cmp);
+       fio_options = NULL;
+}
+
 int parse_cmd_option(const char *opt, const char *val,
                     struct fio_option *options, void *data)
 {
@@ -458,7 +539,7 @@ int parse_cmd_option(const char *opt, const char *val,
 
        o = find_option(options, opt);
        if (!o) {
-               fprintf(stderr, "Bad option %s\n", opt);
+               fprintf(stderr, "Bad option <%s>\n", opt);
                return 1;
        }
 
@@ -469,28 +550,65 @@ int parse_cmd_option(const char *opt, const char *val,
        return 1;
 }
 
+/*
+ * Return a copy of the input string with substrings of the form ${VARNAME}
+ * substituted with the value of the environment variable VARNAME.  The
+ * substitution always occurs, even if VARNAME is empty or the corresponding
+ * environment variable undefined.
+ */
+static char *option_dup_subs(const char *opt)
+{
+       char out[OPT_LEN_MAX+1];
+       char in[OPT_LEN_MAX+1];
+       char *outptr = out;
+       char *inptr = in;
+       char *ch1, *ch2, *env;
+       ssize_t nchr = OPT_LEN_MAX;
+       size_t envlen;
+
+       in[OPT_LEN_MAX] = '\0';
+       strncpy(in, opt, OPT_LEN_MAX);
+
+       while (*inptr && nchr > 0) {
+               if (inptr[0] == '$' && inptr[1] == '{') {
+                       ch2 = strchr(inptr, '}');
+                       if (ch2 && inptr+1 < ch2) {
+                               ch1 = inptr+2;
+                               inptr = ch2+1;
+                               *ch2 = '\0';
+
+                               env = getenv(ch1);
+                               if (env) {
+                                       envlen = strlen(env);
+                                       if (envlen <= nchr) {
+                                               memcpy(outptr, env, envlen);
+                                               outptr += envlen;
+                                               nchr -= envlen;
+                                       }
+                               }
+
+                               continue;
+                       }
+               }
+
+               *outptr++ = *inptr++;
+               --nchr;
+       }
+
+       *outptr = '\0';
+       return strdup(out);
+}
+
 int parse_option(const char *opt, struct fio_option *options, void *data)
 {
        struct fio_option *o;
-       char *pre, *post;
-       char *tmp;
-
-       tmp = strdup(opt);
-
-       pre = strchr(tmp, '=');
-       if (pre) {
-               post = pre;
-               *pre = '\0';
-               pre = tmp;
-               post++;
-               o = find_option(options, pre);
-       } else {
-               o = find_option(options, tmp);
-               post = NULL;
-       }
+       char *post, *tmp;
 
+       tmp = option_dup_subs(opt);
+
+       o = get_option(tmp, options, &post);
        if (!o) {
-               fprintf(stderr, "Bad option %s\n", tmp);
+               fprintf(stderr, "Bad option <%s>\n", tmp);
                free(tmp);
                return 1;
        }
@@ -549,7 +667,6 @@ static void show_option_help(struct fio_option *o)
        const char *typehelp[] = {
                "string (opt=bla)",
                "string with possible k/m/g postfix (opt=4k)",
-               "string with range and postfix (opt=1k-4k)",
                "string with time postfix (opt=10s)",
                "string (opt=bla)",
                "string with dual range (opt=1k-4k,4k-8k)",
@@ -589,7 +706,7 @@ static void __print_option(struct fio_option *o, struct fio_option *org,
                return;
        if (!org)
                org = o;
-       
+
        p = name;
        depth = level;
        while (depth--)
@@ -639,6 +756,9 @@ int show_cmd_help(struct fio_option *options, const char *name)
        for (o = &options[0]; o->name; o++) {
                int match = 0;
 
+               if (o->type == FIO_OPT_DEPRECATED)
+                       continue;
+
                if (name) {
                        if (!strcmp(name, o->name) ||
                            (o->alias && !strcmp(name, o->alias)))
@@ -710,17 +830,26 @@ void options_init(struct fio_option *options)
        dprint(FD_PARSE, "init options\n");
 
        for (o = &options[0]; o->name; o++) {
+               if (o->type == FIO_OPT_DEPRECATED)
+                       continue;
                if (o->type == FIO_OPT_BOOL) {
                        o->minval = 0;
                        o->maxval = 1;
                }
-               if (o->type == FIO_OPT_STR_SET && o->def)
-                       fprintf(stderr, "Option %s: string set option with default will always be true\n", o->name);
-               if (!o->cb && !o->off1)
-                       fprintf(stderr, "Option %s: neither cb nor offset given\n", o->name);
+               if (o->type == FIO_OPT_STR_SET && o->def) {
+                       fprintf(stderr, "Option %s: string set option with"
+                                       " default will always be true\n",
+                                               o->name);
+               }
+               if (!o->cb && !o->off1) {
+                       fprintf(stderr, "Option %s: neither cb nor offset"
+                                       " given\n", o->name);
+               }
                if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE)
                        continue;
-               if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
-                       fprintf(stderr, "Option %s: both cb and offset given\n", o->name);
+               if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4)) {
+                       fprintf(stderr, "Option %s: both cb and offset given\n",
+                                                                o->name);
+               }
        }
 }