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