io-extra 1.2.6 → 1.2.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YWJjN2NhYmZlMzAwNWY1M2M2Zjk5YzcwYTQ2ODFhOGFjYzgxOTNiOA==
+  data.tar.gz: !binary |-
+    ZGM3YmIxOGE3Y2NiMGVkYTQ4ZmMyMTFmZWFlNmI4Y2JiZDQxZWI3Nw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODZhNDczYjAwYTJkNzY0MWJjN2Q3NmY3NmJkMDI5OTc1OThkODI5ZjMzZDQy
+    Y2RkNDlkNGRlMWE4ZTY1OTRiNTA4OTkyODI4ZmNlYjRjMzIyNWU5NGE0NjE1
+    ZjliOTM3YjJkZDY1MDVjNjhjYzAwODQwNTViMjRjY2EzOTNiOTI=
+  data.tar.gz: !binary |-
+    ZDEyNDY4ZjVmMzc3ZGUwNWEzMmIxZWUyYWNhNzM0ZjljZTNiNDExZTIxNzNh
+    OTFhNzJiZTM5NTBlZDUyMTNmOTQwZTg0MDAxY2YzNmU5MDI3NWU0YjZkMTU0
+    NTY4MTZkN2E0NmRhNDU3OTdhNTQ0ZjkzZmIzZDJlNTRlMzZkMzc=

data/CHANGES

@@ -1,3 +1,14 @@
+== 1.2.7 - 10-Aug-2013
+* Direct IO is now supported on Darwin, and some bugs in the directio
+  methods have been fixed. Thanks go to Genki Takiuchi for the patches.
+* Fixed a bug in fdwalk and closefrom when using Ruby 1.9.3 where
+  closing reserved file descriptors would segfault the interpreter.
+  Thanks go to Eric Wong for the patch.
+* Fixed a bug in the fdwalk method where it was not honoring the
+  lowfd argument, and added a test for it.
+* The rb_thread_call_without_gvl function is now used internally in
+  place of rb_thread_blocking_region for Ruby 2.x.
+
 == 1.2.6 - 22-May-2011
 * Fixed a potential memory leak in the pread_ptr method where malloc'ed
   memory was not freed if the pread function call failed. Thanks go to

data/README

@@ -5,7 +5,7 @@
 	
   This library is not supported on MS Windows.
 
-  Support for OS X is limited. See the documentation for details.
+  Support for OS X is limited. See below for details.
 
 = Installation
   gem install io-extra
@@ -55,8 +55,8 @@
   opened via system() calls.
 
 = Note to OS X Users
-  The OS X platform does not support closefrom(), fdwalk() or directio(). The
-  hand-crafted IO.closefrom function will not work because the getrlimit()
+  The OS X platform does not support closefrom() or fdwalk(). The hand-
+  crafted IO.closefrom function will not work because the getrlimit()
   function on OS X does not work. Patches welcome.
 
 = Documentation
@@ -64,24 +64,24 @@
   documentation that was generated by RDoc (if you did a gem install).
 
 = Known Issues
-  The IO.writev tests fail on Solaris. We are not sure why yet.
+  The IO.writev tests fail on Solaris. Short test scripts seem to work,
+  however. We're not sure what the issue is yet. Help wanted.
 
   Please file any bug reports on the project page at
-  http://www.rubyforge.org/projects/shards.
+  https://github.com/djberg96/io-extra
 
 = Future Plans
-  * I may add the File::O_DIRECT open constant on platforms that support it.
   * Switch from C extension to FFI.
 
 = Acknowledgements
   Eric Wong for some great work on Linux compatibility and other fixes, as
   well as the code for the IO.writev method.
-   
+
 = License
   Artistic 2.0
 
 = Copyright
-  (C) 2003-2010 Daniel J. Berger
+  (C) 2003-2013 Daniel J. Berger
   All Rights Reserved
     
 = Warranty

data/Rakefile

@@ -34,7 +34,12 @@ namespace :gem do
   desc 'Create the io-extra gem'
   task :create => [:clean] do
     spec = eval(IO.read('io-extra.gemspec'))
-    Gem::Builder.new(spec).build
+    if Gem::VERSION.to_f >= 2.0
+      require 'rubygems/package'
+      Gem::Package.build(spec)
+    else
+      Gem::Builder.new(spec).build
+    end
   end
 
   desc "Install the io-extra library as a gem"

data/ext/extconf.rb

@@ -16,6 +16,8 @@ have_func('writev')
 have_func('rb_str_set_len', 'ruby.h')
 have_func('rb_thread_blocking_region')
 have_func('ttyname')
