parse.h

   1 #ifndef FIO_PARSE_H
   2 #define FIO_PARSE_H
   3
   4 #include "flist.h"
   5
   6 /*
   7  * Option types
   8  */
   9 enum fio_opt_type {
  10         FIO_OPT_INVALID = 0,
  11         FIO_OPT_STR,
  12         FIO_OPT_STR_MULTI,
  13         FIO_OPT_STR_VAL,
  14         FIO_OPT_STR_VAL_TIME,
  15         FIO_OPT_STR_STORE,
  16         FIO_OPT_RANGE,
  17         FIO_OPT_INT,
  18         FIO_OPT_BOOL,
  19         FIO_OPT_FLOAT_LIST,
  20         FIO_OPT_STR_SET,
  21         FIO_OPT_DEPRECATED,
  22 };
  23
  24 /*
  25  * Match a possible value string with the integer option.
  26  */
  27 struct value_pair {
  28         const char *ival;               /* string option */
  29         unsigned int oval;              /* output value */
  30         const char *help;               /* help text for sub option */
  31         int or;                         /* OR value */
  32         void *cb;                       /* sub-option callback */
  33 };
  34
  35 #define OPT_LEN_MAX     4096
  36 #define PARSE_MAX_VP    16
  37
  38 /*
  39  * Option define
  40  */
  41 struct fio_option {
  42         const char *name;               /* option name */
  43         const char *alias;              /* possible old allowed name */
  44         enum fio_opt_type type;         /* option type */
  45         unsigned int off1;              /* potential parameters */
  46         unsigned int off2;
  47         unsigned int off3;
  48         unsigned int off4;
  49         void *roff1, *roff2, *roff3, *roff4;
  50         unsigned int maxval;            /* max and min value */
  51         int minval;
  52         double maxfp;                   /* max and min floating value */
  53         double minfp;
  54         unsigned int interval;          /* client hint for suitable interval */
  55         unsigned int maxlen;            /* max length */
  56         int neg;                        /* negate value stored */
  57         int prio;
  58         void *cb;                       /* callback */
  59         const char *help;               /* help text for option */
  60         const char *def;                /* default setting */
  61         struct value_pair posval[PARSE_MAX_VP];/* possible values */
  62         const char *parent;             /* parent option */
  63         int hide;                       /* hide if parent isn't set */
  64         int (*verify)(struct fio_option *, void *);
  65         const char *prof_name;          /* only valid for specific profile */
  66         unsigned int category;          /* for type grouping */
  67 };
  68
  69 typedef int (str_cb_fn)(void *, char *);
  70
  71 extern int parse_option(char *, const char *, struct fio_option *, struct fio_option **, void *);
  72 extern void sort_options(char **, struct fio_option *, int);
  73 extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
  74 extern int show_cmd_help(struct fio_option *, const char *);
  75 extern void fill_default_options(void *, struct fio_option *);
  76 extern void option_init(struct fio_option *);
  77 extern void options_init(struct fio_option *);
  78 extern void options_free(struct fio_option *, void *);
  79
  80 extern void strip_blank_front(char **);
  81 extern void strip_blank_end(char *);
  82 extern int str_to_decimal(const char *, long long *, int, void *);
  83 extern int check_str_bytes(const char *p, long long *val, void *data);
  84
  85 /*
  86  * Handlers for the options
  87  */
  88 typedef int (fio_opt_str_fn)(void *, const char *);
  89 typedef int (fio_opt_str_val_fn)(void *, long long *);
  90 typedef int (fio_opt_int_fn)(void *, int *);
  91 typedef int (fio_opt_str_set_fn)(void *);
  92
  93 #define td_var(start, offset)   ((void *) start + (offset))
  94
  95 #ifndef min
  96 #define min(a, b)       ((a) < (b) ? (a) : (b))
  97 #endif
  98 #ifndef max
  99 #define max(a, b)       ((a) > (b) ? (a) : (b))
 100 #endif
 101
 102 static inline int parse_is_percent(unsigned long long val)
 103 {
 104         return val <= -1ULL && val >= (-1ULL - 100ULL);
 105 }
 106
 107 #endif