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