nanomsg 0.2.0 → 0.3.0

data/HISTORY

@@ -1,5 +1,10 @@
+= 0.3 / 4Sept2013
 
-= 0.2 /
+  * Fixes GVL related blocking behaviour, recv/send will now _NOT_ consume 
+    a whole core. 
+  * Adds a raw setsockopt that allows settting various types of values. 
+
+= 0.2 / 26Aug2013
 
   * Adds REQ/REP socket type (ReqSocket, RepSocket).
   * Adds PUB/SUB socket type. 

data/examples/aborting.rb

@@ -0,0 +1,75 @@
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'nanomsg'
+include NanoMsg
+
+class AbortBehaviourChecker
+  attr_reader :t
+  attr_reader :q, :p
+
+  def initialize
+    @q, @p = PairSocket.new, PairSocket.new
+    @adr = 'tcp://127.0.0.1:4000'
+
+    @q.bind(@adr)
+    @p.connect(@adr)
+
+    @q.setsockopt(NanoMsg::NN_SOL_SOCKET, NanoMsg::NN_RCVTIMEO, 5000)
+  end
+
+  def run_recv_thread
+    @t = Thread.start { 
+      begin 
+        @q.recv 
+      rescue NanoMsg::Errno::EAGAIN
+        puts "EAGAIN"
+        # Gets raised when the read operation times out after 5 seconds
+      end
+    }
+    @t.abort_on_exception = false
+  end
+
+  def kill
+    @t.kill
+  end
+  def join
+    s = Time.now
+    @t.join
+    Time.now - s
+  end
+
+  def send msg
+    @p.send msg
+  end
+  def recv 
+    @q.recv
+  end
+end 
+
+
+# ------------------------------------------------- NN_RCVTIMEO behaviour test
+
+abc = AbortBehaviourChecker.new
+s = Time.now
+
+abc.run_recv_thread
+
+# During these first 10 seconds, CPU usage needs to stay low, since we're 
+# just waiting for a message to come in. 
+loop do
+  p abc.t
+  sleep 1
+  break if Time.now - s > 7
+end
+
+# -------------------------------------------------------- kill behaviour test
+
+# Resets the EAGAIN behaviour
+abc.send 'test'
+p abc.recv
+
+abc.run_recv_thread
+abc.kill
+
+puts "Joining..."
+t = abc.join.round
+puts "Join took #{t} seconds."

data/ext/init.c

@@ -77,6 +77,20 @@ sock_get(VALUE socket)
   return psock->socket;
 }
 
+static int
+nn_get_rcv_fd(int sock)
+{
+  int fd; 
+  size_t size = sizeof(fd);
+  int err; 
+
+  err = nn_getsockopt(sock, NN_SOL_SOCKET, NN_RCVFD, &fd, &size);
+  if (err < 0)
+    return err; 
+
+  return fd; 
+}
+
 static VALUE
 sock_alloc(VALUE klass) 
 {
@@ -145,36 +159,18 @@ struct ioop {
   int sock; 
   char* buffer; 
   long len; 
-  int abort; 
 };
 
 static VALUE
-sock_send_no_gvl(void* data)
+sock_send_blocking(void* data)
 {
   struct ioop *pio = data; 
 
-  // TODO This is buggy. I cannot make the difference between 
-  // 'socket gone away' (=EAGAIN) and 'socket busy' (=EAGAIN). So I err on the
-  // side of 'socket busy' and do not raise the error. As a consequence, we'll
-  // get stuck in an endless loop when the socket is just not answering. 
-
-  while (pio->nn_errno == EAGAIN && !pio->abort) {
-    pio->return_code = nn_send(pio->sock, pio->buffer, pio->len, NN_DONTWAIT /* flags */);
-
-    if (pio->return_code < 0)
-      pio->nn_errno = nn_errno(); 
-    else
-      break;
-  }
-
-  return Qnil;
-}
+  pio->return_code = nn_send(pio->sock, pio->buffer, pio->len, 0 /* flags */);
+  if (pio->return_code < 0)
+    pio->nn_errno = nn_errno(); 
 
-static void
-sock_send_abort(void* data)
-{
-  struct ioop *pio = data; 
-  pio->abort = Qtrue;  
+  return Qnil;   
 }
 
 static VALUE
@@ -183,17 +179,10 @@ sock_send(VALUE socket, VALUE buffer)
   struct ioop io; 
 
   io.sock = sock_get(socket);
-  io.nn_errno = EAGAIN;
   io.buffer = StringValuePtr(buffer);
   io.len = RSTRING_LEN(buffer);
-  io.abort = Qfalse; 
-
-  rb_thread_blocking_region(sock_send_no_gvl, &io, sock_send_abort, &io);
 
-  // Unclear what to do in this situation, but we'll simply return nil, 
-  // leaving Ruby to handle the abort. 
-  if (io.abort) 
-    return Qnil; 
+  rb_thread_blocking_region(sock_send_blocking, &io, RUBY_UBF_IO, 0);
 
   if (io.return_code < 0)
     sock_raise_error(io.nn_errno);
@@ -202,35 +191,18 @@ sock_send(VALUE socket, VALUE buffer)
 }
 
 static VALUE
