sleepy_penguin 1.1.1 → 1.2.0

data/.manifest

@@ -25,5 +25,6 @@ lib/sleepy_penguin.rb
 setup.rb
 sleepy_penguin.gemspec
 test/test_epoll.rb
+test/test_epoll_gc.rb
 test/test_eventfd.rb
 test/test_timerfd.rb

data/ChangeLog

@@ -1,5 +1,41 @@
 ChangeLog from http://git.bogomips.org/cgit/sleepy_penguin.git
 
+   commit 743560f8af768a65e6f286fecf80b6ebd91be812
+   Author: Eric Wong <e@yhbt.net>
+   Date:   Sat Jan 15 11:54:15 2011 +0000
+   
+       sleepy_penguin 1.2.0 - epoll GC help
+       
+       One convenience fix:
+       
+         epoll: prevent IO objects from getting GC-ed
+       
+         Users of our code may forget to keep references for their IO
+         objects at all, and since it's not possible for GC to mark
+         kernel memory, we just hold on to the IO objects for them.
+       
+         We can't unmark close()d file descriptors, ever, so we don't
+         bother with the EPOLL_CTL_DEL case, either.  Just storing IO
+         objects in an array using the raw descriptor as a key will allow
+         bounded space usage just like the in-kernel FD tables as long
+         as the user remembers to close descriptors themselves.
+   
+   commit 681c7b02f1e1d9ca70a5748ef986361840746c3d
+   Author: Eric Wong <e@yhbt.net>
+   Date:   Sat Jan 15 11:46:13 2011 +0000
+   
+       epoll: prevent IO objects from getting GC-ed
+       
+       Users of our code may forget to keep references for their IO
+       objects at all, and since it's not possible for GC to mark
+       kernel memory, we just hold on to the IO objects for them.
+       
+       We can't unmark close()d file descriptors, ever, so we don't
+       bother with the EPOLL_CTL_DEL case, either.  Just storing IO
+       objects in an array using the raw descriptor as a key will allow
+       bounded space usage just like the in-kernel FD tables as long
+       as the user remembers to close descriptors themselves.
+   
    commit ab4f1a27e5d2c1688a33870b6d070aaa510ccdbc
    Author: Eric Wong <normalperson@yhbt.net>
    Date:   Thu Jan 13 14:26:58 2011 -0800

data/GIT-VERSION-FILE

@@ -1 +1 @@
-GIT_VERSION = 1.1.1
+GIT_VERSION = 1.2.0

data/GIT-VERSION-GEN

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 GVF=GIT-VERSION-FILE
-DEF_VER=v1.1.1.GIT
+DEF_VER=v1.2.0.GIT
 
 LF='
 '

data/LATEST

@@ -1,8 +1,16 @@
-=== sleepy_penguin 1.1.1 - soft feathers, soft delete / 2011-01-13 22:41 UTC
+=== sleepy_penguin 1.2.0 - epoll GC help / 2011-01-15 12:06 UTC
 
-  SleepyPenguin::Epoll#delete method added for "soft" failures
-  Documentation updates and cleanups, the website is now
-  JavaScript-free!
+  One convenience fix:
 
-  (Ignore the 1.1.0 "release", it was a lie)
+    epoll: prevent IO objects from getting GC-ed
+
+    Users of our code may forget to keep references for their IO
+    objects at all, and since it's not possible for GC to mark
+    kernel memory, we just hold on to the IO objects for them.
+
+    We can't unmark close()d file descriptors, ever, so we don't
+    bother with the EPOLL_CTL_DEL case, either.  Just storing IO
+    objects in an array using the raw descriptor as a key will allow
+    bounded space usage just like the in-kernel FD tables as long
+    as the user remembers to close descriptors themselves.
 

data/NEWS

@@ -1,3 +1,19 @@
+=== sleepy_penguin 1.2.0 - epoll GC help / 2011-01-15 12:06 UTC
+
+  One convenience fix:
+
+    epoll: prevent IO objects from getting GC-ed
+
+    Users of our code may forget to keep references for their IO
+    objects at all, and since it's not possible for GC to mark
+    kernel memory, we just hold on to the IO objects for them.
+
+    We can't unmark close()d file descriptors, ever, so we don't
+    bother with the EPOLL_CTL_DEL case, either.  Just storing IO
+    objects in an array using the raw descriptor as a key will allow
+    bounded space usage just like the in-kernel FD tables as long
+    as the user remembers to close descriptors themselves.
+
 === sleepy_penguin 1.1.1 - soft feathers, soft delete / 2011-01-13 22:41 UTC
 
   SleepyPenguin::Epoll#delete method added for "soft" failures

