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