Blame src/unix/async.c

Packit b5b901
/* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
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
/* This file contains both the uv__async internal infrastructure and the
Packit b5b901
 * user-facing uv_async_t functions.
Packit b5b901
 */
Packit b5b901
Packit b5b901
#include "uv.h"
Packit b5b901
#include "internal.h"
Packit b5b901
#include "atomic-ops.h"
Packit b5b901
Packit b5b901
#include <errno.h>
Packit b5b901
#include <stdio.h>  /* snprintf() */
Packit b5b901
#include <assert.h>
Packit b5b901
#include <stdlib.h>
Packit b5b901
#include <string.h>
Packit b5b901
#include <unistd.h>
Packit Service e08953
#include <sched.h>  /* sched_yield() */
Packit Service e08953
Packit Service e08953
#ifdef __linux__
Packit Service e08953
#include <sys/eventfd.h>
Packit Service e08953
#endif
Packit b5b901
Packit b5b901
static void uv__async_send(uv_loop_t* loop);
Packit b5b901
static int uv__async_start(uv_loop_t* loop);
Packit b5b901
Packit b5b901
Packit b5b901
int uv_async_init(uv_loop_t* loop, uv_async_t* handle, uv_async_cb async_cb) {
Packit b5b901
  int err;
Packit b5b901
Packit b5b901
  err = uv__async_start(loop);
Packit b5b901
  if (err)
Packit b5b901
    return err;
Packit b5b901
Packit b5b901
  uv__handle_init(loop, (uv_handle_t*)handle, UV_ASYNC);
Packit b5b901
  handle->async_cb = async_cb;
Packit b5b901
  handle->pending = 0;
Packit b5b901
Packit b5b901
  QUEUE_INSERT_TAIL(&loop->async_handles, &handle->queue);
Packit b5b901
  uv__handle_start(handle);
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv_async_send(uv_async_t* handle) {
Packit b5b901
  /* Do a cheap read first. */
Packit b5b901
  if (ACCESS_ONCE(int, handle->pending) != 0)
Packit b5b901
    return 0;
Packit b5b901
Packit Service e08953
  /* Tell the other thread we're busy with the handle. */
Packit Service e08953
  if (cmpxchgi(&handle->pending, 0, 1) != 0)
Packit Service e08953
    return 0;
Packit Service e08953
Packit Service e08953
  /* Wake up the other thread's event loop. */
Packit Service e08953
  uv__async_send(handle->loop);
Packit Service e08953
Packit Service e08953
  /* Tell the other thread we're done. */
Packit Service e08953
  if (cmpxchgi(&handle->pending, 1, 2) != 1)
Packit Service e08953
    abort();
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit Service e08953
/* Only call this from the event loop thread. */
Packit Service e08953
static int uv__async_spin(uv_async_t* handle) {
Packit Service e08953
  int i;
Packit Service e08953
  int rc;
Packit Service e08953
Packit Service e08953
  for (;;) {
Packit Service e08953
    /* 997 is not completely chosen at random. It's a prime number, acyclical
Packit Service e08953
     * by nature, and should therefore hopefully dampen sympathetic resonance.
Packit Service e08953
     */
Packit Service e08953
    for (i = 0; i < 997; i++) {
Packit Service e08953
      /* rc=0 -- handle is not pending.
Packit Service e08953
       * rc=1 -- handle is pending, other thread is still working with it.
Packit Service e08953
       * rc=2 -- handle is pending, other thread is done.
Packit Service e08953
       */
Packit Service e08953
      rc = cmpxchgi(&handle->pending, 2, 0);
Packit Service e08953
Packit Service e08953
      if (rc != 1)
Packit Service e08953
        return rc;
Packit Service e08953
Packit Service e08953
      /* Other thread is busy with this handle, spin until it's done. */
Packit Service e08953
      cpu_relax();
Packit Service e08953
    }
Packit Service e08953
Packit Service e08953
    /* Yield the CPU. We may have preempted the other thread while it's
Packit Service e08953
     * inside the critical section and if it's running on the same CPU
Packit Service e08953
     * as us, we'll just burn CPU cycles until the end of our time slice.
Packit Service e08953
     */
Packit Service e08953
    sched_yield();
Packit Service e08953
  }
Packit Service e08953
}
Packit Service e08953
Packit Service e08953
Packit b5b901
void uv__async_close(uv_async_t* handle) {
Packit Service e08953
  uv__async_spin(handle);
Packit b5b901
  QUEUE_REMOVE(&handle->queue);
Packit b5b901
  uv__handle_stop(handle);
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static void uv__async_io(uv_loop_t* loop, uv__io_t* w, unsigned int events) {
Packit b5b901
  char buf[1024];
Packit b5b901
  ssize_t r;
Packit b5b901
  QUEUE queue;
Packit b5b901
  QUEUE* q;
Packit b5b901
  uv_async_t* h;
Packit b5b901
Packit b5b901
  assert(w == &loop->async_io_watcher);
Packit b5b901
Packit b5b901
  for (;;) {
Packit b5b901
    r = read(w->fd, buf, sizeof(buf));
Packit b5b901
Packit b5b901
    if (r == sizeof(buf))
Packit b5b901
      continue;
Packit b5b901
Packit b5b901
    if (r != -1)
Packit b5b901
      break;
Packit b5b901
Packit b5b901
    if (errno == EAGAIN || errno == EWOULDBLOCK)
Packit b5b901
      break;
Packit b5b901
Packit b5b901
    if (errno == EINTR)
Packit b5b901
      continue;
Packit b5b901
Packit b5b901
    abort();
Packit b5b901
  }
Packit b5b901
Packit b5b901
  QUEUE_MOVE(&loop->async_handles, &queue);
Packit b5b901
  while (!QUEUE_EMPTY(&queue)) {
Packit b5b901
    q = QUEUE_HEAD(&queue);
Packit b5b901
    h = QUEUE_DATA(q, uv_async_t, queue);
Packit b5b901
Packit b5b901
    QUEUE_REMOVE(q);
Packit b5b901
    QUEUE_INSERT_TAIL(&loop->async_handles, q);
Packit b5b901
Packit Service e08953
    if (0 == uv__async_spin(h))
Packit Service e08953
      continue;  /* Not pending. */
Packit b5b901
Packit b5b901
    if (h->async_cb == NULL)
Packit b5b901
      continue;
Packit b5b901
Packit b5b901
    h->async_cb(h);
Packit b5b901
  }
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static void uv__async_send(uv_loop_t* loop) {
Packit b5b901
  const void* buf;
Packit b5b901
  ssize_t len;
Packit b5b901
  int fd;
Packit b5b901
  int r;
Packit b5b901
Packit b5b901
  buf = "";
Packit b5b901
  len = 1;
Packit b5b901
  fd = loop->async_wfd;
Packit b5b901
Packit b5b901
#if defined(__linux__)
Packit b5b901
  if (fd == -1) {
Packit b5b901
    static const uint64_t val = 1;
Packit b5b901
    buf = &val;
Packit b5b901
    len = sizeof(val);
Packit b5b901
    fd = loop->async_io_watcher.fd;  /* eventfd */
Packit b5b901
  }
Packit b5b901
#endif
Packit b5b901
Packit b5b901
  do
Packit b5b901
    r = write(fd, buf, len);
Packit b5b901
  while (r == -1 && errno == EINTR);
Packit b5b901
Packit b5b901
  if (r == len)
Packit b5b901
    return;
Packit b5b901
Packit b5b901
  if (r == -1)
Packit b5b901
    if (errno == EAGAIN || errno == EWOULDBLOCK)
Packit b5b901
      return;
Packit b5b901
Packit b5b901
  abort();
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static int uv__async_start(uv_loop_t* loop) {
Packit b5b901
  int pipefd[2];
Packit b5b901
  int err;
Packit b5b901
Packit b5b901
  if (loop->async_io_watcher.fd != -1)
Packit b5b901
    return 0;
Packit b5b901
Packit Service e08953
#ifdef __linux__
Packit Service e08953
  err = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
Packit Service e08953
  if (err < 0)
Packit Service e08953
    return UV__ERR(errno);
Packit b5b901
Packit Service e08953
  pipefd[0] = err;
Packit Service e08953
  pipefd[1] = -1;
Packit Service e08953
#else
Packit Service e08953
  err = uv__make_pipe(pipefd, UV__F_NONBLOCK);
Packit b5b901
  if (err < 0)
Packit b5b901
    return err;
Packit Service e08953
#endif
Packit b5b901
Packit b5b901
  uv__io_init(&loop->async_io_watcher, uv__async_io, pipefd[0]);
Packit b5b901
  uv__io_start(loop, &loop->async_io_watcher, POLLIN);
Packit b5b901
  loop->async_wfd = pipefd[1];
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv__async_fork(uv_loop_t* loop) {
Packit b5b901
  if (loop->async_io_watcher.fd == -1) /* never started */
Packit b5b901
    return 0;
Packit b5b901
Packit b5b901
  uv__async_stop(loop);
Packit b5b901
Packit b5b901
  return uv__async_start(loop);
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
void uv__async_stop(uv_loop_t* loop) {
Packit b5b901
  if (loop->async_io_watcher.fd == -1)
Packit b5b901
    return;
Packit b5b901
Packit b5b901
  if (loop->async_wfd != -1) {
Packit b5b901
    if (loop->async_wfd != loop->async_io_watcher.fd)
Packit b5b901
      uv__close(loop->async_wfd);
Packit b5b901
    loop->async_wfd = -1;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  uv__io_stop(loop, &loop->async_io_watcher, POLLIN);
Packit b5b901
  uv__close(loop->async_io_watcher.fd);
Packit b5b901
  loop->async_io_watcher.fd = -1;
Packit b5b901
}