io_splice 1.0.0 → 2.0.0

data/GIT-VERSION-GEN

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

data/GNUmakefile

@@ -188,7 +188,10 @@ all:: test
 
 build: $(ext)
 test: test-unit
-test-unit: build
-	$(RUBY) -I lib:ext/io_splice test/test_io_splice.rb
 
-.PHONY: .FORCE-GIT-VERSION-FILE doc manifest man test
+test_unit := $(wildcard test/test_*.rb)
+$(test_unit): build
+	$(RUBY) -I lib:ext/io_splice $@
+test-unit: $(test_unit)
+
+.PHONY: .FORCE-GIT-VERSION-FILE doc manifest man test $(test_unit)

data/LICENSE

@@ -3,8 +3,8 @@ revision control for names and email addresses of all of them.
 
 You can redistribute it and/or modify it under the terms of the GNU
 Lesser General Public License as published by the Free Software Foundation,
-version 3.0 {LGPLv3}[http://www.gnu.org/licenses/lgpl-3.0.txt] (see
-link:COPYING).
+version 2.1 or later {LGPLv2.1}[http://www.gnu.org/licenses/lgpl-2.1.txt]
+(see link:COPYING).
 
 io_splice is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

data/Rakefile

@@ -137,14 +137,14 @@ task :raa_update do
     :name => s.name,
     :short_description => s.summary,
     :version => s.version.to_s,
-    :status => 'experimental',
+    :status => 'stable',
     :owner => s.authors.first,
     :email => s.email,
     :category_major => 'Library',
     :category_minor => 'System',
     :url => s.homepage,
     :download => 'http://rubyforge.org/frs/?group_id=5626',
-    :license => 'LGPL', # LGPLv3, actually, but RAA is ancient...
+    :license => 'LGPL',
     :description_style => 'Plain',
     :description => desc,
     :pass => password,

data/examples/splice-cp.rb

@@ -10,28 +10,4 @@ require 'io/splice'
 usage = "#$0 SOURCE DEST"
 source = ARGV.shift or abort usage
 dest = ARGV.shift or abort usage
-
-source = File.open(source, 'rb')
-dest = File.open(dest, 'wb')
-source_fd, dest_fd = source.fileno, dest.fileno
-
-# We use a pipe as a ring buffer in kernel space.
-# pipes may store up to IO::Splice::PIPE_CAPA bytes
-pipe = IO.pipe
-rfd, wfd = pipe.map { |io| io.fileno }
-
-begin
-  nread = begin
-    # first pull as many bytes as possible into the pipe
-    IO.splice(source_fd, nil, wfd, nil, IO::Splice::PIPE_CAPA, 0)
-  rescue EOFError
-    break
-  end
-
-  # now move the contents of the pipe buffer into the destination file
-  # the copied data never enters userspace
-  nwritten = IO.splice(rfd, nil, dest_fd, nil, nread, 0)
-
-  nwritten == nread or
-    abort "short splice to destination file: #{nwritten} != #{nread}"
-end while true
+IO::Splice.copy_stream(source, dest)

data/examples/splice-tee.rb

@@ -11,21 +11,17 @@ $stdin.stat.pipe? or abort "stdin must be a pipe"
 $stdout.stat.pipe? or abort "stdout must be a pipe"
 
 dest = File.open(dest, 'wb')
-out_fd = dest.fileno
-
-stdin_fd = $stdin.fileno
-stdout_fd = $stdout.fileno
 
 begin
   nread = begin
     # "copy" data from stdin to stdout, without consuming stdin
-    IO.tee(stdin_fd, stdout_fd, IO::Splice::PIPE_CAPA, 0)
+    IO.tee($stdin, $stdout, IO::Splice::PIPE_CAPA, 0)
   rescue EOFError
     break
   end
 
   # sends data to the file, consumes stdin
-  nwritten = IO.splice(stdin_fd, nil, out_fd, nil, nread, 0)
+  nwritten = IO.splice($stdin, nil, dest, nil, nread, 0)
 
   nwritten == nread or
     abort "short splice to file: #{nwritten} != #{nread}"

data/ext/io_splice/extconf.rb

@@ -4,6 +4,8 @@ $CPPFLAGS << ' -D_GNU_SOURCE=1'
 have_func('splice', %w(fcntl.h)) or abort 'splice(2) not defined'
 have_func('tee', %w(fcntl.h)) or abort 'tee(2) not defined'
 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/ext/io_splice/io_splice_ext.c

@@ -4,6 +4,7 @@
 #else
 #  include "rubyio.h"
 #endif
+#include <errno.h>
 #include <fcntl.h>
 #include <assert.h>
 #include <sys/uio.h>
@@ -225,7 +226,7 @@ static VALUE my_tee(VALUE self,
 
 struct vmsplice_args {
 	int fd;
-        struct iovec *iov;
+	struct iovec *iov;
 	unsigned long nr_segs;
 	unsigned flags;
 };
@@ -243,7 +244,6 @@ do { \
 	VALUE *cur; \
 	struct iovec *tmp; \
 	long n; \
-	Check_Type(ary, T_ARRAY); \
 	cur = RARRAY_PTR(ary); \
 	n = RARRAY_LEN(ary); \
 	if (n > IOV_MAX) \
@@ -292,6 +292,7 @@ static void advance_vmsplice_args(struct vmsplice_args *a, long n)
 /*
  * call-seq:
  *   IO.vmsplice(fd, string_array, flags) => integer
+ *   IO.vmsplice(fd, string, flags) => integer
  *
  * Transfers an array of strings into the pipe descriptor given by fd.
  * +fd+ must be the writable end of a pipe.
@@ -308,7 +309,24 @@ static VALUE my_vmsplice(VALUE self, VALUE fd, VALUE data, VALUE flags)
 	ssize_t left;
 	struct vmsplice_args a;
 
-	ARY2IOVEC(a.iov, a.nr_segs, left, data);
+	switch (TYPE(data)) {
+	case T_STRING: {
+		struct iovec iov;
+
+		iov.iov_base = RSTRING_PTR(data);
+		iov.iov_len = (size_t)(left = (ssize_t)RSTRING_LEN(data));
+		a.iov = &iov;
+		a.nr_segs = 1;
+		}
+		break;
+	case T_ARRAY:
+		ARY2IOVEC(a.iov, a.nr_segs, left, data);
+		break;
+	default:
+		rb_raise(rb_eTypeError, "wrong argument type %s "
+		         "(expected a String or Array of strings)",
+		         rb_obj_classname(data));
+	}
 	a.fd = my_fileno(fd);
 	a.flags = NUM2UINT(flags);
 
@@ -353,8 +371,8 @@ void Init_io_splice_ext(void)
 
 	/*
 	 * Attempt to move pages instead of copying.  This is only a hint
-	 * and support for it was removed in Linux 2.6.21 and has not been
-	 * readded as of 2.6.30.
+	 * and support for it was removed in Linux 2.6.21.  It will be
+         * re-added for FUSE filesystems only in Linux 2.6.35.
 	 */
 	rb_define_const(mSplice, "F_MOVE", UINT2NUM(SPLICE_F_MOVE));
 
@@ -384,6 +402,15 @@ void Init_io_splice_ext(void)
 	 */
 	rb_define_const(mSplice, "F_GIFT", UINT2NUM(SPLICE_F_GIFT));
 
+#ifdef F_GETPIPE_SZ
+	/* :nodoc: */
+	rb_define_const(mSplice, "F_GETPIPE_SZ", UINT2NUM(F_GETPIPE_SZ));
+#endif
+#ifdef F_SETPIPE_SZ
+	/* :nodoc: */
+	rb_define_const(mSplice, "F_SETPIPE_SZ", UINT2NUM(F_SETPIPE_SZ));
+#endif
+
 	/*
 	 * The maximum size of an atomic write to a pipe
 	 * POSIX requires this to be at least 512 bytes.

data/io_splice.gemspec

@@ -34,5 +34,5 @@ Gem::Specification.new do |s|
 
   s.test_files = test_files
 
-  # s.licenses = %w(LGPLv3) # accessor not compatible with older RubyGems
+  # s.licenses = %w(LGPL) # accessor not compatible with older RubyGems
 end

data/lib/io/splice.rb

@@ -5,13 +5,16 @@ class IO
 
   module Splice
 
-    # the version of IO::Splice, currently 0.1.0
-    VERSION = '1.0.0'
+    # the version of IO::Splice, currently 2.0.0
+    VERSION = '2.0.0'
 
-    # The maximum capacity of the pipe in bytes.
+    # The maximum default capacity of the pipe in bytes.
     # Under stock Linux, this is 65536 bytes as of 2.6.11, and 4096 before
     # We detect this at runtime as it is easy to recompile the kernel
     # and set a new value.
+    # Starting with Linux 2.6.35, pipe capacity will be tunable
+    # and this will only represent the default capacity of a
+    # newly-created pipe.
     PIPE_CAPA = begin
       rd, wr = IO.pipe
       buf = ' ' * PIPE_BUF
@@ -26,5 +29,69 @@ class IO
       n
     end
 
+    # copies the contents of the IO object given by +src+ to +dst+
+    # If len is specified, then only len bytes are 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+
+    def self.copy_stream(src, dst, len = nil, src_offset = nil)
+      src.kind_of?(String) and src = File.open(src, 'rb')
+      dst.kind_of?(String) and dst = File.open(dst, 'wb')
+      src, dst = src.to_io, dst.to_io
+      rv = len
+      src.sysseek(src_offset) if src_offset
+      if src.stat.pipe? || dst.stat.pipe?
+        if len
+          while len > 0
+            nr = len > PIPE_CAPA ? PIPE_CAPA : len
+            nr = IO.splice(src, nil, dst, nil, nr, F_MOVE)
+            if nr == 0
+              raise EOFError, "unexpected EOF with #{len} bytes left"
+            end
+            len -= nr
+          end
+        else
+          rv = 0
+          begin
+            nr = IO.splice(src, nil, dst, nil, PIPE_CAPA, F_MOVE)
+            rv += nr
+          rescue EOFError
+            break
+          end while true
+        end
+      else
+        begin
+          r, w = IO.pipe
+          if len
+            while len > 0
+              nr = len > PIPE_CAPA ? PIPE_CAPA : len
+              nr_src = copy_stream(src, w, nr)
+              nr_src == nr or
+                raise RuntimeError, "short splice from: #{nr_src} != #{nr}"
+              nr_dst = copy_stream(r, dst, nr)
+              nr_dst == nr or
+                raise RuntimeError, "short splice to: #{nr_dst} != #{nr}"
+              len -= nr
+            end
+          else
+            rv = 0
+            begin
+              nr = IO.splice(src, nil, w, nil, PIPE_CAPA, F_MOVE)
+              rv += nr
+              begin
+                nr -= IO.splice(r, nil, dst, nil, nr, F_MOVE)
+              end while nr > 0
+            rescue EOFError
+              break
+            end while true
+          end
+        ensure
+          r.close
+          w.close
+        end
+      end
+
+      rv
+    end
+
   end
 end

data/test/test_io_splice.rb

@@ -213,6 +213,12 @@ class Test_IO_Splice < Test::Unit::TestCase
     assert_equal data.join(''), r.readpartial(16384)
   end
 
+  def test_vmsplice_string
+    r, w = IO.pipe
+    assert_equal 5, IO.vmsplice(w, 'hello', 0)
+    assert_equal 'hello', r.read(5)
+  end
+
   def test_vmsplice_array_io
     data = %w(hello world how are you today)
     r, w = IO.pipe
@@ -272,4 +278,57 @@ class Test_IO_Splice < Test::Unit::TestCase
     assert IO::Splice::PIPE_CAPA >= IO::Splice::PIPE_BUF
   end
 
+  def test_splice_copy_stream_file_to_file_small
+    a, b = Tempfile.new('a'), Tempfile.new('b')
+    a.syswrite 'hello world'
+    a.sysseek(0)
+    IO::Splice.copy_stream(a, b)
+    b.rewind
+    assert_equal 'hello world', b.read
+  end
+
+  def test_splice_copy_stream_file_to_file_big
+    buf = ('ab' * IO::Splice::PIPE_CAPA) + 'hi'
+    a, b = Tempfile.new('a'), Tempfile.new('b')
+    a.syswrite buf
+    a.sysseek(0)
+    IO::Splice.copy_stream(a, b)
+    b.rewind
+    assert_equal buf, b.read
+  end
+
+  def test_splice_copy_stream_file_to_file_len
+    a, b = Tempfile.new('a'), Tempfile.new('b')
+    a.syswrite 'hello world'
+    a.sysseek(0)
+    IO::Splice.copy_stream(a, b, 5)
+    b.rewind
+    assert_equal 'hello', b.read
+  end
+
+  def test_splice_copy_stream_pipe_to_file_len
+    a = Tempfile.new('a')
+    r, w = IO.pipe
+    w.syswrite 'hello world'
+    IO::Splice.copy_stream(r, a, 5)
+    a.rewind
+    assert_equal 'hello', a.read
+  end
+
+  def test_splice_copy_stream_paths
+    a = Tempfile.new('a')
+    b = Tempfile.new('a')
+    a.syswrite('hello world')
+    IO::Splice.copy_stream(a.path, b.path, 5)
+    assert_equal 'hello', b.read
+  end
+
+  def test_splice_copy_stream_src_offset
+    a = Tempfile.new('a')
+    b = Tempfile.new('a')
+    a.syswrite('hello world')
+    IO::Splice.copy_stream(a.path, b.path, 5, 6)
+    assert_equal 'world', b.read
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: io_splice
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors: 
 - io_splice hackers
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 +00:00
+date: 2010-06-05 00:00:00 +00:00
 default_executable: 
 dependencies: []