parse: make suggestions for unknown options
[fio.git] / parse.h
diff --git a/parse.h b/parse.h
index edba7fc6b0256261906b6c4820a3899dc71281ed..15f2e06e62926a9b2353ad14353827577318be72 100644 (file)
--- a/parse.h
+++ b/parse.h
 #ifndef FIO_PARSE_H
 #define FIO_PARSE_H
 
+#include "flist.h"
+
 /*
  * Option types
  */
 enum fio_opt_type {
-       FIO_OPT_STR = 0,
+       FIO_OPT_INVALID = 0,
+       FIO_OPT_STR,
+       FIO_OPT_STR_MULTI,
        FIO_OPT_STR_VAL,
-       FIO_OPT_STR_VAL_INT,
        FIO_OPT_STR_VAL_TIME,
        FIO_OPT_STR_STORE,
        FIO_OPT_RANGE,
        FIO_OPT_INT,
+       FIO_OPT_BOOL,
+       FIO_OPT_FLOAT_LIST,
        FIO_OPT_STR_SET,
+       FIO_OPT_DEPRECATED,
+};
+
+/*
+ * Match a possible value string with the integer option.
+ */
+struct value_pair {
+       const char *ival;               /* string option */
+       unsigned int oval;              /* output value */
+       const char *help;               /* help text for sub option */
+       int orval;                      /* OR value */
+       void *cb;                       /* sub-option callback */
 };
 
+#define OPT_LEN_MAX    4096
+#define PARSE_MAX_VP   24
+
 /*
  * Option define
  */
 struct fio_option {
        const char *name;               /* option name */
+       const char *lname;              /* long option name */
+       const char *alias;              /* possible old allowed name */
        enum fio_opt_type type;         /* option type */
        unsigned int off1;              /* potential parameters */
        unsigned int off2;
        unsigned int off3;
        unsigned int off4;
+       unsigned int off5;
+       unsigned int off6;
        unsigned int maxval;            /* max and min value */
-       unsigned int minval;
+       int minval;
+       double maxfp;                   /* max and min floating value */
+       double minfp;
+       unsigned int interval;          /* client hint for suitable interval */
+       unsigned int maxlen;            /* max length */
+       int neg;                        /* negate value stored */
+       int prio;
        void *cb;                       /* callback */
        const char *help;               /* help text for option */
        const char *def;                /* default setting */
+       struct value_pair posval[PARSE_MAX_VP];/* possible values */
+       const char *parent;             /* parent option */
+       int hide;                       /* hide if parent isn't set */
+       int hide_on_set;                /* hide on set, not on unset */
+       const char *inverse;            /* if set, apply opposite action to this option */
+       struct fio_option *inv_opt;     /* cached lookup */
+       int (*verify)(struct fio_option *, void *);
+       const char *prof_name;          /* only valid for specific profile */
+       void *prof_opts;
+       unsigned int category;          /* what type of option */
+       unsigned int group;             /* who to group with */
+       void *gui_data;
+       int is_seconds;                 /* time value with seconds base */
+       int is_time;                    /* time based value */
+       int no_warn_def;
 };
 
 typedef int (str_cb_fn)(void *, char *);
 
-extern int parse_option(const char *, struct fio_option *, void *);
+extern int parse_option(char *, const char *, struct fio_option *, struct fio_option **, void *, int);
+extern void sort_options(char **, struct fio_option *, int);
 extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
 extern int show_cmd_help(struct fio_option *, const char *);
 extern void fill_default_options(void *, struct fio_option *);
+extern void option_init(struct fio_option *);
+extern void options_init(struct fio_option *);
+extern void options_free(struct fio_option *, void *);
 
 extern void strip_blank_front(char **);
 extern void strip_blank_end(char *);
+extern int str_to_decimal(const char *, long long *, int, void *, int, int);
+extern int check_str_bytes(const char *p, long long *val, void *data);
+extern int check_str_time(const char *p, long long *val, int);
+extern int str_to_float(const char *str, double *val, int is_time);
+
+extern int string_distance(const char *s1, const char *s2);
 
 /*
  * Handlers for the options
  */
 typedef int (fio_opt_str_fn)(void *, const char *);
-typedef int (fio_opt_str_val_fn)(void *, unsigned long long *);
-typedef int (fio_opt_int_fn)(void *, unsigned int *);
+typedef int (fio_opt_str_val_fn)(void *, long long *);
+typedef int (fio_opt_int_fn)(void *, int *);
 typedef int (fio_opt_str_set_fn)(void *);
 
-#define td_var(start, offset)  ((void *) start + (offset))
+#define __td_var(start, offset)        ((char *) start + (offset))
+
+struct thread_options;
+static inline void *td_var(struct thread_options *to, struct fio_option *o,
+                          unsigned int offset)
+{
+       if (o->prof_opts)
+               return __td_var(o->prof_opts, offset);
+
+       return __td_var(to, offset);
+}
+
+static inline int parse_is_percent(unsigned long long val)
+{
+       return val <= -1ULL && val >= (-1ULL - 100ULL);
+}
 
 #endif