Do not free epoll event queues
[akaros.git] / user / iplib / epoll.c
1 /* Copyright (c) 2015 Google Inc.
2  * Barret Rhoden <brho@cs.berkeley.edu>
3  * See LICENSE for details.
4  *
5  * Epoll, built on FD taps, CEQs, and blocking uthreads on event queues.
6  *
7  * TODO: There are a few incompatibilities with Linux's epoll, some of which are
8  * artifacts of the implementation, and other issues:
9  *      - you can't epoll on an epoll fd (or any user fd).  you can only epoll on a
10  *      kernel FD that accepts your FD taps.
11  *      - there's no EPOLLONESHOT or level-triggered support.
12  *      - you can only tap one FD at a time, so you can't add the same FD to
13  *      multiple epoll sets.
14  *      - there is no support for growing the epoll set.
15  *      - closing the epoll is a little dangerous, if there are outstanding INDIR
16  *      events.  this will only pop up if you're yielding cores, maybe getting
17  *      preempted, and are unlucky.
18  *      - epoll_create1 does not support CLOEXEC.  That'd need some work in glibc's
19  *      exec and flags in struct user_fd.
20  *      - EPOLL_CTL_MOD is just a DEL then an ADD.  There might be races associated
21  *      with that.
22  *      - If you close a tracked FD without removing it from the epoll set, the
23  *      kernel will turn off the FD tap.  You may still have an epoll event that was
24  *      concurrently sent.  Likewise, that FD may be used again by your program, and
25  *      if you add *that* one to another epoll set before removing it from the
26  *      current one, weird things may happen (like having two epoll ctlrs turning on
27  *      and off taps).
28  *      - epoll_pwait is probably racy.
29  *      - Using spin locks instead of mutexes during syscalls that could block.  The
30  *      process won't deadlock, but it will busy wait on something like an RPC,
31  *      depending on the device being tapped.
32  *      - You can't dup an epoll fd (same as other user FDs).
33  *      - If you add a BSD socket FD to an epoll set before calling listen(), you'll
34  *      only epoll on the data (which is inactive) instead of on the accept().
35  *      - If you add the same BSD socket listener to multiple epoll sets, you will
36  *      likely fail.  This is in addition to being able to tap only one FD at a
37  *      time.
38  * */
39
40 #include <sys/epoll.h>
41 #include <parlib/parlib.h>
42 #include <parlib/event.h>
43 #include <parlib/ceq.h>
44 #include <parlib/uthread.h>
45 #include <parlib/spinlock.h>
46 #include <parlib/timing.h>
47 #include <sys/user_fd.h>
48 #include <stdio.h>
49 #include <errno.h>
50 #include <unistd.h>
51 #include <malloc.h>
52
53 /* Sanity check, so we can ID our own FDs */
54 #define EPOLL_UFD_MAGIC                 0xe9011
55
56 struct epoll_ctlr {
57         struct event_queue                      *ceq_evq;
58         struct ceq                                      *ceq;   /* convenience pointer */
59         unsigned int                            size;
60         struct spin_pdr_lock            lock;
61         struct user_fd                          ufd;
62 };
63
64 /* There's some bookkeeping we need to maintain on every FD.  Right now, the FD
65  * is the index into the CEQ event array, so we can just hook this into the user
66  * data blob in the ceq_event.
67  *
68  * If we ever do not maintain a 1:1 mapping from FDs to CEQ IDs, we can use this
69  * to track the CEQ ID and FD. */
70 struct ep_fd_data {
71         struct epoll_event                      ep_event;
72         int                                                     fd;
73         int                                                     filter;
74         int                                                     sock_listen_fd;
75 };
76
77 /* Converts epoll events to FD taps. */
78 static int ep_events_to_taps(uint32_t ep_ev)
79 {
80         int taps = 0;
81         if (ep_ev & EPOLLIN)
82                 taps |= FDTAP_FILT_READABLE;
83         if (ep_ev & EPOLLOUT)
84                 taps |= FDTAP_FILT_WRITABLE;
85         if (ep_ev & EPOLLRDHUP)
86                 taps |= FDTAP_FILT_RDHUP;
87         if (ep_ev & EPOLLPRI)
88                 taps |= FDTAP_FILT_PRIORITY;
89         if (ep_ev & EPOLLERR)
90                 taps |= FDTAP_FILT_ERROR;
91         if (ep_ev & EPOLLHUP)
92                 taps |= FDTAP_FILT_HANGUP;
93         return taps;
94 }
95
96 /* Converts corresponding FD Taps to epoll events.  There are other taps that do
97  * not make sense for epoll. */
98 static uint32_t taps_to_ep_events(int taps)
99 {
100         uint32_t ep_ev = 0;
101         if (taps & FDTAP_FILT_READABLE)
102                 ep_ev |= EPOLLIN;
103         if (taps & FDTAP_FILT_WRITABLE)
104                 ep_ev |= EPOLLOUT;
105         if (taps & FDTAP_FILT_RDHUP)
106                 ep_ev |= EPOLLRDHUP;
107         if (taps & FDTAP_FILT_PRIORITY)
108                 ep_ev |= EPOLLPRI;
109         if (taps & FDTAP_FILT_ERROR)
110                 ep_ev |= EPOLLERR;
111         if (taps & FDTAP_FILT_HANGUP)
112                 ep_ev |= EPOLLHUP;
113         return ep_ev;
114 }
115
116 static struct ceq_event *ep_get_ceq_ev(struct epoll_ctlr *ep, size_t idx)
117 {
118         if (ep->ceq_evq->ev_mbox->ceq.nr_events <= idx)
119                 return 0;
120         return &ep->ceq_evq->ev_mbox->ceq.events[idx];
121 }
122
123 static struct epoll_ctlr *fd_to_cltr(int fd)
124 {
125         struct user_fd *ufd = ufd_lookup(fd);
126         if (!ufd)
127                 return 0;
128         if (ufd->magic != EPOLL_UFD_MAGIC) {
129                 errno = EBADF;
130                 return 0;
131         }
132         return container_of(ufd, struct epoll_ctlr, ufd);
133 }
134
135 /* Event queue helpers: */
136 static struct event_queue *ep_get_ceq_evq(unsigned int ceq_size)
137 {
138         struct event_queue *ceq_evq = get_eventq_raw();
139         ceq_evq->ev_mbox->type = EV_MBOX_CEQ;
140         ceq_init(&ceq_evq->ev_mbox->ceq, CEQ_OR, ceq_size, ceq_size);
141         ceq_evq->ev_flags = EVENT_INDIR | EVENT_SPAM_INDIR | EVENT_WAKEUP;
142         evq_attach_wakeup_ctlr(ceq_evq);
143         return ceq_evq;
144 }
145
146 static struct event_queue *ep_get_alarm_evq(void)
147 {
148         /* Don't care about the actual message, just using it for a wakeup */
149         struct event_queue *alarm_evq = get_eventq(EV_MBOX_BITMAP);
150         alarm_evq->ev_flags = EVENT_INDIR | EVENT_SPAM_INDIR | EVENT_WAKEUP;
151         evq_attach_wakeup_ctlr(alarm_evq);
152         return alarm_evq;
153 }
154
155 /* Once we've closed our sources of events, we can try to clean up the event
156  * queues.  These are actually dangerous, since there could be INDIRs floating
157  * around for these evqs still, which are basically pointers.  We'll need to run
158  * some sort of user deferred destruction. (TODO). */
159 static void ep_put_ceq_evq(struct event_queue *ceq_evq)
160 {
161 #if 0 /* TODO: EVQ/INDIR Cleanup */
162         ceq_cleanup(&ceq_evq->ev_mbox->ceq);
163         evq_remove_wakeup_ctlr(ceq_evq);
164         put_eventq_raw(ceq_evq);
165 #endif
166 }
167
168 static void ep_put_alarm_evq(struct event_queue *alarm_evq)
169 {
170 #if 0 /* TODO: EVQ/INDIR Cleanup */
171         evq_remove_wakeup_ctlr(alarm_evq);
172         put_eventq(alarm_evq);
173 #endif
174 }
175
176 static void epoll_close(struct user_fd *ufd)
177 {
178         struct epoll_ctlr *ep = container_of(ufd, struct epoll_ctlr, ufd);
179         struct fd_tap_req *tap_reqs, *tap_req_i;
180         struct ceq_event *ceq_ev_i;
181         struct ep_fd_data *ep_fd_i;
182         int nr_tap_req = 0;
183         int nr_done = 0;
184
185         tap_reqs = malloc(sizeof(struct fd_tap_req) * ep->size);
186         memset(tap_reqs, 0, sizeof(struct fd_tap_req) * ep->size);
187         /* Slightly painful, O(n) with no escape hatch */
188         for (int i = 0; i < ep->size; i++) {
189                 ceq_ev_i = ep_get_ceq_ev(ep, i);
190                 /* CEQ should have been big enough for our size */
191                 assert(ceq_ev_i);
192                 ep_fd_i = (struct ep_fd_data*)ceq_ev_i->user_data;
193                 if (!ep_fd_i)
194                         continue;
195                 if (ep_fd_i->sock_listen_fd >= 0) {
196                         /* This tap is using a listen_fd, opened by __epoll_ctl_add, so the
197                          * user doesn't know about this FD.  We need to remove the tap and
198                          * close the FD; the kernel will remove the tap when we close it. */
199                         close(ep_fd_i->sock_listen_fd);
200                         free(ep_fd_i);
201                         continue;
202                 }
203                 tap_req_i = &tap_reqs[nr_tap_req++];
204                 tap_req_i->fd = i;
205                 tap_req_i->cmd = FDTAP_CMD_REM;
206                 free(ep_fd_i);
207         }
208         /* Requests could fail if the tapped files are already closed.  We need to
209          * skip the failed one (the +1) and untap the rest. */
210         do {
211                 nr_done += sys_tap_fds(tap_reqs + nr_done, nr_tap_req - nr_done);
212                 nr_done += 1;   /* nr_done could be more than nr_tap_req now */
213         } while (nr_done < nr_tap_req);
214         free(tap_reqs);
215         ep_put_ceq_evq(ep->ceq_evq);
216 }
217
218 static int init_ep_ctlr(struct epoll_ctlr *ep, int size)
219 {
220         unsigned int ceq_size = ROUNDUPPWR2(size);
221         /* TODO: we don't grow yet.  Until then, we help out a little. */
222         if (size == 1)
223                 size = 128;
224         ep->size = ceq_size;
225         spin_pdr_init(&ep->lock);
226         ep->ufd.magic = EPOLL_UFD_MAGIC;
227         ep->ufd.close = epoll_close;
228         ep->ceq_evq = ep_get_ceq_evq(ceq_size);
229         return 0;
230 }
231
232 int epoll_create(int size)
233 {
234         int fd;
235         struct epoll_ctlr *ep;
236         /* good thing the arg is a signed int... */
237         if (size < 0) {
238                 errno = EINVAL;
239                 return -1;
240         }
241         ep = malloc(sizeof(struct epoll_ctlr));
242         memset(ep, 0, sizeof(struct epoll_ctlr));
243         if (init_ep_ctlr(ep, size)) {
244                 free(ep);
245                 return -1;
246         }
247         fd = ufd_get_fd(&ep->ufd);
248         if (fd < 0)
249                 free(ep);
250         return fd;
251 }
252
253 int epoll_create1(int flags)
254 {
255         /* TODO: we're supposed to support CLOEXEC.  Our FD is a user_fd, so that'd
256          * require some support in glibc's exec to close our epoll ctlr. */
257         return epoll_create(1);
258 }
259
260 static int __epoll_ctl_add(struct epoll_ctlr *ep, int fd,
261                            struct epoll_event *event)
262 {
263         struct ceq_event *ceq_ev;
264         struct ep_fd_data *ep_fd;
265         struct fd_tap_req tap_req = {0};
266         int ret, filter, sock_listen_fd;
267
268         /* Only support ET.  Also, we just ignore EPOLLONESHOT.  That might work,
269          * logically, just with spurious events firing. */
270         if (!(event->events & EPOLLET)) {
271                 errno = EPERM;
272                 werrstr("Epoll level-triggered not supported");
273                 return -1;
274         }
275         /* The sockets-to-plan9 networking shims are a bit inconvenient.  The user
276          * asked us to epoll on an FD, but that FD is actually a Qdata FD.  We need
277          * to actually epoll on the listen_fd.  We'll store this in the ep_fd, so
278          * that later on we can close it.
279          *
280          * As far as tracking the FD goes for epoll_wait() reporting, if the app
281          * wants to track the FD they think we are using, then they already passed
282          * that in event->data.
283          *
284          * But before we get too far, we need to make sure we aren't already tapping
285          * this FD's listener (hence the lookup).
286          *
287          * This all assumes that this socket is only added to one epoll set at a
288          * time.  The _sock calls are racy, and once one epoller set up a listen_fd
289          * in the Rock, we'll think that it was us. */
290         extern int _sock_lookup_listen_fd(int sock_fd); /* in glibc */
291         extern int _sock_get_listen_fd(int sock_fd);
292         if (_sock_lookup_listen_fd(fd) >= 0) {
293                 errno = EEXIST;
294                 return -1;
295         }
296         sock_listen_fd = _sock_get_listen_fd(fd);
297         if (sock_listen_fd >= 0)
298                 fd = sock_listen_fd;
299         ceq_ev = ep_get_ceq_ev(ep, fd);
300         if (!ceq_ev) {
301                 errno = ENOMEM;
302                 werrstr("Epoll set cannot grow yet!");
303                 return -1;
304         }
305         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
306         if (ep_fd) {
307                 errno = EEXIST;
308                 return -1;
309         }
310         tap_req.fd = fd;
311         tap_req.cmd = FDTAP_CMD_ADD;
312         /* EPOLLHUP is implicitly set for all epolls. */
313         filter = ep_events_to_taps(event->events | EPOLLHUP);
314         tap_req.filter = filter;
315         tap_req.ev_q = ep->ceq_evq;
316         tap_req.ev_id = fd;     /* using FD as the CEQ ID */
317         ret = sys_tap_fds(&tap_req, 1);
318         if (ret != 1)
319                 return -1;
320         ep_fd = malloc(sizeof(struct ep_fd_data));
321         ep_fd->fd = fd;
322         ep_fd->filter = filter;
323         ep_fd->ep_event = *event;
324         ep_fd->ep_event.events |= EPOLLHUP;
325         ep_fd->sock_listen_fd = sock_listen_fd;
326         ceq_ev->user_data = (uint64_t)ep_fd;
327         return 0;
328 }
329
330 static int __epoll_ctl_del(struct epoll_ctlr *ep, int fd,
331                            struct epoll_event *event)
332 {
333         struct ceq_event *ceq_ev;
334         struct ep_fd_data *ep_fd;
335         struct fd_tap_req tap_req = {0};
336         int ret, sock_listen_fd;
337
338         /* They could be asking to clear an epoll for a listener.  We need to remove
339          * the tap for the real FD we tapped */
340         extern int _sock_lookup_listen_fd(int sock_fd); /* in glibc */
341         sock_listen_fd = _sock_lookup_listen_fd(fd);
342         if (sock_listen_fd >= 0)
343                 fd = sock_listen_fd;
344         ceq_ev = ep_get_ceq_ev(ep, fd);
345         if (!ceq_ev) {
346                 errno = ENOENT;
347                 return -1;
348         }
349         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
350         if (!ep_fd) {
351                 errno = ENOENT;
352                 return -1;
353         }
354         assert(ep_fd->fd == fd);
355         tap_req.fd = fd;
356         tap_req.cmd = FDTAP_CMD_REM;
357         /* ignoring the return value; we could have failed to remove it if the FD
358          * has already closed and the kernel removed the tap. */
359         sys_tap_fds(&tap_req, 1);
360         ceq_ev->user_data = 0;
361         assert(ep_fd->sock_listen_fd == sock_listen_fd);
362         if (ep_fd->sock_listen_fd >= 0) {
363                 assert(ep_fd->sock_listen_fd == sock_listen_fd);
364                 close(ep_fd->sock_listen_fd);
365         }
366         free(ep_fd);
367         return 0;
368 }
369
370 int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event)
371 {
372         int ret;
373         struct epoll_ctlr *ep = fd_to_cltr(epfd);
374         if (!ep) {
375                 errno = EBADF;/* or EINVAL */
376                 return -1;
377         }
378         if (fd >= USER_FD_BASE) {
379                 errno = EINVAL;
380                 werrstr("Epoll can't track User FDs");
381                 return -1;
382         }
383         /* TODO: don't use a spinlock, use a mutex.  sys_tap_fds can block. */
384         spin_pdr_lock(&ep->lock);
385         switch (op) {
386                 case (EPOLL_CTL_MOD):
387                         /* In lieu of a proper MOD, just remove and readd.  The errors might
388                          * not work out well, and there could be a missed event in the
389                          * middle.  Not sure what the guarantees are, but we can fake a
390                          * poke. (TODO). */
391                         ret = __epoll_ctl_del(ep, fd, 0);
392                         if (ret)
393                                 break;
394                         ret = __epoll_ctl_add(ep, fd, event);
395                         break;
396                 case (EPOLL_CTL_ADD):
397                         ret = __epoll_ctl_add(ep, fd, event);
398                         break;
399                 case (EPOLL_CTL_DEL):
400                         ret = __epoll_ctl_del(ep, fd, event);
401                         break;
402                 default:
403                         errno = EINVAL;
404                         ret = -1;
405         }
406         spin_pdr_unlock(&ep->lock);
407         return ret;
408 }
409
410 static bool get_ep_event_from_msg(struct epoll_ctlr *ep, struct event_msg *msg,
411                                   struct epoll_event *ep_ev)
412 {
413         struct ceq_event *ceq_ev;
414         struct ep_fd_data *ep_fd;
415
416         ceq_ev = ep_get_ceq_ev(ep, msg->ev_type);
417         /* should never get a tap FD > size of the epoll set */
418         assert(ceq_ev);
419         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
420         if (!ep_fd) {
421                 /* it's possible the FD was unregistered and this was an old
422                  * event sent to this epoll set. */
423                 return FALSE;
424         }
425         ep_ev->data = ep_fd->ep_event.data;
426         ep_ev->events = taps_to_ep_events(msg->ev_arg2);
427         return TRUE;
428 }
429
430 /* We should be able to have multiple waiters.  ep shouldn't be closed or
431  * anything, since we have the FD (that'd be bad programming on the user's
432  * behalf).  We could have concurrent ADD/MOD/DEL operations (which lock). */
433 static int __epoll_wait(struct epoll_ctlr *ep, struct epoll_event *events,
434                         int maxevents, int timeout)
435 {
436         struct event_msg msg = {0};
437         struct event_msg dummy_msg;
438         struct event_queue *which_evq;
439         struct event_queue *alarm_evq;
440         int nr_ret = 0;
441         int recurse_ret;
442         struct syscall sysc;
443
444         /* Locking to protect get_ep_event_from_msg, specifically that the ep_fd
445          * stored at ceq_ev->user_data does not get concurrently removed and
446          * freed. */
447         spin_pdr_lock(&ep->lock);
448         for (int i = 0; i < maxevents; i++) {
449                 if (uth_check_evqs(&msg, &which_evq, 1, ep->ceq_evq)) {
450                         if (get_ep_event_from_msg(ep, &msg, &events[i]))
451                                 nr_ret++;
452                 }
453         }
454         spin_pdr_unlock(&ep->lock);
455         if (nr_ret)
456                 return nr_ret;
457         if (timeout == 0)
458                 return 0;
459         if (timeout != -1) {
460                 alarm_evq = ep_get_alarm_evq();
461                 syscall_async(&sysc, SYS_block, timeout * 1000);
462                 if (!register_evq(&sysc, alarm_evq)) {
463                         /* timeout occurred before we could even block! */
464                         ep_put_alarm_evq(alarm_evq);
465                         return 0;
466                 }
467                 uth_blockon_evqs(&msg, &which_evq, 2, ep->ceq_evq, alarm_evq);
468                 if (which_evq != alarm_evq) {
469                         /* sysc may or may not have finished yet.  this will force it to
470                          * *start* to finish iff it is still a submitted syscall. */
471                         sys_abort_sysc(&sysc);
472                         /* But we still need to wait until the syscall completed.  Need a
473                          * dummy msg, since we don't want to clobber the real msg. */
474                         uth_blockon_evqs(&dummy_msg, 0, 1, alarm_evq);
475                 }
476                 /* TODO: Slightly dangerous, due to spammed INDIRs */
477                 ep_put_alarm_evq(alarm_evq);
478                 if (which_evq == alarm_evq)
479                         return 0;
480         } else {
481                 uth_blockon_evqs(&msg, &which_evq, 1, ep->ceq_evq);
482         }
483         spin_pdr_lock(&ep->lock);
484         if (get_ep_event_from_msg(ep, &msg, &events[0]))
485                 nr_ret++;
486         spin_pdr_unlock(&ep->lock);
487         /* We might not have gotten one yet.  And regardless, there might be more
488          * available.  Let's try again, with timeout == 0 to ensure no blocking.  We
489          * use nr_ret (0 or 1 now) to adjust maxevents and events accordingly. */
490         recurse_ret = __epoll_wait(ep, events + nr_ret, maxevents - nr_ret, 0);
491         if (recurse_ret > 0)
492                 nr_ret += recurse_ret;
493         return nr_ret;
494 }
495
496 int epoll_wait(int epfd, struct epoll_event *events, int maxevents,
497                int timeout)
498 {
499         struct epoll_ctlr *ep = fd_to_cltr(epfd);
500         int ret;
501         if (!ep) {
502                 errno = EBADF;/* or EINVAL */
503                 return -1;
504         }
505         if (maxevents <= 0) {
506                 errno = EINVAL;
507                 return -1;
508         }
509         ret = __epoll_wait(ep, events, maxevents, timeout);
510         return ret;
511 }
512
513 int epoll_pwait(int epfd, struct epoll_event *events, int maxevents,
514                 int timeout, const sigset_t *sigmask)
515 {
516         int ready;
517         sigset_t origmask;
518         /* TODO: this is probably racy */
519         sigprocmask(SIG_SETMASK, sigmask, &origmask);
520         ready = epoll_wait(epfd, events, maxevents, timeout);
521         sigprocmask(SIG_SETMASK, &origmask, NULL);
522         return ready;
523 }