Document loading external io engines
[fio.git] / parse.h
1 #ifndef FIO_PARSE_H
2 #define FIO_PARSE_H
3
4 /*
5  * Option types
6  */
7 enum fio_opt_type {
8         FIO_OPT_STR = 0,
9         FIO_OPT_STR_VAL,
10         FIO_OPT_STR_VAL_INT,
11         FIO_OPT_STR_VAL_TIME,
12         FIO_OPT_STR_STORE,
13         FIO_OPT_RANGE,
14         FIO_OPT_INT,
15         FIO_OPT_BOOL,
16         FIO_OPT_STR_SET,
17 };
18
19 /*
20  * Match a possible value string with the integer option.
21  */
22 struct value_pair {
23         const char *ival;               /* string option */
24         unsigned int oval;              /* output value */
25 };
26
27 #define PARSE_MAX_VP    16
28
29 /*
30  * Option define
31  */
32 struct fio_option {
33         const char *name;               /* option name */
34         const char *alias;              /* possible old allowed name */
35         enum fio_opt_type type;         /* option type */
36         unsigned int off1;              /* potential parameters */
37         unsigned int off2;
38         unsigned int off3;
39         unsigned int off4;
40         unsigned int maxval;            /* max and min value */
41         int minval;
42         int neg;                        /* negate value stored */
43         void *cb;                       /* callback */
44         const char *help;               /* help text for option */
45         const char *def;                /* default setting */
46         const struct value_pair posval[PARSE_MAX_VP];/* possible values */
47 };
48
49 typedef int (str_cb_fn)(void *, char *);
50
51 extern int parse_option(const char *, struct fio_option *, void *);
52 extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
53 extern int show_cmd_help(struct fio_option *, const char *);
54 extern void fill_default_options(void *, struct fio_option *);
55 extern void options_init(struct fio_option *);
56
57 extern void strip_blank_front(char **);
58 extern void strip_blank_end(char *);
59
60 /*
61  * Handlers for the options
62  */
63 typedef int (fio_opt_str_fn)(void *, const char *);
64 typedef int (fio_opt_str_val_fn)(void *, long long *);
65 typedef int (fio_opt_int_fn)(void *, int *);
66 typedef int (fio_opt_str_set_fn)(void *);
67
68 #define td_var(start, offset)   ((void *) start + (offset))
69
70 #endif