zookeeper 1.0.3 → 1.0.4

data/ext/c_zookeeper.rb

@@ -53,6 +53,13 @@ class CZookeeper
 
     @_session_timeout_msec = DEFAULT_SESSION_TIMEOUT_MSEC
 
+    if cid = opts[:client_id]
+      raise ArgumentError, "opts[:client_id] must be a CZookeeper::ClientId" unless cid.kind_of?(ClientId)
+      raise ArgumentError, "session_id must not be nil" if cid.session_id.nil?
+    end
+
+    @_client_id = opts[:client_id]
+
     @start_stop_mutex = Monitor.new
     
     # used to signal that we're running

data/ext/dbg.h

@@ -45,7 +45,7 @@
 // like check_debug_goto, but the label is implicitly 'error'
 #define check_debug(A, M, ...) check_debug_goto(A, error, M, ##__VA_ARGS__) 
 
-#define zkrb_debug(M, ...) if (ZKRBDebugging) fprintf(stderr, "DEBUG %p:%s:%d: " M "\n", pthread_self(), __FILE__, __LINE__, ##__VA_ARGS__)
+#define zkrb_debug(M, ...) if (ZKRBDebugging) fprintf(stderr, "DEBUG %p:%s:%d: " M "\n", (void *)pthread_self(), __FILE__, __LINE__, ##__VA_ARGS__)
 #define zkrb_debug_inst(O, M, ...) zkrb_debug("obj_id: %lx, " M, FIX2LONG(rb_obj_id(O)), ##__VA_ARGS__)
 
 // __dbg_h__

data/ext/zookeeper_base.rb

@@ -88,7 +88,8 @@ class ZookeeperBase
     update_pid!  # from Forked
   end
   private :reopen_after_fork!
- 
+
+
   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!"
@@ -97,11 +98,7 @@ class ZookeeperBase
     reopen_after_fork! if forked?
 
     @mutex.synchronize do
-      if @czk 
-        @czk.close
-        @czk = nil
-      end
-
+      @czk.close if @czk
       @czk = CZookeeper.new(@host, @event_queue)
 
       # flushes all outstanding watcher reqs.
@@ -123,13 +120,14 @@ class ZookeeperBase
 
     @dispatcher = @czk = nil
 
+    update_pid!
     reopen_after_fork!
     
     # 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
+    @host = host.dup
 
     @default_watcher = (watcher or get_default_global_watcher)
 
@@ -165,7 +163,7 @@ class ZookeeperBase
     shutdown_thread = Thread.new do
       @mutex.synchronize do
         stop_dispatch_thread!
-        @czk.close
+        close!
       end
     end
 

data/ext/zookeeper_lib.c

@@ -37,10 +37,34 @@ int ZKRBDebugging;
 // XXX(slyphon): need to check these for error, but what to do if they fail?
 pthread_mutex_t zkrb_q_mutex = PTHREAD_MUTEX_INITIALIZER;
 
-#define LOG_PTHREAD_ERR(A, M, ...) if (A) { log_err(M, ##__VA_ARGS__); errno=0; }
+inline static int global_mutex_lock() {
+  int rv = pthread_mutex_lock(&zkrb_q_mutex);
+  if (rv != 0) log_err("global_mutex_lock error");
+  return rv;
+}
 
