rbczmq 1.5 → 1.6

data/CHANGELOG.rdoc

@@ -1,5 +1,10 @@
 = Changelog
 
+== 1.6 (May 2, 2013 )
+* Bump czmq to 1.4.0
+* Bump zeromq to 3.2.3
+* Make ZMQ::Loop#start thread-safe (Matt Connolly)
+
 == 1.5 (April 29, 2013)
 * Add support for XSUB and XPUB socket types (Matt Connolly)
 * Introduce a ZMQ.proxy API (Matt Connolly)

data/ext/rbczmq/extconf.rb

@@ -111,11 +111,6 @@ end
 # build libzmq
 lib = libs_path + "libzmq.#{LIBEXT}"
 Dir.chdir zmq_path do
-  Dir['../patches/zeromq/*.patch'].sort.each do |patch|
-    puts "applying: #{patch}"
-    sys "patch -p1 < #{patch}", "failed to apply patch: #{patch}"
-  end
-
   sys "./autogen.sh", "ZeroMQ autogen failed!" unless File.exist?(zmq_path + 'configure')
   sys "./configure --prefix=#{dst_path} --without-documentation --enable-shared && make && make install", "ZeroMQ compile error!"
 end unless File.exist?(lib)
@@ -123,11 +118,6 @@ end unless File.exist?(lib)
 # build libczmq
 lib = libs_path + "libczmq.#{LIBEXT}"
 Dir.chdir czmq_path do
-  Dir['../patches/czmq/*.patch'].sort.each do |patch|
-    puts "Applying: #{patch}"
-    sys "patch -p1 < #{patch}", "Failed to apply patch: #{patch}"
-  end
-
   sys "./autogen.sh", "CZMQ autogen failed!" unless File.exist?(czmq_path + 'configure')
   sys "./configure LDFLAGS=-L#{libs_path} CFLAGS='#{CZMQ_CFLAGS.join(" ")}' --prefix=#{dst_path} --with-libzmq=#{dst_path} --disable-shared && make all && make install", "CZMQ compile error!"
 end unless File.exist?(lib)

data/ext/rbczmq/loop.c

@@ -62,25 +62,63 @@ ZMQ_NOINLINE static int rb_czmq_callback(zloop_t *loop, VALUE *args)
     return 0;
 }
 
+/* data structure used to pass czmq parameters across to callbacks with ruby GVL */
+struct _rb_czmq_callback_invocation
+{
+	int result;
+	zloop_t *loop;
+	VALUE* args;
+	
+	// used by poll item callback
+	zmq_pollitem_t *item;
+	void* arg;
+};
+
 /*
  * :nodoc:
  *  Low level callback for when timers registered with the reactor fires. This calls back into the Ruby VM.
  *
+ * This function is called from rb_thread_call_with_gvl and is executed with the ruby GVL held.
 */
-ZMQ_NOINLINE static int rb_czmq_loop_timer_callback(zloop_t *loop, ZMQ_UNUSED zmq_pollitem_t *item, void *cb)
+ZMQ_NOINLINE static void* rb_czmq_loop_timer_callback_with_gvl(void* data)
 {
-    int rc;
+	struct _rb_czmq_callback_invocation* invocation = (struct _rb_czmq_callback_invocation*)data;
+	zloop_t* loop = invocation->loop;
+	zmq_pollitem_t *item = invocation->item;
+	void* cb = invocation->arg;
+
     VALUE args[3];
     ZmqGetTimer((VALUE)cb);
     if (timer->cancelled == true) {
-       zloop_timer_end(loop, (void *)cb);
-       return 0;
-    }
-    args[0] = (VALUE)cb;
-    args[1] = intern_call;
-    args[2] = Qnil;
-    rc = rb_czmq_callback(loop, args);
-    return rc;
+		zloop_timer_end(loop, (void *)cb);
+		invocation->result = 0;
+    } else {
+	    args[0] = (VALUE)cb;
+	    args[1] = intern_call;
+	    args[2] = Qnil;
+	
+	    invocation->result = rb_czmq_callback(loop, args);
+	}
+    return NULL;
+}
+
+
+/*
+ * :nodoc:
+ *  Low level callback for when timers registered with the reactor fires. This calls back into the Ruby VM.
+ *
+ * This is the CZMQ callback, which grabs the ruby GVL and calls the with GVL callback above.
+*/
+ZMQ_NOINLINE static int rb_czmq_loop_timer_callback(zloop_t *loop, ZMQ_UNUSED zmq_pollitem_t *item, void *cb)
+{
+	struct _rb_czmq_callback_invocation invocation;
+	invocation.result = -1;
+	invocation.loop = loop;
+	invocation.item = item;
+	invocation.args = NULL;
+	invocation.arg = cb;
+	rb_thread_call_with_gvl(rb_czmq_loop_timer_callback_with_gvl, &invocation);
+	return invocation.result;
 }
 
 /*
@@ -88,9 +126,15 @@ ZMQ_NOINLINE static int rb_czmq_loop_timer_callback(zloop_t *loop, ZMQ_UNUSED zm
  *  Low level callback for handling socket activity. This calls back into the Ruby VM. We special case ZMQ_POLLERR
  *  by invoking the error callback on the handler registered for this socket.
  *
+ * This function is called from rb_thread_call_with_gvl and is executed with the ruby GVL held.
 */
