io_splice 3.0.0 → 3.1.0

data/ChangeLog

@@ -1,5 +1,44 @@
-ChangeLog from http://bogomips.org/ruby_io_splice.git (v1.0.0..v3.0.0)
+ChangeLog from http://bogomips.org/ruby_io_splice.git (v1.0.0..v3.1.0)
 
+   commit 0b07f9c8ac10219590beebb9038f92efd6c3ebaf
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Sun May 1 14:11:11 2011 -0700
+   
+       io_splice 3.1.0 - IO::Splice.copy_stream improvement
+       
+       IO::Splice.copy_stream no longer modifies the actual file offset
+       of the given source file (if it's a regular file).  This follows
+       IO.copy_stream and IO#sendfile semantics, allowing multiple
+       threads/processes to simultaneously stream a single regular file
+       descriptor to multiple sockets/pipes.
+   
+   commit 5e544bc745e5216f2455fa0ad398e39097debe60
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Sun May 1 13:58:23 2011 -0700
+   
+       minor documentation updates
+       
+       IO::Splice.copy_stream is more useful, now
+   
+   commit b5ec116e331c22c064bee46f63145e325785e33f
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Sun May 1 13:29:51 2011 -0700
+   
+       IO::Splice.copy_stream doesn't change offset of source file
+       
+       This is for compatibility with IO.copy_stream and IO#sendfile,
+       both of which use pread()-semantics when given a source file
+       offset.   This allows multiple threads/processes to copy from
+       the same file handle.
+   
+   commit b39448e121f8f060c274ee1ee3c473f7b20d92e1
+   Author: Eric Wong <normalperson@yhbt.net>
+   Date:   Wed Apr 27 11:36:33 2011 -0700
+   
+       extconf: remove unnecessary dir_config statement
+       
+       I didn't know mkmf at the time :<
+   
    commit 73b61c10c0085ee4a26a321375938bce16fb8a6d
    Author: Eric Wong <normalperson@yhbt.net>
    Date:   Tue Mar 1 09:29:57 2011 +0000

data/GIT-VERSION-FILE

@@ -1 +1 @@
-GIT_VERSION = 3.0.0
+GIT_VERSION = 3.1.0

data/GIT-VERSION-GEN

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

data/LATEST

@@ -1,15 +1,8 @@
-=== io_splice 3.0.0 - kinder, gentler Linux zero-copy / 2011-03-01 09:38 UTC
+=== io_splice 3.1.0 - IO::Splice.copy_stream improvement / 2011-05-01 21:17 UTC
 
-  This release adds the IO.trysplice and IO.trytee interfaces
-  to avoid expensive EAGAIN exceptions for non-blocking I/O.
-
-  There is no IO.tryvmsplice method as we still haven't figured
-  out a good use for IO.vmsplice in Ruby, and non-blocking I/O
-  with iovecs is just painful!  If you want more zero-copy fun
-  without needing mmap(2), check out the "sendfile" RubyGem and
-  IO.copy_stream (1.9).  As of Linux 2.6.33+, sendfile(2) can copy
-  mmap-able files to +any+ descriptor, not just sockets.
-
-  Please email us at ruby.io.splice@librelist.com if you can think
-  of a good use for IO.vmsplice or IO.trysplice in Ruby.
+  IO::Splice.copy_stream no longer modifies the actual file offset
+  of the given source file (if it's a regular file).  This follows
+  IO.copy_stream and IO#sendfile semantics, allowing multiple
+  threads/processes to simultaneously stream a single regular file
+  descriptor to multiple sockets/pipes.
 

data/NEWS

@@ -1,3 +1,11 @@
+=== io_splice 3.1.0 - IO::Splice.copy_stream improvement / 2011-05-01 21:17 UTC
+
+  IO::Splice.copy_stream no longer modifies the actual file offset
+  of the given source file (if it's a regular file).  This follows
+  IO.copy_stream and IO#sendfile semantics, allowing multiple
+  threads/processes to simultaneously stream a single regular file
+  descriptor to multiple sockets/pipes.
+
 === io_splice 3.0.0 - kinder, gentler Linux zero-copy / 2011-03-01 09:38 UTC
 
   This release adds the IO.trysplice and IO.trytee interfaces

data/README

@@ -12,11 +12,13 @@ buffer.
 
 * More flexible than sendfile, may be used to enable copies between
   arbitrary file descriptors (assuming kernel support), not just
-  socket-to-file.
+  file-to-socket (or file-to-anything in newer Linux).
 
 * Thread-safe blocking operations under Ruby 1.9, releases GVL
   if blocking operations are used.
 
+* Almost drop-in replacement for IO.copy_stream: IO::Splice.copy_stream
+
 * Safely usable with non-blocking I/O frameworks (unlike IO.copy_stream)
   when combined with the IO::Splice::F_NONBLOCK flag.
 
@@ -72,7 +74,7 @@ You can get the latest source via git from the following locations:
 You may browse the code from the web and download the latest snapshot
 tarballs here:
 
-* http://bogomips.org/cgit/ruby_io_splice.git (cgit)
+* http://bogomips.org/ruby_io_splice.git (cgit)
 * http://repo.or.cz/w/ruby_io_splice.git (gitweb)
 
 Inline patches (from "git format-patch") to the mailing list are

data/ext/io_splice/extconf.rb

@@ -7,5 +7,4 @@ have_func('rb_thread_blocking_region')
 have_macro('F_GETPIPE_SZ', %w(fcntl.h))
 have_macro('F_SETPIPE_SZ', %w(fcntl.h))
 
-dir_config('io_splice')
 create_makefile('io_splice_ext')

data/lib/io/splice.rb

@@ -29,21 +29,24 @@ module IO::Splice
   # +EOFError+ is raised if fewer than +len+ bytes could be copied.
   # Otherwise the copy will be until EOF is reached on the +src+.
   # +src+ and +dst+ must be IO objects or respond to +to_io+
+  #
+  # This is nearly a drop-in replacement for IO.copy_stream (in Ruby 1.9)
+  # but does not take into account userspace I/O buffers nor IO-like
+  # objects with no underlying file descriptor (e.g. StringIO).
   def self.copy_stream(src, dst, len = nil, src_offset = nil)
     close = []
     src.kind_of?(String) and close << (src = File.open(src))
     dst.kind_of?(String) and close << (dst = File.open(dst, "w"))
     src, dst = src.to_io, dst.to_io
     rv = len
-    src.sysseek(src_offset) if src_offset
     select_args = selectable(src, dst)
 
     if src.stat.pipe? || dst.stat.pipe?
       if len
-        len -= full(src, dst, len, select_args) until len == 0
+        len -= full(src, dst, len, src_offset, select_args) until len == 0
       else
         rv = 0
-        while n = partial(src, dst, PIPE_CAPA, select_args)
+        while n = partial(src, dst, PIPE_CAPA, src_offset, select_args)
           rv += n
         end
       end
@@ -51,13 +54,13 @@ module IO::Splice
       r, w = tmp = IO.pipe
       close.concat(tmp)
       if len
-        while len != 0 && n = partial(src, w, len, select_args)
-          len -= full(r, dst, n, select_args)
+        while len != 0 && n = partial(src, w, len, src_offset, select_args)
+          len -= full(r, dst, n, nil, select_args)
         end
       else
         rv = 0
-        while n = partial(src, w, PIPE_CAPA, select_args)
-          rv += full(r, dst, n, select_args)
+        while n = partial(src, w, PIPE_CAPA, src_offset, select_args)
+          rv += full(r, dst, n, nil, select_args)
         end
       end
     end
@@ -76,10 +79,10 @@ module IO::Splice
   # The +_select_args+ parameter is reserved for internal use and
   # may be removed in future versions.  Do not write code that
   # depends on +_select_args+.
-  def self.full(src, dst, len, _select_args = selectable(src, dst))
+  def self.full(src, dst, len, src_offset, _select_args = selectable(src, dst))
     nr = len
     while nr > 0
-      n = partial(src, dst, nr, _select_args) or
+      n = partial(src, dst, nr, src_offset, _select_args) or
                                      raise EOFError, "end of file reached"
       nr -= n
     end
@@ -94,15 +97,16 @@ module IO::Splice
   # The +_select_args+ parameter is reserved for internal use and
   # may be removed in future versions.  Do not write code that
   # depends on +_select_args+.
-  def self.partial(src, dst, len, _select_args = selectable(src, dst))
+  def self.partial(src, dst, len, src_offset,
+                   _select_args = selectable(src, dst))
     begin
-      rv = IO.trysplice(src, nil, dst, nil, len, F_MOVE)
+      rv = IO.trysplice(src, src_offset, dst, nil, len, F_MOVE)
     end while rv == :EAGAIN and IO.select(*_select_args)
     rv
   end
 
   # returns an array suitable for splat-ing to IO.select for blocking I/O
-  def self.selectable(src, dst)
+  def self.selectable(src, dst) # :nodoc:
     rv = []
     src.stat.pipe? or rv[0] = [ src ]
     dst.stat.pipe? or rv[1] = [ dst ]

data/test/test_io_splice.rb

@@ -392,6 +392,16 @@ class Test_IO_Splice < Test::Unit::TestCase
     assert_equal 'world', b.read
   end
 
+  def test_splice_copy_stream_src_offset_unchanged
+    a = Tempfile.new('a')
+    b = Tempfile.new('a')
+    a.syswrite('hello world')
+    assert_equal 0, a.sysseek(0, IO::SEEK_SET)
+    IO::Splice.copy_stream(a, b.path, 5, 6)
+    assert_equal 'world', b.read
+    assert_equal 0, a.sysseek(0, IO::SEEK_CUR)
+  end
+
   def test_copy_stream_nonblock_src
     server = TCPServer.new('127.0.0.1', 0)
     port = server.addr[1]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: io_splice
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 3
+  - 1
   - 0
-  - 0
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors: 
 - Ruby io_splice hackers
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-01 00:00:00 +00:00
-default_executable: 
+date: 2011-05-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: wrongdoc
@@ -76,7 +75,6 @@ files:
 - pkg.mk
 - setup.rb
 - test/test_io_splice.rb
-has_rdoc: true
 homepage: http://bogomips.org/ruby_io_splice/
 licenses: []
 
@@ -109,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: qrp
-rubygems_version: 1.5.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: zero-copy pipe I/O for Linux and Ruby