-#define GLOBAL_MUTEX_LOCK(F)   LOG_PTHREAD_ERR(pthread_mutex_lock(&zkrb_q_mutex), F)
-#define GLOBAL_MUTEX_UNLOCK(F) LOG_PTHREAD_ERR(pthread_mutex_unlock(&zkrb_q_mutex), F)
+inline static int global_mutex_unlock() {
+  int rv = pthread_mutex_unlock(&zkrb_q_mutex);
+  if (rv != 0) log_err("global_mutex_unlock error");
+  return rv;
+}
+
+void atfork_prepare() {
+  global_mutex_lock();
+}
+
+void atfork_parent() {
+  global_mutex_unlock();
+}
+
+void atfork_child() {
+  global_mutex_unlock();
+}
+
+// set up handlers to make sure the thread being forked holds the lock at the 
+// time the process is copied, then immediately unlock the mutex in both parent
+// and children
+pthread_atfork(atfork_prepare, atfork_parent, atfork_child);
 
 
 void zkrb_enqueue(zkrb_queue_t *q, zkrb_event_t *elt) {
@@ -54,7 +78,7 @@ void zkrb_enqueue(zkrb_queue_t *q, zkrb_event_t *elt) {
     return;
   }
 
-  pthread_mutex_lock(&q->mutex);
+  global_mutex_lock();
 
   q->tail->event = elt;
   q->tail->next = (zkrb_event_ll_t *) malloc(sizeof(zkrb_event_ll_t));
@@ -64,7 +88,7 @@ void zkrb_enqueue(zkrb_queue_t *q, zkrb_event_t *elt) {
 
   ssize_t ret = write(q->pipe_write, "0", 1);   /* Wake up Ruby listener */
 
-  pthread_mutex_unlock(&q->mutex);
+  global_mutex_unlock();
 
   if (ret < 0) {
     log_err("write to queue (%p) pipe failed!\n", q);
@@ -81,13 +105,13 @@ zkrb_event_t * zkrb_peek(zkrb_queue_t *q) {
 
   if (!q) return NULL;
 
-  pthread_mutex_lock(&q->mutex);
+  global_mutex_lock();
 
   if (q != NULL && q->head != NULL && q->head->event != NULL) {
     event = q->head->event;
   }
 
-  pthread_mutex_unlock(&q->mutex);
+  global_mutex_unlock();
 
   return event;
 }
@@ -99,7 +123,7 @@ zkrb_event_t* zkrb_dequeue(zkrb_queue_t *q, int need_lock) {
   zkrb_event_ll_t *old_root = NULL;
     
   if (need_lock)
-    pthread_mutex_lock(&q->mutex);
+    global_mutex_lock();
 
   if (!ZKRB_QUEUE_EMPTY(q)) {
     old_root = q->head;
@@ -108,7 +132,7 @@ zkrb_event_t* zkrb_dequeue(zkrb_queue_t *q, int need_lock) {
   }
 
   if (need_lock)
-    pthread_mutex_unlock(&q->mutex);
+    global_mutex_unlock();
 
   free(old_root);
   return rv;
@@ -117,12 +141,12 @@ zkrb_event_t* zkrb_dequeue(zkrb_queue_t *q, int need_lock) {
 void zkrb_signal(zkrb_queue_t *q) {
   if (!q) return;
 
-  pthread_mutex_lock(&q->mutex);
+  global_mutex_lock();
 
   if (!write(q->pipe_write, "0", 1))      /* Wake up Ruby listener */
     log_err("zkrb_signal: write to pipe failed, could not wake");
 
-  pthread_mutex_unlock(&q->mutex);
+  global_mutex_unlock();
 }
 
 zkrb_event_ll_t *zkrb_event_ll_t_alloc(void) {
@@ -147,8 +171,6 @@ zkrb_queue_t *zkrb_queue_alloc(void) {
 
   rq->orig_pid = getpid();
 
-  check(pthread_mutex_init(&rq->mutex, NULL) == 0, "pthread_mutex_init failed");
-
   rq->head = zkrb_event_ll_t_alloc();
   check_mem(rq->head);
 
@@ -175,8 +197,6 @@ void zkrb_queue_free(zkrb_queue_t *queue) {
   close(queue->pipe_read);
   close(queue->pipe_write);
 
-  pthread_mutex_destroy(&queue->mutex);
-
   free(queue);
 }
 

data/ext/zookeeper_lib.h

@@ -106,7 +106,6 @@ typedef struct {
   zkrb_event_ll_t *tail;
   int             pipe_read;
   int             pipe_write;
-  pthread_mutex_t mutex;
   pid_t           orig_pid;
 } zkrb_queue_t;
 

data/lib/zookeeper.rb

@@ -5,12 +5,16 @@ require 'monitor'
 require 'forwardable'
 require 'logger'
 
-require 'backports'
-
 module Zookeeper
   # establishes the namespace
 end
 
+require File.expand_path('../zookeeper/core_ext', __FILE__)
+
+silence_warnings do
+  require 'backports'
+end
+
 require_relative 'zookeeper/forked'
 require_relative 'zookeeper/latch'
 require_relative 'zookeeper/acls'

data/lib/zookeeper/core_ext.rb

@@ -0,0 +1,30 @@
+# @private
+module ::Kernel
+  unless method_defined?(:silence_warnings)
+    def silence_warnings
+      with_warnings(nil) { yield }
+    end
+  end
+
+  unless method_defined?(:with_warnings)
+    def with_warnings(flag)
+      old_verbose, $VERBOSE = $VERBOSE, flag
+      yield
+    ensure
+      $VERBOSE = old_verbose
+    end
+  end
+end
+
+# @private
+class ::Exception
+  unless method_defined?(:to_std_format)
+    def to_std_format
+      ary = ["#{self.class}: #{message}"]
+      ary.concat(backtrace || [])
+      ary.join("\n\t")
+    end
+  end
+end
+
+

data/lib/zookeeper/forked.rb

@@ -14,6 +14,6 @@ module Zookeeper
     def update_pid!
       self.original_pid = Process.pid
     end
-  end
-end
+  end # Forked
+end # Zookeeper
 

data/lib/zookeeper/version.rb

@@ -1,4 +1,4 @@
 module Zookeeper
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
   DRIVER_VERSION = '3.3.5'
 end

data/spec/fork_hook_specs.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'fork hooks' do
+  def safe_kill_process(signal, pid)
+    Process.kill(signal, pid)
+  rescue Errno::ESRCH
+    nil
+  end
+
+  after do
+    Zookeeper::Forked.clear!
+
+    if @pid
+      safe_kill_process('KILL', @pid)
+    end
+  end
+
+  describe 'fork with a block' do
+    it %[should call the after_fork_in_child hooks in the child] do
+      child_hook_called = false
+
+      hook_order = []
+
+      Zookeeper.prepare_for_fork { hook_order << :prepare }
+      Zookeeper.after_fork_in_parent { hook_order << :parent }
+      Zookeeper.after_fork_in_child { hook_order << :child }
+
+      @pid = fork do
+        unless hook_order.first == :prepare
+          $stderr.puts "hook order wrong! #{hook_order.inspect}"
+          exit! 2
+        end
+
+        unless hook_order.last == :child
+          $stderr.puts "hook order wrong! #{hook_order.inspect}"
+          exit! 3
+        end
+
+        exit! 0
+      end
+
+      hook_order.first.should == :prepare
+      hook_order.last.should == :parent
+
+      _, st = Process.wait2(@pid)
+      st.exitstatus.should == 0
+
+      st.should be_exited
+      st.should be_success
+    end
+  end
+end
+

data/spec/forked_connection_spec.rb

@@ -27,14 +27,31 @@ unless defined?(::JRUBY_VERSION)
 
     after do
       if @pid and process_alive?(@pid)
-        Process.kill('TERM', @pid)
-        p Process.wait2(@pid)
+        begin
+          Process.kill('KILL', @pid)
+          p Process.wait2(@pid)
+        rescue Errno::ESRCH
+        end
       end
 
       @zk.close if @zk and !@zk.closed?
       with_open_zk(connection_string) { |z| rm_rf(z, path) }
     end
 
+    def wait_for_child_safely(pid, timeout=5)
+      time_to_stop = Time.now + timeout
+
+      until Time.now > time_to_stop
+        if a = Process.wait2(@pid, Process::WNOHANG)
+          return a.last
+        else
+          sleep(0.01)
+        end
+      end
+
+      nil
+    end
+
     it %[should do the right thing and not fail] do
       @zk.wait_until_connected
 
@@ -68,13 +85,21 @@ unless defined?(::JRUBY_VERSION)
         exit!(0)
       end
 
-      logger.debug { "waiting on child #{@pid}" }
+      event_waiter_th = Thread.new do
+        @latch.await(10) unless @event 
+        @event
+      end
 
-      @latch.await until @event 
+      logger.debug { "waiting on child #{@pid}" }
 
-      _, status = Process.wait2(@pid)
+      status = wait_for_child_safely(@pid)
+      raise "Child process did not exit, likely hung"  unless status
 
+      status.should_not be_signaled
       status.should be_success
+
+      event_waiter_th.join(5).should == event_waiter_th
+      @event.should_not be nil
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zookeeper
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: 
   segments: 
   - 1
   - 0
-  - 3
-  version: 1.0.3
+  - 4
+  version: 1.0.4
 platform: ruby
 authors: 
 - Phillip Pearson
@@ -20,7 +20,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-09 00:00:00 Z
+date: 2012-05-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: backports
@@ -90,6 +90,7 @@ files:
 - lib/zookeeper/common/queue_with_pipe.rb
 - lib/zookeeper/compatibility.rb
 - lib/zookeeper/constants.rb
+- lib/zookeeper/core_ext.rb
 - lib/zookeeper/em_client.rb
 - lib/zookeeper/exceptions.rb
 - lib/zookeeper/forked.rb
@@ -104,6 +105,7 @@ files:
 - spec/compatibilty_spec.rb
 - spec/default_watcher_spec.rb
 - spec/em_spec.rb
+- spec/fork_hook_specs.rb
 - spec/forked_connection_spec.rb
 - spec/latch_spec.rb
 - spec/log4j.properties
@@ -155,6 +157,7 @@ test_files:
 - spec/compatibilty_spec.rb
 - spec/default_watcher_spec.rb
 - spec/em_spec.rb
+- spec/fork_hook_specs.rb
 - spec/forked_connection_spec.rb
 - spec/latch_spec.rb
 - spec/log4j.properties