-ZMQ_NOINLINE static int rb_czmq_loop_pollitem_callback(zloop_t *loop, zmq_pollitem_t *item, void *arg)
+ZMQ_NOINLINE static void* rb_czmq_loop_pollitem_callback_with_gvl(void* data)
 {
+	struct _rb_czmq_callback_invocation *invocation = (struct _rb_czmq_callback_invocation *)data;
+	zloop_t *loop = invocation->loop;
+	zmq_pollitem_t *item = invocation->item;
+	void *arg = invocation->arg;
+	
     int ret_r = 0;
     int ret_w = 0;
     int ret_e = 0;
@@ -111,8 +155,31 @@ ZMQ_NOINLINE static int rb_czmq_loop_pollitem_callback(zloop_t *loop, zmq_pollit
         args[2] = rb_exc_new2(rb_eZmqError, zmq_strerror(zmq_errno()));
         ret_e = rb_czmq_callback(loop, args);
     }
-    if (ret_r == -1 || ret_w == -1 || ret_e == -1) return -1;
-    return 0;
+    if (ret_r == -1 || ret_w == -1 || ret_e == -1) {
+		invocation->result = -1;
+	} else {
+		invocation->result = 0;
+	}
+	return NULL;
+}
+
+/*
+ * :nodoc:
+ *  Low level callback for handling socket activity. This calls back into the Ruby VM. We special case ZMQ_POLLERR
+ *  by invoking the error callback on the handler registered for this socket.
+ *
+ * This is the CZMQ callback, which grabs the ruby GVL and calls the with GVL callback above.
+*/
+ZMQ_NOINLINE static int rb_czmq_loop_pollitem_callback(zloop_t *loop, zmq_pollitem_t *item, void *arg)
+{
+	struct _rb_czmq_callback_invocation invocation;
+	invocation.result = -1;
+	invocation.loop = loop;
+	invocation.item = item;
+	invocation.arg = arg;
+	invocation.args = NULL;
+	rb_thread_call_with_gvl(rb_czmq_loop_pollitem_callback_with_gvl, (void*)&invocation);
+	return invocation.result;
 }
 
 static void rb_czmq_loop_stop0(zmq_loop_wrapper *loop);
@@ -169,14 +236,45 @@ static VALUE rb_czmq_loop_new(VALUE loop)
     return loop;
 }
 
