io-epoll 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1d5379f3b1a1f7630975f462c9580f0156d53b0
-  data.tar.gz: f9627c3a392a839c64b204aeae939d1fbf8da753
+  metadata.gz: 87c51dc70ed31c8d3a34012ce002a0c9c19c7982
+  data.tar.gz: 92e3c83055ba130342883cb1bb15f9d55bf6c6fd
 SHA512:
-  metadata.gz: 10dfbf4366e5c54dbad66a2bf33d822851d9e2481eda47007348b7446c7939433efd0272bb65a918bec2c6c4486b57a9f1a067c045222d84eeb9831852bf1cd4
-  data.tar.gz: 0bf8d0e53cfb0bd207ed962341481c30c561301752b8f50e4a7767adef959950cd80f4d55644eddcdd7a09711804ffa6e8c2e8b3c1cb7aa5ac7fced2c23e46f5
+  metadata.gz: bd0dd5bdd8e4085c8b6be91ba5ddd218d448981cd3365c498c4bd936196da3d9827d639ff1afeccc5c1ecad72f29de6a16933aab90f6c7bef1f5f678b931a857
+  data.tar.gz: 1eec9c05b0d6e9c6b22fe399992389b62dd92672e65255bcf34d0c1dc4acb8bb6ed46aad0f4a1c1df8424a4d5e567cbee5e226e2c8b2db8e4a4935053192061b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    io-epoll (0.0.2)
+    io-epoll (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,25 +12,7 @@ An experimental binding of epoll(7).
 ```ruby
 require 'io/epoll'
 
-IO.epoll([io1, io2, io3], Epoll::IN) do |ev|
-  # ev is IO::Epoll::Event object like `struct epoll_event`
-  # it's have data and events properties
-
-  # IO::Epoll::Event#events is event flag bits (Fixnum)
-  events = ev.events
-
-  # IO::Epoll::Event#data is notified IO (IO)
-  data = ev.data
-end
-
-# or
-
-# evlist is Array of IO::Epoll::Event
-# it's just short hand for epoll_create(2) -> epoll_ctl(2) -> epoll_wait(2)
-evlist = IO.epoll([io1, io2, io3], Epoll::IN)
-
-# on other way, you can make instance of IO::Epoll
-
+# Recommend short hand
 Epoll = IO::Epoll
 
 # IO::Epoll.create
@@ -42,10 +24,7 @@ epoll = Epoll.create
 
 # IO::Epoll#ctl(option, io, flag)
 #   call epoll_ctl(2)
-#   option: you can choice epoll_ctl option in CTL_ADD, CTL_MOD and CTL_DEL.
-#     CTL_ADD: add io list to watching for created epoll fd
-#     CTL_MOD: you can change io events
-#     CTL_DEL: delete io in watching list
+#   option: you can choice options (see ctl options).
 #   io: set an IO object for watching.
 #   flag: set flag bits like Epoll::IN|Epoll::OUT|Epoll::ONESHOT etc...
 #     see also man epoll_ctl(2)
@@ -57,13 +36,29 @@ epoll.add(io, Epoll::IN)  # same way to epoll.ctl(Epoll::CTL_ADD, io, Epoll::IN)
 epoll.mod(io, Epoll::OUT) # same way to epoll.ctl(Epoll::CTL_MOD, io, Epoll::IN)
 epoll.del(io)             # same way to epoll.ctl(Epoll::CTL_DEL, io)
 
-# IO::Epoll#wait(timeout=-1)
-#   call epoll_wait(2)
-#   timeout = -1: block until receive event or signals
-#   timeout = 0: return all io's can I/O on non block
-#   timeout > 0: block when timeout pass miri second or receive events or signals
-#   return: Array of IO::Epoll::Event
-evlist = epoll.wait
+loop do
+  # IO::Epoll#wait(timeout=-1)
+  #   call epoll_wait(2)
+  #   timeout = -1: block until receive event or signals
+  #   timeout = 0: return all io's can I/O on non block
+  #   timeout > 0: block when timeout pass miri second or receive events or signals
+  #   return: Array of IO::Epoll::Event
+  evlist = epoll.wait
+
+  # ev is instance of IO::Epoll::Event like `struct epoll_event`
+  # it's same as `class Event < Struct.new(:data, :events); end`
+  evlist.each do |ev|
+    # IO::Epoll::Event#events is event flag bits (Fixnum)
+    if (ev.events & Epoll::IN) != 0
+      # IO::Epoll::Event#data is notified IO (IO)
+      # e.g. it's expect to I/O readable
+      puts ev.data.read
+    elsif (ev.events & Epoll::HUP|Epoll::ERR) != 0
+      ev.data.close
+      break
+    end
+  end
+end
 
 # you can close File Descriptor for epoll when finish to use
 epoll.close #=> nil
@@ -72,6 +67,14 @@ epoll.close #=> nil
 epoll.closed? #=> true
 ```
 
+## ctl options
+
+ctl options|description
+---|---
+**IO::Epoll::CTL_ADD**|add to interest list for created epoll fd
+**IO::Epoll::CTL_MOD**|change io events
+**IO::Epoll::CTL_DEL**|delete in interest list
+
 ## Event flags
 
 event flags|ctl|wait|description

data/examples/epoll_server.rb

@@ -0,0 +1,47 @@
+#! /usr/bin/env ruby
+
+require 'io/epoll'
+require 'socket'
+
+server = TCPServer.open(4000)
+
+response = [
+  "HTTP/1.0 200 OK\r\n",
+  "Content-Length: 5\r\n",
+  "Content-Type: text/html\r\n",
+  "\r\n",
+  "HELLO\r\n",
+].join("")
+
+Epoll = IO::Epoll
+ep = Epoll.create
+ep.add server, Epoll::IN
+
+Signal.trap(:INT) {
+  ep.close
+  server.close
+}
+
+loop do
+  ep.wait.each do |ev|
+    data = ev.data
+    events = ev.events
+
+    if data == server
+      socket = server.accept
+      ep.add socket, Epoll::IN|Epoll::ET
+    elsif (events & Epoll::IN) != 0
+      data.recv(1024)
+      ep.mod data, Epoll::OUT|Epoll::ET
+    elsif (events & Epoll::OUT) != 0
+      data.puts response
+      ep.del data
+      data.close
+    elsif (events & (Epoll::HUP|Epoll::ERR)) != 0
+      p "Epoll::HUP|Epoll::ERR"
+    else
+      raise IOError
+    end
+  end
+end
+

data/ext/io/epoll/epoll.c

@@ -4,18 +4,25 @@
 #include <sys/epoll.h>
 
 VALUE cIO_Epoll;
+VALUE cIO_Epoll_Event;
 
 struct Epoll {
   int epfd;
   int ev_len;
 };
 
+static void
+epoll_fd_close(int epfd)
+{
+  rb_thread_fd_close(epfd);
+}
+
 static void
 rb_epoll_free(void *p)
 {
   struct Epoll *ptr = p;
   if (ptr) {
-    if (0 <= ptr->epfd) close(ptr->epfd);
+    if (0 <= ptr->epfd) epoll_fd_close(ptr->epfd);
     ruby_xfree(ptr);
   }
 }
@@ -38,15 +45,30 @@ static const rb_data_type_t epoll_data_type = {
   NULL, NULL, RUBY_TYPED_FREE_IMMEDIATELY|RUBY_TYPED_WB_PROTECTED
 };
 
+void
+epoll_check_initialized(struct Epoll *ptr)
+{
+  if (!ptr) {
+    rb_raise(rb_eIOError, "uninitialized stream");
+  }
+}
+
+void
+epoll_check_closed(struct Epoll *ptr)
+{
+  epoll_check_initialized(ptr);
+  if (ptr->epfd < 0) {
+    rb_raise(rb_eIOError, "closed stream");
+  }
+}
+
 static struct Epoll*
 get_epoll(VALUE self)
 {
   struct Epoll *ptr;
   rb_check_frozen(self);
   TypedData_Get_Struct(self, struct Epoll, &epoll_data_type, ptr);
-  if (!ptr) {
-    rb_raise(rb_eIOError, "uninitialized stream");
-  }
+  epoll_check_initialized(ptr);
   return ptr;
 }
 
@@ -64,13 +86,21 @@ rb_epoll_initialize(VALUE self)
   int epfd;
 
   TypedData_Get_Struct(self, struct Epoll, &epoll_data_type, ptr);
-  if (ptr->epfd < 0) close(ptr->epfd);
+  if (ptr->epfd < 0) epoll_fd_close(ptr->epfd);
   epfd = epoll_create(1);
   if (epfd == -1) {
     rb_sys_fail("epoll_create was failed");
   }
   ptr->epfd = epfd;
   ptr->ev_len = 0;
+
+  /**
+  * FIXME: I want to delete instance variable `evlist` !
+  * It's just only using for GC mark.
+  * So, I don't know how to GC guard io objects.
+  */
+  rb_ivar_set(self, rb_intern("evlist"), rb_ary_new());
+
   return self;
 }
 