-sock_recv_no_gvl(void* data)
+sock_recv_blocking(void* data)
 {
   struct ioop *pio = data; 
 
-  // TODO This is buggy. I cannot make the difference between 
-  // 'socket gone away' (=EAGAIN) and 'socket busy' (=EAGAIN). So I err on the
-  // side of 'socket busy' and do not raise the error. As a consequence, we'll
-  // get stuck in an endless loop when the socket is just not answering. 
-
-  while (pio->nn_errno == EAGAIN && !pio->abort) {
-    pio->return_code = nn_recv(pio->sock, &pio->buffer, NN_MSG, NN_DONTWAIT /* flags */);
+  pio->return_code = nn_recv(pio->sock, &pio->buffer, NN_MSG, 0 /* flags */);
 
-    if (pio->return_code < 0)
-      pio->nn_errno = nn_errno(); 
-    else
-      break;
-  }
+  if (pio->return_code < 0)
+    pio->nn_errno = nn_errno(); 
 
   return Qnil; 
 }
 
-static void
-sock_recv_abort(void* data) 
-{
-  struct ioop *pio = data; 
-
-  pio->abort = Qtrue; 
-}
-
 static VALUE
 sock_recv(VALUE socket)
 {
@@ -238,14 +210,8 @@ sock_recv(VALUE socket)
   struct ioop io; 
 
   io.sock = sock_get(socket);
-  io.buffer = (char*) 0; 
-  io.abort  = Qfalse; 
-  io.nn_errno = EAGAIN;
-
-  rb_thread_blocking_region(sock_recv_no_gvl, &io, sock_recv_abort, &io); 
 
-  if (io.abort) 
-    return Qnil; 
+  rb_thread_blocking_region(sock_recv_blocking, &io, RUBY_UBF_IO, 0);
 
   if (io.return_code < 0)
     sock_raise_error(io.nn_errno);
@@ -277,7 +243,7 @@ sock_close(VALUE socket)
 
   // I've no idea on how to abort a close (which may block for NN_LINGER 
   // seconds), so we'll be uninterruptible. 
-  rb_thread_blocking_region(sock_close_no_gvl, &io, NULL, NULL);
+  rb_thread_blocking_region(sock_close_no_gvl, &io, RUBY_UBF_IO, 0);
 
   if (io.return_code < 0)
     sock_raise_error(io.nn_errno);
@@ -285,6 +251,44 @@ sock_close(VALUE socket)
   return Qnil;
 }
 
+static VALUE
+sock_setsockopt(VALUE self, VALUE level, VALUE option, VALUE val)
+{
+  int sock = sock_get(self);
+  int level_arg = FIX2INT(level); 
+  int option_arg = FIX2INT(option);
+  int err; 
+  int i; 
+  void* v; 
+  size_t vlen = 0;
+
+  switch (TYPE(val)) {
+    case T_FIXNUM:
+      i = FIX2INT(val);
+      goto numval;
+    case T_FALSE:
+      i = 0;
+      goto numval;
+    case T_TRUE:
+      i = 1;
+    numval: 
+      v = (void*)&i; vlen = sizeof(i);
+      break;
+    
+    default:
+      StringValue(val);
+      v = RSTRING_PTR(val);
+      vlen = RSTRING_LEN(val);
+      break;
+  }
+
+  err = nn_setsockopt(sock, level_arg, option_arg, v, vlen);
+  if (err < 0)
+    RAISE_SOCK_ERROR; 
+
+  return self; 
+}
+
 #define SOCK_INIT_FUNC(name, type) \
 static VALUE \
 name(int argc, VALUE *argv, VALUE self) \
@@ -390,7 +394,7 @@ nanomsg_run_device(VALUE self, VALUE a, VALUE b)
   dop.sa = sock_get(a);
   dop.sb = sock_get(b);
 
-  rb_thread_blocking_region(nanomsg_run_device_no_gvl, &dop, NULL, NULL);
+  rb_thread_blocking_region(nanomsg_run_device_no_gvl, &dop, RUBY_UBF_IO, 0);
   if (dop.err < 0)
     RAISE_SOCK_ERROR;
 
@@ -405,7 +409,7 @@ nanomsg_run_loopback(VALUE self, VALUE a)
   dop.sa = sock_get(a);
   dop.sb = -1;          // invalid socket, see documentation
 
-  rb_thread_blocking_region(nanomsg_run_device_no_gvl, &dop, NULL, NULL);
+  rb_thread_blocking_region(nanomsg_run_device_no_gvl, &dop, RUBY_UBF_IO, 0);
   if (dop.err < 0)
     RAISE_SOCK_ERROR;
 
