io_splice 2.1.0 → 2.2.0

data/README

@@ -23,6 +23,9 @@ buffer.
 * Fully-documented library API and
   {examples}[http://bogomips.org/ruby_io_splice/examples/]
 
+* Adds helpful IO#pipe_size and IO#pipe_size= accessor methods for
+  resizing the pipe buffer in Linux 2.6.35 or later.
+
 == Install
 
 Operating system support for the splice(2), tee(2) and vmsplice(2)

data/ext/io_splice/io_splice_ext.c

@@ -10,6 +10,16 @@
 #include <sys/uio.h>
 #include <limits.h>
 #include <alloca.h>
+#include <sys/utsname.h>
+
+#ifndef F_LINUX_SPECIFIC_BASE
+#  define F_LINUX_SPECIFIC_BASE 1024
+#endif
+
+#ifndef F_GETPIPE_SZ
+#  define F_SETPIPE_SZ    (F_LINUX_SPECIFIC_BASE + 7)
+#  define F_GETPIPE_SZ    (F_LINUX_SPECIFIC_BASE + 8)
+#endif
 
 #if ! HAVE_RB_IO_T
 #  define rb_io_t OpenFile
@@ -361,9 +371,76 @@ static VALUE my_vmsplice(VALUE self, VALUE fd, VALUE data, VALUE flags)
 	return LONG2NUM(rv);
 }
 
+/*
+ * call-seq:
+ *   reader, writer = IO.pipe
+ *   reader.pipe_size => integer
+ *
+ * Returns the pipe capacity of the underlying pipe in bytes.  The
+ * default capacity is 65536 bytes since Linux 2.6.11, and 4096 bytes
+ * in previous kernels.
+ *
+ * Since the pipe is a circular buffer in the same kernel, the size
+ * of the reader is exactly the same as the size of the writer.
+ *
+ * This method is only exposed on Linux 2.6.35 or later.
+ */
+static VALUE pipe_size(VALUE self)
+{
+	int size = fcntl(my_fileno(self),  F_GETPIPE_SZ);
+
+	if (size < 0)
+		rb_sys_fail("fcntl(F_GETPIPE_SZ)");
+
+	return INT2NUM(size);
+}
+
+/*
+ * call-seq:
+ *   reader, writer = IO.pipe
+ *   reader.pipe_size = integer
+ *
+ * Sets and returns the pipe capacity of the underlying pipe in bytes.
+ *
+ * This MUST be a power-of-two, or Errno::EINVAL will be raised.
+ * Linux will silently increase this to be equal to the page size
+ * (4096 bytes on most architectures) if the specified value is
+ * less than the size of a page.
+ *
+ * For users without CAP_SYS_RESOURCE, this raises Errno::EPERM when
+ * attempting to specify a value greater than the value in
+ * /proc/sys/fs/pipe-max-size.
+ *
+ * Since the pipe is a circular buffer in the same kernel, the size
+ * of the reader is exactly the same as the size of the writer.
+ *
+ * Raises Errno::EBUSY if the assigned value is less than
+ * the currently filled portion of the pipe.
+ *
+ * This method is only exposed on Linux 2.6.35 or later.
+ */
+static VALUE set_pipe_size(VALUE self, VALUE size)
+{
+	int fd = my_fileno(self);
+	int bytes = NUM2INT(size);
+	int rv = fcntl(fd, F_SETPIPE_SZ, bytes);
+
+	if (rv < 0) {
+		if (errno == ENOMEM) {
+			rb_gc();
+			rv = fcntl(fd, F_SETPIPE_SZ, bytes);
+		}
+		if (rv < 0)
+			rb_sys_fail("fcntl(F_SETPIPE_SZ)");
+	}
+
+	return size;
+}
+
 void Init_io_splice_ext(void)
 {
 	VALUE mSplice = rb_define_module_under(rb_cIO, "Splice");
+	struct utsname utsname;
 
 	rb_define_singleton_method(rb_cIO, "splice", my_splice, 6);
 	rb_define_singleton_method(rb_cIO, "tee", my_tee, 4);
@@ -402,19 +479,35 @@ 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.
 	 * Under Linux, this is 4096 bytes.
 	 */
 	rb_define_const(mSplice, "PIPE_BUF", UINT2NUM(PIPE_BUF));
+
+	if (uname(&utsname) == -1)
+		rb_sys_fail("uname");
+
+	/* includes 2.6.35-rc[1-6] */
+	if (strcmp(utsname.release, "2.6.35") >= 0) {
+		rb_define_method(rb_cIO, "pipe_size", pipe_size, 0);
+		rb_define_method(rb_cIO, "pipe_size=", set_pipe_size, 1);
+
+		/*
+		 * fcntl() command constant used to return the size of a pipe.
+		 * This constant is only defined when running Linux 2.6.35
+		 * or later.  For convenience, use IO#pipe_size instead.
+		 */
+		rb_define_const(mSplice, "F_GETPIPE_SZ",
+		                UINT2NUM(F_GETPIPE_SZ));
+
+		/*
+		 * fcntl() command constant used to set the size of a pipe.
+		 * This constant is only defined when running Linux 2.6.35
+		 * or later.  For convenience, use IO#pipe_size= instead.
+		 */
+		rb_define_const(mSplice, "F_SETPIPE_SZ",
+		                UINT2NUM(F_SETPIPE_SZ));
+	}
 }

data/lib/io/splice.rb

@@ -5,8 +5,8 @@ class IO
 
   module Splice
 
-    # the version of IO::Splice, currently 2.1.0
-    VERSION = '2.1.0'
+    # the version of IO::Splice, currently 2.2.0
+    VERSION = '2.2.0'
 
     # The maximum default capacity of the pipe in bytes.
     # Under stock Linux, this is 65536 bytes as of 2.6.11, and 4096 before

data/test/test_io_splice.rb

@@ -251,7 +251,7 @@ class Test_IO_Splice < Test::Unit::TestCase
         tmp = []
         begin
           sleep 0.005
-          tmp << rd.readpartial(8192, buf)
+          tmp << rd.readpartial(8192)
         rescue EOFError
           break
         end while true
@@ -393,4 +393,19 @@ class Test_IO_Splice < Test::Unit::TestCase
     assert_equal 'hello world', a.read
   end
 
+  def test_pipe_size
+    r, w = IO.pipe
+    assert Integer, r.pipe_size
+    assert(r.pipe_size >= 512)
+    assert_nothing_raised { w.pipe_size = 8192 }
+    assert 8192, r.pipe_size
+
+    w.write('*' * 4097)
+    assert_raises(Errno::EBUSY) { r.pipe_size = 4096 }
+
+    pipe_max_size = File.read("/proc/sys/fs/pipe-max-size").to_i
+    assert_nothing_raised { r.pipe_size = pipe_max_size }
+    assert_raises(Errno::EPERM) { r.pipe_size = pipe_max_size * 2 }
+  end if IO.method_defined?(:pipe_size)
+
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: io_splice
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  hash: 7
+  prerelease: false
+  segments: 
+  - 2
+  - 2
+  - 0
+  version: 2.2.0
 platform: ruby
 authors: 
 - io_splice hackers
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-06 00:00:00 +00:00
+date: 2010-08-02 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -64,21 +70,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: qrp
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: zero-copy pipe I/O for Linux and Ruby