io_splice 4.1.0 → 4.1.1

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v4.1.0.GIT
+DEF_VER=v4.1.1.GIT
 
 LF='
 '

data/ext/io_splice/io_splice_ext.c

@@ -217,9 +217,9 @@ static ssize_t do_splice(int argc, VALUE *argv, unsigned dflags)
  * into account userspace buffering done by Ruby or stdio.  It is
  * also not subject to encoding/decoding filters under Ruby 1.9.
  *
- * Consider using IO.trysplice if you are using non-blocking I/O on
- * both descriptors as it avoids the cost of raising common Errno::EAGAIN
- * exceptions.
+ * Consider using IO.trysplice if +io_out+ is a pipe or if you are using
+ * non-blocking I/O on both descriptors as it avoids the cost of raising
+ * common Errno::EAGAIN exceptions.
  *
  * See manpage for full documentation:
  * http://kernel.org/doc/man-pages/online/pages/man2/splice.2.html
@@ -247,6 +247,8 @@ static VALUE my_splice(int argc, VALUE *argv, VALUE self)
  * but this can still block if the non-pipe descriptor is blocking.
  *
  * See IO.splice documentation for more details.
+ *
+ * This method is recommended whenever +io_out+ is a pipe.
  */
 static VALUE trysplice(int argc, VALUE *argv, VALUE self)
 {
@@ -639,6 +641,12 @@ void Init_io_splice_ext(void)
 	 * themselves are ignored by this family of functions, and
 	 * using this flag is the only way to get non-blocking operation
 	 * out of them.
+	 *
+	 * It is highly recommended this flag be set (or IO.trysplice used)
+	 * whenever splicing from a socket into a pipe unless there is
+	 * another (native) thread or process doing a blocking read on that
+	 * pipe.  Otherwise it is possible to block a single-threaded process
+	 * if the socket buffers are larger than the pipe buffers.
 	 */
 	rb_define_const(mSplice, "F_NONBLOCK", UINT2NUM(SPLICE_F_NONBLOCK));
 	assert(WAITALL != SPLICE_F_NONBLOCK && "WAITALL == F_NONBLOCK");

data/lib/io/splice.rb

@@ -84,6 +84,13 @@ module IO::Splice
   # This will block and wait for IO completion of +len+
   # Raises +EOFError+ if end of file is reached.
   # bytes.  Returns the number of bytes actually spliced (always +len+)
+  # unless +src+ does not have +len+ bytes to read.
+  #
+  # Do not use this method to splice a socket +src+ into a pipe +dst+
+  # unless there is another process or native thread doing a blocking
+  # read on the other end of the +dst+ pipe.
+  #
+  # This method is safe for splicing a pipe +src+ into any type of +dst+ IO.
   def self.full(src, dst, len, src_offset)
     IO.splice(src, src_offset, dst, nil, len, F_MOVE | WAITALL)
   end
@@ -94,16 +101,15 @@ module IO::Splice
   # Returns the number of bytes actually spliced.
   # Like IO#readpartial, this never returns Errno::EAGAIN
   def self.partial(src, dst, len, src_offset)
-    IO.splice(src, src_offset, dst, nil, len, F_MOVE)
-    rescue EOFError
-      nil
-    rescue Errno::EAGAIN
-      begin
-        src.to_io.wait
-        IO.select(nil, [dst])
-        rv = IO.trysplice(src, src_offset, dst, nil, len, F_MOVE)
-      end while rv == :EAGAIN
-      rv
+    case rv = IO.trysplice(src, src_offset, dst, nil, len, F_MOVE)
+    when :EAGAIN
+      src.to_io.wait
+      IO.select(nil, [dst])
+    when Integer
+      return rv
+    else
+      return nil
+    end while true
   end
 end
 if (! defined?(RUBY_ENGINE) || RUBY_ENGINE == "ruby") &&

data/test/test_tcp_splice.rb

@@ -0,0 +1,49 @@
+require 'socket'
+require 'io/wait'
+require 'io/splice'
+require 'io/nonblock'
+require "test/unit"
+
+class TestTCPCopyStream < Test::Unit::TestCase
+  def setup
+    host = ENV["TEST_HOST"] || "127.0.0.1"
+    @srv = TCPServer.new(host, 0)
+    @port = @srv.addr[1]
+    @client = TCPSocket.new(host, @port)
+    @client.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+    @accept = @srv.accept
+    @accept.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+    @client.sync = @accept.sync = true
+    @r, @w = IO.pipe
+  end
+
+  def teardown
+    @srv.close
+    [ @client, @accept, @r, @w ].each { |io| io.close unless io.closed? }
+  end
+
+  def test_client_to_server_eof
+    nr = 2000
+    buf = '0123456789abcdef' * 1024
+    expect = buf.size * nr
+    thr = Thread.new do
+      nr.times { @client.write(buf) }
+      @client.close
+    end
+    sleep 1 # wait for rcvbuf to fill up
+    bytes = IO::Splice.copy_stream(@accept, "/dev/null")
+    assert_equal expect, bytes
+  end
+
+  def test_client_to_server_expect
+    nr = 2000
+    buf = '0123456789abcdef' * 1024
+    expect = buf.size * nr
+    thr = Thread.new do
+      nr.times { @client.write(buf) }
+    end
+    sleep 1 # wait for rcvbuf to fill up
+    bytes = IO::Splice.copy_stream(@accept, "/dev/null", expect)
+    assert_equal expect, bytes
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: io_splice
 version: !ruby/object:Gem::Version 
-  hash: 59
+  hash: 57
   prerelease: 
   segments: 
   - 4
   - 1
-  - 0
-  version: 4.1.0
+  - 1
+  version: 4.1.1
 platform: ruby
 authors: 
 - Ruby io_splice hackers
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 Z
+date: 2011-05-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: wrongdoc
@@ -96,6 +96,7 @@ files:
 - test/test_io_splice_eintr.rb
 - test/test_io_splice_in_full.rb
 - test/test_rack_file_compat.rb
+- test/test_tcp_splice.rb
 homepage: http://bogomips.org/ruby_io_splice/
 licenses: []
 
@@ -135,6 +136,7 @@ summary: zero-copy pipe I/O for Linux and Ruby
 test_files: 
 - test/test_rack_file_compat.rb
 - test/test_io_splice_in_full.rb
+- test/test_tcp_splice.rb
 - test/test_io_splice.rb
 - test/test_copy_stream.rb
 - test/test_io_splice_eintr.rb