Blame src/fs-poll.c

Packit b5b901
/* Copyright Joyent, Inc. and other Node 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 "uv-common.h"
Packit b5b901
Packit Service e08953
#ifdef _WIN32
Packit Service e08953
#include "win/internal.h"
Packit Service e08953
#include "win/handle-inl.h"
Packit Service e08953
#define uv__make_close_pending(h) uv_want_endgame((h)->loop, (h))
Packit Service e08953
#else
Packit Service e08953
#include "unix/internal.h"
Packit Service e08953
#endif
Packit Service e08953
Packit b5b901
#include <assert.h>
Packit b5b901
#include <stdlib.h>
Packit b5b901
#include <string.h>
Packit b5b901
Packit b5b901
struct poll_ctx {
Packit Service e08953
  uv_fs_poll_t* parent_handle;
Packit b5b901
  int busy_polling;
Packit b5b901
  unsigned int interval;
Packit b5b901
  uint64_t start_time;
Packit b5b901
  uv_loop_t* loop;
Packit b5b901
  uv_fs_poll_cb poll_cb;
Packit b5b901
  uv_timer_t timer_handle;
Packit b5b901
  uv_fs_t fs_req; /* TODO(bnoordhuis) mark fs_req internal */
Packit b5b901
  uv_stat_t statbuf;
Packit Service e08953
  struct poll_ctx* previous; /* context from previous start()..stop() period */
Packit b5b901
  char path[1]; /* variable length */
