Blame src/unix/posix-poll.c

Packit b5b901
/* Copyright libuv project contributors. All rights reserved.
Packit b5b901
 *
Packit b5b901
 * Permission is hereby granted, free of charge, to any person obtaining a copy
Packit b5b901
 * of this software and associated documentation files (the "Software"), to
Packit b5b901
 * deal in the Software without restriction, including without limitation the
Packit b5b901
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
Packit b5b901
 * sell copies of the Software, and to permit persons to whom the Software is
Packit b5b901
 * furnished to do so, subject to the following conditions:
Packit b5b901
 *
Packit b5b901
 * The above copyright notice and this permission notice shall be included in
Packit b5b901
 * all copies or substantial portions of the Software.
Packit b5b901
 *
Packit b5b901
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
Packit b5b901
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
Packit b5b901
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
Packit b5b901
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
Packit b5b901
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
Packit b5b901
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
Packit b5b901
 * IN THE SOFTWARE.
Packit b5b901
 */
Packit b5b901
Packit b5b901
#include "uv.h"
Packit b5b901
#include "internal.h"
Packit b5b901
Packit b5b901
/* POSIX defines poll() as a portable way to wait on file descriptors.
Packit b5b901
 * Here we maintain a dynamically sized array of file descriptors and
Packit b5b901
 * events to pass as the first argument to poll().
Packit b5b901
 */
