sleepy_penguin 3.4.1 → 3.5.0

data/pkg.mk

@@ -13,14 +13,6 @@ RUBY_VERSION := $(shell $(RUBY) -e 'puts RUBY_VERSION')
 RUBY_ENGINE := $(shell $(RUBY) -e 'puts((RUBY_ENGINE rescue "ruby"))')
 lib := lib
 
-ifeq ($(shell test -f script/isolate_for_tests && echo t),t)
-isolate_libs := tmp/isolate/$(RUBY_ENGINE)-$(RUBY_VERSION)/isolate.mk
-$(isolate_libs): script/isolate_for_tests
-	@$(RUBY) script/isolate_for_tests
--include $(isolate_libs)
-lib := $(lib):$(ISOLATE_LIBS)
-endif
-
 ext := $(firstword $(wildcard ext/*))
 ifneq ($(ext),)
 ext_pfx := tmp/ext/$(RUBY_ENGINE)-$(RUBY_VERSION)
@@ -94,7 +86,7 @@ fix-perms:
 gem: $(pkggem)
 
 install-gem: $(pkggem)
-	gem install $(CURDIR)/$<
+	gem install --local $(CURDIR)/$<
 
 $(pkggem): manifest fix-perms
 	gem build $(rfpackage).gemspec
@@ -121,9 +113,10 @@ gem install-gem: GIT-VERSION-FILE
 	$(MAKE) $@ VERSION=$(GIT_VERSION)
 endif
 
-all:: test
+all:: check
 test_units := $(wildcard test/test_*.rb)
-test: test-unit
+test: check
+check: test-unit
 test-unit: $(test_units)
 $(test_units): build
 	$(RUBY) -I $(lib) $@ $(RUBY_TEST_OPTS)
@@ -153,5 +146,5 @@ $(PLACEHOLDERS):
 	echo olddoc_placeholder > $@
 endif
 
-.PHONY: all .FORCE-GIT-VERSION-FILE doc test $(test_units) manifest
+.PHONY: all .FORCE-GIT-VERSION-FILE doc check test $(test_units) manifest
 .PHONY: check-warnings

data/sleepy_penguin.gemspec

@@ -1,24 +1,22 @@
-ENV["VERSION"] or abort "VERSION= must be specified"
-manifest = File.readlines('.manifest').map! { |x| x.chomp! }
-require 'olddoc'
-extend Olddoc::Gemspec
-name, summary, title = readme_metadata
+manifest = File.exist?('.manifest') ?
+  IO.readlines('.manifest').map!(&:chomp!) : `git ls-files`.split("\n")
 
 Gem::Specification.new do |s|
   s.name = %q{sleepy_penguin}
-  s.version = ENV["VERSION"].dup
-  s.homepage = Olddoc.config['rdoc_url']
-  s.authors = ["#{name} hackers"]
-  s.description = readme_description
+  s.version = (ENV['VERSION'] || '3.5.0').dup
+  s.homepage = 'https://bogomips.org/sleepy_penguin/'
+  s.authors = ['sleepy_penguin hackers']
+  s.description = File.read('README').split("\n\n")[1]
   s.email = %q{sleepy-penguin@bogomips.org}
-  s.extra_rdoc_files = extra_rdoc_files(manifest)
   s.files = manifest
-  s.summary = summary
+  s.summary = 'Linux I/O events for Ruby'
   s.test_files = Dir['test/test_*.rb']
   s.extensions = %w(ext/sleepy_penguin/extconf.rb)
-  s.add_development_dependency('minitest', '~> 5.0')
-  s.add_development_dependency('olddoc', '~> 1.0')
+  s.extra_rdoc_files = IO.readlines('.document').map!(&:chomp!).keep_if do |f|
+    File.exist?(f)
+  end
+  s.add_development_dependency('test-unit', '~> 3.0')
   s.add_development_dependency('strace_me', '~> 1.0')
-
-  s.licenses = %w(LGPLv2.1+)
+  s.required_ruby_version = '>= 2.0'
+  s.licenses = %w(LGPL-2.1+)
 end

data/test/helper.rb

@@ -1,11 +1,6 @@
 $-w = $stdout.sync = $stderr.sync = Thread.abort_on_exception = true
-gem 'minitest'
-require 'minitest/autorun'
-Testcase = begin
-  Minitest::Test # minitest 5
-rescue NameError
-  Minitest::Unit::TestCase # minitest 4
-end
+require 'test/unit'
+require 'sleepy_penguin'
 
 def check_cloexec(io)
   pipe = IO.pipe

data/test/test_cfr.rb

@@ -0,0 +1,35 @@
+# -*- encoding: binary -*-
+require_relative 'helper'
+require 'tempfile'
+
+class TestCfr < Test::Unit::TestCase
+  def test_copy_file_range
+    str = 'abcde'
+    size = 5
+    src = Tempfile.new('ruby_cfr_src')
+    dst = Tempfile.new('ruby_cfr_dst')
+    assert_equal 5, src.syswrite(str)
+    src.sysseek(0)
+    begin
+      nr = SleepyPenguin.copy_file_range(src, dst, size)
+    rescue Errno::EINVAL
+      warn 'copy_file_range not supported (requires Linux 4.5+)'
+      warn "We have: #{`uname -a`}"
+      return
+    end
+    assert_equal nr, 5
+    dst.sysseek(0)
+    assert_equal str, dst.sysread(5)
+
+    nr = SleepyPenguin.copy_file_range(src, dst, size, off_in: 1, off_out: 0)
+    assert_equal 4, nr
+    dst.sysseek(0)
+    assert_equal 'bcde', dst.sysread(4)
+
+    nr = SleepyPenguin.copy_file_range(src, dst, size, off_in: 9)
+    assert_equal 0, nr, 'no EOFError'
+  ensure
+    dst.close!
+    src.close!
+  end
+end if SleepyPenguin.respond_to?(:copy_file_range)

data/test/test_constants.rb

@@ -1,9 +1,7 @@
-require './test/helper'
-$-w = true
-Thread.abort_on_exception = true
 require 'sleepy_penguin/sp'
+require_relative 'helper'
 
-class TestConstants < Testcase
+class TestConstants < Test::Unit::TestCase
   def test_constants
     assert_equal SleepyPenguin::SLEEPY_PENGUIN_VERSION,
                  SP::SLEEPY_PENGUIN_VERSION

data/test/test_epoll.rb

@@ -1,13 +1,9 @@
-require './test/helper'
+require_relative 'helper'
 require 'fcntl'
 require 'socket'
 require 'thread'
-$-w = true
-Thread.abort_on_exception = true
 
-require 'sleepy_penguin'
-
-class TestEpoll < Testcase
+class TestEpoll < Test::Unit::TestCase
   include SleepyPenguin
 
   def setup
@@ -343,6 +339,13 @@ class TestEpoll < Testcase
     @ep.close
     io = Epoll.new(Epoll::CLOEXEC).to_io
     assert((io.fcntl(Fcntl::F_GETFD) & Fcntl::FD_CLOEXEC) == Fcntl::FD_CLOEXEC)
+    io.close
+
+    # prettier, slower, but more memory efficient due to lack of caching
+    # due to the constant cache:
+    io = Epoll.new(:CLOEXEC).to_io
+
+    assert((io.fcntl(Fcntl::F_GETFD) & Fcntl::FD_CLOEXEC) == Fcntl::FD_CLOEXEC)
   end
 
   def test_new
@@ -531,4 +534,30 @@ class TestEpoll < Testcase
     end
     @ep.wait(1) { |flags, io| assert_equal(first[0], io) }
   end
+
+  def test_epoll_nest
+    ep2 = Epoll.new
+    r, w = IO.pipe
+    @ep.add(@rd, :IN)
+    @ep.add(@wr, :OUT)
+    ep2.add(r, :IN)
+    ep2.add(w, :OUT)
+    w.write('.')
+    @wr.write('.')
+    outer = []
+    inner = []
+    nr = 0
+    @ep.wait(2) do |_, io|
+      outer << io
+      ep2.wait(2) do |_, io2|
+        (inner[nr] ||= []) << io2
+      end
+      nr += 1
+    end
+    assert_equal [ @rd, @wr ].sort_by(&:fileno), outer.sort_by(&:fileno)
+    exp = [ r, w ].sort_by(&:fileno)
+    assert_equal [ exp, exp ], inner.map { |x| x.sort_by(&:fileno) }
+  ensure
+    [ r, w, ep2 ].compact.each(&:close)
+  end
 end if defined?(SleepyPenguin::Epoll)

data/test/test_epoll_gc.rb

@@ -1,9 +1,6 @@
-require './test/helper'
-$-w = true
+require_relative 'helper'
 
-require 'sleepy_penguin'
-
-class TestEpollGC < Testcase
+class TestEpollGC < Test::Unit::TestCase
   include SleepyPenguin
 
   def setup

data/test/test_epoll_io.rb

@@ -1,12 +1,9 @@
-require './test/helper'
+require_relative 'helper'
 require 'fcntl'
 require 'socket'
 require 'thread'
-$-w = true
-Thread.abort_on_exception = true
-require 'sleepy_penguin'
 
-class TestEpollIO < Testcase
+class TestEpollIO < Test::Unit::TestCase
   include SleepyPenguin
 
   def setup
@@ -23,7 +20,7 @@ class TestEpollIO < Testcase
 
   class EpSub < Epoll::IO
     def self.new
-      super(SleepyPenguin::Epoll::CLOEXEC)
+      super(:CLOEXEC)
     end
   end
 

data/test/test_epoll_optimizations.rb

@@ -1,4 +1,4 @@
-require './test/helper'
+require_relative 'helper'
 begin
   require 'strace'
 rescue LoadError
@@ -7,7 +7,7 @@ $-w = true
 
 require 'sleepy_penguin'
 
-class TestEpollOptimizations < Testcase
+class TestEpollOptimizations < Test::Unit::TestCase
   include SleepyPenguin
   IO_PURGATORY = []
 

data/test/test_eventfd.rb

@@ -1,10 +1,7 @@
-require './test/helper'
+require_relative 'helper'
 require 'fcntl'
-$-w = true
 
-require 'sleepy_penguin'
-
-class TestEventFD < Testcase
+class TestEventFD < Test::Unit::TestCase
   include SleepyPenguin
 
   def test_constants

data/test/test_inotify.rb

@@ -1,11 +1,9 @@
-require './test/helper'
+require_relative 'helper'
 require 'fcntl'
 require 'tempfile'
 require 'set'
-$-w = true
-require 'sleepy_penguin'
 
-class TestInotify < Testcase
+class TestInotify < Test::Unit::TestCase
   include SleepyPenguin
   attr_reader :ino
 

data/test/test_kqueue.rb

@@ -1,9 +1,6 @@
-require './test/helper'
-$-w = true
-Thread.abort_on_exception = true
-require 'sleepy_penguin'
+require_relative 'helper'
 
-class TestKqueue < Testcase
+class TestKqueue < Test::Unit::TestCase
   include SleepyPenguin
 
   def test_kqueue
@@ -71,5 +68,36 @@ class TestKqueue < Testcase
   ensure
     kq.close
   end
-end if defined?(SleepyPenguin::Kqueue) &&
-       IO.instance_methods.include?(:autoclose=)
+
+  def test_epoll_nest
+    kq1 = Kqueue.new
+    kq2 = Kqueue.new
+    r1, w1 = IO.pipe
+    r2, w2 = IO.pipe
+    w1.write '.'
+    w2.write '.'
+    kq1.kevent([
+       Kevent[r1.fileno, EvFilt::READ, Ev::ADD, 0, 0, r1],
+       Kevent[w1.fileno, EvFilt::WRITE, Ev::ADD, 0, 0, w1]
+    ])
+    kq2.kevent([
+       Kevent[r2.fileno, EvFilt::READ, Ev::ADD, 0, 0, r2],
+       Kevent[w2.fileno, EvFilt::WRITE, Ev::ADD, 0, 0, w2]
+    ])
+    outer = []
+    inner = []
+    nr = 0
+    kq1.kevent(nil, 2) do |kev1|
+      outer << kev1.udata
+      kq2.kevent(nil, 2) do |kev2|
+        (inner[nr] ||= []) << kev2.udata
+      end
+      nr += 1
+    end
+    assert_equal [ r1, w1 ].sort_by(&:fileno), outer.sort_by(&:fileno)
+    exp = [ r2, w2 ].sort_by(&:fileno)
+    assert_equal [ exp, exp ], inner.map { |x| x.sort_by(&:fileno) }
+  ensure
+    [ r1, w1, r2, w2, kq1, kq2 ].compact.each(&:close)
+  end
+end if defined?(SleepyPenguin::Kqueue)

data/test/test_kqueue_io.rb

@@ -1,9 +1,6 @@
-require './test/helper'
-$-w = true
-Thread.abort_on_exception = true
-require 'sleepy_penguin'
+require_relative 'helper'
 
-class TestKqueueIO < Testcase
+class TestKqueueIO < Test::Unit::TestCase
   include SleepyPenguin
 
   def setup

data/test/test_pipesize.rb

@@ -0,0 +1,22 @@
+# -*- encoding: binary -*-
+require_relative 'helper'
+require 'fcntl'
+
+class TestPipesize < Test::Unit::TestCase
+  def test_pipe_size
+    return unless RUBY_PLATFORM =~ /linux/
+    [ :F_GETPIPE_SZ, :F_SETPIPE_SZ ].each do |c|
+      return unless SleepyPenguin.const_defined?(c)
+    end
+    r, w = pipe = IO.pipe
+    nr = r.fcntl(SleepyPenguin::F_GETPIPE_SZ)
+    assert_kind_of Integer, nr
+    assert_operator nr, :>, 0
+
+    set = 131072
+    r.fcntl(SleepyPenguin::F_SETPIPE_SZ, set)
+    assert_equal set, r.fcntl(SleepyPenguin::F_GETPIPE_SZ)
+  ensure
+    pipe.each(&:close) if pipe
+  end
+end

data/test/test_sendfile.rb

@@ -0,0 +1,26 @@
+# -*- encoding: binary -*-
+require_relative 'helper'
+require 'tempfile'
+require 'socket'
+
+class TestSendfile < Test::Unit::TestCase
+  def test_linux_sendfile
+    rd, wr = UNIXSocket.pair
+    size = 5
+    src = Tempfile.new('ruby_sf_src')
+    assert_equal 0, SleepyPenguin.linux_sendfile(wr, src, size)
+    str = 'abcde'.freeze
+    assert_equal str.bytesize, src.syswrite(str)
+    assert_equal 0, SleepyPenguin.linux_sendfile(wr, src, size)
+    src.sysseek(0, IO::SEEK_SET)
+    assert_equal str.bytesize,
+                 SleepyPenguin.linux_sendfile(wr, src, size, offset: 0)
+    assert_equal str, rd.read(size)
+    assert_equal 0, src.sysseek(0, IO::SEEK_CUR), 'handle offset not changed'
+    assert_equal 3, SleepyPenguin.linux_sendfile(wr, src, 3)
+    assert_equal 3, src.sysseek(0, IO::SEEK_CUR), 'handle offset changed'
+  ensure
+    [ rd, wr ].compact.each(&:close)
+    src.close! if src
+  end
+end

data/test/test_splice.rb

@@ -0,0 +1,250 @@
+# -*- encoding: binary -*-
+require_relative 'helper'
+require 'tempfile'
+require 'socket'
+require 'io/nonblock'
+require 'timeout'
+
+class TestSplice < Test::Unit::TestCase
+
+  def test_splice
+    str = 'abcde'
+    size = 5
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+
+    assert_equal 5, tmp.syswrite(str)
+    tmp.sysseek(0)
+
+    nr = SleepyPenguin.splice(tmp.fileno, wr.fileno, size)
+    assert_equal size, nr
+    assert_equal str, rd.sysread(size)
+  end
+
+  def test_splice_io
+    str = 'abcde'
+    size = 5
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+
+    assert_equal 5, tmp.syswrite(str)
+    tmp.sysseek(0)
+
+    nr = SleepyPenguin.splice(tmp, wr, size)
+    assert_equal size, nr
+    assert_equal str, rd.sysread(size)
+  end
+
+  def test_splice_io_noflags
+    str = 'abcde'
+    size = 5
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+
+    assert_equal 5, tmp.syswrite(str)
+    tmp.sysseek(0)
+
+    nr = SleepyPenguin.splice(tmp, wr, size)
+    assert_equal size, nr
+    assert_equal str, rd.sysread(size)
+  end
+
+  def test_trysplice_io_noflags
+    str = 'abcde'
+    size = 5
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+
+    assert_equal 5, tmp.syswrite(str)
+    tmp.sysseek(0)
+
+    nr = SleepyPenguin.splice(tmp, wr, size, :nonblock, exception: false)
+    assert_equal size, nr
+    assert_equal str, rd.sysread(size)
+  end
+
+  def test_splice_io_ish
+    str = 'abcde'
+    size = 5
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+    io_ish = [ tmp ]
+    def io_ish.to_io
+      first.to_io
+    end
+
+    assert_equal 5, tmp.syswrite(str)
+    tmp.sysseek(0)
+
+    nr = SleepyPenguin.splice(io_ish, wr, size)
+    assert_equal size, nr
+    assert_equal str, rd.sysread(size)
+  end
+
+  def test_splice_in_offset
+    str = 'abcde'
+    off = 3
+    len = 2
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+
+    assert_equal 5, tmp.syswrite(str)
+    tmp.sysseek(0)
+
+    nr = SleepyPenguin.splice(tmp.fileno, wr.fileno, len, off_in: off)
+    assert_equal len, nr
+    assert_equal 'de', rd.sysread(len)
+  end
+
+  def test_splice_out_offset
+    str = 'abcde'
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+
+    assert_equal 5, wr.syswrite(str)
+    nr = SleepyPenguin.splice(rd.fileno, tmp.fileno, str.size, off_out: 3)
+    assert_equal 5, nr
+    tmp.sysseek(0)
+    assert_equal "\0\0\0abcde", tmp.sysread(9)
+  end
+
+  def test_splice_nonblock
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+
+    assert_raises(Errno::EAGAIN) {
+      SleepyPenguin.splice(rd.fileno, tmp.fileno, 5, :nonblock, off_out: 0)
+    }
+  end
+
+  def test_trysplice_nonblock
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+    assert_equal :EAGAIN, SleepyPenguin.splice(rd, tmp, 5, :nonblock,
+                                               off_out: 0, exception: false)
+  end
+
+  def test_trysplice_nonblock_noargs
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+    assert_equal :EAGAIN, SleepyPenguin.splice(rd, tmp, 5, :nonblock,
+                                               off_out: 0, exception: false)
+    assert_equal :EAGAIN, SleepyPenguin.splice(rd, tmp, 5, [:more,:nonblock],
+                                               off_out: 0,
+                                               exception: false)
+  end
+
+  def test_splice_eof
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+    wr.syswrite 'abc'
+    wr.close
+
+    nr = SleepyPenguin.splice(rd.fileno, tmp.fileno, 5, :nonblock, off_out: 0)
+    assert_equal 3, nr
+    assert_raises(EOFError) {
+      SleepyPenguin.splice(rd.fileno, tmp.fileno, 5, :nonblock, off_out: 0)
+    }
+  end
+
+  def test_trysplice_eof
+    rd, wr = IO.pipe
+    tmp = Tempfile.new('ruby_splice')
+    wr.syswrite 'abc'
+    wr.close
+
+    nr = SleepyPenguin.splice(rd, tmp, 5, off_out: 0, exception: false)
+    assert_equal 3, nr
+    assert_nil SleepyPenguin.splice(rd, tmp, 5, :nonblock,
+                                    off_out: 0, exception: false)
+  end
+
+  def test_splice_nonblock_socket
+    server = TCPServer.new('127.0.0.1', 0)
+    port = server.addr[1]
+    rp, wp = IO.pipe
+    rs = TCPSocket.new('127.0.0.1', port)
+    rs.nonblock = true
+    assert_raises(Errno::EAGAIN) {
+      SleepyPenguin.splice(rs, wp, 1024)
+    }
+    rs.close
+    server.close
+  end
+
+  def test_tee
+    str = 'abcde'
+    size = 5
+    rda, wra = IO.pipe
+    rdb, wrb = IO.pipe
+
+    assert_equal 5, wra.syswrite(str)
+    nr = SleepyPenguin.tee(rda.fileno, wrb.fileno, size)
+    assert_equal 5, nr
+    assert_equal str, rdb.sysread(5)
+    assert_equal str, rda.sysread(5)
+  end
+
+  def test_trytee
+    str = 'abcde'
+    size = 5
+    rda, wra = IO.pipe
+    rdb, wrb = IO.pipe
+
+    assert_equal 5, wra.syswrite(str)
+    nr = SleepyPenguin.tee(rda, wrb, size, :nonblock, exception: false)
+    assert_equal 5, nr
+    assert_equal str, rdb.sysread(5)
+    assert_equal str, rda.sysread(5)
+  end
+
+  def test_tee_eof
+    rda, wra = IO.pipe
+    rdb, wrb = IO.pipe
+    wra.close
+    assert_raises(EOFError) {
+      SleepyPenguin.tee(rda.fileno, wrb.fileno, 4096)
+    }
+  end
+
+  def test_trytee_eof
+    rda, wra = IO.pipe
+    rdb, wrb = IO.pipe
+    wra.close
+    assert_nil SleepyPenguin.tee(rda, wrb, 4096, :nonblock, exception: false)
+  end
+
+  def test_tee_nonblock
+    rda, wra = IO.pipe
+    rdb, wrb = IO.pipe
+    assert_raises(Errno::EAGAIN) {
+      SleepyPenguin.tee(rda.fileno, wrb.fileno, 4096, SleepyPenguin::F_NONBLOCK)
+    }
+  end
+
+  def test_trytee_nonblock
+    rda, wra = IO.pipe
+    rdb, wrb = IO.pipe
+    assert_equal :EAGAIN, SleepyPenguin.tee(rda, wrb, 4096, :nonblock,
+                                            exception: false)
+  end
+
+  def test_tee_io
+    str = 'abcde'
+    size = 5
+    rda, wra = IO.pipe
+    rdb, wrb = IO.pipe
+
+    assert_equal 5, wra.syswrite(str)
+    nr = SleepyPenguin.tee(rda, wrb, size)
+    assert_equal 5, nr
+    assert_equal str, rdb.sysread(5)
+    assert_equal str, rda.sysread(5)
+  end
+
+  def test_constants
+    %w(move nonblock more).each { |x|
+      assert Integer === SleepyPenguin.const_get("F_#{x.upcase}")
+    }
+  end
+end if SleepyPenguin.respond_to?(:splice)