evt 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 945c1a802be8b4e03b88c44138a139367288409b27c83a6f2904d0ecc94d2a40
-  data.tar.gz: 7b88e16f4a082f536c5b0eb9a7f68e67e6e1f5ab4586dbe771f7c57b9004447a
+  metadata.gz: 3275dc2e231b57c3e740671f2d431ede41ca23339ba799b280edeed1c7be8d2c
+  data.tar.gz: 4107ecb57ec3ff7e566187013348a056773ac654eb2b369b7fa8bb057675750e
 SHA512:
-  metadata.gz: f042da98ff5f85de3b4fce59a2726f2f4c46a1da8817abb524d700cd0413fc4118cb6c0a766a69abdc7e4ae5f0acdd35bc653b0c33116239c1e776f4c3218f23
-  data.tar.gz: 1824a4935d712e62268b9cad01f52c445ccecfcaa859b11fd93749f28ef3f259370b011af395ae269c9c03544b7ab5c1bb6ad3afd18cc8eea4a6d576e151ff76
+  metadata.gz: db3172fe0ee6776480a64ee036aedb03b09ee5d5c8a5088fe68e4a969d7058964e8c55b004bb69962f61bffdb13a1c6c28ce49d339f8194e616ae44d877a9616
+  data.tar.gz: 94e287ddb35ae5f99e15ebf27ef76ce54ce3272008fe7c535483706111a8a39ff3168d2289135a027934d45c4382b51527c240fc9d7fbf6b9ce13f2ca7b016e3

data/README.md

@@ -19,30 +19,59 @@ The Event Library that designed for Ruby 3.0 Fiber Scheduler.
 | epoll           | ✅  (See 2) | ❌          | ❌          | ❌          |
 | kqueue          | ❌          | ❌          | ✅ (⚠️ See 5) | ✅          |
 | IOCP            | ❌          | ❌ (⚠️See 3) | ❌          | ❌          |
-| Ruby (`IO.select`) | ✅ Fallback | ✅ (⚠️See 4) | ✅ Fallback | ✅ Fallback |
+| Ruby (`IO.select`) | ✅ (See 6) | ✅ (⚠️See 4) | ✅ (See 6) | ✅ (See 6) |
 
 1. when liburing is installed. (Currently fixing)
 2. when kernel version >= 2.6.9
 3. WOULD NOT WORK until `FILE_FLAG_OVERLAPPED` is included in I/O initialization process.
