slyphon-zookeeper 0.1.4 → 0.1.6

data/CHANGELOG

@@ -1,5 +1,8 @@
-v0.4.3 Fix a handful of memory-related bugs, fix SIGSEGV on master change,
-       reduce latency of event handling, fix compilation on OSX.
+v0.4.5 Upgrade to ZooKeeper 3.3.3
+
+v0.4.4 Fix race condition on close, possible data corruption on async get.
+
+v0.4.3 Fix a handful of memory-related bugs, fix SIGSEGV on master change, reduce latency of event handling, fix compilation on OSX.
 
 v0.4.2 Add options to Zookeeper#initialize, silence most Zookeeper logs.
 

data/Rakefile

@@ -1,15 +1,3 @@
-require 'echoe'
-
-Echoe.new("zookeeper") do |p|
-  p.author = "Phillip Pearson, Eric Maland, Evan Weaver, Brian Wickman"
-  p.project = "fauna"
-  p.summary = "An interface to the Zookeeper distributed configuration server."
-  p.url = "https://github.com/twitter/zookeeper"
-  p.docs_host = "blog.evanweaver.com:~/www/bax/public/files/doc/"
-  p.clean_pattern += ["ext/lib", "ext/include", "ext/c", "ext/bin", "ext/conftest.dSYM"]
-  p.rdoc_pattern = /README|TODO|LICENSE|CHANGELOG|BENCH|COMPAT|zookeeper_c.c|zookeeper.rb/
-end
-
 namespace :mb do
   task :build_gems do
     sh "gem build slyphon-zookeeper.gemspec"
@@ -17,3 +5,4 @@ namespace :mb do
     sh "gem build slyphon-zookeeper.gemspec"
   end
 end
+

data/ext/zookeeper_base.rb

@@ -49,6 +49,9 @@ class ZookeeperBase < CZookeeper
     watcher ||= get_default_global_watcher
 
     @_running = nil # used by the C layer
+
+    yield self if block_given?
+
     reopen(timeout, watcher)
     return nil unless connected?
     setup_dispatch_thread!
@@ -73,7 +76,7 @@ class ZookeeperBase < CZookeeper
   end
 
   def close
-    @_running = false;
+    @_running = false
     wake_event_loop!
     
     @dispatcher.join

data/ext/zookeeper_c.c

