nn-core 0.1.5 → 0.1.6

data/History.txt

@@ -1,3 +1,16 @@
+20130220 / 0.1.6
+	* Several fixes for tcp string handling have made it to nanomsg trunk,
+		so I can now re-enable those specs.
+		
+	*	For MRI Ruby, add @blocking=true before all function attachments to instruct
+		the FFI gem to release the GIL.
+		
+	*	Fixed a nn_recv spec to only read a specific number of bytes from a received
+		string. Must note that the library does not null terminate strings on its
+		own so we need to be very careful how many bytes are read from received
+		strings.
+		
+
 20130215 / 0.1.5
 	*	libnanomsg has removed the nn_init and nn_term functions. Updated
 		specs to remove those features.

data/examples/roundtrip_latency.rb

@@ -0,0 +1,167 @@
+begin
+  require 'nn-core'
+rescue LoadError
+  $: << File.join(File.dirname(__FILE__), '..', 'lib')
+  retry
+end
+
+
+# Within a single process, we start up two threads. One thread has a REQ (request)
+# socket and the second thread has a REP (reply) socket. We measure the
+# *round-trip* latency between these sockets. Only *one* message is in flight at
+# any given moment.
+#
+#  % ruby roundtrip_latency.rb tcp://127.0.0.1:5555 1024 1_000_000
+#
+#  % ruby roundtrip_latency.rb inproc://lm_sock 1024 1_000_000
+#
+
+if ARGV.length < 3
+  puts "usage: ruby roundtrip_latency.rb <connect-to> <message-size> <roundtrip-count>"
+  exit
+end
+
+link = ARGV[0]
+message_size = ARGV[1].to_i
+roundtrip_count = ARGV[2].to_i
+
+def set_signal_handler(receiver, transmitter)
+  trap(:INT) do
+    puts "got ctrl-c"
+    receiver.terminate
+    transmitter.terminate
+  end
+end
+
+class Node
+  def initialize(endpoint, size, count)
+    @endpoint = endpoint
+    @size = size
+    @count = count
+    @msg = 'a' * @size
+
+    @rcv_buffer = FFI::MemoryPointer.new(@size)
+
+    allocate_socket
+    setup_socket
+    set_endpoint
+  end
+
+  def setup_socket
+    option = FFI::MemoryPointer.new(:int32)
+
+    # LINGER
+    option.write_int(100)
+    rc = NNCore::LibNanomsg.nn_setsockopt(@socket, NNCore::NN_SOL_SOCKET, NNCore::NN_LINGER, option, 4)
+    assert(rc)
+
+    # SNDBUF
+    option.write_int(131072)
+    rc = NNCore::LibNanomsg.nn_setsockopt(@socket, NNCore::NN_SOL_SOCKET, NNCore::NN_SNDBUF, option, 4)
+    assert(rc)
+
+    # RCVBUF
+    option.write_int(131072)
+    rc = NNCore::LibNanomsg.nn_setsockopt(@socket, NNCore::NN_SOL_SOCKET, NNCore::NN_RCVBUF, option, 4)
+    assert(rc)
+  end
+
+  def send_msg
+    nbytes = NNCore::LibNanomsg.nn_send(@socket, @msg, @size, 0)
+    assert(nbytes)
+    nbytes
+  end
+
+  def recv_msg
+    nbytes = NNCore::LibNanomsg.nn_recv(@socket, @rcv_buffer, @size, 0)
+    assert(nbytes)
+    nbytes
+  end
+
+  def terminate
+    assert(NNCore::LibNanomsg.nn_close(@socket))
+  end
+
+  def assert(rc)
+    raise "Last API call failed at #{caller(1)}" unless rc >= 0
+  end
+end
+
+class Receiver < Node
+  def allocate_socket
+    @socket = NNCore::LibNanomsg.nn_socket(NNCore::AF_SP, NNCore::NN_REP)
+    assert(@socket)
+  end
+
+  def set_endpoint
+    assert(NNCore::LibNanomsg.nn_bind(@socket, @endpoint))
+  end
+
+  def run
+    @count.times do
+      nbytes = recv_msg
+
+      raise "Message size doesn't match, expected [#{@size}] but received [#{string.size}]" if @size != nbytes
+
+      send_msg
+    end
+
+    terminate
+  end
+end
+
+class Transmitter < Node
+  def allocate_socket
+    @socket = NNCore::LibNanomsg.nn_socket(NNCore::AF_SP, NNCore::NN_REQ)
+    assert(@socket)
+  end
+
+  def set_endpoint
+    assert(NNCore::LibNanomsg.nn_connect(@socket, @endpoint))
+  end
+
+  def run
+    elapsed = elapsed_microseconds do
+      @count.times do
+        send_msg
+
+        nbytes = recv_msg
+
+        raise "Message size doesn't match, expected [#{@size}] but received [#{nbytes}]" if @size != nbytes
+      end
+    end
+
+    latency = elapsed / @count / 2
+
+    puts "message size: %i [B]" % @size
+    puts "roundtrip count: %i" % @count
+    puts "throughput (msgs/s): %i" % (@count / (elapsed / 1_000_000))
+    puts "mean latency: %.3f [us]" % latency
+    terminate
+  end
+
+  def elapsed_microseconds(&blk)
+    start = Time.now
+    yield
+    value = ((Time.now - start) * 1_000_000)
+  end
+end
+
+threads = []
+receiver = transmitter = nil
+
+threads << Thread.new do
+  receiver = Receiver.new(link, message_size, roundtrip_count)
+  receiver.run
+end
+
+sleep 1
+
+threads << Thread.new do
+  transmitter = Transmitter.new(link, message_size, roundtrip_count)
+  transmitter.run
+end
+
+set_signal_handler(receiver, transmitter)
+
+threads.each {|t| t.join}

