ffi-rzmq 0.9.2 → 0.9.3

data/History.txt

@@ -1,3 +1,21 @@
+== 0.9.3 / 20111214
+  * Performance optimizations for #getsockopt.
+  
+  * Fixed Message#copy and Message#move. They didn't work before.
+  
+  * Cache LibZM::Msg.size in the ZMQ::Message class so that 
+    initialization can skip recalculating what is effectively a
+    constant value. This speeds up ZMQ::Message instantiation by
+    5 to 10%. Wow.
+    
+  * Modified calls to #super to use explicit arguments (e.g. #super())
+    because otherwise the Ruby runtime has to (at runtime) dig out
+    the arguments that are expected to be passed up the chain. By
+    explicitly listing the args and using parentheses, the runtime
+    can avoid that work and dispatch directly. This effects all
+    Ruby runtimes, but it was through the work of Evan Phoenix that
+    I figured this out. Results in a 2-5% speedup on method dispatch.
+
 == 0.9.2 / 20111115
   * Removed all references to the version4 API.
   

data/ffi-rzmq.gemspec

@@ -21,7 +21,7 @@ MRI 1.9.x, Rubinius and JRuby.}
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "ffi", [">= 1.0.9"]
+  s.add_runtime_dependency "ffi"#, [">= 1.0.9"]
   s.add_development_dependency "rspec", ["~> 2.6"]
   s.add_development_dependency "rake"
 end

data/lib/ffi-rzmq/message.rb

@@ -94,12 +94,10 @@ module ZMQ
     end
 
     def initialize message = nil
-      @state = :uninitialized
-
       # allocate our own pointer so that we can tell it to *not* zero out
       # the memory; it's pointless work since the library is going to
       # overwrite it anyway.
-      @pointer = FFI::MemoryPointer.new LibZMQ::Msg.size, 1, false
+      @pointer = FFI::MemoryPointer.new Message.msg_size, 1, false
 
       if message
         copy_in_string message
@@ -147,11 +145,11 @@ module ZMQ
     alias :pointer :address
 
     def copy source
-      LibZMQ.zmq_msg_copy @pointer, source.address
+      LibZMQ.zmq_msg_copy @pointer, source
     end
 
     def move source
-      LibZMQ.zmq_msg_move @pointer, source.address
+      LibZMQ.zmq_msg_move @pointer, source
     end
 
     # Provides the size of the data buffer for this +zmq_msg_t+ C struct.
@@ -193,6 +191,12 @@ module ZMQ
       
       rc
     end
+    
+    # cache the msg size so we don't have to recalculate it when creating
+    # each new instance
+    @msg_size = LibZMQ::Msg.size
+    
+    def self.msg_size() @msg_size; end
 
   end # class Message
 
@@ -228,7 +232,7 @@ module ZMQ
     # handles deallocation of the native memory buffer.
     #
     def copy_in_bytes bytes, len
-      rc = super
+      rc = super(bytes, len)
       
       # make sure we have a way to deallocate this memory if the object goes
       # out of scope
@@ -240,7 +244,7 @@ module ZMQ
     # buffer.
     #
     def close
-      rc = super
+      rc = super()
       remove_finalizer
       rc
     end
@@ -268,6 +272,11 @@ module ZMQ
       end
     end
 
+    # cache the msg size so we don't have to recalculate it when creating
+    # each new instance
+    # need to do this again because ivars are not inheritable
+    @msg_size = LibZMQ::Msg.size
+
   end # class ManagedMessage
 
 end # module ZMQ

data/lib/ffi-rzmq/socket.rb

@@ -82,7 +82,9 @@ module ZMQ
         raise ContextError.new 'zmq_socket', 0, ETERM, "Context pointer was null"
       end
 
-      @sockopt_cache = {}
+      @more_parts_array = []
+      @option_lookup = []
+      populate_option_lookup
 
       define_finalizer
     end
@@ -123,17 +125,17 @@ module ZMQ
     #  ZMQ::Util.resultcode_ok?(rc) ? puts("succeeded") : puts("failed")
     #
     def setsockopt name, value, length = nil
-      if long_long_option?(name)
+      if 1 == @option_lookup[name]
         length = 8
         pointer = LibC.malloc length
         pointer.write_long_long value
 
-      elsif int_option?(name)
+      elsif 0 == @option_lookup[name]
         length = 4
         pointer = LibC.malloc length
         pointer.write_int value
 
-      elsif string_option?(name)
+      elsif 2 == @option_lookup[name]
         length ||= value.size
 
         # note: not checking errno for failed memory allocations :(
