Fio 2.3
[fio.git] / options.h
1 #ifndef FIO_OPTION_H
2 #define FIO_OPTION_H
3
4 #define FIO_MAX_OPTS            512
5
6 #include <string.h>
7 #include <inttypes.h>
8 #include "parse.h"
9 #include "flist.h"
10 #include "lib/types.h"
11
12 #define td_var_offset(var)      ((size_t) &((struct thread_options *)0)->var)
13
14 int add_option(struct fio_option *);
15 void invalidate_profile_options(const char *);
16 extern char *exec_profile;
17
18 void add_opt_posval(const char *, const char *, const char *);
19 void del_opt_posval(const char *, const char *);
20 struct thread_data;
21 void fio_options_free(struct thread_data *);
22 char *get_name_idx(char *, int);
23 int set_name_idx(char *, size_t, char *, int);
24
25 extern char client_sockaddr_str[];  /* used with --client option */
26
27 extern struct fio_option fio_options[FIO_MAX_OPTS];
28
29 extern bool __fio_option_is_set(struct thread_options *, unsigned int off);
30
31 #define fio_option_is_set(__td, name)                                   \
32 ({                                                                      \
33         const unsigned int off = td_var_offset(name);                   \
34         bool __r = __fio_option_is_set((__td), off);                    \
35         __r;                                                            \
36 })
37
38 extern void fio_option_mark_set(struct thread_options *, struct fio_option *);
39
40 static inline bool o_match(struct fio_option *o, const char *opt)
41 {
42         if (!strcmp(o->name, opt))
43                 return true;
44         else if (o->alias && !strcmp(o->alias, opt))
45                 return true;
46
47         return false;
48 }
49
50 static inline struct fio_option *find_option(struct fio_option *options,
51                                              const char *opt)
52 {
53         struct fio_option *o;
54
55         for (o = &options[0]; o->name; o++)
56                 if (o_match(o, opt))
57                         return o;
58
59         return NULL;
60 }
61
62 struct opt_group {
63         const char *name;
64         uint64_t mask;
65 };
66
67 enum opt_category {
68         __FIO_OPT_C_GENERAL     = 0,
69         __FIO_OPT_C_IO,
70         __FIO_OPT_C_FILE,
71         __FIO_OPT_C_STAT,
72         __FIO_OPT_C_LOG,
73         __FIO_OPT_C_PROFILE,
74         __FIO_OPT_C_ENGINE,
75         __FIO_OPT_C_NR,
76
77         FIO_OPT_C_GENERAL       = (1ULL << __FIO_OPT_C_GENERAL),
78         FIO_OPT_C_IO            = (1ULL << __FIO_OPT_C_IO),
79         FIO_OPT_C_FILE          = (1ULL << __FIO_OPT_C_FILE),
80         FIO_OPT_C_STAT          = (1ULL << __FIO_OPT_C_STAT),
81         FIO_OPT_C_LOG           = (1ULL << __FIO_OPT_C_LOG),
82         FIO_OPT_C_PROFILE       = (1ULL << __FIO_OPT_C_PROFILE),
83         FIO_OPT_C_ENGINE        = (1ULL << __FIO_OPT_C_ENGINE),
84         FIO_OPT_C_INVALID       = (1ULL << __FIO_OPT_C_NR),
85 };
86
87 enum opt_category_group {
88         __FIO_OPT_G_RATE        = 0,
89         __FIO_OPT_G_ZONE,
90         __FIO_OPT_G_RWMIX,
91         __FIO_OPT_G_VERIFY,
92         __FIO_OPT_G_TRIM,
93         __FIO_OPT_G_IOLOG,
94         __FIO_OPT_G_IO_DEPTH,
95         __FIO_OPT_G_IO_FLOW,
96         __FIO_OPT_G_DESC,
97         __FIO_OPT_G_FILENAME,
98         __FIO_OPT_G_IO_BASIC,
99         __FIO_OPT_G_CGROUP,
100         __FIO_OPT_G_RUNTIME,
101         __FIO_OPT_G_PROCESS,
102         __FIO_OPT_G_CRED,
103         __FIO_OPT_G_CLOCK,
104         __FIO_OPT_G_IO_TYPE,
105         __FIO_OPT_G_THINKTIME,
106         __FIO_OPT_G_RANDOM,
107         __FIO_OPT_G_IO_BUF,
108         __FIO_OPT_G_TIOBENCH,
109         __FIO_OPT_G_ERR,
110         __FIO_OPT_G_E4DEFRAG,
111         __FIO_OPT_G_NETIO,
112         __FIO_OPT_G_RDMA,
113         __FIO_OPT_G_LIBAIO,
114         __FIO_OPT_G_ACT,
115         __FIO_OPT_G_LATPROF,
116         __FIO_OPT_G_RBD,
117         __FIO_OPT_G_GFAPI,
118         __FIO_OPT_G_MTD,
119         __FIO_OPT_G_HDFS,
120         __FIO_OPT_G_NR,
121
122         FIO_OPT_G_RATE          = (1ULL << __FIO_OPT_G_RATE),
123         FIO_OPT_G_ZONE          = (1ULL << __FIO_OPT_G_ZONE),
124         FIO_OPT_G_RWMIX         = (1ULL << __FIO_OPT_G_RWMIX),
125         FIO_OPT_G_VERIFY        = (1ULL << __FIO_OPT_G_VERIFY),
126         FIO_OPT_G_TRIM          = (1ULL << __FIO_OPT_G_TRIM),
127         FIO_OPT_G_IOLOG         = (1ULL << __FIO_OPT_G_IOLOG),
128         FIO_OPT_G_IO_DEPTH      = (1ULL << __FIO_OPT_G_IO_DEPTH),
129         FIO_OPT_G_IO_FLOW       = (1ULL << __FIO_OPT_G_IO_FLOW),
130         FIO_OPT_G_DESC          = (1ULL << __FIO_OPT_G_DESC),
131         FIO_OPT_G_FILENAME      = (1ULL << __FIO_OPT_G_FILENAME),
132         FIO_OPT_G_IO_BASIC      = (1ULL << __FIO_OPT_G_IO_BASIC),
133         FIO_OPT_G_CGROUP        = (1ULL << __FIO_OPT_G_CGROUP),
134         FIO_OPT_G_RUNTIME       = (1ULL << __FIO_OPT_G_RUNTIME),
135         FIO_OPT_G_PROCESS       = (1ULL << __FIO_OPT_G_PROCESS),
136         FIO_OPT_G_CRED          = (1ULL << __FIO_OPT_G_CRED),
137         FIO_OPT_G_CLOCK         = (1ULL << __FIO_OPT_G_CLOCK),
138         FIO_OPT_G_IO_TYPE       = (1ULL << __FIO_OPT_G_IO_TYPE),
139         FIO_OPT_G_THINKTIME     = (1ULL << __FIO_OPT_G_THINKTIME),
140         FIO_OPT_G_RANDOM        = (1ULL << __FIO_OPT_G_RANDOM),
141         FIO_OPT_G_IO_BUF        = (1ULL << __FIO_OPT_G_IO_BUF),
142         FIO_OPT_G_TIOBENCH      = (1ULL << __FIO_OPT_G_TIOBENCH),
143         FIO_OPT_G_ERR           = (1ULL << __FIO_OPT_G_ERR),
144         FIO_OPT_G_E4DEFRAG      = (1ULL << __FIO_OPT_G_E4DEFRAG),
145         FIO_OPT_G_NETIO         = (1ULL << __FIO_OPT_G_NETIO),
146         FIO_OPT_G_RDMA          = (1ULL << __FIO_OPT_G_RDMA),
147         FIO_OPT_G_LIBAIO        = (1ULL << __FIO_OPT_G_LIBAIO),
148         FIO_OPT_G_ACT           = (1ULL << __FIO_OPT_G_ACT),
149         FIO_OPT_G_LATPROF       = (1ULL << __FIO_OPT_G_LATPROF),
150         FIO_OPT_G_RBD           = (1ULL << __FIO_OPT_G_RBD),
151         FIO_OPT_G_GFAPI         = (1ULL << __FIO_OPT_G_GFAPI),
152         FIO_OPT_G_MTD           = (1ULL << __FIO_OPT_G_MTD),
153         FIO_OPT_G_HDFS          = (1ULL << __FIO_OPT_G_HDFS),
154         FIO_OPT_G_INVALID       = (1ULL << __FIO_OPT_G_NR),
155 };
156
157 extern struct opt_group *opt_group_from_mask(uint64_t *mask);
158 extern struct opt_group *opt_group_cat_from_mask(uint64_t *mask);
159 extern struct fio_option *fio_option_find(const char *name);
160 extern unsigned int fio_get_kb_base(void *);
161
162 #endif