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