rework docs, finish embed implementation

[software/libev.git] / ev_epoll.c

diff --git a/ev_epoll.c b/ev_epoll.c
index 7bd7949f9a6c8e3ab7263039b71a296d197a9c42..52f8337604cc699c84fc68c136331bd6c20b2f8f 100644 (file)
--- a/ev_epoll.c
+++ b/ev_epoll.c
@@ -29,32 +29,73 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
+/*
+ * general notes about epoll:
+ *
+ * a) epoll silently removes fds from the fd set. as nothing tells us
+ *    that an fd has been removed otherwise, we have to continually
+ *    "rearm" fds that we suspect *might* have changed (same
+ *    problem with kqueue, but much less costly there).
+ * b) the fact that ADD != MOD creates a lot of extra syscalls due to a)
+ *    and seems not to have any advantage.
+ * c) the inability to handle fork or file descriptors (think dup)
+ *    limits the applicability over poll, so this is not a generic
+ *    poll replacement.
+ *
+ * lots of "weird code" and complication handling in this file is due
+ * to these design problems with epoll, as we try very hard to avoid
+ * epoll_ctl syscalls for common usage patterns.
+ */
+
 #include <sys/epoll.h>
 
 static void
 epoll_modify (EV_P_ int fd, int oev, int nev)
 {
-  int mode = nev ? oev ? EPOLL_CTL_MOD : EPOLL_CTL_ADD : EPOLL_CTL_DEL;
-
   struct epoll_event ev;
+
+  /*
+   * we handle EPOLL_CTL_DEL by ignoring it here
+   * on the assumption that the fd is gone anyways
+   * if that is wrong, we have to handle the spurious
+   * event in epoll_poll.
+   */
+  if (!nev)
+    return;
+
   ev.data.u64 = fd; /* use u64 to fully initialise the struct, for nicer strace etc. */
-  ev.events =
-      (nev & EV_READ ? EPOLLIN : 0)
-      | (nev & EV_WRITE ? EPOLLOUT : 0);
-
-  if (epoll_ctl (epoll_fd, mode, fd, &ev))
-    if (errno != ENOENT /* on ENOENT the fd went away, so try to do the right thing */
-        || (nev && epoll_ctl (epoll_fd, EPOLL_CTL_ADD, fd, &ev)))
-      fd_kill (EV_A_ fd);
+  ev.events   = (nev & EV_READ  ? EPOLLIN  : 0)
+              | (nev & EV_WRITE ? EPOLLOUT : 0);
+
+  if (expect_true (!epoll_ctl (backend_fd, oev ? EPOLL_CTL_MOD : EPOLL_CTL_ADD, fd, &ev)))
+    return;
+
+  if (expect_true (errno == ENOENT))
+    {
+      /* on ENOENT the fd went away, so try to do the right thing */
+      if (!nev)
+        return;
+
+      if (!epoll_ctl (backend_fd, EPOLL_CTL_ADD, fd, &ev))
+        return;
+    }
+  else if (expect_true (errno == EEXIST))
+    {
+      /* on EEXIST we ignored a previous DEL */
+      if (!epoll_ctl (backend_fd, EPOLL_CTL_MOD, fd, &ev))
+        return;
+    }
+
+  fd_kill (EV_A_ fd);
 }
 
 static void
 epoll_poll (EV_P_ ev_tstamp timeout)
 {
   int i;
-  int eventcnt = epoll_wait (epoll_fd, epoll_events, epoll_eventmax, (int)ceil (timeout * 1000.));
+  int eventcnt = epoll_wait (backend_fd, epoll_events, epoll_eventmax, (int)ceil (timeout * 1000.));
 
-  if (eventcnt < 0)
+  if (expect_false (eventcnt < 0))
     {
       if (errno != EINTR)
         syserr ("(libev) epoll_wait");
@@ -63,33 +104,46 @@ epoll_poll (EV_P_ ev_tstamp timeout)
     }
 
   for (i = 0; i < eventcnt; ++i)
-    fd_event (
-      EV_A_
-      epoll_events [i].data.u64,
-      (epoll_events [i].events & (EPOLLOUT | EPOLLERR | EPOLLHUP) ? EV_WRITE : 0)
-      | (epoll_events [i].events & (EPOLLIN | EPOLLERR | EPOLLHUP) ? EV_READ : 0)
-    );
+    {
+      struct epoll_event *ev = epoll_events + i;
+
+      int fd   = ev->data.u64;
+      int got  = (ev->events & (EPOLLOUT | EPOLLERR | EPOLLHUP) ? EV_WRITE : 0)
+               | (ev->events & (EPOLLIN  | EPOLLERR | EPOLLHUP) ? EV_READ  : 0);
+      int want = anfds [fd].events;
+
+      if (expect_false (got & ~want))
+        {
+          /* we received an event but are not interested in it, try mod or del */
+          ev->events = (want & EV_READ  ? EPOLLIN  : 0)
+                     | (want & EV_WRITE ? EPOLLOUT : 0);
+
+          epoll_ctl (backend_fd, want ? EPOLL_CTL_MOD : EPOLL_CTL_DEL, fd, ev);
+        }
+
+      fd_event (EV_A_ fd, got);
+    }
 
   /* if the receive array was full, increase its size */
   if (expect_false (eventcnt == epoll_eventmax))
     {
       ev_free (epoll_events);
-      epoll_eventmax = array_roundsize (epoll_events, epoll_eventmax << 1);
+      epoll_eventmax = array_nextsize (sizeof (struct epoll_event), epoll_eventmax, epoll_eventmax + 1);
       epoll_events = (struct epoll_event *)ev_malloc (sizeof (struct epoll_event) * epoll_eventmax);
     }
 }
 
-static int
+int inline_size
 epoll_init (EV_P_ int flags)
 {
-  epoll_fd = epoll_create (256);
+  backend_fd = epoll_create (256);
 
-  if (epoll_fd < 0)
+  if (backend_fd < 0)
     return 0;
 
-  fcntl (epoll_fd, F_SETFD, FD_CLOEXEC);
+  fcntl (backend_fd, F_SETFD, FD_CLOEXEC);
 
-  backend_fudge  = 1e-3; /* needed to compensate for epoll returning early */
+  backend_fudge  = 0.; /* kernel sources seem to indicate this to be zero */
   backend_modify = epoll_modify;
   backend_poll   = epoll_poll;
 
@@ -99,23 +153,21 @@ epoll_init (EV_P_ int flags)
   return EVBACKEND_EPOLL;
 }
 
-static void
+void inline_size
 epoll_destroy (EV_P)
 {
-  close (epoll_fd);
-
   ev_free (epoll_events);
 }
 
-static void
+void inline_size
 epoll_fork (EV_P)
 {
-  close (epoll_fd);
+  close (backend_fd);
 
-  while ((epoll_fd = epoll_create (256)) < 0)
+  while ((backend_fd = epoll_create (256)) < 0)
     syserr ("(libev) epoll_create");
 
-  fcntl (epoll_fd, F_SETFD, FD_CLOEXEC);
+  fcntl (backend_fd, F_SETFD, FD_CLOEXEC);
 
   fd_rearm_all (EV_A);
 }