Include engines in dependency check
[fio.git] / ioengines.c
1 /*
2  * The io parts of the fio tool, includes workers for sync and mmap'ed
3  * io, as well as both posix and linux libaio support.
4  *
5  * sync io is implemented on top of aio.
6  *
7  * This is not really specific to fio, if the get_io_u/put_io_u and
8  * structures was pulled into this as well it would be a perfectly
9  * generic io engine that could be used for other projects.
10  *
11  */
12 #include <stdio.h>
13 #include <stdlib.h>
14 #include <unistd.h>
15 #include <string.h>
16 #include <dlfcn.h>
17 #include <assert.h>
18
19 #include "fio.h"
20 #include "os.h"
21
22 static LIST_HEAD(engine_list);
23
24 static int check_engine_ops(struct ioengine_ops *ops)
25 {
26         if (ops->version != FIO_IOOPS_VERSION) {
27                 log_err("bad ioops version %d (want %d)\n", ops->version, FIO_IOOPS_VERSION);
28                 return 1;
29         }
30
31         /*
32          * cpu thread doesn't need to provide anything
33          */
34         if (ops->flags & FIO_CPUIO)
35                 return 0;
36
37         if (!ops->queue) {
38                 log_err("%s: no queue handler\n", ops->name);
39                 return 1;
40         }
41
42         /*
43          * sync engines only need a ->queue()
44          */
45         if (ops->flags & FIO_SYNCIO)
46                 return 0;
47         
48         if (!ops->event) {
49                 log_err("%s: no event handler\n", ops->name);
50                 return 1;
51         }
52         if (!ops->getevents) {
53                 log_err("%s: no getevents handler\n", ops->name);
54                 return 1;
55         }
56         if (!ops->queue) {
57                 log_err("%s: no queue handler\n", ops->name);
58                 return 1;
59         }
60                 
61         return 0;
62 }
63
64 void unregister_ioengine(struct ioengine_ops *ops)
65 {
66         list_del(&ops->list);
67         INIT_LIST_HEAD(&ops->list);
68 }
69
70 void register_ioengine(struct ioengine_ops *ops)
71 {
72         INIT_LIST_HEAD(&ops->list);
73         list_add_tail(&ops->list, &engine_list);
74 }
75
76 static struct ioengine_ops *find_ioengine(const char *name)
77 {
78         struct ioengine_ops *ops;
79         struct list_head *entry;
80         char engine[16];
81
82         strncpy(engine, name, sizeof(engine) - 1);
83
84         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
85                 strcpy(engine, "libaio");
86
87         list_for_each(entry, &engine_list) {
88                 ops = list_entry(entry, struct ioengine_ops, list);
89                 if (!strcmp(engine, ops->name))
90                         return ops;
91         }
92
93         return NULL;
94 }
95
96 static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
97                                             const char *engine_lib)
98 {
99         struct ioengine_ops *ops;
100         void *dlhandle;
101
102         dlerror();
103         dlhandle = dlopen(engine_lib, RTLD_LAZY);
104         if (!dlhandle) {
105                 td_vmsg(td, -1, dlerror());
106                 return NULL;
107         }
108
109         /*
110          * Unlike the included modules, external engines should have a
111          * non-static ioengine structure that we can reference.
112          */
113         ops = dlsym(dlhandle, "ioengine");
114         if (!ops) {
115                 td_vmsg(td, -1, dlerror());
116                 dlclose(dlhandle);
117                 return NULL;
118         }
119
120         ops->dlhandle = dlhandle;
121         return ops;
122 }
123
124 struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
125 {
126         struct ioengine_ops *ops, *ret;
127         char engine[16];
128
129         strncpy(engine, name, sizeof(engine) - 1);
130
131         /*
132          * linux libaio has alias names, so convert to what we want
133          */
134         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
135                 strcpy(engine, "libaio");
136
137         ops = find_ioengine(engine);
138         if (!ops)
139                 ops = dlopen_ioengine(td, name);
140
141         if (!ops) {
142                 log_err("fio: engine %s not loadable\n", name);
143                 return NULL;
144         }
145
146         /*
147          * Check that the required methods are there.
148          */
149         if (check_engine_ops(ops))
150                 return NULL;
151
152         ret = malloc(sizeof(*ret));
153         memcpy(ret, ops, sizeof(*ret));
154         ret->data = NULL;
155
156         return ret;
157 }
158
159 void close_ioengine(struct thread_data *td)
160 {
161         if (td->io_ops->cleanup)
162                 td->io_ops->cleanup(td);
163
164         if (td->io_ops->dlhandle)
165                 dlclose(td->io_ops->dlhandle);
166
167         free(td->io_ops);
168         td->io_ops = NULL;
169 }
170
171 int td_io_prep(struct thread_data *td, struct io_u *io_u)
172 {
173         if (td->io_ops->prep)
174                 return td->io_ops->prep(td, io_u);
175
176         return 0;
177 }
178
179 int td_io_getevents(struct thread_data *td, int min, int max,
180                     struct timespec *t)
181 {
182         if (td->io_ops->getevents)
183                 return td->io_ops->getevents(td, min, max, t);
184
185         return 0;
186 }
187
188 int td_io_queue(struct thread_data *td, struct io_u *io_u)
189 {
190         int ret;
191
192         assert((io_u->flags & IO_U_F_FLIGHT) == 0);
193         io_u->flags |= IO_U_F_FLIGHT;
194
195         if (td->io_ops->flags & FIO_SYNCIO) {
196                 fio_gettime(&io_u->issue_time, NULL);
197
198                 /*
199                  * for a sync engine, set the timeout upfront
200                  */
201                 if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
202                         io_u_set_timeout(td);
203         }
204
205         if (io_u->ddir != DDIR_SYNC)
206                 td->io_issues[io_u->ddir]++;
207
208         ret = td->io_ops->queue(td, io_u);
209
210         if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
211                 fio_gettime(&io_u->issue_time, NULL);
212
213                 /*
214                  * async engine, set the timeout here
215                  */
216                 if (ret == FIO_Q_QUEUED &&
217                     mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
218                         io_u_set_timeout(td);
219         }
220
221         return ret;
222 }
223
224 int td_io_init(struct thread_data *td)
225 {
226         if (td->io_ops->init)
227                 return td->io_ops->init(td);
228
229         return 0;
230 }
231
232 int td_io_commit(struct thread_data *td)
233 {
234         if (td->io_ops->commit)
235                 return td->io_ops->commit(td);
236
237         return 0;
238 }