parse.h revision a4ed77fe07de1ca78cd44a6378dc20a2cd1ce7ad 
1#ifndef FIO_PARSE_H
2#define FIO_PARSE_H
3
4#include "flist.h"
5
6/*
7 * Option types
8 */
9enum 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 */
27struct 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 */
41struct fio_option {
42	const char *name;		/* option name */
43	const char *lname;		/* long option name */
44	const char *alias;		/* possible old allowed name */
45	enum fio_opt_type type;		/* option type */
46	unsigned int off1;		/* potential parameters */
47	unsigned int off2;
48	unsigned int off3;
49	unsigned int off4;
50	void *roff1, *roff2, *roff3, *roff4;
51	unsigned int maxval;		/* max and min value */
52	int minval;
53	double maxfp;			/* max and min floating value */
54	double minfp;
55	unsigned int interval;		/* client hint for suitable interval */
56	unsigned int maxlen;		/* max length */
57	int neg;			/* negate value stored */
58	int prio;
59	void *cb;			/* callback */
60	const char *help;		/* help text for option */
61	const char *def;		/* default setting */
62	struct value_pair posval[PARSE_MAX_VP];/* possible values */
63	const char *parent;		/* parent option */
64	int hide;			/* hide if parent isn't set */
65	int hide_on_set;		/* hide on set, not on unset */
66	const char *inverse;		/* if set, apply opposite action to this option */
67	struct fio_option *inv_opt;	/* cached lookup */
68	int (*verify)(struct fio_option *, void *);
69	const char *prof_name;		/* only valid for specific profile */
70	unsigned int category;		/* what type of option */
71	unsigned int group;		/* who to group with */
72	void *gui_data;
73};
74
75typedef int (str_cb_fn)(void *, char *);
76
77extern int parse_option(char *, const char *, struct fio_option *, struct fio_option **, void *);
78extern void sort_options(char **, struct fio_option *, int);
79extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
80extern int show_cmd_help(struct fio_option *, const char *);
81extern void fill_default_options(void *, struct fio_option *);
82extern void option_init(struct fio_option *);
83extern void options_init(struct fio_option *);
84extern void options_free(struct fio_option *, void *);
85
86extern void strip_blank_front(char **);
87extern void strip_blank_end(char *);
88extern int str_to_decimal(const char *, long long *, int, void *);
89extern int check_str_bytes(const char *p, long long *val, void *data);
90
91/*
92 * Handlers for the options
93 */
94typedef int (fio_opt_str_fn)(void *, const char *);
95typedef int (fio_opt_str_val_fn)(void *, long long *);
96typedef int (fio_opt_int_fn)(void *, int *);
97typedef int (fio_opt_str_set_fn)(void *);
98
99#define td_var(start, offset)	((void *) start + (offset))
100
101#ifndef min
102#define min(a, b)	((a) < (b) ? (a) : (b))
103#endif
104#ifndef max
105#define max(a, b)	((a) > (b) ? (a) : (b))
106#endif
107
108static inline int parse_is_percent(unsigned long long val)
109{
110	return val <= -1ULL && val >= (-1ULL - 100ULL);
111}
112
113#endif
114