@@ -166,10 +168,9 @@ module ZMQ
     #  end
     #
     def more_parts?
-      array = []
-      rc = getsockopt ZMQ::RCVMORE, array
+      rc = getsockopt ZMQ::RCVMORE, @more_parts_array
 
-      Util.resultcode_ok?(rc) ? array.at(0) : false
+      Util.resultcode_ok?(rc) ? @more_parts_array.at(0) : false
     end
 
     # Binds the socket to an +address+.
@@ -213,20 +214,22 @@ module ZMQ
     private
 
     def __getsockopt__ name, array
-      value, length = sockopt_buffers name
+      # a small optimization so we only have to determine the option
+      # type a single time; gives approx 5% speedup to do it this way.
+      option_type = @option_lookup[name]
+      
+      value, length = sockopt_buffers option_type
 
       rc = LibZMQ.zmq_getsockopt @socket, name, value, length
 
       if Util.resultcode_ok?(rc)
-        result = if int_option?(name)
-          value.read_int
-        elsif long_long_option?(name)
+        array[0] = if 1 == option_type
           value.read_long_long
-        elsif string_option?(name)
+        elsif 0 == option_type
+          value.read_int
+        elsif 2 == option_type
           value.read_string(length.read_int)
         end
-
-        array << result
       end
 
       rc
@@ -235,28 +238,28 @@ module ZMQ
     # Calls to ZMQ.getsockopt require us to pass in some pointers. We can cache and save those buffers
     # for subsequent calls. This is a big perf win for calling RCVMORE which happens quite often.
     # Cannot save the buffer for the IDENTITY.
-    def sockopt_buffers name
-      if long_long_option?(name)
+    def sockopt_buffers option_type
+      if 1 == option_type
         # int64_t or uint64_t
-        unless @sockopt_cache[:int64]
+        unless @longlong_cache
           length = FFI::MemoryPointer.new :size_t
           length.write_int 8
-          @sockopt_cache[:int64] = [FFI::MemoryPointer.new(:int64), length]
+          @longlong_cache = [FFI::MemoryPointer.new(:int64), length]
         end
 
-        @sockopt_cache[:int64]
+        @longlong_cache
 
-      elsif int_option?(name)
+      elsif 0 == option_type
         # int, 0mq assumes int is 4-bytes
-        unless @sockopt_cache[:int32]
+        unless @int_cache
           length = FFI::MemoryPointer.new :size_t
           length.write_int 4
-          @sockopt_cache[:int32] = [FFI::MemoryPointer.new(:int32), length]
+          @int_cache = [FFI::MemoryPointer.new(:int32), length]
         end
 
-        @sockopt_cache[:int32]
+        @int_cache
 
-      elsif string_option?(name)
+      elsif 2 == option_type
         length = FFI::MemoryPointer.new :size_t
         # could be a string of up to 255 bytes
         length.write_int 255
@@ -264,50 +267,30 @@ module ZMQ
 
       else
         # uh oh, someone passed in an unknown option; use a slop buffer
-        unless @sockopt_cache[:unknown]
+        unless @int_cache
           length = FFI::MemoryPointer.new :size_t
           length.write_int 4
-          @sockopt_cache[:unknown] = [FFI::MemoryPointer.new(:int32), length]
+          @int_cache = [FFI::MemoryPointer.new(:int32), length]
         end
 
-        @sockopt_cache[:unknown]
+        @int_cache
       end
     end
-
-    def supported_option? name
-      int_option?(name) || long_long_option?(name) || string_option?(name)
-    end
-
-    def int_option? name
-      EVENTS        == name ||
-      LINGER        == name ||
-      RECONNECT_IVL == name ||
-      FD            == name ||
-      TYPE          == name ||
-      BACKLOG       == name
-    end
-
-    def string_option? name
-      SUBSCRIBE   == name ||
-      UNSUBSCRIBE == name
-    end
-
-    def long_long_option? name
-      RCVMORE  == name ||
-      AFFINITY == name
-    end
-
-    def unsupported_setsock_option? name
-      RCVMORE == name
-    end
-
-    def unsupported_getsock_option? name
-      UNSUBSCRIBE == name ||
-      SUBSCRIBE   == name
+    
+    def populate_option_lookup
+      # integer options
+      [EVENTS, LINGER, RECONNECT_IVL, FD, TYPE, BACKLOG].each { |option| @option_lookup[option] = 0 }
+
+      # long long options
+      [RCVMORE, AFFINITY].each { |option| @option_lookup[option] = 1 }
+      
+      # string options
+      [SUBSCRIBE, UNSUBSCRIBE].each { |option| @option_lookup[option] = 2 }
     end
 
     def release_cache