data/ext/sleepy_penguin/epoll.c

@@ -50,6 +50,7 @@ struct rb_epoll {
 	int capa;
 	struct epoll_event *events;
 	VALUE io;
+	VALUE marks;
 	int flags;
 };
 
@@ -93,6 +94,7 @@ static void gcmark(void *ptr)
 	struct rb_epoll *ep = ptr;
 
 	rb_gc_mark(ep->io);
+	rb_gc_mark(ep->marks);
 }
 
 static void gcfree(void *ptr)
@@ -122,6 +124,7 @@ static VALUE alloc(VALUE klass)
 	self = Data_Make_Struct(klass, struct rb_epoll, gcmark, gcfree, ep);
 	ep->fd = -1;
 	ep->io = Qnil;
+	ep->marks = rb_ary_new();
 	ep->capa = step;
 	ep->flags = EPOLL_CLOEXEC;
 	ep->events = xmalloc(sizeof(struct epoll_event) * ep->capa);
@@ -201,6 +204,8 @@ static VALUE ctl(VALUE self, VALUE io, VALUE flags, int op)
 		if (rv == -1)
 			rb_sys_fail("epoll_ctl");
 	}
+	if (op == EPOLL_CTL_ADD)
+		rb_ary_store(ep->marks, fd, io);
 
 	return INT2NUM(rv);
 }
@@ -226,6 +231,8 @@ static VALUE set(VALUE self, VALUE io, VALUE flags)
 			rv = epoll_ctl(ep->fd, EPOLL_CTL_ADD, fd, &event);
 			if (rv == -1)
 				rb_sys_fail("epoll_ctl - add");
+
+			rb_ary_store(ep->marks, fd, io);
 			return INT2NUM(rv);
 		}
 		rb_sys_fail("epoll_ctl - mod");
@@ -514,6 +521,7 @@ static VALUE init_copy(VALUE copy, VALUE orig)
 	       NIL_P(b->io) && "Ruby broken?");
 
 	ep_check(a);
+	b->marks = a->marks;
 	b->flags = a->flags;
 	b->fd = cloexec_dup(a);
 	if (b->fd == -1) {

data/lib/sleepy_penguin.rb

@@ -1,7 +1,7 @@
 # -*- encoding: binary -*-
 module SleepyPenguin
 
-  # the version of sleepy_penguin, currently 1.1.1
-  SLEEPY_PENGUIN_VERSION = '1.1.1'
+  # the version of sleepy_penguin, currently 1.2.0
+  SLEEPY_PENGUIN_VERSION = '1.2.0'
 end
 require 'sleepy_penguin_ext'

data/test/test_epoll_gc.rb

@@ -0,0 +1,47 @@
+require 'test/unit'
+$-w = true
+
+require 'sleepy_penguin'
+
+class TestEpollGC < Test::Unit::TestCase
+  include SleepyPenguin
+
+  def setup
+    GC.stress = true if GC.respond_to?(:stress=)
+    @ep = Epoll.new
+  end
+
+  def teardown
+    GC.stress = false if GC.respond_to?(:stress=)
+  end
+
+  def add_pipe_no_tailcall(m, depth)
+    add_pipe(m, depth += 1)
+  end
+
+  def add_pipe(m, depth = 0)
+    if depth > 6000
+      rd, wr = IO.pipe
+      warn "wr: #{wr.fileno}"
+      @ep.__send__(m, wr, Epoll::OUT)
+    else
+      add_pipe_no_tailcall(m, depth + 1)
+    end
+  end
+
+  def test_gc_safety
+    done = false
+    begin
+      if done
+        x = nil
+        @ep.wait(nil, 10) { |flags, obj| p [  flags, x = obj ] }
+        assert x, "#{x.inspect}"
+        break
+      else
+        add_pipe(:add)
+        2048.times { IO.pipe; File.open(__FILE__)}
+        done = true
+      end
+    end while true
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sleepy_penguin
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 31
   prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - sleepy_penguin hackers
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 +00:00
+date: 2011-01-15 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -81,6 +81,7 @@ files:
 - setup.rb
 - sleepy_penguin.gemspec
 - test/test_epoll.rb
+- test/test_epoll_gc.rb
 - test/test_eventfd.rb
 - test/test_timerfd.rb
 has_rdoc: true
@@ -124,4 +125,5 @@ summary: Linux I/O events for Ruby
 test_files: 
 - test/test_epoll.rb
 - test/test_eventfd.rb
+- test/test_epoll_gc.rb
 - test/test_timerfd.rb