Commit | Line | Data |
---|---|---|
2866c82d | 1 | /* |
da751ca9 JA |
2 | * libaio engine |
3 | * | |
4 | * IO engine using the Linux native aio interface. | |
2866c82d JA |
5 | * |
6 | */ | |
7 | #include <stdio.h> | |
8 | #include <stdlib.h> | |
9 | #include <unistd.h> | |
10 | #include <errno.h> | |
11 | #include <assert.h> | |
67bf9823 | 12 | #include <libaio.h> |
5f350952 JA |
13 | |
14 | #include "../fio.h" | |
2866c82d | 15 | |
0fc2e103 JA |
16 | static int fio_libaio_commit(struct thread_data *td); |
17 | ||
2866c82d JA |
18 | struct libaio_data { |
19 | io_context_t aio_ctx; | |
20 | struct io_event *aio_events; | |
755200a3 | 21 | struct iocb **iocbs; |
7e77dd02 | 22 | struct io_u **io_us; |
acd45e02 JA |
23 | |
24 | /* | |
25 | * Basic ring buffer. 'head' is incremented in _queue(), and | |
26 | * 'tail' is incremented in _commit(). We keep 'queued' so | |
27 | * that we know if the ring is full or empty, when | |
28 | * 'head' == 'tail'. 'entries' is the ring size, and | |
29 | * 'is_pow2' is just an optimization to use AND instead of | |
30 | * modulus to get the remainder on ring increment. | |
31 | */ | |
32 | int is_pow2; | |
33 | unsigned int entries; | |
34 | unsigned int queued; | |
35 | unsigned int head; | |
36 | unsigned int tail; | |
2866c82d JA |
37 | }; |
38 | ||
de890a1e SL |
39 | struct libaio_options { |
40 | struct thread_data *td; | |
41 | unsigned int userspace_reap; | |
42 | }; | |
43 | ||
44 | static struct fio_option options[] = { | |
45 | { | |
46 | .name = "userspace_reap", | |
e8b0e958 | 47 | .lname = "Libaio userspace reaping", |
de890a1e SL |
48 | .type = FIO_OPT_STR_SET, |
49 | .off1 = offsetof(struct libaio_options, userspace_reap), | |
50 | .help = "Use alternative user-space reap implementation", | |
e90a0adf | 51 | .category = FIO_OPT_C_ENGINE, |
5a3cd5f3 | 52 | .group = FIO_OPT_G_LIBAIO, |
de890a1e SL |
53 | }, |
54 | { | |
55 | .name = NULL, | |
56 | }, | |
57 | }; | |
58 | ||
acd45e02 JA |
59 | static inline void ring_inc(struct libaio_data *ld, unsigned int *val, |
60 | unsigned int add) | |
61 | { | |
62 | if (ld->is_pow2) | |
63 | *val = (*val + add) & (ld->entries - 1); | |
64 | else | |
65 | *val = (*val + add) % ld->entries; | |
66 | } | |
67 | ||
7a16dd02 | 68 | static int fio_libaio_prep(struct thread_data fio_unused *td, struct io_u *io_u) |
2866c82d | 69 | { |
53cdc686 JA |
70 | struct fio_file *f = io_u->file; |
71 | ||
2866c82d | 72 | if (io_u->ddir == DDIR_READ) |
cec6b55d | 73 | io_prep_pread(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset); |
87dc1ab1 | 74 | else if (io_u->ddir == DDIR_WRITE) |
cec6b55d | 75 | io_prep_pwrite(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset); |
5f9099ea | 76 | else if (ddir_sync(io_u->ddir)) |
87dc1ab1 | 77 | io_prep_fsync(&io_u->iocb, f->fd); |
2866c82d JA |
78 | |
79 | return 0; | |
80 | } | |
81 | ||
82 | static struct io_u *fio_libaio_event(struct thread_data *td, int event) | |
83 | { | |
84 | struct libaio_data *ld = td->io_ops->data; | |
f423479d JA |
85 | struct io_event *ev; |
86 | struct io_u *io_u; | |
2866c82d | 87 | |
f423479d | 88 | ev = ld->aio_events + event; |
0cc6ee59 | 89 | io_u = container_of(ev->obj, struct io_u, iocb); |
f423479d JA |
90 | |
91 | if (ev->res != io_u->xfer_buflen) { | |
92 | if (ev->res > io_u->xfer_buflen) | |
93 | io_u->error = -ev->res; | |
94 | else | |
95 | io_u->resid = io_u->xfer_buflen - ev->res; | |
96 | } else | |
97 | io_u->error = 0; | |
98 | ||
99 | return io_u; | |
2866c82d JA |
100 | } |
101 | ||
675012f0 DE |
102 | struct aio_ring { |
103 | unsigned id; /** kernel internal index number */ | |
104 | unsigned nr; /** number of io_events */ | |
105 | unsigned head; | |
106 | unsigned tail; | |
c44b1ff5 | 107 | |
675012f0 DE |
108 | unsigned magic; |
109 | unsigned compat_features; | |
110 | unsigned incompat_features; | |
111 | unsigned header_length; /** size of aio_ring */ | |
112 | ||
113 | struct io_event events[0]; | |
114 | }; | |
115 | ||
116 | #define AIO_RING_MAGIC 0xa10a10a1 | |
117 | ||
118 | static int user_io_getevents(io_context_t aio_ctx, unsigned int max, | |
c44b1ff5 | 119 | struct io_event *events) |
675012f0 DE |
120 | { |
121 | long i = 0; | |
122 | unsigned head; | |
c44b1ff5 | 123 | struct aio_ring *ring = (struct aio_ring*) aio_ctx; |
675012f0 DE |
124 | |
125 | while (i < max) { | |
126 | head = ring->head; | |
127 | ||
128 | if (head == ring->tail) { | |
129 | /* There are no more completions */ | |
130 | break; | |
131 | } else { | |
132 | /* There is another completion to reap */ | |
133 | events[i] = ring->events[head]; | |
134 | read_barrier(); | |
c44b1ff5 | 135 | ring->head = (head + 1) % ring->nr; |
675012f0 DE |
136 | i++; |
137 | } | |
138 | } | |
139 | ||
140 | return i; | |
141 | } | |
142 | ||
e7d2e616 | 143 | static int fio_libaio_getevents(struct thread_data *td, unsigned int min, |
1f440ece | 144 | unsigned int max, const struct timespec *t) |
2866c82d JA |
145 | { |
146 | struct libaio_data *ld = td->io_ops->data; | |
de890a1e | 147 | struct libaio_options *o = td->eo; |
0b7fdba7 | 148 | unsigned actual_min = td->o.iodepth_batch_complete == 0 ? 0 : min; |
1f440ece | 149 | struct timespec __lt, *lt = NULL; |
0b7fdba7 | 150 | int r, events = 0; |
2866c82d | 151 | |
1f440ece JA |
152 | if (t) { |
153 | __lt = *t; | |
154 | lt = &__lt; | |
155 | } | |
156 | ||
2866c82d | 157 | do { |
de890a1e | 158 | if (o->userspace_reap == 1 |
675012f0 DE |
159 | && actual_min == 0 |
160 | && ((struct aio_ring *)(ld->aio_ctx))->magic | |
161 | == AIO_RING_MAGIC) { | |
162 | r = user_io_getevents(ld->aio_ctx, max, | |
163 | ld->aio_events + events); | |
164 | } else { | |
165 | r = io_getevents(ld->aio_ctx, actual_min, | |
1f440ece | 166 | max, ld->aio_events + events, lt); |
675012f0 | 167 | } |
3441a52d | 168 | if (r > 0) |
0b7fdba7 | 169 | events += r; |
3441a52d | 170 | else if ((min && r == 0) || r == -EAGAIN) { |
0fc2e103 | 171 | fio_libaio_commit(td); |
2866c82d | 172 | usleep(100); |
0fc2e103 | 173 | } else if (r != -EINTR) |
a31dc2dd | 174 | break; |
0b7fdba7 DE |
175 | } while (events < min); |
176 | ||
177 | return r < 0 ? r : events; | |
2866c82d JA |
178 | } |
179 | ||
180 | static int fio_libaio_queue(struct thread_data *td, struct io_u *io_u) | |
181 | { | |
182 | struct libaio_data *ld = td->io_ops->data; | |
2866c82d | 183 | |
7101d9c2 JA |
184 | fio_ro_check(td, io_u); |
185 | ||
acd45e02 | 186 | if (ld->queued == td->o.iodepth) |
755200a3 JA |
187 | return FIO_Q_BUSY; |
188 | ||
189 | /* | |
190 | * fsync is tricky, since it can fail and we need to do it | |
191 | * serialized with other io. the reason is that linux doesn't | |
192 | * support aio fsync yet. So return busy for the case where we | |
193 | * have pending io, to let fio complete those first. | |
194 | */ | |
f011531e | 195 | if (ddir_sync(io_u->ddir)) { |
acd45e02 | 196 | if (ld->queued) |
755200a3 | 197 | return FIO_Q_BUSY; |
5f9099ea | 198 | |
f011531e | 199 | do_io_u_sync(td, io_u); |
755200a3 JA |
200 | return FIO_Q_COMPLETED; |
201 | } | |
202 | ||
a5f3027c | 203 | if (io_u->ddir == DDIR_TRIM) { |
acd45e02 | 204 | if (ld->queued) |
a5f3027c JA |
205 | return FIO_Q_BUSY; |
206 | ||
207 | do_io_u_trim(td, io_u); | |
208 | return FIO_Q_COMPLETED; | |
209 | } | |
210 | ||
acd45e02 JA |
211 | ld->iocbs[ld->head] = &io_u->iocb; |
212 | ld->io_us[ld->head] = io_u; | |
213 | ring_inc(ld, &ld->head, 1); | |
214 | ld->queued++; | |
755200a3 JA |
215 | return FIO_Q_QUEUED; |
216 | } | |
217 | ||
7e77dd02 JA |
218 | static void fio_libaio_queued(struct thread_data *td, struct io_u **io_us, |
219 | unsigned int nr) | |
220 | { | |
221 | struct timeval now; | |
222 | unsigned int i; | |
223 | ||
12d9d841 JA |
224 | if (!fio_fill_issue_time(td)) |
225 | return; | |
226 | ||
7e77dd02 JA |
227 | fio_gettime(&now, NULL); |
228 | ||
229 | for (i = 0; i < nr; i++) { | |
230 | struct io_u *io_u = io_us[i]; | |
231 | ||
232 | memcpy(&io_u->issue_time, &now, sizeof(now)); | |
233 | io_u_queued(td, io_u); | |
234 | } | |
235 | } | |
236 | ||
755200a3 JA |
237 | static int fio_libaio_commit(struct thread_data *td) |
238 | { | |
239 | struct libaio_data *ld = td->io_ops->data; | |
240 | struct iocb **iocbs; | |
7e77dd02 | 241 | struct io_u **io_us; |
a120ca7f JA |
242 | struct timeval tv; |
243 | int ret, wait_start = 0; | |
755200a3 | 244 | |
acd45e02 | 245 | if (!ld->queued) |
755200a3 JA |
246 | return 0; |
247 | ||
2866c82d | 248 | do { |
acd45e02 JA |
249 | long nr = ld->queued; |
250 | ||
251 | nr = min((unsigned int) nr, ld->entries - ld->tail); | |
252 | io_us = ld->io_us + ld->tail; | |
253 | iocbs = ld->iocbs + ld->tail; | |
254 | ||
255 | ret = io_submit(ld->aio_ctx, nr, iocbs); | |
5e00c2c4 | 256 | if (ret > 0) { |
7e77dd02 | 257 | fio_libaio_queued(td, io_us, ret); |
838bc709 | 258 | io_u_mark_submit(td, ret); |
acd45e02 JA |
259 | |
260 | ld->queued -= ret; | |
261 | ring_inc(ld, &ld->tail, ret); | |
5e00c2c4 | 262 | ret = 0; |
e3b4e568 | 263 | wait_start = 0; |
acd45e02 | 264 | } else if (ret == -EINTR || !ret) { |
838bc709 JA |
265 | if (!ret) |
266 | io_u_mark_submit(td, ret); | |
e3b4e568 | 267 | wait_start = 0; |
2866c82d | 268 | continue; |
acd45e02 JA |
269 | } else if (ret == -EAGAIN) { |
270 | /* | |
271 | * If we get EAGAIN, we should break out without | |
272 | * error and let the upper layer reap some | |
a120ca7f JA |
273 | * events for us. If we have no queued IO, we |
274 | * must loop here. If we loop for more than 30s, | |
275 | * just error out, something must be buggy in the | |
276 | * IO path. | |
acd45e02 | 277 | */ |
a120ca7f JA |
278 | if (ld->queued) { |
279 | ret = 0; | |
280 | break; | |
281 | } | |
282 | if (!wait_start) { | |
283 | fio_gettime(&tv, NULL); | |
284 | wait_start = 0; | |
285 | } else if (mtime_since_now(&tv) > 30000) { | |
286 | log_err("fio: aio appears to be stalled, giving up\n"); | |
287 | break; | |
288 | } | |
289 | usleep(1); | |
290 | continue; | |
a31dc2dd JA |
291 | } else if (ret == -ENOMEM) { |
292 | /* | |
293 | * If we get -ENOMEM, reap events if we can. If | |
294 | * we cannot, treat it as a fatal event since there's | |
295 | * nothing we can do about it. | |
296 | */ | |
297 | if (ld->queued) | |
298 | ret = 0; | |
299 | break; | |
838bc709 | 300 | } else |
2866c82d | 301 | break; |
2c3a4ae9 | 302 | } while (ld->queued); |
2866c82d | 303 | |
36167d82 | 304 | return ret; |
2866c82d JA |
305 | } |
306 | ||
307 | static int fio_libaio_cancel(struct thread_data *td, struct io_u *io_u) | |
308 | { | |
309 | struct libaio_data *ld = td->io_ops->data; | |
310 | ||
311 | return io_cancel(ld->aio_ctx, &io_u->iocb, ld->aio_events); | |
312 | } | |
313 | ||
314 | static void fio_libaio_cleanup(struct thread_data *td) | |
315 | { | |
316 | struct libaio_data *ld = td->io_ops->data; | |
317 | ||
318 | if (ld) { | |
319 | io_destroy(ld->aio_ctx); | |
7e77dd02 JA |
320 | free(ld->aio_events); |
321 | free(ld->iocbs); | |
322 | free(ld->io_us); | |
2866c82d | 323 | free(ld); |
2866c82d JA |
324 | } |
325 | } | |
326 | ||
327 | static int fio_libaio_init(struct thread_data *td) | |
328 | { | |
c90e1017 | 329 | struct libaio_options *o = td->eo; |
acd45e02 | 330 | struct libaio_data *ld; |
c90e1017 | 331 | int err = 0; |
2866c82d | 332 | |
acd45e02 | 333 | ld = calloc(1, sizeof(*ld)); |
c1db2dce | 334 | |
c90e1017 JA |
335 | /* |
336 | * First try passing in 0 for queue depth, since we don't | |
337 | * care about the user ring. If that fails, the kernel is too old | |
338 | * and we need the right depth. | |
339 | */ | |
340 | if (!o->userspace_reap) | |
c224ec05 | 341 | err = io_queue_init(INT_MAX, &ld->aio_ctx); |
c90e1017 JA |
342 | if (o->userspace_reap || err == -EINVAL) |
343 | err = io_queue_init(td->o.iodepth, &ld->aio_ctx); | |
c1db2dce JA |
344 | if (err) { |
345 | td_verror(td, -err, "io_queue_init"); | |
75de55ac | 346 | log_err("fio: check /proc/sys/fs/aio-max-nr\n"); |
cb781c75 | 347 | free(ld); |
2866c82d JA |
348 | return 1; |
349 | } | |
350 | ||
acd45e02 JA |
351 | ld->entries = td->o.iodepth; |
352 | ld->is_pow2 = is_power_of_2(ld->entries); | |
353 | ld->aio_events = calloc(ld->entries, sizeof(struct io_event)); | |
354 | ld->iocbs = calloc(ld->entries, sizeof(struct iocb *)); | |
355 | ld->io_us = calloc(ld->entries, sizeof(struct io_u *)); | |
755200a3 | 356 | |
2866c82d JA |
357 | td->io_ops->data = ld; |
358 | return 0; | |
359 | } | |
360 | ||
5f350952 | 361 | static struct ioengine_ops ioengine = { |
de890a1e SL |
362 | .name = "libaio", |
363 | .version = FIO_IOOPS_VERSION, | |
364 | .init = fio_libaio_init, | |
365 | .prep = fio_libaio_prep, | |
366 | .queue = fio_libaio_queue, | |
367 | .commit = fio_libaio_commit, | |
368 | .cancel = fio_libaio_cancel, | |
369 | .getevents = fio_libaio_getevents, | |
370 | .event = fio_libaio_event, | |
371 | .cleanup = fio_libaio_cleanup, | |
372 | .open_file = generic_open_file, | |
373 | .close_file = generic_close_file, | |
374 | .get_file_size = generic_get_file_size, | |
375 | .options = options, | |
376 | .option_struct_size = sizeof(struct libaio_options), | |
2866c82d | 377 | }; |
34cfcdaf | 378 | |
5f350952 JA |
379 | static void fio_init fio_libaio_register(void) |
380 | { | |
381 | register_ioengine(&ioengine); | |
382 | } | |
383 | ||
384 | static void fio_exit fio_libaio_unregister(void) | |
385 | { | |
386 | unregister_ioengine(&ioengine); | |
387 | } |