@@ -106,7 +106,7 @@ static VALUE method_init(int argc, VALUE* argv, VALUE self) {
   zkrb_calling_context *ctx =
     zkrb_calling_context_alloc(ZKRB_GLOBAL_REQ, zk_local_ctx->queue);
 
-  zk_local_ctx->zh = 
+  zk_local_ctx->zh =
       zookeeper_init(
           RSTRING_PTR(hostPort),
           zkrb_state_callback,
@@ -114,7 +114,7 @@ static VALUE method_init(int argc, VALUE* argv, VALUE self) {
           &zk_local_ctx->myid,
           ctx,
           0);
-  
+
 #warning [wickman] TODO handle this properly on the Ruby side rather than C side
   if (!zk_local_ctx->zh) {
     rb_raise(rb_eRuntimeError, "error connecting to zookeeper: %d", errno);
@@ -158,10 +158,10 @@ static VALUE method_init(int argc, VALUE* argv, VALUE self) {
 
 static VALUE method_get_children(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE watch) {
   STANDARD_PREAMBLE(self, zk, reqid, path, async, watch, data_ctx, watch_ctx, call_type);
-  
+
   struct String_vector strings;
   struct Stat stat;
-  
+
   int rc;
   switch (call_type) {
     case SYNC:
@@ -171,11 +171,11 @@ static VALUE method_get_children(VALUE self, VALUE reqid, VALUE path, VALUE asyn
     case SYNC_WATCH:
       rc = zoo_wget_children2(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, &strings, &stat);
       break;
-      
+
     case ASYNC:
       rc = zoo_aget_children2(zk->zh, RSTRING_PTR(path), 0, zkrb_strings_stat_callback, data_ctx);
       break;
-      
+
     case ASYNC_WATCH:
       rc = zoo_awget_children2(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, zkrb_strings_stat_callback, data_ctx);
       break;
@@ -192,7 +192,7 @@ static VALUE method_get_children(VALUE self, VALUE reqid, VALUE path, VALUE asyn
 
 static VALUE method_exists(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE watch) {
   STANDARD_PREAMBLE(self, zk, reqid, path, async, watch, data_ctx, watch_ctx, call_type);
-  
+
   struct Stat stat;
 
   int rc;
@@ -204,11 +204,11 @@ static VALUE method_exists(VALUE self, VALUE reqid, VALUE path, VALUE async, VAL
     case SYNC_WATCH:
       rc = zoo_wexists(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, &stat);
       break;
-      
+
     case ASYNC:
       rc = zoo_aexists(zk->zh, RSTRING_PTR(path), 0, zkrb_stat_callback, data_ctx);
       break;
-      
+
     case ASYNC_WATCH:
       rc = zoo_awexists(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, zkrb_stat_callback, data_ctx);
       break;
@@ -225,12 +225,12 @@ static VALUE method_exists(VALUE self, VALUE reqid, VALUE path, VALUE async, VAL
 static VALUE method_create(VALUE self, VALUE reqid, VALUE path, VALUE data, VALUE async, VALUE acls, VALUE flags) {
   VALUE watch = Qfalse;
   STANDARD_PREAMBLE(self, zk, reqid, path, async, watch, data_ctx, watch_ctx, call_type);
-  
+
   if (data != Qnil) Check_Type(data, T_STRING);
   Check_Type(flags, T_FIXNUM);
   const char *data_ptr = (data == Qnil) ? NULL : RSTRING_PTR(data);
   size_t      data_len = (data == Qnil) ? -1   : RSTRING_LEN(data);
-  
+
   struct ACL_vector *aclptr = NULL;
   if (acls != Qnil) { aclptr = zkrb_ruby_to_aclvector(acls); }
   char realpath[16384];
@@ -263,10 +263,10 @@ static VALUE method_create(VALUE self, VALUE reqid, VALUE path, VALUE data, VALU
 }
 
 static VALUE method_delete(VALUE self, VALUE reqid, VALUE path, VALUE version, VALUE async) {
-  VALUE watch = Qfalse; 
+  VALUE watch = Qfalse;
   STANDARD_PREAMBLE(self, zk, reqid, path, async, watch, data_ctx, watch_ctx, call_type);
   Check_Type(version, T_FIXNUM);
-  
+
   int rc = 0;
   switch (call_type) {
     case SYNC:
@@ -295,7 +295,7 @@ static VALUE method_get(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE
   struct Stat stat;
 
   int rc;
-  
+
   switch (call_type) {
     case SYNC:
       rc = zoo_get(zk->zh, RSTRING_PTR(path), 0, data, &data_len, &stat);
@@ -304,11 +304,11 @@ static VALUE method_get(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE
     case SYNC_WATCH:
       rc = zoo_wget(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, data, &data_len, &stat);
       break;
-      
+
     case ASYNC:
       rc = zoo_aget(zk->zh, RSTRING_PTR(path), 0, zkrb_data_callback, data_ctx);
       break;
-      
+
     case ASYNC_WATCH:
       rc = zoo_awget(zk->zh, RSTRING_PTR(path), zkrb_state_callback, watch_ctx, zkrb_data_callback, data_ctx);
       break;
@@ -331,7 +331,7 @@ static VALUE method_get(VALUE self, VALUE reqid, VALUE path, VALUE async, VALUE
 static VALUE method_set(VALUE self, VALUE reqid, VALUE path, VALUE data, VALUE async, VALUE version) {
   VALUE watch = Qfalse;
   STANDARD_PREAMBLE(self, zk, reqid, path, async, watch, data_ctx, watch_ctx, call_type);
-  
+
   struct Stat stat;
   if (data != Qnil) Check_Type(data, T_STRING);
   const char *data_ptr = (data == Qnil) ? NULL : RSTRING_PTR(data);
@@ -391,7 +391,7 @@ static VALUE method_get_acl(VALUE self, VALUE reqid, VALUE path, VALUE async) {
 
   struct ACL_vector acls;
   struct Stat stat;
-  
+
   int rc;
   switch (call_type) {
     case SYNC:
@@ -426,6 +426,10 @@ static VALUE method_get_next_event(VALUE self) {
   FETCH_DATA_PTR(self, zk);
 
   for (;;) {
+
+    // we use the is_running(self) method here because it allows us to have a
+    // ruby-land semaphore that we can also use in the java extension
+    //
     if (!is_running(self)) {
 /*      fprintf(stderr, "method_get_next_event: running is false, returning nil\n");*/
       return Qnil;  // this case for shutdown
@@ -433,12 +437,7 @@ static VALUE method_get_next_event(VALUE self) {
 
     zkrb_event_t *event = zkrb_dequeue(zk->queue, 1);
 
-    /*
-     * If no events found, wait for an event by using rb_thread_select() on the
-     * queue's pipe. Note that the ZK handle might be closed while we're
-     * waiting; if this happens, the rb_thread_select() will fail, and we can't
-     * safely touch the "zk" instance handle.
-     */
+    /* Wait for an event using rb_thread_select() on the queue's pipe */
     if (event == NULL) {
       int fd = zk->queue->pipe_read;
       fd_set rset;
@@ -475,18 +474,25 @@ static VALUE method_client_id(VALUE self) {
   return UINT2NUM(id->client_id);
 }
 
+
 // wake up the event loop, used when shutting down
 static VALUE method_wake_event_loop_bang(VALUE self) {
   FETCH_DATA_PTR(self, zk); 
 
-  ssize_t ret = write(zk->queue->pipe_write, "0", 1);   /* Wake up Ruby listener */
-
-  if (ret == -1)
-    rb_raise(rb_eRuntimeError, "write to pipe failed: %d", errno);
+  zkrb_signal(zk->queue);
 
   return Qnil;
 };
 
+// static VALUE method_signal_pending_close(VALUE self) {
+//   FETCH_DATA_PTR(self, zk);
+// 
+//   zk->pending_close = 1;
+//   zkrb_signal(zk->queue);
+// 
+//   return Qnil;
+// }
+
 static VALUE method_close(VALUE self) {
   FETCH_DATA_PTR(self, zk);
 
@@ -541,7 +547,7 @@ static void zkrb_define_methods(void) {
   DEFINE_METHOD(get, 4);
   DEFINE_METHOD(set, 5);
   DEFINE_METHOD(set_acl, 5);
-  DEFINE_METHOD(get_acl, 3);  
+  DEFINE_METHOD(get_acl, 3);
   DEFINE_METHOD(client_id, 0);
   DEFINE_METHOD(close, 0);
   DEFINE_METHOD(deterministic_conn_order, 1);
@@ -552,11 +558,11 @@ static void zkrb_define_methods(void) {
   // DEFINE_METHOD(add_auth, 3);
   // DEFINE_METHOD(async, 1);
 
-  // methods for the ruby-side event manager  
+  // methods for the ruby-side event manager
   DEFINE_METHOD(get_next_event, 0);
   DEFINE_METHOD(has_events, 0);
 
-  // Make these class methods?  
+  // Make these class methods?
   DEFINE_METHOD(set_debug_level, 1);
   DEFINE_METHOD(zerror, 1);
 

data/ext/zookeeper_lib.c

@@ -69,6 +69,14 @@ zkrb_event_t* zkrb_dequeue(zkrb_queue_t *q, int need_lock) {
   }
 }
 
+void zkrb_signal(zkrb_queue_t *q) {
+  pthread_mutex_lock(&zkrb_q_mutex);
+  ssize_t ret = write(q->pipe_write, "0", 1);   /* Wake up Ruby listener */
+  pthread_mutex_unlock(&zkrb_q_mutex);
+  if (ret == -1)
+    rb_raise(rb_eRuntimeError, "write to pipe failed: %d", errno);
+}
+
 zkrb_queue_t *zkrb_queue_alloc(void) {
   int pfd[2];
   if (pipe(pfd) == -1)
@@ -194,7 +202,7 @@ VALUE zkrb_event_to_ruby(zkrb_event_t *event) {
     case ZKRB_STAT: {
       struct zkrb_stat_completion *stat_ctx = event->completion.stat_completion;
       rb_hash_aset(hash, GET_SYM("stat"), stat_ctx->stat ? zkrb_stat_to_rarray(stat_ctx->stat) : Qnil);
-      break;      
+      break;
     }
     case ZKRB_STRING: {
       struct zkrb_string_completion *string_ctx = event->completion.string_completion;
@@ -342,7 +350,7 @@ void zkrb_data_callback(
   event->rc = rc;
   event->type = ZKRB_DATA;
   event->completion.data_completion = dc;
-  
+
   zkrb_enqueue(queue, event);
 }
 
@@ -361,7 +369,7 @@ void zkrb_stat_callback(
   event->rc = rc;
   event->type = ZKRB_STAT;
   event->completion.stat_completion = sc;
-  
+
   zkrb_enqueue(queue, event);
 }
 
@@ -381,7 +389,7 @@ void zkrb_string_callback(
   event->rc = rc;
   event->type = ZKRB_STRING;
   event->completion.string_completion = sc;
-  
+
   zkrb_enqueue(queue, event);
 }
 
@@ -400,7 +408,7 @@ void zkrb_strings_callback(
   event->rc = rc;
   event->type = ZKRB_STRINGS;
   event->completion.strings_completion = sc;
-  
+
   zkrb_enqueue(queue, event);
 }
 
@@ -420,7 +428,7 @@ void zkrb_strings_stat_callback(
   event->rc = rc;
   event->type = ZKRB_STRINGS_STAT;
   event->completion.strings_stat_completion = sc;
-  
+
   zkrb_enqueue(queue, event);
 }
 
@@ -435,7 +443,7 @@ void zkrb_void_callback(
   event->rc = rc;
   event->type = ZKRB_VOID;
   event->completion.void_completion = NULL;
-  
+
   zkrb_enqueue(queue, event);
 }
 
@@ -456,7 +464,7 @@ void zkrb_acl_callback(
   event->rc = rc;
   event->type = ZKRB_ACL;
   event->completion.acl_completion = ac;
-  
+
   /* should be synchronized */
   zkrb_enqueue(queue, event);
 }
@@ -494,22 +502,22 @@ struct ACL_vector * zkrb_ruby_to_aclvector(VALUE acl_ary) {
 #warning [wickman] TODO test zkrb_ruby_to_aclvector
 struct ACL zkrb_ruby_to_acl(VALUE rubyacl) {
   struct ACL acl;
-  
+
   VALUE perms  = rb_iv_get(rubyacl, "@perms");
   VALUE rubyid = rb_iv_get(rubyacl, "@id");
   acl.perms  = NUM2INT(perms);
   acl.id = zkrb_ruby_to_id(rubyid);
-  
+
   return acl;
 }
 
 #warning [wickman] TODO zkrb_ruby_to_id error checking? test
 struct Id zkrb_ruby_to_id(VALUE rubyid) {
   struct Id id;
-  
+
   VALUE scheme = rb_iv_get(rubyid, "@scheme");
   VALUE ident  = rb_iv_get(rubyid, "@id");
-  
+
   if (scheme != Qnil) {
     id.scheme = malloc(RSTRING_LEN(scheme) + 1);
     strncpy(id.scheme, RSTRING_PTR(scheme), RSTRING_LEN(scheme));
@@ -525,7 +533,7 @@ struct Id zkrb_ruby_to_id(VALUE rubyid) {
   } else {
     id.id = NULL;
   }
-  
+
   return id;
 }
 
@@ -549,17 +557,17 @@ VALUE zkrb_string_vector_to_ruby(struct String_vector *string_vector) {
 
 VALUE zkrb_stat_to_rarray(const struct Stat* stat) {
   return rb_ary_new3(11,
-		     LL2NUM(stat->czxid),
-		     LL2NUM(stat->mzxid),
-		     LL2NUM(stat->ctime),
-		     LL2NUM(stat->mtime),
-		     INT2NUM(stat->version),
-		     INT2NUM(stat->cversion),
-		     INT2NUM(stat->aversion),
-		     LL2NUM(stat->ephemeralOwner),
-		     INT2NUM(stat->dataLength),
-		     INT2NUM(stat->numChildren),
-		     LL2NUM(stat->pzxid));
+             LL2NUM(stat->czxid),
+             LL2NUM(stat->mzxid),
+             LL2NUM(stat->ctime),
+             LL2NUM(stat->mtime),
+             INT2NUM(stat->version),
+             INT2NUM(stat->cversion),
+             INT2NUM(stat->aversion),
+             LL2NUM(stat->ephemeralOwner),
+             INT2NUM(stat->dataLength),
+             INT2NUM(stat->numChildren),
+             LL2NUM(stat->pzxid));
 }
 
 VALUE zkrb_stat_to_rhash(const struct Stat *stat) {

data/ext/zookeeper_lib.h

@@ -109,6 +109,7 @@ void           zkrb_event_free(zkrb_event_t *ptr);
 void                 zkrb_enqueue(zkrb_queue_t *queue, zkrb_event_t *elt);
 zkrb_event_t *       zkrb_peek(zkrb_queue_t *queue);
 zkrb_event_t *       zkrb_dequeue(zkrb_queue_t *queue, int need_lock);
+void                 zkrb_signal(zkrb_queue_t *queue);
 
 void zkrb_print_stat(const struct Stat *s);
 

data/java/zookeeper_base.rb

@@ -179,6 +179,9 @@ class ZookeeperBase
 
     watcher ||= get_default_global_watcher
 
+    # allows connected-state handlers to be registered before 
+    yield self if block_given?
+
     reopen(timeout, watcher)
     return nil unless connected?
     setup_dispatch_thread!

data/lib/zookeeper.rb

@@ -31,14 +31,14 @@ class Zookeeper < ZookeeperBase
     assert_open
     assert_supported_keys(options, [:path, :watcher, :watcher_context, :callback, :callback_context])
     assert_required_keys(options, [:path])
-    
+
     req_id = setup_call(options)
     rc, value, stat = super(req_id, options[:path], options[:callback], options[:watcher])
 
     rv = { :req_id => req_id, :rc => rc }
     options[:callback] ? rv : rv.merge(:data => value, :stat => Stat.new(stat))
   end
-  
+
   def set(options = {})
     assert_open
     assert_supported_keys(options, [:path, :data, :version, :callback, :callback_context])
@@ -51,7 +51,7 @@ class Zookeeper < ZookeeperBase
     rv = { :req_id => req_id, :rc => rc }
     options[:callback] ? rv : rv.merge(:stat => Stat.new(stat))
   end
-  
+
   def get_children(options = {})
     assert_open
     assert_supported_keys(options, [:path, :callback, :callback_context, :watcher, :watcher_context])
@@ -75,34 +75,34 @@ class Zookeeper < ZookeeperBase
     rv = { :req_id => req_id, :rc => rc }
     options[:callback] ? rv : rv.merge(:stat => Stat.new(stat))
   end
-  
+
   def create(options = {})
     assert_open
     assert_supported_keys(options, [:path, :data, :acl, :ephemeral, :sequence, :callback, :callback_context])
     assert_required_keys(options, [:path])
-    
+
     flags = 0
     flags |= ZOO_EPHEMERAL if options[:ephemeral]
     flags |= ZOO_SEQUENCE if options[:sequence]
 
     options[:acl] ||= ZOO_OPEN_ACL_UNSAFE
-    
+
     req_id = setup_call(options)
     rc, newpath = super(req_id, options[:path], options[:data], options[:callback], options[:acl], flags)
-    
+
     rv = { :req_id => req_id, :rc => rc }
-    options[:callback] ? rv : rv.merge(:path => newpath) 
+    options[:callback] ? rv : rv.merge(:path => newpath)
   end
-  
+
   def delete(options = {})
     assert_open
     assert_supported_keys(options, [:path, :version, :callback, :callback_context])
     assert_required_keys(options, [:path])
     options[:version] ||= -1
-    
+
     req_id = setup_call(options)
     rc = super(req_id, options[:path], options[:version], options[:callback])
-    
+
     { :req_id => req_id, :rc => rc }
   end
 
@@ -111,21 +111,21 @@ class Zookeeper < ZookeeperBase
     assert_supported_keys(options, [:path, :acl, :version, :callback, :callback_context])
     assert_required_keys(options, [:path, :acl])
     options[:version] ||= -1
-    
+
     req_id = setup_call(options)
     rc = super(req_id, options[:path], options[:acl], options[:callback], options[:version])
-    
+
     { :req_id => req_id, :rc => rc }
   end
-  
+
   def get_acl(options = {})
     assert_open
     assert_supported_keys(options, [:path, :callback, :callback_context])
     assert_required_keys(options, [:path])
-    
+
     req_id = setup_call(options)
     rc, acls, stat = super(req_id, options[:path], options[:callback])
-    
+
     rv = { :req_id => req_id, :rc => rc }
     options[:callback] ? rv : rv.merge(:acl => acls, :stat => Stat.new(stat))
   end
@@ -157,7 +157,7 @@ private
     }
     req_id
   end
-  
+
   def setup_watcher(req_id, call_opts)
     @watcher_reqs[req_id] = { :watcher => call_opts[:watcher],
                               :context => call_opts[:watcher_context] }

data/slyphon-zookeeper.gemspec

@@ -3,9 +3,9 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "slyphon-zookeeper"
-  s.version     = '0.1.4'
+  s.version     = '0.1.6'
 
-  s.authors     = ["Phillip Pearson", "Eric Maland", "Evan Weaver", "Brian Wickman", "Jonathan D. Simms"]
+  s.authors     = ["Phillip Pearson", "Eric Maland", "Evan Weaver", "Brian Wickman", "Neil Conway", "Jonathan D. Simms"]
   s.email       = ["slyphon@gmail.com"]
   s.summary     = %q{twitter's zookeeper client}
   s.description = s.summary

metadata

@@ -1,25 +1,26 @@
 --- !ruby/object:Gem::Specification 
 name: slyphon-zookeeper
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 6
+  version: 0.1.6
 platform: ruby
 authors: 
 - Phillip Pearson
 - Eric Maland
 - Evan Weaver
 - Brian Wickman
+- Neil Conway
 - Jonathan D. Simms
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-03-08 00:00:00 +00:00
+date: 2011-05-18 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,7 +75,7 @@ files:
 - examples/cloud_config.rb
 - ext/.gitignore
 - ext/extconf.rb
-- ext/zkc-3.3.2.tar.gz
+- ext/zkc-3.3.3.tar.gz
 - ext/zookeeper_base.rb
 - ext/zookeeper_c.c
 - ext/zookeeper_lib.c
@@ -130,7 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: twitter's zookeeper client