-4. Some I/Os are not able to be nonblock under Windows. See [Scheduler Docs](https://docs.ruby-lang.org/en/master/doc/scheduler_md.html#label-IO).
+4. Some I/Os are not able to be nonblock under Windows. Using POSIX select, **SLOW**. See [Scheduler Docs](https://docs.ruby-lang.org/en/master/doc/scheduler_md.html#label-IO).
 5. `kqueue` performance in Darwin is very poor. **MAY BE DISABLED IN THE FUTURE.**
+6. Using poll
 
 ### Benchmark
 
-The benchmark is running under `v0.3.1` version. See `example.rb` in [midori](https://github.com/midori-rb/midori.rb) for test code, the test is running under a single-thread server.
+The benchmark is running under `v0.3.6` version. See `example.rb` in [midori](https://github.com/midori-rb/midori.rb) for test code, the test is running under a single-thread server.
 
-The test command is `wrk -t4 -c8192 -d30s http://localhost:3001`.
+The test command is `wrk -t4 -c8192 -d30s http://localhost:8080`.
 
 All of the systems have set their file descriptor limit to maximum.
 On systems raising "Fiber unable to allocate memory", `sudo sysctl -w vm.max_map_count=1000000` is set.
 
 | OS    | CPU         | Memory | Backend                | req/s         |
-| ----- | ----------- | ------ | ---------------------- | --------------|
-| Linux | Ryzen 2700x | 64GB   | epoll                  | 1853259.47    |
+| ----- | ----------- | ------ | ---------------------- | ------------- |
+| Linux | Ryzen 2700x | 64GB   | epoll                  | 2035742.59    |
 | Linux | Ryzen 2700x | 64GB   | io_uring               | require fixes |
-| Linux | Ryzen 2700x | 64GB   | IO.select (using poll) | 1636849.15    |
-| macOS | i7-6820HQ   | 16GB   | kqueue                 | 247370.37     |
-| macOS | i7-6820HQ   | 16GB   | IO.select (using poll) | 323391.38     |
+| Linux | Ryzen 2700x | 64GB   | IO.select (using poll) | 1837640.54    |
+| macOS | i7-6820HQ   | 16GB   | kqueue                 | 257821.78     |
+| macOS | i7-6820HQ   | 16GB   | IO.select (using poll) | 338392.12     |
+
+We also test the server with Redis request, with a [monkey-patched redis library](https://github.com/midori-rb/midori-contrib/blob/master/lib/midori-contrib/redic.rb). The example code is following:
+
+```ruby
+require 'evt'
+require 'midori'
+require 'midori-contrib/redic'
+
+Fiber.set_scheduler Evt::Scheduler.new
+REDIS = Redic.new
+
+class HelloWorldAPI < Midori::API
+  get '/' do
+    REDIS.call 'GET', 'foo'
+  end
+end
+
+Fiber.schedule do
+  Midori::Runner.new(HelloWorldAPI).start
+end
+```
+
+The benckmark result is as following:
+
+| OS    | CPU         | Memory | Backend | req/s     |
+| ----- | ----------- | ------ | ------- | --------- |
+| Linux | Ryzen 2700x | 64GB   | epoll   | 378060.30 |
+| macOS | i7-6820HQ   | 16GB   | kqueue  | 204460.32 |
 
 ## Install
 
@@ -74,6 +103,15 @@ end
 # "Hello World"
 ```
 
+|                | Windows `WaitFor...` | Windows `select` | Windows IOCP | `io_uring` | `epoll` | `kqueue` | `poll` | *NIX `select` |
+| -------------- | -------------------- | ---------------- | ------------ | ---------- | ------- | -------- | ------ | ------------- |
+| Anonymous Pipe | ❌                    | ❌                | ❌            | ✅          | ✅       | ✅        | ✅      | ✅             |
+| Named Pipe     | ❌                    | ❌                | ✅            | ✅          | ✅       | ✅        | ✅      | ✅             |
+| Socket         | ✅                    | ✅                | ✅            | ✅          | ✅       | ✅        | ✅      | ✅             |
+| File           | ✅                    | ✅                | ✅            | ✅          | ✅       | ✅        | ✅      | ✅             |
+
+
+
 ## Roadmap
 
 - [x] Support epoll/kqueue/select

data/evt.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = "A low-level Event Handler designed for Ruby 3 Scheduler for better performance"
   spec.homepage      = "https://github.com/dsh0416/evt"
   spec.license       = 'BSD-3-Clause'
-  spec.required_ruby_version = '>= 3.0.0.rc1'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/dsh0416/evt"

data/ext/evt/epoll.h

@@ -3,6 +3,7 @@
 #include "evt.h"
 
 #if HAVE_SYS_EPOLL_H
+
 VALUE method_scheduler_epoll_init(VALUE self) {
     rb_iv_set(self, "@epfd", INT2NUM(epoll_create(1))); // Size of epoll is ignored after Linux 2.6.8.
     return Qnil;
@@ -25,7 +26,7 @@ VALUE method_scheduler_epoll_register(VALUE self, VALUE io, VALUE interest) {
         event.events |= EPOLLOUT;
     }
 
-    event.events |=EPOLLONESHOT;
+    event.events |= EPOLLRDHUP;
 
     event.data.ptr = (void*) io;
 
@@ -35,14 +36,13 @@ VALUE method_scheduler_epoll_register(VALUE self, VALUE io, VALUE interest) {
 
 VALUE method_scheduler_epoll_wait(VALUE self) {
     int n, epfd, i, event_flag, timeout;
-    VALUE next_timeout, obj_io, readables, writables, result;
+    VALUE next_timeout, obj_io, iovs, result;
     ID id_next_timeout = rb_intern("next_timeout");
     ID id_push = rb_intern("push");
     
     epfd = NUM2INT(rb_iv_get(self, "@epfd"));
     next_timeout = rb_funcall(self, id_next_timeout, 0);
-    readables = rb_ary_new();
-    writables = rb_ary_new();
+    iovs = rb_ary_new();
 
     if (next_timeout == Qnil) {
         timeout = -1;
@@ -59,23 +59,28 @@ VALUE method_scheduler_epoll_wait(VALUE self) {
 
     for (i = 0; i < n; i++) {
         event_flag = events[i].events;
-        if (event_flag & EPOLLIN) {
-            obj_io = (VALUE) events[i].data.ptr;
-            rb_funcall(readables, id_push, 1, obj_io);
-        }
-
-        if (event_flag & EPOLLOUT) {
-            obj_io = (VALUE) events[i].data.ptr;
-            rb_funcall(writables, id_push, 1, obj_io);
-        }
+        obj_io = (VALUE) events[i].data.ptr;
+        VALUE e = rb_ary_new2(2);
+        rb_ary_store(e, 0, obj_io);
+        rb_ary_store(e, 1, INT2NUM(event_flag));
+        rb_funcall(iovs, id_push, 1, e);
     }
 
-    result = rb_ary_new2(2);
-    rb_ary_store(result, 0, readables);
-    rb_ary_store(result, 1, writables);
+    result = rb_ary_new2(3);
+    rb_ary_store(result, 0, rb_ary_new());
+    rb_ary_store(result, 1, rb_ary_new());
+    rb_ary_store(result, 2, iovs);
     return result;
 }
 
+VALUE method_scheduler_epoll_deregister(VALUE self, VALUE io) {
+    ID id_fileno = rb_intern("fileno");
+    int epfd = NUM2INT(rb_iv_get(self, "@epfd"));
+    int fd = NUM2INT(rb_funcall(io, id_fileno, 0));
+    epoll_ctl(epfd, EPOLL_CTL_DEL, fd, NULL); // Require Linux 2.6.9 for NULL event.
+    return Qnil;
+}
+
 VALUE method_scheduler_epoll_backend(VALUE klass) {
     return rb_str_new_cstr("epoll");
 }

data/ext/evt/evt.c

@@ -24,6 +24,7 @@ void Init_evt_ext()
     rb_define_singleton_method(Bundled, "epoll_backend", method_scheduler_epoll_backend, 0);
     rb_define_method(Bundled, "epoll_init_selector", method_scheduler_epoll_init, 0);
     rb_define_method(Bundled, "epoll_register", method_scheduler_epoll_register, 2);
+    rb_define_method(Bundled, "epoll_deregister", method_scheduler_epoll_deregister, 1);
     rb_define_method(Bundled, "epoll_wait", method_scheduler_epoll_wait, 0);
 #endif
 #if HAVE_SYS_EVENT_H

data/ext/evt/evt.h

@@ -45,6 +45,7 @@ void Init_evt_ext();
 #if HAVE_SYS_EPOLL_H
     VALUE method_scheduler_epoll_init(VALUE self);
     VALUE method_scheduler_epoll_register(VALUE self, VALUE io, VALUE interest);
+    VALUE method_scheduler_epoll_deregister(VALUE self, VALUE io);
     VALUE method_scheduler_epoll_wait(VALUE self);
     VALUE method_scheduler_epoll_backend(VALUE klass);
     #include <sys/epoll.h>

data/ext/evt/select.h

@@ -3,19 +3,22 @@
 #include "evt.h"
 
 VALUE method_scheduler_select_wait(VALUE self) {
-    // return IO.select(@readable.keys, @writable.keys, [], next_timeout)
-    VALUE readable, writable, readable_keys, writable_keys, next_timeout;
+    // return IO.select(@readable.keys, @writable.keys, [], next_timeout / 1000.0)
     ID id_select = rb_intern("select");
     ID id_next_timeout = rb_intern("next_timeout");
+    ID id_div = rb_intern("/");
+    ID id_to_f = rb_intern("to_f");
 
-    readable = rb_iv_get(self, "@readable");
-    writable = rb_iv_get(self, "@writable");
+    VALUE readable = rb_iv_get(self, "@readable");
+    VALUE writable = rb_iv_get(self, "@writable");
 
-    readable_keys = rb_funcall(readable, rb_intern("keys"), 0);
-    writable_keys = rb_funcall(writable, rb_intern("keys"), 0);
-    next_timeout = rb_funcall(self, id_next_timeout, 0);
+    VALUE readable_keys = rb_funcall(readable, rb_intern("keys"), 0);
+    VALUE writable_keys = rb_funcall(writable, rb_intern("keys"), 0);
+    VALUE next_timeout = rb_funcall(self, id_next_timeout, 0);
+    next_timeout = rb_funcall(next_timeout, id_to_f, 0);
+    VALUE secs = rb_funcall(next_timeout, id_div, 1, DBL2NUM(1000.0));
 
-    return rb_funcall(rb_cIO, id_select, 4, readable_keys, writable_keys, rb_ary_new(), next_timeout);
+    return rb_funcall(rb_cIO, id_select, 4, readable_keys, writable_keys, rb_ary_new(), secs);
 }
 
 VALUE method_scheduler_select_backend(VALUE klass) {

data/lib/evt/backends/bundled.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class Evt::Bundled
-  MAXIMUM_TIMEOUT = 5
+  MAXIMUM_TIMEOUT = 5000
   COLLECT_COUNTER_MAX = 16384
 
   def initialize
@@ -26,7 +26,7 @@ class Evt::Bundled
     _fiber, timeout = @waiting.min_by{ |key, value| value }
 
     if timeout
-      offset = timeout - current_time
+      offset = (timeout - current_time) * 1000 # Use mililisecond
       return 0 if offset < 0
       return offset if offset < MAXIMUM_TIMEOUT
     end
@@ -101,6 +101,7 @@ class Evt::Bundled
     @writable[io] = Fiber.current unless (events & IO::WRITABLE).zero?
     self.register(io, events)
     Fiber.yield
+    self.deregister(io)
     true
   end
 

data/lib/evt/backends/epoll.rb

@@ -17,6 +17,60 @@ class Evt::Epoll < Evt::Bundled
     epoll_register(io, interest)
   end
 
+  def deregister(io)
+    epoll_deregister(io)
+  end
+
+  def io_wait(io, events, duration)
+    @iovs[io] = Fiber.current
+    self.register(io, events)
+    Fiber.yield
+    self.deregister(io)
+    true
+  end
+
+  # def io_read(io, buffer, offset, length)
+  #   result = +('')
+    
+  #   self.register(io, IO::READABLE)
+  #   direct_read = io.read_nonblock(length, exception: false)
+  
+  #   unless direct_read == :wait_readable
+  #     result << direct_read
+  #   end
+
+  #   until result.length >= length or io.closed? or io.eof?
+  #     @iovs[io] = Fiber.current
+  #     Fiber.yield
+  #     todo = length - result.length
+  #     result << io.read_nonblock(todo)
+  #   end
+
+  #   self.deregister(io)
+  #   buffer[offset...offset+result.length] = result
+  #   result.length
+  # end
+
+  # def io_write(io, buffer, offset, length)
+  #   finished = 0
+
+  #   self.register(io, IO::WRITABLE)
+  #   direct_write = io.write_nonblock(buffer.byteslice(offset+finished..-1), exception: false)
+  #   unless direct_write == :wait_writable
+  #     finished += direct_write
+  #   end
+
+  #   until finished >= length or io.closed?
+  #     @iovs[io] = Fiber.current
+  #     Fiber.yield
+  #     finished += io.write_nonblock(buffer.byteslice(offset+finished..-1))
+  #   end
+
+  #   self.deregister(io)
+
+  #   finished
+  # end
+
   def wait
     epoll_wait
   end

data/lib/evt/backends/iocp.rb

@@ -15,6 +15,9 @@ class Evt::Iocp < Evt::Bundled
     # Placeholder
   end
 
+  def deregister(io)
+  end
+
   def io_read(io, buffer, offset, length)
     # Placeholder
   end

data/lib/evt/backends/kqueue.rb

@@ -17,6 +17,9 @@ class Evt::Kqueue < Evt::Bundled
     kqueue_register(io, interest)
   end
 
+  def deregister(io)
+  end
+
   def wait
     kqueue_wait
   end

data/lib/evt/backends/select.rb

@@ -17,8 +17,14 @@ class Evt::Select < Evt::Bundled
     # Select is stateless
   end
 
+  def deregister(io)
+  end
+
   def wait
     select_wait
+  rescue IOError => _
+    collect(true)
+    return [], []
   rescue Errno::EBADF => _
     collect(true)
     return [], []

data/lib/evt/backends/uring.rb

@@ -17,13 +17,17 @@ class Evt::Uring < Evt::Bundled
     uring_register(io, interest)
   end
 
-  def io_read(io, buffer, offset, length)
-    uring_io_read(io, buffer, offset, length)
+  def deregister(io)
   end
 
-  def io_write(io, buffer, offset, length)
-    uring_io_write(io, buffer, offset, length)
-  end
+  # Disable direct I/Os for now
+  # def io_read(io, buffer, offset, length)
+  #   uring_io_read(io, buffer, offset, length)
+  # end
+
+  # def io_write(io, buffer, offset, length)
+  #   uring_io_write(io, buffer, offset, length)
+  # end
 
   def wait
     uring_wait

data/lib/evt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Evt
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evt
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Delton Ding
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-23 00:00:00.000000000 Z
+date: 2020-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -100,14 +100,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0.rc1
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: The Event Library that designed for Ruby 3.0 Fiber Scheluer.