data/lib/nn-core/libnanomsg.rb

@@ -33,25 +33,41 @@ module NNCore
     # Size_t not working properly on Windows
     find_type(:size_t) rescue typedef(:ulong, :size_t)
 
+    @blocking = true
     attach_function :nn_version, [:pointer, :pointer, :pointer], :int
     
+    @blocking = true
     attach_function :nn_errno, [], :int
+    @blocking = true
     attach_function :nn_strerror, [:int], :string
+    @blocking = true
     attach_function :nn_socket, [:int, :int], :int
+    @blocking = true
     attach_function :nn_close, [:int], :int
     
+    @blocking = true
     attach_function :nn_getsockopt, [:int, :int, :int, :pointer, :pointer], :int
+    @blocking = true
     attach_function :nn_setsockopt, [:int, :int, :int, :pointer, :size_t], :int
+    @blocking = true
     attach_function :nn_bind, [:int, :string], :int
+    @blocking = true
     attach_function :nn_connect, [:int, :string], :int
+    @blocking = true
     attach_function :nn_shutdown, [:int, :int], :int
+    @blocking = true
     attach_function :nn_send, [:int, :pointer, :size_t, :int], :int
+    @blocking = true
     attach_function :nn_recv, [:int, :pointer, :size_t, :int], :int
 
     # functions for working with raw buffers
+    @blocking = true
     attach_function :nn_sendmsg, [:int, :pointer, :int], :int
+    @blocking = true
     attach_function :nn_recvmsg, [:int, :pointer, :int], :int
+    @blocking = true
     attach_function :nn_allocmsg, [:size_t, :int], :pointer
+    @blocking = true
     attach_function :nn_freemsg, [:pointer], :int        
   end
 end

data/lib/nn-core/version.rb

@@ -1,3 +1,3 @@
 module NNCore
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/spec/nn_connect_spec.rb

@@ -53,35 +53,28 @@ module NNCore
           LibNanomsg.nn_errno.should == EINVAL
         end
 
-#        it "returns -1 for an invalid TCP address (missing port)" do
-#          rc = LibNanomsg.nn_connect(@socket, "tcp://*:")
-#          rc.should == -1
-#          LibNanomsg.nn_errno.should == EINVAL
-#        end
-#
-#        it "returns -1 for an invalid TCP address (non-numeric port)" do
-#          rc = LibNanomsg.nn_connect(@socket, "tcp://192.168.0.1:port")
-#          rc.should == -1
-#          LibNanomsg.nn_errno.should == EINVAL
-#        end
-#
-#        it "returns -1 for an invalid TCP address (port number is out of range)" do
-#          rc = LibNanomsg.nn_connect(@socket, "tcp://192.168.0.1:65536")
-#          rc.should == -1
-#          LibNanomsg.nn_errno.should == EINVAL
-#        end
+        it "returns -1 for an invalid TCP address (missing port)" do
+          rc = LibNanomsg.nn_connect(@socket, "tcp://*:")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
+        end
 
