Commit | Line | Data |
---|---|---|
ebac4655 JA |
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> | |
5c4e1dbc | 15 | #include <string.h> |
2866c82d | 16 | #include <dlfcn.h> |
0c6e7517 | 17 | #include <assert.h> |
8c16d840 | 18 | |
ebac4655 | 19 | #include "fio.h" |
ebac4655 | 20 | |
5f350952 JA |
21 | static LIST_HEAD(engine_list); |
22 | ||
8c16d840 JA |
23 | static int check_engine_ops(struct ioengine_ops *ops) |
24 | { | |
5f350952 JA |
25 | if (ops->version != FIO_IOOPS_VERSION) { |
26 | log_err("bad ioops version %d (want %d)\n", ops->version, FIO_IOOPS_VERSION); | |
27 | return 1; | |
28 | } | |
29 | ||
36167d82 JA |
30 | if (!ops->queue) { |
31 | log_err("%s: no queue handler\n", ops->name); | |
32 | return 1; | |
33 | } | |
34 | ||
35 | /* | |
36 | * sync engines only need a ->queue() | |
37 | */ | |
38 | if (ops->flags & FIO_SYNCIO) | |
39 | return 0; | |
40 | ||
8c16d840 | 41 | if (!ops->event) { |
36167d82 | 42 | log_err("%s: no event handler\n", ops->name); |
8c16d840 JA |
43 | return 1; |
44 | } | |
45 | if (!ops->getevents) { | |
36167d82 | 46 | log_err("%s: no getevents handler\n", ops->name); |
8c16d840 JA |
47 | return 1; |
48 | } | |
49 | if (!ops->queue) { | |
36167d82 | 50 | log_err("%s: no queue handler\n", ops->name); |
8c16d840 JA |
51 | return 1; |
52 | } | |
53 | ||
54 | return 0; | |
55 | } | |
56 | ||
5f350952 | 57 | void unregister_ioengine(struct ioengine_ops *ops) |
ebac4655 | 58 | { |
ee56ad50 | 59 | dprint(FD_IO, "ioengine %s unregistered\n", ops->name); |
5f350952 JA |
60 | list_del(&ops->list); |
61 | INIT_LIST_HEAD(&ops->list); | |
62 | } | |
63 | ||
b2fdda43 | 64 | void register_ioengine(struct ioengine_ops *ops) |
5f350952 | 65 | { |
ee56ad50 | 66 | dprint(FD_IO, "ioengine %s registered\n", ops->name); |
5f350952 JA |
67 | INIT_LIST_HEAD(&ops->list); |
68 | list_add_tail(&ops->list, &engine_list); | |
5f350952 JA |
69 | } |
70 | ||
71 | static struct ioengine_ops *find_ioengine(const char *name) | |
72 | { | |
73 | struct ioengine_ops *ops; | |
74 | struct list_head *entry; | |
ebac4655 | 75 | |
5f350952 JA |
76 | list_for_each(entry, &engine_list) { |
77 | ops = list_entry(entry, struct ioengine_ops, list); | |
bc5b77a8 | 78 | if (!strcmp(name, ops->name)) |
5f350952 JA |
79 | return ops; |
80 | } | |
81 | ||
82 | return NULL; | |
83 | } | |
84 | ||
85 | static struct ioengine_ops *dlopen_ioengine(struct thread_data *td, | |
86 | const char *engine_lib) | |
87 | { | |
88 | struct ioengine_ops *ops; | |
89 | void *dlhandle; | |
90 | ||
ee56ad50 JA |
91 | dprint(FD_IO, "dload engine %s\n", engine_lib); |
92 | ||
2866c82d JA |
93 | dlerror(); |
94 | dlhandle = dlopen(engine_lib, RTLD_LAZY); | |
d4dbaaa8 | 95 | if (!dlhandle) { |
e1161c32 | 96 | td_vmsg(td, -1, dlerror(), "dlopen"); |
d4dbaaa8 JA |
97 | return NULL; |
98 | } | |
8756e4d4 | 99 | |
da51c050 JA |
100 | /* |
101 | * Unlike the included modules, external engines should have a | |
102 | * non-static ioengine structure that we can reference. | |
103 | */ | |
2866c82d | 104 | ops = dlsym(dlhandle, "ioengine"); |
d4dbaaa8 | 105 | if (!ops) { |
e1161c32 | 106 | td_vmsg(td, -1, dlerror(), "dlsym"); |
d4dbaaa8 JA |
107 | dlclose(dlhandle); |
108 | return NULL; | |
109 | } | |
8756e4d4 | 110 | |
5f350952 JA |
111 | ops->dlhandle = dlhandle; |
112 | return ops; | |
113 | } | |
114 | ||
115 | struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name) | |
116 | { | |
117 | struct ioengine_ops *ops, *ret; | |
118 | char engine[16]; | |
119 | ||
ee56ad50 JA |
120 | dprint(FD_IO, "load ioengine %s\n", name); |
121 | ||
5f350952 JA |
122 | strncpy(engine, name, sizeof(engine) - 1); |
123 | ||
124 | /* | |
125 | * linux libaio has alias names, so convert to what we want | |
126 | */ | |
127 | if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3)) | |
128 | strcpy(engine, "libaio"); | |
129 | ||
130 | ops = find_ioengine(engine); | |
131 | if (!ops) | |
132 | ops = dlopen_ioengine(td, name); | |
133 | ||
134 | if (!ops) { | |
135 | log_err("fio: engine %s not loadable\n", name); | |
b902ceb5 JA |
136 | return NULL; |
137 | } | |
138 | ||
8c16d840 JA |
139 | /* |
140 | * Check that the required methods are there. | |
141 | */ | |
5f350952 | 142 | if (check_engine_ops(ops)) |
8c16d840 | 143 | return NULL; |
8c16d840 | 144 | |
84585003 JA |
145 | ret = malloc(sizeof(*ret)); |
146 | memcpy(ret, ops, sizeof(*ret)); | |
147 | ret->data = NULL; | |
84585003 JA |
148 | |
149 | return ret; | |
8756e4d4 JA |
150 | } |
151 | ||
2866c82d | 152 | void close_ioengine(struct thread_data *td) |
8756e4d4 | 153 | { |
ee56ad50 JA |
154 | dprint(FD_IO, "close ioengine %s\n", td->io_ops->name); |
155 | ||
2866c82d JA |
156 | if (td->io_ops->cleanup) |
157 | td->io_ops->cleanup(td); | |
b990b5c0 | 158 | |
5f350952 JA |
159 | if (td->io_ops->dlhandle) |
160 | dlclose(td->io_ops->dlhandle); | |
161 | ||
84585003 JA |
162 | free(td->io_ops); |
163 | td->io_ops = NULL; | |
b990b5c0 | 164 | } |
10ba535a | 165 | |
ee56ad50 JA |
166 | static void dprint_io_u(struct io_u *io_u, const char *p) |
167 | { | |
168 | struct fio_file *f = io_u->file; | |
169 | ||
170 | dprint(FD_IO, "%s: off=%llu/len=%lu/ddir=%d", p, io_u->offset, | |
171 | io_u->buflen, io_u->ddir); | |
172 | if (f) | |
173 | dprint(FD_IO, "/%s", f->file_name); | |
174 | dprint(FD_IO, "\n"); | |
175 | } | |
176 | ||
10ba535a JA |
177 | int td_io_prep(struct thread_data *td, struct io_u *io_u) |
178 | { | |
ee56ad50 | 179 | dprint_io_u(io_u, "prep"); |
7101d9c2 JA |
180 | fio_ro_check(td, io_u); |
181 | ||
36167d82 JA |
182 | if (td->io_ops->prep) |
183 | return td->io_ops->prep(td, io_u); | |
10ba535a JA |
184 | |
185 | return 0; | |
186 | } | |
187 | ||
e7d2e616 | 188 | int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max, |
10ba535a JA |
189 | struct timespec *t) |
190 | { | |
ee56ad50 | 191 | int r = 0; |
face81b2 | 192 | |
ee56ad50 JA |
193 | if (min > 0 && td->io_ops->commit) { |
194 | r = td->io_ops->commit(td); | |
face81b2 | 195 | if (r < 0) |
ee56ad50 | 196 | goto out; |
face81b2 | 197 | } |
36167d82 | 198 | |
ee56ad50 JA |
199 | r = 0; |
200 | if (td->io_ops->getevents) | |
201 | r = td->io_ops->getevents(td, min, max, t); | |
202 | out: | |
203 | dprint(FD_IO, "getevents: %d\n", r); | |
204 | return r; | |
10ba535a JA |
205 | } |
206 | ||
207 | int td_io_queue(struct thread_data *td, struct io_u *io_u) | |
208 | { | |
7e77dd02 JA |
209 | int ret; |
210 | ||
ee56ad50 | 211 | dprint_io_u(io_u, "queue"); |
7101d9c2 JA |
212 | fio_ro_check(td, io_u); |
213 | ||
0c6e7517 JA |
214 | assert((io_u->flags & IO_U_F_FLIGHT) == 0); |
215 | io_u->flags |= IO_U_F_FLIGHT; | |
216 | ||
3d7b485f JA |
217 | assert(io_u->file->flags & FIO_FILE_OPEN); |
218 | ||
11786802 JA |
219 | io_u->error = 0; |
220 | io_u->resid = 0; | |
221 | ||
433afcb4 | 222 | if (td->io_ops->flags & FIO_SYNCIO) { |
5aeb77df | 223 | fio_gettime(&io_u->issue_time, NULL); |
a61eddec | 224 | memcpy(&td->last_issue, &io_u->issue_time, sizeof(struct timeval)); |
10ba535a | 225 | |
433afcb4 JA |
226 | /* |
227 | * for a sync engine, set the timeout upfront | |
228 | */ | |
229 | if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT) | |
230 | io_u_set_timeout(td); | |
231 | } | |
232 | ||
755200a3 JA |
233 | if (io_u->ddir != DDIR_SYNC) |
234 | td->io_issues[io_u->ddir]++; | |
235 | ||
b3605062 JA |
236 | io_u_mark_depth(td, io_u); |
237 | ||
7e77dd02 | 238 | ret = td->io_ops->queue(td, io_u); |
5aeb77df | 239 | |
eb7c8ae2 JA |
240 | if (ret == FIO_Q_QUEUED) { |
241 | int r; | |
242 | ||
cb5ab512 | 243 | td->io_u_queued++; |
2dc1bbeb | 244 | if (td->io_u_queued > td->o.iodepth_batch) { |
eb7c8ae2 JA |
245 | r = td_io_commit(td); |
246 | if (r < 0) | |
247 | return r; | |
248 | } | |
249 | } | |
cb5ab512 | 250 | |
433afcb4 | 251 | if ((td->io_ops->flags & FIO_SYNCIO) == 0) { |
5aeb77df | 252 | fio_gettime(&io_u->issue_time, NULL); |
a61eddec | 253 | memcpy(&td->last_issue, &io_u->issue_time, sizeof(struct timeval)); |
5aeb77df | 254 | |
433afcb4 JA |
255 | /* |
256 | * async engine, set the timeout here | |
257 | */ | |
258 | if (ret == FIO_Q_QUEUED && | |
259 | mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT) | |
260 | io_u_set_timeout(td); | |
261 | } | |
262 | ||
7e77dd02 | 263 | return ret; |
10ba535a | 264 | } |
8c16d840 JA |
265 | |
266 | int td_io_init(struct thread_data *td) | |
267 | { | |
eeb12160 | 268 | int ret = 0; |
8c16d840 | 269 | |
eeb12160 JA |
270 | if (td->io_ops->init) { |
271 | ret = td->io_ops->init(td); | |
272 | if (ret && td->o.iodepth > 1) | |
9de6bebc | 273 | log_err("fio: io engine init failed. Perhaps try reducing io depth?\n"); |
eeb12160 JA |
274 | } |
275 | ||
276 | return ret; | |
8c16d840 | 277 | } |
755200a3 JA |
278 | |
279 | int td_io_commit(struct thread_data *td) | |
280 | { | |
ee56ad50 JA |
281 | dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth); |
282 | ||
e1161c32 JA |
283 | if (!td->cur_depth) |
284 | return 0; | |
cb5ab512 JA |
285 | |
286 | td->io_u_queued = 0; | |
755200a3 JA |
287 | if (td->io_ops->commit) |
288 | return td->io_ops->commit(td); | |
289 | ||
290 | return 0; | |
291 | } | |
b5af8293 JA |
292 | |
293 | int td_io_open_file(struct thread_data *td, struct fio_file *f) | |
294 | { | |
413d6693 JA |
295 | if (td->io_ops->open_file(td, f)) { |
296 | if (td->error == EINVAL && td->o.odirect) | |
297 | log_err("fio: destination does not support O_DIRECT\n"); | |
298 | if (td->error == EMFILE) | |
299 | log_err("fio: try reducing/setting openfiles (failed at %u of %u)\n", td->nr_open_files, td->o.nr_files); | |
300 | ||
301 | return 1; | |
302 | } | |
303 | ||
66159828 JA |
304 | if (f->filetype == FIO_TYPE_PIPE) { |
305 | if (td_random(td)) { | |
306 | log_err("fio: can't seek on pipes (no random io)\n"); | |
307 | goto err; | |
308 | } | |
309 | } | |
310 | ||
413d6693 JA |
311 | f->last_free_lookup = 0; |
312 | f->last_completed_pos = 0; | |
bcdedd0a | 313 | f->last_pos = f->file_offset; |
413d6693 JA |
314 | f->flags |= FIO_FILE_OPEN; |
315 | f->flags &= ~FIO_FILE_CLOSING; | |
316 | ||
317 | if (td->io_ops->flags & FIO_DISKLESSIO) | |
318 | goto done; | |
319 | ||
320 | if (td->o.invalidate_cache && file_invalidate_cache(td, f)) | |
321 | goto err; | |
322 | ||
66159828 JA |
323 | if (td->o.fadvise_hint && |
324 | (f->filetype == FIO_TYPE_BD || f->filetype == FIO_TYPE_FILE)) { | |
325 | ||
413d6693 JA |
326 | int flags; |
327 | ||
328 | if (td_random(td)) | |
329 | flags = POSIX_FADV_RANDOM; | |
330 | else | |
331 | flags = POSIX_FADV_SEQUENTIAL; | |
332 | ||
333 | if (fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) { | |
334 | td_verror(td, errno, "fadvise"); | |
335 | goto err; | |
336 | } | |
7bb48f84 | 337 | } |
a978ba68 | 338 | |
413d6693 JA |
339 | if (f->file_map) |
340 | memset(f->file_map, 0, f->num_maps * sizeof(long)); | |
a978ba68 | 341 | |
413d6693 | 342 | done: |
f29b25a3 | 343 | log_file(td, f, FIO_LOG_OPEN_FILE); |
413d6693 JA |
344 | td->nr_open_files++; |
345 | get_file(f); | |
346 | return 0; | |
347 | err: | |
b284075a JA |
348 | if (td->io_ops->close_file) |
349 | td->io_ops->close_file(td, f); | |
7bb48f84 | 350 | return 1; |
b5af8293 JA |
351 | } |
352 | ||
353 | void td_io_close_file(struct thread_data *td, struct fio_file *f) | |
354 | { | |
f29b25a3 JA |
355 | if (!(f->flags & FIO_FILE_CLOSING)) |
356 | log_file(td, f, FIO_LOG_CLOSE_FILE); | |
357 | ||
0ad920e7 JA |
358 | /* |
359 | * mark as closing, do real close when last io on it has completed | |
360 | */ | |
361 | f->flags |= FIO_FILE_CLOSING; | |
362 | ||
363 | put_file(td, f); | |
b5af8293 | 364 | } |