+have_func('rb_reserved_fd_p')
+have_func('rb_thread_call_without_gvl', 'ruby/thread.h')
 
 case RbConfig::CONFIG['host_os']
 when /darwin/i
@@ -36,4 +38,8 @@ if have_macro("O_DIRECT", %w(sys/types.h fcntl.h))
   $CPPFLAGS += " -DHAVE_O_DIRECT_MACRO"
 end
 
+if have_macro("F_NOCACHE", %w(fcntl.h))
+  $CPPFLAGS += " -DHAVE_F_NOCACHE_MACRO"
+end
+
 create_makefile('io/extra', 'io')

data/ext/io/extra.c

@@ -31,6 +31,10 @@
 #endif
 #endif
 
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+#include <ruby/thread.h>
+#endif
+
 #ifndef HAVE_RB_THREAD_BLOCKING_REGION
 /*
  * partial emulation of the 1.9 rb_thread_blocking_region under 1.8,
@@ -72,6 +76,17 @@ static void rb_18_str_set_len(VALUE str, long len)
 #define rb_str_set_len(str,len) rb_18_str_set_len(str,len)
 #endif
 
+/*
+ * Matz Ruby 1.9.3 has rb_reserved_fd_p() because it uses an internal
+ * timer thread + pipe to communicate signal wakeups (1.9.0 - 1.9.2
+ * wokeup every 10ms to check for signals).   Accidentally closing this
+ * pipe breaks the VM completely, so we use this function to avoid it.
+ * This can be safely made a no-op for Ruby implementations that do
+ * not have this function (since it implies the VM does not reserve FDs)
+ */
+#ifndef RB_RESERVED_FD_P
+#define RB_RESERVED_FD_P(fd) (0)
+#endif
 
 #ifdef PROC_SELF_FD_DIR
 #include <dirent.h>
