epoll: Give every waiter their own event queue
[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  *      - closing the epoll is a little dangerous, if there are outstanding INDIR
15  *      events.  this will only pop up if you're yielding cores, maybe getting
16  *      preempted, and are unlucky.
17  *      - epoll_create1 does not support CLOEXEC.  That'd need some work in glibc's
18  *      exec and flags in struct user_fd.
19  *      - EPOLL_CTL_MOD is just a DEL then an ADD.  There might be races associated
20  *      with that.
21  *      - epoll_pwait is probably racy.
22  *      - You can't dup an epoll fd (same as other user FDs).
23  *      - If you add a BSD socket FD to an epoll set, you'll get taps on both the
24  *      data FD and the listen FD.
25  *      - If you add the same BSD socket listener to multiple epoll sets, you will
26  *      likely fail.  This is in addition to being able to tap only one FD at a
27  *      time.
28  * */
29
30 #include <sys/epoll.h>
31 #include <parlib/parlib.h>
32 #include <parlib/event.h>
33 #include <parlib/ceq.h>
34 #include <parlib/uthread.h>
35 #include <parlib/timing.h>
36 #include <parlib/slab.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 #include <sys/plan9_helpers.h>
45 #include <ros/fs.h>
46
47 /* Sanity check, so we can ID our own FDs */
48 #define EPOLL_UFD_MAGIC                 0xe9011
49
50 /* Each waiter that uses a timeout will have its own structure for dealing with
51  * its timeout.
52  *
53  * TODO: (RCU/SLAB) it's not safe to reap the objects, until we sort out
54  * INDIRs and RCU-style grace periods.  Not a big deal, since the number of
55  * these is the number of threads that concurrently do epoll timeouts. */
56 struct ep_alarm {
57         struct event_queue                      *alarm_evq;
58         struct syscall                          sysc;
59 };
60
61 static struct kmem_cache *ep_alarms_cache;
62
63 struct epoll_ctlr {
64         TAILQ_ENTRY(epoll_ctlr)         link;
65         struct event_queue                      *ceq_evq;
66         uth_mutex_t                                     mtx;
67         struct user_fd                          ufd;
68 };
69
70 TAILQ_HEAD(epoll_ctlrs, epoll_ctlr);
71 static struct epoll_ctlrs all_ctlrs = TAILQ_HEAD_INITIALIZER(all_ctlrs);
72 static uth_mutex_t ctlrs_mtx;
73
74 /* There's some bookkeeping we need to maintain on every FD.  Right now, the FD
75  * is the index into the CEQ event array, so we can just hook this into the user
76  * data blob in the ceq_event.
77  *
78  * If we ever do not maintain a 1:1 mapping from FDs to CEQ IDs, we can use this
79  * to track the CEQ ID and FD. */
80 struct ep_fd_data {
81         struct epoll_event                      ep_event;
82         int                                                     fd;
83         int                                                     filter;
84 };
85
86 /* Converts epoll events to FD taps. */
87 static int ep_events_to_taps(uint32_t ep_ev)
88 {
89         int taps = 0;
90         if (ep_ev & EPOLLIN)
91                 taps |= FDTAP_FILT_READABLE;
92         if (ep_ev & EPOLLOUT)
93                 taps |= FDTAP_FILT_WRITABLE;
94         if (ep_ev & EPOLLRDHUP)
95                 taps |= FDTAP_FILT_RDHUP;
96         if (ep_ev & EPOLLPRI)
97                 taps |= FDTAP_FILT_PRIORITY;
98         if (ep_ev & EPOLLERR)
99                 taps |= FDTAP_FILT_ERROR;
100         if (ep_ev & EPOLLHUP)
101                 taps |= FDTAP_FILT_HANGUP;
102         return taps;
103 }
104
105 /* Converts corresponding FD Taps to epoll events.  There are other taps that do
106  * not make sense for epoll. */
107 static uint32_t taps_to_ep_events(int taps)
108 {
109         uint32_t ep_ev = 0;
110         if (taps & FDTAP_FILT_READABLE)
111                 ep_ev |= EPOLLIN;
112         if (taps & FDTAP_FILT_WRITABLE)
113                 ep_ev |= EPOLLOUT;
114         if (taps & FDTAP_FILT_RDHUP)
115                 ep_ev |= EPOLLRDHUP;
116         if (taps & FDTAP_FILT_PRIORITY)
117                 ep_ev |= EPOLLPRI;
118         if (taps & FDTAP_FILT_ERROR)
119                 ep_ev |= EPOLLERR;
120         if (taps & FDTAP_FILT_HANGUP)
121                 ep_ev |= EPOLLHUP;
122         return ep_ev;
123 }
124
125 static unsigned int ep_get_ceq_max_ever(struct epoll_ctlr *ep)
126 {
127         return atomic_read(&ep->ceq_evq->ev_mbox->ceq.max_event_ever);
128 }
129
130 static struct ceq_event *ep_get_ceq_ev(struct epoll_ctlr *ep, size_t idx)
131 {
132         if (ep->ceq_evq->ev_mbox->ceq.nr_events <= idx)
133                 return 0;
134         return &ep->ceq_evq->ev_mbox->ceq.events[idx];
135 }
136
137 static struct epoll_ctlr *fd_to_cltr(int fd)
138 {
139         struct user_fd *ufd = ufd_lookup(fd);
140         if (!ufd)
141                 return 0;
142         if (ufd->magic != EPOLL_UFD_MAGIC) {
143                 errno = EBADF;
144                 return 0;
145         }
146         return container_of(ufd, struct epoll_ctlr, ufd);
147 }
148
149 /* Event queue helpers: */
150 static struct event_queue *ep_get_ceq_evq(unsigned int ceq_ring_sz)
151 {
152         struct event_queue *ceq_evq = get_eventq_raw();
153         ceq_evq->ev_mbox->type = EV_MBOX_CEQ;
154         ceq_init(&ceq_evq->ev_mbox->ceq, CEQ_OR, NR_FILE_DESC_MAX, ceq_ring_sz);
155         ceq_evq->ev_flags = EVENT_INDIR | EVENT_SPAM_INDIR | EVENT_WAKEUP;
156         evq_attach_wakeup_ctlr(ceq_evq);
157         return ceq_evq;
158 }
159
160 static struct event_queue *ep_get_alarm_evq(void)
161 {
162         /* Don't care about the actual message, just using it for a wakeup */
163         struct event_queue *alarm_evq = get_eventq(EV_MBOX_BITMAP);
164         alarm_evq->ev_flags = EVENT_INDIR | EVENT_SPAM_INDIR | EVENT_WAKEUP;
165         evq_attach_wakeup_ctlr(alarm_evq);
166         return alarm_evq;
167 }
168
169 /* Once we've closed our sources of events, we can try to clean up the event
170  * queues.  These are actually dangerous, since there could be INDIRs floating
171  * around for these evqs still, which are basically pointers.  We'll need to run
172  * some sort of user deferred destruction. (TODO). */
173 static void ep_put_ceq_evq(struct event_queue *ceq_evq)
174 {
175 #if 0 /* TODO: EVQ/INDIR Cleanup */
176         ceq_cleanup(&ceq_evq->ev_mbox->ceq);
177         evq_remove_wakeup_ctlr(ceq_evq);
178         put_eventq_raw(ceq_evq);
179 #endif
180 }
181
182 static void ep_put_alarm_evq(struct event_queue *alarm_evq)
183 {
184 #if 0 /* TODO: EVQ/INDIR Cleanup */
185         evq_remove_wakeup_ctlr(alarm_evq);
186         put_eventq(alarm_evq);
187 #endif
188 }
189
190 static void epoll_close(struct user_fd *ufd)
191 {
192         struct epoll_ctlr *ep = container_of(ufd, struct epoll_ctlr, ufd);
193         struct fd_tap_req *tap_reqs, *tap_req_i;
194         struct ceq_event *ceq_ev_i;
195         struct ep_fd_data *ep_fd_i;
196         int nr_tap_req = 0;
197         int nr_done = 0;
198         unsigned int max_ceq_events = ep_get_ceq_max_ever(ep);
199
200         tap_reqs = malloc(sizeof(struct fd_tap_req) * max_ceq_events);
201         memset(tap_reqs, 0, sizeof(struct fd_tap_req) * max_ceq_events);
202         /* Slightly painful, O(n) with no escape hatch */
203         for (int i = 0; i < max_ceq_events; i++) {
204                 ceq_ev_i = ep_get_ceq_ev(ep, i);
205                 /* CEQ should have been big enough for our size */
206                 assert(ceq_ev_i);
207                 ep_fd_i = (struct ep_fd_data*)ceq_ev_i->user_data;
208                 if (!ep_fd_i)
209                         continue;
210                 tap_req_i = &tap_reqs[nr_tap_req++];
211                 tap_req_i->fd = i;
212                 tap_req_i->cmd = FDTAP_CMD_REM;
213                 free(ep_fd_i);
214         }
215         /* Requests could fail if the tapped files are already closed.  We need to
216          * skip the failed one (the +1) and untap the rest. */
217         do {
218                 nr_done += sys_tap_fds(tap_reqs + nr_done, nr_tap_req - nr_done);
219                 nr_done += 1;   /* nr_done could be more than nr_tap_req now */
220         } while (nr_done < nr_tap_req);
221         free(tap_reqs);
222         ep_put_ceq_evq(ep->ceq_evq);
223         uth_mutex_lock(ctlrs_mtx);
224         TAILQ_REMOVE(&all_ctlrs, ep, link);
225         uth_mutex_unlock(ctlrs_mtx);
226         uth_mutex_free(ep->mtx);
227         free(ep);
228 }
229
230 static int init_ep_ctlr(struct epoll_ctlr *ep, int size)
231 {
232         if (size == 1)
233                 size = 128;
234         ep->mtx = uth_mutex_alloc();
235         ep->ufd.magic = EPOLL_UFD_MAGIC;
236         ep->ufd.close = epoll_close;
237         /* Size is a hint for the CEQ concurrency.  We can actually handle as many
238          * kernel FDs as is possible. */
239         ep->ceq_evq = ep_get_ceq_evq(ROUNDUPPWR2(size));
240         return 0;
241 }
242
243 static void epoll_fd_closed(int fd)
244 {
245         struct epoll_ctlr *ep;
246
247         /* Lockless peek, avoid locking for every close() */
248         if (TAILQ_EMPTY(&all_ctlrs))
249                 return;
250         uth_mutex_lock(ctlrs_mtx);
251         TAILQ_FOREACH(ep, &all_ctlrs, link)
252                 epoll_ctl(ep->ufd.fd, EPOLL_CTL_DEL, fd, 0);
253         uth_mutex_unlock(ctlrs_mtx);
254 }
255
256 static void ep_alarm_ctor(void *obj, size_t unused)
257 {
258         struct ep_alarm *ep_a = (struct ep_alarm*)obj;
259
260         ep_a->alarm_evq = ep_get_alarm_evq();
261 }
262
263 static void ep_alarm_dtor(void *obj, size_t unused)
264 {
265         struct ep_alarm *ep_a = (struct ep_alarm*)obj;
266
267         /* TODO: (RCU/SLAB).  Somehow the slab allocator is trying to reap our
268          * objects.  Note that when we update userspace to use magazines, the dtor
269          * will fire earlier (when the object is given to the slab layer).  We'll
270          * need to be careful about the final freeing of the ev_q. */
271         panic("Epoll alarms should never be destroyed!");
272         ep_put_alarm_evq(ep_a->alarm_evq);
273 }
274
275 static void epoll_init(void)
276 {
277         static struct close_cb epoll_close_cb = {.func = epoll_fd_closed};
278
279         register_close_cb(&epoll_close_cb);
280         ctlrs_mtx = uth_mutex_alloc();
281         ep_alarms_cache = kmem_cache_create("epoll alarms",
282                                             sizeof(struct ep_alarm),
283                                             __alignof__(sizeof(struct ep_alarm)), 0,
284                                             ep_alarm_ctor, ep_alarm_dtor);
285         assert(ep_alarms_cache);
286 }
287
288 int epoll_create(int size)
289 {
290         int fd;
291         struct epoll_ctlr *ep;
292
293         run_once(epoll_init());
294         /* good thing the arg is a signed int... */
295         if (size < 0) {
296                 errno = EINVAL;
297                 return -1;
298         }
299         ep = malloc(sizeof(struct epoll_ctlr));
300         memset(ep, 0, sizeof(struct epoll_ctlr));
301         if (init_ep_ctlr(ep, size)) {
302                 free(ep);
303                 return -1;
304         }
305         fd = ufd_get_fd(&ep->ufd);
306         if (fd < 0)
307                 free(ep);
308         uth_mutex_lock(ctlrs_mtx);
309         TAILQ_INSERT_TAIL(&all_ctlrs, ep, link);
310         uth_mutex_unlock(ctlrs_mtx);
311         return fd;
312 }
313
314 int epoll_create1(int flags)
315 {
316         /* TODO: we're supposed to support CLOEXEC.  Our FD is a user_fd, so that'd
317          * require some support in glibc's exec to close our epoll ctlr. */
318         return epoll_create(1);
319 }
320
321 /* Linux's epoll will check for events, even if edge-triggered, during
322  * additions (and probably modifications) to the epoll set.  It's a questionable
323  * policy, since it can hide user bugs.
324  *
325  * We can do the same, though only for EPOLLIN and EPOLLOUT for FDs that can
326  * report their status via stat.  (same as select()).
327  *
328  * Note that this could result in spurious events, which should be fine. */
329 static void fire_existing_events(int fd, int ep_events,
330                                  struct event_queue *ev_q)
331 {
332         struct stat stat_buf[1];
333         struct event_msg ev_msg[1];
334         int ret;
335         int synth_ep_events = 0;
336
337         ret = fstat(fd, stat_buf);
338         assert(!ret);
339         if ((ep_events & EPOLLIN) && S_READABLE(stat_buf->st_mode))
340                 synth_ep_events |= EPOLLIN;
341         if ((ep_events & EPOLLOUT) && S_WRITABLE(stat_buf->st_mode))
342                 synth_ep_events |= EPOLLOUT;
343         if (synth_ep_events) {
344                 ev_msg->ev_type = fd;
345                 ev_msg->ev_arg2 = ep_events_to_taps(synth_ep_events);
346                 ev_msg->ev_arg3 = 0; /* tap->data is unused for epoll. */
347                 sys_send_event(ev_q, ev_msg, vcore_id());
348         }
349 }
350
351 static int __epoll_ctl_add(struct epoll_ctlr *ep, int fd,
352                            struct epoll_event *event)
353 {
354         struct ceq_event *ceq_ev;
355         struct ep_fd_data *ep_fd;
356         struct fd_tap_req tap_req = {0};
357         int ret, filter, sock_listen_fd;
358         struct epoll_event listen_event;
359
360         /* Only support ET.  Also, we just ignore EPOLLONESHOT.  That might work,
361          * logically, just with spurious events firing. */
362         if (!(event->events & EPOLLET)) {
363                 errno = EPERM;
364                 werrstr("Epoll level-triggered not supported");
365                 return -1;
366         }
367         /* The sockets-to-plan9 networking shims are a bit inconvenient.  The user
368          * asked us to epoll on an FD, but that FD is actually a Qdata FD.  We might
369          * need to actually epoll on the listen_fd.  Further, we don't know yet
370          * whether or not they want the listen FD.  They could epoll on the socket,
371          * then listen later and want to wake up on the listen.
372          *
373          * So in the case we have a socket FD, we'll actually open the listen FD
374          * regardless (glibc handles this), and we'll epoll on both FDs.
375          * Technically, either FD could fire and they'd get an epoll event for it,
376          * but I think socket users will use only listen or data.
377          *
378          * As far as tracking the FD goes for epoll_wait() reporting, if the app
379          * wants to track the FD they think we are using, then they already passed
380          * that in event->data. */
381         sock_listen_fd = _sock_lookup_listen_fd(fd);
382         if (sock_listen_fd >= 0) {
383                 listen_event.events = EPOLLET | EPOLLIN | EPOLLHUP;
384                 listen_event.data = event->data;
385                 ret = __epoll_ctl_add(ep, sock_listen_fd, &listen_event);
386                 if (ret < 0)
387                         return ret;
388         }
389         ceq_ev = ep_get_ceq_ev(ep, fd);
390         if (!ceq_ev) {
391                 errno = ENOMEM;
392                 werrstr("Epoll set cannot grow yet!");
393                 return -1;
394         }
395         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
396         if (ep_fd) {
397                 errno = EEXIST;
398                 return -1;
399         }
400         tap_req.fd = fd;
401         tap_req.cmd = FDTAP_CMD_ADD;
402         /* EPOLLHUP is implicitly set for all epolls. */
403         filter = ep_events_to_taps(event->events | EPOLLHUP);
404         tap_req.filter = filter;
405         tap_req.ev_q = ep->ceq_evq;
406         tap_req.ev_id = fd;     /* using FD as the CEQ ID */
407         ret = sys_tap_fds(&tap_req, 1);
408         if (ret != 1)
409                 return -1;
410         ep_fd = malloc(sizeof(struct ep_fd_data));
411         ep_fd->fd = fd;
412         ep_fd->filter = filter;
413         ep_fd->ep_event = *event;
414         ep_fd->ep_event.events |= EPOLLHUP;
415         ceq_ev->user_data = (uint64_t)ep_fd;
416         fire_existing_events(fd, ep_fd->ep_event.events, ep->ceq_evq);
417         return 0;
418 }
419
420 static int __epoll_ctl_del(struct epoll_ctlr *ep, int fd,
421                            struct epoll_event *event)
422 {
423         struct ceq_event *ceq_ev;
424         struct ep_fd_data *ep_fd;
425         struct fd_tap_req tap_req = {0};
426         int ret, sock_listen_fd;
427
428         /* If we were dealing with a socket shim FD, we tapped both the listen and
429          * the data file and need to untap both of them. */
430         sock_listen_fd = _sock_lookup_listen_fd(fd);
431         if (sock_listen_fd >= 0) {
432                 /* It's possible to fail here.  Even though we tapped it already, if the
433                  * deletion was triggered from close callbacks, it's possible for the
434                  * sock_listen_fd to be closed first, which would have triggered an
435                  * epoll_ctl_del.  When we get around to closing the Rock FD, the listen
436                  * FD was already closed. */
437                 __epoll_ctl_del(ep, sock_listen_fd, event);
438         }
439         ceq_ev = ep_get_ceq_ev(ep, fd);
440         if (!ceq_ev) {
441                 errno = ENOENT;
442                 return -1;
443         }
444         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
445         if (!ep_fd) {
446                 errno = ENOENT;
447                 return -1;
448         }
449         assert(ep_fd->fd == fd);
450         tap_req.fd = fd;
451         tap_req.cmd = FDTAP_CMD_REM;
452         /* ignoring the return value; we could have failed to remove it if the FD
453          * has already closed and the kernel removed the tap. */
454         sys_tap_fds(&tap_req, 1);
455         ceq_ev->user_data = 0;
456         free(ep_fd);
457         return 0;
458 }
459
460 int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event)
461 {
462         int ret;
463         struct epoll_ctlr *ep = fd_to_cltr(epfd);
464         if (!ep) {
465                 errno = EBADF;/* or EINVAL */
466                 return -1;
467         }
468         if (fd >= USER_FD_BASE) {
469                 errno = EINVAL;
470                 werrstr("Epoll can't track User FDs");
471                 return -1;
472         }
473         uth_mutex_lock(ep->mtx);
474         switch (op) {
475                 case (EPOLL_CTL_MOD):
476                         /* In lieu of a proper MOD, just remove and readd.  The errors might
477                          * not work out well, and there could be a missed event in the
478                          * middle.  Not sure what the guarantees are, but we can fake a
479                          * poke. (TODO). */
480                         ret = __epoll_ctl_del(ep, fd, 0);
481                         if (ret)
482                                 break;
483                         ret = __epoll_ctl_add(ep, fd, event);
484                         break;
485                 case (EPOLL_CTL_ADD):
486                         ret = __epoll_ctl_add(ep, fd, event);
487                         break;
488                 case (EPOLL_CTL_DEL):
489                         ret = __epoll_ctl_del(ep, fd, event);
490                         break;
491                 default:
492                         errno = EINVAL;
493                         ret = -1;
494         }
495         uth_mutex_unlock(ep->mtx);
496         return ret;
497 }
498
499 static bool get_ep_event_from_msg(struct epoll_ctlr *ep, struct event_msg *msg,
500                                   struct epoll_event *ep_ev)
501 {
502         struct ceq_event *ceq_ev;
503         struct ep_fd_data *ep_fd;
504
505         ceq_ev = ep_get_ceq_ev(ep, msg->ev_type);
506         /* should never get a tap FD > size of the epoll set */
507         assert(ceq_ev);
508         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
509         if (!ep_fd) {
510                 /* it's possible the FD was unregistered and this was an old
511                  * event sent to this epoll set. */
512                 return FALSE;
513         }
514         ep_ev->data = ep_fd->ep_event.data;
515         /* The events field was initialized to 0 in epoll_wait() */
516         ep_ev->events |= taps_to_ep_events(msg->ev_arg2);
517         return TRUE;
518 }
519
520 /* Helper: extracts as many epoll_events as possible from the ep. */
521 static int __epoll_wait_poll(struct epoll_ctlr *ep, struct epoll_event *events,
522                              int maxevents)
523 {
524         struct event_msg msg = {0};
525         int nr_ret = 0;
526
527         if (maxevents <= 0)
528                 return 0;
529         /* Locking to protect get_ep_event_from_msg, specifically that the ep_fd
530          * stored at ceq_ev->user_data does not get concurrently removed and
531          * freed. */
532         uth_mutex_lock(ep->mtx);
533         for (int i = 0; i < maxevents; i++) {
534 retry:
535                 if (!uth_check_evqs(&msg, NULL, 1, ep->ceq_evq))
536                         break;
537                 if (!get_ep_event_from_msg(ep, &msg, &events[i]))
538                         goto retry;
539                 nr_ret++;
540         }
541         uth_mutex_unlock(ep->mtx);
542         return nr_ret;
543 }
544
545 /* We should be able to have multiple waiters.  ep shouldn't be closed or
546  * anything, since we have the FD (that'd be bad programming on the user's
547  * behalf).  We could have concurrent ADD/MOD/DEL operations (which lock). */
548 static int __epoll_wait(struct epoll_ctlr *ep, struct epoll_event *events,
549                         int maxevents, int timeout)
550 {
551         struct event_msg msg = {0};
552         struct event_msg dummy_msg;
553         struct event_queue *which_evq;
554         struct ep_alarm *ep_a;
555         int nr_ret;
556
557         nr_ret = __epoll_wait_poll(ep, events, maxevents);
558         if (nr_ret)
559                 return nr_ret;
560         if (timeout == 0)
561                 return 0;
562         /* From here on down, we're going to block until there is some activity */
563         if (timeout != -1) {
564                 ep_a = kmem_cache_alloc(ep_alarms_cache, 0);
565                 assert(ep_a);
566                 syscall_async_evq(&ep_a->sysc, ep_a->alarm_evq, SYS_block,
567                                   timeout * 1000);
568                 uth_blockon_evqs(&msg, &which_evq, 2, ep->ceq_evq, ep_a->alarm_evq);
569                 if (which_evq == ep_a->alarm_evq) {
570                         kmem_cache_free(ep_alarms_cache, ep_a);
571                         return 0;
572                 }
573                 /* The alarm sysc may or may not have finished yet.  This will force it
574                  * to *start* to finish iff it is still a submitted syscall. */
575                 sys_abort_sysc(&ep_a->sysc);
576                 /* But we still need to wait until the syscall completed.  Need a
577                  * dummy msg, since we don't want to clobber the real msg. */
578                 uth_blockon_evqs(&dummy_msg, 0, 1, ep_a->alarm_evq);
579                 kmem_cache_free(ep_alarms_cache, ep_a);
580         } else {
581                 uth_blockon_evqs(&msg, &which_evq, 1, ep->ceq_evq);
582         }
583         uth_mutex_lock(ep->mtx);
584         if (get_ep_event_from_msg(ep, &msg, &events[0]))
585                 nr_ret = 1;
586         uth_mutex_unlock(ep->mtx);
587         /* We had to extract one message already as part of the blocking process.
588          * We might be able to get more. */
589         nr_ret += __epoll_wait_poll(ep, events + nr_ret, maxevents - nr_ret);
590         /* This is a little nasty and hopefully a rare race.  We still might not
591          * have a ret, but we expected to block until we had something.  We didn't
592          * time out yet, but we spuriously woke up.  We need to try again (ideally,
593          * we'd subtract the time left from the original timeout). */
594         if (!nr_ret)
595                 return __epoll_wait(ep, events, maxevents, timeout);
596         return nr_ret;
597 }
598
599 int epoll_wait(int epfd, struct epoll_event *events, int maxevents,
600                int timeout)
601 {
602         struct epoll_ctlr *ep = fd_to_cltr(epfd);
603
604         if (!ep) {
605                 errno = EBADF;/* or EINVAL */
606                 return -1;
607         }
608         if (maxevents <= 0) {
609                 errno = EINVAL;
610                 return -1;
611         }
612         for (int i = 0; i < maxevents; i++)
613                 events[i].events = 0;
614         return __epoll_wait(ep, events, maxevents, timeout);
615 }
616
617 int epoll_pwait(int epfd, struct epoll_event *events, int maxevents,
618                 int timeout, const sigset_t *sigmask)
619 {
620         int ready;
621         sigset_t origmask;
622         /* TODO: this is probably racy */
623         sigprocmask(SIG_SETMASK, sigmask, &origmask);
624         ready = epoll_wait(epfd, events, maxevents, timeout);
625         sigprocmask(SIG_SETMASK, &origmask, NULL);
626         return ready;
627 }