Blame src/unix/linux-inotify.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
#include "uv.h"
Packit b5b901
#include "uv/tree.h"
Packit b5b901
#include "internal.h"
Packit b5b901
Packit b5b901
#include <stdint.h>
Packit b5b901
#include <stdio.h>
Packit b5b901
#include <stdlib.h>
Packit b5b901
#include <string.h>
Packit b5b901
#include <assert.h>
Packit b5b901
#include <errno.h>
Packit b5b901
Packit b5b901
#include <sys/types.h>
Packit b5b901
#include <unistd.h>
Packit b5b901
Packit b5b901
struct watcher_list {
Packit b5b901
  RB_ENTRY(watcher_list) entry;
Packit b5b901
  QUEUE watchers;
Packit b5b901
  int iterating;
Packit b5b901
  char* path;
Packit b5b901
  int wd;
Packit b5b901
};
Packit b5b901
Packit b5b901
struct watcher_root {
Packit b5b901
  struct watcher_list* rbh_root;
Packit b5b901
};
Packit b5b901
#define CAST(p) ((struct watcher_root*)(p))
Packit b5b901
Packit b5b901
Packit b5b901
static int compare_watchers(const struct watcher_list* a,
Packit b5b901
                            const struct watcher_list* b) {
Packit b5b901
  if (a->wd < b->wd) return -1;
Packit b5b901
  if (a->wd > b->wd) return 1;
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
RB_GENERATE_STATIC(watcher_root, watcher_list, entry, compare_watchers)
Packit b5b901
Packit b5b901
Packit b5b901
static void uv__inotify_read(uv_loop_t* loop,
Packit b5b901
                             uv__io_t* w,
Packit b5b901
                             unsigned int revents);
Packit b5b901
Packit b5b901
static void maybe_free_watcher_list(struct watcher_list* w,
Packit b5b901
                                    uv_loop_t* loop);
Packit b5b901
Packit b5b901
static int new_inotify_fd(void) {
Packit b5b901
  int err;
Packit b5b901
  int fd;
Packit b5b901
Packit b5b901
  fd = uv__inotify_init1(UV__IN_NONBLOCK | UV__IN_CLOEXEC);
Packit b5b901
  if (fd != -1)
Packit b5b901
    return fd;
Packit b5b901
Packit b5b901
  if (errno != ENOSYS)
Packit b5b901
    return UV__ERR(errno);
Packit b5b901
Packit b5b901
  fd = uv__inotify_init();
Packit b5b901
  if (fd == -1)
Packit b5b901
    return UV__ERR(errno);
Packit b5b901
Packit b5b901
  err = uv__cloexec(fd, 1);
Packit b5b901
  if (err == 0)
Packit b5b901
    err = uv__nonblock(fd, 1);
Packit b5b901
Packit b5b901
  if (err) {
Packit b5b901
    uv__close(fd);
Packit b5b901
    return err;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  return fd;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static int init_inotify(uv_loop_t* loop) {
Packit b5b901
  int err;
Packit b5b901
Packit b5b901
  if (loop->inotify_fd != -1)
Packit b5b901
    return 0;
Packit b5b901
Packit b5b901
  err = new_inotify_fd();
Packit b5b901
  if (err < 0)
Packit b5b901
    return err;
Packit b5b901
Packit b5b901
  loop->inotify_fd = err;
Packit b5b901
  uv__io_init(&loop->inotify_read_watcher, uv__inotify_read, loop->inotify_fd);
Packit b5b901
  uv__io_start(loop, &loop->inotify_read_watcher, POLLIN);
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv__inotify_fork(uv_loop_t* loop, void* old_watchers) {
Packit b5b901
  /* Open the inotify_fd, and re-arm all the inotify watchers. */
Packit b5b901
  int err;
Packit b5b901
  struct watcher_list* tmp_watcher_list_iter;
Packit b5b901
  struct watcher_list* watcher_list;
Packit b5b901
  struct watcher_list tmp_watcher_list;
Packit b5b901
  QUEUE queue;
Packit b5b901
  QUEUE* q;
Packit b5b901
  uv_fs_event_t* handle;
Packit b5b901
  char* tmp_path;
Packit b5b901
Packit b5b901
  if (old_watchers != NULL) {
Packit b5b901
    /* We must restore the old watcher list to be able to close items
Packit b5b901
     * out of it.
Packit b5b901
     */
Packit b5b901
    loop->inotify_watchers = old_watchers;
Packit b5b901
Packit b5b901
    QUEUE_INIT(&tmp_watcher_list.watchers);
Packit b5b901
    /* Note that the queue we use is shared with the start and stop()
Packit b5b901
     * functions, making QUEUE_FOREACH unsafe to use. So we use the
Packit b5b901
     * QUEUE_MOVE trick to safely iterate. Also don't free the watcher
Packit b5b901
     * list until we're done iterating. c.f. uv__inotify_read.
Packit b5b901
     */
Packit b5b901
    RB_FOREACH_SAFE(watcher_list, watcher_root,
Packit b5b901
                    CAST(&old_watchers), tmp_watcher_list_iter) {
Packit b5b901
      watcher_list->iterating = 1;
Packit b5b901
      QUEUE_MOVE(&watcher_list->watchers, &queue);
Packit b5b901
      while (!QUEUE_EMPTY(&queue)) {
Packit b5b901
        q = QUEUE_HEAD(&queue);
Packit b5b901
        handle = QUEUE_DATA(q, uv_fs_event_t, watchers);
Packit b5b901
        /* It's critical to keep a copy of path here, because it
Packit b5b901
         * will be set to NULL by stop() and then deallocated by
Packit b5b901
         * maybe_free_watcher_list
Packit b5b901
         */
Packit b5b901
        tmp_path = uv__strdup(handle->path);
Packit b5b901
        assert(tmp_path != NULL);
Packit b5b901
        QUEUE_REMOVE(q);
Packit b5b901
        QUEUE_INSERT_TAIL(&watcher_list->watchers, q);
Packit b5b901
        uv_fs_event_stop(handle);
Packit b5b901
Packit b5b901
        QUEUE_INSERT_TAIL(&tmp_watcher_list.watchers, &handle->watchers);
Packit b5b901
        handle->path = tmp_path;
Packit b5b901
      }
Packit b5b901
      watcher_list->iterating = 0;
Packit b5b901
      maybe_free_watcher_list(watcher_list, loop);
Packit b5b901
    }
Packit b5b901
Packit b5b901
    QUEUE_MOVE(&tmp_watcher_list.watchers, &queue);
Packit b5b901
    while (!QUEUE_EMPTY(&queue)) {
Packit b5b901
        q = QUEUE_HEAD(&queue);
Packit b5b901
        QUEUE_REMOVE(q);
Packit b5b901
        handle = QUEUE_DATA(q, uv_fs_event_t, watchers);
Packit b5b901
        tmp_path = handle->path;
Packit b5b901
        handle->path = NULL;
Packit b5b901
        err = uv_fs_event_start(handle, handle->cb, tmp_path, 0);
Packit b5b901
        uv__free(tmp_path);
Packit b5b901
        if (err)
Packit b5b901
          return err;
Packit b5b901
    }
Packit b5b901
  }
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static struct watcher_list* find_watcher(uv_loop_t* loop, int wd) {
Packit b5b901
  struct watcher_list w;
Packit b5b901
  w.wd = wd;
Packit b5b901
  return RB_FIND(watcher_root, CAST(&loop->inotify_watchers), &w);
Packit b5b901
}
Packit b5b901
Packit b5b901
static void maybe_free_watcher_list(struct watcher_list* w, uv_loop_t* loop) {
Packit b5b901
  /* if the watcher_list->watchers is being iterated over, we can't free it. */
Packit b5b901
  if ((!w->iterating) && QUEUE_EMPTY(&w->watchers)) {
Packit b5b901
    /* No watchers left for this path. Clean up. */
Packit b5b901
    RB_REMOVE(watcher_root, CAST(&loop->inotify_watchers), w);
Packit b5b901
    uv__inotify_rm_watch(loop->inotify_fd, w->wd);
Packit b5b901
    uv__free(w);
Packit b5b901
  }
Packit b5b901
}
Packit b5b901
Packit b5b901
static void uv__inotify_read(uv_loop_t* loop,
Packit b5b901
                             uv__io_t* dummy,
Packit b5b901
                             unsigned int events) {
Packit b5b901
  const struct uv__inotify_event* e;
Packit b5b901
  struct watcher_list* w;
Packit b5b901
  uv_fs_event_t* h;
Packit b5b901
  QUEUE queue;
Packit b5b901
  QUEUE* q;
Packit b5b901
  const char* path;
Packit b5b901
  ssize_t size;
Packit b5b901
  const char *p;
Packit b5b901
  /* needs to be large enough for sizeof(inotify_event) + strlen(path) */
Packit b5b901
  char buf[4096];
Packit b5b901
Packit b5b901
  while (1) {
Packit b5b901
    do
Packit b5b901
      size = read(loop->inotify_fd, buf, sizeof(buf));
Packit b5b901
    while (size == -1 && errno == EINTR);
Packit b5b901
Packit b5b901
    if (size == -1) {
Packit b5b901
      assert(errno == EAGAIN || errno == EWOULDBLOCK);
Packit b5b901
      break;
Packit b5b901
    }
Packit b5b901
Packit b5b901
    assert(size > 0); /* pre-2.6.21 thing, size=0 == read buffer too small */
Packit b5b901
Packit b5b901
    /* Now we have one or more inotify_event structs. */
Packit b5b901
    for (p = buf; p < buf + size; p += sizeof(*e) + e->len) {
Packit b5b901
      e = (const struct uv__inotify_event*)p;
Packit b5b901
Packit b5b901
      events = 0;
Packit b5b901
      if (e->mask & (UV__IN_ATTRIB|UV__IN_MODIFY))
Packit b5b901
        events |= UV_CHANGE;
Packit b5b901
      if (e->mask & ~(UV__IN_ATTRIB|UV__IN_MODIFY))
Packit b5b901
        events |= UV_RENAME;
Packit b5b901
Packit b5b901
      w = find_watcher(loop, e->wd);
Packit b5b901
      if (w == NULL)
Packit b5b901
        continue; /* Stale event, no watchers left. */
Packit b5b901
Packit b5b901
      /* inotify does not return the filename when monitoring a single file
Packit b5b901
       * for modifications. Repurpose the filename for API compatibility.
Packit b5b901
       * I'm not convinced this is a good thing, maybe it should go.
Packit b5b901
       */
Packit b5b901
      path = e->len ? (const char*) (e + 1) : uv__basename_r(w->path);
Packit b5b901
Packit b5b901
      /* We're about to iterate over the queue and call user's callbacks.
Packit b5b901
       * What can go wrong?
Packit b5b901
       * A callback could call uv_fs_event_stop()
Packit b5b901
       * and the queue can change under our feet.
Packit b5b901
       * So, we use QUEUE_MOVE() trick to safely iterate over the queue.
Packit b5b901
       * And we don't free the watcher_list until we're done iterating.
Packit b5b901
       *
Packit b5b901
       * First,
Packit b5b901
       * tell uv_fs_event_stop() (that could be called from a user's callback)
Packit b5b901
       * not to free watcher_list.
Packit b5b901
       */
Packit b5b901
      w->iterating = 1;
Packit b5b901
      QUEUE_MOVE(&w->watchers, &queue);
Packit b5b901
      while (!QUEUE_EMPTY(&queue)) {
Packit b5b901
        q = QUEUE_HEAD(&queue);
Packit b5b901
        h = QUEUE_DATA(q, uv_fs_event_t, watchers);
Packit b5b901
Packit b5b901
        QUEUE_REMOVE(q);
Packit b5b901
        QUEUE_INSERT_TAIL(&w->watchers, q);
Packit b5b901
Packit b5b901
        h->cb(h, path, events, 0);
Packit b5b901
      }
Packit b5b901
      /* done iterating, time to (maybe) free empty watcher_list */
Packit b5b901
      w->iterating = 0;
Packit b5b901
      maybe_free_watcher_list(w, loop);
Packit b5b901
    }
Packit b5b901
  }
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv_fs_event_init(uv_loop_t* loop, uv_fs_event_t* handle) {
Packit b5b901
  uv__handle_init(loop, (uv_handle_t*)handle, UV_FS_EVENT);
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv_fs_event_start(uv_fs_event_t* handle,
Packit b5b901
                      uv_fs_event_cb cb,
Packit b5b901
                      const char* path,
Packit b5b901
                      unsigned int flags) {
Packit b5b901
  struct watcher_list* w;
Packit b5b901
  int events;
Packit b5b901
  int err;
Packit b5b901
  int wd;
Packit b5b901
Packit b5b901
  if (uv__is_active(handle))
Packit b5b901
    return UV_EINVAL;
Packit b5b901
Packit b5b901
  err = init_inotify(handle->loop);
Packit b5b901
  if (err)
Packit b5b901
    return err;
Packit b5b901
Packit b5b901
  events = UV__IN_ATTRIB
Packit b5b901
         | UV__IN_CREATE
Packit b5b901
         | UV__IN_MODIFY
Packit b5b901
         | UV__IN_DELETE
Packit b5b901
         | UV__IN_DELETE_SELF
Packit b5b901
         | UV__IN_MOVE_SELF
Packit b5b901
         | UV__IN_MOVED_FROM
Packit b5b901
         | UV__IN_MOVED_TO;
Packit b5b901
Packit b5b901
  wd = uv__inotify_add_watch(handle->loop->inotify_fd, path, events);
Packit b5b901
  if (wd == -1)
Packit b5b901
    return UV__ERR(errno);
Packit b5b901
Packit b5b901
  w = find_watcher(handle->loop, wd);
Packit b5b901
  if (w)
Packit b5b901
    goto no_insert;
Packit b5b901
Packit b5b901
  w = uv__malloc(sizeof(*w) + strlen(path) + 1);
Packit b5b901
  if (w == NULL)
Packit b5b901
    return UV_ENOMEM;
Packit b5b901
Packit b5b901
  w->wd = wd;
Packit b5b901
  w->path = strcpy((char*)(w + 1), path);
Packit b5b901
  QUEUE_INIT(&w->watchers);
Packit b5b901
  w->iterating = 0;
Packit b5b901
  RB_INSERT(watcher_root, CAST(&handle->loop->inotify_watchers), w);
Packit b5b901
Packit b5b901
no_insert:
Packit b5b901
  uv__handle_start(handle);
Packit b5b901
  QUEUE_INSERT_TAIL(&w->watchers, &handle->watchers);
Packit b5b901
  handle->path = w->path;
Packit b5b901
  handle->cb = cb;
Packit b5b901
  handle->wd = wd;
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv_fs_event_stop(uv_fs_event_t* handle) {
Packit b5b901
  struct watcher_list* w;
Packit b5b901
Packit b5b901
  if (!uv__is_active(handle))
Packit b5b901
    return 0;
Packit b5b901
Packit b5b901
  w = find_watcher(handle->loop, handle->wd);
Packit b5b901
  assert(w != NULL);
Packit b5b901
Packit b5b901
  handle->wd = -1;
Packit b5b901
  handle->path = NULL;
Packit b5b901
  uv__handle_stop(handle);
Packit b5b901
  QUEUE_REMOVE(&handle->watchers);
Packit b5b901
Packit b5b901
  maybe_free_watcher_list(w, handle->loop);
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
void uv__fs_event_close(uv_fs_event_t* handle) {
Packit b5b901
  uv_fs_event_stop(handle);
Packit b5b901
}