Packit b5b901
};
Packit b5b901
Packit b5b901
static int statbuf_eq(const uv_stat_t* a, const uv_stat_t* b);
Packit b5b901
static void poll_cb(uv_fs_t* req);
Packit b5b901
static void timer_cb(uv_timer_t* timer);
Packit b5b901
static void timer_close_cb(uv_handle_t* handle);
Packit b5b901
Packit b5b901
static uv_stat_t zero_statbuf;
Packit b5b901
Packit b5b901
Packit b5b901
int uv_fs_poll_init(uv_loop_t* loop, uv_fs_poll_t* handle) {
Packit b5b901
  uv__handle_init(loop, (uv_handle_t*)handle, UV_FS_POLL);
Packit Service e08953
  handle->poll_ctx = NULL;
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv_fs_poll_start(uv_fs_poll_t* handle,
Packit b5b901
                     uv_fs_poll_cb cb,
Packit b5b901
                     const char* path,
Packit b5b901
                     unsigned int interval) {
Packit b5b901
  struct poll_ctx* ctx;
Packit b5b901
  uv_loop_t* loop;
Packit b5b901
  size_t len;
Packit b5b901
  int err;
Packit b5b901
Packit Service e08953
  if (uv_is_active((uv_handle_t*)handle))
Packit b5b901
    return 0;
Packit b5b901
Packit b5b901
  loop = handle->loop;
Packit b5b901
  len = strlen(path);
Packit b5b901
  ctx = uv__calloc(1, sizeof(*ctx) + len);
Packit b5b901
Packit b5b901
  if (ctx == NULL)
Packit b5b901
    return UV_ENOMEM;
Packit b5b901
Packit b5b901
  ctx->loop = loop;
Packit b5b901
  ctx->poll_cb = cb;
Packit b5b901
  ctx->interval = interval ? interval : 1;
Packit b5b901
  ctx->start_time = uv_now(loop);
Packit b5b901
  ctx->parent_handle = handle;
Packit b5b901
  memcpy(ctx->path, path, len + 1);
Packit b5b901
Packit b5b901
  err = uv_timer_init(loop, &ctx->timer_handle);
Packit b5b901
  if (err < 0)
Packit b5b901
    goto error;
Packit b5b901
Packit b5b901
  ctx->timer_handle.flags |= UV_HANDLE_INTERNAL;
Packit b5b901
  uv__handle_unref(&ctx->timer_handle);
Packit b5b901
Packit b5b901
  err = uv_fs_stat(loop, &ctx->fs_req, ctx->path, poll_cb);
Packit b5b901
  if (err < 0)
Packit b5b901
    goto error;
Packit b5b901
Packit Service e08953
  if (handle->poll_ctx != NULL)
Packit Service e08953
    ctx->previous = handle->poll_ctx;
Packit b5b901
  handle->poll_ctx = ctx;
Packit b5b901
  uv__handle_start(handle);
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
Packit b5b901
error:
Packit b5b901
  uv__free(ctx);
Packit b5b901
  return err;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv_fs_poll_stop(uv_fs_poll_t* handle) {
Packit b5b901
  struct poll_ctx* ctx;
Packit b5b901
Packit Service e08953
  if (!uv_is_active((uv_handle_t*)handle))
Packit b5b901
    return 0;
Packit b5b901
Packit b5b901
  ctx = handle->poll_ctx;
Packit b5b901
  assert(ctx != NULL);
Packit Service e08953
  assert(ctx->parent_handle == handle);
Packit b5b901
Packit b5b901
  /* Close the timer if it's active. If it's inactive, there's a stat request
Packit b5b901
   * in progress and poll_cb will take care of the cleanup.
Packit b5b901
   */
Packit Service e08953
  if (uv_is_active((uv_handle_t*)&ctx->timer_handle))
Packit b5b901
    uv_close((uv_handle_t*)&ctx->timer_handle, timer_close_cb);
Packit b5b901
Packit b5b901
  uv__handle_stop(handle);
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
int uv_fs_poll_getpath(uv_fs_poll_t* handle, char* buffer, size_t* size) {
Packit b5b901
  struct poll_ctx* ctx;
Packit b5b901
  size_t required_len;
Packit b5b901
Packit Service e08953
  if (!uv_is_active((uv_handle_t*)handle)) {
Packit b5b901
    *size = 0;
Packit b5b901
    return UV_EINVAL;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  ctx = handle->poll_ctx;
Packit b5b901
  assert(ctx != NULL);
Packit b5b901
Packit b5b901
  required_len = strlen(ctx->path);
Packit b5b901
  if (required_len >= *size) {
Packit b5b901
    *size = required_len + 1;
Packit b5b901
    return UV_ENOBUFS;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  memcpy(buffer, ctx->path, required_len);
Packit b5b901
  *size = required_len;
Packit b5b901
  buffer[required_len] = '\0';
Packit b5b901
Packit b5b901
  return 0;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
void uv__fs_poll_close(uv_fs_poll_t* handle) {
Packit b5b901
  uv_fs_poll_stop(handle);
Packit Service e08953
Packit Service e08953
  if (handle->poll_ctx == NULL)
Packit Service e08953
    uv__make_close_pending((uv_handle_t*)handle);
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static void timer_cb(uv_timer_t* timer) {
Packit b5b901
  struct poll_ctx* ctx;
Packit b5b901
Packit b5b901
  ctx = container_of(timer, struct poll_ctx, timer_handle);
Packit b5b901
  assert(ctx->parent_handle != NULL);
Packit b5b901
  assert(ctx->parent_handle->poll_ctx == ctx);
Packit b5b901
  ctx->start_time = uv_now(ctx->loop);
Packit b5b901
Packit b5b901
  if (uv_fs_stat(ctx->loop, &ctx->fs_req, ctx->path, poll_cb))
Packit b5b901
    abort();
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static void poll_cb(uv_fs_t* req) {
Packit b5b901
  uv_stat_t* statbuf;
Packit b5b901
  struct poll_ctx* ctx;
Packit b5b901
  uint64_t interval;
Packit Service e08953
  uv_fs_poll_t* handle;
Packit b5b901
Packit b5b901
  ctx = container_of(req, struct poll_ctx, fs_req);
Packit Service e08953
  handle = ctx->parent_handle;
Packit b5b901
Packit Service e08953
  if (!uv_is_active((uv_handle_t*)handle) || uv__is_closing(handle))
Packit Service e08953
    goto out;
Packit b5b901
Packit b5b901
  if (req->result != 0) {
Packit b5b901
    if (ctx->busy_polling != req->result) {
Packit b5b901
      ctx->poll_cb(ctx->parent_handle,
Packit b5b901
                   req->result,
Packit b5b901
                   &ctx->statbuf,
Packit b5b901
                   &zero_statbuf);
Packit b5b901
      ctx->busy_polling = req->result;
Packit b5b901
    }
Packit b5b901
    goto out;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  statbuf = &req->statbuf;
Packit b5b901
Packit b5b901
  if (ctx->busy_polling != 0)
Packit b5b901
    if (ctx->busy_polling < 0 || !statbuf_eq(&ctx->statbuf, statbuf))
Packit b5b901
      ctx->poll_cb(ctx->parent_handle, 0, &ctx->statbuf, statbuf);
Packit b5b901
Packit b5b901
  ctx->statbuf = *statbuf;
Packit b5b901
  ctx->busy_polling = 1;
Packit b5b901
Packit b5b901
out:
Packit b5b901
  uv_fs_req_cleanup(req);
Packit b5b901
Packit Service e08953
  if (!uv_is_active((uv_handle_t*)handle) || uv__is_closing(handle)) {
Packit b5b901
    uv_close((uv_handle_t*)&ctx->timer_handle, timer_close_cb);
Packit b5b901
    return;
Packit b5b901
  }
Packit b5b901
Packit b5b901
  /* Reschedule timer, subtract the delay from doing the stat(). */
Packit b5b901
  interval = ctx->interval;
Packit b5b901
  interval -= (uv_now(ctx->loop) - ctx->start_time) % interval;
Packit b5b901
Packit b5b901
  if (uv_timer_start(&ctx->timer_handle, timer_cb, interval, 0))
Packit b5b901
    abort();
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit Service e08953
static void timer_close_cb(uv_handle_t* timer) {
Packit Service e08953
  struct poll_ctx* ctx;
Packit Service e08953
  struct poll_ctx* it;
Packit Service e08953
  struct poll_ctx* last;
Packit Service e08953
  uv_fs_poll_t* handle;
Packit Service e08953
Packit Service e08953
  ctx = container_of(timer, struct poll_ctx, timer_handle);
Packit Service e08953
  handle = ctx->parent_handle;
Packit Service e08953
  if (ctx == handle->poll_ctx) {
Packit Service e08953
    handle->poll_ctx = ctx->previous;
Packit Service e08953
    if (handle->poll_ctx == NULL && uv__is_closing(handle))
Packit Service e08953
      uv__make_close_pending((uv_handle_t*)handle);
Packit Service e08953
  } else {
Packit Service e08953
    for (last = handle->poll_ctx, it = last->previous;
Packit Service e08953
         it != ctx;
Packit Service e08953
         last = it, it = it->previous) {
Packit Service e08953
      assert(last->previous != NULL);
Packit Service e08953
    }
Packit Service e08953
    last->previous = ctx->previous;
Packit Service e08953
  }
Packit Service e08953
  uv__free(ctx);
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
static int statbuf_eq(const uv_stat_t* a, const uv_stat_t* b) {
Packit b5b901
  return a->st_ctim.tv_nsec == b->st_ctim.tv_nsec
Packit b5b901
      && a->st_mtim.tv_nsec == b->st_mtim.tv_nsec
Packit b5b901
      && a->st_birthtim.tv_nsec == b->st_birthtim.tv_nsec
Packit b5b901
      && a->st_ctim.tv_sec == b->st_ctim.tv_sec
Packit b5b901
      && a->st_mtim.tv_sec == b->st_mtim.tv_sec
Packit b5b901
      && a->st_birthtim.tv_sec == b->st_birthtim.tv_sec
Packit b5b901
      && a->st_size == b->st_size
Packit b5b901
      && a->st_mode == b->st_mode
Packit b5b901
      && a->st_uid == b->st_uid
Packit b5b901
      && a->st_gid == b->st_gid
Packit b5b901
      && a->st_ino == b->st_ino
Packit b5b901
      && a->st_dev == b->st_dev
Packit b5b901
      && a->st_flags == b->st_flags
Packit b5b901
      && a->st_gen == b->st_gen;
Packit b5b901
}
Packit b5b901
Packit b5b901
Packit b5b901
#if defined(_WIN32)
Packit b5b901
Packit b5b901
#include "win/internal.h"
Packit b5b901
#include "win/handle-inl.h"
Packit b5b901
Packit b5b901
void uv__fs_poll_endgame(uv_loop_t* loop, uv_fs_poll_t* handle) {
Packit b5b901
  assert(handle->flags & UV_HANDLE_CLOSING);
Packit b5b901
  assert(!(handle->flags & UV_HANDLE_CLOSED));
Packit b5b901
  uv__handle_close(handle);
Packit b5b901
}
Packit b5b901
Packit b5b901
#endif /* _WIN32 */