+/*
+ * :nodoc:
+ *  Run the zloop without holding the GVL. 
+ *
+*/
+static VALUE rb_czmq_loop_start_nogvl(void *ptr)
+{
+	zmq_loop_wrapper *loop = (zmq_loop_wrapper *)ptr;
+	return (VALUE)zloop_start(loop->loop);
+}
+
+/*
+ * :nodoc:
+ * unblocking function: called by ruby when our zloop is running without
+ * gvl to tell it to stop and return back to ruby.
+*/
+static void rb_czmq_loop_start_ubf(void* arg)
+{
+    // this flag is set when an interrupt / signal would kill
+    // an application using czmq and allows loops to end gracefully.
+    // This will terminate all loops and pools in all threads.
+
+    // Without setting this, the CZMQ loop does not terminate when
+    // the user hits CTRL-C.
+    zctx_interrupted = true;
+
+    // do same as 
+    zmq_loop_wrapper *loop_wrapper = arg;
+    loop_wrapper->running = false;
+}
+
 /*
  *  call-seq:
  *     loop.start    =>  Fixnum
  *
  *  Creates a new reactor instance and blocks the caller until the process is interrupted, the context terminates or the
  *  loop's explicitly stopped via callback. Returns 0 if interrupted and -1 when stopped via a handler.
- *
  * === Examples
+ *
  *     loop = ZMQ::Loop.new    =>   ZMQ::Loop
  *     loop.start    =>   Fixnum
  *
@@ -189,7 +287,9 @@ static VALUE rb_czmq_loop_start(VALUE obj)
     ZmqGetLoop(obj);
     THREAD_PASS;
     zloop_timer(loop->loop, 1, 1, rb_czmq_loop_started_callback, loop);
-    rc = zloop_start(loop->loop);
+
+    rc = (int)rb_thread_call_without_gvl(rb_czmq_loop_start_nogvl, (void *)loop, rb_czmq_loop_start_ubf, (void*)loop);
+	
     if (rc > 0) rb_raise(rb_eZmqError, "internal event loop error!");
     return INT2NUM(rc);
 }

data/ext/rbczmq/poller.h

@@ -26,4 +26,4 @@ struct nogvl_poll_args {
 
 void _init_rb_czmq_poller();
 
-#endif
+#endif

data/ext/rbczmq/pollitem.h

@@ -26,4 +26,4 @@ VALUE rb_czmq_pollitem_events(VALUE obj);
 
 void _init_rb_czmq_pollitem();
 
-#endif
+#endif

data/ext/rbczmq/rbczmq_ext.c

@@ -23,6 +23,7 @@ VALUE rb_cZmqLoop;
 VALUE rb_cZmqTimer;
 VALUE rb_cZmqPoller;
 VALUE rb_cZmqPollitem;
+VALUE rb_cZmqBeacon;
 
 st_table *frames_map = NULL;
 
@@ -282,4 +283,5 @@ void Init_rbczmq_ext()
     _init_rb_czmq_loop();
     _init_rb_czmq_poller();
     _init_rb_czmq_pollitem();
+    _init_rb_czmq_beacon();
 }

data/ext/rbczmq/rbczmq_ext.h

@@ -67,6 +67,7 @@ extern VALUE rb_cZmqLoop;
 extern VALUE rb_cZmqTimer;
 extern VALUE rb_cZmqPoller;
 extern VALUE rb_cZmqPollitem;
+extern VALUE rb_cZmqBeacon;
 
 extern st_table *frames_map;
 
@@ -83,6 +84,7 @@ extern VALUE intern_error;
 #include "timer.h"
 #include "poller.h"
 #include "pollitem.h"
+#include "beacon.h"
 
 static inline char *rb_czmq_formatted_current_time()
 {

data/lib/zmq/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module ZMQ
-  VERSION = "1.5"
+  VERSION = "1.6"
 end

metadata

@@ -1,49 +1,42 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rbczmq
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: '1.6'
   prerelease: 
-  segments: 
-  - 1
-  - 5
-  version: "1.5"
 platform: ruby
-authors: 
-- "Lourens Naud\xC3\xA9"
+authors:
+- Lourens Naudé
 - James Tucker
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-04-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake-compiler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 8
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
-  version_requirements: *id001
-description: "Ruby extension for CZMQ - High-level C Binding for \xC3\x98MQ (http://czmq.zeromq.org)"
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Ruby extension for CZMQ - High-level C Binding for ØMQ (http://czmq.zeromq.org)
+email:
 - lourens@methodmissing.com
 - jftucker@gmail.com
 executables: []
-
-extensions: 
+extensions:
 - ext/rbczmq/extconf.rb
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .travis.yml
 - CHANGELOG.rdoc
@@ -57,8 +50,7 @@ files:
 - examples/pub_sub.rb
 - examples/push_pull.rb
 - examples/req_rep.rb
-- ext/czmq-1.3.2.tar.gz
-- ext/patches/czmq/0_zframe_free.patch
+- ext/czmq-1.4.0.tar.gz
 - ext/rbczmq/context.c
 - ext/rbczmq/context.h
 - ext/rbczmq/extconf.rb
@@ -83,7 +75,7 @@ files:
 - ext/rbczmq/socket.h
 - ext/rbczmq/timer.c
 - ext/rbczmq/timer.h
-- ext/zeromq-3.2.2.tar.gz
+- ext/zeromq-3.2.3.tar.gz
 - lib/rbczmq.rb
 - lib/zmq.rb
 - lib/zmq/context.rb
@@ -150,38 +142,30 @@ files:
 - test/test_zmq.rb
 homepage: http://github.com/methodmissing/rbczmq
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: "Ruby extension for CZMQ - High-level C Binding for \xC3\x98MQ (http://czmq.zeromq.org)"
-test_files: 
+summary: Ruby extension for CZMQ - High-level C Binding for ØMQ (http://czmq.zeromq.org)
+test_files:
 - test/helper.rb
 - test/socket/test_dealer_socket.rb
 - test/socket/test_pair_socket.rb

data/ext/patches/czmq/0_zframe_free.patch

@@ -1,78 +0,0 @@
-diff --git a/include/zframe.h b/include/zframe.h
-index e0e36c2..1b880d3 100644
---- a/include/zframe.h
-+++ b/include/zframe.h
-@@ -116,6 +116,10 @@ CZMQ_EXPORT void
- CZMQ_EXPORT void
-     zframe_reset (zframe_t *self, const void *data, size_t size);
- 
-+//  Set the free callback for frame
-+CZMQ_EXPORT void
-+    zframe_freefn(zframe_t *self, zframe_free_fn *free_fn, void *arg);
-+
- //  Self test of this class
- CZMQ_EXPORT int
-     zframe_test (bool verbose);
-diff --git a/src/zframe.c b/src/zframe.c
-index edeec07..cf124ac 100644
---- a/src/zframe.c
-+++ b/src/zframe.c
-@@ -49,6 +49,8 @@ struct _zframe_t {
-     zmq_msg_t zmsg;             //  zmq_msg_t blob for frame
-     int more;                   //  More flag, from last read
-     int zero_copy;              //  zero-copy flag
-+    zframe_free_fn *free_fn;    //  destructor callback
-+    void *free_arg;             //  destructor callback arg
- };
- 
- 
-@@ -116,6 +118,8 @@ zframe_destroy (zframe_t **self_p)
-     assert (self_p);
-     if (*self_p) {
-         zframe_t *self = *self_p;
-+        if (self->free_fn)
-+          (self->free_fn) (self, self->free_arg);
-         zmq_msg_close (&self->zmsg);
-         free (self);
-         *self_p = NULL;
-@@ -373,6 +377,16 @@ zframe_reset (zframe_t *self, const void *data, size_t size)
-     memcpy (zmq_msg_data (&self->zmsg), data, size);
- }
- 
-+void
-+zframe_freefn (zframe_t *self, zframe_free_fn *free_fn, void *arg)
-+{
-+    assert (self);
-+    assert (free_fn);
-+
-+    self->free_fn = free_fn;
-+    self->free_arg = arg;
-+}
-+
- //  --------------------------------------------------------------------------
- //  Selftest
- 
-@@ -389,6 +403,12 @@ s_test_free_cb (void *data, void *arg)
-     free (data);
- }
- 
-+static void
-+s_test_free_frame_cb(void *frame, void *arg)
-+{
-+    assert (frame);
-+}
-+
- int
- zframe_test (bool verbose)
- {
-@@ -472,6 +492,10 @@ zframe_test (bool verbose)
-     zframe_destroy (&frame);
-     zframe_destroy (&frame_copy);
- 
-+    frame = zframe_new ("callback", 8);
-+    zframe_freefn (frame, s_test_free_frame_cb, NULL);
-+    zframe_destroy (&frame);
-+
-     zctx_destroy (&ctx);
-     //  @end
-     printf ("OK\n");