-        it "returns -1 for an unsupported transport protocol" do
-          rc = LibNanomsg.nn_connect(@socket, "zmq://192.168.0.1:65536")
+        it "returns -1 for an invalid TCP address (non-numeric port)" do
+          rc = LibNanomsg.nn_connect(@socket, "tcp://192.168.0.1:port")
           rc.should == -1
-          LibNanomsg.nn_errno.should == EPROTONOSUPPORT
+          LibNanomsg.nn_errno.should == EINVAL
+        end
+
+        it "returns -1 for an invalid TCP address (port number is out of range)" do
+          rc = LibNanomsg.nn_connect(@socket, "tcp://192.168.0.1:65536")
+          rc.should == -1
+          LibNanomsg.nn_errno.should == EINVAL
         end
 
-        it "returns -1 for specifying a non-existent device using TCP transport" do
-          pending # currently fails
-          rc = LibNanomsg.nn_connect(@socket, "tcp://doesntexist:5555")
+        it "returns -1 for an unsupported transport protocol" do
+          rc = LibNanomsg.nn_connect(@socket, "zmq://192.168.0.1:65536")
           rc.should == -1
-          LibNanomsg.nn_errno.should == ENODEV
+          LibNanomsg.nn_errno.should == EPROTONOSUPPORT
         end
 
         it "returns 2 when connecting twice to an existing endpoint" do

data/spec/nn_recv_spec.rb

@@ -40,7 +40,10 @@ module NNCore
             buffer = FFI::MemoryPointer.new(:pointer)
             nbytes = LibNanomsg.nn_recv(@socket, buffer, NN_MSG, 0)
             nbytes.should == 3
-            buffer.get_pointer(0).read_string.should == string
+            
+            # important to pass +nbytes+ to #read_string since the sent string
+            # is not null-terminated
+            buffer.get_pointer(0).read_string(nbytes).should == string
           end
         end
       end

data/spec/nn_socket_spec.rb

@@ -33,11 +33,10 @@ module NNCore
       end
 
       context "given an unsupported address family" do
-
-        #        it "nn_socket returns -1 and sets nn_errno to EAFNOSUPPORT" do
-        #          LibNanomsg.nn_socket(0, NN_PUB).should == -1
-        #          LibNanomsg.nn_errno.should == EAFNOSUPPORT
-        #        end
+        it "nn_socket returns -1 and sets nn_errno to EAFNOSUPPORT" do
+          LibNanomsg.nn_socket(0, NN_PUB).should == -1
+          LibNanomsg.nn_errno.should == EAFNOSUPPORT
+        end
       end
 
       context "given an unsupported protocol and a supported address family" do

data/spec/nn_version_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 module NNCore
-  describe "nn_bind" do
+  describe "nn_version" do
 
     context "given an initialized library" do
 

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ module NNCore
     :NN_LINGER => NN_LINGER,
     :NN_SNDBUF => NN_SNDBUF,
     :NN_RCVBUF => NN_RCVBUF,
-    :NN_SENDTIMEO => NN_SNDTIMEO,
+    :NN_SNDTIMEO => NN_SNDTIMEO,
     :NN_RCVTIMEO => NN_RCVTIMEO,
     :NN_RECONNECT_IVL => NN_RECONNECT_IVL,
     :NN_RECONNECT_IVL_MAX => NN_RECONNECT_IVL_MAX,

metadata

@@ -1,64 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: nn-core
 version: !ruby/object:Gem::Version
+  version: 0.1.6
   prerelease: 
-  version: 0.1.5
 platform: ruby
 authors:
 - Chuck Remes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-15 00:00:00.000000000 Z
+date: 2013-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
   type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  name: ffi
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: ffi
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
     none: false
   type: :development
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
     none: false
-  name: rspec
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  requirement: !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
   type: :development
-  version_requirements: !ruby/object:Gem::Requirement
+  name: rake
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
-  name: rake
 description: ! 'Wraps the nanomsg networking library using the ruby FFI (foreign
 
   function interface). It only exposes the native C API to Ruby. Other gems should
@@ -85,6 +85,8 @@ files:
   UkVBRE1FLm1k
 - !binary |-
   UmFrZWZpbGU=
+- !binary |-
+  ZXhhbXBsZXMvcm91bmR0cmlwX2xhdGVuY3kucmI=
 - !binary |-
   bGliL25uLWNvcmUucmI=
 - !binary |-