-      @sockopt_cache.clear
+      @longlong_cache = nil
+      @int_cache = nil
     end
   end # module CommonSocketBehavior
 
@@ -330,11 +313,14 @@ module ZMQ
 
 
     private
-
-    def string_option? name
-      super ||
-      IDENTITY == name
+    
+    def populate_option_lookup
+      super()
+      
+      # string options
+      [IDENTITY].each { |option| @option_lookup[option] = 2 }
     end
+    
   end # module IdentitySupport
 
 
@@ -658,23 +644,16 @@ module ZMQ
       def noblock? flags
         (NOBLOCK & flags) == NOBLOCK
       end
+    
+    def populate_option_lookup
+      super()
+      
+      # integer options
+      [RECONNECT_IVL_MAX].each { |option| @option_lookup[option] = 0 }
 
-      def int_option? name
-        super ||
-        RECONNECT_IVL_MAX == name
-      end
-
-      def long_long_option? name
-        super ||
-        HWM               == name ||
-        SWAP              == name ||
-        RATE              == name ||
-        RECOVERY_IVL      == name ||
-        RECOVERY_IVL_MSEC == name ||
-        MCAST_LOOP        == name ||
-        SNDBUF            == name ||
-        RCVBUF            == name
-      end
+      # long long options
+      [HWM, SWAP, RATE, RECOVERY_IVL, RECOVERY_IVL_MSEC, MCAST_LOOP, SNDBUF, RCVBUF].each { |option| @option_lookup[option] = 1 }
+    end
 
       # these finalizer-related methods cannot live in the CommonSocketBehavior
       # module; they *must* be in the class definition directly
@@ -986,7 +965,7 @@ module ZMQ
       alias :noblock? :dontwait?
 
       def int_option? name
-        super ||
+        super(name) ||
         RECONNECT_IVL_MAX == name ||
         RCVHWM            == name ||
         SNDHWM            == name ||
@@ -995,6 +974,13 @@ module ZMQ
         SNDBUF            == name ||
         RCVBUF            == name
       end
+    
+    def populate_option_lookup
+      super()
+      
+      # integer options
+      [RECONNECT_IVL_MAX, RCVHWM, SNDHWM, RATE, RECOVERY_IVL, SNDBUF, RCVBUF].each { |option| @option_lookup[option] = 0 }
+    end
 
       # these finalizer-related methods cannot live in the CommonSocketBehavior
       # module; they *must* be in the class definition directly

data/lib/ffi-rzmq/version.rb

@@ -1,3 +1,3 @@
 module ZMQ
-  VERSION = "0.9.2"
+  VERSION = "0.9.3"
 end

data/spec/socket_spec.rb

@@ -366,12 +366,22 @@ module ZMQ
             array[0].should == value
           end
 
-          it "should default to a value of -1" do
-            value = -1
-            array = []
-            rc = socket.getsockopt(ZMQ::LINGER, array)
-            rc.should == 0
-            array[0].should == value
+          if ZMQ::SUB == socket_type || ZMQ::XSUB == socket_type
+            it "should default to a value of 0" do
+              value = 0
+              array = []
+              rc = socket.getsockopt(ZMQ::LINGER, array)
+              rc.should == 0
+              array[0].should == value
+            end
+          else
+            it "should default to a value of -1" do
+              value = -1
+              array = []
+              rc = socket.getsockopt(ZMQ::LINGER, array)
+              rc.should == 0
+              array[0].should == value
+            end
           end
         end # context using option ZMQ::LINGER
 

metadata

@@ -2,7 +2,7 @@
 name: ffi-rzmq
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
   - Chuck Remes
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-30 00:00:00 -06:00
-default_executable: 
+date: 2011-12-20 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: ffi
@@ -21,7 +20,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: 1.0.9
+            version: "0"
     type: :runtime
     version_requirements: *id001
   - !ruby/object:Gem::Dependency 
@@ -115,7 +114,6 @@ files:
   - spec/reqrep_spec.rb
   - spec/socket_spec.rb
   - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/chuckremes/ffi-rzmq
 licenses: []
 
@@ -139,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ffi-rzmq
-rubygems_version: 1.5.1
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: This gem wraps the ZeroMQ (0mq) networking library using Ruby FFI (foreign function interface).