@@ -445,6 +449,7 @@ Init_nanomsg(void)
   rb_define_method(cSocket, "send", sock_send, 1);
   rb_define_method(cSocket, "recv", sock_recv, 0);
   rb_define_method(cSocket, "close", sock_close, 0);
+  rb_define_method(cSocket, "setsockopt", sock_setsockopt, 3);
 
   rb_define_method(cPairSocket, "initialize", pair_sock_init, -1);
 

data/ext/mkmf.log

@@ -0,0 +1,22 @@
+have_library: checking for main() in -lnanomsg... -------------------- yes
+
+"/usr/local/bin/gcc-4.2 -o conftest -I/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/include/ruby-1.9.1/x86_64-darwin12.3.0 -I/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/include/ruby-1.9.1/ruby/backward -I/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/include/ruby-1.9.1 -I. -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE   -I/usr/local/opt/libyaml/include -I/usr/local/opt/readline/include -I/usr/local/opt/libxml2/include -I/usr/local/opt/libxslt/include -I/usr/local/opt/libksba/include -I/usr/local/opt/openssl/include -I/usr/local/opt/sqlite/include  -O3 -ggdb -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wshorten-64-to-32 -Wimplicit-function-declaration  -fno-common -pipe conftest.c  -L. -L/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/lib -L/usr/local/opt/libyaml/lib -L/usr/local/opt/readline/lib -L/usr/local/opt/libxml2/lib -L/usr/local/opt/libxslt/lib -L/usr/local/opt/libksba/lib -L/usr/local/opt/openssl/lib -L/usr/local/opt/sqlite/lib -L. -L/usr/local/lib -L/usr/local/opt/libyaml/lib -L/usr/local/opt/readline/lib -L/usr/local/opt/libxml2/lib -L/usr/local/opt/libxslt/lib -L/usr/local/opt/libksba/lib -L/usr/local/opt/openssl/lib -L/usr/local/opt/sqlite/lib      -lruby.1.9.1  -lpthread -ldl -lobjc "
+checked program was:
+/* begin */
+1: #include "ruby.h"
+2: 
+3: int main() {return 0;}
+/* end */
+
+"/usr/local/bin/gcc-4.2 -o conftest -I/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/include/ruby-1.9.1/x86_64-darwin12.3.0 -I/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/include/ruby-1.9.1/ruby/backward -I/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/include/ruby-1.9.1 -I. -D_XOPEN_SOURCE -D_DARWIN_C_SOURCE   -I/usr/local/opt/libyaml/include -I/usr/local/opt/readline/include -I/usr/local/opt/libxml2/include -I/usr/local/opt/libxslt/include -I/usr/local/opt/libksba/include -I/usr/local/opt/openssl/include -I/usr/local/opt/sqlite/include  -O3 -ggdb -Wall -Wextra -Wno-unused-parameter -Wno-parentheses -Wno-long-long -Wno-missing-field-initializers -Wpointer-arith -Wwrite-strings -Wdeclaration-after-statement -Wshorten-64-to-32 -Wimplicit-function-declaration  -fno-common -pipe conftest.c  -L. -L/Users/kschiess/.rvm/rubies/ruby-1.9.3-p392-turbo/lib -L/usr/local/opt/libyaml/lib -L/usr/local/opt/readline/lib -L/usr/local/opt/libxml2/lib -L/usr/local/opt/libxslt/lib -L/usr/local/opt/libksba/lib -L/usr/local/opt/openssl/lib -L/usr/local/opt/sqlite/lib -L. -L/usr/local/lib -L/usr/local/opt/libyaml/lib -L/usr/local/opt/readline/lib -L/usr/local/opt/libxml2/lib -L/usr/local/opt/libxslt/lib -L/usr/local/opt/libksba/lib -L/usr/local/opt/openssl/lib -L/usr/local/opt/sqlite/lib      -lruby.1.9.1 -lnanomsg  -lpthread -ldl -lobjc "
+checked program was:
+/* begin */
+1: #include "ruby.h"
+2: 
+3: /*top*/
+4: int main() {return 0;}
+5: int t() { void ((*volatile p)()); p = (void ((*)()))main; return 0; }
+/* end */
+
+--------------------
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nanomsg
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-26 00:00:00.000000000 Z
+date: 2013-09-04 00:00:00.000000000 Z
 dependencies: []
 description: ! "    nanomsg library is a high-performance implementation of several
   \"scalability \n    protocols\". Scalability protocol's job is to define how multiple
@@ -29,12 +29,11 @@ files:
 - lib/nanomsg.rb
 - ext/constants.c
 - ext/constants.h
-- ext/constants.o
 - ext/extconf.rb
 - ext/init.c
-- ext/init.o
 - ext/Makefile
-- ext/nanomsg.bundle
+- ext/mkmf.log
+- examples/aborting.rb
 - examples/bus.rb
 - examples/bus_device.rb
 - examples/pair.rb