ev_kqueue.c

   1 /*
   2  * Copyright 2007      Marc Alexander Lehmann <libev@schmorp.de>
   3  * Copyright 2000-2002 Niels Provos <provos@citi.umich.edu>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  *
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. The name of the author may not be used to endorse or promote products
  16  *    derived from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #include <sys/types.h>
  31 #include <sys/time.h>
  32 #include <sys/queue.h>
  33 #include <sys/event.h>
  34 #include <string.h>
  35 #include <errno.h>
  36
  37 static void
  38 kqueue_change (EV_P_ int fd, int filter, int flags, int fflags)
  39 {
  40   struct kevent *ke;
  41
  42   array_needsize (struct kevent, kqueue_changes, kqueue_changemax, ++kqueue_changecnt, );
  43
  44   ke = &kqueue_changes [kqueue_changecnt - 1];
  45   memset (ke, 0, sizeof (struct kevent));
  46   ke->ident  = fd;
  47   ke->filter = filter;
  48   ke->flags  = flags;
  49   ke->fflags = fflags;
  50 }
  51
  52 #ifndef NOTE_EOF
  53 # define NOTE_EOF 0
  54 #endif
  55
  56 static void
  57 kqueue_modify (EV_P_ int fd, int oev, int nev)
  58 {
  59   /* to detect close/reopen reliably, we have to remove and re-add */
  60   /* event requests even when oev == nev */
  61
  62   if (oev & EV_READ)
  63     kqueue_change (EV_A_ fd, EVFILT_READ, EV_DELETE, 0);
  64
  65   if (oev & EV_WRITE)
  66     kqueue_change (EV_A_ fd, EVFILT_WRITE, EV_DELETE, 0);
  67
  68   if (nev & EV_READ)
  69     kqueue_change (EV_A_ fd, EVFILT_READ, EV_ADD, NOTE_EOF);
  70
  71   if (nev & EV_WRITE)
  72     kqueue_change (EV_A_ fd, EVFILT_WRITE, EV_ADD, NOTE_EOF);
  73 }
  74
  75 static void
  76 kqueue_poll (EV_P_ ev_tstamp timeout)
  77 {
  78   int res, i;
  79   struct timespec ts;
  80
  81   /* need to resize so there is enough space for errors */
  82   if (kqueue_changecnt > kqueue_eventmax)
  83     {
  84       ev_free (kqueue_events);
  85       kqueue_eventmax = array_roundsize (struct kevent, kqueue_changecnt);
  86       kqueue_events = ev_malloc (sizeof (struct kevent) * kqueue_eventmax);
  87     }
  88
  89   ts.tv_sec  = (time_t)timeout;
  90   ts.tv_nsec = (long)(timeout - (ev_tstamp)ts.tv_sec) * 1e9;
  91   res = kevent (kqueue_fd, kqueue_changes, kqueue_changecnt, kqueue_events, kqueue_eventmax, &ts);
  92   kqueue_changecnt = 0;
  93
  94   if (res < 0)
  95     {
  96       if (errno != EINTR)
  97         syserr ("(libev) kevent");
  98
  99       return;
 100     }
 101
 102   for (i = 0; i < res; ++i)
 103     {
 104       int fd = kqueue_events [i].ident;
 105
 106       if (kqueue_events [i].flags & EV_ERROR)
 107         {
 108           int err = kqueue_events [i].data;
 109
 110           /*
 111            * errors that may happen
 112            *   EBADF happens when the file discriptor has been
 113            *   closed,
 114            *   ENOENT when the file descriptor was closed and
 115            *   then reopened.
 116            *   EINVAL for some reasons not understood; EINVAL
 117            *   should not be returned ever; but FreeBSD does :-\
 118            */
 119
 120           /* we are only interested in errors for fds that we are interested in :) */
 121           if (anfds [fd].events)
 122             {
 123               if (err == ENOENT) /* resubmit changes on ENOENT */
 124                 kqueue_modify (EV_A_ fd, 0, anfds [fd].events);
 125               else if (err == EBADF) /* on EBADF, we re-check the fd */
 126                 {
 127                   if (fd_valid (fd))
 128                     kqueue_modify (EV_A_ fd, 0, anfds [fd].events);
 129                   else
 130                     fd_kill (EV_A_ fd);
 131                 }
 132               else /* on all other errors, we error out on the fd */
 133                 fd_kill (EV_A_ fd);
 134             }
 135         }
 136       else
 137         fd_event (
 138           EV_A_
 139           fd,
 140           kqueue_events [i].filter == EVFILT_READ ? EV_READ
 141           : kqueue_events [i].filter == EVFILT_WRITE ? EV_WRITE
 142           : 0
 143         );
 144     }
 145
 146   if (expect_false (res == kqueue_eventmax))
 147     {
 148       ev_free (kqueue_events);
 149       kqueue_eventmax = array_roundsize (struct kevent, kqueue_eventmax << 1);
 150       kqueue_events = ev_malloc (sizeof (struct kevent) * kqueue_eventmax);
 151     }
 152 }
 153
 154 static int
 155 kqueue_init (EV_P_ int flags)
 156 {
 157   struct kevent ch, ev;
 158
 159   /* Initalize the kernel queue */
 160   if ((kqueue_fd = kqueue ()) < 0)
 161     return 0;
 162
 163   fcntl (kqueue_fd, F_SETFD, FD_CLOEXEC); /* not sure if necessary, hopefully doesn't hurt */
 164
 165   /* Check for Mac OS X kqueue bug. */
 166   ch.ident  = -1;
 167   ch.filter = EVFILT_READ;
 168   ch.flags  = EV_ADD;
 169
 170   /*
 171    * If kqueue works, then kevent will succeed, and it will
 172    * stick an error in ev. If kqueue is broken, then
 173    * kevent will fail.
 174    */
 175   if (kevent (kqueue_fd, &ch, 1, &ev, 1, 0) != 1
 176       || ev.ident != -1
 177       || ev.flags != EV_ERROR)
 178     {
 179       /* detected broken kqueue */
 180       close (kqueue_fd);
 181       return 0;
 182     }
 183
 184   method_fudge  = 1e-3; /* needed to compensate for kevent returning early */
 185   method_modify = kqueue_modify;
 186   method_poll   = kqueue_poll;
 187
 188   kqueue_eventmax = 64; /* intiial number of events receivable per poll */
 189   kqueue_events = ev_malloc (sizeof (struct kevent) * kqueue_eventmax);
 190
 191   kqueue_changes   = 0;
 192   kqueue_changemax = 0;
 193   kqueue_changecnt = 0;
 194
 195   return EVMETHOD_KQUEUE;
 196 }
 197
 198 static void
 199 kqueue_destroy (EV_P)
 200 {
 201   close (kqueue_fd);
 202
 203   ev_free (kqueue_events);
 204   ev_free (kqueue_changes);
 205 }
 206
 207 static void
 208 kqueue_fork (EV_P)
 209 {
 210   close (kqueue_fd);
 211
 212   while ((kqueue_fd = kqueue ()) < 0)
 213     syserr ("(libev) kqueue");
 214
 215   fcntl (kqueue_fd, F_SETFD, FD_CLOEXEC);
 216
 217   /* re-register interest in fds */
 218   fd_rearm_all (EV_A);
 219 }
 220