Show IOPS as well as bw numbers
[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
JA
19#include "fio.h"
20#include "os.h"
21
5f350952
JA
22static LIST_HEAD(engine_list);
23
8c16d840
JA
24static int check_engine_ops(struct ioengine_ops *ops)
25{
5f350952
JA
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
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;
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 }
54
55 return 0;
56}
57
5f350952 58void unregister_ioengine(struct ioengine_ops *ops)
ebac4655 59{
5f350952
JA
60 list_del(&ops->list);
61 INIT_LIST_HEAD(&ops->list);
62}
63
b2fdda43 64void register_ioengine(struct ioengine_ops *ops)
5f350952 65{
5f350952
JA
66 INIT_LIST_HEAD(&ops->list);
67 list_add_tail(&ops->list, &engine_list);
5f350952
JA
68}
69
70static struct ioengine_ops *find_ioengine(const char *name)
71{
72 struct ioengine_ops *ops;
73 struct list_head *entry;
ebac4655 74
5f350952
JA
75 list_for_each(entry, &engine_list) {
76 ops = list_entry(entry, struct ioengine_ops, list);
bc5b77a8 77 if (!strcmp(name, ops->name))
5f350952
JA
78 return ops;
79 }
80
81 return NULL;
82}
83
84static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
85 const char *engine_lib)
86{
87 struct ioengine_ops *ops;
88 void *dlhandle;
89
2866c82d
JA
90 dlerror();
91 dlhandle = dlopen(engine_lib, RTLD_LAZY);
d4dbaaa8 92 if (!dlhandle) {
e1161c32 93 td_vmsg(td, -1, dlerror(), "dlopen");
d4dbaaa8
JA
94 return NULL;
95 }
8756e4d4 96
da51c050
JA
97 /*
98 * Unlike the included modules, external engines should have a
99 * non-static ioengine structure that we can reference.
100 */
2866c82d 101 ops = dlsym(dlhandle, "ioengine");
d4dbaaa8 102 if (!ops) {
e1161c32 103 td_vmsg(td, -1, dlerror(), "dlsym");
d4dbaaa8
JA
104 dlclose(dlhandle);
105 return NULL;
106 }
8756e4d4 107
5f350952
JA
108 ops->dlhandle = dlhandle;
109 return ops;
110}
111
112struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
113{
114 struct ioengine_ops *ops, *ret;
115 char engine[16];
116
117 strncpy(engine, name, sizeof(engine) - 1);
118
119 /*
120 * linux libaio has alias names, so convert to what we want
121 */
122 if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
123 strcpy(engine, "libaio");
124
125 ops = find_ioengine(engine);
126 if (!ops)
127 ops = dlopen_ioengine(td, name);
128
129 if (!ops) {
130 log_err("fio: engine %s not loadable\n", name);
b902ceb5
JA
131 return NULL;
132 }
133
8c16d840
JA
134 /*
135 * Check that the required methods are there.
136 */
5f350952 137 if (check_engine_ops(ops))
8c16d840 138 return NULL;
8c16d840 139
84585003
JA
140 ret = malloc(sizeof(*ret));
141 memcpy(ret, ops, sizeof(*ret));
142 ret->data = NULL;
84585003
JA
143
144 return ret;
8756e4d4
JA
145}
146
2866c82d 147void close_ioengine(struct thread_data *td)
8756e4d4 148{
2866c82d
JA
149 if (td->io_ops->cleanup)
150 td->io_ops->cleanup(td);
b990b5c0 151
5f350952
JA
152 if (td->io_ops->dlhandle)
153 dlclose(td->io_ops->dlhandle);
154
84585003
JA
155 free(td->io_ops);
156 td->io_ops = NULL;
b990b5c0 157}
10ba535a
JA
158
159int td_io_prep(struct thread_data *td, struct io_u *io_u)
160{
36167d82
JA
161 if (td->io_ops->prep)
162 return td->io_ops->prep(td, io_u);
10ba535a
JA
163
164 return 0;
165}
166
10ba535a
JA
167int td_io_getevents(struct thread_data *td, int min, int max,
168 struct timespec *t)
169{
face81b2
JA
170 if (min > 0 && td->io_ops->commit) {
171 int r = td->io_ops->commit(td);
172
173 if (r < 0)
174 return r;
175 }
36167d82
JA
176 if (td->io_ops->getevents)
177 return td->io_ops->getevents(td, min, max, t);
178
179 return 0;
10ba535a
JA
180}
181
182int td_io_queue(struct thread_data *td, struct io_u *io_u)
183{
7e77dd02
JA
184 int ret;
185
0c6e7517
JA
186 assert((io_u->flags & IO_U_F_FLIGHT) == 0);
187 io_u->flags |= IO_U_F_FLIGHT;
188
11786802
JA
189 io_u->error = 0;
190 io_u->resid = 0;
191
433afcb4 192 if (td->io_ops->flags & FIO_SYNCIO) {
5aeb77df 193 fio_gettime(&io_u->issue_time, NULL);
10ba535a 194
433afcb4
JA
195 /*
196 * for a sync engine, set the timeout upfront
197 */
198 if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
199 io_u_set_timeout(td);
200 }
201
755200a3
JA
202 if (io_u->ddir != DDIR_SYNC)
203 td->io_issues[io_u->ddir]++;
204
b3605062
JA
205 io_u_mark_depth(td, io_u);
206
7e77dd02 207 ret = td->io_ops->queue(td, io_u);
5aeb77df 208
eb7c8ae2
JA
209 if (ret == FIO_Q_QUEUED) {
210 int r;
211
cb5ab512 212 td->io_u_queued++;
eb7c8ae2
JA
213 if (td->io_u_queued > td->iodepth_batch) {
214 r = td_io_commit(td);
215 if (r < 0)
216 return r;
217 }
218 }
cb5ab512 219
433afcb4 220 if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
5aeb77df
JA
221 fio_gettime(&io_u->issue_time, NULL);
222
433afcb4
JA
223 /*
224 * async engine, set the timeout here
225 */
226 if (ret == FIO_Q_QUEUED &&
227 mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
228 io_u_set_timeout(td);
229 }
230
7e77dd02 231 return ret;
10ba535a 232}
8c16d840
JA
233
234int td_io_init(struct thread_data *td)
235{
236 if (td->io_ops->init)
237 return td->io_ops->init(td);
238
239 return 0;
240}
755200a3
JA
241
242int td_io_commit(struct thread_data *td)
243{
e1161c32
JA
244 if (!td->cur_depth)
245 return 0;
cb5ab512
JA
246
247 td->io_u_queued = 0;
755200a3
JA
248 if (td->io_ops->commit)
249 return td->io_ops->commit(td);
250
251 return 0;
252}
b5af8293
JA
253
254int td_io_open_file(struct thread_data *td, struct fio_file *f)
255{
a978ba68
JA
256 if (td->io_ops->open_file(td, f))
257 return 1;
b5af8293 258
a978ba68
JA
259 f->last_free_lookup = 0;
260 f->last_completed_pos = 0;
261 f->last_pos = 0;
262 f->open = 1;
263
264 if (f->file_map)
265 memset(f->file_map, 0, f->num_maps * sizeof(long));
266
267 td->nr_open_files++;
268 return 0;
b5af8293
JA
269}
270
271void td_io_close_file(struct thread_data *td, struct fio_file *f)
272{
860a3044
JA
273 if (f->open) {
274 if (td->io_ops->close_file)
275 td->io_ops->close_file(td, f);
276 td->nr_open_files--;
277 f->open = 0;
278 }
b5af8293 279}