ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/libev/ev_linuxaio.c
Revision: 1.6
Committed: Fri Jun 21 03:52:29 2019 UTC (4 years, 10 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.5: +26 -21 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 /*
2     * libev linux aio fd activity backend
3     *
4     * Copyright (c) 2019 Marc Alexander Lehmann <libev@schmorp.de>
5     * All rights reserved.
6     *
7     * Redistribution and use in source and binary forms, with or without modifica-
8     * tion, are permitted provided that the following conditions are met:
9     *
10     * 1. Redistributions of source code must retain the above copyright notice,
11     * this list of conditions and the following disclaimer.
12     *
13     * 2. Redistributions in binary form must reproduce the above copyright
14     * notice, this list of conditions and the following disclaimer in the
15     * documentation and/or other materials provided with the distribution.
16     *
17     * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
18     * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MER-
19     * CHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
20     * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPE-
21     * CIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
22     * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
23     * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
24     * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTH-
25     * ERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
26     * OF THE POSSIBILITY OF SUCH DAMAGE.
27     *
28     * Alternatively, the contents of this file may be used under the terms of
29     * the GNU General Public License ("GPL") version 2 or any later version,
30     * in which case the provisions of the GPL are applicable instead of
31     * the above. If you wish to allow the use of your version of this file
32     * only under the terms of the GPL and not to allow others to use your
33     * version of this file under the BSD license, indicate your decision
34     * by deleting the provisions above and replace them with the notice
35     * and other provisions required by the GPL. If you do not delete the
36     * provisions above, a recipient may use your version of this file under
37     * either the BSD or the GPL.
38     */
39    
40     #include <sys/time.h> /* actually linux/time.h, but we must assume they are compatible */
41 root 1.2 #include <poll.h>
42 root 1.1 #include <linux/aio_abi.h>
43    
44 root 1.6 /* we try to fill 4kB pages exactly.
45 root 1.1 * the ring buffer header is 32 bytes, every io event is 32 bytes.
46 root 1.6 * the kernel takes the io event number, doubles it, adds 2, adds the ring buffer.
47     * therefore the calculation below will use "exactly" 8kB for the ring buffer
48 root 1.1 */
49     #define EV_LINUXAIO_DEPTH (256 / 2 - 2 - 1) /* max. number of io events per batch */
50    
51     /*****************************************************************************/
52     /* syscall wrapdadoop */
53    
54     #include <sys/syscall.h> /* no glibc wrappers */
55    
56 root 1.5 /* aio_abi.h is not versioned in any way, so we cannot test for its existance */
57 root 1.1 #define IOCB_CMD_POLL 5
58    
59     /* taken from linux/fs/aio.c */
60     #define AIO_RING_MAGIC 0xa10a10a1
61     #define AIO_RING_INCOMPAT_FEATURES 0
62     struct aio_ring
63     {
64     unsigned id; /* kernel internal index number */
65     unsigned nr; /* number of io_events */
66     unsigned head; /* Written to by userland or by kernel. */
67     unsigned tail;
68    
69     unsigned magic;
70     unsigned compat_features;
71     unsigned incompat_features;
72     unsigned header_length; /* size of aio_ring */
73    
74     struct io_event io_events[0];
75     };
76    
77 root 1.6 inline_size
78     int
79 root 1.1 ev_io_setup (unsigned nr_events, aio_context_t *ctx_idp)
80     {
81     return syscall (SYS_io_setup, nr_events, ctx_idp);
82     }
83    
84 root 1.6 inline_size
85     int
86 root 1.1 ev_io_destroy (aio_context_t ctx_id)
87     {
88     return syscall (SYS_io_destroy, ctx_id);
89     }
90    
91 root 1.6 inline_size
92     int
93 root 1.1 ev_io_submit (aio_context_t ctx_id, long nr, struct iocb *cbp[])
94     {
95     return syscall (SYS_io_submit, ctx_id, nr, cbp);
96     }
97    
98 root 1.6 inline_size
99     int
100 root 1.1 ev_io_cancel (aio_context_t ctx_id, struct iocb *cbp, struct io_event *result)
101     {
102     return syscall (SYS_io_cancel, ctx_id, cbp, result);
103     }
104    
105 root 1.6 inline_size
106     int
107 root 1.1 ev_io_getevents (aio_context_t ctx_id, long min_nr, long nr, struct io_event *events, struct timespec *timeout)
108     {
109     return syscall (SYS_io_getevents, ctx_id, min_nr, nr, events, timeout);
110     }
111    
112     /*****************************************************************************/
113     /* actual backed implementation */
114    
115     typedef struct aniocb
116     {
117     struct iocb io;
118     /*int inuse;*/
119     } *ANIOCBP;
120    
121     inline_size
122     void
123     linuxaio_array_needsize_iocbp (ANIOCBP *base, int count)
124     {
125     /* TODO: quite the overhead to allocate every iocb separately */
126     while (count--)
127     {
128     *base = (ANIOCBP)ev_malloc (sizeof (**base));
129 root 1.2 /* TODO: full zero initialize required? */
130 root 1.1 memset (*base, 0, sizeof (**base));
131     /* would be nice to initialize fd/data as well */
132     (*base)->io.aio_lio_opcode = IOCB_CMD_POLL;
133     ++base;
134     }
135     }
136    
137 root 1.6 ecb_cold
138 root 1.1 static void
139     linuxaio_free_iocbp (EV_P)
140     {
141     while (linuxaio_iocbpmax--)
142     ev_free (linuxaio_iocbps [linuxaio_iocbpmax]);
143    
144 root 1.6 linuxaio_iocbpmax = 0; /* next resize will completely reallocate the array, at some overhead */
145 root 1.1 }
146    
147     static void
148     linuxaio_modify (EV_P_ int fd, int oev, int nev)
149     {
150     array_needsize (ANIOCBP, linuxaio_iocbps, linuxaio_iocbpmax, fd + 1, linuxaio_array_needsize_iocbp);
151     struct aniocb *iocb = linuxaio_iocbps [fd];
152    
153     if (iocb->io.aio_buf)
154 root 1.4 ev_io_cancel (linuxaio_ctx, &iocb->io, (struct io_event *)0); /* always returns an error relevant kernels */
155 root 1.1
156     if (nev)
157     {
158     iocb->io.aio_data = fd;
159     iocb->io.aio_fildes = fd;
160     iocb->io.aio_buf =
161     (nev & EV_READ ? POLLIN : 0)
162     | (nev & EV_WRITE ? POLLOUT : 0);
163    
164     /* queue iocb up for io_submit */
165     /* this assumes we only ever get one call per fd per loop iteration */
166     ++linuxaio_submitcnt;
167     array_needsize (struct iocb *, linuxaio_submits, linuxaio_submitmax, linuxaio_submitcnt, array_needsize_noinit);
168     linuxaio_submits [linuxaio_submitcnt - 1] = &iocb->io;
169     }
170     }
171    
172     static void
173     linuxaio_parse_events (EV_P_ struct io_event *ev, int nr)
174     {
175     while (nr)
176     {
177     int fd = ev->data;
178     int res = ev->res;
179    
180 root 1.2 assert (("libev: iocb fd must be in-bounds", fd >= 0 && fd < anfdmax));
181 root 1.1
182     /* linux aio is oneshot: rearm fd */
183     linuxaio_iocbps [fd]->io.aio_buf = 0;
184     anfds [fd].events = 0;
185     fd_change (EV_A_ fd, 0);
186    
187     /* feed events, we do not expect or handle POLLNVAL */
188     if (ecb_expect_false (res & POLLNVAL))
189     fd_kill (EV_A_ fd);
190     else
191     fd_event (
192     EV_A_
193     fd,
194     (res & (POLLOUT | POLLERR | POLLHUP) ? EV_WRITE : 0)
195     | (res & (POLLIN | POLLERR | POLLHUP) ? EV_READ : 0)
196     );
197    
198     --nr;
199     ++ev;
200     }
201     }
202    
203     /* get any events from ringbuffer, return true if any were handled */
204     static int
205     linuxaio_get_events_from_ring (EV_P)
206     {
207     struct aio_ring *ring = (struct aio_ring *)linuxaio_ctx;
208    
209     ECB_MEMORY_FENCE_ACQUIRE;
210    
211     unsigned head = ring->head;
212     unsigned tail = *(volatile unsigned *)&ring->tail;
213    
214 root 1.6 if (head == tail)
215     return 0;
216    
217     if (ecb_expect_false (ring->magic != AIO_RING_MAGIC)
218     || ring->incompat_features != AIO_RING_INCOMPAT_FEATURES
219     || ring->header_length != sizeof (struct aio_ring)) /* TODO: or use it to find io_event[0]? */
220 root 1.1 return 0;
221    
222     /* parse all available events, but only once, to avoid starvation */
223     if (tail > head) /* normal case around */
224     linuxaio_parse_events (EV_A_ ring->io_events + head, tail - head);
225 root 1.6 else /* wrapped around */
226 root 1.1 {
227     linuxaio_parse_events (EV_A_ ring->io_events + head, ring->nr - head);
228     linuxaio_parse_events (EV_A_ ring->io_events, tail);
229     }
230    
231     ring->head = tail;
232    
233     return 1;
234     }
235    
236     /* read at least one event from kernel, or timeout */
237     inline_size
238     void
239     linuxaio_get_events (EV_P_ ev_tstamp timeout)
240     {
241     struct timespec ts;
242     struct io_event ioev;
243     int res;
244    
245     if (linuxaio_get_events_from_ring (EV_A))
246     return;
247    
248     /* no events, so wait for at least one, then poll ring buffer again */
249     /* this degraded to one event per loop iteration */
250     /* if the ring buffer changes layout, but so be it */
251    
252     ts.tv_sec = (long)timeout;
253     ts.tv_nsec = (long)((timeout - ts.tv_sec) * 1e9);
254    
255     res = ev_io_getevents (linuxaio_ctx, 1, 1, &ioev, &ts);
256    
257     if (res < 0)
258     ev_syserr ("(libev) io_getevents");
259     else if (res)
260     {
261     /* at least one event received, handle it and any remaining ones in the ring buffer */
262     linuxaio_parse_events (EV_A_ &ioev, 1);
263     linuxaio_get_events_from_ring (EV_A);
264     }
265     }
266    
267     static void
268     linuxaio_poll (EV_P_ ev_tstamp timeout)
269     {
270     int submitted;
271    
272     /* first phase: submit new iocbs */
273    
274     /* io_submit might return less than the requested number of iocbs */
275     /* this is, afaics, only because of errors, but we go by the book and use a loop, */
276     /* which allows us to pinpoint the errornous iocb */
277     for (submitted = 0; submitted < linuxaio_submitcnt; )
278     {
279     int res = ev_io_submit (linuxaio_ctx, linuxaio_submitcnt - submitted, linuxaio_submits + submitted);
280    
281 root 1.6 if (ecb_expect_false (res < 0))
282 root 1.1 if (errno == EAGAIN)
283     {
284     /* This happens when the ring buffer is full, at least. I assume this means
285     * that the event was queued synchronously during io_submit, and thus
286     * the buffer overflowd.
287     * In this case, we just try next loop iteration.
288     */
289 root 1.5 memmove (linuxaio_submits, linuxaio_submits + submitted, (linuxaio_submitcnt - submitted) * sizeof (*linuxaio_submits));
290 root 1.1 linuxaio_submitcnt -= submitted;
291     timeout = 0;
292     break;
293     }
294     else
295     /* TODO: we get EAGAIN when the ring buffer is full for some reason */
296     /* TODO: should we always just try next time? */
297     ev_syserr ("(libev) io_submit");
298    
299     submitted += res;
300     }
301    
302     linuxaio_submitcnt = 0;
303    
304     /* second phase: fetch and parse events */
305    
306     linuxaio_get_events (EV_A_ timeout);
307     }
308    
309     inline_size
310     int
311     linuxaio_init (EV_P_ int flags)
312     {
313     /* would be great to have a nice test for IOCB_CMD_POLL instead */
314 root 1.2 /* also: test some semi-common fd types, such as files and ttys in recommended_backends */
315 root 1.1 if (ev_linux_version () < 0x041200) /* 4.18 introduced IOCB_CMD_POLL */
316     return 0;
317    
318 root 1.3 linuxaio_ctx = 0;
319 root 1.1 if (ev_io_setup (EV_LINUXAIO_DEPTH, &linuxaio_ctx) < 0)
320     return 0;
321    
322     backend_modify = linuxaio_modify;
323     backend_poll = linuxaio_poll;
324    
325     linuxaio_iocbpmax = 0;
326     linuxaio_iocbps = 0;
327    
328     linuxaio_submits = 0;
329     linuxaio_submitmax = 0;
330     linuxaio_submitcnt = 0;
331    
332     return EVBACKEND_LINUXAIO;
333     }
334    
335     inline_size
336     void
337     linuxaio_destroy (EV_P)
338     {
339     linuxaio_free_iocbp (EV_A);
340     ev_io_destroy (linuxaio_ctx);
341     }
342    
343     inline_size
344     void
345     linuxaio_fork (EV_P)
346     {
347 root 1.2 /* TODO: verify and test */
348 root 1.6
349     /* this frees all iocbs, which is very heavy-handed */
350 root 1.2 linuxaio_destroy (EV_A);
351 root 1.6 linuxaio_submitcnt = 0; /* all pointers were invalidated */
352 root 1.2
353 root 1.3 linuxaio_ctx = 0;
354 root 1.2 while (ev_io_setup (EV_LINUXAIO_DEPTH, &linuxaio_ctx) < 0)
355     ev_syserr ("(libev) io_setup");
356    
357     fd_rearm_all (EV_A);
358 root 1.1 }
359