Remove dependency for {unistd,stdlib}.h in vcore.h (XCC)
[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         ceq_cleanup(&ceq_evq->ev_mbox->ceq);
162         evq_remove_wakeup_ctlr(ceq_evq);
163         put_eventq_raw(ceq_evq);
164 }
165
166 static void ep_put_alarm_evq(struct event_queue *alarm_evq)
167 {
168         evq_remove_wakeup_ctlr(alarm_evq);
169         put_eventq(alarm_evq);
170 }
171
172 static void epoll_close(struct user_fd *ufd)
173 {
174         struct epoll_ctlr *ep = container_of(ufd, struct epoll_ctlr, ufd);
175         struct fd_tap_req *tap_reqs, *tap_req_i;
176         struct ceq_event *ceq_ev_i;
177         struct ep_fd_data *ep_fd_i;
178         int nr_tap_req = 0;
179         int nr_done = 0;
180
181         tap_reqs = malloc(sizeof(struct fd_tap_req) * ep->size);
182         memset(tap_reqs, 0, sizeof(struct fd_tap_req) * ep->size);
183         /* Slightly painful, O(n) with no escape hatch */
184         for (int i = 0; i < ep->size; i++) {
185                 ceq_ev_i = ep_get_ceq_ev(ep, i);
186                 /* CEQ should have been big enough for our size */
187                 assert(ceq_ev_i);
188                 ep_fd_i = (struct ep_fd_data*)ceq_ev_i->user_data;
189                 if (!ep_fd_i)
190                         continue;
191                 if (ep_fd_i->sock_listen_fd >= 0) {
192                         /* This tap is using a listen_fd, opened by __epoll_ctl_add, so the
193                          * user doesn't know about this FD.  We need to remove the tap and
194                          * close the FD; the kernel will remove the tap when we close it. */
195                         close(ep_fd_i->sock_listen_fd);
196                         free(ep_fd_i);
197                         continue;
198                 }
199                 tap_req_i = &tap_reqs[nr_tap_req++];
200                 tap_req_i->fd = i;
201                 tap_req_i->cmd = FDTAP_CMD_REM;
202                 free(ep_fd_i);
203         }
204         /* Requests could fail if the tapped files are already closed.  We need to
205          * skip the failed one (the +1) and untap the rest. */
206         do {
207                 nr_done += sys_tap_fds(tap_reqs + nr_done, nr_tap_req - nr_done);
208                 nr_done += 1;   /* nr_done could be more than nr_tap_req now */
209         } while (nr_done < nr_tap_req);
210         free(tap_reqs);
211         ep_put_ceq_evq(ep->ceq_evq);
212 }
213
214 static int init_ep_ctlr(struct epoll_ctlr *ep, int size)
215 {
216         unsigned int ceq_size = ROUNDUPPWR2(size);
217         /* TODO: we don't grow yet.  Until then, we help out a little. */
218         if (size == 1)
219                 size = 128;
220         ep->size = ceq_size;
221         spin_pdr_init(&ep->lock);
222         ep->ufd.magic = EPOLL_UFD_MAGIC;
223         ep->ufd.close = epoll_close;
224         ep->ceq_evq = ep_get_ceq_evq(ceq_size);
225         return 0;
226 }
227
228 int epoll_create(int size)
229 {
230         int fd;
231         struct epoll_ctlr *ep;
232         /* good thing the arg is a signed int... */
233         if (size < 0) {
234                 errno = EINVAL;
235                 return -1;
236         }
237         ep = malloc(sizeof(struct epoll_ctlr));
238         memset(ep, 0, sizeof(struct epoll_ctlr));
239         if (init_ep_ctlr(ep, size)) {
240                 free(ep);
241                 return -1;
242         }
243         fd = ufd_get_fd(&ep->ufd);
244         if (fd < 0)
245                 free(ep);
246         return fd;
247 }
248
249 int epoll_create1(int flags)
250 {
251         /* TODO: we're supposed to support CLOEXEC.  Our FD is a user_fd, so that'd
252          * require some support in glibc's exec to close our epoll ctlr. */
253         return epoll_create(1);
254 }
255
256 static int __epoll_ctl_add(struct epoll_ctlr *ep, int fd,
257                            struct epoll_event *event)
258 {
259         struct ceq_event *ceq_ev;
260         struct ep_fd_data *ep_fd;
261         struct fd_tap_req tap_req = {0};
262         int ret, filter, sock_listen_fd;
263
264         /* Only support ET.  Also, we just ignore EPOLLONESHOT.  That might work,
265          * logically, just with spurious events firing. */
266         if (!(event->events & EPOLLET)) {
267                 errno = EPERM;
268                 werrstr("Epoll level-triggered not supported");
269                 return -1;
270         }
271         /* The sockets-to-plan9 networking shims are a bit inconvenient.  The user
272          * asked us to epoll on an FD, but that FD is actually a Qdata FD.  We need
273          * to actually epoll on the listen_fd.  We'll store this in the ep_fd, so
274          * that later on we can close it.
275          *
276          * As far as tracking the FD goes for epoll_wait() reporting, if the app
277          * wants to track the FD they think we are using, then they already passed
278          * that in event->data.
279          *
280          * But before we get too far, we need to make sure we aren't already tapping
281          * this FD's listener (hence the lookup).
282          *
283          * This all assumes that this socket is only added to one epoll set at a
284          * time.  The _sock calls are racy, and once one epoller set up a listen_fd
285          * in the Rock, we'll think that it was us. */
286         extern int _sock_lookup_listen_fd(int sock_fd); /* in glibc */
287         extern int _sock_get_listen_fd(int sock_fd);
288         if (_sock_lookup_listen_fd(fd) >= 0) {
289                 errno = EEXIST;
290                 return -1;
291         }
292         sock_listen_fd = _sock_get_listen_fd(fd);
293         if (sock_listen_fd >= 0)
294                 fd = sock_listen_fd;
295         ceq_ev = ep_get_ceq_ev(ep, fd);
296         if (!ceq_ev) {
297                 errno = ENOMEM;
298                 werrstr("Epoll set cannot grow yet!");
299                 return -1;
300         }
301         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
302         if (ep_fd) {
303                 errno = EEXIST;
304                 return -1;
305         }
306         tap_req.fd = fd;
307         tap_req.cmd = FDTAP_CMD_ADD;
308         /* EPOLLHUP is implicitly set for all epolls. */
309         filter = ep_events_to_taps(event->events | EPOLLHUP);
310         tap_req.filter = filter;
311         tap_req.ev_q = ep->ceq_evq;
312         tap_req.ev_id = fd;     /* using FD as the CEQ ID */
313         ret = sys_tap_fds(&tap_req, 1);
314         if (ret != 1)
315                 return -1;
316         ep_fd = malloc(sizeof(struct ep_fd_data));
317         ep_fd->fd = fd;
318         ep_fd->filter = filter;
319         ep_fd->ep_event = *event;
320         ep_fd->ep_event.events |= EPOLLHUP;
321         ep_fd->sock_listen_fd = sock_listen_fd;
322         ceq_ev->user_data = (uint64_t)ep_fd;
323         return 0;
324 }
325
326 static int __epoll_ctl_del(struct epoll_ctlr *ep, int fd,
327                            struct epoll_event *event)
328 {
329         struct ceq_event *ceq_ev;
330         struct ep_fd_data *ep_fd;
331         struct fd_tap_req tap_req = {0};
332         int ret, sock_listen_fd;
333
334         /* They could be asking to clear an epoll for a listener.  We need to remove
335          * the tap for the real FD we tapped */
336         extern int _sock_lookup_listen_fd(int sock_fd); /* in glibc */
337         sock_listen_fd = _sock_lookup_listen_fd(fd);
338         if (sock_listen_fd >= 0)
339                 fd = sock_listen_fd;
340         ceq_ev = ep_get_ceq_ev(ep, fd);
341         if (!ceq_ev) {
342                 errno = ENOENT;
343                 return -1;
344         }
345         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
346         if (!ep_fd) {
347                 errno = ENOENT;
348                 return -1;
349         }
350         assert(ep_fd->fd == fd);
351         tap_req.fd = fd;
352         tap_req.cmd = FDTAP_CMD_REM;
353         /* ignoring the return value; we could have failed to remove it if the FD
354          * has already closed and the kernel removed the tap. */
355         sys_tap_fds(&tap_req, 1);
356         ceq_ev->user_data = 0;
357         assert(ep_fd->sock_listen_fd == sock_listen_fd);
358         if (ep_fd->sock_listen_fd >= 0) {
359                 assert(ep_fd->sock_listen_fd == sock_listen_fd);
360                 close(ep_fd->sock_listen_fd);
361         }
362         free(ep_fd);
363         return 0;
364 }
365
366 int epoll_ctl(int epfd, int op, int fd, struct epoll_event *event)
367 {
368         int ret;
369         struct epoll_ctlr *ep = fd_to_cltr(epfd);
370         if (!ep) {
371                 errno = EBADF;/* or EINVAL */
372                 return -1;
373         }
374         if (fd >= USER_FD_BASE) {
375                 errno = EINVAL;
376                 werrstr("Epoll can't track User FDs");
377                 return -1;
378         }
379         /* TODO: don't use a spinlock, use a mutex.  sys_tap_fds can block. */
380         spin_pdr_lock(&ep->lock);
381         switch (op) {
382                 case (EPOLL_CTL_MOD):
383                         /* In lieu of a proper MOD, just remove and readd.  The errors might
384                          * not work out well, and there could be a missed event in the
385                          * middle.  Not sure what the guarantees are, but we can fake a
386                          * poke. (TODO). */
387                         ret = __epoll_ctl_del(ep, fd, 0);
388                         if (ret)
389                                 break;
390                         ret = __epoll_ctl_add(ep, fd, event);
391                         break;
392                 case (EPOLL_CTL_ADD):
393                         ret = __epoll_ctl_add(ep, fd, event);
394                         break;
395                 case (EPOLL_CTL_DEL):
396                         ret = __epoll_ctl_del(ep, fd, event);
397                         break;
398                 default:
399                         errno = EINVAL;
400                         ret = -1;
401         }
402         spin_pdr_unlock(&ep->lock);
403         return ret;
404 }
405
406 static bool get_ep_event_from_msg(struct epoll_ctlr *ep, struct event_msg *msg,
407                                   struct epoll_event *ep_ev)
408 {
409         struct ceq_event *ceq_ev;
410         struct ep_fd_data *ep_fd;
411
412         ceq_ev = ep_get_ceq_ev(ep, msg->ev_type);
413         /* should never get a tap FD > size of the epoll set */
414         assert(ceq_ev);
415         ep_fd = (struct ep_fd_data*)ceq_ev->user_data;
416         if (!ep_fd) {
417                 /* it's possible the FD was unregistered and this was an old
418                  * event sent to this epoll set. */
419                 return FALSE;
420         }
421         ep_ev->data = ep_fd->ep_event.data;
422         ep_ev->events = taps_to_ep_events(msg->ev_arg2);
423         return TRUE;
424 }
425
426 /* We should be able to have multiple waiters.  ep shouldn't be closed or
427  * anything, since we have the FD (that'd be bad programming on the user's
428  * behalf).  We could have concurrent ADD/MOD/DEL operations (which lock). */
429 static int __epoll_wait(struct epoll_ctlr *ep, struct epoll_event *events,
430                         int maxevents, int timeout)
431 {
432         struct event_msg msg = {0};
433         struct event_msg dummy_msg;
434         struct event_queue *which_evq;
435         struct event_queue *alarm_evq;
436         int nr_ret = 0;
437         int recurse_ret;
438         struct syscall sysc;
439
440         /* Locking to protect get_ep_event_from_msg, specifically that the ep_fd
441          * stored at ceq_ev->user_data does not get concurrently removed and
442          * freed. */
443         spin_pdr_lock(&ep->lock);
444         for (int i = 0; i < maxevents; i++) {
445                 if (uth_check_evqs(&msg, &which_evq, 1, ep->ceq_evq)) {
446                         if (get_ep_event_from_msg(ep, &msg, &events[i]))
447                                 nr_ret++;
448                 }
449         }
450         spin_pdr_unlock(&ep->lock);
451         if (nr_ret)
452                 return nr_ret;
453         if (timeout == 0)
454                 return 0;
455         if (timeout != -1) {
456                 alarm_evq = ep_get_alarm_evq();
457                 syscall_async(&sysc, SYS_block, timeout * 1000);
458                 if (!register_evq(&sysc, alarm_evq)) {
459                         /* timeout occurred before we could even block! */
460                         ep_put_alarm_evq(alarm_evq);
461                         return 0;
462                 }
463                 uth_blockon_evqs(&msg, &which_evq, 2, ep->ceq_evq, alarm_evq);
464                 if (which_evq != alarm_evq) {
465                         /* sysc may or may not have finished yet.  this will force it to
466                          * *start* to finish iff it is still a submitted syscall. */
467                         sys_abort_sysc(&sysc);
468                         /* But we still need to wait until the syscall completed.  Need a
469                          * dummy msg, since we don't want to clobber the real msg. */
470                         uth_blockon_evqs(&dummy_msg, 0, 1, alarm_evq);
471                 }
472                 /* TODO: Slightly dangerous, due to spammed INDIRs */
473                 ep_put_alarm_evq(alarm_evq);
474                 if (which_evq == alarm_evq)
475                         return 0;
476         } else {
477                 uth_blockon_evqs(&msg, &which_evq, 1, ep->ceq_evq);
478         }
479         spin_pdr_lock(&ep->lock);
480         if (get_ep_event_from_msg(ep, &msg, &events[0]))
481                 nr_ret++;
482         spin_pdr_unlock(&ep->lock);
483         /* We might not have gotten one yet.  And regardless, there might be more
484          * available.  Let's try again, with timeout == 0 to ensure no blocking.  We
485          * use nr_ret (0 or 1 now) to adjust maxevents and events accordingly. */
486         recurse_ret = __epoll_wait(ep, events + nr_ret, maxevents - nr_ret, 0);
487         if (recurse_ret > 0)
488                 nr_ret += recurse_ret;
489         return nr_ret;
490 }
491
492 int epoll_wait(int epfd, struct epoll_event *events, int maxevents,
493                int timeout)
494 {
495         struct epoll_ctlr *ep = fd_to_cltr(epfd);
496         int ret;
497         if (!ep) {
498                 errno = EBADF;/* or EINVAL */
499                 return -1;
500         }
501         if (maxevents <= 0) {
502                 errno = EINVAL;
503                 return -1;
504         }
505         ret = __epoll_wait(ep, events, maxevents, timeout);
506         return ret;
507 }
508
509 int epoll_pwait(int epfd, struct epoll_event *events, int maxevents,
510                 int timeout, const sigset_t *sigmask)
511 {
512         int ready;
513         sigset_t origmask;
514         /* TODO: this is probably racy */
515         sigprocmask(SIG_SETMASK, sigmask, &origmask);
516         ready = epoll_wait(epfd, events, maxevents, timeout);
517         sigprocmask(SIG_SETMASK, &origmask, NULL);
518         return ready;
519 }