Home | History | Annotate | Download | only in fio
      1 #ifndef FIO_PARSE_H
      2 #define FIO_PARSE_H
      3 
      4 #include <inttypes.h>
      5 #include "flist.h"
      6 
      7 /*
      8  * Option types
      9  */
     10 enum fio_opt_type {
     11 	FIO_OPT_INVALID = 0,
     12 	FIO_OPT_STR,
     13 	FIO_OPT_STR_MULTI,
     14 	FIO_OPT_STR_VAL,
     15 	FIO_OPT_STR_VAL_TIME,
     16 	FIO_OPT_STR_STORE,
     17 	FIO_OPT_RANGE,
     18 	FIO_OPT_INT,
     19 	FIO_OPT_BOOL,
     20 	FIO_OPT_FLOAT_LIST,
     21 	FIO_OPT_STR_SET,
     22 	FIO_OPT_DEPRECATED,
     23 	FIO_OPT_UNSUPPORTED,
     24 };
     25 
     26 /*
     27  * Match a possible value string with the integer option.
     28  */
     29 struct value_pair {
     30 	const char *ival;		/* string option */
     31 	unsigned int oval;		/* output value */
     32 	const char *help;		/* help text for sub option */
     33 	int orval;			/* OR value */
     34 	void *cb;			/* sub-option callback */
     35 };
     36 
     37 #define OPT_LEN_MAX 	4096
     38 #define PARSE_MAX_VP	24
     39 
     40 /*
     41  * Option define
     42  */
     43 struct fio_option {
     44 	const char *name;		/* option name */
     45 	const char *lname;		/* long option name */
     46 	const char *alias;		/* possible old allowed name */
     47 	enum fio_opt_type type;		/* option type */
     48 	unsigned int off1;		/* potential parameters */
     49 	unsigned int off2;
     50 	unsigned int off3;
     51 	unsigned int off4;
     52 	unsigned int off5;
     53 	unsigned int off6;
     54 	unsigned int maxval;		/* max and min value */
     55 	int minval;
     56 	double maxfp;			/* max and min floating value */
     57 	double minfp;
     58 	unsigned int interval;		/* client hint for suitable interval */
     59 	unsigned int maxlen;		/* max length */
     60 	int neg;			/* negate value stored */
     61 	int prio;
     62 	void *cb;			/* callback */
     63 	const char *help;		/* help text for option */
     64 	const char *def;		/* default setting */
     65 	struct value_pair posval[PARSE_MAX_VP];/* possible values */
     66 	const char *parent;		/* parent option */
     67 	int hide;			/* hide if parent isn't set */
     68 	int hide_on_set;		/* hide on set, not on unset */
     69 	const char *inverse;		/* if set, apply opposite action to this option */
     70 	struct fio_option *inv_opt;	/* cached lookup */
     71 	int (*verify)(struct fio_option *, void *);
     72 	const char *prof_name;		/* only valid for specific profile */
     73 	void *prof_opts;
     74 	uint64_t category;		/* what type of option */
     75 	uint64_t group;			/* who to group with */
     76 	void *gui_data;
     77 	int is_seconds;			/* time value with seconds base */
     78 	int is_time;			/* time based value */
     79 	int no_warn_def;
     80 	int pow2;			/* must be a power-of-2 */
     81 };
     82 
     83 extern int parse_option(char *, const char *, struct fio_option *, struct fio_option **, void *, struct flist_head *);
     84 extern void sort_options(char **, struct fio_option *, int);
     85 extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *, struct flist_head *);
     86 extern int show_cmd_help(struct fio_option *, const char *);
     87 extern void fill_default_options(void *, struct fio_option *);
     88 extern void options_init(struct fio_option *);
     89 extern void options_mem_dupe(struct fio_option *, void *);
     90 extern void options_free(struct fio_option *, void *);
     91 
     92 extern void strip_blank_front(char **);
     93 extern void strip_blank_end(char *);
     94 extern int str_to_decimal(const char *, long long *, int, void *, int, int);
     95 extern int check_str_bytes(const char *p, long long *val, void *data);
     96 extern int check_str_time(const char *p, long long *val, int);
     97 extern int str_to_float(const char *str, double *val, int is_time);
     98 
     99 extern int string_distance(const char *s1, const char *s2);
    100 extern int string_distance_ok(const char *s1, int dist);
    101 
    102 /*
    103  * Handlers for the options
    104  */
    105 typedef int (fio_opt_str_fn)(void *, const char *);
    106 typedef int (fio_opt_str_val_fn)(void *, long long *);
    107 typedef int (fio_opt_int_fn)(void *, int *);
    108 
    109 struct thread_options;
    110 static inline void *td_var(void *to, struct fio_option *o, unsigned int offset)
    111 {
    112 	void *ret;
    113 
    114 	if (o->prof_opts)
    115 		ret = o->prof_opts;
    116 	else
    117 		ret = to;
    118 
    119 	return (char *) ret + offset;
    120 }
    121 
    122 static inline int parse_is_percent(unsigned long long val)
    123 {
    124 	return val <= -1ULL && val >= (-1ULL - 100ULL);
    125 }
    126 
    127 struct print_option {
    128 	struct flist_head list;
    129 	char *name;
    130 	char *value;
    131 };
    132 
    133 #endif
    134