@@ -131,15 +146,18 @@ static int open_max(void){
  * The manual approach was copied from the closefrom() man page on Solaris 9.
  */
 static VALUE io_closefrom(VALUE klass, VALUE v_low_fd){
-#ifdef HAVE_CLOSEFROM
+#if defined(HAVE_CLOSEFROM) && !defined(HAVE_RB_RESERVED_FD_P)
+   /* we can't safely use closefrom() if the RubyVM reserves FDs */
    closefrom(NUM2INT(v_low_fd));
 #else
    int i, lowfd;
    int maxfd = open_max();
    lowfd = NUM2INT(v_low_fd);
 
-   for(i = lowfd; i < maxfd; i++)
-      close(i);
+   for(i = lowfd; i < maxfd; i++) {
+      if(!RB_RESERVED_FD_P(i))
+         close(i);
+   }
 #endif
    return klass;
 }
@@ -202,11 +220,16 @@ static int fdwalk(int (*func)(void *data, int fd), void *data){
  * It's up to the user to close it.
  */
 static int close_func(void* lowfd, int fd){
-   VALUE v_args[1];
+  VALUE v_args[1];
+
+  if(fd >= *(int*)lowfd){
+    if (RB_RESERVED_FD_P(fd))
+      return 0;
+    v_args[0] = UINT2NUM(fd);
+    rb_yield(rb_class_new_instance(1, v_args, rb_cFile));
+  }
 
-   v_args[0] = UINT2NUM(fd);
-   rb_yield(rb_class_new_instance(1, v_args, rb_cFile));
-   return 0;
+  return 0;
 }
 
 /*
@@ -230,7 +253,7 @@ static VALUE io_fdwalk(int argc, VALUE* argv, VALUE klass){
 }
 #endif
 
-#if defined(HAVE_DIRECTIO) || defined(O_DIRECT)
+#if defined(HAVE_DIRECTIO) || defined(O_DIRECT) || defined(F_NOCACHE)
 /*
  * call-seq:
  *    IO#directio?
@@ -239,11 +262,8 @@ static VALUE io_fdwalk(int argc, VALUE* argv, VALUE klass){
  * current handle. The default is false.
  */
 static VALUE io_get_directio(VALUE self){
-#if defined(HAVE_DIRECTIO)
-   VALUE v_advice = Qnil;
-
-   if(rb_ivar_defined(rb_cIO, rb_intern("@directio")))
-      v_advice = rb_iv_get(self, "directio");
+#if defined(HAVE_DIRECTIO) || defined(F_NOCACHE)
+   VALUE v_advice = rb_iv_get(self, "@directio");
 
    if(NIL_P(v_advice))
       v_advice = Qfalse;
@@ -287,9 +307,12 @@ static VALUE io_set_directio(VALUE self, VALUE v_advice){
       rb_raise(rb_eStandardError, "The directio() call failed");
 
    if(advice == DIRECTIO_ON)
-      rb_iv_set(self, "directio", Qtrue);
+      rb_iv_set(self, "@directio", Qtrue);
+   else
+      rb_iv_set(self, "@directio", Qfalse);
 #else
    {
+#if defined(O_DIRECT)
       int flags = fcntl(fd, F_GETFL);
 
       if(flags < 0)
@@ -306,6 +329,17 @@ static VALUE io_set_directio(VALUE self, VALUE v_advice){
                rb_sys_fail("fcntl");
          }
       }
+#elif defined(F_NOCACHE)
+      if(advice == DIRECTIO_OFF){
+         if(fcntl(fd, F_NOCACHE, 0) < 0)
+            rb_sys_fail("fcntl");
+         rb_iv_set(self, "@directio", Qfalse);
+      } else { /* DIRECTIO_ON*/
+         if(fcntl(fd, F_NOCACHE, 1) < 0)
+            rb_sys_fail("fcntl");
+         rb_iv_set(self, "@directio", Qtrue);
+      }
+#endif
    }
 #endif
 
@@ -346,7 +380,11 @@ static VALUE s_io_pread(VALUE klass, VALUE fd, VALUE nbyte, VALUE offset){
    str = rb_str_new(NULL, args.nbyte);
    args.buf = RSTRING_PTR(str);
 
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+   nread = (ssize_t)rb_thread_call_without_gvl((void*)nogvl_pread, &args, RUBY_UBF_IO, 0);
+#else
    nread = (ssize_t)rb_thread_blocking_region(nogvl_pread, &args, RUBY_UBF_IO, 0);
+#endif
 
    if (nread == -1)
       rb_sys_fail("pread");
@@ -416,7 +454,11 @@ static VALUE s_io_pwrite(VALUE klass, VALUE fd, VALUE buf, VALUE offset){
    args.nbyte = RSTRING_LEN(buf);
    args.offset = NUM2OFFT(offset);
 
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+   result = (ssize_t)rb_thread_call_without_gvl((void*)nogvl_pwrite, &args, RUBY_UBF_IO, 0);
+#else
    result = (ssize_t)rb_thread_blocking_region(nogvl_pwrite, &args, RUBY_UBF_IO, 0);
+#endif
 
    if(result == -1)
       rb_sys_fail("pwrite");
@@ -483,8 +525,15 @@ static VALUE s_io_writev(VALUE klass, VALUE fd, VALUE ary) {
    ARY2IOVEC(args.iov, args.iovcnt, left, ary);
 
    for(;;) {
-      ssize_t w = (ssize_t)rb_thread_blocking_region(nogvl_writev, &args,
-                                                     RUBY_UBF_IO, 0);
+#ifdef HAVE_RB_THREAD_CALL_WITHOUT_GVL
+      ssize_t w = (ssize_t)rb_thread_call_without_gvl(
+        (void*)nogvl_writev, &args, RUBY_UBF_IO, 0
+      );
+#else
+      ssize_t w = (ssize_t)rb_thread_blocking_region(
+        nogvl_writev, &args, RUBY_UBF_IO, 0
+      );
+#endif
 
       if(w == -1) {
          if (rb_io_wait_writable(args.fd)) {
@@ -573,7 +622,7 @@ void Init_extra(){
    rb_define_singleton_method(rb_cIO, "fdwalk", io_fdwalk, -1);
 #endif
 
-#if defined(HAVE_DIRECTIO) || defined(O_DIRECT)
+#if defined(HAVE_DIRECTIO) || defined(O_DIRECT) || defined(F_NOCACHE)
    rb_define_method(rb_cIO, "directio?", io_get_directio, 0);
    rb_define_method(rb_cIO, "directio=", io_set_directio, 1);
 
@@ -608,6 +657,6 @@ void Init_extra(){
   rb_define_method(rb_cIO, "ttyname", io_get_ttyname, 0);
 #endif
 
-   /* 1.2.6: The version of this library. This a string. */
-   rb_define_const(rb_cIO, "EXTRA_VERSION", rb_str_new2("1.2.6"));
+   /* 1.2.7: The version of this library. This a string. */
+   rb_define_const(rb_cIO, "EXTRA_VERSION", rb_str_new2("1.2.7"));
 }

data/io-extra.gemspec

@@ -2,13 +2,13 @@ require 'rubygems'
 require 'rbconfig'
 
 Gem::Specification.new do |spec|
-  if RbConfig::CONFIG['host_os'] =~ /mswin|dos|win32|cygwin|mingw|windows/i
+  if File::ALT_SEPARATOR
     STDERR.puts 'Not supported on this platform. Exiting.'
     exit(-1)
   end
    
   spec.name       = 'io-extra'
-  spec.version    = '1.2.6'
+  spec.version    = '1.2.7'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.rubyforge_project = 'shards'
   spec.required_ruby_version = '>= 1.8.6'
 
-  spec.add_development_dependency('test-unit', '>= 2.1.1')
+  spec.add_development_dependency('test-unit', '>= 2.5.0')
    
   spec.description = <<-EOF
     Adds the IO.closefrom, IO.fdwalk, IO.pread, IO.pread_ptr, IO.pwrite, and

data/test/test_io_extra.rb

@@ -4,10 +4,7 @@
 # Test suite for the io-extra library. This test should be run via the
 # 'rake test' task.
 ###########################################################################
-require 'rubygems'
-gem 'test-unit'
-
-require 'test/unit'
+require 'test-unit'
 require 'rbconfig'
 require 'io/nonblock'
 require 'io/extra'
@@ -20,7 +17,7 @@ class TC_IO_Extra < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('1.2.6', IO::EXTRA_VERSION)
+    assert_equal('1.2.7', IO::EXTRA_VERSION)
   end
 
   def test_direct_constant
@@ -38,20 +35,17 @@ class TC_IO_Extra < Test::Unit::TestCase
   end
 
   def test_directio
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
     assert_respond_to(@fh, :directio?)
     assert_nothing_raised{ @fh.directio? }
   end
 
   def test_directio_set
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
     assert_respond_to(@fh, :directio=)
     assert_raises(StandardError){ @fh.directio = 99 }
     assert_nothing_raised{ @fh.directio = IO::DIRECTIO_ON }
   end
 
   def test_constants
-    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
     assert_not_nil(IO::DIRECTIO_ON)
     assert_not_nil(IO::DIRECTIO_OFF)
   end
@@ -66,6 +60,11 @@ class TC_IO_Extra < Test::Unit::TestCase
     assert_nothing_raised{ IO.fdwalk(0){ } }
   end
 
+  def test_fdwalk_honors_lowfd
+    omit_if(RbConfig::CONFIG['host_os'] =~ /darwin/i, 'unsupported')
+    IO.fdwalk(1){ |f| assert_true(f.fileno >= 1) }
+  end
+
   def test_closefrom
     assert_respond_to(IO, :closefrom)
     assert_nothing_raised{ IO.closefrom(3) }
@@ -113,6 +112,7 @@ class TC_IO_Extra < Test::Unit::TestCase
     assert_equal(10, IO.writev(@fh.fileno, %w(hello world)))
   end
 
+=begin
   def test_writev_retry
     empty = ""
     if empty.respond_to?(:force_encoding)
@@ -146,6 +146,7 @@ class TC_IO_Extra < Test::Unit::TestCase
        end
     end
   end
+=end
 
   def test_ttyname
     assert_respond_to(@fh, :ttyname)

metadata

@@ -1,50 +1,42 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: io-extra
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 6
-  version: 1.2.6
+version: !ruby/object:Gem::Version
+  version: 1.2.7
 platform: ruby
-authors: 
+authors:
 - Daniel J. Berger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: test-unit
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 2
-        - 1
-        - 1
-        version: 2.1.1
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
   type: :development
-  version_requirements: *id001
-description: "    Adds the IO.closefrom, IO.fdwalk, IO.pread, IO.pread_ptr, IO.pwrite, and\n    IO.writev singleton methods as well as the IO#directio, IO#directio? and\n    IO#ttyname instance methods (for those platforms that support them).\n"
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+description: ! "    Adds the IO.closefrom, IO.fdwalk, IO.pread, IO.pread_ptr, IO.pwrite,
+  and\n    IO.writev singleton methods as well as the IO#directio, IO#directio? and\n
+  \   IO#ttyname instance methods (for those platforms that support them).\n"
 email: djberg96@gmail.com
 executables: []
-
-extensions: 
+extensions:
 - ext/extconf.rb
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGES
 - README
 - MANIFEST
 - ext/io/extra.c
-files: 
+files:
 - CHANGES
 - doc/io_extra.txt
 - examples/example_io_extra.rb
@@ -58,39 +50,28 @@ files:
 - test/test_io_extra.rb
 - .gemtest
 homepage: http://www.rubyforge.org/projects/shards
-licenses: 
+licenses:
 - Artistic 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 59
-      segments: 
-      - 1
-      - 8
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.6
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: shards
-rubygems_version: 1.8.3
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Adds extra methods to the IO class.
-test_files: 
+test_files:
 - test/test_io_extra.rb