zookeeper 0.4.4 → 0.9.3

data/ext/zkrb_wrapper.h

@@ -0,0 +1,330 @@
+#ifndef ZKRB_WRAPPER_H
+#define ZKRB_WRAPPER_H
+#if 0
+
+  AUTOGENERATED BY generate_gvl_code.rb 
+
+#endif
+
+#include "ruby.h"
+#include "c-client-src/zookeeper.h"
+#include "zkrb_wrapper_compat.h"
+#include "dbg.h"
+
+#define ZKRB_FAIL -1
+
+typedef struct {
+  zhandle_t *zh;
+  int rc;
+} zkrb_zoo_recv_timeout_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  int rc;
+} zkrb_zoo_state_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  const char *value;
+  int valuelen;
+  const struct ACL_vector *acl;
+  int flags;
+  string_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_acreate_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int version;
+  void_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_adelete_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  stat_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_aexists_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  stat_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_awexists_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  data_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_aget_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  data_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_awget_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  const char *buffer;
+  int buflen;
+  int version;
+  stat_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_aset_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  strings_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_aget_children_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  strings_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_awget_children_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  strings_stat_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_aget_children2_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  strings_stat_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_awget_children2_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  string_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_async_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  acl_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_aget_acl_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int version;
+  struct ACL_vector *acl;
+  void_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_aset_acl_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char* scheme;
+  const char* cert;
+  int certLen;
+  void_completion_t completion;
+  const void *data;
+  int rc;
+} zkrb_zoo_add_auth_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  const char *value;
+  int valuelen;
+  const struct ACL_vector *acl;
+  int flags;
+  char *path_buffer;
+  int path_buffer_len;
+  int rc;
+} zkrb_zoo_create_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int version;
+  int rc;
+} zkrb_zoo_delete_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_exists_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_wexists_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  char *buffer;
+  int* buffer_len;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_get_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  char *buffer;
+  int* buffer_len;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_wget_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  const char *buffer;
+  int buflen;
+  int version;
+  int rc;
+} zkrb_zoo_set_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  const char *buffer;
+  int buflen;
+  int version;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_set2_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  struct String_vector *strings;
+  int rc;
+} zkrb_zoo_get_children_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  struct String_vector *strings;
+  int rc;
+} zkrb_zoo_wget_children_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int watch;
+  struct String_vector *strings;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_get_children2_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  watcher_fn watcher;
+  void* watcherCtx;
+  struct String_vector *strings;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_wget_children2_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  struct ACL_vector *acl;
+  struct Stat *stat;
+  int rc;
+} zkrb_zoo_get_acl_args_t;
+
+typedef struct {
+  zhandle_t *zh;
+  const char *path;
+  int version;
+  const struct ACL_vector *acl;
+  int rc;
+} zkrb_zoo_set_acl_args_t;
+
+int zkrb_call_zoo_recv_timeout(zhandle_t *zh);
+int zkrb_call_zoo_state(zhandle_t *zh);
+int zkrb_call_zoo_acreate(zhandle_t *zh, const char *path, const char *value, int valuelen, const struct ACL_vector *acl, int flags, string_completion_t completion, const void *data);
+int zkrb_call_zoo_adelete(zhandle_t *zh, const char *path, int version, void_completion_t completion, const void *data);
+int zkrb_call_zoo_aexists(zhandle_t *zh, const char *path, int watch, stat_completion_t completion, const void *data);
+int zkrb_call_zoo_awexists(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, stat_completion_t completion, const void *data);
+int zkrb_call_zoo_aget(zhandle_t *zh, const char *path, int watch, data_completion_t completion, const void *data);
+int zkrb_call_zoo_awget(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, data_completion_t completion, const void *data);
+int zkrb_call_zoo_aset(zhandle_t *zh, const char *path, const char *buffer, int buflen, int version, stat_completion_t completion, const void *data);
+int zkrb_call_zoo_aget_children(zhandle_t *zh, const char *path, int watch, strings_completion_t completion, const void *data);
+int zkrb_call_zoo_awget_children(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, strings_completion_t completion, const void *data);
+int zkrb_call_zoo_aget_children2(zhandle_t *zh, const char *path, int watch, strings_stat_completion_t completion, const void *data);
+int zkrb_call_zoo_awget_children2(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, strings_stat_completion_t completion, const void *data);
+int zkrb_call_zoo_async(zhandle_t *zh, const char *path, string_completion_t completion, const void *data);
+int zkrb_call_zoo_aget_acl(zhandle_t *zh, const char *path, acl_completion_t completion, const void *data);
+int zkrb_call_zoo_aset_acl(zhandle_t *zh, const char *path, int version, struct ACL_vector *acl, void_completion_t completion, const void *data);
+int zkrb_call_zoo_add_auth(zhandle_t *zh, const char* scheme, const char* cert, int certLen, void_completion_t completion, const void *data);
+int zkrb_call_zoo_create(zhandle_t *zh, const char *path, const char *value, int valuelen, const struct ACL_vector *acl, int flags, char *path_buffer, int path_buffer_len);
+int zkrb_call_zoo_delete(zhandle_t *zh, const char *path, int version);
+int zkrb_call_zoo_exists(zhandle_t *zh, const char *path, int watch, struct Stat *stat);
+int zkrb_call_zoo_wexists(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, struct Stat *stat);
+int zkrb_call_zoo_get(zhandle_t *zh, const char *path, int watch, char *buffer, int* buffer_len, struct Stat *stat);
+int zkrb_call_zoo_wget(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, char *buffer, int* buffer_len, struct Stat *stat);
+int zkrb_call_zoo_set(zhandle_t *zh, const char *path, const char *buffer, int buflen, int version);
+int zkrb_call_zoo_set2(zhandle_t *zh, const char *path, const char *buffer, int buflen, int version, struct Stat *stat);
+int zkrb_call_zoo_get_children(zhandle_t *zh, const char *path, int watch, struct String_vector *strings);
+int zkrb_call_zoo_wget_children(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, struct String_vector *strings);
+int zkrb_call_zoo_get_children2(zhandle_t *zh, const char *path, int watch, struct String_vector *strings, struct Stat *stat);
+int zkrb_call_zoo_wget_children2(zhandle_t *zh, const char *path, watcher_fn watcher, void* watcherCtx, struct String_vector *strings, struct Stat *stat);
+int zkrb_call_zoo_get_acl(zhandle_t *zh, const char *path, struct ACL_vector *acl, struct Stat *stat);
+int zkrb_call_zoo_set_acl(zhandle_t *zh, const char *path, int version, const struct ACL_vector *acl);
+
+#endif /* ZKRB_WRAPPER_H */