Packit b5b901
Packit b5b901
#include <assert.h>
Packit b5b901
#include <stddef.h>
Packit b5b901
#include <stdint.h>
Packit b5b901
#include <errno.h>
Packit b5b901
#include <unistd.h>
Packit b5b901
Packit b5b901
int uv__platform_loop_init(uv_loop_t* loop) {
Packit b5b901
  loop->poll_fds = NULL;
Packit b5b901
  loop->poll_fds_used = 0;
Packit b5b901
  loop->poll_fds_size = 0;
Packit b5b901
  loop->poll_fds_iterating = 0;
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
void uv__platform_loop_delete(uv_loop_t* loop) {
Packit b5b901
  uv__free(loop->poll_fds);
Packit b5b901
  loop->poll_fds = NULL;
Packit b5b901
}
Packit b5b901
Packit b5b901
int uv__io_fork(uv_loop_t* loop) {
Packit b5b901
  uv__platform_loop_delete(loop);
Packit b5b901
  return uv__platform_loop_init(loop);
Packit b5b901
}
Packit b5b901
Packit b5b901
/* Allocate or dynamically resize our poll fds array.  */
Packit b5b901
static void uv__pollfds_maybe_resize(uv_loop_t* loop) {
Packit b5b901
  size_t i;
Packit b5b901
  size_t n;
Packit b5b901
  struct pollfd* p;
Packit b5b901
Packit b5b901
  if (loop->poll_fds_used < loop->poll_fds_size)
Packit b5b901
    return;
Packit b5b901
Packit b5b901
  n = loop->poll_fds_size ? loop->poll_fds_size * 2 : 64;
Packit Service e08953
  p = uv__reallocf(loop->poll_fds, n * sizeof(*loop->poll_fds));
Packit b5b901
  if (p == NULL)
Packit b5b901
    abort();
Packit b5b901
Packit b5b901
  loop->poll_fds = p;
Packit b5b901
  for (i = loop->poll_fds_size; i < n; i++) {
Packit b5b901
    loop->poll_fds[i].fd = -1;
Packit b5b901
    loop->poll_fds[i].events = 0;
Packit b5b901
    loop->poll_fds[i].revents = 0;
Packit b5b901
  }
Packit b5b901
  loop->poll_fds_size = n;
Packit b5b901
}
Packit b5b901
Packit b5b901
/* Primitive swap operation on poll fds array elements.  */
Packit b5b901
static void uv__pollfds_swap(uv_loop_t* loop, size_t l, size_t r) {
Packit b5b901
  struct pollfd pfd;
Packit b5b901
  pfd = loop->poll_fds[l];
Packit b5b901
  loop->poll_fds[l] = loop->poll_fds[r];
Packit b5b901
  loop->poll_fds[r] = pfd;
Packit b5b901
}
Packit b5b901
Packit b5b901
/* Add a watcher's fd to our poll fds array with its pending events.  */
Packit b5b901
static void uv__pollfds_add(uv_loop_t* loop, uv__io_t* w) {
Packit b5b901
  size_t i;
Packit b5b901
  struct pollfd* pe;
Packit b5b901
Packit b5b901
  /* If the fd is already in the set just update its events.  */
Packit b5b901
  assert(!loop->poll_fds_iterating);
Packit b5b901
  for (i = 0; i < loop->poll_fds_used; ++i) {
Packit b5b901
    if (loop->poll_fds[i].fd == w->fd) {
Packit b5b901
      loop->poll_fds[i].events = w->pevents;
Packit b5b901
      return;
Packit b5b901
    }
Packit b5b901
  }
Packit b5b901
Packit b5b901
  /* Otherwise, allocate a new slot in the set for the fd.  */
Packit b5b901
  uv__pollfds_maybe_resize(loop);
Packit b5b901
  pe = &loop->poll_fds[loop->poll_fds_used++];
Packit b5b901
  pe->fd = w->fd;
Packit b5b901
  pe->events = w->pevents;
Packit b5b901
}
Packit b5b901
Packit b5b901
/* Remove a watcher's fd from our poll fds array.  */
Packit b5b901
static void uv__pollfds_del(uv_loop_t* loop, int fd) {
Packit b5b901
  size_t i;
Packit b5b901
  assert(!loop->poll_fds_iterating);
Packit b5b901
  for (i = 0; i < loop->poll_fds_used;) {
Packit b5b901
    if (loop->poll_fds[i].fd == fd) {
Packit b5b901
      /* swap to last position and remove */
Packit b5b901
      --loop->poll_fds_used;
Packit b5b901
      uv__pollfds_swap(loop, i, loop->poll_fds_used);
Packit b5b901
      loop->poll_fds[loop->poll_fds_used].fd = -1;
Packit b5b901
      loop->poll_fds[loop->poll_fds_used].events = 0;
Packit b5b901
      loop->poll_fds[loop->poll_fds_used].revents = 0;
Packit b5b901
      /* This method is called with an fd of -1 to purge the invalidated fds,
Packit b5b901
       * so we may possibly have multiples to remove.
Packit b5b901
       */
Packit b5b901
      if (-1 != fd)
Packit b5b901
        return;
Packit b5b901
    } else {
Packit b5b901
      /* We must only increment the loop counter when the fds do not match.
Packit b5b901
       * Otherwise, when we are purging an invalidated fd, the value just
Packit b5b901
       * swapped here from the previous end of the array will be skipped.
Packit b5b901
       */
Packit b5b901
       ++i;
Packit b5b901
    }
Packit b5b901
  }
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
void uv__io_poll(uv_loop_t* loop, int timeout) {
Packit b5b901
  sigset_t* pset;
Packit b5b901
  sigset_t set;
Packit b5b901
  uint64_t time_base;
Packit b5b901
  uint64_t time_diff;
Packit b5b901
  QUEUE* q;
Packit b5b901
  uv__io_t* w;
Packit b5b901
  size_t i;
Packit b5b901
  unsigned int nevents;
Packit b5b901
  int nfds;
Packit b5b901
  int have_signals;
Packit b5b901
  struct pollfd* pe;
Packit b5b901
  int fd;
Packit b5b901
Packit b5b901
  if (loop->nfds == 0) {
Packit b5b901
    assert(QUEUE_EMPTY(&loop->watcher_queue));
Packit b5b901
    return;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  /* Take queued watchers and add their fds to our poll fds array.  */
Packit b5b901
  while (!QUEUE_EMPTY(&loop->watcher_queue)) {
Packit b5b901
    q = QUEUE_HEAD(&loop->watcher_queue);
Packit b5b901
    QUEUE_REMOVE(q);
Packit b5b901
    QUEUE_INIT(q);
Packit b5b901
Packit b5b901
    w = QUEUE_DATA(q, uv__io_t, watcher_queue);
Packit b5b901
    assert(w->pevents != 0);
Packit b5b901
    assert(w->fd >= 0);
Packit b5b901
    assert(w->fd < (int) loop->nwatchers);
Packit b5b901
Packit b5b901
    uv__pollfds_add(loop, w);
Packit b5b901
Packit b5b901
    w->events = w->pevents;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  /* Prepare a set of signals to block around poll(), if any.  */
Packit b5b901
  pset = NULL;
Packit b5b901
  if (loop->flags & UV_LOOP_BLOCK_SIGPROF) {
Packit b5b901
    pset = &set;
Packit b5b901
    sigemptyset(pset);
Packit b5b901
    sigaddset(pset, SIGPROF);
Packit b5b901
  }
Packit b5b901
Packit b5b901
  assert(timeout >= -1);
Packit b5b901
  time_base = loop->time;
Packit b5b901
Packit b5b901
  /* Loop calls to poll() and processing of results.  If we get some
Packit b5b901
   * results from poll() but they turn out not to be interesting to
Packit b5b901
   * our caller then we need to loop around and poll() again.
Packit b5b901
   */
Packit b5b901
  for (;;) {
Packit b5b901
    if (pset != NULL)
Packit b5b901
      if (pthread_sigmask(SIG_BLOCK, pset, NULL))
Packit b5b901
        abort();
Packit b5b901
    nfds = poll(loop->poll_fds, (nfds_t)loop->poll_fds_used, timeout);
Packit b5b901
    if (pset != NULL)
Packit b5b901
      if (pthread_sigmask(SIG_UNBLOCK, pset, NULL))
Packit b5b901
        abort();
Packit b5b901
Packit b5b901
    /* Update loop->time unconditionally. It's tempting to skip the update when
Packit b5b901
     * timeout == 0 (i.e. non-blocking poll) but there is no guarantee that the
Packit b5b901
     * operating system didn't reschedule our process while in the syscall.
Packit b5b901
     */
Packit b5b901
    SAVE_ERRNO(uv__update_time(loop));
Packit b5b901
Packit b5b901
    if (nfds == 0) {
Packit b5b901
      assert(timeout != -1);
Packit b5b901
      return;
Packit b5b901
    }
Packit b5b901
Packit b5b901
    if (nfds == -1) {
Packit b5b901
      if (errno != EINTR)
Packit b5b901
        abort();
Packit b5b901
Packit b5b901
      if (timeout == -1)
Packit b5b901
        continue;
Packit b5b901
Packit b5b901
      if (timeout == 0)
Packit b5b901
        return;
Packit b5b901
Packit b5b901
      /* Interrupted by a signal. Update timeout and poll again. */
Packit b5b901
      goto update_timeout;
Packit b5b901
    }
Packit b5b901
Packit b5b901
    /* Tell uv__platform_invalidate_fd not to manipulate our array
Packit b5b901
     * while we are iterating over it.
Packit b5b901
     */
Packit b5b901
    loop->poll_fds_iterating = 1;
Packit b5b901
Packit b5b901
    /* Initialize a count of events that we care about.  */
Packit b5b901
    nevents = 0;
Packit b5b901
    have_signals = 0;
Packit b5b901
Packit b5b901
    /* Loop over the entire poll fds array looking for returned events.  */
Packit b5b901
    for (i = 0; i < loop->poll_fds_used; i++) {
Packit b5b901
      pe = loop->poll_fds + i;
Packit b5b901
      fd = pe->fd;
Packit b5b901
Packit b5b901
      /* Skip invalidated events, see uv__platform_invalidate_fd.  */
Packit b5b901
      if (fd == -1)
Packit b5b901
        continue;
Packit b5b901
Packit b5b901
      assert(fd >= 0);
Packit b5b901
      assert((unsigned) fd < loop->nwatchers);
Packit b5b901
Packit b5b901
      w = loop->watchers[fd];
Packit b5b901
Packit b5b901
      if (w == NULL) {
Packit b5b901
        /* File descriptor that we've stopped watching, ignore.  */
Packit b5b901
        uv__platform_invalidate_fd(loop, fd);
Packit b5b901
        continue;
Packit b5b901
      }
Packit b5b901
Packit b5b901
      /* Filter out events that user has not requested us to watch
Packit b5b901
       * (e.g. POLLNVAL).
Packit b5b901
       */
Packit b5b901
      pe->revents &= w->pevents | POLLERR | POLLHUP;
Packit b5b901
Packit b5b901
      if (pe->revents != 0) {
Packit b5b901
        /* Run signal watchers last.  */
Packit b5b901
        if (w == &loop->signal_io_watcher) {
Packit b5b901
          have_signals = 1;
Packit b5b901
        } else {
Packit b5b901
          w->cb(loop, w, pe->revents);
Packit b5b901
        }
Packit b5b901
Packit b5b901
        nevents++;
Packit b5b901
      }
Packit b5b901
    }
Packit b5b901
Packit b5b901
    if (have_signals != 0)
Packit b5b901
      loop->signal_io_watcher.cb(loop, &loop->signal_io_watcher, POLLIN);
Packit b5b901
Packit b5b901
    loop->poll_fds_iterating = 0;
Packit b5b901
Packit b5b901
    /* Purge invalidated fds from our poll fds array.  */
Packit b5b901
    uv__pollfds_del(loop, -1);
Packit b5b901
Packit b5b901
    if (have_signals != 0)
Packit b5b901
      return;  /* Event loop should cycle now so don't poll again. */
Packit b5b901
Packit b5b901
    if (nevents != 0)
Packit b5b901
      return;
Packit b5b901
Packit b5b901
    if (timeout == 0)
Packit b5b901
      return;
Packit b5b901
Packit b5b901
    if (timeout == -1)
Packit b5b901
      continue;
Packit b5b901
Packit b5b901
update_timeout:
Packit b5b901
    assert(timeout > 0);
Packit b5b901
Packit b5b901
    time_diff = loop->time - time_base;
Packit b5b901
    if (time_diff >= (uint64_t) timeout)
Packit b5b901
      return;
Packit b5b901
Packit b5b901
    timeout -= time_diff;
Packit b5b901
  }
Packit b5b901
}
Packit b5b901
Packit b5b901
/* Remove the given fd from our poll fds array because no one
Packit b5b901
 * is interested in its events anymore.
Packit b5b901
 */
Packit b5b901
void uv__platform_invalidate_fd(uv_loop_t* loop, int fd) {
Packit b5b901
  size_t i;
Packit b5b901
Packit Service e08953
  assert(fd >= 0);
Packit Service e08953
Packit b5b901
  if (loop->poll_fds_iterating) {
Packit b5b901
    /* uv__io_poll is currently iterating.  Just invalidate fd.  */
Packit b5b901
    for (i = 0; i < loop->poll_fds_used; i++)
Packit b5b901
      if (loop->poll_fds[i].fd == fd) {
Packit b5b901
        loop->poll_fds[i].fd = -1;
Packit b5b901
        loop->poll_fds[i].events = 0;
Packit b5b901
        loop->poll_fds[i].revents = 0;
Packit b5b901
      }
Packit b5b901
  } else {
Packit b5b901
    /* uv__io_poll is not iterating.  Delete fd from the set.  */
Packit b5b901
    uv__pollfds_del(loop, fd);
Packit b5b901
  }
Packit b5b901
}
Packit b5b901
Packit b5b901
/* Check whether the given fd is supported by poll().  */
Packit b5b901
int uv__io_check_fd(uv_loop_t* loop, int fd) {
Packit b5b901
  struct pollfd p[1];
Packit b5b901
  int rv;
Packit b5b901
Packit b5b901
  p[0].fd = fd;
Packit b5b901
  p[0].events = POLLIN;
Packit b5b901
Packit b5b901
  do
Packit b5b901
    rv = poll(p, 1, 0);
Packit b5b901
  while (rv == -1 && (errno == EINTR || errno == EAGAIN));
Packit b5b901
Packit b5b901
  if (rv == -1)
Packit b5b901
    return UV__ERR(errno);
Packit b5b901
Packit b5b901
  if (p[0].revents & POLLNVAL)
Packit b5b901
    return UV_EINVAL;
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}