@@ -78,9 +108,26 @@ static VALUE
 rb_epoll_fileno(VALUE self)
 {
   struct Epoll *ptr = get_epoll(self);
+  epoll_check_closed(ptr);
   return INT2FIX(ptr->epfd);
 }
 
+inline static void
+rb_epoll_evlist_add(VALUE self, VALUE io)
+{
+   VALUE evlist = rb_ivar_get(self, rb_intern("evlist"));
+   rb_ary_push(evlist, io);
+   rb_ivar_set(self, rb_intern("evlist"), evlist);
+}
+
+inline static void
+rb_epoll_evlist_del(VALUE self, VALUE io)
+{
+  VALUE evlist = rb_ivar_get(self, rb_intern("evlist"));
+  rb_ary_delete(evlist, io);
+  rb_ivar_set(self, rb_intern("evlist"), evlist);
+}
+
 static VALUE
 rb_epoll_ctl(int argc, VALUE *argv, VALUE self)
 {
@@ -97,11 +144,21 @@ rb_epoll_ctl(int argc, VALUE *argv, VALUE self)
     if (FIX2INT(flag) != EPOLL_CTL_DEL)
       rb_raise(rb_eArgError, "too few argument for CTL_ADD or CTL_MOD");
     break;
+    rb_epoll_evlist_del(self, io);
   case 3:
-    if (FIX2INT(flag) != EPOLL_CTL_ADD && FIX2INT(flag) != EPOLL_CTL_MOD)
+    if (FIX2INT(flag) == EPOLL_CTL_ADD) {
+      rb_epoll_evlist_add(self, io);
+    }
+    else if (FIX2INT(flag) == EPOLL_CTL_MOD) {
+      /* nothing */
+    }
+    else {
       rb_raise(rb_eArgError, "too many argument for CTL_DEL");
+    }
+
     if ((FIX2LONG(events) & (EPOLLIN|EPOLLPRI|EPOLLRDHUP|EPOLLOUT|EPOLLET|EPOLLONESHOT)) == 0)
       rb_raise(rb_eIOError, "undefined events");
+
     ev.events = FIX2LONG(events);
     ev.data.ptr = (void*)io;
     break;
@@ -150,7 +207,6 @@ rb_epoll_wait(int argc, VALUE *argv, VALUE self)
 {
   struct Epoll *ptr = get_epoll(self);
   VALUE ready_evlist;
-  VALUE cEvent;
   VALUE event;
   struct epoll_event *evlist;
   int i, ready;
@@ -159,6 +215,7 @@ rb_epoll_wait(int argc, VALUE *argv, VALUE self)
 
   if (argc == 1)
     timeout = FIX2INT(argv[0]);
+
   if (ptr->ev_len <= 0)
     rb_raise(rb_eIOError, "empty interest list");
 
@@ -181,9 +238,8 @@ RETRY:
   }
 
   ready_evlist = rb_ary_new_capa(ready);
-  cEvent = rb_path2class("IO::Epoll::Event");
   for (i = 0; i < ready; i++) {
-    event = rb_obj_alloc(cEvent);
+    event = rb_obj_alloc(cIO_Epoll_Event);
     RSTRUCT_SET(event, 0, (VALUE) evlist[i].data.ptr);
     RSTRUCT_SET(event, 1, LONG2FIX(evlist[i].events));
     rb_ary_store(ready_evlist, i, event);
@@ -196,13 +252,19 @@ static VALUE
 rb_epoll_close(VALUE self)
 {
   struct Epoll *ptr = get_epoll(self);
-  if (close(ptr->epfd) == -1) {
-    rb_raise(rb_eIOError, "file descriptor duplicate close %ld", INT2FIX(ptr->epfd));
-  }
+  epoll_check_closed(ptr);
+  epoll_fd_close(ptr->epfd);
   ptr->epfd = -1;
   return Qnil;
 }
 
+static VALUE
+rb_epoll_closed_p(VALUE self)
+{
+  struct Epoll *ptr = get_epoll(self);
+  return 0 <= ptr->epfd ? Qfalse : Qtrue;
+}
+
 static VALUE
 rb_epoll_length(VALUE self)
 {
@@ -214,13 +276,15 @@ void
 Init_epoll()
 {
   cIO_Epoll = rb_define_class_under(rb_cIO, "Epoll", rb_cObject);
+  cIO_Epoll_Event = rb_struct_define_under(cIO_Epoll, "Event", "data", "events", NULL);
   rb_define_alloc_func(cIO_Epoll, rb_epoll_allocate);
 
   rb_define_method(cIO_Epoll, "initialize", rb_epoll_initialize, 0);
-  rb_define_method(cIO_Epoll, "fileno", rb_epoll_fileno, 0);
   rb_define_method(cIO_Epoll, "ctl", rb_epoll_ctl, -1);
   rb_define_method(cIO_Epoll, "wait", rb_epoll_wait, -1);
+  rb_define_method(cIO_Epoll, "fileno", rb_epoll_fileno, 0);
   rb_define_method(cIO_Epoll, "close", rb_epoll_close, 0);
+  rb_define_method(cIO_Epoll, "closed?", rb_epoll_closed_p, 0);
   rb_define_method(cIO_Epoll, "length", rb_epoll_length, 0);
   rb_define_alias(cIO_Epoll, "size", "length");
   rb_define_const(cIO_Epoll, "IN", INT2FIX(EPOLLIN));

data/io-epoll.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "io-epoll"
-  spec.version       = "0.0.2"
+  spec.version       = "0.1.0"
   spec.authors       = ["ksss"]
   spec.email         = ["co000ri@gmail.com"]
   spec.summary       = %q{An experimental binding of epoll(7)}

data/lib/io/epoll.rb

@@ -2,9 +2,6 @@ require 'io/epoll/epoll'
 
 class IO
   class Epoll
-    class Event < Struct.new(:data, :events)
-    end
-
     class << self
       alias create new
     end
@@ -20,35 +17,5 @@ class IO
     def del(io)
       ctl(CTL_DEL, io)
     end
-
-    def closed?
-      fileno < 0
-    end
-  end
-
-  def self.epoll(ios, events)
-    ios = ios.to_a
-    open_len = ios.length
-    ep = Epoll.create
-    ios.each do |io|
-      ep.add(io, events)
-    end
-    if block_given?
-      while 0 < open_len
-        evlist = ep.wait
-        evlist.each do |ev|
-          yield ev
-          if ev.events & (Epoll::HUP|Epoll::ERR)
-            open_len -= 1
-            ev.data.close
-          end
-        end
-      end
-      ep.close
-    else
-      evlist = ep.wait
-      ep.close
-      evlist
-    end
   end
 end

data/test/test_epoll.rb

@@ -9,7 +9,10 @@ class TestIOEpoll < Test::Unit::TestCase
   end
 
   def test_fileno
-    assert { 0 < IO::Epoll.create.fileno }
+    ep = IO::Epoll.create
+    assert { 0 < ep.fileno }
+    ep.close
+    assert_raise(IOError) { ep.fileno }
   end
 
   def test_ctl
@@ -56,7 +59,10 @@ class TestIOEpoll < Test::Unit::TestCase
     ep = IO::Epoll.create
     io = IO.new(1, 'w')
     ep.add(io, IO::Epoll::IN|IO::Epoll::PRI|IO::Epoll::RDHUP|IO::Epoll::ET|IO::Epoll::OUT)
-    assert { [IO::Epoll::Event.new(io, IO::Epoll::OUT)] == ep.wait }
+    evlist = ep.wait
+    assert { [IO::Epoll::Event.new(io, IO::Epoll::OUT)] == evlist }
+    assert_instance_of(IO, evlist[0].data)
+    assert_instance_of(Fixnum, evlist[0].events)
     assert_raise(TypeError) { ep.wait(nil) }
     assert_raise(IOError) { IO::Epoll.create.wait }
   end
@@ -89,37 +95,6 @@ class TestIOEpoll < Test::Unit::TestCase
     assert { true == ep.closed? }
   end
 
-  def test_epoll
-    r, w = IO.pipe
-    fork {
-      r.close
-      w.write('ok')
-    }
-    w.close
-    ret = []
-    evs = IO.epoll([r], IO::Epoll::IN)
-    assert { 'ok' == evs[0].data.read }
-    assert { false == evs[0].data.closed? }
-    assert_raise(IOError) { IO.epoll(nil, nil) }
-    assert_raise(IOError) { IO.epoll([], nil) }
-    assert_raise(TypeError) { IO.epoll([nil], nil) }
-  end
-
-  def test_epoll_with_block
-    r, w = IO.pipe
-    fork {
-      r.close
-      w.write('ok')
-    }
-    w.close
-    ret = []
-    IO.epoll([r], IO::Epoll::IN) do |ev|
-      ret << ev
-      assert { 'ok' == ev.data.read }
-    end
-    assert { true == ret[0].data.closed? }
-  end
-
   def test_thread
     ep = IO::Epoll.create
     io = IO.new(1, 'w')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io-epoll
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - ksss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,6 +81,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/epoll_server.rb
 - ext/io/epoll/epoll.c
 - ext/io/epoll/extconf.rb
 - io-epoll.gemspec