data/ext/zkrb_wrapper_compat.c

@@ -0,0 +1,15 @@
+#include "ruby.h"
+#include "zkrb_wrapper_compat.h"
+
+
+VALUE zkrb_thread_blocking_region(zkrb_blocking_function_t *func, void *data1) {
+
+#ifdef ZKRB_RUBY_187
+  return func(data1);
+#else
+  return rb_thread_blocking_region((rb_blocking_function_t *)func, data1, RUBY_UBF_IO, 0);
+#endif
+
+}
+
+// vim:sts=2:sw=2:et

data/ext/zkrb_wrapper_compat.h

@@ -0,0 +1,11 @@
+#ifndef ZKRB_WRAPPER_COMPAT_H
+#define ZKRB_WRAPPER_COMPAT_H
+
+typedef VALUE zkrb_blocking_function_t(void *);
+typedef void zkrb_unblock_function_t(void *);
+
+// delegates to rb_thread_blocking_region on 1.9.x, always uses UBF_IO
+VALUE zkrb_thread_blocking_region(zkrb_blocking_function_t *func, void *data1);
+
+
+#endif /* ZKRB_WRAPPER_COMPAT_H */

data/ext/zookeeper_base.rb

@@ -0,0 +1,211 @@
+require File.expand_path('../c_zookeeper', __FILE__)
+require 'forwardable'
+
+# The low-level wrapper-specific methods for the C lib
+# subclassed by the top-level Zookeeper class
+class ZookeeperBase
+  extend Forwardable
+  include ZookeeperCommon
+  include ZookeeperCallbacks
+  include ZookeeperConstants
+  include ZookeeperExceptions
+  include ZookeeperACLs
+  include ZookeeperStat
+
+  # @private
+  class ClientShutdownException < StandardError; end
+
+  # @private
+  KILL_TOKEN = Object.new unless defined?(KILL_TOKEN)
+
+  ZKRB_GLOBAL_CB_REQ   = -1
+
+  # debug levels
+  ZOO_LOG_LEVEL_ERROR  = 1
+  ZOO_LOG_LEVEL_WARN   = 2
+  ZOO_LOG_LEVEL_INFO   = 3
+  ZOO_LOG_LEVEL_DEBUG  = 4
+
+  def_delegators :czk, 
+    :get_children, :exists, :delete, :get, :set, :set_acl, :get_acl, :client_id, :sync, :selectable_io
+
+  # some state methods need to be more paranoid about locking to ensure the correct
+  # state is returned
+  # 
+  def self.threadsafe_inquisitor(*syms)
+    syms.each do |sym|
+      class_eval(<<-EOM, __FILE__, __LINE__+1)
+        def #{sym}
+          false|@mutex.synchronize { @czk and @czk.#{sym} }
+        end
+      EOM
+    end
+  end
+
+  threadsafe_inquisitor :connected?, :connecting?, :associating?, :running?
+
+  attr_reader :event_queue
+ 
+  def reopen(timeout = 10, watcher=nil)
+    if watcher and (watcher != @default_watcher)
+      raise "You cannot set the watcher to a different value this way anymore!"
+    end
+    
+    @mutex.synchronize do
+      # flushes all outstanding watcher reqs.
+      @watcher_reqs.clear
+      set_default_global_watcher
+
+      orig_czk, @czk = @czk, CZookeeper.new(@host, @event_queue)
+
+      orig_czk.close if orig_czk
+      
+      @czk.wait_until_connected(timeout)
+    end
+
+    setup_dispatch_thread!
+    state
+  end
+
+  def initialize(host, timeout = 10, watcher=nil)
+    @watcher_reqs = {}
+    @completion_reqs = {}
+
+    @mutex = Monitor.new
+    @dispatch_shutdown_cond = @mutex.new_cond
+
+    @current_req_id = 0
+    @event_queue = QueueWithPipe.new
+    @czk = nil
+    
+    # approximate the java behavior of raising java.lang.IllegalArgumentException if the host
+    # argument ends with '/'
+    raise ArgumentError, "Host argument #{host.inspect} may not end with /" if host.end_with?('/')
+
+    @host = host
+
+    @default_watcher = (watcher or get_default_global_watcher)
+
+    yield self if block_given?
+
+    reopen(timeout)
+  end
+
+  # synchronized accessor to the @czk instance
+  # @private
+  def czk
+    @mutex.synchronize { @czk }
+  end
+  
+  # if either of these happen, the user will need to renegotiate a connection via reopen
+  def assert_open
+    raise ZookeeperException::SessionExpired if state == ZOO_EXPIRED_SESSION_STATE
+    raise ZookeeperException::NotConnected   unless connected?
+  end
+
+  def close
+    shutdown_thread = Thread.new do
+      @mutex.synchronize do
+        stop_dispatch_thread!
+        @czk.close
+      end
+    end
+
+    shutdown_thread.join unless event_dispatch_thread?
+  end
+
+  # the C lib doesn't strip the chroot path off of returned path values, which
+  # is pretty damn annoying. this is used to clean things up.
+  def create(*args)
+    # since we don't care about the inputs, just glob args
+    rc, new_path = czk.create(*args)
+    [rc, strip_chroot_from(new_path)]
+  end
+
+  def set_debug_level(int)
+    warn "DEPRECATION WARNING: #{self.class.name}#set_debug_level, it has moved to the class level and will be removed in a future release"
+    self.class.set_debug_level(int)
+  end
+
+  # set the watcher object/proc that will receive all global events (such as session/state events)
+  def set_default_global_watcher
+    warn "DEPRECATION WARNING: #{self.class}#set_default_global_watcher ignores block" if block_given?
+
+    @mutex.synchronize do
+#       @default_watcher = block # save this here for reopen() to use
+      @watcher_reqs[ZKRB_GLOBAL_CB_REQ] = { :watcher => @default_watcher, :watcher_context => nil }
+    end
+  end
+
+  def state
+    return ZOO_CLOSED_STATE if closed?
+    czk.state
+  end
+
+  def session_id
+    cid = client_id and cid.session_id
+  end
+
+  def session_passwd
+    cid = client_id and cid.passwd
+  end
+
+  # we are closed if there is no @czk instance or @czk.closed?
+  def closed?
+    @mutex.synchronize { !@czk or @czk.closed? } 
+  end
+ 
+protected
+  # this is a hack: to provide consistency between the C and Java drivers when
+  # using a chrooted connection, we wrap the callback in a block that will
+  # strip the chroot path from the returned path (important in an async create
+  # sequential call). This is the only place where we can hook *just* the C
+  # version. The non-async manipulation is handled in ZookeeperBase#create.
+  # 
+  def setup_completion(req_id, meth_name, call_opts)
+    if (meth_name == :create) and cb = call_opts[:callback]
+      call_opts[:callback] = lambda do |hash|
+        # in this case the string will be the absolute zookeeper path (i.e.
+        # with the chroot still prepended to the path). Here's where we strip it off
+        hash[:string] = strip_chroot_from(hash[:string])
+
+        # call the original callback
+        cb.call(hash)
+      end
+    end
+
+    # pass this along to the ZookeeperCommon implementation
+    super(req_id, meth_name, call_opts)
+  end
+
+  # if we're chrooted, this method will strip the chroot prefix from +path+
+  def strip_chroot_from(path)
+    return path unless (chrooted? and path and path.start_with?(chroot_path))
+    path[chroot_path.length..-1]
+  end
+
+  def get_default_global_watcher
+    Proc.new { |args|
+      logger.debug { "Ruby ZK Global CB called type=#{event_by_value(args[:type])} state=#{state_by_value(args[:state])}" }
+      true
+    }
+  end
+
+  def chrooted?
+    !chroot_path.empty?
+  end
+
+  def chroot_path
+    if @chroot_path.nil?
+      @chroot_path = 
+        if idx = @host.index('/')
+          @host.slice(idx, @host.length)
+        else
+          ''
+        end
+    end
+
+    @chroot_path
+  end
+end
+