syslet: x86_64 support
[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
8c16d840
JA
31 /*
32 * cpu thread doesn't need to provide anything
33 */
34 if (ops->flags & FIO_CPUIO)
35 return 0;
36
36167d82
JA
37 if (!ops->queue) {
38 log_err("%s: no queue handler\n", ops->name);
39 return 1;
40 }
41
42 /*
43 * sync engines only need a ->queue()
44 */
45 if (ops->flags & FIO_SYNCIO)
46 return 0;
47
8c16d840 48 if (!ops->event) {
36167d82 49 log_err("%s: no event handler\n", ops->name);
8c16d840
JA
50 return 1;
51 }
52 if (!ops->getevents) {
36167d82 53 log_err("%s: no getevents handler\n", ops->name);
8c16d840
JA
54 return 1;
55 }
56 if (!ops->queue) {
36167d82 57 log_err("%s: no queue handler\n", ops->name);
8c16d840
JA
58 return 1;
59 }
60
61 return 0;
62}
63
5f350952 64void unregister_ioengine(struct ioengine_ops *ops)
ebac4655 65{
5f350952
JA
66 list_del(&ops->list);
67 INIT_LIST_HEAD(&ops->list);
68}
69
b2fdda43 70void register_ioengine(struct ioengine_ops *ops)
5f350952 71{
5f350952
JA
72 INIT_LIST_HEAD(&ops->list);
73 list_add_tail(&ops->list, &engine_list);
5f350952
JA
74}
75
76static struct ioengine_ops *find_ioengine(const char *name)
77{
78 struct ioengine_ops *ops;
79 struct list_head *entry;
80 char engine[16];
ebac4655 81
0bbab0e7 82 strncpy(engine, name, sizeof(engine) - 1);
ebac4655 83
2866c82d
JA
84 if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
85 strcpy(engine, "libaio");
ebac4655 86
5f350952
JA
87 list_for_each(entry, &engine_list) {
88 ops = list_entry(entry, struct ioengine_ops, list);
89 if (!strcmp(engine, ops->name))
90 return ops;
91 }
92
93 return NULL;
94}
95
96static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
97 const char *engine_lib)
98{
99 struct ioengine_ops *ops;
100 void *dlhandle;
101
2866c82d
JA
102 dlerror();
103 dlhandle = dlopen(engine_lib, RTLD_LAZY);
d4dbaaa8 104 if (!dlhandle) {
e1161c32 105 td_vmsg(td, -1, dlerror(), "dlopen");
d4dbaaa8
JA
106 return NULL;
107 }
8756e4d4 108
da51c050
JA
109 /*
110 * Unlike the included modules, external engines should have a
111 * non-static ioengine structure that we can reference.
112 */
2866c82d 113 ops = dlsym(dlhandle, "ioengine");
d4dbaaa8 114 if (!ops) {
e1161c32 115 td_vmsg(td, -1, dlerror(), "dlsym");
d4dbaaa8
JA
116 dlclose(dlhandle);
117 return NULL;
118 }
8756e4d4 119
5f350952
JA
120 ops->dlhandle = dlhandle;
121 return ops;
122}
123
124struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
125{
126 struct ioengine_ops *ops, *ret;
127 char engine[16];
128
129 strncpy(engine, name, sizeof(engine) - 1);
130
131 /*
132 * linux libaio has alias names, so convert to what we want
133 */
134 if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
135 strcpy(engine, "libaio");
136
137 ops = find_ioengine(engine);
138 if (!ops)
139 ops = dlopen_ioengine(td, name);
140
141 if (!ops) {
142 log_err("fio: engine %s not loadable\n", name);
b902ceb5
JA
143 return NULL;
144 }
145
8c16d840
JA
146 /*
147 * Check that the required methods are there.
148 */
5f350952 149 if (check_engine_ops(ops))
8c16d840 150 return NULL;
8c16d840 151
84585003
JA
152 ret = malloc(sizeof(*ret));
153 memcpy(ret, ops, sizeof(*ret));
154 ret->data = NULL;
84585003
JA
155
156 return ret;
8756e4d4
JA
157}
158
2866c82d 159void close_ioengine(struct thread_data *td)
8756e4d4 160{
2866c82d
JA
161 if (td->io_ops->cleanup)
162 td->io_ops->cleanup(td);
b990b5c0 163
5f350952
JA
164 if (td->io_ops->dlhandle)
165 dlclose(td->io_ops->dlhandle);
166
19a98c41
JA
167#if 0
168 /* we can't do this for threads, so just leak it, it's exiting */
84585003 169 free(td->io_ops);
19a98c41 170#endif
84585003 171 td->io_ops = NULL;
b990b5c0 172}
10ba535a
JA
173
174int td_io_prep(struct thread_data *td, struct io_u *io_u)
175{
36167d82
JA
176 if (td->io_ops->prep)
177 return td->io_ops->prep(td, io_u);
10ba535a
JA
178
179 return 0;
180}
181
10ba535a
JA
182int td_io_getevents(struct thread_data *td, int min, int max,
183 struct timespec *t)
184{
face81b2
JA
185 if (min > 0 && td->io_ops->commit) {
186 int r = td->io_ops->commit(td);
187
188 if (r < 0)
189 return r;
190 }
36167d82
JA
191 if (td->io_ops->getevents)
192 return td->io_ops->getevents(td, min, max, t);
193
194 return 0;
10ba535a
JA
195}
196
197int td_io_queue(struct thread_data *td, struct io_u *io_u)
198{
7e77dd02
JA
199 int ret;
200
0c6e7517
JA
201 assert((io_u->flags & IO_U_F_FLIGHT) == 0);
202 io_u->flags |= IO_U_F_FLIGHT;
203
433afcb4 204 if (td->io_ops->flags & FIO_SYNCIO) {
5aeb77df 205 fio_gettime(&io_u->issue_time, NULL);
10ba535a 206
433afcb4
JA
207 /*
208 * for a sync engine, set the timeout upfront
209 */
210 if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
211 io_u_set_timeout(td);
212 }
213
755200a3
JA
214 if (io_u->ddir != DDIR_SYNC)
215 td->io_issues[io_u->ddir]++;
216
7e77dd02 217 ret = td->io_ops->queue(td, io_u);
5aeb77df 218
eb7c8ae2
JA
219 if (ret == FIO_Q_QUEUED) {
220 int r;
221
cb5ab512 222 td->io_u_queued++;
eb7c8ae2
JA
223 if (td->io_u_queued > td->iodepth_batch) {
224 r = td_io_commit(td);
225 if (r < 0)
226 return r;
227 }
228 }
cb5ab512 229
433afcb4 230 if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
5aeb77df
JA
231 fio_gettime(&io_u->issue_time, NULL);
232
433afcb4
JA
233 /*
234 * async engine, set the timeout here
235 */
236 if (ret == FIO_Q_QUEUED &&
237 mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
238 io_u_set_timeout(td);
239 }
240
7e77dd02 241 return ret;
10ba535a 242}
8c16d840
JA
243
244int td_io_init(struct thread_data *td)
245{
246 if (td->io_ops->init)
247 return td->io_ops->init(td);
248
249 return 0;
250}
755200a3
JA
251
252int td_io_commit(struct thread_data *td)
253{
e1161c32
JA
254 if (!td->cur_depth)
255 return 0;
cb5ab512
JA
256
257 td->io_u_queued = 0;
755200a3
JA
258 if (td->io_ops->commit)
259 return td->io_ops->commit(td);
260
261 return 0;
262}