Private parameters for ioengines
[fio.git] / ioengines.c
CommitLineData
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>
ecc314ba 17#include <fcntl.h>
0c6e7517 18#include <assert.h>
8c16d840 19
ebac4655 20#include "fio.h"
7c9b1bce 21#include "diskutil.h"
ebac4655 22
01743ee1 23static FLIST_HEAD(engine_list);
5f350952 24
8c16d840
JA
25static int check_engine_ops(struct ioengine_ops *ops)
26{
5f350952 27 if (ops->version != FIO_IOOPS_VERSION) {
5ec10eaa
JA
28 log_err("bad ioops version %d (want %d)\n", ops->version,
29 FIO_IOOPS_VERSION);
5f350952
JA
30 return 1;
31 }
32
36167d82
JA
33 if (!ops->queue) {
34 log_err("%s: no queue handler\n", ops->name);
35 return 1;
36 }
37
38 /*
39 * sync engines only need a ->queue()
40 */
41 if (ops->flags & FIO_SYNCIO)
42 return 0;
5ec10eaa 43
8c16d840 44 if (!ops->event) {
36167d82 45 log_err("%s: no event handler\n", ops->name);
8c16d840
JA
46 return 1;
47 }
48 if (!ops->getevents) {
36167d82 49 log_err("%s: no getevents handler\n", ops->name);
8c16d840
JA
50 return 1;
51 }
52 if (!ops->queue) {
36167d82 53 log_err("%s: no queue handler\n", ops->name);
8c16d840
JA
54 return 1;
55 }
5ec10eaa 56
8c16d840
JA
57 return 0;
58}
59
5f350952 60void unregister_ioengine(struct ioengine_ops *ops)
ebac4655 61{
ee56ad50 62 dprint(FD_IO, "ioengine %s unregistered\n", ops->name);
01743ee1
JA
63 flist_del(&ops->list);
64 INIT_FLIST_HEAD(&ops->list);
5f350952
JA
65}
66
b2fdda43 67void register_ioengine(struct ioengine_ops *ops)
5f350952 68{
ee56ad50 69 dprint(FD_IO, "ioengine %s registered\n", ops->name);
01743ee1
JA
70 INIT_FLIST_HEAD(&ops->list);
71 flist_add_tail(&ops->list, &engine_list);
5f350952
JA
72}
73
74static struct ioengine_ops *find_ioengine(const char *name)
75{
76 struct ioengine_ops *ops;
01743ee1 77 struct flist_head *entry;
ebac4655 78
01743ee1
JA
79 flist_for_each(entry, &engine_list) {
80 ops = flist_entry(entry, struct ioengine_ops, list);
bc5b77a8 81 if (!strcmp(name, ops->name))
5f350952
JA
82 return ops;
83 }
84
85 return NULL;
86}
87
88static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
89 const char *engine_lib)
90{
91 struct ioengine_ops *ops;
92 void *dlhandle;
93
ee56ad50
JA
94 dprint(FD_IO, "dload engine %s\n", engine_lib);
95
2866c82d
JA
96 dlerror();
97 dlhandle = dlopen(engine_lib, RTLD_LAZY);
d4dbaaa8 98 if (!dlhandle) {
e1161c32 99 td_vmsg(td, -1, dlerror(), "dlopen");
d4dbaaa8
JA
100 return NULL;
101 }
8756e4d4 102
da51c050
JA
103 /*
104 * Unlike the included modules, external engines should have a
105 * non-static ioengine structure that we can reference.
106 */
2866c82d 107 ops = dlsym(dlhandle, "ioengine");
d4dbaaa8 108 if (!ops) {
e1161c32 109 td_vmsg(td, -1, dlerror(), "dlsym");
d4dbaaa8
JA
110 dlclose(dlhandle);
111 return NULL;
112 }
8756e4d4 113
5f350952
JA
114 ops->dlhandle = dlhandle;
115 return ops;
116}
117
118struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
119{
120 struct ioengine_ops *ops, *ret;
121 char engine[16];
122
ee56ad50
JA
123 dprint(FD_IO, "load ioengine %s\n", name);
124
5f350952
JA
125 strncpy(engine, name, sizeof(engine) - 1);
126
127 /*
128 * linux libaio has alias names, so convert to what we want
129 */
130 if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
131 strcpy(engine, "libaio");
132
133 ops = find_ioengine(engine);
134 if (!ops)
135 ops = dlopen_ioengine(td, name);
136
137 if (!ops) {
138 log_err("fio: engine %s not loadable\n", name);
b902ceb5
JA
139 return NULL;
140 }
141
8c16d840
JA
142 /*
143 * Check that the required methods are there.
144 */
5f350952 145 if (check_engine_ops(ops))
8c16d840 146 return NULL;
8c16d840 147
84585003
JA
148 ret = malloc(sizeof(*ret));
149 memcpy(ret, ops, sizeof(*ret));
150 ret->data = NULL;
84585003
JA
151
152 return ret;
8756e4d4
JA
153}
154
de890a1e
SL
155/*
156 * For cleaning up an ioengine which never made it to init().
157 */
158void free_ioengine(struct thread_data *td)
8756e4d4 159{
de890a1e 160 dprint(FD_IO, "free ioengine %s\n", td->io_ops->name);
ee56ad50 161
de890a1e
SL
162 if (td->eo && td->io_ops->options) {
163 options_free(td->io_ops->options, td->eo);
164 free(td->eo);
165 td->eo = NULL;
2992b059 166 }
b990b5c0 167
5f350952
JA
168 if (td->io_ops->dlhandle)
169 dlclose(td->io_ops->dlhandle);
170
84585003
JA
171 free(td->io_ops);
172 td->io_ops = NULL;
b990b5c0 173}
10ba535a 174
de890a1e
SL
175void close_ioengine(struct thread_data *td)
176{
177 dprint(FD_IO, "close ioengine %s\n", td->io_ops->name);
178
179 if (td->io_ops->cleanup) {
180 td->io_ops->cleanup(td);
181 td->io_ops->data = NULL;
182 }
183
184 free_ioengine(td);
185}
186
10ba535a
JA
187int td_io_prep(struct thread_data *td, struct io_u *io_u)
188{
ee56ad50 189 dprint_io_u(io_u, "prep");
7101d9c2
JA
190 fio_ro_check(td, io_u);
191
4d4e80f2 192 lock_file(td, io_u->file, io_u->ddir);
b2bd2bd9 193
2ba1c290
JA
194 if (td->io_ops->prep) {
195 int ret = td->io_ops->prep(td, io_u);
196
197 dprint(FD_IO, "->prep(%p)=%d\n", io_u, ret);
b2bd2bd9 198 if (ret)
4d4e80f2 199 unlock_file(td, io_u->file);
2ba1c290
JA
200 return ret;
201 }
10ba535a
JA
202
203 return 0;
204}
205
e7d2e616 206int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max,
10ba535a
JA
207 struct timespec *t)
208{
ee56ad50 209 int r = 0;
face81b2 210
ee56ad50
JA
211 if (min > 0 && td->io_ops->commit) {
212 r = td->io_ops->commit(td);
face81b2 213 if (r < 0)
ee56ad50 214 goto out;
face81b2 215 }
4950421a
JA
216 if (max > td->cur_depth)
217 max = td->cur_depth;
218 if (min > max)
219 max = min;
36167d82 220
ee56ad50 221 r = 0;
4950421a 222 if (max && td->io_ops->getevents)
ee56ad50
JA
223 r = td->io_ops->getevents(td, min, max, t);
224out:
838bc709
JA
225 if (r >= 0)
226 io_u_mark_complete(td, r);
f3e11d05 227 else
7c639b14 228 td_verror(td, r, "get_events");
f3e11d05 229
ee56ad50
JA
230 dprint(FD_IO, "getevents: %d\n", r);
231 return r;
10ba535a
JA
232}
233
234int td_io_queue(struct thread_data *td, struct io_u *io_u)
235{
7e77dd02
JA
236 int ret;
237
ee56ad50 238 dprint_io_u(io_u, "queue");
7101d9c2
JA
239 fio_ro_check(td, io_u);
240
0c6e7517
JA
241 assert((io_u->flags & IO_U_F_FLIGHT) == 0);
242 io_u->flags |= IO_U_F_FLIGHT;
243
d6aed795 244 assert(fio_file_open(io_u->file));
3d7b485f 245
11786802
JA
246 io_u->error = 0;
247 io_u->resid = 0;
248
433afcb4 249 if (td->io_ops->flags & FIO_SYNCIO) {
12d9d841 250 if (fio_fill_issue_time(td))
9520ebb9 251 fio_gettime(&io_u->issue_time, NULL);
d0c15328
JA
252
253 /*
254 * only used for iolog
255 */
256 if (td->o.read_iolog_file)
257 memcpy(&td->last_issue, &io_u->issue_time,
5ec10eaa 258 sizeof(struct timeval));
433afcb4
JA
259 }
260
ff58fced 261 if (ddir_rw(io_u->ddir))
755200a3
JA
262 td->io_issues[io_u->ddir]++;
263
7e77dd02 264 ret = td->io_ops->queue(td, io_u);
5aeb77df 265
4d4e80f2 266 unlock_file(td, io_u->file);
b2bd2bd9 267
cb211682
JA
268 /*
269 * Add warning for O_DIRECT so that users have an easier time
270 * spotting potentially bad alignment. If this triggers for the first
271 * IO, then it's likely an alignment problem or because the host fs
272 * does not support O_DIRECT
273 */
ff58fced 274 if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
cb211682
JA
275 td->o.odirect) {
276 log_info("fio: first direct IO errored. File system may not "
277 "support direct IO, or iomem_align= is bad.\n");
278 }
279
838bc709
JA
280 if (!td->io_ops->commit) {
281 io_u_mark_submit(td, 1);
282 io_u_mark_complete(td, 1);
283 }
284
d8005759 285 if (ret == FIO_Q_COMPLETED) {
ff58fced 286 if (ddir_rw(io_u->ddir)) {
d8005759
JA
287 io_u_mark_depth(td, 1);
288 td->ts.total_io_u[io_u->ddir]++;
0d29de83
JA
289 } else if (io_u->ddir == DDIR_TRIM)
290 td->ts.total_io_u[2]++;
d8005759 291 } else if (ret == FIO_Q_QUEUED) {
eb7c8ae2
JA
292 int r;
293
ff58fced 294 if (ddir_rw(io_u->ddir)) {
d8005759
JA
295 td->io_u_queued++;
296 td->ts.total_io_u[io_u->ddir]++;
297 }
298
299 if (td->io_u_queued >= td->o.iodepth_batch) {
eb7c8ae2
JA
300 r = td_io_commit(td);
301 if (r < 0)
302 return r;
303 }
304 }
cb5ab512 305
433afcb4 306 if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
12d9d841 307 if (fio_fill_issue_time(td))
9520ebb9 308 fio_gettime(&io_u->issue_time, NULL);
d0c15328
JA
309
310 /*
311 * only used for iolog
312 */
313 if (td->o.read_iolog_file)
314 memcpy(&td->last_issue, &io_u->issue_time,
315 sizeof(struct timeval));
433afcb4
JA
316 }
317
7e77dd02 318 return ret;
10ba535a 319}
8c16d840
JA
320
321int td_io_init(struct thread_data *td)
322{
eeb12160 323 int ret = 0;
8c16d840 324
eeb12160
JA
325 if (td->io_ops->init) {
326 ret = td->io_ops->init(td);
5ec10eaa
JA
327 if (ret && td->o.iodepth > 1) {
328 log_err("fio: io engine init failed. Perhaps try"
329 " reducing io depth?\n");
330 }
7c973896
JA
331 if (!td->error)
332 td->error = ret;
eeb12160
JA
333 }
334
335 return ret;
8c16d840 336}
755200a3
JA
337
338int td_io_commit(struct thread_data *td)
339{
f3e11d05
JA
340 int ret;
341
ee56ad50
JA
342 dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
343
d8005759 344 if (!td->cur_depth || !td->io_u_queued)
e1161c32 345 return 0;
cb5ab512 346
d8005759 347 io_u_mark_depth(td, td->io_u_queued);
cb5ab512 348 td->io_u_queued = 0;
d8005759 349
f3e11d05
JA
350 if (td->io_ops->commit) {
351 ret = td->io_ops->commit(td);
352 if (ret)
353 td_verror(td, -ret, "io commit");
354 }
755200a3
JA
355
356 return 0;
357}
b5af8293
JA
358
359int td_io_open_file(struct thread_data *td, struct fio_file *f)
360{
22a57ba8
JA
361 assert(!fio_file_open(f));
362 assert(f->fd == -1);
363
413d6693
JA
364 if (td->io_ops->open_file(td, f)) {
365 if (td->error == EINVAL && td->o.odirect)
366 log_err("fio: destination does not support O_DIRECT\n");
5ec10eaa
JA
367 if (td->error == EMFILE) {
368 log_err("fio: try reducing/setting openfiles (failed"
369 " at %u of %u)\n", td->nr_open_files,
370 td->o.nr_files);
371 }
413d6693 372
22a57ba8
JA
373 assert(f->fd == -1);
374 assert(!fio_file_open(f));
413d6693
JA
375 return 1;
376 }
377
d5707a35 378 fio_file_reset(f);
d6aed795
JA
379 fio_file_set_open(f);
380 fio_file_clear_closing(f);
c97bd0fa 381 disk_util_inc(f->du);
d5707a35
JA
382
383 td->nr_open_files++;
384 get_file(f);
385
66159828
JA
386 if (f->filetype == FIO_TYPE_PIPE) {
387 if (td_random(td)) {
388 log_err("fio: can't seek on pipes (no random io)\n");
389 goto err;
390 }
391 }
392
413d6693
JA
393 if (td->io_ops->flags & FIO_DISKLESSIO)
394 goto done;
395
396 if (td->o.invalidate_cache && file_invalidate_cache(td, f))
397 goto err;
398
66159828
JA
399 if (td->o.fadvise_hint &&
400 (f->filetype == FIO_TYPE_BD || f->filetype == FIO_TYPE_FILE)) {
413d6693
JA
401 int flags;
402
403 if (td_random(td))
404 flags = POSIX_FADV_RANDOM;
405 else
406 flags = POSIX_FADV_SEQUENTIAL;
407
ecc314ba 408 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
413d6693
JA
409 td_verror(td, errno, "fadvise");
410 goto err;
411 }
7bb48f84 412 }
a978ba68 413
e116f2b9
JA
414#ifdef FIO_OS_DIRECTIO
415 /*
416 * Some OS's have a distinct call to mark the file non-buffered,
417 * instead of using O_DIRECT (Solaris)
418 */
419 if (td->o.odirect) {
420 int ret = fio_set_odirect(f->fd);
421
422 if (ret) {
423 td_verror(td, ret, "fio_set_odirect");
78e51c72 424 log_err("fio: the file system does not seem to support direct IO\n");
e116f2b9
JA
425 goto err;
426 }
427 }
428#endif
429
413d6693 430done:
f29b25a3 431 log_file(td, f, FIO_LOG_OPEN_FILE);
413d6693
JA
432 return 0;
433err:
c97bd0fa 434 disk_util_dec(f->du);
b284075a
JA
435 if (td->io_ops->close_file)
436 td->io_ops->close_file(td, f);
7bb48f84 437 return 1;
b5af8293
JA
438}
439
6977bcd0 440int td_io_close_file(struct thread_data *td, struct fio_file *f)
b5af8293 441{
d6aed795 442 if (!fio_file_closing(f))
f29b25a3
JA
443 log_file(td, f, FIO_LOG_CLOSE_FILE);
444
0ad920e7
JA
445 /*
446 * mark as closing, do real close when last io on it has completed
447 */
d6aed795 448 fio_file_set_closing(f);
0ad920e7 449
c97bd0fa 450 disk_util_dec(f->du);
4d4e80f2 451 unlock_file_all(td, f);
29c1349f 452
6977bcd0 453 return put_file(td, f);
b5af8293 454}
df9c26b1
JA
455
456int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
457{
458 if (!td->io_ops->get_file_size)
459 return 0;
460
461 return td->io_ops->get_file_size(td, f);
462}
44f29692 463
0a28ecda 464static int do_sync_file_range(struct thread_data *td, struct fio_file *f)
44f29692
JA
465{
466 off64_t offset, nbytes;
467
468 offset = f->first_write;
469 nbytes = f->last_write - f->first_write;
470
3843deb3
JA
471 if (!nbytes)
472 return 0;
44f29692 473
3843deb3 474 return sync_file_range(f->fd, offset, nbytes, td->o.sync_file_range);
44f29692 475}
0a28ecda
JA
476
477int do_io_u_sync(struct thread_data *td, struct io_u *io_u)
478{
479 int ret;
480
481 if (io_u->ddir == DDIR_SYNC) {
482 ret = fsync(io_u->file->fd);
483 } else if (io_u->ddir == DDIR_DATASYNC) {
484#ifdef FIO_HAVE_FDATASYNC
485 ret = fdatasync(io_u->file->fd);
486#else
487 ret = io_u->xfer_buflen;
488 io_u->error = EINVAL;
489#endif
490 } else if (io_u->ddir == DDIR_SYNC_FILE_RANGE)
491 ret = do_sync_file_range(td, io_u->file);
492 else {
493 ret = io_u->xfer_buflen;
494 io_u->error = EINVAL;
495 }
496
cb849a79
JA
497 if (ret < 0)
498 io_u->error = errno;
499
0a28ecda
JA
500 return ret;
501}
a5f3027c
JA
502
503int do_io_u_trim(struct thread_data *td, struct io_u *io_u)
504{
505#ifndef FIO_HAVE_TRIM
506 io_u->error = EINVAL;
ff58fced 507 return 0;
a5f3027c
JA
508#else
509 struct fio_file *f = io_u->file;
510 int ret;
511
c6404a44 512 ret = os_trim(f->fd, io_u->offset, io_u->xfer_buflen);
a5f3027c 513 if (!ret)
ff58fced 514 return io_u->xfer_buflen;;
a5f3027c 515
ff58fced
JA
516 io_u->error = ret;
517 return 0;
a5f3027c
JA
518#endif
519}
de890a1e
SL
520
521int fio_show_ioengine_help(const char *engine)
522{
523 struct flist_head *entry;
524 struct thread_data td;
525 char *sep;
526 int ret = 1;
527
528 if (!engine || !*engine) {
529 log_info("Available IO engines:\n");
530 flist_for_each(entry, &engine_list) {
531 td.io_ops = flist_entry(entry, struct ioengine_ops,
532 list);
533 log_info("\t%s\n", td.io_ops->name);
534 }
535 return 0;
536 }
537 sep = strchr(engine, ',');
538 if (sep) {
539 *sep = 0;
540 sep++;
541 }
542
543 memset(&td, 0, sizeof(td));
544
545 td.io_ops = load_ioengine(&td, engine);
546 if (!td.io_ops) {
547 log_info("IO engine %s not found\n", engine);
548 return 1;
549 }
550
551 if (td.io_ops->options)
552 ret = show_cmd_help(td.io_ops->options, sep);
553 else
554 log_info("IO engine %s has no options\n", td.io_ops->name);
555
556 free_ioengine(&td);
557
558 return ret;
559}